photish 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4815953c918957b9276b9f71f6ad4e296a8c4120
-  data.tar.gz: 27900c1a28826e6e1c69ec35c4c67388b6638347
+  metadata.gz: d39b760e4b3dd56a1feefd2aa4149d8e8f8f8b20
+  data.tar.gz: 721fc210a9c59c7bb43acbccedc3d2802bc9c3d5
 SHA512:
-  metadata.gz: 8941c122835aed8ffc2dac6c0f0b1f3c1f6b286ec0c9a020df21c252db438a9c9905fe9ef2b5ae8382674abb35810aa95f23ec7038bf8f2a27f50b7026aed7ba
-  data.tar.gz: 953ba2db9319f21c7dee454c8ddb63da089838d36737c6c459f8c2313e099db5253bb63cb56aaaba9d2b82a8bd7b9a59205ae2da99dc2fc76adbdf89318d192b
+  metadata.gz: 495b94ebf70ea1ed448cb4043382e3e6fe89778538c6a6640c453c595427fafba5cdd6e67b9f758d3fabe235b6b3a9dabd1664c462f0cee3f00f4c10b58c1a01
+  data.tar.gz: 07827e7468ba84db98ff8021a0828a38dc7e2cf94957cfd62da379944a1cf4c3f779361305992c775117ec74f022cbed80bbfa59fe10d660930111833d7a9cd5

data/.gitignore

@@ -1,10 +1,10 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/lib/photish/assets/output
+.bundle
+.yardoc
+Gemfile.lock
+_yardoc
+coverage
+doc
+pkg
+spec/reports
+tmp
+lib/photish/assets/output

data/README.md

