photish 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 277dfe161a294df87082b4dd77c7f2d0da7a2b4d
-  data.tar.gz: 368345cfd9d277260840b2c3df17db71dfd491c2
+  metadata.gz: f389c011653a5f505b5da4ec206d127fad29b9c5
+  data.tar.gz: f48fc53c2bdd720e105ac1d9cbccb18717f53825
 SHA512:
-  metadata.gz: 0faabb7a8ba4dfc28a6d19dd17bf042e80dbde32d1a11b28401b6376d60c09a342466cb69f2fc223368f4ce6e01a8c88bfc8baafeabd3c44e3ac41ced080dea0
-  data.tar.gz: 6d086c3276c64e4d44b34d1cc42d804ff2b30cb2428c7992bd8957050be48e1d99899acd79a1bf84518e3f09cd4688b4cecf48efd0e9160b1ef3bf55934fdb87
+  metadata.gz: 2e7461f3149ba958ddce657af522a08c1ce9a2aa98a5fbfbaaba4d398bc6769b920e55c610505586d48982ade9694e8a38ba44b2be6e2d980f01f2c84ea45e57
+  data.tar.gz: 0cc7394c4dcafad97d03731c62fa61681d654de03b41e7508b60e0a942620c5d2526915b0cb4b14937519c2497f489072400fa13471a74f69a3d25f1816e6c02

data/README.md

@@ -255,7 +255,7 @@ generated file, the generated file will clobber the asset.
 
 #### Config File Options
 
-Below is a basic `config.yml` file:
+Below is a complete `config.yml` file:
 
 ```yaml
 port: 9876
@@ -269,6 +269,10 @@ templates:
   collection: collection.slim
   album: album.slim
   photo: photo.slim
+logging:
+  colorize: true
+  level: 'info'
+  output: ['stdout', 'file']
 ```
 
 The meanings and purpose of each field is defined below:
@@ -284,6 +288,10 @@ Field                  | Purpose
 `templates/collection` | the collection template file in the `site/_templates` folder
 `templates/album`      | the album template file in the `site/_templates` folder
 `templates/photo`      | the photo template file in the `site/_templates` folder
+`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`
+`logging/output`       | the appenders for the logger, `stdout` goes to `STDOUT`, `file` goes to `log/photish.log`
 
 #### Customizing Templates
 

data/TODO.md

@@ -2,10 +2,6 @@
 
 ## In Progress
 
-1. A .gitignore file for the `init` project
-1. Change logging to colorize on command options
-1. Pipe WEBrick logging to log module
-
 ## Backlog
 
 1. Custom user created helpers in templates

data/lib/photish/assets/config.yml

@@ -10,3 +10,7 @@ templates:
   collection: collection.slim
   album: album.slim
   photo: photo.slim
+logging:
+  colorize: true
+  level: 'info'
+  output: ['stdout', 'file']

data/lib/photish/assets/gitignore

@@ -0,0 +1,2 @@
+output
+log

data/lib/photish/cli.rb

@@ -12,7 +12,7 @@ module Photish
       Command::Generation.new(options).execute
     end
 
-    desc "host", "Serves the HTML on a HTTP server at http://localhost:9876/"
+    desc "host", "Serves the HTML on a HTTP server"
     def host
       Command::Host.new(options).execute
     end

data/lib/photish/command/generation.rb

@@ -6,34 +6,36 @@ 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
+        @log = Logging.logger[self]
       end
 
       def execute
+        Photish::Log::Logger.setup_logging(config)
+
         log_important_config_values
         log_album_and_photo_names
         render_whole_site
-        log 'Site generation completed successfully'
+        log.info 'Site generation completed successfully'
       end
 
       private
 
-      attr_reader :config
+      attr_reader :config, 
+                  :log
 
       def log_important_config_values
-        log "Photo directory: #{photo_dir}"
-        log "Site directory: #{site_dir}"
-        log "Output directory: #{output_dir}"
+        log.info "Photo directory: #{photo_dir}"
+        log.info "Site directory: #{site_dir}"
+        log.info "Output directory: #{output_dir}"
       end
 
       def log_album_and_photo_names
         collection.albums.each do |album|
-          log album.name
-          log album.photos.map(&:name)
+          log.info album.name
+          log.info album.photos.map(&:name)
         end
       end
 

data/lib/photish/command/host.rb

@@ -1,30 +1,42 @@
 require 'photish/log/logger'
