photish 0.5.3 → 0.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWMyMTJmOTViNGQwNzY4ODI5NDIxNjZhNWJhYzY3ZWY2MWY0OGI4NQ==
+    MjhjN2EzYzNmNjVkNGI0YjVlYmU5OWUxYjJmYjBkZDgzODY5NWMzMg==
   data.tar.gz: !binary |-
-    OTJhMzAyOWVmOTE5NTdiOGQ0MmI0ZGU4NTY0YTFiZjliMjM0OWUwMg==
+    NzEwNmIxNzdjNDkwOTkzMTYyOGZlMDJlYjViMjUyNTlkYTdlOWZhNw==
 SHA512:
   metadata.gz: !binary |-
-    MmE0Yjg5ZmNhODY1NDJhZDQxNTE0MTdjNDNkZTE5ZmUxMDgxMGYwODcxYTk1
-    MTlmODRiMzE2ZGU5YjcyZmUyODk2ZDU3YWQ4NWQyMTZkYzBiM2VmMjM4ZTE1
-    MTQ0YThjMjMxZGMyMjFkYzI0NDkzNjQ0MDMzNzQzMGVmYWZmZTc=
+    ZGRjOGY1Nzg4Mjk3OThjOWQ2MTEwNzVkZjk3MzQ3MDkwMTJlYjdhMTFmYWQw
+    ZmMzZTU3NjJiMmYzYzNiZDk5NWNmNmFkOTRmN2I5ZTNjNDg0YWZiZDNjOGFm
+    YTQ4NmUzYzUwN2UyYTc1YmQxOWU0OWFkY2MxOTRkNzJmODhkZjE=
   data.tar.gz: !binary |-
-    YTg2MmEyYWMwNGVkYTMwMTA1MmY5ZDE4YjI5Mjc4NTZlNzc3NDUxNGY4NmNh
-    M2VkMTZmMzQ5MjNhN2I5OGM3NDZmNzM4ZjE4ZmRlZjVhYTBkMjJlYjM4Zjc0
-    ODkzYmVmOTkzOWRkYmZlNTc5ZWI0NGYxODU5MTY2YzRhNzFmNDQ=
+    YTk3NTM5ZTE1MjY5ZDYyYzFiZGI0ZjM5NzUyZTcyNGM0YTU1NmVhODY0NzE1
+    OWU5Yjg1NzE5ZjQ2YWJjNTJmYjNjNmU3ZTMxM2M3YjExZmZhMzE4YTg5OTA0
+    ZGQ4MzFjZjBiYWI0MWUxZmU0OTk1YmY4ZmU4OWUyZGI0N2U2YzY=

data/.travis.yml

@@ -13,32 +13,26 @@ addons:
 cache: bundler
 matrix:
   include:
-    - rvm: ruby-head
     - rvm: 2.3.0
       env: COVERAGE=1 DEPLOY=1
     - rvm: 2.2
     - rvm: 2.1
     - rvm: 2.0
 
-    - rvm: jruby-head
     - rvm: jruby-9.0
       env: SMOKE_TEST_ONLY=1
 
-    - rvm: rbx
     - rvm: rbx-3.2
       env: SMOKE_TEST_ONLY=1
     - rvm: rbx-2.7
       env: SMOKE_TEST_ONLY=1
   fast_finish: true
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: rbx
 deploy:
   provider: rubygems
   on:
     repo: henrylawson/photish
     condition: "$DEPLOY = 1"
+    branch: master
     tags: true
   api_key:
     secure: nFNY85dNmvdhc8H2t/tIiv0xTeWctitZSs2WtlVzOFpbNFac9rqd4ZhNQb/l2QiukquMdbWVzSr2uPZ+gJwhV/yWtX+xNbnPHdW/u5upX5PO9SNZImx8iVS95bViW+zygp3rZvVS6oVeIg4xAzuBMlviomYhp8lGRISWAM5efznK+NkLw16BiiDVQQ3KKLst0Ydo2TIzjkpfeFyNK9qj0Joxqllojo+QVBFUN+vHQcC2VgOQIJjCKshlRKDtMwvvt5+qjBPs5IsTwWkySkkum3WRLxwUXHoMqKqxbYfgXtr2A7KUKiGkK9L2zVYOYCErKDuS+YgQ3AgxnFsToOR8hp6SRv1WhR8Vix67u3A7dRmJ1hdyt0Re5+LyvHAuKXuUB6gJ8rbWpf56i4fbGCjl9IVE4YB+PfwRDwBAttXQTtYZE7AuseH+qdUYPRq3zLlYIcFxEliyNhh5Ud8aBh+ciM2R7ql0wA2Fu8tOK/2beoBWjifZc0z/B/hDHO4JGsphJaz59wPk/3DV6sCmaS4iMPAKtoyRdTyUN/hnzpq99LOEoQLCWUteWet5saV0svOQ3THRTZYO2mUX18Yb1Xjrm6iGhpjOMueBn+X12WLSXgHLuWV07/30cFdUOuhrGGu68weoMUY060PIdslUFtygSWIVVtvDpX1W52MLZyINeaA=

