photish 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86c9bceeb05e4c52b9e06582cf5d47332d7338c1
-  data.tar.gz: 9f69c399a197274f8383c927ff7be19f08915080
+  metadata.gz: c712dc33fcb4d3676a75f2d0db5ff195d262dda8
+  data.tar.gz: 079592c5851be9fc41fe1ac3303140f518189b62
 SHA512:
-  metadata.gz: 174364ba192d4f23e91ae45fd6cb26741e1806f15b27f5a6f20dfa1ab285e71e4ea01eb6dd7b65f0ce635beaeb1f2f208b16ef8697e600c32f505dd1af96d6a3
-  data.tar.gz: a0002e4bd187e082e354e0135b787eb05f24a14cab3197dc48bd815d0278565b0da81d68eb721940a363c1ce4cb0fe3adebeb0cb450b11171d519afdae636e97
+  metadata.gz: 387946be6d365bbd64b5a4890e07177f9ec4d2142252139b362ceebe2361811b9f9fed4d3ac87b2e392e64a9847fb1c56c82ca0cff9963e034c288ea31ade62d
+  data.tar.gz: 197d39dc376c55ad3c1b4528383f44d90598934483cc350803381289804435bf406d0438468c0f1552bbd5c3a284c1e5ec0a6b37c47d165ffb5269e4cfbe4e1d

data/README.md