+require 'photish/log/access_log'
 require 'webrick'
 
 module Photish
   module Command
     class Host
-      include ::Photish::Log::Logger
-
       def initialize(runtime_config)
         @config = Photish::Config::AppSettings.new(runtime_config)
                                               .config
+        @log = Logging.logger[self]
       end
 
       def execute
+        Photish::Log::Logger.setup_logging(config)
+
         trap 'INT' do server.shutdown end
-        log "Site will be running at http://0.0.0.0:#{port}/"
+        log.info "Site will be running at http://0.0.0.0:#{port}/"
         server.start
-        log "Site has been shutdown"
+        log.info "Site has been shutdown"
       end
 
       private
 
-      attr_reader :config
+      attr_reader :config,
+                  :log
 
       def server
-        @server ||= WEBrick::HTTPServer.new(Port: port, 
-                                            DocumentRoot: output_dir)
+        @server ||= WEBrick::HTTPServer.new(Port: port,
+                                            DocumentRoot: output_dir,
+                                            AccessLog: access_log,
+                                            Logger: log)
+      end
+
+      def access_log
+        [
+          [Photish::Log::AccessLog.new,
+           WEBrick::AccessLog::COMBINED_LOG_FORMAT]
+        ]
       end
 
       def port

data/lib/photish/command/init.rb

@@ -3,27 +3,35 @@ require 'photish/log/logger'
 module Photish
   module Command
     class Init
-      include ::Photish::Log::Logger
-
       def initialize(runtime_config)
-        @runtime_config = runtime_config
+        @config = Photish::Config::AppSettings.new(runtime_config)
+                                              .config
+        @log = Logging.logger[self]
       end
 
       def execute
+        Photish::Log::Logger.setup_logging(config)
+
         FileUtils.cp_r(config_file, Dir.pwd)
+        FileUtils.cp_r(gitignore_file, File.join(Dir.pwd, '.gitignore'))
         FileUtils.cp_r(photos_dir, Dir.pwd)
         FileUtils.cp_r(site_dir, Dir.pwd)
-        log "Photish site initiated successfully"
+        log.info "Photish site initiated successfully"
       end
 
       private
 
-      attr_reader :runtime_config
+      attr_reader :config,
+                  :log
 
       def config_file
         asset_path('config.yml')
       end
 
+      def gitignore_file
+        asset_path('gitignore')
+      end
+
       def photos_dir
         asset_path('photos')
       end

data/lib/photish/config/default_config.rb

@@ -18,6 +18,11 @@ module Photish
             collection: 'collection.slim',
             album: 'album.slim',
             photo: 'photo.slim'
+          },
+          logging: {
+            colorize: true,
+            output: ['stdout', 'file'],
+            level: 'info'
           }
         }
       end

data/lib/photish/config/file_config.rb

@@ -8,7 +8,8 @@ module Photish
       end
 
       def hash
-        @hash ||= YAML.load_file(config_file_path)
+        return {} if !File.exist?(config_file_path)
+        YAML.load_file(config_file_path)
       end
 
       private

data/lib/photish/config/location.rb

@@ -8,23 +8,13 @@ module Photish
       end
 
       def path
-        ensure_expected_path_exists
-        expected_path
+        File.join(directory, config_file_name)
       end
 
       private
 
       attr_reader :site_dir
 
-      def ensure_expected_path_exists
-        return if File.exist?(expected_path)
-        raise "Config file does not exist at #{expected_path}"
-      end
-
-      def expected_path
-        File.join(directory, config_file_name)
-      end
-
       def directory
         site_dir || Dir.pwd
       end

data/lib/photish/gallery/album.rb

@@ -10,7 +10,6 @@ require 'filemagic'
 module Photish
   module Gallery
     class Album
-
       include ::Photish::Gallery::Traits::Urlable
       include ::Photish::Gallery::Traits::Albumable
       include ::Photish::Gallery::Traits::Metadatable

data/lib/photish/gallery/collection.rb

@@ -6,7 +6,6 @@ require 'photish/gallery/traits/breadcrumbable'
 module Photish
   module Gallery
     class Collection
-
       include ::Photish::Gallery::Traits::Urlable
       include ::Photish::Gallery::Traits::Albumable
       include ::Photish::Gallery::Traits::Metadatable

data/lib/photish/gallery/image.rb

@@ -4,7 +4,6 @@ require 'active_support/core_ext'
 module Photish
   module Gallery
     class Image
