jekyll-gallery-generator 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fb877d9687a9a9b4c2ceb86449dbb29ff32db30
-  data.tar.gz: 3b95efbc9f1992097efae0ae0dd8a1c93cd6bd25
+  metadata.gz: fcea80713b0f4630d7579d6364b8534d8f60c651
+  data.tar.gz: a77062b54c229259d1ca00e290f93380858a3cb5
 SHA512:
-  metadata.gz: 5fce10d707394b0df32939ae3fa2b4da5938d627308e16fbe0dfb417ef49e9cc543f8ff477cc6fe435a1ace94de46a90af65c7dca801552ed7c802bfe94dc43c
-  data.tar.gz: 520617fc88e4e50ca4183efd7a04889aeba93554017530350167045a42e39fadd9331ca800822a2afc3967869071d69bb71781bba2db5333fa7fda6626e04e0e
+  metadata.gz: d714d25ca0673f7a8e00b53a5b68a9c56c463bace45fcd2945c8805c11612f6affca10871382449ee36898a03fe470b4c8a4d605d02373817df8a0ffa4560f42
+  data.tar.gz: 9f283ef8133e3063974d6dbaa6f33b7c52a25ff6746fe9ff3deff2074561f07aab8c1e071301d97c35125aa21699922f2da38b8446faf323eba059703c6448d8

data/README.md

@@ -17,14 +17,14 @@ This plugin is quite minimalist. It generates galleries with no pagination, no s
 
 2. Add `jekyll-gallery-generator` to the gems list in your `_config.yml`:
 
-```
+    ```
 gems:
   - jekyll-gallery-generator
 ```
 
 3. Copy your image directories into `jekyll-site/photos/`. Here's what my directory structure looks like:
 
-```bash
+    ```bash
 $ ls jekyll-site/photos
 best/          chile_trip/  japan_trip/
 $ ls jekyll-site/photos/chile_trip
@@ -54,28 +54,27 @@ This plugin reads several config options from `_config.yml`. The following optio
 
 ```yaml
 gallery:
-  # path to the gallery
-  dir: photos
-  # title for gallery index
-  title: "Photos"
-  # title prefix for gallery page. title=title_prefix+gallery_name
-  title_prefix: "Photos: "
-  # field to control sorting of galleries for the index page
-  # (possible values are: title, date_time, best_image)
-  sort_field: "date_time"
-  # sizes for thumbnails
+  dir: photos               # Path to the gallery
+  symlink: false            # false: copy images into _site. true: create symbolic links (saves disk space)
+  title: "Photos"           # Title for gallery index page
+  title_prefix: "Photos: "  # Title prefix for gallery pages. Gallery title = title_prefix + gallery_name
+  sort_field: "date_time"   # How to sort galleries on the index page.
+                            # Possible values are: title, date_time, best_image
   thumbnail_size:
-    x: 400
-    y: 400
-  # custom configuration for individual gallery
-  # best_image is image for the index page (defaults to last image)
+    x: 400                  # max width of thumbnails (in pixels)
+    y: 400                  # max height of thumbnails (in pixels)
+  # The following options are for individual galleries.
   galleries:
     chile_trip:
-      best_image: IMG_1068.JPG
+      best_image: IMG_1068.JPG  # The image to show on the gallery index page. Defaults to the last image.
     japan_trip:
       best_image: IMG_0690.JPG
-    best:
+      name: "日本の旅"       # Defaults to directory name, replacing _ with spaces & capitalizing words.
+    awesome_stuff:
       best_image: snaileo_gonzales.jpg
