photish 0.3.11 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd549e0b900be9de4fb137293813237d8e320aa4
-  data.tar.gz: 96dbedfaf551bbb1d3e70c8a6f6a383707578ac3
+  metadata.gz: 126b9558be5101767839891a8bb1f439e4ceeb4d
+  data.tar.gz: f7f5788e4eae6c56c450f81b5079eb9747ac4660
 SHA512:
-  metadata.gz: 0cee42768c288ffbd5a31011b0fdff42fd4ddf18b1127492b43a0da0275ee8a44cf17dc5c688aa2f43718854d6a592f7ac3aa42706a389dedab8cab6f2dd4366
-  data.tar.gz: aaf9bef8e114106b96e2c9e77960364deee7b8a4f83ffdfe75ab8dc9c573d50b4d8de0c4a25d7632d48a95603051fb4ecf4e4cd121d89abee7519a695f1144c7
+  metadata.gz: bfb7b794c442026a35bd9a2e8281068c083fd9e7bd963a0630c878683002dd13ed4b7c8f4f79ad231f565edd94ce2803b2363ac65113f2d8d9006929b24d2f48
+  data.tar.gz: 8ad4cdffaae09e93667179b2d25b3ec6320244c6d4a582994d7bc283592dc9d7900ec64b1e22435b8458ee0466e2fb873e9635c6281f4702277fcbffe02d7891

data/.pryrc

@@ -0,0 +1,2 @@
+require "awesome_print"
+AwesomePrint.pry!

data/README.md

@@ -28,11 +28,11 @@ has changed, it is not needlessly regenerated. This results in a responsive
 and fast local development environment, making it easy to perfect the design
 of your photo based website without having to wait for regeneration.
 
-## Photish in the Wild
+## Example
 