-
       include ::Photish::Gallery::Traits::Urlable
 
       delegate :name,

data/lib/photish/gallery/photo.rb

@@ -9,7 +9,6 @@ require 'mini_exiftool'
 module Photish
   module Gallery
     class Photo
-
       include ::Photish::Gallery::Traits::Urlable
       include ::Photish::Gallery::Traits::Metadatable
       include ::Photish::Gallery::Traits::Breadcrumbable

data/lib/photish/log/access_log.rb

@@ -0,0 +1,17 @@
+module Photish
+  module Log
+    class AccessLog
+      def initialize
+        @log = Logging.logger[self]
+      end
+
+      def <<(message)
+        log.info message.chomp
+      end
+
+      private
+
+      attr_reader :log
+    end
+  end
+end

data/lib/photish/log/logger.rb

@@ -1,10 +1,65 @@
-require 'colorize'
+require 'logging'
 
 module Photish
   module Log
     module Logger
-      def log(message)
-        puts "#{Time.now.iso8601.colorize(:blue)} => #{message.to_s.colorize(:green)}"
+      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)
+
+          Logging.logger.root.level = logging_level(config)
+        end
+
+        private
+
+        def logging_level(config)
+          config.val(:logging)[:level].to_sym
+        end
+
+        def colorize?(config)
+          config.val(:logging)[:colorize]
+        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_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
+
+        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
   end

data/lib/photish/render/image_conversion.rb

@@ -3,11 +3,9 @@ require 'mini_magick'
 module Photish
   module Render
     class ImageConversion
-
-      include Photish::Log::Logger
-
       def initialize(output_dir)
         @output_dir = output_dir
+        @log = Logging.logger[self]
       end
 
       def render(images)
@@ -19,14 +17,15 @@ module Photish
             convert << image.path
             convert.merge!(image.quality_params)
             convert << output_file
-            log "Performing image conversion #{convert.command}"
+            log.info "Performing image conversion #{convert.command}"
           end
         end
       end
 
       private
 
-      attr_reader :output_dir
+      attr_reader :output_dir,
+                  :log
     end
   end
 end

data/lib/photish/render/page.rb

@@ -3,13 +3,11 @@ require 'tilt'
 module Photish
   module Render
     class Page
-
-      include Photish::Log::Logger
-
       def initialize(layout_file, template_file, output_dir)
         @layout_file = layout_file
         @template_file = template_file
         @output_dir = output_dir
+        @log = Logging.logger[self]
       end
 
       def render(models)
@@ -18,7 +16,7 @@ module Photish
           output_model_file = relative_to_output_dir(model.url_parts)
           output_model_dir = relative_to_output_dir(model.base_url_parts)
 
-          log "Rendering #{model.url} with template #{template_file} to #{output_model_file}"
+          log.info "Rendering #{model.url} with template #{template_file} to #{output_model_file}"
 
           FileUtils.mkdir_p(output_model_dir)
           File.write(output_model_file, rendered_model)
@@ -29,7 +27,8 @@ module Photish
 
       attr_reader :template_file,
                   :layout_file,
-                  :output_dir
+                  :output_dir,
+                  :log
 
       def relative_to_output_dir(url_parts)
         File.join(output_dir, url_parts)

data/lib/photish/version.rb

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

data/photish.gemspec

@@ -31,8 +31,8 @@ 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_dependency "nokogiri", "~> 1.6"
+  spec.add_dependency "logging", "~> 2.0"
 
   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.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Henry Lawson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2015-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -137,33 +137,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: logging
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -317,6 +317,7 @@ files:
 - exe/photish
 - lib/photish.rb
 - lib/photish/assets/config.yml
+- lib/photish/assets/gitignore
 - lib/photish/assets/photos/Big Dogs/Tired Dogs.jpg
 - lib/photish/assets/photos/Big Dogs/Winking Dog.jpg
 - lib/photish/assets/photos/Small Dogs/Fluffy Dogs/Exhausted Dogs.jpg
@@ -350,6 +351,7 @@ files:
 - lib/photish/gallery/traits/breadcrumbable.rb
 - lib/photish/gallery/traits/metadatable.rb
 - lib/photish/gallery/traits/urlable.rb
+- lib/photish/log/access_log.rb
 - lib/photish/log/logger.rb
 - lib/photish/render/image_conversion.rb
 - lib/photish/render/page.rb