photish 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 126b9558be5101767839891a8bb1f439e4ceeb4d
-  data.tar.gz: f7f5788e4eae6c56c450f81b5079eb9747ac4660
+  metadata.gz: 2187730cc461f37521bd2306765d64de3a5cd48c
+  data.tar.gz: 4767017b8aee301d228e405fbf5617257111ed6d
 SHA512:
-  metadata.gz: bfb7b794c442026a35bd9a2e8281068c083fd9e7bd963a0630c878683002dd13ed4b7c8f4f79ad231f565edd94ce2803b2363ac65113f2d8d9006929b24d2f48
-  data.tar.gz: 8ad4cdffaae09e93667179b2d25b3ec6320244c6d4a582994d7bc283592dc9d7900ec64b1e22435b8458ee0466e2fb873e9635c6281f4702277fcbffe02d7891
+  metadata.gz: 619f637a81a664c7d6979fbac0ed998be1b29709824e049ca90f58a4fa10b8db304d862e6e2b59bab9c930c61f58b3d4d1507bf317cd6322fa97351a9a2bd20b
+  data.tar.gz: 63231d51f974db316a1989e995cf749bedea94486d686ad878d7b7494a1f138420d06858a9a66c614b03b2c71b6c40adb945ebc65a27cbf8ed53d1eecebe4150

data/.jrubyrc

@@ -0,0 +1,7 @@
+backtrace.mask=true
+compile.invokedynamic=true
+objectspace.enabled=true
+backtrace.color=true
+compat.version=2.2
+backtrace.style=mri
+cli.debug=false

data/.travis.yml

@@ -1,10 +1,4 @@
 language: ruby
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3.0
-  - ruby-head
 sudo: false
 before_install:
   - gem install bundler -v 1.10.6
@@ -17,3 +11,26 @@ addons:
       - libmagic-dev
       - libimage-exiftool-perl
 cache: bundler
+matrix:
+  include:
+    - rvm: ruby-head
+    - rvm: 2.3.0
+      env: COVERAGE=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
+      env: SMOKE_TEST_ONLY=1
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx

data/Gemfile

@@ -2,7 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in photish.gemspec
 gemspec
-
-group :development do
-  gem 'aruba', git: 'https://github.com/cucumber/aruba.git', ref: '0a3bffa'
-end

data/README.md

