desoto-photoapp 0.4.7 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f46bf791e878c8020fcc4f3164aa85d23e077b6
-  data.tar.gz: 0e3f59eb18ff5eafa81e1e183912b0bbe731744c
+  metadata.gz: 0d179b8286429cb3e024ca35397e545a9fc7bec6
+  data.tar.gz: 2a5ffe60691b4d23ae1e11d8f683b36949e6d5a2
 SHA512:
-  metadata.gz: 77c3f1064d046fb2a5544a772adbb0355b1cfa9e1c95ec80349979a14ca9ea8f2666d4b547d63896a71e6a2c6a2cbd0ae079da4281b3fa55d5037bf7d0498c98
-  data.tar.gz: 6b79b7e663726394215089ea7a66dc0377a4940ddadb9c2420fcdf0defaee30c2aaa27062e0a55a24d014f626c9558c030b7fb6a04ab5de229c084e31a5aa73d
+  metadata.gz: 9859dc880a300ae8562918c7bf2fc17640ba3377ef45ef97d046be9b6e7a859deccb8e94d4f045d766efbf219422c8167c3527a0d71078704b0343ddd1501a2a
+  data.tar.gz: f365b6b4b5bd127ca84abf773af83492ac7ddad1b665b65c1bee1d462c55c8d08aad46c389af6aa7120422a39fa3ec210dd0c8c37fc26d864832be0f83051892

data/README.md

@@ -22,9 +22,6 @@ And then execute:
 
     $ bundle
 