@@ -15,6 +15,28 @@ 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
+
+- [Overview](#overview)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Initialize](#initialize)
+    - [Basic Photish Structure](#basic-photish-structure)
+    - [Template Engines](#template-engines)
+    - [Site Assets](#site-assets)
+    - [Config File Options](#config-file-options)
+    - [Customizing Templates](#customizing-templates)
+      - [Layout Template](#layout-template)
+      - [Collection Template](#collection-template)
+      - [Album Template](#album-template)
+      - [Photo Template](#photo-template)
+  - [Generate](#generate)
+    - [Execution Order](#execution-order)
+  - [Host](#host)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+
 ## Overview
 
 Photish turns this:
@@ -159,7 +181,7 @@ the file extension of the template engine you prefer
 1. Update `config.yml` to reference your newly created template files
 1. Re write the basic template code in your chosen language
 
-#### Site Assets, CSS, Images, JavaScript
+#### Site Assets
 
 Any content not starting with an `_` (underscore) in the `site` folder will be
 copied to the `output` folder.

data/TODO.md

@@ -2,17 +2,11 @@
 
 ## Must Have
 
-1. `init` command to get started
+1. Make the assets stuff smaller, prettier HTML/CSS design
 
 ## Might Have
 
 1. `deploy` to deploy to github pages
-1. Exception and error handling to have clearer errors
-1. Startup bash script should install image magick, libmagic, exiftool
-1. README table of contents
-
-## Potential Features
-
 1. A sitemap helper
 1. A breadcrumb helper
 1. Relative/absolute with/without hostname URLs (for different host envs) with view helper

data/bin/setup

@@ -2,6 +2,9 @@
 set -euo pipefail
 IFS=$'\n\t'
 
+command -v convert >/dev/null 2>&1 || { echo >&2 "imagemagick required. run \"brew install imagemagick\""; exit 1; }
+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/cli.rb

@@ -1,7 +1,7 @@
 require 'thor'
-require 'photish/generation'
-require 'photish/host'
-require 'photish/init'
+require 'photish/command/generation'
+require 'photish/command/host'
+require 'photish/command/init'
 
 module Photish
   class CLI < Thor
@@ -9,17 +9,17 @@ module Photish
 
     desc "generate", "Generates the gallery static site"
     def generate
-      Photish::Generation.new(options).execute
+      Command::Generation.new(options).execute
     end
 
     desc "host", "Serves the HTML on a HTTP server at http://localhost:9876/"
     def host
-      Photish::Host.new(options).execute
+      Command::Host.new(options).execute
     end
 
     desc "init", "Creates a basic Photish site sctructure"
     def init
-      Photish::Init.new(options).execute
+      Command::Init.new(options).execute
     end
   end
 end

data/lib/photish/command/generation.rb

@@ -0,0 +1,73 @@
+require 'photish/log/logger'
+require 'photish/config/app_settings'
+require 'photish/gallery/collection'
+require 'photish/render/site'
+
+module Photish
+  module Command
+    class Generation
+      include ::Photish::Log::Logger
+
+      def initialize(runtime_config)
+        @config = Photish::Config::AppSettings.new(runtime_config)
+                                              .config
+      end
+
+      def execute
+        log_important_config_values
+        log_album_and_photo_names
+        render_whole_site
+        log 'Site generation completed successfully'
+      end
+
+      private
+
+      attr_reader :config
+
+      def log_important_config_values
+        log "Photo directory: #{photo_dir}"
+        log "Site directory: #{site_dir}"
+        log "Output directory: #{output_dir}"
+      end
+
+      def log_album_and_photo_names
+        collection.albums.each do |album|
+          log album.name
+          log album.photos.map(&:name)
+        end
+      end
+
+      def render_whole_site
+        Photish::Render::Site.new(templates,
+                                  site_dir,
+                                  output_dir)
+                             .all_for(collection)
+      end
+
+      def photo_dir
+        config.val(:photo_dir)
+      end
+
+      def output_dir
+        config.val(:output_dir)
+      end
+
+      def site_dir
+        config.val(:site_dir)
+      end
+
+      def collection
+        @collection ||= Gallery::Collection.new(photo_dir, qualities)
+      end
+
+      def qualities
+        config.val(:qualities)
+              .map { |quality| OpenStruct.new(quality) }
+      end
+
+      def templates
+        OpenStruct.new(config.val(:templates))
+      end
+    end
+  end
+end

data/lib/photish/command/host.rb

@@ -0,0 +1,38 @@
+require 'photish/log/logger'
+require 'webrick'
+
+module Photish
+  module Command
+    class Host
+      include ::Photish::Log::Logger
+
+      def initialize(runtime_config)
+        @config = Photish::Config::AppSettings.new(runtime_config)
+                                              .config
+      end
+
+      def execute
+        trap 'INT' do server.shutdown end
+        server.start
+        log "Site is running at 0.0.0.0:#{port}"
+      end
+
+      private
+
+      attr_reader :config
+
+      def server
+        @server ||= WEBrick::HTTPServer.new(Port: port, 
+                                            DocumentRoot: output_dir)
+      end
+
+      def port
+        config.val(:port)
+      end
+
+      def output_dir
+        config.val(:output_dir)
+      end
+    end
+  end
+end

data/lib/photish/command/init.rb

@@ -0,0 +1,40 @@
+require 'photish/log/logger'
+
+module Photish
+  module Command
+    class Init
+      include ::Photish::Log::Logger
+
+      def initialize(runtime_config)
+        @runtime_config = runtime_config
+      end
+
+      def execute
+        FileUtils.cp_r(config_file, Dir.pwd)
+        FileUtils.cp_r(photos_dir, Dir.pwd)
+        FileUtils.cp_r(site_dir, Dir.pwd)
+        log "Photish site initiated successfully"
+      end
+
+      private
+
+      attr_reader :runtime_config
+
+      def config_file
+        asset_path('config.yml')
+      end
+
+      def photos_dir
+        asset_path('photos')
+      end
+
+      def site_dir
+        asset_path('site')
+      end
+
+      def asset_path(*path)
+        File.join(File.dirname(__FILE__), '..', 'assets', path)
+      end
+    end
+  end
+end

data/lib/photish/log/logger.rb

@@ -0,0 +1,11 @@
+require 'colorize'
+
+module Photish
+  module Log
+    module Logger
+      def log(message)
+        puts "#{Time.now.iso8601.colorize(:blue)} => #{message.to_s.colorize(:green)}"
+      end
+    end
+  end
+end

data/lib/photish/render/image_conversion.rb

@@ -4,7 +4,7 @@ module Photish
   module Render
     class ImageConversion
 
-      include Photish::Log
+      include Photish::Log::Logger
 
       def initialize(output_dir)
         @output_dir = output_dir

data/lib/photish/render/page.rb

@@ -4,7 +4,7 @@ module Photish
   module Render
     class Page
 
-      include Photish::Log
+      include Photish::Log::Logger
 
       def initialize(layout_file, template_file, output_dir)
         @layout_file = layout_file

data/lib/photish/version.rb

@@ -1,3 +1,3 @@
 module Photish
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/photish.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "anemone", "~> 0.7"
   spec.add_dependency "mini_exiftool", "~> 2.5"
   spec.add_dependency "recursive-open-struct", "~> 0.6"
+  spec.add_dependency "colorize", "~> 0.7"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: photish
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Henry Lawson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-23 00:00:00.000000000 Z
+date: 2015-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -274,6 +288,9 @@ files:
 - lib/photish/assets/site/custom.html
 - lib/photish/assets/site/styles/basic.css
 - lib/photish/cli.rb
+- lib/photish/command/generation.rb
+- lib/photish/command/host.rb
+- lib/photish/command/init.rb
 - lib/photish/config/app_settings.rb
 - lib/photish/config/default_config.rb
 - lib/photish/config/file_config.rb
@@ -286,10 +303,7 @@ files:
 - lib/photish/gallery/traits/albumable.rb
 - lib/photish/gallery/traits/metadatable.rb
 - lib/photish/gallery/traits/urlable.rb
-- lib/photish/generation.rb
-- lib/photish/host.rb
-- lib/photish/init.rb
-- lib/photish/log.rb
+- lib/photish/log/logger.rb
 - lib/photish/render/image_conversion.rb
 - lib/photish/render/page.rb
 - lib/photish/render/site.rb

data/lib/photish/generation.rb

@@ -1,71 +0,0 @@
-require 'photish/log'
-require 'photish/config/app_settings'
-require 'photish/gallery/collection'
-require 'photish/render/site'
-
-module Photish
-  class Generation
-    include Photish::Log
-
-    def initialize(runtime_config)
-      @config = Photish::Config::AppSettings.new(runtime_config)
-                                            .config
-    end
-
-    def execute
-      log_important_config_values
-      log_album_and_photo_names
-      render_whole_site
-      log 'Site generation completed successfully'
-    end
-
-    private
-
-    attr_reader :config
-
-    def log_important_config_values
-      log "Photo directory: #{photo_dir}"
-      log "Site directory: #{site_dir}"
-      log "Output directory: #{output_dir}"
-    end
-
-    def log_album_and_photo_names
-      collection.albums.each do |album|
-        log album.name
-        log album.photos.map(&:name)
-      end
-    end
-
-    def render_whole_site
-      Photish::Render::Site.new(templates,
-                                site_dir,
-                                output_dir)
-                           .all_for(collection)
-    end
-
-    def photo_dir
-      config.val(:photo_dir)
-    end
-
-    def output_dir
-      config.val(:output_dir)
-    end
-
-    def site_dir
-      config.val(:site_dir)
-    end
-
-    def collection
-      @collection ||= Gallery::Collection.new(photo_dir, qualities)
-    end
-
-    def qualities
-      config.val(:qualities)
-            .map { |quality| OpenStruct.new(quality) }
-    end
-
-    def templates
-      OpenStruct.new(config.val(:templates))
-    end
-  end
-end

data/lib/photish/host.rb

@@ -1,35 +0,0 @@
-require 'webrick'
-
-module Photish
-  class Host
-    include Photish::Log
-
-    def initialize(runtime_config)
-      @config = Photish::Config::AppSettings.new(runtime_config)
-                                            .config
-    end
-
-    def execute
-      trap 'INT' do server.shutdown end
-      server.start
-      log "Site is running at 0.0.0.0:#{port}"
-    end
-
-    private
-
-    attr_reader :config
-
-    def server
-      @server ||= WEBrick::HTTPServer.new(Port: port, 
-                                          DocumentRoot: output_dir)
-    end
-
-    def port
-      config.val(:port)
-    end
-
-    def output_dir
-      config.val(:output_dir)
-    end
-  end
-end

data/lib/photish/init.rb

@@ -1,36 +0,0 @@
-module Photish
-  class Init
-    include Photish::Log
-
-    def initialize(runtime_config)
-      @runtime_config = runtime_config
-    end
-
-    def execute
-      FileUtils.cp_r(config_file, Dir.pwd)
-      FileUtils.cp_r(photos_dir, Dir.pwd)
-      FileUtils.cp_r(site_dir, Dir.pwd)
-      log "Photish site initiated successfully"
-    end
-
-    private
-
-    attr_reader :runtime_config
-
-    def config_file
-      asset_path('config.yml')
-    end
-
-    def photos_dir
-      asset_path('photos')
-    end
-
-    def site_dir
-      asset_path('site')
-    end
-
-    def asset_path(*path)
-      File.join(File.dirname(__FILE__), 'assets', path)
-    end
-  end
-end

data/lib/photish/log.rb

@@ -1,7 +0,0 @@
-module Photish
-  module Log
-    def log(message)
-      puts "#{Time.now.iso8601} => #{message}"
-    end
-  end
-end