@@ -54,6 +54,7 @@ and running:
 - [Overview](#overview)
 - [Installation](#installation)
   - [Dependencies](#dependencies)
+  - [Ruby Versions](#ruby-versions)
 - [Usage](#usage)
   - [Initialize](#initialize)
     - [Basic Photish Structure](#basic-photish-structure)
@@ -68,6 +69,7 @@ and running:
       - [Template Helpers](#template-helpers)
     - [Custom Rendered Content](#custom-rendered-content)
       - [Gallery Page](#gallery-page)
+      - [Asset Page](#asset-page)
   - [Generate](#generate)
     - [Execution Order](#execution-order)
     - [Workers and Threads](#workers-and-threads)
@@ -84,6 +86,7 @@ and running:
     - [Plugin Loading](#plugin-loading)
 - [Development](#development)
 - [Contributing](#contributing)
+- [Versioning](#versioning)
 - [License](#license)
 
 ## Overview
@@ -231,6 +234,20 @@ Target OS dependencies:
     $ sudo apt-get install imagemagick
     $ sudo apt-get install libimage-exiftool-perl
 
+### Ruby Versions
+
+Photish supports multiple ruby versions:
+
+Ruby Version                              | Minimum | Maximum | Comments
+----------------------------------------- |---------|---------|---------
+[MRI Ruby](https://www.ruby-lang.org/en/) | 2.0     | HEAD    | Very stable, all tests pass consistently
+[JRuby](http://jruby.org/)                | 9.0     | HEAD    | Mostly stable, smoke test passes consistently, full feature test flakey
+[Rubinius](http://rubinius.com/)          | 2.0     | HEAD    | Mostly stable, smoke test passes consistently, full feature test flakey
+
+The latest version and all releases of Photish are tested against the above
+ruby versions in the [CI pipeline](https://travis-ci.org/henrylawson/photish).
+
+
 ## Usage
 
 Once you have photish installed. Get started with the following commands:
@@ -552,13 +569,13 @@ 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
+For example, if you would like to create a "more details" page somewhere within
+an album, or the collection root, 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.
+by creating a Gallery Page such as `more-about.slim` anywhere in your `photos`
+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}`
 
@@ -574,6 +591,41 @@ 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.
 
+##### Asset Page
+
+An Asset Page is a custom page that lives inside your `site` directory that
+is rendered using your template engine of choice. When an Asset Page template
+is rendered it is not rendered inside the site's [Layout
+Template](#layout-template). Asset Page's are standalone templates. Like other
+assets, they maintain the same folder structure in the `output` directory that
+they have in the `site` directory. When rendered, the template is passed the
+Collection model, as such they have access to all attributes that a [Collection
+Template](#collection-template) does.
+
+For example, if you would like to create an index page of all albums in your
+collection you can create the following file:
+
+`site/index/all_albums.html.{page_extension}`
+
+```slim
+doctype html
+html
+  head
+    title All Albums
+  body
+    ol
+      - all_albums.each do |album|
+        li #{album.name}
+```
+
+When rendered, the above Asset Page will be available at
+[http://localhost:9876/index/all_albums.html](http://localhost:9876/index/all_albums.html).
+
+It is important to note that once rendered, the template extension is removed
+and the basename is used for the final filename. This allows you to specify
+custom extensions before the `page_extension` such as TXT or XML. In the
+example above, HTML is specified.
+
 ### Generate
 
 The static HTML can be generated by running the below command inside the
@@ -783,6 +835,7 @@ Plugin supports:
 1. `Photish::Plugin::Type::Album`
 1. `Photish::Plugin::Type::Photo`
 1. `Photish::Plugin::Type::Image`
+1. `Photish::Plugin::Type::Page`
 
 To use the Template Helper Plugin, simply call the custom method(s) in your
 template file. For the above example, it can be used by calling the `shout`
@@ -796,8 +849,10 @@ div.my-shouting-content
 
 Some "core" Template Helper plugins available in Photish by default are:
 
-1. [Breadcrumb](https://github.com/henrylawson/photish/blob/master/lib/photish/core_plugin/breadcrumb.rb)
-1. [BuildUrl](https://github.com/henrylawson/photish/blob/master/lib/photish/core_plugin/build_url.rb)
+1. [Breadcrumb](https://github.com/henrylawson/photish/blob/master/lib/photish/plugin/core/breadcrumb.rb)
+1. [BuildUrl](https://github.com/henrylawson/photish/blob/master/lib/photish/plugin/core/build_url.rb)
+1. [Metadatable](https://github.com/henrylawson/photish/blob/master/lib/photish/plugin/core/metadatable.rb)
+1. [Exifable](https://github.com/henrylawson/photish/blob/master/lib/photish/plugin/core/exifable.rb)
 
 #### Deployment Engine Plugins
 
@@ -939,6 +994,10 @@ https://github.com/henrylawson/photish. This project is intended to be a safe,
 welcoming space for collaboration, and contributors are expected to adhere to
 the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+## Versioning
+
+This project follows [Semantic Versioning 2.0.0](http://semver.org/).
+
 ## License
 
 The gem is available as open source under the terms of the [MIT

data/Rakefile

@@ -8,11 +8,15 @@ require 'metric_fu'
 RSpec::Core::RakeTask.new(:spec)
 
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "features --format pretty --tags ~@wip"
+  tags = ['']
+  tags << '--tags ~@wip'
+  tags << '--tags @smoke' if ENV['SMOKE_TEST_ONLY']
+  t.cucumber_opts = "features --format pretty #{tags.join(' ')}"
 end
 
 desc 'Gather code climate results'
 task :gather_coverage do
+  next unless ENV['COVERAGE']
   require 'simplecov'
   require 'codeclimate-test-reporter'
   CodeClimate::TestReporter::Formatter.new.format(SimpleCov.result)

data/TODO.md

@@ -2,17 +2,16 @@
 
 ## In Progress
 
-1. Create the Asset Page feature, pages in the site folder, passing collection
-   reference
-1. RCode tools
+1. A sitemap helper plugin for use in custom templates for example
+   `sitemap.xml`
 
 ## Backlog
 
+1. Get url by smart key
 1. Video transcoding and template rendering for videos
 1. Templates with exif data, super slow
 1. Proper asset pipeline for CSS
-1. A sitemap helper plugin for use in custom templates for example
-   `sitemap.xml`
+1. Improve the `--example` template of Photish
+1. Stabilize full tests for JRuby and Rubinius
 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/exe/.jrubyrc

@@ -0,0 +1,7 @@
+backtrace.mask=true
+compile.invokedynamic=true
+objectspace.enabled=true
+backtrace.color=true
+compat.version=2.2
+backtrace.style=mri
+cli.debug=false

data/lib/photish.rb

@@ -50,9 +50,10 @@ require 'photish/gallery/album'
 require 'photish/gallery/image'
 require 'photish/gallery/collection'
 require 'photish/render/template'
-require 'photish/render/page'
+require 'photish/render/asset_page'
+require 'photish/render/gallery_page'
 require 'photish/render/site'
-require 'photish/render/model'
+require 'photish/render/gallery'
 require 'photish/render/image'
 require 'photish/cache/db_file'
 require 'photish/cache/manifest'

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

@@ -14,4 +14,5 @@ html
     div.footer
       | Site assets:
       == links_with_seperator([{text: 'My Custom Page', url: build_url('custom.html')},
+                               {text: 'My Asset Page', url: build_url('map', 'site_albums.html')},
                                {text: 'CSS Download',   url: build_url('styles', 'basic.css')}], '|')

data/lib/photish/assets/example/site/map/site_albums.html.slim

@@ -0,0 +1,13 @@
+doctype html
+html
+  head
+    title Photish asset page
+    link href="#{build_url('styles', 'basic.css')}" media="screen" rel="stylesheet" type="text/css"
+  body
+    div.header
+      a href="/"
+        h1 PHOTISH
+    div.content
+      ol
+        - all_albums.each do |album|
+          li #{album.name}

data/lib/photish/cache/db_file.rb

@@ -33,7 +33,7 @@ module Photish
 
       def self.path(output_dir, filename)
         FileUtils.mkdir_p(output_dir)
-        path = File.join(output_dir, filename)
+        File.join(output_dir, filename)
       end
     end
   end

data/lib/photish/cli/interface.rb

@@ -2,6 +2,18 @@ module Photish
   module CLI
     class Interface < Thor
       package_name "Photish"
+      map "-v" => :version
+      map "--version" => :version
+
+      desc "version", "Current version"
+      def version
+        puts "Photish v#{Photish::VERSION}"
+      end
+
+      desc "credits", "Major conritbutors"
+      def credits
+        puts "#{Photish::AUTHOR_NAME} <#{Photish::AUTHOR_EMAIL}>"
+      end
 
       desc "generate", "Generates the gallery static site"
       option :force, type: :boolean

data/lib/photish/command/worker.rb

@@ -22,8 +22,8 @@ module Photish
                to: :config
 
       def render_whole_site
-        Render::Model.new(config, version_hash)
-                     .all_for(collection)
+        Render::Gallery.new(config, version_hash)
+                       .all_for(collection)
       end
 
       def collection

data/lib/photish/render/asset_page.rb

@@ -0,0 +1,48 @@
+module Photish
+  module Render
+    class AssetPage
+      include Log::Loggable
+
+      def initialize(collection, output_dir, site_dir)
+        @collection = collection
+        @output_dir = output_dir
+        @site_dir = site_dir
+      end
+
+      def render(page_paths)
+        render_all(page_paths)
+      end
+
+      private
+
+      attr_reader :collection,
+                  :output_dir,
+                  :site_dir
+
+      def render_all(page_paths)
+        Array(page_paths).each do |page_path|
+          rendered_model = render_page(page_path)
+          output_model_file = relative_to_output_dir(page_path)
+          output_model_dir = File.dirname(output_model_file)
+
+          log.debug "Rendering #{page_path} to #{output_model_file}"
+
+          FileUtils.mkdir_p(output_model_dir)
+          File.write(output_model_file, rendered_model)
+        end
+      end
+
+      def relative_to_output_dir(page_path)
+        relative_path = page_path.gsub(site_dir, '')
+        basename = File.basename(relative_path, File.extname(relative_path))
+        a = File.join(output_dir, File.dirname(relative_path), basename)
+        puts a
+        a
+      end
+
+      def render_page(page_path)
+        Tilt.new(page_path).render(collection)
+      end
+    end
+  end
+end

data/lib/photish/render/{model.rb → gallery.rb}

@@ -1,6 +1,6 @@
 module Photish
   module Render
-    class Model
+    class Gallery
       def initialize(config, version_hash)
         @config = config
         @version_hash = version_hash
@@ -48,7 +48,7 @@ module Photish
       end
 
       def page_template
-        Page.new(layout_file, output_dir)
+        GalleryPage.new(layout_file, output_dir)
       end
 
       def photo_template

data/lib/photish/render/{page.rb → gallery_page.rb}

@@ -1,6 +1,6 @@
 module Photish
   module Render
-    class Page
+    class GalleryPage
       include Log::Loggable
 
       def initialize(layout_file, output_dir)

data/lib/photish/render/image.rb

@@ -52,12 +52,17 @@ module Photish
 
       def process_next_image(image_queue)
         image = image_queue.pop
-        convert(image) if cache_changed?(image.url_path, image.path)
+        convert(image) if regenerate?(image)
       rescue Errno::ENOENT
         log.warn "Image not found #{image.path}"
         raise unless soft_failure
       end
 
+      def regenerate?(image)
+        cache_changed?(image.url_path, image.path) ||
+          !File.exist?(output_path(image))
+      end
+
       def to_queue(images)
         image_queue = Queue.new
         Array(images).shuffle.each { |image| image_queue << image }

data/lib/photish/render/site.rb

@@ -10,6 +10,7 @@ module Photish
         delete_empty_folders
         move_non_ignored_site_contents
         collection_template.render(collection)
+        render_asset_pages(collection)
       end
 
       private
@@ -21,8 +22,21 @@ module Photish
                :output_dir,
                :worker_index,
                :url,
+               :page_extension,
                to: :config
 
+      def render_asset_pages(collection)
+        AssetPage.new(collection,
+                      output_dir,
+                      site_dir).render(asset_page_paths)
+      end
+
+      def asset_page_paths
+        Dir["#{site_dir}/**/*.#{page_extension}"].reject do |dir|
+          dir.include? "#{File::SEPARATOR}_"
+        end
+      end
+
       def move_non_ignored_site_contents
         FileUtils.mkdir_p(output_dir)
         FileUtils.cp_r(non_ignored_site_contents,

data/lib/photish/version.rb

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

data/photish.gemspec

@@ -6,8 +6,8 @@ require 'photish/version'
 Gem::Specification.new do |spec|
   spec.name          = "photish"
   spec.version       = Photish::VERSION
-  spec.authors       = ["Henry Lawson"]
-  spec.email         = ["henry.lawson@foinq.com"]
+  spec.authors       = [Photish::AUTHOR_NAME]
+  spec.email         = [Photish::AUTHOR_EMAIL]
 
   spec.summary       = %q{A static photo site generator}
   spec.description   = %q{Photish is a simple, convention based (but
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^exe/[^\.]}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = '>= 2.0'
@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "anemone", "~> 0.7"
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "aruba"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "cucumber"
   spec.add_development_dependency "pry"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: photish
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Henry Lawson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-03 00:00:00.000000000 Z
+date: 2016-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -192,6 +192,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -331,6 +345,7 @@ files:
 - ".codeclimate.yml"
 - ".csslintrc"
 - ".gitignore"
+- ".jrubyrc"
 - ".pryrc"
 - ".rspec"
 - ".rubocop.yml"
@@ -344,6 +359,7 @@ files:
 - TODO.md
 - bin/console
 - bin/setup
+- exe/.jrubyrc
 - exe/photish
 - lib/photish.rb
 - lib/photish/assets/Gemfile
@@ -370,6 +386,7 @@ files:
 - lib/photish/assets/example/site/_templates/photo.slim
 - lib/photish/assets/example/site/custom.html
 - lib/photish/assets/example/site/images/crumbs.gif
+- lib/photish/assets/example/site/map/site_albums.html.slim
 - lib/photish/assets/example/site/styles/basic.css
 - lib/photish/assets/gitignore
 - lib/photish/cache/db_file.rb
@@ -406,9 +423,10 @@ files:
 - lib/photish/plugin/repository.rb
 - lib/photish/plugin/type.rb
 - lib/photish/rake/task.rb
+- lib/photish/render/asset_page.rb
+- lib/photish/render/gallery.rb
+- lib/photish/render/gallery_page.rb
 - lib/photish/render/image.rb
-- lib/photish/render/model.rb
-- lib/photish/render/page.rb
 - lib/photish/render/site.rb
 - lib/photish/render/template.rb
 - lib/photish/version.rb