-Install the [Automator actions](https://photosautomation.com/index.html) for importing photos. Download the [installer here](https://photosautomation.com/installer.zip).
-
-
 Be sure your shell profile loads in executables.
 
 ```
@@ -46,9 +43,8 @@ $ photoapp setup
 This will do the following:
 
 - Installs `imagemagick` with (using Homebrew).
-- Installs [Automator actions](https://photosautomation.com/index.html) for importing pictures into Photos.app [Manually install from here](https://photosautomation.com/installer.zip)
 - Copies the image processing Automator workflow to `~/Library/Workflows/Applications/Folder\ Actions/`
-- Installs the `Reprint.app` to `/Applications` (You should add this app to the dock for easy reprinting).
+- Installs the `Reprint.app`, `Update.app`, and `Upload.app` to `/Applications`.
 
 Finally you'll need to enable the folder action to trigger photo processing when photos are added to the import folder. Launch the folder actions setup app:
 
@@ -88,18 +84,6 @@ $ photoapp config printer
 These are the default settings for an Epson Stylus Photo R280. If using a different printer, use whatever settings are equivalent.
 
 ```
-Page Setup: Sheet Feeder - Borderless
-Paper Size: 5x7 in
-Media Type: Ulta Premium Photo Paper Glossy
-
-... further down ...
-
-MediaType: Ulta Premium Photo Paper Glossy
-Media Size: 5x7 in (Sheet Feeder - Borderless)
+Paper Size: 5x7
+Media Type: Glossy
 ```
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/bin/imageOptim

@@ -0,0 +1,86 @@
+#!/bin/bash
+
+# ------------------------------------
+# LOCATE THIS SCRIPT
+# ------------------------------------
+
+CLI_PATH="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+# ------------------------------------
+# IMPORT BASH LIBRARY
+# ------------------------------------
+
+source "${CLI_PATH}/imageOptimBashLib"
+
+# ------------------------------------
+# INGEST COMMAND LINE ARGUMENTS
+# ------------------------------------
+
+while [ "$1" != "" ]; do
+  case $1 in
+    -d | --directory )
+      shift;
+      DIRECTORY_OPTION="$1"
+      ;;
+    -a | --image-alpha )
+      USE_IMAGE_ALPHA="true"
+      ;;
+    -j | --jpeg-mini )
+      USE_JPEGMINI="true"
+      ;;
+    -m | --min-quality )
+      shift;
+      MIN_QUALITY="$1"
+      ;;
+    -s | --skip-if-larger )
+      SKIP_IF_LARGER="true"
+      ;;
+    -q | --quit )
+      QUIT_ON_COMPLETE="true"
+      ;;
+    -c | --no-color )
+      NO_COLOR="true"
+      ;;
+    -h | --help )
+      usage;
+      exit 0
+      ;;
+    -e | --examples )
+      examples;
+      exit 0
+      ;;
+    --verbose )
+      IS_VERBOSE="true"
+      ;;
+    -v | --version )
+      echo $VERSION;
+      exit 0
+      ;;
+    * )
+    usage
+    exit 1
+  esac
+  shift
+done
+
+# ------------------------------------
+# POPULATE VARIABLES
+# ------------------------------------
+
+# Determine which Applications are installed.
+HAS_IMAGE_OPTIM=$(has_imageoptim)
+HAS_JPEGMINI=$(has_jpegmini)
+HAS_IMAGEMAGICK=$(has_imagemagick)
+HAS_GUI_SCRIPT=`osascript -e 'tell application "System Events" to get UI elements enabled'`
+JPEGMINI_NAME=$(get_jpegmini_app_name)
+
+# ------------------------------------
+# BEGIN PROCESSING
+# ------------------------------------
+
+start
+run_image_alpha
+run_jpegmini
+run_image_optim
+output_savings
+finish

data/bin/imageOptimAppleScriptLib

@@ -0,0 +1,251 @@
+#!/bin/osascript
+
+-- https://raw.githubusercontent.com/JamieMason/LICENSES/master/LICENSE-MIT
+
+global DIRECTORY_GIF
+global DIRECTORY_JPG
+global DIRECTORY_PNG
+global DIRECTORY_TEMP
+global ID_IMAGEOPTIM
+global ID_JPEGMINI
+global ID_JPEGMINI_RETAIL
+global ID_JPEGMINI_LITE
+global ID_JPEGMINI_LITE_RETAIL
+global ID_JPEGMINI_PRO
+global ID_JPEGMINI_PRO_RETAIL
+global JPEGMINI_APP_NAME
+
+(*
+ * @description
+ * Is the app with this bundle id installed somewhere on this machine?
+ *
+ * @param   {String}   bundleId  eg. ID_IMAGEOPTIM
+ * @return  {Boolean}
+ *)
+on isInstalled(bundleId)
+  try
+    tell application "Finder" to get application file id bundleId
+    return true
+  on error
+    return false
+  end try
+end isInstalled
+
+(*
+ * @description
+ * Check whether access for assistive devices is enabled under System
+ * Preferences, needed to perform synthetic user actions so JPEGmini can be
+ * automated.
+ *
+ * Enable access for assistive devices in Mavericks;
+ * http://www.tekrevue.com/how-to-enable-access-for-assistive-devices-in-os-x-mavericks/
+ *
+ * Enable access for assistive devices in Yosemite;
+ * https://thequantumself.wordpress.com/2014/06/26/enable-access-for-assistive-devices-in-osx-yosmite/
+ *
+ * @return  {Boolean}
+ *)
+on supportsAssistiveDevices()
+  try
+    -- return do shell script "osascript -e 'tell application \"System Events\" to get UI elements enabled'"
+    tell application "System Events" to get UI elements enabled
+  on error
+    return "ERROR_GUISCRIPT_UNREADABLE"
+  end try
+end supportsAssistiveDevices
+
+(*
+ * @description
+ * Find the appropriate JPEGmini app name, starting with the paid-for plans
+ * down to the free one.
+ *
+ * @return  {String}  eg. "JPEGmini Pro"
+ *)
+on getJpegMiniAppName()
+  if isInstalled(ID_JPEGMINI_PRO) or isInstalled(ID_JPEGMINI_PRO_RETAIL) then
+    return "JPEGmini Pro"
+  else if isInstalled(ID_JPEGMINI) or isInstalled(ID_JPEGMINI_RETAIL) then
+    return "JPEGmini"
+  else if isInstalled(ID_JPEGMINI_LITE) or isInstalled(ID_JPEGMINI_LITE_RETAIL) then
+    return "JPEGmini Lite"
+  end if
+  return "false"
+end getJpegMiniAppName
+
+on hasJPEGmini()
+  if getJpegMiniAppName() is "false" then
+    return false
+  else
+    return true
+  end if
+end hasJPEGmini
+
+on hasImageOptim()
+  return isInstalled(ID_IMAGEOPTIM)
+end hasImageOptim
+
+(*
+ * @description
+ * Run JPEGmini <variant> over the contents of DIRECTORY_JPG.
+ *)
+on runJPEGmini()
+  (* DETERMINE WHICH VERSION IS INSTALLED *)
+  set JPEGMINI_APP_NAME to getJpegMiniAppName()
+  (* QUIT IF NOT INSTALLED *)
+  if JPEGMINI_APP_NAME is "false" then
+    return "ERROR_JPEGMINI_UNAVAILABLE"
+  end if
+  (* OPEN AND FOCUS JPEGMINI *)
+  tell application JPEGMINI_APP_NAME
+    activate
+    delay 3
+    activate
+  end tell
+  (* SPAWN THE FILE > OPEN MENU *)
+  tell application "System Events"
+    keystroke "o" using {command down}
+    delay 3
+    keystroke "g" using {command down, shift down}
+    delay 2
+  end tell
+  (* NAVIGATE TO OUR FOLDER OF IMAGES *)
+  tell application "System Events"
+    tell process JPEGMINI_APP_NAME
+      (* < SIERRA, FILE PATH SELECTOR IS TEXT INPUT *)
+      if text field 1 of sheet 1 of sheet 1 of window 1 exists then
+        set value of text field 1 of sheet 1 of sheet 1 of window 1 to DIRECTORY_JPG
+        repeat
+          if (value of text field 1 of sheet 1 of sheet 1 of window 1) is not equal to DIRECTORY_JPG then
+            delay 1
+          else
+            exit repeat
+          end if
+        end repeat
+      end if
+      (* = SIERRA, FILE PATH SELECTOR IS COMBO BOX *)
+      if combo box 1 of sheet 1 of sheet 1 of window 1 exists then
+        set value of combo box 1 of sheet 1 of sheet 1 of window 1 to DIRECTORY_JPG
+        repeat
+          if (value of combo box 1 of sheet 1 of sheet 1 of window 1) is not equal to DIRECTORY_JPG then
+            delay 1
+          else
+            exit repeat
+          end if
+        end repeat
+      end if
+      (* >= HIGH SIERRA *)
+      if combo box 1 of sheet 1 of window 1 exists then
+        set value of combo box 1 of sheet 1 of window 1 to DIRECTORY_JPG
+        repeat
+          if (value of combo box 1 of sheet 1 of window 1) is not equal to DIRECTORY_JPG then
+            delay 1
+          else
+            exit repeat
+          end if
+        end repeat
+      end if
+      -- give Finder time to resolve the path
+      delay 2
+      keystroke return
+      delay 2
+      keystroke return
+      -- start optimising (>= Yosemite)
+      -- click button "Go" of sheet 1 of window 1
+      -- start optimising (<= Mavericks)
+      -- click button "Open" of sheet 1 of window 1
+    end tell
+  end tell
+  (* WAIT FOR JPEGMINI TO FINISH RUNNING *)
+  tell application "System Events"
+    set timesIdle to 0
+    repeat
+      -- get all process information | filtered to JPEGmini
+      set getRawProcess to "ps aux | grep '/Applications/" & JPEGMINI_APP_NAME & "'"
+      -- filter out JPEGmini grep | get column 3 of output (% CPU)
+      set filterRawProcess to "grep -v grep | awk '{print $3}'"
+      -- store above pipe chain in a variable
+      set getRawCpu to "RAWCPU=$(" & getRawProcess & " | " & filterRawProcess & ")"
+      -- round that variable to a whole number
+      set outputRoundedCpu to "$(printf \"%.0f\" $(echo \"scale=2;$RAWCPU\" | bc))"
+      -- join the two commands and echo it out to applescript
+      set getCpuPercent to getRawCpu & " && echo " & outputRoundedCpu
+      -- get raw terminal string output
+      set cpuPercent to (do shell script getCpuPercent) as number
+      -- give the app a little time to work
+      delay 0.5
+      -- if the app is idle
+      if (cpuPercent) < 1 then
+        -- increment number of times we've found the app consecutively idle
+        set timesIdle to timesIdle + 1
+        -- if it's been idle for long enough we can exit
+        if (timesIdle) > 5 then
+          exit repeat
+        end if
+      end if
+      -- (implied else: by not exiting we repeat again)
+    end repeat
+    delay 0.5
+  end tell
+end runJPEGmini
+
+(*
+ * @param  {String}  appName  eg. "ImageOptim"
+ *)
+on quitApp(appName)
+  tell application appName to quit
+end quitApp
+
+on quitImageOptim()
+  quitApp("ImageOptim")
+end runImageOptim
+
+on quitJPEGmini()
+  quitApp(getJpegMiniAppName())
+end runImageOptim
+
+(*
+ * @description
+ * Handle command-line arguments.
+ *
+ * @example
+ * ./imageOptimAppleScriptLib "<action>" "<quitAfter>"
+ *)
+on run argv
+
+  (* INITIALISE GLOBALS *)
+
+  set DIRECTORY_TEMP to (do shell script "echo $TMPDIR") & "imageoptim-cli/"
+  set DIRECTORY_GIF to DIRECTORY_TEMP & "gif"
+  set DIRECTORY_JPG to DIRECTORY_TEMP & "jpg"
+  set DIRECTORY_PNG to DIRECTORY_TEMP & "png"
+  set ID_IMAGEOPTIM to "net.pornel.ImageOptim"
+  set ID_JPEGMINI to "com.icvt.JPEGmini"
+  set ID_JPEGMINI_RETAIL to "com.icvt.JPEGmini-retail"
+  set ID_JPEGMINI_LITE to "com.icvt.JPEGminiLite"
+  set ID_JPEGMINI_LITE_RETAIL to "com.icvt.JPEGminiLite-retail"
+  set ID_JPEGMINI_PRO to "com.icvt.JPEGmini-Pro"
+  set ID_JPEGMINI_PRO_RETAIL to "com.icvt.JPEGmini-Pro-retail"
+
+  (* HANDLE COMMAND LINE ARGUMENTS *)
+
+  set action to item 1 of argv
+
+  (* PERFORM ACTION *)
+
+  if action is "quitImageOptim" then
+    return quitImageOptim()
+  else if action is "quitJPEGmini" then
+    return quitJPEGmini()
+  else if action is "runJPEGmini" then
+    return runJPEGmini()
+  else if action is "supportsAssistiveDevices" then
+    return supportsAssistiveDevices()
+  else if action is "getJpegMiniAppName" then
+    return getJpegMiniAppName()
+  else if action is "hasJPEGmini" then
+    return hasJPEGmini()
+  else if action is "hasImageOptim" then
+    return hasImageOptim()
+  end if
+
+end run

data/bin/imageOptimBashLib

@@ -0,0 +1,534 @@
+#!/bin/bash
+
+# https://raw.githubusercontent.com/JamieMason/LICENSES/master/LICENSE-MIT
+
+# ------------------------------------
+# DEFAULT / ENVIRONMENT VARIABLES
+# ------------------------------------
+
+# current version of ImageOptim-CLI from package.json
+VERSION="1.15.4"
+
+# {DirectoryPath} Absolute file system path to this shell script.
+CLI_PATH="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+# {DirectoryPath} Absolute file system path to where this shell script was invoked from.
+EXEC_PATH="$PWD"
+
+# {FilePath} The location of our Applescript library file.
+APPLESCRIPT_BIN="$CLI_PATH/imageOptimAppleScriptLib"
+
+# {FilePath} The location of stat (see issue #59 with stat & homebrew)
+STAT_BIN="/usr/bin/stat"
+
+# {DirectoryPath} Where we'll copy all images to be processed, compared, then returned to their
+# original locations.
+TEMP_PATH="${TMPDIR}imageoptim-cli"
+
+# {FilePath} A list of all images we'll be operating on.
+INDEX_FILE="${TEMP_PATH}/index.txt"
+
+# {FilePath[]} The original locations of every image to be processed.
+INDEX_ARRAY=[]
+
+# {Number} How many images in total being processed.
+TOTAL_IMAGES=0
+
+# {DirectoryPath|String} The optionally provided -d or --directory command line argument.
+DIRECTORY_OPTION="false"
+
+# {Number} Optinally overriden with -m or --min-quality
+MIN_QUALITY="75"
+
+# {BooleanString} Optionally use -s or --skip-if-larger with pngquant
+SKIP_IF_LARGER="false"
+
+# {BooleanString} Optionally overridden with -a or --image-alpha.
+USE_IMAGE_ALPHA="false"
+
+# {BooleanString} Optionally overridden with -j or --jpeg-mini.
+USE_JPEGMINI="false"
+
+# {BooleanString} Optionally overridden with -q or --quit.
+QUIT_ON_COMPLETE="false"
+
+# {RegEx} Supported file extensions for each application.
+FILE_TYPES_REGEX_IMAGE_ALPHA=".*(png)$"
+FILE_TYPES_REGEX_IMAGE_OPTIM=".*(bmp|gif|jpeg|jpg|pcx|png|pnm|tga|tiff)$"
+FILE_TYPES_REGEX_JPEGMINI=".*(jpg|jpeg)$"
+
+# {FilePath} Location of pngquant executable within ImageAlpha.
+PNGQUANT_PATH="${CLI_PATH}/pngquant"
+
+# {FilePath} Location of executable within ImageOptim.
+IMAGEOPTIM_BIN_PATH="/Applications/ImageOptim.app/Contents/MacOS/ImageOptim"
+
+# {BooleanString} Whether we can compare file quality afterwards, will be set to
+# true accordingly during initialisation.
+HAS_IMAGEMAGICK="false"
+
+# {BooleanString} Whether to disable ANSI colour output.
+NO_COLOR="false"
+
+# {BooleanString} Whether to print detailed information about the optimizations
+IS_VERBOSE="false"
+
+# ------------------------------------
+# LOGGING UTILS
+# ------------------------------------
+
+# Display a red error message and quit
+# param  {String}  $1  message
+function fatal {
+  if [ $NO_COLOR == "false" ]; then
+    printf "\e[31m✘ $1\033[0m\n"
+  else
+    echo "Error: $1"
+  fi
+  exit 1
+}
+
+# Display a message in green with a tick by it
+# param  {String}  $1  message
+function success {
+  if [ $NO_COLOR == "false" ]; then
+    printf "\e[32m✔ $1\033[0m\n"
+  else
+    echo "Success: $1"
+  fi
+}
+
+# Display an info message
+# param  {String}  $1  message
+function info {
+  if [ $NO_COLOR == "false" ]; then
+    printf "\e[90m$1\e[39m\n"
+  else
+    echo $1
+  fi
+}
+
+# Display a message in green
+# param  {String}  $1  message
+function format_green {
+  if [ $NO_COLOR == "false" ]; then
+    echo "\e[32m$1\e[39m"
+  else
+    echo $1
+  fi
+}
+
+# Display a message in red
+# param  {String}  $1  message
+function format_red {
+  if [ $NO_COLOR == "false" ]; then
+    echo "\e[31m$1\e[39m"
+  else
+    echo $1
+  fi
+}
+
+# Display usage information
+function usage {
+  echo "Usage: imageOptim [options]"
+  echo ""
+  echo "Options:"
+  echo ""
+  echo "  -d, --directory       directory of images to process"
+  echo "  -a, --image-alpha     pre-process PNGs with ImageAlpha.app *"
+  echo "  -j, --jpeg-mini       pre-process JPGs with JPEGmini.app **"
+  echo "  -m, --min-quality     pngquant min quality parameter"
+  echo "  -s, --skip-if-larger  pngquant use --skip-if-larger"
+  echo "  -q, --quit            quit all apps when complete"
+  echo "  -c, --no-color        disable color output"
+  echo "  -h, --help            display this usage information"
+  echo "  -e, --examples        display some example commands and uses"
+  echo "  -v, --version         display the version number"
+  echo "  --verbose             display detailed, per-file info on optimizations"
+  echo ""
+  echo "*  http://pngmini.com"
+  echo "** https://itunes.apple.com/us/app/jpegmini/id498944723"
+  echo ""
+}
+
+# Display usage examples
+function examples {
+  echo "### Optimise a directory of images"
+  echo ""
+  echo "This command will optimise all image files in your Awesome project."
+  echo ""
+  echo "    imageOptim --directory ~/Sites/Awesome # [options]"
+  echo ""
+  echo "### Optimise a filtered set of images"
+  echo ""
+  echo "This command will optimise just the .jpg files in your Awesome project."
+  echo ""
+  echo "    find ~/Sites/Awesome -name '*.jpg' | imageOptim # [options]"
+  echo ""
+  echo "### Passing additional options"
+  echo ""
+  echo "The long format for enabling options is as follows;"
+  echo ""
+  echo "    imageOptim --jpeg-mini --image-alpha --quit --no-color --directory path/to/images"
+  echo ""
+  echo "The equivalent of the above in short format is as follows;"
+  echo ""
+  echo "    imageOptim -j -a -q -c -d path/to/images"
+  echo ""
+  echo "### Adding to git pre-commit hook"
+  echo ""
+  echo "Adding the below to **your_project/.git/hooks/pre-commit** will run imageoptim-CLI"
+  echo "each time you commit new and changed files into your project. Any files which"
+  echo "aren't images will be ignored."
+  echo ""
+  echo "    images=$(git diff --exit-code --cached --name-only --diff-filter=ACM -- '*.png' '*.jpg')"
+  echo "    $(exit $?) || (echo "$images" | imageOptim && git add $images)"
+  echo ""
+}
+
+# Display the before/after result of a file
+# param  {String}  $1  label
+# param  {Number}  $2  size_before
+# param  {Number}  $3  size_after
+# param  {Number}  $4  quality_loss
+function render_result {
+  let local savings=$2-$3
+  local savings_percent=$(bc <<< "scale=2; $savings/$2 * 100")
+  local size_before=$(format_red "$(toKb $2)kb")
+  local size_after=$(format_green "$(toKb $3)kb")
+  local savings=$(format_green "$(toKb $savings)kb")
+  local savings_percent=$(format_green "$savings_percent%%")
+  local quality_loss=$(bc <<< "scale=2; 100-$4")
+  local quality_loss=$(format_green "$quality_loss%%")
+  local output="$1 was: $size_before now: $size_after saving: $savings ($savings_percent)"
+  if [[ $HAS_IMAGEMAGICK != "false" ]]; then
+    local output="$output quality: $quality_loss"
+  fi
+  printf "$output\n"
+}
+
+# Display the before/after results of all files
+function output_savings {
+  local total_before=0
+  local total_after=0
+  local perfect_quality=0
+  local actual_quality=0
+  for source_file in "${INDEX_ARRAY[@]}"; do
+    local image_type=$(get_image_type "$source_file")
+    if [[ $image_type != "unsupported" ]]; then
+      local temp_file=$(get_temp_path_for_file "$source_file")
+      local size_before=$(sizeInBytes "$source_file")
+      local size_after=$(sizeInBytes "$temp_file")
+      let local total_before=$total_before+$size_before
+      let local total_after=$total_after+$size_after
+      local perfect_quality=$(bc <<< "scale=2; $perfect_quality+100")
+      local quality_loss="false"
+      if [[ $HAS_IMAGEMAGICK == "true" ]]; then
+        local quality_loss=$(compare -metric MSE "$source_file" "$temp_file" /dev/null 2>&1 >/dev/null | awk '{print $1}')
+        if [[ $quality_loss == *:* ]]; then
+          quality_loss=0
+        fi
+        local actual_quality=$(bc <<< "scale=2; $actual_quality+$quality_loss")
+      fi
+      if [[ $IS_VERBOSE == "true" ]]; then
+        render_result "$source_file" $size_before $size_after $quality_loss
+      fi
+    fi
+  done
+  render_result "TOTAL" $total_before $total_after $quality_loss
+}
+
+# ------------------------------------
+# DETERMINE WHAT EXISTS AT A GIVEN LOCATION
+# ------------------------------------
+
+# State whether the entity at path is a "file", "directory", or "other".
+# param   {EntityPath}  $1  entity
+# return  {String}          file_type
+function get_entity_type {
+  if [ -f "$1" ]; then
+    echo "file"
+  elif [ -d "$1" ]; then
+    echo "directory"
+  else
+    echo "other"
+  fi
+}
+
+# State whether the entity at path is a "png", "jpg", "other", or "unsupported" image file.
+# param   {EntityPath}  $1  entity
+# return  {String}          image_type
+function get_image_type {
+  shopt -s nocasematch
+  if [[ "$1" =~ $FILE_TYPES_REGEX_IMAGE_ALPHA ]]; then
+    echo "png"
+  elif [[ "$1" =~ $FILE_TYPES_REGEX_JPEGMINI ]]; then
+    echo "jpg"
+  elif [[ "$1" =~ $FILE_TYPES_REGEX_IMAGE_OPTIM ]]; then
+    echo "other"
+  else
+    echo "unsupported"
+  fi
+  shopt -u nocasematch
+}
+
+# ------------------------------------
+# GATHER PATHS TO IMAGES
+# ------------------------------------
+
+# Add file received via stdin to our index file.
+# param  {FilePath}  $1  file
+function add_file_to_index {
+  local image_type=$(get_image_type "$1")
+  if [ $image_type != "unsupported" ]; then
+    echo "$1" >> $INDEX_FILE
+  else
+    info "Ignored as an unsupported file type: $LINE"
+  fi
+}
+
+# Add all files in a directory to our index file.
+# param  {DirectoryPath}  $1  directory
+function add_directory_to_index {
+  find -E "$1" -iregex $FILE_TYPES_REGEX_IMAGE_OPTIM -type f -print0 | while read -d '' -r file; do
+    add_file_to_index "$file"
+  done
+}
+
+# Read files received via stdin into an index which will outlive the LINE variable.
+function add_stdin_to_index {
+  if [ "$DIRECTORY_OPTION" == "false" ]; then
+    while read LINE; do
+      local entity_type=$(get_entity_type "$LINE")
+      if [ $entity_type == "file" ]; then
+        add_file_to_index "$LINE"
+      elif [ $entity_type == "directory" ]; then
+        add_directory_to_index "$LINE"
+      else
+        info "Ignored as neither file or directory: $LINE"
+      fi
+    done
+  fi
+}
+
+# If -d or --directory were supplied, add the contents of that directory to our processing index.
+function add_directory_option_to_index {
+  if [ "$DIRECTORY_OPTION" != "false" ]; then
+    if [ -d "$DIRECTORY_OPTION" ]; then
+      add_directory_to_index "$DIRECTORY_OPTION"
+    else
+      fatal "Value for --directory is not a directory: $LINE"
+    fi
+  fi
+}
+
+# Remove any duplicate files in our index, which may have occurred when importing directories whose
+# images have already been gathered by other means.
+function remove_duplicate_indexes {
+  LC_ALL=C sort -uf "$INDEX_FILE"  > "$INDEX_FILE.uniq.txt"
+  mv "$INDEX_FILE.uniq.txt" "$INDEX_FILE"
+}
+
+# Check we actually got some files
+# test -s means exists and size > zero
+# See: man bash | less '+/^\s*CONDITIONAL'
+function check_index_exists {
+  if [ ! -s "$INDEX_FILE" ]; then
+    fatal "No files found by the find command or in the provided directory"
+  fi
+}
+
+# Read our index file into an Array.
+function parse_index {
+  IFS=$'\n' read -d '' -r -a INDEX_ARRAY < "$INDEX_FILE"
+  TOTAL_IMAGES=${#INDEX_ARRAY[@]}
+}
+
+# Construct a clean Array containing sorted, unique paths to every image we should process.
+function gather_paths_to_images {
+  add_stdin_to_index
+  add_directory_option_to_index
+  check_index_exists
+  remove_duplicate_indexes
+  parse_index
+}
+
+# ------------------------------------
+# PREPARE A TEMPORARY DIRECTORY
+# ------------------------------------
+
+function clean {
+  rm -rf "$TEMP_PATH"
+}
+
+# Automating JPEGmini is particularily difficult and unusably slow when working with arbitrary sets
+# of files. Instead, we create a temporary directory and pass that once to JPEGmini rather than
+# each file individually.
+function init_temp_directory {
+  clean
+  mkdir -p "$TEMP_PATH"
+  chmod 777 "$TEMP_PATH"
+}
+
+# Get the absolute path of an entity
+# param   {EntityPath}  $1  entity
+# return  {EntityPath}      absolute_path
+function to_absolute {
+  local present_dir="$PWD"
+  local file_dir=$(dirname "$1")
+  local file_name=$(basename "$1")
+  cd "$file_dir"
+  local absolute_dir="$PWD"
+  cd "$present_dir"
+  echo "${absolute_dir}/${file_name}"
+}
+
+# Determine the location in our temp directory a given file should be held at.
+# param   {FilePath}  $1  file
+# return  {FilePath}      temp_file
+function get_temp_path_for_file {
+  local absolute_path=$(to_absolute "$1")
+  local image_type=$(get_image_type "$absolute_path")
+  echo "${TEMP_PATH}/${image_type}/$absolute_path"
+}
+
+# Copy all files received to a temp directory, grouped by file extension.
+function populate_temp_directories {
+  local image_type
+  local temp_file
+  for source_file in "${INDEX_ARRAY[@]}"; do
+    image_type=$(get_image_type "$source_file")
+    temp_file=$(get_temp_path_for_file "$source_file")
+    if [[ $image_type != "unsupported" ]]; then
+      ditto "$source_file" "$temp_file"
+    fi
+  done
+}
+
+# @TODO: DRY these two methods
+
+# Copy all files received back to their original locations.
+function replace_originals {
+  local image_type
+  local temp_file
+  for source_file in "${INDEX_ARRAY[@]}"; do
+    image_type=$(get_image_type "$source_file")
+    temp_file=$(get_temp_path_for_file "$source_file")
+    if [[ $image_type != "unsupported" ]]; then
+      ditto "$temp_file" "$source_file"
+      rm "$temp_file"
+    fi
+  done
+}
+
+# Gather paths to all images we should process and prepare a temporary directory containing copies.
+function prepare_images {
+  gather_paths_to_images
+  if [ $TOTAL_IMAGES -gt 0 ]; then
+    populate_temp_directories
+  fi
+}
+
+function start {
+  init_temp_directory
+  prepare_images
+}
+
+function finish {
+  replace_originals
+  clean
+}
+
+# ------------------------------------
+# INVOKE IMAGE APPLICATIONS
+# ------------------------------------
+
+# Determine whether GUI Scripting is enabled, which is needed to automate JPEGmini.
+function has_gui_script {
+  echo `osascript "$APPLESCRIPT_BIN" supportsAssistiveDevices`
+}
+
+# State whether eg node, brew, gem etc is installed
+# param   {CliApp}         $1  bin
+# return  {BooleanString}      is_installed
+function has_imagemagick {
+  local is_installed="true"
+  type compare >/dev/null 2>&1 || { local is_installed="false"; }
+  echo "$is_installed"
+}
+
+function has_imageoptim {
+  echo `osascript "$APPLESCRIPT_BIN" hasImageOptim`
+}
+
+function has_jpegmini {
+  echo `osascript "$APPLESCRIPT_BIN" hasJPEGmini`
+}
+
+function get_jpegmini_app_name {
+  echo `osascript "$APPLESCRIPT_BIN" getJpegMiniAppName`
+}
+
+# If enabled and installed, run ImageAlpha on our temp directory
+function run_image_alpha {
+  if [ "true" == "$USE_IMAGE_ALPHA" ]; then
+    info "Running ImageAlpha..."
+    local added_options
+    if [ "true" == "$SKIP_IF_LARGER" ]; then
+      added_options="--skip-if-larger"
+    fi
+    find "${TEMP_PATH}/png" -type f -print0 | xargs -n10 -P8 -0 "$PNGQUANT_PATH" --ext=.png --force --speed=1 --quality="$MIN_QUALITY"-100 ${added_options} --
+  fi
+}
+
+# If enabled and installed, run JPEGmini on our temp directory
+function run_jpegmini {
+  if [ "true" == "$USE_JPEGMINI" ]; then
+    if [ "true" == "$HAS_JPEGMINI" ]; then
+      if [ "true" != "$HAS_GUI_SCRIPT" ]; then
+        fatal "To automate JPEGmini we need to add Terminal.app (or iTerm.app etc) to the 'support for assistive devices' whitelist. Please see README for more details."
+      fi
+      info "Running ${JPEGMINI_NAME}..."
+      local location=`osascript -e "POSIX path of (path to application \"${JPEGMINI_NAME}\")"`
+      open "${location}"
+      osascript "$APPLESCRIPT_BIN" runJPEGmini
+      if [ "true" == "$QUIT_ON_COMPLETE" ]; then
+        osascript "$APPLESCRIPT_BIN" quitJPEGmini
+      fi
+    else
+      fatal "JPEGmini is not installed (https://itunes.apple.com/us/app/jpegmini/id498944723)"
+    fi
+  fi
+}
+
+# If enabled and installed, run ImageOptim on our temp directory
+function run_image_optim {
+  info "Running ImageOptim..."
+  # find where imageoptim is installed (opens app)
+  local location=`osascript -e 'POSIX path of (path to application "ImageOptim")'`
+  # close duplicate app
+  osascript "$APPLESCRIPT_BIN" quitImageOptim
+  # run images over the app
+  "${location}Contents/MacOS/ImageOptim" 2> /dev/null "${TEMP_PATH}"
+  if [ "true" == "$QUIT_ON_COMPLETE" ]; then
+    osascript "$APPLESCRIPT_BIN" quitImageOptim
+  fi
+}
+
+# ------------------------------------
+# GET AND MANAGE FILE SIZES
+# ------------------------------------
+
+# Get the size of a file, in bytes.
+# param   {FilePath}  $1  file
+# return  {Number}        file_size
+function sizeInBytes {
+  echo $($STAT_BIN -f %z "$1")
+}
+
+# Convert a value in bytes to kilobytes in 3 decimal places, 1b is 0.001kb for example.
+# param   {Number}  $1  bytes
+# return  {Number}      kilobytes
+function toKb {
+  echo $(bc <<< "scale=3; $1/1000")
+}