gallerize-cli 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b51bfcfc0d4acd441ddc56c58903df3f57cc28b2
-  data.tar.gz: 8c433292f6b43525884823a02ee1dcb16a19ed09
+  metadata.gz: fc69d889c2a6a376cc872a33e4b6bd60637a49a7
+  data.tar.gz: b3d1c67446924666c5d0bafe39e52dbadc04f08a
 SHA512:
-  metadata.gz: 63b1c6a27417b1527b9e94b8e6101cb7107cbff9b9e3ed160b286890f15fd1c95e75c89783d07f35bc8768801d3852fcaf0f8e5df4a7f75f01890950398b4016
-  data.tar.gz: 19561f6e1deb571d0e742b021f2f2f77ad17d8144bf2676def3db701effd9cda00d7b7cc0d9193ae60c3f3b788e984eb942c96922ac5c481190b05104ec70692
+  metadata.gz: e9f3ee1e12f19706935e26052da9d640e479864154d6957547975c20f7d97082e3f0c847a62be699e04860ee22f141875ee73e35dd06cf53d26f2d07721efdbb
+  data.tar.gz: 805f18c473d8c70de3c8053729581a153d9ae347d8fe33d2cde9f22f095443c5ae2452460afb6ba14b0b09fda586139b946fada42098f1f1d91b6cc9097215cf

data/README.md

@@ -1,52 +1,35 @@
-### Overview
+### Example
+
+http://examples.hilscher.ca/gallerize/
 
-Generate a static gallery from a folder of images. 
 
-**Highlights**
+### Overview
 
+* generate a static gallery from a folder of images
 * responsive layout
 * thumbnails and fullsize are generated automatically
 * does not alter existing directory
 
 
-### Example
-
-http://examples.hilscher.ca/static-gallery-generator/
-
-
-### Usage
-
-```
-$ cd folder-with-pictures
-$ gallerize
-```
-
-
 ### Installation
 
-* Clone or download the repo
-
 ```
-git clone https://github.com/blakehilscher/static-gallery-generator.git
+gem install gallerize-cli
 ```
 
-* Install depedencies
 
-```
-cd static-gallery-generator
-bundle install
-```
-
-* Link bin/gallerize into your PATH
+### Usage
 
 ```
-ln -sf "$(pwd)/bin/gallerize" $HOME/bin/gallerize
+$ cd folder-with-pictures
+$ gallerize
+$ open gallerize/index.html
 ```
 
 
 ### Configuration
 
-* configure in config/global.yml
+Create .gallerize in the directory that contains your photos with any of these options:
 
 | Name          | Required?     | Example Value     | Description                                                   |
 | ------------- |:-------------:| -----------------:| -------------------------------------------------------------:|
@@ -55,8 +38,8 @@ ln -sf "$(pwd)/bin/gallerize" $HOME/bin/gallerize
 | workers       | required      | 4                 | The number of processes to use when doing CPU intensive work  |
 | image_width   | required      | 1200              | The fullsize image width                                      |
 | image_height  | required      | 800               | The fullsize image height                                     |
-| thumb_width   | required      | 1200              | The thumbnail image width                                     |
-| thumb_height  | required      | 800               | The thumbnail image height                                    |
+| thumb_width   | required      | 400               | The thumbnail image width                                     |
+| thumb_height  | required      | 300               | The thumbnail image height                                    |
 | output_name   | optional      | gallery           | Directory name where the gallery will be created              |
 | tracking      | optional      | UA-0000000-2      | Enable google analytics by entering a tracking code           |
 

data/config/global.yml.example

@@ -6,4 +6,4 @@ image_width: 1200
 image_height: 800
 thumb_width: 400
 thumb_height: 300
-output_name: static-gallery
+output_name: gallerize

data/lib/gallerize.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require 'ostruct'
 require 'active_support/all'
 require 'parallel'
 require 'mini_magick'
@@ -10,92 +11,80 @@ ROOT = File.expand_path( File.join(__FILE__, '../../') )
 
 class Gallerize
   
