photish 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f389c011653a5f505b5da4ec206d127fad29b9c5
-  data.tar.gz: f48fc53c2bdd720e105ac1d9cbccb18717f53825
+  metadata.gz: 4815953c918957b9276b9f71f6ad4e296a8c4120
+  data.tar.gz: 27900c1a28826e6e1c69ec35c4c67388b6638347
 SHA512:
-  metadata.gz: 2e7461f3149ba958ddce657af522a08c1ce9a2aa98a5fbfbaaba4d398bc6769b920e55c610505586d48982ade9694e8a38ba44b2be6e2d980f01f2c84ea45e57
-  data.tar.gz: 0cc7394c4dcafad97d03731c62fa61681d654de03b41e7508b60e0a942620c5d2526915b0cb4b14937519c2497f489072400fa13471a74f69a3d25f1816e6c02
+  metadata.gz: 8941c122835aed8ffc2dac6c0f0b1f3c1f6b286ec0c9a020df21c252db438a9c9905fe9ef2b5ae8382674abb35810aa95f23ec7038bf8f2a27f50b7026aed7ba
+  data.tar.gz: 953ba2db9319f21c7dee454c8ddb63da089838d36737c6c459f8c2313e099db5253bb63cb56aaaba9d2b82a8bd7b9a59205ae2da99dc2fc76adbdf89318d192b

data/Gemfile

@@ -2,3 +2,7 @@ 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

