add script to install and run the project

Author: bluenex

README.md

@@ -2,6 +2,24 @@
 
 Repository for [tupleblog](http://tupleblog.github.io) (in Thai) based on [Jekyll](http://jekyllrb.com/) [HPSTR](https://github.com/mmistakes/hpstr-jekyll-theme) theme.
 
+### `tpb` script
+
+`tpb` script is now live! `tpb.sh` will help you install and serve the site easily. All you need to have is Ruby version >= `2.5.3`.
+
+Here is how the script help looks like:
+
+```sh
+$ ./tpb.sh
+Usage: ./tpb.sh [-i] [-d]
+
+  Options:
+    -i, --install     install dependencies with gem (gem install bundler) and bundler (bundle install).
+    -d, --debug       serve jekyll locally using bundler.
+```
+
+If you have already installed Ruby, you can go ahead with the command `./tpb.sh -i`. This will install `bundler` if it is not installed yet and then run `bundle install` for you. Another command is `./tpb.sh -d` or debug. This command starts with commenting specified `url` in the `_config.yml` of the project then serving Jekyll with `JEKYLL_ENV=production` prefix. It also uncomment the line for you when you stop the server by hitting `ctrl`+`c`.
+
+
 ### Running the blog locally
 
 First, go to `_config.yml` then change line 9 for running locally. Then, change
@@ -11,7 +29,7 @@ directory to the repository and then do the following
   2. Download `ruby` using [Homebrew](https://brew.sh/) for Mac. For Windows, download **RubyInstaller** and
   **DEVELOPMENT KIT** regarding your OS architecture from [here](https://rubyinstaller.org/downloads/).
   For **RubyInstaller**, just double click and done. For **DEVELOPMENT KIT**, please follows [its instruction](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit).
-  3. Update your installed gems to latest version `gem update`. If updating failed try running `gem update --system` to update its core (see [this post](http://guides.rubygems.org/ssl-certificate-update/#installing-using-update-packages)). 
+  3. Update your installed gems to latest version `gem update`. If updating failed try running `gem update --system` to update its core (see [this post](http://guides.rubygems.org/ssl-certificate-update/#installing-using-update-packages)).
   4. `gem install bundler`
   5. `bundle install` (For Windows, run `cmd` as Administrator)
   6. `bundle exec jekyll serve` to serve the site in port 4000. You can also run

tpb.sh

@@ -0,0 +1,107 @@
+#!/usr/bin/env bash
+
+# ---------------------------
+#      helper functions
+# ---------------------------
+## detect if it is on which system, because inplace sed on MacOS requires backup extension
+isMac() {
+  if [[ "$OSTYPE" == "darwin"* ]]; then
+    return 0
+  fi
+
+  return 1
+}
+
+## sed inplace for cross platform
+xsed() {
+  # $1 : pattern
+  # $2 : filename
+  if isMac; then
+    sed -Ei '' "$1" "$2"
+  else
+    sed -Ei "$1" "$2"
+  fi
+}
+
+## check if imageMagick is installed
+checkRequirement() {
+  if ! type ruby > /dev/null; then
+    echo "ruby not found, please install.. (rbenv recommended)"
+    return 1
+  fi
+  if ! type gem > /dev/null; then
+    echo "gem not found, please install.. (rbenv recommended)"
+    return 1
+  fi
+  return 0
+}
+
+## display help
+displayHelp(){
+    echo "Usage: $0 [-i] [-d]"
+    echo
+    echo "  Options:"
+    echo "    -i, --install     install dependencies with gem (gem install bundler) and bundler (bundle install)."
+    echo "    -d, --debug       serve jekyll locally using bundler."
+    echo
+
+    exit 1
+}
+
+# ---------------------------
+#      functions
+# ---------------------------
+## install dependencies
+installDeps() {
+  if ! type bundle > /dev/null; then
+    echo -e ">> bundle not found, installing..\n"
+    gem install bundler
+  fi
+
+  echo -e ">> installing bundles..\n"
+  bundle install
+}
+
+## debug locally
+debugLocally() {
+  local config_file
+  config_file="./_config.yml"
+
+  # comment url line on start
+  xsed 's/^(url:.*)/\# \1/' $config_file
+
+  # serve jekyll locally
+  JEKYLL_ENV=production bundle exec jekyll serve
+
+  # uncomment url line on stop
+  xsed 's/^#\s*(url: https\:\/\/tupleblog.*)/\1/' $config_file
+}
+
+# ---------------------------
+#      main
+# ---------------------------
+
+main() {
+  # check requirement first
+  if ! checkRequirement; then exit 1; fi
+
+  case $1 in
+    '-i' | '--install' )
+      installDeps
+      exit
+    ;;
+    '-d' | '--debug' )
+      debugLocally
+      exit
+    ;;
+    '-t' | '--test' )
+      debugLocally
+    #   displayHelp
+    ;;
+    * )
+      displayHelp
+    ;;
+  esac
+}
+
+main $@