photish 0.3.11 → 0.4.0

data/lib/photish/command/host.rb

@@ -2,8 +2,8 @@ module Photish
   module Command
     class Host < Base
       def run
-        log.info "Site will be running at http://0.0.0.0:#{port}/"
-        log.info "Monitoring paths #{paths_to_monitor}"
+        log.debug "Site will be running at http://0.0.0.0:#{port}/"
+        log.debug "Monitoring paths #{paths_to_monitor}"
 
         regenerate_entire_site
         regenerate_thread
@@ -23,7 +23,7 @@ module Photish
         trap 'INT' do server.shutdown end
         listener.start
         server.start
-        log.info "Photish host has shutdown"
+        log.debug "Photish host has shutdown"
       ensure
         regenerate_thread.exit if @regenerate_thread
         listener.stop if @listener
@@ -62,7 +62,7 @@ module Photish
 
       def handle_change(mod, add, del)
         changes = changes_as_hash(mod, add, del)
-        log.info "File change detected: #{changes}}"
+        log.debug "File change detected: #{changes}}"
         queue.push(changes)
       end
 
@@ -79,19 +79,20 @@ module Photish
 
       def access_log
         [
-          [Photish::Log::AccessLog.new,
+          [Photish::Log::IO.new(log, :debug),
            WEBrick::AccessLog::COMBINED_LOG_FORMAT]
         ]
       end
 
       def regenerate_entire_site
-        log.info "Regenerating site"
+        log.debug "Regenerating site"
         Photish::Command::Generate.new(regenerate_runtime_config)
                                   .execute
       end
 
       def regenerate_runtime_config
-        runtime_config.merge(url: { type: 'absolute_relative' })
+        runtime_config.merge(url: { type: 'absolute_relative' },
+                             soft_failure: true)
       end
 
       def queue

data/lib/photish/command/init.rb

@@ -7,7 +7,7 @@ module Photish
         else
            init_barebones
         end
-        log.info "Photish site initiated successfully"
+        log.debug "Photish site initiated successfully"
       end
 
       private

data/lib/photish/command/worker.rb

@@ -2,12 +2,12 @@ module Photish
   module Command
     class Worker < Base
       def run
-        log.info "Worker ##{worker_index} starting"
+        log.debug "Worker ##{worker_index} starting"
 
         load_all_plugins
         render_whole_site
 
-        log.info "Site generation completed, by Worker ##{worker_index}"
+        log.debug "Site generation completed, by Worker ##{worker_index}"
       end
 
       private
@@ -21,25 +21,13 @@ module Photish
                :image_extensions,
                to: :config
 
-      def load_all_plugins
-        return if Plugin::Repository.instance.loaded?
-        Plugin::Repository.instance.reload(config)
-      end
-
       def render_whole_site
-        Render::SiteWorker.new(config, version_hash)
-                          .all_for(collection)
+        Render::Model.new(config, version_hash)
+                     .all_for(collection)
       end
 
       def collection
-        @collection ||= Gallery::Collection.new(photo_dir,
-                                                qualities_mapped,
-                                                url,
-                                                image_extensions)
-      end
-
-      def qualities_mapped
-        qualities.map { |quality| OpenStruct.new(quality) }
+        @collection ||= Gallery::Collection.new(config)
       end
     end
   end

data/lib/photish/config/default_config.rb

@@ -17,14 +17,16 @@ module Photish
           logging: logging,
           url: url,
           plugins: [],
-          image_extensions: image_extensions
+          image_extensions: image_extensions,
+          page_extension: 'slim',
+          soft_failure: false
         }
       end
 
       private
 
       def image_extensions