data/README.md

@@ -74,6 +74,7 @@ and running:
       - [Asset Page](#asset-page)
   - [Generate](#generate)
     - [Execution Order](#execution-order)
+    - [Image Conversion Tools](#image-conversion-tools)
     - [Workers and Threads](#workers-and-threads)
     - [Caching](#caching)
       - [Automatic Rengeneration](#automatic-regeneration)
@@ -360,6 +361,11 @@ force: false
 plugins: ['ssh_deploy', 'other_plugin']
 image_extensions: ['jpg', 'gif']
 page_extension: 'slim'
+dependencies:
+  minimagick:
+    cli: 'imagemagick'
+    cli_path:
+    timeout: 3600
 ```
 
 The meanings and purpose of each field is defined below:
@@ -389,6 +395,11 @@ Field                  | Purpose
 `plugins`              | an array of plugin names that have been included in your Gemfile and that Photish should require into it's runtime
 `image_extensions`     | by default, Photish has a complete list of image extensions, however if you choose too, you can explicitly list the extensions that Photish should use to find images
 `page_extension`       | the extension of **Pages** files that will live amongst the photo collection
+`dependencies`         | this section is for the configuration of third party tools
+`dependencies/minimagick`          | configuration for [minimagick](https://github.com/minimagick/minimagick), the wrapping library around [ImageMagick](http://www.imagemagick.org/) or [GraphicsMagick](http://www.graphicsmagick.org/)
+`dependencies/minimagick/cli`      | provide `imagemagick`, or `graphicsmagick` depending on your chosen library
+`dependencies/minimagick/cli_path` | if the above executables are not in your PATH, you can provide it explicitly here
+`dependencies/minimagick/timeout`  | terminate a command after the provided number of seconds
 
 #### Customizing Templates
 
@@ -651,6 +662,35 @@ The Generate command does the following:
 1. Converts all Photo(s) to the configured quality versions, writing various
    images to the `output` folder
 
+#### Image Conversion Tools
+
+Photish supports [ImageMagick](http://www.imagemagick.org/) or
+[GraphicsMagick](http://www.graphicsmagick.org/) for image conversion.
+
+By default, Photish will assume [ImageMagick](http://www.imagemagick.org/) is
+installed. To change this, ensure
+[GraphicsMagick](http://www.graphicsmagick.org/) is installed and the utility
+is availabe on the PATH. Then ensure that the [Config File
+Option](#config-file-option) `dependencies/minimagick/cli` is set to
+`graphicsmagick`. For example:
+
+```yaml
+dependencies:
+  minimagick:
+    cli: graphicsmagick
+```
+
+If [ImageMagick](http://www.imagemagick.org/) or
+[GraphicsMagick](http://www.graphicsmagick.org/) is not available on the PATH
+you can manually specify it's location by setting
+`dependencies/minimagick/cli_path`. For example:
+
+```yaml
+dependencies:
+  minimagick:
+    cli_path: '/usr/bin/convert'
+```
+
 #### Workers and Threads
 
 In order to achieve maximum utilization of all processors on a computer during

data/TODO.md

@@ -2,12 +2,8 @@
 
 ## In Progress
 
-1. Create config to configure mini magick
-   (http://www.rubydoc.info/github/minimagick/minimagick/MiniMagick/Configuration)
 1. Create config to configure mini exiftool, also invalid chars
    (https://github.com/janfri/mini_exiftool#configuration)
-1. Configure releases from travis-ci
-   (https://docs.travis-ci.com/user/deployment/rubygems)
 1. Consider adding after release step of bumping and pushing other projects
    (https://docs.travis-ci.com/user/deployment/custom/)
 

data/lib/photish/config/default_config.rb

@@ -19,12 +19,26 @@ module Photish
           plugins: [],
           image_extensions: image_extensions,
           page_extension: 'slim',
-          soft_failure: false
+          soft_failure: false,
+          dependencies: {
+            minimagick: minimagick
+          }
         }
       end
 
       private
 
+      def minimagick
+        {
+          cli: 'imagemagick',
+          cli_path: nil,
+          timeout: 3600,
+          validate_on_create: true,
+          validate_on_write: true,
+          whiny: true
+        }
+      end
+
       def image_extensions
         ['aai', 'art', 'avs', 'bgr', 'bgra', 'bgro', 'bmp', 'bmp2', 'bmp3', 'brf', 'cal', 'cals', 'canvas', 'caption', 'cin', 'cip', 'clip', 'cmyk', 'cmyka', 'cur', 'cut', 'data', 'dcm', 'dcx', 'dds', 'dfont', 'dpx', 'dxt1', 'dxt5', 'eps2', 'eps3', 'fax', 'fits', 'fractal', 'fts', 'g3', 'gif', 'gif87', 'gradient', 'gray', 'group4', 'h', 'hald', 'hdr', 'histogram', 'hrz', 'htm', 'html', 'icb', 'ico', 'icon', 'inline', 'ipl', 'isobrl', 'isobrl6', 'jng', 'jnx', 'jpe', 'jpeg', 'jpg', 'jps', 'label', 'mac', 'magick', 'map', 'mask', 'matte', 'miff', 'mng', 'mono', 'mpc', 'msl', 'mtv', 'mvg', 'null', 'otb', 'otf', 'pal', 'palm', 'pam', 'pango', 'pattern', 'pbm', 'pcd', 'pcds', 'pct', 'pcx', 'pdb', 'pes', 'pfa', 'pfb', 'pfm', 'pgm', 'picon', 'pict', 'pix', 'pjpeg', 'plasma', 'png', 'png00', 'png24', 'png32', 'png48', 'png64', 'png8', 'pnm', 'ppm', 'preview', 'ps2', 'ps3', 'psb', 'psd', 'ptif', 'pwp', 'radial-gradient', 'ras', 'rgb', 'rgba', 'rgbo', 'rgf', 'rla', 'rle', 'scr', 'sct', 'sfw', 'sgi', 'shtml', 'six', 'sixel', 'sparse-color', 'stegano', 'sun', 'text', 'tga', 'thumbnail', 'tiff', 'tiff64', 'tile', 'tim', 'ttc', 'ttf', 'ubrl', 'ubrl6', 'uil', 'uyvy', 'vda', 'vicar', 'vid', 'viff', 'vips', 'vst', 'wbmp', 'wpg', 'xbm', 'xc', 'xcf', 'xpm', 'xv', 'ycbcr', 'ycbcra', 'yuv']
       end

data/lib/photish/render/image.rb

@@ -11,6 +11,7 @@ module Photish
       def render(images)
         log.debug "Rendering #{images.count} images across #{threads} threads"
 
+        setup_minimagick
         cache_load_from_disk
         threads = spawn_thread_instances(to_queue(images))
         threads.map(&:join)
@@ -80,7 +81,6 @@ module Photish
           convert << image.path
           convert.merge!(image.quality_params)
           convert << output_path(image)
-          log.debug "Performing image conversion #{convert.command}"
         end
       rescue MiniMagick::Error => e
         log.warn "Error occured while converting"
@@ -102,6 +102,27 @@ module Photish
                                        worker_index,
                                        version_hash)
       end
+
+      def minimagick_config
+        config.dependencies.minimagick
+      end
+
+      def debug?
+        config.logging.level == 'debug'
+      end
+
+      def setup_minimagick
+        MiniMagick.configure do |config|
+          config.cli = minimagick_config.cli.to_sym
+          config.cli_path = minimagick_config.cli_path if minimagick_config.cli_path
+          config.debug = debug?
+          config.logger = MiniMagick::Logger.new(Log::IO.new(log, :debug))
+          config.timeout = minimagick_config.timeout
+          config.validate_on_create = minimagick_config.validate_on_create
+          config.validate_on_write = minimagick_config.validate_on_write
+          config.whiny = minimagick_config.whiny
+        end
+      end
     end
   end
 end

data/lib/photish/version.rb

@@ -1,5 +1,5 @@
 module Photish
-  VERSION = "0.5.3"
+  VERSION = "0.6.0"
   AUTHOR_NAME = "Henry Lawson"
   AUTHOR_EMAIL = "henry.lawson@foinq.com"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: photish
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Henry Lawson