-1. [Photish Montage](https://foinq.com/photish-montage/index.html) - A quick
-   mockup to show what can be done with Photish. [Source
-   here](https://github.com/henrylawson/photish-montage).
+[Photish Montage](https://foinq.com/photish-montage/index.html) - A quick
+mockup to show what can be done with Photish. [Source
+here](https://github.com/henrylawson/photish-montage).
 
 ## Getting Started
 
@@ -66,6 +66,8 @@ and running:
       - [Album Template](#album-template)
       - [Photo Template](#photo-template)
       - [Template Helpers](#template-helpers)
+    - [Custom Rendered Content](#custom-rendered-content)
+      - [Gallery Page](#gallery-page)
   - [Generate](#generate)
     - [Execution Order](#execution-order)
     - [Workers and Threads](#workers-and-threads)
@@ -208,19 +210,24 @@ Photish has dependencies on certain software:
 - [Exiftool](http://www.sno.phy.queensu.ca/~phil/exiftool/) for image metadata
   retrieval
 
-Softer dependencies:
+Target OS dependencies:
 
-- [Unix](http://www.unix.org/) based OS, Photish has been tested thoroughly on
-  Linux and MacOSX computers but theoretically should work on Windows, though
-  this is not tested
+- [Unix](http://www.unix.org/) based operating system, Photish has been tested
+  thoroughly on Ubuntu and MacOSX
 
 **On MacOSX, using [Brew](http://brew.sh/)**
 
+    $ brew install ruby
     $ brew install imagemagick
     $ brew install exiftool
+    $ gem install bundler
 
 **On Ubuntu or Debian**
 
+    $ sudo apt-add-repository ppa:brightbox/ruby-ng
+    $ sudo apt-get update
+    $ sudo apt-get install ruby2.2
+    $
     $ sudo apt-get install imagemagick
     $ sudo apt-get install libimage-exiftool-perl
 
@@ -292,7 +299,21 @@ generated file, the generated file will clobber the asset.
 
 #### Config File Options
 
-Below is a complete `config.yml` file:
+The default way to express config is in the `config.yml` file. However config
+can also be overridden using the `--config_override` flag to any of the Photish
+commands. When using the `--config_override` flag, the config must be expressed
+as [JSON](http://www.json.org/). For example, to override logging when calling
+the Generate command, you can use:
+
+    $ photish generate --config_override='{"logging":{"colorize":false}}'
+
+This method of config override is only recommended for cases where the value
+needs to be temporarily overridden, such as during a deployment or while
+debugging.
+
+Below is a complete `config.yml` file, recommended practice is to only set the
+config values you need, otherwise just use the defaults, the file can be empty
+and Photish will still function:
 
 ```yaml
 port: 9876
@@ -308,7 +329,7 @@ templates:
   photo: photo.slim
 logging:
   colorize: true
-  level: 'info'
+  level: 'debug'
   output: ['stdout', 'file']
 url:
   host: http://mydomain.com
@@ -319,6 +340,7 @@ threads: 2
 force: false
 plugins: ['ssh_deploy', 'other_plugin']
 image_extensions: ['jpg', 'gif']
+page_extension: 'slim'
 ```
 
 The meanings and purpose of each field is defined below:
@@ -336,7 +358,7 @@ Field                  | Purpose
 `templates/photo`      | the photo template file in the `site/_templates` folder, must be overridden if using a different template engine
 `logging`              | a listing of the various logging options
 `logging/colorize`     | when outputting to `STDOUT`, `true` to use color, `false` for none
-`logging/level`        | the default logging level, it is advised to keep this at `info`, supported are `debug`, `info`, `warn`, `error` and `fatal`
+`logging/level`        | the default logging level, it is advised to keep this at `debug`, supported are `debug`, `info`, `warn`, `error` and `fatal`
 `logging/output`       | the appenders for the logger, `stdout` goes to `STDOUT`, `file` goes to `log/photish.log`
 `url`                  | a listing of the various url options
 `url/host`             | if you would like URLs generated with a specific host prefix, you can define it here, otherwise leave it as '/' or do not set this configuration at all
@@ -347,6 +369,7 @@ Field                  | Purpose
 `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
+`page_extension`       | the extension of **Pages** files that will live amongst the photo collection
 
 #### Customizing Templates
 
@@ -407,6 +430,7 @@ albums              | an array of child [Albums](https://github.com/henrylawson/
 all_albums          | an array of all child [Albums](https://github.com/henrylawson/photish/blob/master/lib/photish/gallery/album.rb)
 all_photos          | an array of all child [Photos](https://github.com/henrylawson/photish/blob/master/lib/photish/gallery/photo.rb)
 all_images          | an array of all child [Images](https://github.com/henrylawson/photish/blob/master/lib/photish/gallery/image.rb)
+all_pages           | an array of all child [Pages](https://github.com/henrylawson/photish/blob/master/lib/photish/gallery/page.rb)
 
 ##### Album Template
 
@@ -442,6 +466,7 @@ albums              | an array of child [Albums](https://github.com/henrylawson/
 all_albums          | an array of all child [Albums](https://github.com/henrylawson/photish/blob/master/lib/photish/gallery/album.rb)
 all_photos          | an array of all child [Photos](https://github.com/henrylawson/photish/blob/master/lib/photish/gallery/photo.rb)
 all_images          | an array of all child [Images](https://github.com/henrylawson/photish/blob/master/lib/photish/gallery/image.rb)
+all_pages           | an array of all child [Pages](https://github.com/henrylawson/photish/blob/master/lib/photish/gallery/page.rb)
 
 ##### Photo Template
 
@@ -519,6 +544,36 @@ Method              | Description
 breadcrumbs         | an unordered list of pages above the current page in the hierarchy
 build_url(\*pieces) | use this to ensure your URLs have the correct host name and base directory, to avoid having it hard coded in the template
 
+#### Custom Rendered Content
+
+##### Gallery Page
+
+A gallery page is a simple way to create a custom web page within the
+collection or album of your gallery that will render within your site's [Layout
+Template](#layout-template).
+
+For example, if you would like to create a "more details about album" page
+somewhere within an album, and you would like it rendered in the [Layout
+Template](#layout-template) to have a consistent look and feel, you can do it
+by creating a file a Gallery Page file such as `more-about.slim` in your
+album's directory. The file extension is determined using the `page_extension`
+[Config File Option](#config-file-option). A Gallery Page can live anywhere and
+you can have as many of them as you like within the `photos` directory.
+
+`photos/**/*.{page_extension}`
+
+```slim
+div.more-about-album
+  h2 The More Details Page
+  p Lorem ipsum...
+  p Lorem ipsum...
+  p Lorem ipsum...
+```
+
+As with other gallery generated content, a gallery page is accessible from the
+`all_pages` method within the [Collection](#collection-template) or
+[Album](#album-template) template.
+
 ### Generate
 
 The static HTML can be generated by running the below command inside the
@@ -644,6 +699,12 @@ The local version of your website will be visible at
 The Host command will also automatically regenerate the website on startup and
 when a file is added, removed or modified in the `photo_dir` or `site_dir`.
 
+Note, when running in this mode any Image Conversion errors are swallowed and
+logged. This is done as it is quite common for image files to be moved while
+conversion is in progress. Rather then terminate the Host, the file move is
+recorded and regeneration will be triggered once the current generation
+completes.
+
 ### Deploy
 
 Photish provides a plugin type specifically for deployments, called the
@@ -777,7 +838,7 @@ module Photish::Plugin::MyCustomDeploy
   end
 
   def deploy_site
-    @log.info "Deploying using my plugin"
+    @log.debug "Deploying using my plugin"
     FileUtils.cp(@config.output_dir, '/srv/www')
   end
 end

data/TODO.md

@@ -2,17 +2,17 @@
 
 ## In Progress
 
+1. Create the Asset Page feature, pages in the site folder, passing collection
+   reference
+1. RCode tools
+
 ## Backlog
 
-1. Worker can die when large folders moved mid generation
-1. Changing convert items does not trigger regeneration but changing name does
+1. Video transcoding and template rendering for videos
 1. Templates with exif data, super slow
-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`
-1. Share on RubyWebToolkit, StaticGen, etc
-1. RDoc documentation for classes, perhaps use the badge too
-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. Add unit tests to classes relying on feature tests
+1. Improve metric scores from `rake stats`
+1. Improve the `--example` template of Photish

data/bin/console

@@ -2,13 +2,5 @@
 
 require "bundler/setup"
 require "photish"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start
+require "pry"
+Pry.start

data/bin/setup

@@ -6,5 +6,3 @@ command -v convert >/dev/null 2>&1 || { echo >&2 "imagemagick required. run \"br
 command -v exiftool >/dev/null 2>&1 || { echo >&2 "exiftool required. run \"brew install exiftool\""; exit 1; }
 
 bundle install
-
-# Do any other automated setup that you need to do here

data/lib/photish/assets/example/photos/Big Dogs/Custom Template Page.slim

@@ -0,0 +1,5 @@
+div.album
+  div.album-title
+    Custom Template Page
+  p By creating a page that ends with the template extension, you can create
+  custom pages that are rendered in the default layout.

data/lib/photish/assets/example/site/_plugins/footer_links.rb

@@ -4,7 +4,8 @@ module Photish::Plugin::FooterLinks
       Photish::Plugin::Type::Collection,
       Photish::Plugin::Type::Album,
       Photish::Plugin::Type::Photo,
-      Photish::Plugin::Type::Image
+      Photish::Plugin::Type::Image,
+      Photish::Plugin::Type::Page,
     ].include?(type)
   end
 

data/lib/photish/assets/example/site/_plugins/tmpdir_deploy.rb

@@ -8,8 +8,8 @@ class Photish::Plugin::TmpdirDeploy
     tmpdir = Dir.mktmpdir
     FileUtils.cp_r(config.output_dir, tmpdir)
 
-    log.info "Static site deployed to directory: #{tmpdir}"
-    log.info "Deployment to tmpdir successful"
+    log.debug "Static site deployed to directory: #{tmpdir}"
+    log.debug "Deployment to tmpdir successful"
   end
 
   private

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

@@ -4,7 +4,8 @@ module Photish::Plugin::YellLoud
       Photish::Plugin::Type::Collection,
       Photish::Plugin::Type::Album,
       Photish::Plugin::Type::Photo,
-      Photish::Plugin::Type::Image
+      Photish::Plugin::Type::Image,
+      Photish::Plugin::Type::Page,
     ].include?(type)
   end
 

data/lib/photish/assets/example/site/_templates/album.slim

@@ -7,6 +7,10 @@ div.album
       div.album-photo
         a href=photo.url title=photo.name
           img src=photo.images.find{ |i|i.quality_name=='Low' }.url alt=photo.name
+  div.album-pages
+    - pages.each do |page|
+      div.album-page
+        a href=page.url title=page.name #{page.name}
 
 div.sub-albums
   - albums.each do |album|

data/lib/photish/cache/db_file.rb

@@ -0,0 +1,40 @@
+module Photish
+  module Cache
+    class DbFile
+      def self.new_master(output_dir)
+        new(path(output_dir, '.changes.yml'))
+      end
+
+      def self.new_worker(output_dir, index)
+        new(path(output_dir, ".changes.#{index}.yml"))
+      end
+
+      def write(hash)
+        File.open(file, 'w') do
+          |f| f.write(hash.to_yaml)
+        end
+      end
+
+      def read
+        File.exist?(file) ? YAML.load_file(file) : {}
+      end
+
+      def clear
+        FileUtils.rm_rf(file)
+      end
+
+      private
+
+      attr_reader :file
+
+      def initialize(file)
+        @file = file
+      end
+
+      def self.path(output_dir, filename)
+        FileUtils.mkdir_p(output_dir)
+        path = File.join(output_dir, filename)
+      end
+    end
+  end
+end

data/lib/photish/cache/manifest.rb

@@ -1,8 +1,9 @@
 module Photish
   module Cache
     class Manifest
-      def initialize(output_dir, worker_index, version_hash)
+      def initialize(output_dir, workers, worker_index, version_hash)
         @output_dir = output_dir
+        @workers = workers
         @worker_index = worker_index
         @version_hash = version_hash
         @cache = {}
@@ -12,23 +13,21 @@ module Photish
       def record(key, file_path = nil)
         checksum = checksum_of_file(file_path || key)
         worker_db[key] = checksum
-        db[key] = checksum
+        master_db[key] = checksum
       end
 
       def changed?(key, file_path = nil)
         checksum = checksum_of_file(file_path || key)
         worker_db[key] = checksum
-        checksum != db[key]
+        checksum != master_db[key]
       end
 
       def flush_to_disk
-        File.open(worker_db_file(worker_index), 'w') do
-          |f| f.write(worker_db.to_yaml)
-        end
+        worker_db_file(worker_index).write(worker_db)
       end
 
-      def preload
-        db
+      def load_from_disk
+        master_db
       end
 
       private
@@ -37,26 +36,29 @@ module Photish
                   :cache,
                   :version_hash,
                   :worker_index,
-                  :worker_db
+                  :worker_db,
+                  :workers
 
-      delegate :db_file,
+      delegate :master_db_file,
                :worker_db_file,
-               to: :manifest_db_file
+               to: :repository
 
       def checksum_of_file(file_path)
         cache.fetch(file_path.hash) do |key|
-          cache[key] = version_hash.to_s +
-                       Digest::MD5.file(file_path).hexdigest
+          cache[key] = hash(file_path)
         end
       end
 
-      def db
-        return @db if @db
-        @db = File.exist?(db_file) ? YAML.load_file(db_file) : {}
+      def hash(file_path)
+        version_hash.to_s + Digest::MD5.file(file_path).hexdigest
+      end
+
+      def master_db
+        @master_db ||= master_db_file.read
       end
 
-      def manifest_db_file
-        ManifestDbFile.new(output_dir)
+      def repository
+        @repository ||= Repository.new(output_dir, workers)
       end
     end
   end

data/lib/photish/cache/repository.rb

@@ -0,0 +1,42 @@
+module Photish
+  module Cache
+    class Repository
+      def initialize(output_dir, workers)
+        @output_dir = output_dir
+        @workers = workers
+        @worker_db_file_cache = {}
+      end
+
+      delegate :clear,
+               to: :master_db_file,
+               prefix: true
+
+      def concat_worker_db_files
+        master_db_file.write(accumulate_changes)
+      end
+
+      def master_db_file
+        @master_db_file ||= DbFile.new_master(output_dir)
+      end
+
+      def worker_db_file(index)
+        worker_db_file_cache.fetch(index) do
+          DbFile.new_worker(output_dir, index)
+        end
+      end
+
+      private
+
+      attr_reader :output_dir,
+                  :workers,
+                  :worker_db_file_cache
+
+      def accumulate_changes
+        (1..workers).inject({}) do |accumulator, worker_index|
+          db_file = worker_db_file(worker_index)
+          accumulator.merge(db_file.read)
+        end
+      end
+    end
+  end
+end

data/lib/photish/cli/interface.rb

@@ -5,6 +5,7 @@ module Photish
 
       desc "generate", "Generates the gallery static site"
       option :force, type: :boolean
+      option :config_override, type: :string
       def generate
         Photish::Command::Generate.new(options).execute
       end
@@ -17,18 +18,21 @@ module Photish
 
       desc "host", "Serves the HTML on a HTTP server"
       option :force, type: :boolean
+      option :config_override, type: :string
       def host
         Photish::Command::Host.new(options).execute
       end
 
       desc "init", "Creates a basic Photish site structure"
       option :example, type: :boolean
+      option :config_override, type: :string
       def init
         Photish::Command::Init.new(options).execute
       end
 
       desc "deploy", "Deploys the static site, using the specified engine"
       method_option :engine, required: true
+      option :config_override, type: :string
       def deploy
         Photish::Command::Deploy.new(options).execute
       end

data/lib/photish/command/base.rb

@@ -23,14 +23,18 @@ module Photish
                :version_hash,
                to: :app_settings
 
+      def load_all_plugins
+        Plugin::Repository.instance.reload(config)
+      end      
+
       private
 
       def app_settings
-        @app_settings ||= Config::AppSettings.new(runtime_config)
+        @app_settings ||= Config::Settings.new(runtime_config)
       end
 
       def setup_logging
-        Log::LogSetup.instance.configure(config.logging)
+        Log::Setup.instance.configure(config.logging)
       end
     end
   end

data/lib/photish/command/deploy.rb

@@ -3,14 +3,14 @@ module Photish
     class Deploy < Base
       def run
         load_all_plugins
-        log.info "Requested engine: #{engine}"
+        log.debug "Requested engine: #{engine}"
 
         return no_engine_found unless engine && engine_class
 
-        log.info "Regenerating site, to ensure fresh copy"
+        log.debug "Regenerating site, to ensure fresh copy"
         regenerate_entire_site
 
-        log.info "Deploying with engine #{engine_class}"
+        log.debug "Deploying with engine #{engine_class}"
         engine_class.new(config, log).deploy_site
       end
 
@@ -26,11 +26,7 @@ module Photish
       end
 
       def no_engine_found
-        log.info "No engine found..."
-      end
-
-      def load_all_plugins
-        Plugin::Repository.instance.reload(config)
+        log.debug "No engine found..."
       end
 
       def engine_class

data/lib/photish/command/generate.rb

@@ -2,44 +2,35 @@ module Photish
   module Command
     class Generate < Base
       def run
-        log.info "Generating with #{workers} workers and #{threads} threads"
+        log.debug "Generating with #{workers} workers and #{threads} threads"
 
-        clear if force_regeneration?
+        master_db_file_clear if force_regeneration?
         spawn_all_workers
         load_all_plugins
         wait_for_workers_to_complete
-        concat_db_files(workers)
+        concat_worker_db_files
         perform_serial_generation
 
-        log.info "Generation completed successfully"
+        log.debug "Generation completed successfully"
       end
 
       private
 
       delegate :output_dir,
-               :photo_dir,
-               :url,
-               :site_dir,
-               :qualities,
                :photish_executable,
                :workers,
                :force,
                :threads,
-               :image_extensions,
                to: :config
 
-      delegate :concat_db_files,
-               :clear,
-               to: :manifest_db_file
+      delegate :concat_worker_db_files,
+               :master_db_file_clear,
+               to: :cache_repository
 
       def force_regeneration?
         force == true
       end
 
-      def load_all_plugins
-        Plugin::Repository.instance.reload(config)
-      end
-
       def spawn_all_workers
         return single_worker if one_worker?
         @spawned_processes ||= (1..workers).map do |index|
@@ -68,14 +59,7 @@ module Photish
       end
 
       def collection
-        @collection ||= Gallery::Collection.new(photo_dir,
-                                                qualities_mapped,
-                                                url,
-                                                image_extensions)
-      end
-
-      def qualities_mapped
-        qualities.map { |quality| OpenStruct.new(quality) }
+        @collection ||= Gallery::Collection.new(config)
       end
 
       def worker_command(worker_index)
@@ -84,8 +68,8 @@ module Photish
          "--worker_index=#{worker_index}"].join(' ')
       end
 
-      def manifest_db_file
-        Cache::ManifestDbFile.new(output_dir)
+      def cache_repository
+        Cache::Repository.new(output_dir, workers)
       end
     end
   end