@@ -56,6 +56,7 @@ and running:
   - [Generate](#generate)
     - [Execution Order](#execution-order)
   - [Host](#host)
+  - [Rake Task](#rake-task)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -412,7 +413,29 @@ server to serve the HTML files:
 
     $ photish host
 
-The local version of your website will be visible at [http://localhost:9876/](http://localhost:9876/)
+The local version of your website will be visible at
+[http://localhost:9876/](http://localhost:9876/).
+
+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`.
+
+### Rake Task
+
+If you would prefer to use Photish as a task in
+[Rake](http://rake.rubyforge.org/). A helper class is available to create
+custom rake tasks that call Photish. The helper class is defined in
+[Photish::Rake::Task](https://github.com/henrylawson/photish/blob/master/lib/photish/rake/task.rb).
+
+In your Rakefile, simply add the following to wrap the generate command:
+
+```ruby
+Photish::Rake::Task.new(:generate, 'Compiles the project to HTML') do |t|
+  t.options = "generate"
+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`.
 
 ## Development
 

data/Rakefile

@@ -2,6 +2,7 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require 'cucumber'
 require 'cucumber/rake/task'
+require 'photish/rake/task'
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -9,4 +10,35 @@ Cucumber::Rake::Task.new(:features) do |t|
   t.cucumber_opts = "features --format pretty"
 end
 
-task :default => [:spec, :features]
+desc 'Gather code climate results'
+task :gather_coverage do
+  require 'simplecov'
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter::Formatter.new.format(SimpleCov.result)
+end
+
+desc 'Clean output folders'
+task :clean do
+  FileUtils.rm_rf('coverage')
+end
+
+task :default => [:clean,
+                  :spec,
+                  :features,
+                  :gather_coverage]
+
+namespace :photish do
+  Photish::Rake::Task.new(:init, 'Creates a basic project') do |t|
+    t.options = "init"
+  end
+
+  Photish::Rake::Task.new(:generate, 'Generates all the code') do |t|
+    t.options = "generate"
+  end
+
+  Photish::Rake::Task.new(:host, 'Starts a HTTP and hosts the code') do |t|
+    t.options = "host"
+  end
+
+  task :all => [:init, :generate, :host]
+end

data/TODO.md

@@ -5,13 +5,13 @@
 ## Backlog
 
 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. Custom template rendering outside of `_templates` folder
 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. A sitemap helper plugin for use in custom templates for example
+   `sitemap.xml`
 1. Share on RubyWebToolkit, StaticGen, etc
+1. RDoc documentation for classes
+1. More intelligent regeneration based on changes

data/exe/photish

@@ -1,4 +1,12 @@
 #!/usr/bin/env ruby
+if ENV['COVERAGE']
+  require 'simplecov'
+  require 'codeclimate-test-reporter'
 
-require 'photish/cli'
-Photish::CLI.start
+  SimpleCov.command_name "photish-binary-#{Process.pid}"
+  SimpleCov.root(File.join(File.expand_path(File.dirname(__FILE__)), '..'))
+  SimpleCov.start CodeClimate::TestReporter.configuration.profile
+end
+
+require 'photish/cli/interface'
+Photish::CLI::Interface.start

data/lib/photish/cli/interface.rb

@@ -0,0 +1,28 @@
+require 'thor'
+require 'photish/command/generate'
+require 'photish/command/host'
+require 'photish/command/init'
+
+module Photish
+  module CLI
+    class Interface < Thor
+      package_name "Photish"
+
+      desc "generate", "Generates the gallery static site"
+      def generate
+        Photish::Command::Generate.new(options).execute
+      end
+
+      desc "host", "Serves the HTML on a HTTP server"
+      def host
+        Photish::Command::Host.new(options).execute
+      end
+
+      desc "init", "Creates a basic Photish site sctructure"
+      def init
+        Photish::Command::Init.new(options).execute
+      end
+    end
+  end
+end
+

data/lib/photish/command/{generation.rb → generate.rb}

@@ -5,15 +5,14 @@ require 'photish/render/site'
 
 module Photish
   module Command
-    class Generation
+    class Generate
       def initialize(runtime_config)
-        @config = Photish::Config::AppSettings.new(runtime_config)
-                                              .config
+        @runtime_config = runtime_config
         @log = Logging.logger[self]
       end
 
       def execute
-        Photish::Log::Logger.setup_logging(config)
+        Photish::Log::Logger.instance.setup_logging(config)
 
         log_important_config_values
         log_album_and_photo_names
@@ -23,9 +22,14 @@ module Photish
 
       private
 
-      attr_reader :config, 
+      attr_reader :runtime_config,
                   :log
 
+      def config
+        @config ||= Photish::Config::AppSettings.new(runtime_config)
+                                                .config
+      end
+
       def log_important_config_values
         log.info "Photo directory: #{photo_dir}"
         log.info "Site directory: #{site_dir}"

data/lib/photish/command/host.rb

@@ -1,30 +1,44 @@
 require 'photish/log/logger'
 require 'photish/log/access_log'
 require 'webrick'
+require 'listen'
 
 module Photish
   module Command
     class Host
       def initialize(runtime_config)
-        @config = Photish::Config::AppSettings.new(runtime_config)
-                                              .config
+        @runtime_config = runtime_config
         @log = Logging.logger[self]
       end
 
       def execute
-        Photish::Log::Logger.setup_logging(config)
+        Photish::Log::Logger.instance.setup_logging(config)
 
-        trap 'INT' do server.shutdown end
         log.info "Site will be running at http://0.0.0.0:#{port}/"
-        server.start
-        log.info "Site has been shutdown"
+        log.info "Monitoring paths #{paths_to_monitor}"
+
+        regenerate_entire_site
+        start_http_server_with_listener
       end
 
       private
 
-      attr_reader :config,
+      attr_reader :runtime_config,
                   :log
 
+      def start_http_server_with_listener
+        trap 'INT' do server.shutdown end
+        listener.start
+        server.start
+        listener.stop
+        log.info "Photish host has shutdown"
+      end
+
+      def config
+        @config ||= Photish::Config::AppSettings.new(runtime_config)
+                                                .config
+      end
+
       def server
         @server ||= WEBrick::HTTPServer.new(Port: port,
                                             DocumentRoot: output_dir,
@@ -32,6 +46,21 @@ module Photish
                                             Logger: log)
       end
 
+      def listener
+        @listener ||= Listen.to(*paths_to_monitor) do |modified, added, removed|
+          log.info "File was modified #{modified}" if modified.present?
+          log.info "File was added #{added}" if added.present?
+          log.info "File was removed #{removed}" if removed.present?
+
+          regenerate_entire_site
+        end
+      end
+
+      def paths_to_monitor
+        [site_dir,
+         photos_dir]
+      end
+
       def access_log
         [
           [Photish::Log::AccessLog.new,
@@ -39,6 +68,12 @@ module Photish
         ]
       end
 
+      def regenerate_entire_site
+        log.info "Regenerating site"
+        Photish::Command::Generate.new(runtime_config)
+                                   .execute
+      end
+
       def port
         config.val(:port)
       end
@@ -46,6 +81,14 @@ module Photish
       def output_dir
         config.val(:output_dir)
       end
+
+      def site_dir
+        config.val(:site_dir)
+      end
+
+      def photos_dir
+        config.val(:photo_dir)
+      end
     end
   end
 end

data/lib/photish/command/init.rb

@@ -4,13 +4,12 @@ module Photish
   module Command
     class Init
       def initialize(runtime_config)
-        @config = Photish::Config::AppSettings.new(runtime_config)
-                                              .config
+        @runtime_config = runtime_config
         @log = Logging.logger[self]
       end
 
       def execute
-        Photish::Log::Logger.setup_logging(config)
+        Photish::Log::Logger.instance.setup_logging(config)
 
         FileUtils.cp_r(config_file, Dir.pwd)
         FileUtils.cp_r(gitignore_file, File.join(Dir.pwd, '.gitignore'))
@@ -21,9 +20,14 @@ module Photish
 
       private
 
-      attr_reader :config,
+      attr_reader :runtime_config,
                   :log
 
+      def config
+        @config ||= Photish::Config::AppSettings.new(runtime_config)
+                                                .config
+      end
+
       def config_file
         asset_path('config.yml')
       end

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

@@ -6,7 +6,7 @@ module Photish
       module Breadcrumbable
         def breadcrumbs
           doc = Nokogiri::HTML::DocumentFragment.parse("")
-          builder = Nokogiri::HTML::Builder.with(doc) do |doc|
+          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)) {

data/lib/photish/log/logger.rb

@@ -2,64 +2,72 @@ require 'logging'
 
 module Photish
   module Log
-    module Logger
-      class << self
-        def setup_logging(config)
-          setup_color_scheme if colorize?(config)
-          setup_stdout_output if output_to_stdout?(config)
-          setup_file_output if output_to_file?(config)
+    class Logger
+      include Singleton
 
-          Logging.logger.root.level = logging_level(config)
-        end
+      attr_accessor :setup_complete
 
-        private
+      def initialize
+        @setup_complete = false
+      end
+
+      def setup_logging(config)
+        return if setup_complete
+        setup_color_scheme if colorize?(config)
+        setup_stdout_output if output_to_stdout?(config)
+        setup_file_output if output_to_file?(config)
 
-        def logging_level(config)
-          config.val(:logging)[:level].to_sym
-        end
+        Logging.logger.root.level = logging_level(config)
+        self.setup_complete = true
+      end
 
-        def colorize?(config)
-          config.val(:logging)[:colorize]
-        end
+      private
 
-        def output_to_stdout?(config)
-          config.val(:logging)[:output].include?('stdout')
-        end
+      def logging_level(config)
+        config.val(:logging)[:level].to_sym
+      end
 
-        def output_to_file?(config)
-          config.val(:logging)[:output].include?('file')
-        end
+      def colorize?(config)
+        config.val(:logging)[:colorize]
+      end
 
-        def setup_color_scheme
-          Logging.color_scheme('bright',
-            levels: {
-              info: :green,
-              warn:  :yellow,
-              error: :red,
-              fatal: [:white, :on_red]
-            },
-            date: :blue,
-            logger: :cyan,
-            message: :magenta
-          )
-        end
+      def output_to_stdout?(config)
+        config.val(:logging)[:output].include?('stdout')
+      end
+
+      def output_to_file?(config)
+        config.val(:logging)[:output].include?('file')
+      end
 
-        def setup_stdout_output
-          Logging.appenders.stdout(
-            'stdout',
-            layout: Logging.layouts.pattern(
-              pattern: '[%d] %-5l %c: %m\n',
-              color_scheme: 'bright'
-            )
+      def setup_color_scheme
+        Logging.color_scheme('bright',
+          levels: {
+            info: :green,
+            warn:  :yellow,
+            error: :red,
+            fatal: [:white, :on_red]
+          },
+          date: :blue,
+          logger: :cyan,
+          message: :magenta
+        )
+      end
+
+      def setup_stdout_output
+        Logging.appenders.stdout(
+          'stdout',
+          layout: Logging.layouts.pattern(
+            pattern: '[%d] %-5l %c: %m\n',
+            color_scheme: 'bright'
           )
-          Logging.logger.root.add_appenders('stdout')
-        end
+        )
+        Logging.logger.root.add_appenders('stdout')
+      end
 
-        def setup_file_output
-          FileUtils.mkdir_p('log')
-          file_appender = Logging.appenders.file('log/photish.log')
-          Logging.logger.root.add_appenders(file_appender)
-        end
+      def setup_file_output
+        FileUtils.mkdir_p('log')
+        file_appender = Logging.appenders.file('log/photish.log')
+        Logging.logger.root.add_appenders(file_appender)
       end
     end
   end

data/lib/photish/rake/task.rb

@@ -0,0 +1,32 @@
+require 'photish/cli/interface'
+require 'rake'
+
+module Photish
+  module Rake
+    class Task
+      include ::Rake::DSL if defined?(::Rake::DSL)
+
+      attr_accessor :options
+
+      def initialize(task_name = "photish", desc = "Run photish")
+        @task_name = task_name
+        @desc = desc
+        yield self if block_given?
+        define_task
+      end
+
+      def options=(opts)
+        @options = String === opts ? opts.split(' ') : opts
+      end
+
+      private
+
+      def define_task
+        desc @desc
+        task @task_name do
+          Photish::CLI::Interface.start(options)
+        end
+      end
+    end
+  end
+end

data/lib/photish/version.rb

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

data/photish.gemspec

@@ -33,12 +33,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "recursive-open-struct", "~> 0.6"
   spec.add_dependency "nokogiri", "~> 1.6"
   spec.add_dependency "logging", "~> 2.0"
+  spec.add_dependency "listen", "~> 3.0"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "cucumber"
-  spec.add_development_dependency "aruba"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "retriable"
   spec.add_development_dependency "codeclimate-test-reporter"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: photish
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Henry Lawson
@@ -165,49 +165,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
+        version: '3.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -221,7 +221,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -334,8 +334,8 @@ files:
 - 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
+- lib/photish/cli/interface.rb
+- lib/photish/command/generate.rb
 - lib/photish/command/host.rb
 - lib/photish/command/init.rb
 - lib/photish/config/app_settings.rb
@@ -353,6 +353,7 @@ files:
 - lib/photish/gallery/traits/urlable.rb
 - lib/photish/log/access_log.rb
 - lib/photish/log/logger.rb
+- lib/photish/rake/task.rb
 - lib/photish/render/image_conversion.rb
 - lib/photish/render/page.rb
 - lib/photish/render/site.rb

data/lib/photish/cli.rb

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