-        ImageExtension::IMAGE_MAGICK
+        ['aai', 'art', 'avs', 'bgr', 'bgra', 'bgro', 'bmp', 'bmp2', 'bmp3', 'brf', 'cal', 'cals', 'canvas', 'caption', 'cin', 'cip', 'clip', 'cmyk', 'cmyka', 'cur', 'cut', 'data', 'dcm', 'dcx', 'dds', 'dfont', 'dpx', 'dxt1', 'dxt5', 'eps2', 'eps3', 'fax', 'fits', 'fractal', 'fts', 'g3', 'gif', 'gif87', 'gradient', 'gray', 'group4', 'h', 'hald', 'hdr', 'histogram', 'hrz', 'htm', 'html', 'icb', 'ico', 'icon', 'inline', 'ipl', 'isobrl', 'isobrl6', 'jng', 'jnx', 'jpe', 'jpeg', 'jpg', 'jps', 'label', 'mac', 'magick', 'map', 'mask', 'matte', 'miff', 'mng', 'mono', 'mpc', 'msl', 'mtv', 'mvg', 'null', 'otb', 'otf', 'pal', 'palm', 'pam', 'pango', 'pattern', 'pbm', 'pcd', 'pcds', 'pct', 'pcx', 'pdb', 'pes', 'pfa', 'pfb', 'pfm', 'pgm', 'picon', 'pict', 'pix', 'pjpeg', 'plasma', 'png', 'png00', 'png24', 'png32', 'png48', 'png64', 'png8', 'pnm', 'ppm', 'preview', 'ps2', 'ps3', 'psb', 'psd', 'ptif', 'pwp', 'radial-gradient', 'ras', 'rgb', 'rgba', 'rgbo', 'rgf', 'rla', 'rle', 'scr', 'sct', 'sfw', 'sgi', 'shtml', 'six', 'sixel', 'sparse-color', 'stegano', 'sun', 'text', 'tga', 'thumbnail', 'tiff', 'tiff64', 'tile', 'tim', 'ttc', 'ttf', 'ubrl', 'ubrl6', 'uil', 'uyvy', 'vda', 'vicar', 'vid', 'viff', 'vips', 'vst', 'wbmp', 'wpg', 'xbm', 'xc', 'xcf', 'xpm', 'xv', 'ycbcr', 'ycbcra', 'yuv']
       end
 
       def url
@@ -39,7 +41,7 @@ module Photish
         {
           colorize: true,
           output: ['stdout', 'file'],
-          level: 'info'
+          level: 'debug'
         }
       end
 

data/lib/photish/config/file_config.rb

@@ -1,18 +1,32 @@
 module Photish
   module Config
     class FileConfig
-      def initialize(config_file_path)
-        @config_file_path = config_file_path
+      FILE_NAME = 'config.yml'
+
+      def initialize(config_dir)
+        @config_dir = config_dir
       end
 
       def hash
-        return {} if !File.exist?(config_file_path)
-        YAML.load_file(config_file_path)
+        return {} if !File.exist?(path)
+        YAML.load_file(path)
+      end
+
+      def path
+        File.join(directory, config_file_name)
       end
 
       private
 
-      attr_reader :config_file_path
+      attr_reader :config_dir
+
+      def directory
+        config_dir || Dir.pwd
+      end
+
+      def config_file_name
+        FILE_NAME
+      end
     end
   end
 end

data/lib/photish/config/settings.rb

@@ -0,0 +1,59 @@
+module Photish
+  module Config
+    class Settings
+      def initialize(runtime_config)
+        @runtime_config = extract_config(runtime_config)
+      end
+
+      def config
+        @config ||= RecursiveOpenStruct.new(prioritized_config)
+      end
+
+      def version_hash
+        @version_hash ||= Digest::MD5.hexdigest(sensitive_config.to_json)
+      end
+
+      private
+
+      attr_reader :runtime_config
+
+      def extract_config(hash)
+        {}.deep_merge(hash)
+          .deep_merge(JSON.parse(hash.fetch('config_override', '{}')))
+          .deep_symbolize_keys
+      end
+
+      def prioritized_config
+        @prioritized_config = {}.deep_merge(default_config)
+                                .deep_merge(file_config)
+                                .deep_merge(runtime_config)
+                                .deep_merge(derived_config)
+      end
+
+      def sensitive_config
+        prioritized_config.slice(:qualities)
+      end
+
+      def derived_config
+        {
+          config_file_location: file_config_instance.path
+        }
+      end
+
+      def file_config
+        file_config_instance.hash
+                            .deep_symbolize_keys
+      end
+
+      def default_config
+        DefaultConfig.new
+                     .hash
+                     .deep_symbolize_keys
+      end
+
+      def file_config_instance
+        @file_config_instance ||= FileConfig.new(runtime_config[:config_dir])
+      end
+    end
+  end
+end

