photish 0.3.10 → 0.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a602e2fa444afd9abffa153c6bc9dd7b7bf7dc75
-  data.tar.gz: 618a774823ec2eda75b667161c1c4d673189e64f
+  metadata.gz: dd549e0b900be9de4fb137293813237d8e320aa4
+  data.tar.gz: 96dbedfaf551bbb1d3e70c8a6f6a383707578ac3
 SHA512:
-  metadata.gz: db17ce6d45a74db3af8ab7d070f142e1078b8fca9d285d1e855857e64d81ac7dfdac2788df7a9d5252944c751bd371c04220776fbffd96b4a6d7119849631f27
-  data.tar.gz: 837e4ecac164613042b9ba202708b97ead4a0ed19522ea1c3185cf7bd79423a196d601eebf33bfd471272c08a6fd62f9e84541f0528af8566d392f73a82066b7
+  metadata.gz: 0cee42768c288ffbd5a31011b0fdff42fd4ddf18b1127492b43a0da0275ee8a44cf17dc5c688aa2f43718854d6a592f7ac3aa42706a389dedab8cab6f2dd4366
+  data.tar.gz: aaf9bef8e114106b96e2c9e77960364deee7b8a4f83ffdfe75ab8dc9c573d50b4d8de0c4a25d7632d48a95603051fb4ecf4e4cd121d89abee7519a695f1144c7

data/.simplecov

@@ -3,15 +3,19 @@ require 'codeclimate-test-reporter'
 SimpleCov.start(CodeClimate::TestReporter.configuration.profile) do
   filters.clear
 
+  root(File.expand_path(File.dirname(__FILE__)))
+
   add_filter do |src|
     !(src.filename =~ /^#{SimpleCov.root}/) unless src.filename =~ /photish/
   end
-
+  add_filter '/gems/photish'
   add_filter '/bin/'
   add_filter '/coverage/'
   add_filter '/exe/'
   add_filter '/log/'
   add_filter '/pkg/'
+  add_filter 'vendor'
+  add_filter 'tmp'
 
   add_group 'Library',  'lib'
   add_group 'Specs',    'spec'

data/README.md

@@ -318,6 +318,7 @@ workers: 4
 threads: 2
 force: false
 plugins: ['ssh_deploy', 'other_plugin']
+image_extensions: ['jpg', 'gif']
 ```
 
 The meanings and purpose of each field is defined below:
@@ -345,6 +346,7 @@ Field                  | Purpose
 `threads`              | the number of threads each worker should create to handle image magick transcoding
 `force`                | this should always be false, if true, all content will be regenerated and nothing cached
 `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 obtains a list of supported image format extensions from ImageMagick, however if you choose too, you can explicitly list the extensions that Photish should use to find images
 
 #### Customizing Templates
 
@@ -685,7 +687,10 @@ Photish supports extension through the creation of plugins.
 
 To create a template helper plugin you must:
 
-1. Create a **Ruby module** in the `Photish::Plugin` module namespace
+1. Create a **Ruby Module** in the `Photish::Plugin` module namespace, if
+   you are packaging the plugin as a Gem, you can implement your module one
+   level deeper in the namespace to allow for the Gem namespace, e.g.
+   `Photish::Plugin::MyGemPlugin::MyTemplateHelper`
 1. Make the plugin available for [loading](#plugin-loading)
 1. Implement the `self.is_for?(type)` method
 1. Implement your custom helper method(s)
@@ -737,7 +742,10 @@ Some "core" Template Helper plugins available in Photish by default are:
 
 To create a deployment engine plugin you must:
 
-1. Create a **Ruby class** in the `Photish::Plugin` module namespace
+1. Create a **Ruby Class** in the `Photish::Plugin` module namespace, if
+   you are packaging the plugin as a Gem, you can implement your module one
+   level deeper in the namespace to allow for the Gem namespace, e.g.
+   `Photish::Plugin::MyGemPlugin::MyDeployEngine`
 1. Make the plugin available for [loading](#plugin-loading)
 1. Implement a `self.is_for?(type)` method and respond true when it receives
    the `Photish::Plugin::Type::Deploy` type
@@ -775,18 +783,70 @@ module Photish::Plugin::MyCustomDeploy
 end
 ```
 
+Some reference implementations of deploy plugins are:
+
+1. [Photish SSH Deploy](https://github.com/henrylawson/photish-plugin-sshdeploy)
+1. [Tmp Dir Deploy](https://github.com/henrylawson/photish/blob/master/lib/photish/assets/example/site/_plugins/tmpdir_deploy.rb)
+
 ### Plugin Loading
 
-Photish supports the following methods of Plugin loading:
+Photish supports the following methods of Plugin loading.
+
+#### Site Folder Loading
+
+By default, Photish will automatically load all files in the `site/_plugins`
+directory. This is the most simple way and is recommended if you just want to
+write a simple helper specific to your site.
+
+The example site created when running `photish generate --example` uses this
+method to load plugins.
+
+#### Explicit Gem Loading
+
+This is recommended method if you want to utilize a plugin created by someone
+else in the community - rather than simply copy pasting their code to your
+`site/_plugins` directory. It is done by including a Gem in your Photish site's
+`Gemfile` and listing the require path of the Gem in the `plugins` [Config File
+Option](#config-file-options).
+
+An example of Explicit Gem Loading is provided by the [Photish
+Montage](https://github.com/henrylawson/photish-montage) demo that explicitly
+loads the
+[Photish::Plugin::Sshdeploy](https://github.com/henrylawson/photish-plugin-sshdeploy)
+Gem.
+
+To load a Gem as a plugin, first of all add the Gem to your Gemfile:
+
+**Gemfile**
+
+```Gemfile
+gem 'photish-plugin-sshdeploy'
+```
+
+And in your Photish config, ensure it is listed in your `plugins` [Config File
+Option](#config-file-options).
+
+**config.yml**
+
+```YAML
+plugins: ['photish/plugin/sshdeploy']
+```
+
+Then run `bundle install`.
+
+To confirm that it is installed correctly, when you run the `photish generate`
+command, you should see the plugin load:
+
+**log/photish.log or STDOUT**
+
+```
+...
+... Photish::Plugin::Repository: Found plugin Photish::Plugin::Sshdeploy::Deploy
+...
+```
 
-1. Automatic loading of files in the `site/_plugins` directory. This is the
-   most simple way and is recommended if you just want a simple helper specific
-   to your site.
-1. Including a Gem in your Photish site's `Gemfile` and listing the name of the
-   Gem in the `plugins` [Config File Option](#config-file-options). This is
-   recommended if you want to utilize a plugin created by someone else in the
-   community - rather than simple copy pasting their code to your
-   `site/_plugins` directory.
+Note the 'photish-plugin-sshdeploy' Gem has other install steps documented in
+it's [README](https://github.com/henrylawson/photish-plugin-sshdeploy).
 
 ## Development
 

data/TODO.md

@@ -2,13 +2,8 @@
 
 ## In Progress
 
-1. Extract the SSH deploy to gem
-
 ## Backlog
 
-1. Dry up the SimpleCov config that is everywhere
-1. Mime-types gem required 2.0 and above, lost 1.9.x, does this matter?
-1. Need to have parameters to change on deploy
 1. Worker can die when large folders moved mid generation
 1. Changing convert items does not trigger regeneration but changing name does
 1. Templates with exif data, super slow
@@ -21,4 +16,3 @@
 1. Provide generic way to override config from arguments to allow for host name
    override on deploy etc.
 1. Video transcoding and template rendering
-1. JRuby support, perhaps?

data/exe/photish

@@ -3,9 +3,6 @@
 if ENV['COVERAGE']
   require 'simplecov'
   SimpleCov.command_name "photish-binary-#{Process.pid}"
-  SimpleCov.add_filter 'vendor'
-  SimpleCov.add_filter 'tmp'
-  SimpleCov.root(File.join(File.expand_path(File.dirname(__FILE__)), '..'))
 end
 
 if ENV['PROFILE']

data/lib/photish/command/generate.rb

@@ -25,6 +25,7 @@ module Photish
                :workers,
                :force,
                :threads,
+               :image_extensions,
                to: :config
 
       delegate :concat_db_files,
@@ -69,7 +70,8 @@ module Photish
       def collection
         @collection ||= Gallery::Collection.new(photo_dir,
                                                 qualities_mapped,
-                                                url)
+                                                url,
+                                                image_extensions)
       end
 
       def qualities_mapped

data/lib/photish/command/worker.rb

@@ -18,6 +18,7 @@ module Photish
                :qualities,
                :url,
                :worker_index,
+               :image_extensions,
                to: :config
 
       def load_all_plugins
@@ -33,7 +34,8 @@ module Photish
       def collection
         @collection ||= Gallery::Collection.new(photo_dir,
                                                 qualities_mapped,
-                                                url)
+                                                url,
+                                                image_extensions)
       end
 
       def qualities_mapped

data/lib/photish/config/default_config.rb

@@ -16,12 +16,17 @@ module Photish
           templates: templates,
           logging: logging,
           url: url,
-          plugins: []
+          plugins: [],
+          image_extensions: image_extensions
         }
       end
 
       private
 
+      def image_extensions
+        ImageExtension::IMAGE_MAGICK
+      end
+
       def url
         {
           host: '',

data/lib/photish/config/image_extension.rb

@@ -0,0 +1,8 @@
+module Photish
+  module Config
+    module ImageExtension
+      # Taken from 'convert -list format'
+      IMAGE_MAGICK = ['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', 'txt', 'ubrl', 'ubrl6', 'uil', 'uyvy', 'vda', 'vicar', 'vid', 'viff', 'vips', 'vst', 'wbmp', 'wpg', 'xbm', 'xc', 'xcf', 'xpm', 'xv', 'ycbcr', 'ycbcra', 'yuv']
+    end
+  end
+end

data/lib/photish/gallery/album.rb

@@ -7,6 +7,7 @@ module Photish
       include Photish::Plugin::Pluginable
 
       delegate :qualities,
+               :image_extensions,
                :url_info,
                to: :parent, allow_nil: true
 
@@ -42,10 +43,7 @@ module Photish
 
       def image_format?(file)
         extension = File.extname(file).split('.').last.try(:downcase)
-        return if extension.nil?
-        MIME::Types.type_for(extension).any? do
-          |mime| mime.to_s.match(formats)
-        end
+        image_extensions.include?(extension)
       end
 
       def album_class
@@ -55,12 +53,6 @@ module Photish
       def url_end
         'index.html'
       end
-
-      def formats
-        Regexp.union([
-          /image/i
-        ])
-      end
     end
   end
 end

data/lib/photish/gallery/collection.rb

@@ -7,13 +7,15 @@ module Photish
       include Photish::Plugin::Pluginable
 
       attr_reader :qualities,
-                  :url_info
+                  :url_info,
+                  :image_extensions
 
-      def initialize(path, qualities, url_info)
+      def initialize(path, qualities, url_info, image_extensions)
         super
         @path = path
         @qualities = qualities
         @url_info = url_info
+        @image_extensions = Set.new(image_extensions)
       end
 
       def name

data/lib/photish/version.rb

@@ -1,3 +1,3 @@
 module Photish
-  VERSION = "0.3.10"
+  VERSION = "0.3.11"
 end

data/lib/photish.rb

@@ -12,11 +12,11 @@ require 'thor'
 require 'recursive_open_struct'
 require 'cgi'
 require 'facter'
-require 'mime-types'
 require 'thread'
 require 'thwait'
 require 'slim'
 require 'colorize'
+require 'open3'
 
 # Photish
 require 'photish/log/loggable'
@@ -34,6 +34,7 @@ require 'photish/command/host'
 require 'photish/command/init'
 require 'photish/command/deploy'
 require 'photish/cli/interface'
+require 'photish/config/image_extension'
 require 'photish/config/default_config'
 require 'photish/config/file_config'
 require 'photish/config/file_config_location'

data/photish.gemspec

@@ -31,7 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "recursive-open-struct", "~> 1.0"
   spec.add_dependency "listen", "~> 3.0"
   spec.add_dependency "facter", "~> 2.4"
-  spec.add_dependency "mime-types", "~> 3.0"
   spec.add_dependency "colorize", "~> 0.7.7"
 
   spec.add_development_dependency "anemone", "~> 0.7"
@@ -44,4 +43,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "rspec-html-matchers"
   spec.add_development_dependency "metric_fu"
+  spec.add_development_dependency "photish-plugin-sshdeploy"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: photish
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.3.11
 platform: ruby
 authors:
 - Henry Lawson
@@ -136,20 +136,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: mime-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -304,6 +290,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: photish-plugin-sshdeploy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   Photish is a simple, convention based (but
     configurable) static photo site generator.
@@ -369,6 +369,7 @@ files:
 - lib/photish/config/default_config.rb
 - lib/photish/config/file_config.rb
 - lib/photish/config/file_config_location.rb
+- lib/photish/config/image_extension.rb
 - lib/photish/core_plugin/breadcrumb.rb
 - lib/photish/core_plugin/build_url.rb
 - lib/photish/gallery/album.rb