+      sort_reverse: true    # Reverse sort images in gallery.
+    secret_stuff:
+      hidden: true          # Don't show this gallery on the index page. People must guess the URL.
 ```
 
 

data/jekyll-gallery-generator.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
   spec.name        = "jekyll-gallery-generator"
   spec.summary     = "Generate galleries with thumbnails for your Jekyll site."
-  spec.version     = "0.9.0"
+  spec.version     = "1.0.0"
   spec.authors     = ["Geoff Greer"]
   spec.email       = "geoff@greer.fm"
   spec.homepage    = "https://github.com/ggreer/jekyll-gallery-generator"

data/lib/gallery_page.html

@@ -22,9 +22,9 @@ layout: page
 <hr />
 {% for image in page.images %}
     <div class="gallery-image-wrapper">
-        <a name="{{ image }}"></a>
-        <a href="{{ image }}"{% if site.gallery.lightbox %} rel="lightbox[{{ page.gallery }}]"{% endif %}>
-            <img class="gallery-image" src="thumbs/{{ image }}" />
+        <a name="{{ image.name }}"></a>
+        <a href="{{ image.name }}"{% if site.gallery.lightbox %} rel="lightbox[{{ page.gallery }}]"{% endif %}>
+            <img class="gallery-image" src="thumbs/{{ image.name }}" />
         </a>
     </div>
 {% endfor %}

data/lib/jekyll-gallery-generator.rb

@@ -6,18 +6,59 @@ include FileUtils
 
 $image_extensions = [".png", ".jpg", ".jpeg", ".gif"]
 
-def get_exif_date_time(image_path)
-  begin
-    return EXIFR::JPEG.new(image_path).date_time.to_i
-  rescue EXIFR::MalformedJPEG
-    puts "No EXIF data in #{image_path}"
-  rescue Exception => e
-    puts "Error reading EXIF date_time for #{image_path}: #{e}"
+module Jekyll
+  class GalleryImage
+    include Comparable
+    attr_accessor :name
+    attr_accessor :path
+
+    def initialize(name, base)
+      @name = name
+      @path = File.join(base, name)
+    end
+
+    def <=>(b)
+      return @date_time <=> b.date_time
+    end
+
+    def date_time
+      return @date_time if defined? @date_time
+      begin
+        @date_time = self.exif.date_time.to_i
+      rescue Exception => e
+        @date_time = 0
+      end
+      return @date_time
+    end
+
+    def exif
+      return @exif if defined? @exif
+      @exif = nil
+      begin
+        @exif = EXIFR::JPEG.new(@path)
+      rescue EXIFR::MalformedJPEG
+        puts "No EXIF data in #{@path}"
+      rescue Exception => e
+        puts "Error reading EXIF data for #{@path}: #{e}"
+      end
+      return @exif
+    end
+
+    def to_s
+      return @name
+    end
+
+    def to_liquid
+      # Liquid hates symbol keys. Gotta stringify them
+      return {
+        'name' => @name,
+        'src' => @name,
+        'date_time' => @date_time,
+        'exif' => @exif && @exif.to_hash.collect{|k,v| [k.to_s, v]}.to_h,
+      }
+    end
   end
-  return 0
-end
 
-module Jekyll
   class GalleryFile < StaticFile
     def write(dest)
       return false
@@ -97,15 +138,15 @@ module Jekyll
       scale_method = config["scale_method"] || "fit"
       begin
         max_size_x = config["thumbnail_size"]["x"]
-      rescue
+      rescue Exception
       end
       begin
         max_size_y = config["thumbnail_size"]["y"]
-      rescue
+      rescue Exception
       end
       begin
         gallery_config = config["galleries"][gallery_name] || {}
-      rescue
+      rescue Exception
       end
       self.process(@name)
       gallery_page = File.join(base, "_layouts", "gallery_page.html")
@@ -115,42 +156,42 @@ module Jekyll
       self.read_yaml(File.dirname(gallery_page), File.basename(gallery_page))
       self.data["gallery"] = gallery_name
       gallery_title_prefix = config["title_prefix"] || "Photos: "
-      gallery_name = gallery_name.gsub("_", " ").gsub(/\w+/) {|word| word.capitalize}
+      gallery_name = gallery_name.gsub(/[_-]/, " ").gsub(/\w+/) {|word| word.capitalize}
       begin
         gallery_name = gallery_config["name"] || gallery_name
-      rescue
+      rescue Exception
       end
       self.data["name"] = gallery_name
       self.data["title"] = "#{gallery_title_prefix}#{gallery_name}"
-      thumbs_dir = File.join(site.dest, @dest_dir, "thumbs")
+      self.data["exif"] = {}
       begin
         @hidden = gallery_config["hidden"] || false
-      rescue
+      rescue Exception
       end
       if @hidden
         self.data["sitemap"] = false
       end
 
+      thumbs_dir = File.join(site.dest, @dest_dir, "thumbs")
       FileUtils.mkdir_p(thumbs_dir, :mode => 0755)
       date_times = {}
       entries = Dir.entries(dir)
-      entries.each_with_index do |image, i|
-        next if image.chars.first == "."
-        next unless image.downcase().end_with?(*$image_extensions)
+      entries.each_with_index do |name, i|
+        next if name.chars.first == "."
+        next unless name.downcase().end_with?(*$image_extensions)
+        image = GalleryImage.new(name, dir)
         @images.push(image)
-        best_image = image
-        @site.static_files << GalleryFile.new(site, base, File.join(@dest_dir, "thumbs"), image)
-        image_path = File.join(dir, image)
-
-        date_times[image] = get_exif_date_time(image_path)
+        date_times[name] = image.date_time
+        best_image = name
+        @site.static_files << GalleryFile.new(site, base, File.join(@dest_dir, "thumbs"), name)
 
         if symlink
-          link_src = site.in_source_dir(image_path)
-          link_dest = site.in_dest_dir(image_path)
+          link_src = site.in_source_dir(image.path)
+          link_dest = site.in_dest_dir(image.path)
           @site.static_files.delete_if { |sf|
-            sf.relative_path == "/" + image_path
+            sf.relative_path == "/" + image.path
           }
-          @site.static_files << GalleryFile.new(site, base, dir, image)
+          @site.static_files << GalleryFile.new(site, base, dir, name)
           if File.exists?(link_dest) or File.symlink?(link_dest)
             if not File.symlink?(link_dest)
               puts "#{link_dest} exists but is not a symlink. Deleting."
@@ -165,16 +206,16 @@ module Jekyll
             File.symlink(link_src, link_dest)
           end
         end
-        thumb_path = File.join(thumbs_dir, image)
-        if File.file?(thumb_path) == false or File.mtime(image_path) > File.mtime(thumb_path)
+        thumb_path = File.join(thumbs_dir, name)
+        if File.file?(thumb_path) == false or File.mtime(image.path) > File.mtime(thumb_path)
           begin
-            m_image = ImageList.new(image_path)
+            m_image = ImageList.new(image.path)
             m_image.auto_orient!
             m_image.send("resize_to_#{scale_method}!", max_size_x, max_size_y)
             puts "Writing thumbnail to #{thumb_path}"
             m_image.write(thumb_path)
-          rescue e
-            printf "Error generating thumbnail for #{image_path}: #{e}\r"
+          rescue Exception => e
+            printf "Error generating thumbnail for #{image.path}: #{e}\r"
             puts e.backtrace
           end
           if i % 5 == 0
@@ -187,13 +228,7 @@ module Jekyll
       puts ""
 
       begin
-        @images.sort! {|a,b|
-          if date_times[a] == date_times[b]
-            a <=> b
-          else
-            date_times[a] <=> date_times[b]
-          end
-        }
+        @images.sort!
         if gallery_config["sort_reverse"]
           @images.reverse!
         end
@@ -204,9 +239,15 @@ module Jekyll
 
       site.static_files = @site.static_files
       self.data["images"] = @images
-      self.data["best_image"] = gallery_config["best_image"] || best_image
-      best_image_path = File.join(dir.to_s, best_image.to_s)
-      self.data["date_time"] = get_exif_date_time(best_image_path)
+      best_image = gallery_config["best_image"] || best_image
+      self.data["best_image"] = best_image
+      if date_times.has_key?(best_image)
+        gallery_date_time = date_times[best_image]
+      else
+        puts "#{gallery_name}: best_image #{best_image} not found!"
+        gallery_date_time = 0
+      end
+      self.data["date_time"] = gallery_date_time
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-gallery-generator
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Geoff Greer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-07 00:00:00.000000000 Z
+date: 2016-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: exifr