data/lib/photish/gallery/album.rb

@@ -3,13 +3,15 @@ module Photish
     class Album
       include Traits::Urlable
       include Traits::Albumable
-      include Traits::Metadatable
-      include Photish::Plugin::Pluginable
+      include Traits::Fileable
+      include Plugin::Pluginable
 
       delegate :qualities,
                :image_extensions,
+               :page_extension,
                :url_info,
-               to: :parent, allow_nil: true
+               to: :parent,
+               allow_nil: true
 
       def initialize(parent, path)
         super
@@ -18,20 +20,21 @@ module Photish
       end
 
       def name
-        @name ||= File.basename(path)
+        @name ||= basename
       end
 
       def photos
-        @photos ||= Dir.entries(path)
-                       .reject { |file| ['.', '..'].include?(file) }
-                       .map    { |file| File.join(path, file) }
-                       .reject { |file| !File.file?(file) ||
-                                          !image_format?(file) }
-                       .map    { |file| Photo.new(self, file) }
+        @photos ||= child_files.select { |file| image?(file)   }
+                               .map    { |file| Photo.new(self, file) }
+      end
+
+      def pages
+        @pages ||=  child_files.select { |file| page?(file)   }
+                               .map    { |file| Page.new(self, file) }
       end
 
       def plugin_type
-        Photish::Plugin::Type::Album
+        Plugin::Type::Album
       end
 
       private
@@ -41,9 +44,19 @@ module Photish
 
       alias_method :base_url_name, :name
 
-      def image_format?(file)
-        extension = File.extname(file).split('.').last.try(:downcase)
-        image_extensions.include?(extension)
+      def child_files
+        @child_files ||= Dir.entries(path)
+                            .reject { |file| ['.', '..'].include?(file) }
+                            .map    { |file| File.join(path, file)      }
+                            .select { |file| File.file?(file)           }
+      end
+
+      def image?(file)
+        image_extensions.include?(extension_of(file))
+      end
+
+      def page?(file)
+        page_extension == extension_of(file)
       end
 
       def album_class

data/lib/photish/gallery/collection.rb

@@ -3,19 +3,18 @@ module Photish
     class Collection
       include Traits::Urlable
       include Traits::Albumable
-      include Traits::Metadatable
-      include Photish::Plugin::Pluginable
+      include Traits::Fileable
+      include Plugin::Pluginable
 
-      attr_reader :qualities,
-                  :url_info,
-                  :image_extensions
+      delegate :page_extension,
+               :photo_dir,
+               to: :config
 
-      def initialize(path, qualities, url_info, image_extensions)
+      alias_method :path, :photo_dir
+
+      def initialize(config)
         super
-        @path = path
-        @qualities = qualities
-        @url_info = url_info
-        @image_extensions = Set.new(image_extensions)
+        @config = config
       end
 
       def name
@@ -27,19 +26,34 @@ module Photish
       end
 
       def plugin_type
-        Photish::Plugin::Type::Collection
+        Plugin::Type::Collection
       end
 
       def all_url_parts
         @all_url_parts ||= [[url_parts],
                             all_albums.map(&:url_parts),
                             all_photos.map(&:url_parts),
-                            all_images.map(&:url_parts)].flatten(1)
+                            all_images.map(&:url_parts),
+                            all_pages.map(&:url_parts),
+                           ].flatten(1)
+      end
+
+      def image_extensions
+        @image_extensions ||= Set.new(config.image_extensions)
+      end
+
+      def qualities
+        @qualities ||= config.qualities
+                             .map { |quality| OpenStruct.new(quality) }
+      end
+
+      def url_info
+        config.url
       end
 
       private
 
