photish 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 065983f865e77de75e2248edfe93374ec4d1fe10
-  data.tar.gz: 07eeac3a6faf3131980227b61cc2fcb4ccdfc690
+  metadata.gz: 1d2196afefb3930e090519fd81435fbba5c8347c
+  data.tar.gz: 5b2213f00cf0521772295fb2e21f84e764cfdbb1
 SHA512:
-  metadata.gz: 8ca0b8fe9f7c0ab35bd28c369fbfc53fcf269e2107a39bfc9649270304bbb2984de91a31e60c9289312af4710f9b3491fced3bcb2a5f6e85c774ec60a63214e4
-  data.tar.gz: 78e3cb4c65245c584a76a63d82bd8a8730ec62747a0084dc9667fd069d18019fd6432d2fa7195dc949abe101134762ad0aa66e810a27b2025e5ffb90a50c4c1f
+  metadata.gz: 3db008201ee711a28556bbd0c5b7d65f1e6dca3a6a0c775518c88e61881fd885f55ad11cfee2ab4b208144f4346dd92e6759bfd0f90f8146dc0c1ab4d079d5e0
+  data.tar.gz: 732b2b201fabfc21593277d1c633bc8a54d4d464d658085871a626e12b5fe02f627f3de53082fd86374723a8620736ca2b32e18d551d8d0d2874d8a766bb1d22

data/README.md

@@ -216,6 +216,7 @@ File or Folder                    | Purpose
 --------------------------------- | -------
 `photos`                          | folder, for your photo collection and metadata
 `site`                            | folder for your templates, assets and static pages
+`site/_plugins`                   | folder for plugins to be loaded from
 `site/_templates`                 | folder for your templates
 `site/_templates/layout.slim`     | file for the basic layout for all pages
 `site/_templates/collection.slim` | template file for your collection page
@@ -278,6 +279,9 @@ logging:
   colorize: true
   level: 'info'
   output: ['stdout', 'file']