@@ -53,10 +53,14 @@ and running:
       - [Collection Template](#collection-template)
       - [Album Template](#album-template)
       - [Photo Template](#photo-template)
+      - [Template Helpers](#template-helpers)
   - [Generate](#generate)
     - [Execution Order](#execution-order)
   - [Host](#host)
   - [Rake Task](#rake-task)
+  - [Plugins](#plugins)
+    - [Template Helper Plugins](#template-helper-plugins)
+    - [Plugin Loading](#plugin-loading)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -381,6 +385,48 @@ metadata            | an object with methods for the attributes in the `{photo_n
 exif                | an object with methods for the exif data of the original photo file
 images              | an array of all the [Images](https://github.com/henrylawson/photish/blob/master/lib/photish/gallery/image.rb) for this photo, an Image will be a version of the photo in the quality configured in `config.yml`
 
+#### Template Helpers
+
+A template helper is a simple method that is available in the template that can
+be called to render complex information.
+
+For example in a template, the method `breadcrumbs` can be called:
+
+```slim
+div.content
+  div.site-breadcrumbs
+    == breadcrumbs
+```
+
+When rendered this will result in an unordered list of pages above the
+current page in the hierarchy:
+
+```html
+<div class="content">
+  <div class="site-breadcrumbs">
+    <ul class="breadcrumbs">
+      <li class="breadcrumb crumb-0 crumb-first">
+        <a href="/index.html">Home</a>
+      </li>
+      <li class="breadcrumb crumb-1">
+        <a href="/big-dogs/index.html">Big Dogs</a>
+      </li>
+      <li class="breadcrumb crumb-2 crumb-last">
+        <a href="/big-dogs/tired-dogs/index.html">Tired Dogs</a>
+      </li>
+    </ul>
+  </div>
+</div>
+```
+
+Custom template helpers are supported through [Plugins](#plugins).
+
+By default, Photish comes with the following helpers:
+
+Method      | Description
+----------- | -----------
+breadcrumbs | an unordered list of pages above the current page in the hierarchy
+
 ### Generate
 
 The static HTML can be generated by running the below command inside the
@@ -437,6 +483,58 @@ end
 The above code will define a rake task called `generate` which can be ran
 by using `rake generate`. It is the equivalent of `photish generate`.
 
+### Plugins
+
+Photish supports extension through the creation of plugins.
+
+#### Template Helper Plugins
+
+To create a template helper plugin you must:
+
+1. Create a module in the `Photish:Plugin` module namespace
+1. Implement the `self.is_for?(type)` method
+1. Implement your custom helper method(s)
+
+A simple plugin is bellow, this plugin is for all [Photo
+Template](#photo-template)'s as the `self.is_for?(type)` method only returns
+true for `Photish::Plugin::Type::Photo` types. When the `shout` method is
+called inside the template, it will render the message in bold wrapped in the
+"I am shouting" text.
+
+**site/_plugins/shout.rb**
+```ruby
+require 'nokogiri'
+
+module Photish::Plugin::Shout
+
+  def self.is_for?(type)
+    Photish::Plugin::Type::Photo == type
+  end
+
+  def shout(message)
+    "<strong>I am shouting '#{message}'!!!</strong>"
+  end
+end
+```
+
+If the above code is saved to `site/_plugins/shout.rb` Photish will detect the
+plugin ruby file at runtime and it will load and make the method available in
+the template.
+
+A usage example is below
+
+**site/_templates/photo.slim**
+```slim
+div.my-shouting-content
+  == shout("HELLO")
+```
+
+### Plugin Loading
+
+All ruby files in `site/_plugins` will be loaded into the runtime but only
+those in the `Photish::Plugin` namespace with a `self.is_for?(type)` method
+will be used by Photish as plugins.
+
 ## Development
 
 If you would like to contribute to Photish by creating a new feature or fixing

data/TODO.md

@@ -2,13 +2,13 @@
 
 ## In Progress
 
-## Backlog
-
-1. Custom user created helpers in templates
 1. A `deploy` command as a gem to deploy to github pages, netlify, amazon s3
 1. URL customization, relative, absolute with or without hostname URLs (for
    different host envs)
-1. Custom template rendering outside of `_templates` folder
+
+## Backlog
+
+1. Custom template rendering outside of `_templates` folder using `page.{type}`
 1. Proper asset pipeline for CSS
 1. A sitemap helper plugin for use in custom templates for example
    `sitemap.xml`

data/lib/photish/assets/site/_plugins/yell_loud.rb

@@ -0,0 +1,22 @@
+require 'nokogiri'
+
+module Photish::Plugin::YellLoud
+
+  def self.is_for?(type)
+    [
+      Photish::Plugin::Type::Collection,
+      Photish::Plugin::Type::Album,
+      Photish::Plugin::Type::Photo,
+      Photish::Plugin::Type::Image
+    ].include?(type)
+  end
+
+  def yell_very_loud
+    doc = Nokogiri::HTML::DocumentFragment.parse("")
+    Nokogiri::HTML::Builder.with(doc) do |doc|
+      doc.span("Yelling \"#{name}\" from a plugin!",
+               style: 'font-weight:bold;color:red;font-size:200%;')
+    end
+    doc.to_html
+  end
+end

data/lib/photish/assets/site/_templates/photo.slim

@@ -1,7 +1,7 @@
 div.album
   div.album-title
     a href=url
-      | #{name}
+      == yell_very_loud
   - if metadata.try(:description)
     div.album-blurb
       p #{metadata.try(:description)}

data/lib/photish/command/generate.rb

@@ -16,6 +16,7 @@ module Photish
 
         log_important_config_values
         log_album_and_photo_names
+        load_all_plugins
         render_whole_site
         log.info 'Site generation completed successfully'
       end
@@ -25,6 +26,16 @@ module Photish
       attr_reader :runtime_config,
                   :log
 
+      def load_all_plugins
+        Dir[File.join(site_dir, '_plugins', '*.rb')].each do |file|
+          require file
+        end
+
+        Photish::Plugin::Repository.all_plugins.each do |plugin|
+          log.info "Found plugin #{plugin}"
+        end
+      end
+
       def config
         @config ||= Photish::Config::AppSettings.new(runtime_config)
                                                 .config

data/lib/photish/gallery/album.rb

@@ -3,6 +3,7 @@ require 'photish/gallery/traits/urlable'
 require 'photish/gallery/traits/albumable'
 require 'photish/gallery/traits/metadatable'
 require 'photish/gallery/traits/breadcrumbable'
+require 'photish/plugin/pluginable'
 require 'active_support'
 require 'active_support/core_ext'
 require 'filemagic'
@@ -10,14 +11,16 @@ require 'filemagic'
 module Photish
   module Gallery
     class Album
-      include ::Photish::Gallery::Traits::Urlable
-      include ::Photish::Gallery::Traits::Albumable
-      include ::Photish::Gallery::Traits::Metadatable
-      include ::Photish::Gallery::Traits::Breadcrumbable
+      include Photish::Gallery::Traits::Urlable
+      include Photish::Gallery::Traits::Albumable
+      include Photish::Gallery::Traits::Metadatable
+      include Photish::Gallery::Traits::Breadcrumbable
+      include Photish::Plugin::Pluginable
 
       delegate :qualities, to: :parent, allow_nil: true
 
       def initialize(parent, path)
+        super
         @parent = parent
         @path = path
       end
@@ -35,6 +38,10 @@ module Photish
                        .map    { |file| Photo.new(self, file) }
       end
 
+      def plugin_type
+        Photish::Plugin::Type::Album
+      end
+
       private
 
       attr_reader :path,

data/lib/photish/gallery/collection.rb

@@ -2,18 +2,21 @@ require 'photish/gallery/album'
 require 'photish/gallery/traits/albumable'
 require 'photish/gallery/traits/metadatable'
 require 'photish/gallery/traits/breadcrumbable'
+require 'photish/plugin/pluginable'
 
 module Photish
   module Gallery
     class Collection
-      include ::Photish::Gallery::Traits::Urlable
-      include ::Photish::Gallery::Traits::Albumable
-      include ::Photish::Gallery::Traits::Metadatable
-      include ::Photish::Gallery::Traits::Breadcrumbable
+      include Photish::Gallery::Traits::Urlable
+      include Photish::Gallery::Traits::Albumable
+      include Photish::Gallery::Traits::Metadatable
+      include Photish::Gallery::Traits::Breadcrumbable
+      include Photish::Plugin::Pluginable
 
       attr_reader :qualities
 
       def initialize(path, qualities)
+        super
         @path = path
         @qualities = qualities
       end
@@ -26,6 +29,10 @@ module Photish
         []
       end
 
+      def plugin_type
+        Photish::Plugin::Type::Collection
+      end
+
       private
 
       attr_reader :path

data/lib/photish/gallery/image.rb

@@ -1,10 +1,12 @@
 require 'active_support'
 require 'active_support/core_ext'
+require 'photish/plugin/pluginable'
 
 module Photish
   module Gallery
     class Image
-      include ::Photish::Gallery::Traits::Urlable
+      include Photish::Gallery::Traits::Urlable
+      include Photish::Plugin::Pluginable
 
       delegate :name,
                :params,
@@ -13,6 +15,7 @@ module Photish
       attr_reader :path
 
       def initialize(parent, path, quality)
+        super
         @parent = parent
         @path = path
         @quality = quality
@@ -22,6 +25,10 @@ module Photish
         @name ||= "#{basename} #{quality_name}"
       end
 
+      def plugin_type
+        Photish::Plugin::Type::Image
+      end
+
       private
 
       attr_reader :parent,

data/lib/photish/gallery/photo.rb

@@ -2,6 +2,7 @@ require 'photish/gallery/traits/urlable'
 require 'photish/gallery/traits/metadatable'
 require 'photish/gallery/traits/breadcrumbable'
 require 'photish/gallery/image'
+require 'photish/plugin/pluginable'
 require 'active_support'
 require 'active_support/core_ext'
 require 'mini_exiftool'
@@ -9,13 +10,15 @@ require 'mini_exiftool'
 module Photish
   module Gallery
     class Photo
-      include ::Photish::Gallery::Traits::Urlable
-      include ::Photish::Gallery::Traits::Metadatable
-      include ::Photish::Gallery::Traits::Breadcrumbable
+      include Photish::Gallery::Traits::Urlable
+      include Photish::Gallery::Traits::Metadatable
+      include Photish::Gallery::Traits::Breadcrumbable
+      include Photish::Plugin::Pluginable
 
       delegate :qualities, to: :parent, allow_nil: true
 
       def initialize(parent, path)
+        super
         @parent = parent
         @path = path
       end
@@ -32,6 +35,10 @@ module Photish
         MiniExiftool.new(path)
       end
 
+      def plugin_type
+        Photish::Plugin::Type::Photo
+      end
+
       private
 
       attr_reader :path,

data/lib/photish/plugin/pluginable.rb

@@ -0,0 +1,14 @@
+require 'photish/plugin/type'
+require 'photish/plugin/repository'
+
+module Photish
+  module Plugin
+    module Pluginable
+      def initialize(*_args)
+        Photish::Plugin::Repository.plugins_for(self.plugin_type).each do |moduol|
+          self.class.send(:include, moduol)
+        end
+      end
+    end
+  end
+end

data/lib/photish/plugin/repository.rb

@@ -0,0 +1,29 @@
+
+module Photish
+  module Plugin
+    module Repository
+      class << self
+        def plugins_for(type)
+          all_plugins.reject { |m| !m.is_for?(type) }
+        end
+
+        def all_plugins
+          Photish::Plugin.constants.map    { |m| constantize(m) }
+                                   .reject { |m| ignored_modules.include?(m) }
+        end
+        
+        private
+
+        def ignored_modules
+          [Photish::Plugin::Repository,
+           Photish::Plugin::Pluginable,
+           Photish::Plugin::Type]
+        end
+
+        def constantize(symbol)
+          Kernel.const_get("Photish::Plugin::#{symbol}")
+        end
+      end
+    end
+  end
+end

data/lib/photish/plugin/type.rb

@@ -0,0 +1,10 @@
+module Photish
+  module Plugin
+    module Type
+      module Collection; end
+      module Album; end
+      module Photo; end
+      module Image; end
+    end
+  end
+end

data/lib/photish/version.rb

@@ -1,3 +1,3 @@
 module Photish
-  VERSION = "0.1.7"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: photish
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Henry Lawson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-27 00:00:00.000000000 Z
+date: 2015-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -327,6 +327,7 @@ files:
 - lib/photish/assets/photos/Small Dogs/Sleepy Dog.jpg
 - lib/photish/assets/photos/Small Dogs/Sleepy Dog.yml
 - lib/photish/assets/photos/Small Dogs/Squishy Dogs/Big Ear Dog.jpg
+- lib/photish/assets/site/_plugins/yell_loud.rb
 - lib/photish/assets/site/_templates/album.slim
 - lib/photish/assets/site/_templates/collection.slim
 - lib/photish/assets/site/_templates/layout.slim
@@ -353,6 +354,9 @@ files:
 - lib/photish/gallery/traits/urlable.rb
 - lib/photish/log/access_log.rb
 - lib/photish/log/logger.rb
+- lib/photish/plugin/pluginable.rb
+- lib/photish/plugin/repository.rb
+- lib/photish/plugin/type.rb
 - lib/photish/rake/task.rb
 - lib/photish/render/image_conversion.rb
 - lib/photish/render/page.rb