-      attr_reader :path
+      attr_reader :config
 
       def album_class
         Album

data/lib/photish/gallery/image.rb

@@ -2,7 +2,8 @@ module Photish
   module Gallery
     class Image
       include Traits::Urlable
-      include Photish::Plugin::Pluginable
+      include Traits::Fileable
+      include Plugin::Pluginable
 
       delegate :name,
                :params,
@@ -21,11 +22,11 @@ module Photish
       end
 
       def name
-        @name ||= "#{basename} #{quality_name}"
+        @name ||= "#{basename_without_extension} #{quality_name}"
       end
 
       def plugin_type
-        Photish::Plugin::Type::Image
+        Plugin::Type::Image
       end
 
       private
@@ -36,15 +37,7 @@ module Photish
       alias_method :base_url_name, :name
 
       def url_end
-        @url_end ||= "#{slugify(basename)}-#{slugify(quality_name)}#{extension}"
-      end
-
-      def basename
-        @basename ||= File.basename(path, '.*')
-      end
-
-      def extension
-        @extentsion ||= File.extname(path)
+        @url_end ||= slugify("#{basename_without_extension}-#{quality_name}.#{extension}")
       end
 
       def base_url_name

data/lib/photish/gallery/page.rb

@@ -0,0 +1,40 @@
+module Photish
+  module Gallery
+    class Page
+      include Traits::Urlable
+      include Traits::Albumable
+      include Traits::Fileable
+      include Plugin::Pluginable
+
+      attr_reader :path
+
+      delegate :url_info,
+               to: :parent,
+               allow_nil: true
+
+      def initialize(parent, path)
+        super
+        @parent = parent
+        @path = path
+      end
+
+      def name
+        @name ||= basename_without_extension
+      end
+
+      def plugin_type
+        Plugin::Type::Page
+      end
+
+      private
+
+      attr_reader :parent
+
+      alias_method :base_url_name, :name
+
+      def url_end
+        'index.html'
+      end
+    end
+  end
+end

data/lib/photish/gallery/photo.rb

@@ -2,12 +2,13 @@ module Photish
   module Gallery
     class Photo
       include Traits::Urlable
-      include Traits::Metadatable
-      include Photish::Plugin::Pluginable
+      include Traits::Fileable
+      include Plugin::Pluginable
 
       delegate :qualities,
                :url_info,
-               to: :parent, allow_nil: true
+               to: :parent,
+               allow_nil: true
 
       def initialize(parent, path)
         super
@@ -16,19 +17,15 @@ module Photish
       end
 
       def name
-        @name ||= File.basename(path, '.*')
+        @name ||= basename_without_extension
       end
 
       def images
-        @images ||= qualities.map { |quality| Photish::Gallery::Image.new(self, path, quality) }
-      end
-
-      def exif
-        @exif ||= MiniExiftool.new(path)
+        @images ||= qualities.map { |quality| Image.new(self, path, quality) }
       end
 
       def plugin_type
-        Photish::Plugin::Type::Photo
+        Plugin::Type::Photo
       end
 
       private

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

@@ -4,9 +4,9 @@ module Photish
       module Albumable
         def albums
           @albums ||= Dir.entries(path)
-                         .reject { |file| ['.', '..'].include?(file) }
-                         .map    { |file| File.join(path, file) }
-                         .reject { |file| !Dir.exist?(file) }
+                         .reject { |file| ['.', '..'].include?(file)  }
+                         .map    { |file| File.join(path, file)       }
+                         .reject { |file| !Dir.exist?(file)           }
                          .map    { |file| album_class.new(self, file) }
         end
 
@@ -21,6 +21,12 @@ module Photish
                                     .flatten
         end
 