-  VERSION='0.1.1'
+  attr_accessor :image_paths
   
-  if File.exists?(File.join(File.expand_path('.'), '.gallerize.yml'))
-    config = YAML.load(File.read(File.join(File.expand_path('.'), '.gallerize.yml')))
-  else
-    config = {}
-  end
-  
-  unless File.exists?(File.join(ROOT,'config/global.yml'))
-    FileUtils.cp(File.join(ROOT,'config/global.yml.example'), File.join(ROOT,'config/global.yml'))
-  end
-  
-  CONFIG = YAML.load(File.read(File.join(ROOT,'config/global.yml'))).merge(config)
-  
-  PER_PAGE = CONFIG['per_page']
-  TRACKING = CONFIG['tracking']
-  IMAGE_TYPES = CONFIG['image_types']
-  WORKERS = CONFIG['workers'].to_i
+  VERSION='0.2.0'
   
   def self.generate
     new.perform
   end
   
   def perform
-    if Dir.glob("*.{#{IMAGE_TYPES}}").reject{|f| f =~ /thumbnail/ }.blank?
-      puts "no images found in #{File.expand_path('.')} matching #{IMAGE_TYPES}"
+    if image_paths.blank?
+      puts "no images found in #{source_dir.root} matching #{config.image_types}"
     else
-      reset
+      prepare_output_directory
       generate_images
       ticker = 0
-      images_to_html(images.each_slice(per_page).to_a.first, 0, File.join(output_dir, 'index.html'))
+      images_to_html(images.each_slice(config.per_page).to_a.first, 0, output_dir.html_file(:index) )
       images.each_slice(per_page) do |some_images|
         images_to_html(some_images, ticker)
         ticker = ticker + 1
       end
-      
     end
   end 
   
+  def prepare_output_directory
+    # remove html files
+    Dir.glob( output_dir.html_files ){|f| FileUtils.rm(f) }
+    # ensure output directory
+    FileUtils.mkdir( output_dir.root ) unless File.exists?( output_dir.root )
+    # ensure output/images directory
+    FileUtils.mkdir( output_dir.images ) unless File.exists?( output_dir.images )
+    # copy css and js from gem to output
+    output_dir.copy_from_gem_source( 'css', 'js' )
+  end
+  
   def generate_images
-    Parallel.map( Dir.glob("*.{#{IMAGE_TYPES}}").reject{|f| f =~ /thumbnail/ }, in_processes: WORKERS ) do |f| 
-      generate_image(f)
-      generate_thumbnail(f)
+    generated = []
+    # generate images and skip any that fail
+    Parallel.map( image_paths, in_processes: config.workers.to_i ) do |f|
+      begin
+        generate_fullsize(f)
+        generate_thumbnail(f)
+        generated << f
+      rescue => e
+        # if any error occurs while processing the image, skip it
+        puts "failed to process #{f}. error: #{e} #{e.backtrace.first}"
+        nil
+      end
     end