+url:
+  host: http://mydomain.com
+  base: 'subdirectory'
 ```
 
 The meanings and purpose of each field is defined below:
@@ -297,6 +301,9 @@ Field                  | Purpose
 `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`
+`url`                  | a listing of the various url options
+`url/host`             | default is to leave this configuration blank, however if you would like URLs generated with a specific host prefix, you can define it here
+`url/base`             | default is to leave this configuration blank, if your website will be hosted in a sub folder and will not be accessible at the root of the host, you can specify the sub folder(s) here, this will also mean your website will be hosted in a sub folder when ran using `photish host`
 
 #### Customizing Templates
 
@@ -521,6 +528,15 @@ If the above code is saved to `site/_plugins/shout.rb` Photish will detect the
 plugin ruby file at runtime and it will load and make the method available in
 the template.
 
+A Template Helper Plugin `self.is_for?(type)` method could potentially receive
+any of the below types, simply return true for the types the Template Helper
+Plugin supports:
+
+1. `Photish::Plugin::Type::Collection`
+1. `Photish::Plugin::Type::Album`
+1. `Photish::Plugin::Type::Photo`
+1. `Photish::Plugin::Type::Image`
+
 A usage example is below
 
 **site/_templates/photo.slim**

data/TODO.md

@@ -15,3 +15,5 @@
 1. Share on RubyWebToolkit, StaticGen, etc
 1. RDoc documentation for classes
 1. More intelligent regeneration based on changes
+1. Change `init` to have `--example` and normal for barebones
+1. Add `Gemfile` to `init`

data/exe/photish

@@ -8,5 +8,5 @@ if ENV['COVERAGE']
   SimpleCov.start CodeClimate::TestReporter.configuration.profile
 end
 
-require 'photish/cli/interface'
+require 'photish'
 Photish::CLI::Interface.start

data/lib/photish/assets/site/_plugins/tmpdir_deploy.rb

@@ -0,0 +1,30 @@
+class Photish::Plugin::TmpdirDeploy
+
+  def initialize(config, log)
+    @config = config
+    @log = log
+  end
+
+  def deploy
+    tmpdir = Dir.mktmpdir
+    FileUtils.cp_r(config.output_dir, tmpdir)
+
+    log.info "Static site deployed to directory: #{tmpdir}"
+    log.info "Deployment to tmpdir successful"
+  end
+
+  private
+
+  attr_reader :config,
+              :log
+
+  def self.is_for?(type)
+    [
+      Photish::Plugin::Type::Deploy
+    ].include?(type)
+  end
+
+  def self.engine_name
+    'tmpdir'
+  end
+end

data/lib/photish/cli/interface.rb

@@ -1,8 +1,3 @@
-require 'thor'
-require 'photish/command/generate'
-require 'photish/command/host'
-require 'photish/command/init'
-
 module Photish
   module CLI
     class Interface < Thor
@@ -22,6 +17,12 @@ module Photish
       def init
         Photish::Command::Init.new(options).execute
       end
+
+      desc "deploy", "Deploys the static site, using the specified engine"
+      method_option :engine, required: true
+      def deploy
+        Photish::Command::Deploy.new(options).execute
+      end
     end
   end
 end

data/lib/photish/command/base.rb

@@ -0,0 +1,36 @@
+module Photish
+  module Command
+    class Base
+      def initialize(runtime_config)
+        @runtime_config = runtime_config
+        @log = Logging.logger[self]
+      end
+
+      def execute
+        setup_logging
+        begin
+          run
+        rescue => e
+          log.fatal "An exception occured #{e.class} \"#{e.message}\" #{e.backtrace.join("\n")}"
+          false
+        end
+      end
+
+      protected
+
+      attr_reader :runtime_config,
+                  :log
+
+      def config
+        @config ||= Photish::Config::AppSettings.new(runtime_config)
+                                                .config
+      end
+
+      private
+
+      def setup_logging
+        Photish::Log::Logger.instance.setup_logging(config)
+      end
+    end
+  end
+end

data/lib/photish/command/deploy.rb

@@ -0,0 +1,44 @@
+module Photish
+  module Command
+    class Deploy < Base
+      def run
+        load_all_plugins
+        log.info "Requested engine: #{engine}"
+
+        return no_engine_found unless engine
+
+        log.info "Deploying with engine #{engine_class}"
+        engine_class.new(config, log).deploy
+      end
+
+      private
+
+      delegate :engine,
+               :site_dir,
+               to: :config
+
+
+      def no_engine_found
+        log.info "No engine found..."
+      end
+
+      def load_all_plugins
+        Photish::Plugin::Repository.reload(log, site_dir)
+      end
+
+      def engine_class
+        @engine ||= deploy_plugins.find do |p|
+          p.engine_name == engine
+        end
+      end
+
+      def deploy_plugins
+        Photish::Plugin::Repository.plugins_for(deploy_plugin_type)
+      end
+
+      def deploy_plugin_type
+        Photish::Plugin::Type::Deploy
+      end
+    end
+  end
+end

data/lib/photish/command/generate.rb

@@ -1,19 +1,7 @@
-require 'photish/log/logger'
-require 'photish/config/app_settings'
-require 'photish/gallery/collection'
-require 'photish/render/site'
-
 module Photish
   module Command
-    class Generate
-      def initialize(runtime_config)
-        @runtime_config = runtime_config
-        @log = Logging.logger[self]
-      end
-
-      def execute
-        Photish::Log::Logger.instance.setup_logging(config)
-
+    class Generate < Base
+      def run
         log_important_config_values
         load_all_plugins
         log_album_and_photo_names
@@ -23,22 +11,16 @@ module Photish
 
       private
 
-      attr_reader :runtime_config,
-                  :log
+      delegate :output_dir,
+               :site_dir,
+               :photo_dir,
+               :qualities,
+               :templates,
+               :url,
+               to: :config
 
       def load_all_plugins
-        Dir[File.join(site_dir, '_plugins', '*.rb')].each do |file|
-          require file
-        end
-
-        Photish::Plugin::Repository.all_plugins.each do |plugin|
-          log.info "Found plugin #{plugin}"
-        end
-      end
-
-      def config
-        @config ||= Photish::Config::AppSettings.new(runtime_config)
-                                                .config
+        Photish::Plugin::Repository.reload(log, site_dir)
       end
 
       def log_important_config_values
@@ -61,29 +43,14 @@ module Photish
                              .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) }
+        @collection ||= Gallery::Collection.new(photo_dir,
+                                                qualities_mapped,
+                                                url)
       end
 
-      def templates
-        OpenStruct.new(config.val(:templates))
+      def qualities_mapped
+        qualities.map { |quality| OpenStruct.new(quality) }
       end
     end
   end

data/lib/photish/command/host.rb

@@ -1,17 +1,7 @@
-require 'photish/log/logger'
-require 'photish/log/access_log'
-require 'webrick'
-require 'listen'
-
 module Photish
   module Command
-    class Host
-      def initialize(runtime_config)
-        @runtime_config = runtime_config
-        @log = Logging.logger[self]
-      end
-
-      def execute
+    class Host < Base
+      def run
         Photish::Log::Logger.instance.setup_logging(config)
 
         log.info "Site will be running at http://0.0.0.0:#{port}/"
@@ -23,8 +13,11 @@ module Photish
 
       private
 
-      attr_reader :runtime_config,
-                  :log
+      delegate :port,
+               :output_dir,
+               :site_dir,
+               :photo_dir,
+               to: :config
 
       def start_http_server_with_listener
         trap 'INT' do server.shutdown end
@@ -34,11 +27,6 @@ module Photish
         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,
@@ -58,7 +46,7 @@ module Photish
 
       def paths_to_monitor
         [site_dir,
-         photos_dir]
+         photo_dir]
       end
 
       def access_log
@@ -73,22 +61,6 @@ module Photish
         Photish::Command::Generate.new(runtime_config)
                                    .execute
       end
-
-      def port
-        config.val(:port)
-      end
-
-      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

@@ -1,33 +1,16 @@
-require 'photish/log/logger'
-
 module Photish
   module Command
-    class Init
-      def initialize(runtime_config)
-        @runtime_config = runtime_config
-        @log = Logging.logger[self]
-      end
-
-      def execute
-        Photish::Log::Logger.instance.setup_logging(config)
-
+    class Init < Base
+      def run
         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(photo_dir, Dir.pwd)
         FileUtils.cp_r(site_dir, Dir.pwd)
         log.info "Photish site initiated successfully"
       end
 
       private
 
-      attr_reader :runtime_config,
-                  :log
-
-      def config
-        @config ||= Photish::Config::AppSettings.new(runtime_config)
-                                                .config
-      end
-
       def config_file
         asset_path('config.yml')
       end
@@ -36,7 +19,7 @@ module Photish
         asset_path('gitignore')
       end
 
-      def photos_dir
+      def photo_dir
         asset_path('photos')
       end
 

data/lib/photish/config/app_settings.rb

@@ -1,31 +1,41 @@
-require 'photish/config/settings'
-require 'photish/config/location'
-
 module Photish
   module Config
     class AppSettings
       def initialize(runtime_config)
-        @runtime_config = runtime_config
+        @runtime_config = symbolize(runtime_config)
       end
 
       def config
-        @config ||= Config::Settings
-          .new(default_config)
-          .override(file_config)
-          .override(runtime_config)
+        @config ||= RecursiveOpenStruct.new(prioritized_config)
       end
 
       private
 
       attr_reader :runtime_config
 
+      def prioritized_config
+        {}.merge(default_config)
+          .merge(file_config)
+          .merge(runtime_config)
+      end
+
       def file_config
-        config_location = Config::Location.new(runtime_config[:site_dir])
-        Config::FileConfig.new(config_location.path).hash
+        symbolize(FileConfig.new(file_config_location)
+                                            .hash)
       end
 
       def default_config
-        Config::DefaultConfig.new.hash
+        symbolize(DefaultConfig.new.hash)
+      end
+
+      def file_config_location
+        FileConfigLocation.new(runtime_config[:site_dir])
+                        .path
+      end
+
+      def symbolize(hash)
+        (hash || {})
+          .deep_symbolize_keys
       end
     end
   end

data/lib/photish/config/default_config.rb

@@ -23,6 +23,10 @@ module Photish
             colorize: true,
             output: ['stdout', 'file'],
             level: 'info'
+          },
+          url: {
+            host: '/',
+            base: nil
           }
         }
       end

data/lib/photish/config/file_config.rb

@@ -1,5 +1,3 @@
-require 'yaml'
-
 module Photish
   module Config
     class FileConfig

data/lib/photish/config/{location.rb → file_config_location.rb}

@@ -1,6 +1,6 @@
 module Photish
   module Config
-    class Location
+    class FileConfigLocation
       FILE_NAME = 'config.yml'
 
       def initialize(site_dir)

data/lib/photish/gallery/album.rb

@@ -1,13 +1,3 @@
-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 'photish/plugin/pluginable'
-require 'active_support'
-require 'active_support/core_ext'
-require 'filemagic'
-
 module Photish
   module Gallery
     class Album
@@ -17,7 +7,9 @@ module Photish
       include Photish::Gallery::Traits::Breadcrumbable
       include Photish::Plugin::Pluginable
 
-      delegate :qualities, to: :parent, allow_nil: true
+      delegate :qualities,
+               :url_info,
+               to: :parent, allow_nil: true
 
       def initialize(parent, path)
         super

data/lib/photish/gallery/collection.rb

@@ -1,9 +1,3 @@
-require 'photish/gallery/album'
-require 'photish/gallery/traits/albumable'
-require 'photish/gallery/traits/metadatable'
-require 'photish/gallery/traits/breadcrumbable'
-require 'photish/plugin/pluginable'
-
 module Photish
   module Gallery
     class Collection
@@ -13,12 +7,14 @@ module Photish
       include Photish::Gallery::Traits::Breadcrumbable
       include Photish::Plugin::Pluginable
 
-      attr_reader :qualities
+      attr_reader :qualities,
+                  :url_info
 
-      def initialize(path, qualities)
+      def initialize(path, qualities, url_info)
         super
         @path = path
         @qualities = qualities
+        @url_info = url_info
       end
 
       def name
@@ -26,7 +22,7 @@ module Photish
       end
 
       def base_url_parts
-        []
+        [url_info.base].flatten.compact
       end
 
       def plugin_type

data/lib/photish/gallery/image.rb

@@ -1,7 +1,3 @@
-require 'active_support'
-require 'active_support/core_ext'
-require 'photish/plugin/pluginable'
-
 module Photish
   module Gallery
     class Image
@@ -12,6 +8,9 @@ module Photish
                :params,
                to: :quality, prefix: true, allow_nil: true
 
+      delegate :url_info,
+               to: :parent, allow_nil: true
+
       attr_reader :path
 
       def initialize(parent, path, quality)

data/lib/photish/gallery/photo.rb

@@ -1,12 +1,3 @@
-require 'photish/gallery/traits/urlable'
-require 'photish/gallery/traits/metadatable'
-require 'photish/gallery/traits/breadcrumbable'
-require 'photish/gallery/image'
-require 'photish/plugin/pluginable'
-require 'active_support'
-require 'active_support/core_ext'
-require 'mini_exiftool'
-
 module Photish
   module Gallery
     class Photo
@@ -15,7 +6,9 @@ module Photish
       include Photish::Gallery::Traits::Breadcrumbable
       include Photish::Plugin::Pluginable
 
-      delegate :qualities, to: :parent, allow_nil: true
+      delegate :qualities,
+               :url_info,
+               to: :parent, allow_nil: true
 
       def initialize(parent, path)
         super

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

@@ -1,5 +1,3 @@
-require 'nokogiri'
-
 module Photish
   module Gallery
     module Traits

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

@@ -1,6 +1,3 @@
-require 'yaml'
-require 'recursive_open_struct'
-
 module Photish
   module Gallery
     module Traits

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

@@ -1,11 +1,9 @@
-require 'cgi'
-
 module Photish
   module Gallery
     module Traits
       module Urlable
         def url
-          '/' + url_parts.join('/')
+          [host, url_parts].flatten.join('/')
         end
 
         def url_parts
@@ -18,6 +16,14 @@ module Photish
 
         private
 
+        def host
+          normalized_host || ''
+        end
+
+        def normalized_host
+          url_info.host.try(:chomp, '/')
+        end
+
         def slugify(word)
           CGI.escape(word.downcase.gsub(' ', '-'))
         end

data/lib/photish/log/logger.rb

@@ -1,5 +1,3 @@
-require 'logging'
-
 module Photish
   module Log
     class Logger
@@ -24,19 +22,19 @@ module Photish
       private
 
       def logging_level(config)
-        config.val(:logging)[:level].to_sym
+        config.logging.level.to_sym
       end
 
       def colorize?(config)
-        config.val(:logging)[:colorize]
+        config.logging.colorize
       end
 
       def output_to_stdout?(config)
-        config.val(:logging)[:output].include?('stdout')
+        config.logging.output.include?('stdout')
       end
 
       def output_to_file?(config)
-        config.val(:logging)[:output].include?('file')
+        config.logging.output.include?('file')
       end
 
       def setup_color_scheme

data/lib/photish/plugin/pluginable.rb

@@ -1,6 +1,3 @@
-require 'photish/plugin/type'
-require 'photish/plugin/repository'
-
 module Photish
   module Plugin
     module Pluginable

data/lib/photish/plugin/repository.rb

@@ -1,8 +1,18 @@
-
 module Photish
   module Plugin
     module Repository
       class << self
+        def reload(log, site_dir)
+          log.info "Loading plugins..."
+          Dir[File.join(site_dir, '_plugins', '*.rb')].each do |file|
+            load file
+          end
+
+          all_plugins.each do |plugin|
+            log.info "Found plugin #{plugin}"
+          end
+        end
+
         def plugins_for(type)
           all_plugins.reject { |m| !m.is_for?(type) }
         end

data/lib/photish/plugin/type.rb

@@ -2,9 +2,10 @@ module Photish
   module Plugin
     module Type
       module Collection; end
-      module Album; end
-      module Photo; end
-      module Image; end
+      module Album;      end
+      module Photo;      end
+      module Image;      end
+      module Deploy;     end
     end
   end
 end

data/lib/photish/rake/task.rb

@@ -1,6 +1,3 @@
-require 'photish/cli/interface'
-require 'rake'
-
 module Photish
   module Rake
     class Task

data/lib/photish/render/image_conversion.rb

@@ -1,5 +1,3 @@
-require 'mini_magick'
-
 module Photish
   module Render
     class ImageConversion

data/lib/photish/render/page.rb

@@ -1,5 +1,3 @@
-require 'tilt'
-
 module Photish
   module Render
     class Page

data/lib/photish/render/site.rb

@@ -1,6 +1,3 @@
-require 'photish/render/page'
-require 'photish/render/image_conversion'
-
 module Photish
   module Render
     class Site

data/lib/photish/version.rb

@@ -1,3 +1,3 @@
 module Photish
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/photish.rb

@@ -1,4 +1,50 @@
-require "photish/version"
+# 3rd Party
+require 'mini_magick'
+require 'logging'
+require 'tilt'
+require 'rake'
+require 'active_support'
+require 'active_support/core_ext'
+require 'mini_exiftool'
+require 'webrick'
+require 'listen'
+require 'yaml'
+require 'thor'
+require 'filemagic'
+require 'recursive_open_struct'
+require 'cgi'
+
+# Photish
+require 'photish/plugin/type'
+require 'photish/plugin/pluginable'
+require 'photish/plugin/repository'
+require 'photish/command/base'
+require 'photish/command/generate'
+require 'photish/command/host'
+require 'photish/command/init'
+require 'photish/command/deploy'
+require 'photish/cli/interface'
+require 'photish/log/logger'
+require 'photish/log/logger'
+require 'photish/log/access_log'
+require 'photish/log/logger'
+require 'photish/config/default_config'
+require 'photish/config/file_config'
+require 'photish/config/file_config_location'
+require 'photish/config/app_settings'
+require 'photish/gallery/traits/urlable'
+require 'photish/gallery/traits/albumable'
+require 'photish/gallery/traits/metadatable'
+require 'photish/gallery/traits/breadcrumbable'
+require 'photish/gallery/photo'
+require 'photish/gallery/album'
+require 'photish/gallery/image'
+require 'photish/gallery/collection'
+require 'photish/render/page'
+require 'photish/render/site'
+require 'photish/render/image_conversion'
+require 'photish/rake/task'
+require 'photish/version'
 
 module Photish
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: photish
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Henry Lawson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-28 00:00:00.000000000 Z
+date: 2015-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -328,6 +328,7 @@ files:
 - lib/photish/assets/photos/Small Dogs/Sleepy Dog.yml
 - lib/photish/assets/photos/Small Dogs/Squishy Dogs/Big Ear Dog.jpg
 - lib/photish/assets/site/_plugins/footer_links.rb
+- lib/photish/assets/site/_plugins/tmpdir_deploy.rb
 - lib/photish/assets/site/_plugins/yell_loud.rb
 - lib/photish/assets/site/_templates/album.slim
 - lib/photish/assets/site/_templates/collection.slim
@@ -337,14 +338,15 @@ files:
 - lib/photish/assets/site/images/crumbs.gif
 - lib/photish/assets/site/styles/basic.css
 - lib/photish/cli/interface.rb
+- lib/photish/command/base.rb
+- lib/photish/command/deploy.rb
 - lib/photish/command/generate.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
-- lib/photish/config/location.rb
-- lib/photish/config/settings.rb
+- lib/photish/config/file_config_location.rb
 - lib/photish/gallery/album.rb
 - lib/photish/gallery/collection.rb
 - lib/photish/gallery/image.rb

data/lib/photish/config/settings.rb

@@ -1,34 +0,0 @@
-require 'yaml'
-require 'active_support'
-require 'active_support/core_ext'
-require 'photish/config/default_config'
-require 'photish/config/file_config'
-
-module Photish
-  module Config
-    class Settings
-      def initialize(config = nil)
-        @config = compact_symbolize(config)
-      end
-
-      def val(key)
-        config[key.to_sym]
-      end
-
-      def override(hash)
-        cleaned_hash = compact_symbolize(hash)
-        self.class.new(config.merge(cleaned_hash))
-      end
-
-      private
-
-      attr_reader :config
-
-      def compact_symbolize(hash)
-        (hash || {})
-          .compact
-          .deep_symbolize_keys
-      end
-    end
-  end
-end