+        def all_pages
+          @all_pages ||= all_albums.map(&:pages)
+                                    .concat(self.try(:pages) || [])
+                                    .flatten
+        end
+
         def all_images
           @all_images ||= all_photos.map(&:images)
                                     .flatten

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

@@ -0,0 +1,30 @@
+module Photish
+  module Gallery
+    module Traits
+      module Fileable
+        def extension_of(file)
+          File.extname(file)
+              .split('.')
+              .last
+              .try(:downcase)
+        end
+
+        def extension
+          extension_of(path)
+        end
+
+        def dirname
+          File.dirname(path)
+        end
+
+        def basename
+          File.basename(path)
+        end
+
+        def basename_without_extension
+          File.basename(path, '.*')
+        end
+      end
+    end
+  end
+end

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

@@ -15,21 +15,26 @@ module Photish
         end
 
         def base_url_parts
-          @base_url_parts ||= parent.base_url_parts + [slugify(base_url_name)]
+          @base_url_parts ||= (parent.base_url_parts +
+                               [slugify(base_url_name)]).compact
         end
 
         def host
-          @host ||= if url_info.type == 'absolute_uri'
-                      url_info.host || ''
-                    else
-                      ''
-                    end
+          @host ||= absolute_uris? ? url_info_host : ''
         end
 
         private
 
         def slugify(word)
-          CGI.escape(word.downcase.gsub(' ', '-'))
+          CGI.escape(word.downcase.gsub(' ', '-')) if word
+        end
+
+        def absolute_uris?
+          url_info.type == 'absolute_uri'
+        end
+
+        def url_info_host
+          url_info.host || ''
         end
       end
     end

data/lib/photish/log/io.rb

@@ -0,0 +1,20 @@
+module Photish
+  module Log
+    class IO
+      def initialize(log, level)
+        @log = log
+        @level = level
+      end
+
+      def write(message)
+        log.send(level, message.chomp)
+      end
+      alias_method :<<, :write
+
+      private
+
+      attr_reader :log,
+                  :level
+    end
+  end
+end

data/lib/photish/log/loggable.rb

@@ -2,7 +2,7 @@ module Photish
   module Log
     module Loggable
       def log
-        @log ||= LogSetup.instance.new_logger(self.class.name)
+        @log ||= Setup.instance.new_logger(self.class.name)
       end
     end
   end

data/lib/photish/log/{log_setup.rb → setup.rb}

@@ -1,6 +1,6 @@
 module Photish
   module Log
-    class LogSetup
+    class Setup
       LEVEL = {
         debug: Logger::DEBUG,
         info:  Logger::INFO,

data/lib/photish/{gallery/traits/breadcrumbable.rb → plugin/core/breadcrumb.rb}

@@ -1,7 +1,16 @@
 module Photish
-  module Gallery
-    module Traits
-      module Breadcrumbable
+  module Plugin
+    module Core
+      module Breadcrumb
+        def self.is_for?(type)
+          [
+            Photish::Plugin::Type::Collection,
+            Photish::Plugin::Type::Album,
+            Photish::Plugin::Type::Photo,
+            Photish::Plugin::Type::Page,
+          ].include?(type)
+        end
+
         def breadcrumbs
           html = "<ul class=\"breadcrumbs\">"
           parents_and_me.each_with_index do |level, index|

data/lib/photish/plugin/core/build_url.rb

@@ -0,0 +1,26 @@
+module Photish
+  module Plugin
+    module Core
+      module BuildUrl
+        def self.is_for?(type)
+          [
+            Photish::Plugin::Type::Collection,
+            Photish::Plugin::Type::Album,
+            Photish::Plugin::Type::Photo,
+            Photish::Plugin::Type::Page,
+          ].include?(type)
+        end
+
+        def build_url(*pieces)
+          url_pieces = []
+          url_pieces << host
+          url_pieces << url_info.base
+          url_pieces << pieces
+          url_pieces.flatten
+                    .compact
+                    .join('/')
+        end
+      end
+    end
+  end
+end