+    generated
   end
   
   def images_to_html(some_images, ticker=0, name=nil)
     some_images ||= []
     navigation = (images.count / per_page.to_f).ceil.times.collect{|r| %Q{<a class="#{'active' if r == ticker}" href="images-#{r}.html">#{r}</a>} }.join("\n")
+    navigation = (images.count > some_images.count) ? %Q{<div class="navigation">#{navigation}</div>} : ""
     html = %Q{
       #{body}
-      <div class="navigation">
-        #{navigation}
-      </div>
+      #{navigation}
       <div id="images-container" class="images">
       #{some_images.join("\n")}
       </div>
-      <div class="navigation">
-        #{navigation}
-      </div>
+      #{navigation}
       #{footer}
     }
-    name ||= File.join( output_dir, "images-#{ticker}.html" )
+    name ||= output_dir.html_file("images-#{ticker}")
     puts "generate #{name}"
     File.write(name, html)
   end
   
   def images
     ticker = 0
-    @images ||= Dir.glob("*.{#{IMAGE_TYPES}}").reject{|f| 
-      # reject thumbnails
-      f =~ /thumbnail/
-    }.reject{|f| 
-      begin
-        EXIFR::JPEG.new(f).date_time
-        false
-      rescue
-        true
-      end
-    }.sort_by{|f|
-      # sort by exif date
-      EXIFR::JPEG.new(f).date_time || Time.parse('3000-01-01')
-    }.collect do |f| 
-      image_fullsize = generate_image(f)
+    image_paths.collect do |f| 
+      image_fullsize = generate_fullsize(f)
       image_thumbnail = generate_thumbnail(f)
-      
       even = (ticker % 2 == 0) ? 'image-even' : 'image-odd'
       third = (ticker % 3 == 0) ? 'image-third' : ''
       fourth = (ticker % 4 == 0) ? 'image-fourth' : ''
@@ -111,6 +100,23 @@ class Gallerize
     end
   end
   
+  def image_paths
+    @image_paths ||= Dir.glob("*.{#{config.image_types}}").reject{|f| 
+      # reject thumbnails
+      f =~ /thumbnail/
+    }.reject{|f| 
+      begin
+        EXIFR::JPEG.new(f).date_time
+        false
+      rescue
+        true
+      end
+    }.sort_by{|f|
+      # sort by exif date
+      EXIFR::JPEG.new(f).date_time || Time.parse('3000-01-01')
+    }
+  end
+  
   def body
     %Q{
         <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
@@ -163,11 +169,11 @@ class Gallerize
   end
   
   def per_page
-    PER_PAGE
+    config.per_page
   end
   
   def tracking_js
-    return if TRACKING == ''
+    return if config.tracking.blank?
     %Q{
       <script>
         (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
@@ -175,51 +181,52 @@ class Gallerize
         m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
         })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
 
-        ga('create', '#{TRACKING}', 'auto');
+        ga('create', '#{config.tracking}', 'auto');
         ga('send', 'pageview');
 
       </script>
     }
   end
   
-  def generate_image(image_path)
-    
-    image_output = File.join(output_dir, 'images', image_path.downcase)
-    
-    unless File.exists?(image_output)
-      puts "generate_image #{CONFIG['image_width']}x#{CONFIG['image_height']} #{image_output}"
-      image = MiniMagick::Image.open(image_path)
-      image.auto_orient
-      width,height = image['width'],image['height']
-      if width > height
-        image.resize "#{CONFIG['image_width']}x#{CONFIG['image_height']}"
-      else
-        image.resize "#{CONFIG['image_height']}x#{CONFIG['image_width']}"
-      end
-      image.write image_output
-    end
-    image_output.gsub(output_dir, '')
+  def generate_fullsize(source_path)
+    image = extract_image_extension(source_path)
+    output_path = File.join(output_dir.images, "#{image[:basename]}.#{image[:extension]}")
+    # generate the thumbnail
+    generate_image(source_path, output_path, config.image_width, config.image_height)
   end
   
-  def generate_thumbnail(f)
-    image_basename = f.downcase.split(".")
-    image_ext = image_basename.pop
-    image_basename = image_basename.join('.')
-    image_thumbnail = File.join(output_dir, 'images', "#{image_basename}-thumbnail.#{image_ext}")
-    
-    unless File.exists?(image_thumbnail)
-      puts "generate_thumbnail #{CONFIG['thumb_width']}x#{CONFIG['thumb_height']} #{image_thumbnail}"
-      image = MiniMagick::Image.open(f)
+  def generate_thumbnail(source_path)
+    image = extract_image_extension(source_path)
+    output_path = File.join(output_dir.images, "#{image[:basename]}-thumbnail.#{image[:extension]}")
+    # generate the thumbnail
+    generate_image(source_path, output_path, config.thumb_width, config.thumb_height)
+  end
+  
+  def generate_image(source_path, output_path, width, height)
+    # ensure correct types
+    width, height = width.to_i, height.to_i
+    # skip if image exists
+    unless File.exists?(output_path)
+      puts "generate_image #{File.basename(source_path)} #{File.basename(output_path)} #{width} #{height}"
+      image = MiniMagick::Image.open(source_path)
       image.auto_orient
-      width,height = image['width'],image['height']
-      if width > height
-        image.resize "#{CONFIG['thumb_width']}x#{CONFIG['thumb_height']}"
+      # landscape?
+      if image['width'] > image['height']
+        image.resize "#{width}x#{height}"
       else
-        image.resize "#{CONFIG['thumb_height']}x#{CONFIG['thumb_width'].to_i * 1.25}"
+        image.resize "#{height}x#{width.to_i * 1.25}"
       end
-      image.write image_thumbnail
+      image.write output_path
     end
-    image_thumbnail.gsub(output_dir, '')
+    # strip the output_dir.root from the path so that the returned path is relative
+    output_path.gsub( output_dir.root, '' )
+  end
+  
+  def extract_image_extension(image_path)
+    basename = image_path.split(".")
+    extension = basename.pop.downcase
+    basename = basename.join('.')
+    return { basename: basename, extension: extension }
   end
   
   def title
@@ -227,27 +234,80 @@ class Gallerize
   end
   
   def output_dir
-    return CONFIG['output_name'] if CONFIG['output_name'].present?
-    dir = File.basename(File.expand_path('.'))
-    dir = "#{Date.today.strftime('%Y-%m')}-#{dir}" unless dir =~ /^[0-9]{4}/
-    dir = dir.downcase.underscore.gsub('_','-')
-    dir
-  end
-  
-  def reset
-    Dir.glob(File.join(output_dir, '*.html')){|f| FileUtils.rm(f) }
-    FileUtils.mkdir(output_dir) unless File.exists?(output_dir)
-    FileUtils.mkdir(File.join(output_dir,'images')) unless File.exists?(File.join(output_dir,'images'))
-    copy('css', 'js')
-  end
-  
-  def copy(*folders)
-    folders.each do |folder|
-      outdir = File.join( output_dir, folder )
-      puts "copy #{File.join( ROOT, folder )} #{outdir}"
-      FileUtils.rm_rf( outdir )
-      FileUtils.cp_r( File.join( ROOT, folder ), outdir )
+    @output_dir ||= OutputDir.new( config.output_name )
+  end
+  
+  def config
+    @config ||= load_config
+  end
+  
+  def load_config
+    config = {}
+    # load config from output directory if present
+    config = YAML.load( File.read( source_dir.config ) ) if source_dir.config?
+    # generate global config from example if missing
+    global_config = File.join(ROOT,'config/global.yml')
+    FileUtils.cp( "#{global_config}.example", global_config ) unless File.exists?( global_config )
+    # load global_config and merge with source config
+    OpenStruct.new(YAML.load(File.read(global_config)).merge(config))
+  end
+  
+  def source_dir
+    @source_dir ||= SourceDir.new
+  end
+  
+  class SourceDir
+    
+    def config?
+      File.exists?(config)
     end
+    
+    def config
+      File.join( root, '.gallerize')
+    end
+    
+    def root
+      @root ||= File.expand_path('.')
+    end
+    
+  end
+  
+  class OutputDir
+    
+    attr_accessor :root
+    
+    def initialize(path)
+      self.root = path
+    end
+    
+    def root=(value)
+      @root = File.join( File.expand_path('.'), (value || 'gallerize') )
+    end
+    
+    def html_file(name)
+      name = name.to_s
+      name = "#{name}.html" unless name =~ /\.html/
+      File.join(root, name)
+    end
+    
+    def images
+      File.join( root, 'images' )
+    end
+    
+    def html_files
+      File.join( root, '*.html')
+    end
+    
+    def copy_from_gem_source(*folders)
+      folders.each do |folder|
+        outdir = File.join( root, folder )
+        puts "copy ./#{folder} #{outdir}"
+        FileUtils.rm_rf( outdir )
+        FileUtils.cp_r( File.join( ROOT, folder ), outdir )
+      end
+    end
+  
+    
   end
   
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gallerize-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Blake Hilscher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2014-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick