photish 0.1.4 → 0.1.5

data/.travis.yml

@@ -1,4 +1,14 @@
 language: ruby
 rvm:
   - 2.2.2
-before_install: gem install bundler -v 1.10.6
+sudo: false
+before_install:
+  - gem install bundler -v 1.10.6
+script: rake
+addons:
+  code_climate:
+    repo_token: ae398c193255da8c5e030cb6251f053c76757635e5215e65efa32f52d003a519
+  apt:
+    packages:
+      - libmagic-dev
+      - libimage-exiftool-perl

data/README.md

@@ -1,3 +1,9 @@
+[![Gem Version](https://badge.fury.io/rb/photish.svg)](https://badge.fury.io/rb/photish)
+[![Build Status](https://travis-ci.org/henrylawson/photish.svg)](https://travis-ci.org/henrylawson/photish)
+[![Dependency Status](https://gemnasium.com/henrylawson/photish.svg)](https://gemnasium.com/henrylawson/photish)
+[![Code Climate](https://codeclimate.com/github/henrylawson/photish/badges/gpa.svg)](https://codeclimate.com/github/henrylawson/photish)
+[![Test Coverage](https://codeclimate.com/github/henrylawson/photish/badges/coverage.svg)](https://codeclimate.com/github/henrylawson/photish/coverage)
+[![Issue Count](https://codeclimate.com/github/henrylawson/photish/badges/issue_count.svg)](https://codeclimate.com/github/henrylawson/photish/issues)
 # Photish
 
 Photish is a simple, convention based (but configurable) static photo site
@@ -15,10 +21,27 @@ information, Photish creates a complete static website that can be hosted on an
 [NGINX](http://nginx.org/), [Apache HTTP Server](https://httpd.apache.org/), or
 even on [Github Pages](https://pages.github.com/).
 
-## Table of Contents
+## Getting Started
+
+It is strongly recommended to read through the [Installation](#installation)
+and [Usage](#usage) sections before seriously using Photish, however to get up
+and running:
+
+1. Ensure [ImageMagick](http://www.imagemagick.org/script/index.php),
+   [Exiftool](http://www.sno.phy.queensu.ca/~phil/exiftool/) and
+   [Nokogiri](http://www.nokogiri.org/tutorials/installing_nokogiri.html) are
+   installed (see [Dependencies](#dependencies))
+1. Install Photish `gem install photish`
+1. Create a base project with `photish init`
+1. Generate the HTML using `photish generate`
+1. Run a local HTTP server to view the site with `photish host`
+1. View your photo site at [http://localhost:9876](http://localhost:9876/)
+
+# Documentation
 
 - [Overview](#overview)
 - [Installation](#installation)
+  - [Dependencies](#dependencies)
 - [Usage](#usage)
   - [Initialize](#initialize)
     - [Basic Photish Structure](#basic-photish-structure)
@@ -64,6 +87,8 @@ Photish turns this:
         │   ├── layout.slim
         │   └── photo.slim
         ├── custom.html
+        ├── images
+        │   └── crumbs.gif
         └── styles
             └── basic.css
 
@@ -111,6 +136,8 @@ Into this:
         │       │   │   └── big-ear-dog-original.jpg
         │       │   └── index.html
         │       └── index.html
+        ├── images
+        │   └── crumbs.gif
         └── styles
             └── basic.css
 
@@ -144,6 +171,27 @@ photo site so you can track the version of Photish you are building with:
     $ echo 'gem "photish"' >> Gemfile
     $ bundle install
 
+### Dependencies
+
+Photish has dependencies on certain utilities:
+
+- [ImageMagick](http://www.imagemagick.org/script/index.php) for Image
+  conversion
+- [Exiftool](http://www.sno.phy.queensu.ca/~phil/exiftool/) for image metadata
+  retrieval
+- [Nokogiri](http://www.nokogiri.org/tutorials/installing_nokogiri.html) for
+  XML writing and parsing
+
+**On MacOSX, using [Brew](http://brew.sh/)**
+
+    $ brew install imagemagick
+    $ brew install exiftool
+
+**On Ubuntu or Debian**
+
+    $ sudo apt-get install imagemagick
+    $ sudo apt-get install libimage-exiftool-perl
+
 ## Usage
 
 Once you have photish installed. Get started with the following commands:
@@ -176,8 +224,10 @@ By default Photish uses [Slim](http://slim-lang.com/) as the template language.
 The templates can be in any format supported by
 [Tilt](https://github.com/rtomayko/tilt). To use a different template language:
 
-1. Create a `layout`, `collection`, `album` and `photo` file with
-the file extension of the template engine you prefer
+1. Create a `layout`, `collection`, `album` and `photo` file in the
+   `site/_templates` folder, with the file extension of the template engine you
+   prefer, supported extensions are documented by
+   [Tilt](https://github.com/rtomayko/tilt)
 1. Update `config.yml` to reference your newly created template files
 1. Re write the basic template code in your chosen language
 
@@ -186,10 +236,11 @@ the file extension of the template engine you prefer
 Any content not starting with an `_` (underscore) in the `site` folder will be
 copied to the `output` folder.
 
-In the example in the Overview section. There are 2 static asset files. These
-are:
+In the example in the Overview section. There are a few static asset files.
+These are:
 
 1. `site/styles/basic.css`
+1. `site/images/crumbs.gif`
 1. `site/custom.html`
 
 Both of these files were copied by Photish to the output folder, respecting
@@ -276,6 +327,7 @@ Attribute or Method | Description
 ------------------- | -----------
 url                 | the URL of this page
 metadata            | an object with methods for the attributes in the `photos.yml` file
+albums              | an array of child [Albums](https://github.com/henrylawson/photish/blob/master/lib/photish/gallery/album.rb) within this folder
 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)
@@ -296,6 +348,7 @@ Attribute or Method | Description
 name                | the name of the folder, i.e. `photos/My album/` will become `My album`
 url                 | the URL of this page
 metadata            | an object with methods for the attributes in the `{album_name}.yml` file stored at the same level as the album
+albums              | an array of child [Albums](https://github.com/henrylawson/photish/blob/master/lib/photish/gallery/album.rb) within this folder
 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)

data/Rakefile

@@ -9,4 +9,4 @@ Cucumber::Rake::Task.new(:features) do |t|
   t.cucumber_opts = "features --format pretty"
 end
 
-task :default => [:features, :spec]
+task :default => [:spec, :features]

data/TODO.md

@@ -1,11 +1,21 @@
 # Photish Todo
 
-## Must Have
+## In Progress
 
-1. A sitemap helper
-1. A breadcrumb helper
+1. A .gitignore file for the `init` project
+1. Change logging to colorize on command options
+1. Pipe WEBrick logging to log module
 
-## Might Have
+## Backlog
 
-1. `deploy` to deploy to github pages
-1. Relative/absolute with/without hostname URLs (for different host envs) with view helper
+1. Custom user created helpers in templates
+1. RDoc documentation for classes
+1. A Rakefile task for each of the commands
+1. A `deploy` command as a gem to deploy to github pages, netlify, amazon s3
+1. Monitor for file changes and regenerate for `host` command
+1. URL customization, relative, absolute with or without hostname URLs (for
+   different host envs)
+1. Proper asset pipeline for CSS
+1. Customer template rendering outside of `_templates` folder
+1. A sitemap helper for use in custome templates for example `sitemap.xml`
+1. Share on RubyWebToolkit, StaticGen, etc

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

@@ -8,6 +8,8 @@ html
       a href="/"
         h1 PHOTISH
     div.content
+      div.site-breadcrumbs
+        == breadcrumbs
       == yield
     div.footer
       | Site assets:

data/lib/photish/assets/site/styles/basic.css

@@ -1,45 +1,68 @@
 body {
-  padding:0px;
-  margin:0px;
   font-family:sans-serif, arial, helvetica;
   font-size:12pt;
+  margin:0;
+  padding:0;
 }
-
-div.header {
-  padding:10px 50px 10px 50px;
-  border-bottom:30px solid #e9e9e9;
-}
-div.header h1 {
+h1 {
   font-size:200%;
 }
-div.album {
-}
-div.album div.album-title {
+.header {
+  border-bottom:30px solid #e9e9e9;
   padding:10px 50px 10px 50px;
-  border-top:1px solid #f1f1f1;
+}
+.album .album-title {
   border-bottom:1px solid #f1f1f1;
+  border-top:1px solid #f1f1f1;
+  padding:10px 50px 10px 50px;
 }
-div.album div.album-photos a {
-  padding:0;
-  margin:0;
+.album .album-photos a {
   line-height:0;
+  margin:0;
+  padding:0;
 }
-div.album div.album-photos div.album-photo, div.album-blurb {
+.album .album-photos .album-photo, .album-blurb {
   padding:10px 50px 10px 50px;
 }
-div.album div.album-photos a img {
-  padding:0;
-  margin:0;
+.site-breadcrumbs {
+  font-size:90%;
+}
+.album .album-photos a img {
   display:block;
+  margin:0;
+  padding:0;
 }
 a {
-  text-decoration:none;
   color:#F16272;
+  text-decoration:none;
 }
-div.sub-albums a {
+.sub-albums a {
   font-size:90%;
 }
-div.footer {
+.footer {
   border-top:30px solid #e9e9e9;
   padding:10px 50px 10px 50px;
 }
+ul.breadcrumbs, ul.breadcrumbs li {
+  list-style-type:none;
+  margin:0;
+  padding:0;
+}
+ul.breadcrumbs {
+  border:1px solid #dedede;
+  height:2.3em;
+}
+ul.breadcrumbs li {
+  color:#777;
+  float:left;
+  line-height:2.3em;
+  padding-left:.75em;
+}
+ul.breadcrumbs li a {
+  background:url(/images/crumbs.gif) no-repeat right center;
+  display:block;
+  padding:0 15px 0 0;
+}
+ul.breadcrumbs li a:link, ul.breadcrumbs li a:visited {
+  text-decoration:none;
+}

data/lib/photish/config/location.rb

@@ -1,5 +1,5 @@
- module Photish
-   module Config
+module Photish
+  module Config
     class Location
       FILE_NAME = 'config.yml'
 
@@ -17,7 +17,7 @@
       attr_reader :site_dir
 
       def ensure_expected_path_exists
-        return if File.exists?(expected_path)
+        return if File.exist?(expected_path)
         raise "Config file does not exist at #{expected_path}"
       end
 

data/lib/photish/gallery/album.rb

@@ -2,6 +2,7 @@ require 'photish/gallery/photo'
 require 'photish/gallery/traits/urlable'
 require 'photish/gallery/traits/albumable'
 require 'photish/gallery/traits/metadatable'
+require 'photish/gallery/traits/breadcrumbable'
 require 'active_support'
 require 'active_support/core_ext'
 require 'filemagic'
@@ -13,6 +14,7 @@ module Photish
       include ::Photish::Gallery::Traits::Urlable
       include ::Photish::Gallery::Traits::Albumable
       include ::Photish::Gallery::Traits::Metadatable
+      include ::Photish::Gallery::Traits::Breadcrumbable
 
       delegate :qualities, to: :parent, allow_nil: true
 

data/lib/photish/gallery/collection.rb

@@ -1,6 +1,7 @@
 require 'photish/gallery/album'
 require 'photish/gallery/traits/albumable'
 require 'photish/gallery/traits/metadatable'
+require 'photish/gallery/traits/breadcrumbable'
 
 module Photish
   module Gallery
@@ -9,6 +10,7 @@ module Photish
       include ::Photish::Gallery::Traits::Urlable
       include ::Photish::Gallery::Traits::Albumable
       include ::Photish::Gallery::Traits::Metadatable
+      include ::Photish::Gallery::Traits::Breadcrumbable
 
       attr_reader :qualities
 
@@ -17,6 +19,10 @@ module Photish
         @qualities = qualities
       end
 
+      def name
+        'Home'
+      end
+
       def base_url_parts
         []
       end
@@ -32,6 +38,10 @@ module Photish
       def url_end
         'index.html'
       end
+
+      def parent
+        nil
+      end
     end
   end
 end

data/lib/photish/gallery/photo.rb

@@ -1,5 +1,6 @@
 require 'photish/gallery/traits/urlable'
 require 'photish/gallery/traits/metadatable'
+require 'photish/gallery/traits/breadcrumbable'
 require 'photish/gallery/image'
 require 'active_support'
 require 'active_support/core_ext'
@@ -11,6 +12,7 @@ module Photish
 
       include ::Photish::Gallery::Traits::Urlable
       include ::Photish::Gallery::Traits::Metadatable
+      include ::Photish::Gallery::Traits::Breadcrumbable
 
       delegate :qualities, to: :parent, allow_nil: true
 

data/lib/photish/gallery/traits/breadcrumbable.rb

@@ -0,0 +1,39 @@
+require 'nokogiri'
+
+module Photish
+  module Gallery
+    module Traits
+      module Breadcrumbable
+        def breadcrumbs
+          doc = Nokogiri::HTML::DocumentFragment.parse("")
+          builder = Nokogiri::HTML::Builder.with(doc) do |doc|
+            doc.ul(class: 'breadcrumbs') {
+              parents_and_me.each_with_index do |level, index|
+                doc.li(class: crumb_class(index)) {
+                  doc.a(level.name, href: level.url)
+                }
+              end
+            }
+          end
+          doc.to_html
+        end
+
+        def parents_and_me
+          [parent.try(:parents_and_me), self].flatten.compact
+        end
+
+        private
+
+        def crumb_class(index)
+          crumb_class = []
+          crumb_class << 'breadcrumb'
+          crumb_class << "crumb-#{index}"
+          crumb_class << 'crumb-first' if index == 0
+          crumb_class << 'crumb-last' if index == (parents_and_me.count - 1)
+          crumb_class << 'crumb-only' if parents_and_me.count == 1
+          crumb_class.join(' ')
+        end
+      end
+    end
+  end
+end

data/lib/photish/gallery/traits/metadatable.rb

@@ -6,7 +6,7 @@ module Photish
     module Traits
       module Metadatable
         def metadata
-          return unless File.exists?(metadata_file)
+          return unless File.exist?(metadata_file)
           RecursiveOpenStruct.new(YAML.load_file(metadata_file))
         end
 

data/lib/photish/version.rb

@@ -1,3 +1,3 @@
 module Photish
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/photish.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 1.8.6'
+  spec.required_ruby_version = '>= 1.9.3'
 
   spec.add_dependency "thor", "~> 0.1"
   spec.add_dependency "activesupport", "~> 4.2"
@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "mini_exiftool", "~> 2.5"
   spec.add_dependency "recursive-open-struct", "~> 0.6"
   spec.add_dependency "colorize", "~> 0.7"
+  spec.add_dependency "nokogiri", "~> 1.6"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
@@ -40,4 +41,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "aruba"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "retriable"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "rspec-html-matchers"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: photish
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Henry Lawson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-24 00:00:00.000000000 Z
+date: 2015-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -248,6 +262,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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-html-matchers
+  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.
@@ -258,8 +300,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".csslintrc"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -286,6 +331,7 @@ files:
 - lib/photish/assets/site/_templates/layout.slim
 - lib/photish/assets/site/_templates/photo.slim
 - lib/photish/assets/site/custom.html
+- lib/photish/assets/site/images/crumbs.gif
 - lib/photish/assets/site/styles/basic.css
 - lib/photish/cli.rb
 - lib/photish/command/generation.rb
@@ -301,6 +347,7 @@ files:
 - lib/photish/gallery/image.rb
 - lib/photish/gallery/photo.rb
 - lib/photish/gallery/traits/albumable.rb
+- lib/photish/gallery/traits/breadcrumbable.rb
 - lib/photish/gallery/traits/metadatable.rb
 - lib/photish/gallery/traits/urlable.rb
 - lib/photish/log/logger.rb
@@ -321,7 +368,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.6
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="