jekyll-galleries 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96392eb09f6402ecf36bb1144ab3037ac4431d52
-  data.tar.gz: 52129659e6b1e595d2493e3457823f5c6c653ae9
+  metadata.gz: 0489231e919c218babd6617e37e913be0dd8c72d
+  data.tar.gz: f22848c946b32ac8f1214b92e1ef0c0c9a5abf6d
 SHA512:
-  metadata.gz: cf7c2944dd0d6bcc5703aa252295e457e198830b8c3f8347e3bb25f5320bc27df23b9cb42bd6c61675399d3c22aeb4658ba19a29b83bca9011970dc492753a65
-  data.tar.gz: 1530757ee636776276f8d678130f09822bcfa3ce41986c8b3d28298ed0aa10d229fda40bc2dc8aa544d9978d3c120d28e1b524ca3642e0a351155239eb9cffda
+  metadata.gz: f34067a34ac82992965a482fce1feb0052eba6db5ce772f3083b9a2d0972d19f58a1d7472d0c7d0486c251d7ada79ad69564c181b297e05598d17687c6e424d5
+  data.tar.gz: 8a88da9bbc312697178aa02018ccc8f79defbc429e947a0765d30d4547e5f8fcd725fcb1727a1eacb1227bb001e6fdcb94c4988ec78327595390ec356131bdbb

data/ChangeLog

@@ -1,3 +1,8 @@
+== 0.8.0 [2014-03-13]
+
+* Add `top` as an attribute, for putting an gallery on the top of index page
+* Automatically generate thumbnails for galleries
+
 == 0.7.2 [2014-02-20]
 
 * Add full documentation

data/README.md

@@ -4,6 +4,8 @@ By [allenlsy](mailto:cafe@allenlsy.com)
 
 __Jekyll-galleries__ is a Jekyll plugin used for generating photo galleries from image folders.
 
+A demo to this plugin is on my [personal website](http://allenlsy.com/galleries.html).
+
 If you have any questions or any suggestions, I'm very pleased to hear from you. I need your support and ideas to make this plugin better.
 
 ---
@@ -25,15 +27,15 @@ Here is an example on how to use this plugin.
 
 ##### 1. Setup the plugin
 
-Add `gem 'jekyll-galleries'` to the `Gemfile` in your jekyll project, and then run `bundle` command in shell to install it. Then add `require 'jekyll/galleries'` to `_plugins/_ext.rb`.
+Add `gem 'jekyll-galleries'` to the `Gemfile` in your jekyll project, and also the depedencies `rmagick`. Then run `bundle` command in shell to install them. Next add `require 'jekyll/galleries'` to `_plugins/_ext.rb`.
 
-There are three attributes which are optional. All of them should be put at the root level of `_config.yml`, if needed.
+There are three attributes which are optional. All of them should be put into the `_config.yml`, if needed.
 
 * `galleries` specifies the extra information of each gallery, using the YAML object format.
 * `gallery_dir` defines which folder in jekyll project stores the all the galleries. Default value is `galleries` if not defined.
 * `gallery_layout` defines the layout __Jekyll-galleries__ will use to render each single gallery. Default value is `gallery`, which uses the `_layouts/gallery.html` as the template.
 
-Check out the example `_config.yml` if you are still not clear.
+Check out the example `_config.yml` down below if you are still not clear.
 
 ##### 2. Add galleries to jekyll project
 
@@ -64,6 +66,13 @@ Inside the optional `galleries` attribute in `_config.yml`, you can have objects
 
 Then in the template, the gallery will have the attribute `subtitle` that can be rendered.
 
+Another attribute is `top`. If you set `top: true` for a gallery, then this gallery will always be put on top of the galleries index page. For example:
+
+    galleries:
+      - name: Sample Gallery
+        subtitle: This is a sample gallery
+        top: true
+
 ##### 5. Use attributes in template
 
 Now, the `site.data['galleries']` global variable contains all the gallery pages. It is an array of `GalleryPage` objects. Each `GalleryPage` object has at least three attributes: `name`, `date` and `url`. `url` is URL escaped. You can use them in your galleries index page.

data/lib/jekyll/galleries.rb

@@ -1,12 +1,25 @@
+require 'RMagick'
+include Magick
+
+include FileUtils
+
 module Jekyll
   class GalleryGenerator < Generator
-    attr_accessor :site, :gallery_dir, :gallery_layout, :galleries
+    attr_accessor :site
+    attr_accessor :gallery_dir # directory for storing galleries. Default value is `galleries`
+    attr_accessor :gallery_layout # layout file for gallery. Default value is `gallery`
+    attr_accessor :galleries
+    attr_accessor :gallery_pages
+    attr_accessor :top_gallery_pages # GalleryPage array of topped galleries
+
     class << self; attr_accessor :site; end
 
     def generate(site)
       self.class.site = self.site = site
       self.gallery_dir = site.config['gallery_dir'] || 'galleries'
       self.gallery_layout = site.config['gallery_layout'] || 'gallery'
+      self.gallery_pages = []
+      self.top_gallery_pages = []
 
       # array of GalleryPage objects
       site.data['galleries'] = []
@@ -16,6 +29,17 @@ module Jekyll
       gallery_dirs.each do |dir|
         generate_gallery_page(dir)
       end
+
+      # ordering the Page generation
+      site.pages << self.top_gallery_pages
+      site.pages << self.gallery_pages
+      site.pages.flatten!
+
+      # ordering galleries on gallery index page
+      site.data['galleries'] << self.top_gallery_pages
+      site.data['galleries'] << self.gallery_pages.reverse!
+      site.data['galleries'].flatten!
+
     end
 
     private
@@ -24,54 +48,72 @@ module Jekyll
 
       page = GalleryPage.new(site, site.source, self.gallery_dir, gallery_dir, data)
 
-      site.pages << page
-
-      site.data['galleries'] << page
+      pages_queue = page.top? ? top_gallery_pages : gallery_pages # decide the queue that current page should be put into
+      pages_queue << page
     end
-
   end
 
   class GalleryPage < Page
     # Valid post name regex.
     MATCHER = /^(\d+-\d+-\d+)-(.*)$/
     CONFIG_GALLERIES_ATTR = 'galleries'
-
-    attr_accessor :url, :name, :slug, :date
+    attr_accessor :url, :name, :slug, :date, :base
+    attr_accessor :gen_dir # path that this gallery will be generated into
+    attr_accessor :gallery_dir # the original path of the this gallery on local
+    attr_accessor :gallery_dir_name # the name of this gallery dir
+    attr_accessor :thumbs_dir # path of thumbnails dir
 
     def initialize(site, base, gen_dir, gallery_dir, data={})
+      # preparation
+      @base = base
+      @site = site
+      self.gen_dir = gen_dir
+      self.gallery_dir = gallery_dir
       self.content = data.delete('content') || ''
       self.data = data
+      self.thumbs_dir = site.config['thumbs_dir']
+
+      self.gallery_dir_name = File.basename gallery_dir
+      super(site, base, gen_dir, self.gallery_dir_name)
 
-      gallery_dir_name = File.basename gallery_dir
-      super(site, base, gen_dir, gallery_dir_name)
+      # ---
+      generate_photos
 
-      # load photos configuration
-      photos_config_filepath =  "#{base}/#{site.config['gallery_dir']}/#{self.date}-#{self.name}.yml"
-      photos_config = YAML.load(File.open(photos_config_filepath).read) if File.exists?(photos_config_filepath)
+    end
+
+    def generate_photos
+      photos_config_filepath =  "#{@base}/#{@site.config['gallery_dir']}/#{self.date}-#{self.name}.yml"
+      photos_config = YAML.load(File.open(photos_config_filepath).read) if File.exists?(photos_config_filepath) # config of this gallery
 
       # generating photos
-      self.url = "/#{gen_dir}/#{self.date}-#{self.slug}.html" # gallery page url
-      self.data['url'] = URI.escape self.url 
+      self.url = "/#{self.gen_dir}/#{self.gallery_dir_name}/index.html" # gallery page url
+      self.data['url'] = URI.escape self.url
 
       # For each photo, initial attributes are `filename` and `url`
-      photos = Dir["#{gallery_dir}/*"].map { |e| { filename: File.basename(e), url: URI.escape("/#{gen_dir}/#{gallery_dir_name}/#{File.basename e}") } } # basic photos attributes
+      photos = Dir["#{self.gallery_dir}/*"].map { |e| { filename: File.basename(e), url: URI.escape("/#{self.gen_dir}/#{self.gallery_dir_name}/#{File.basename e}") } } # basic photos attributes
 
       self.data['photos'] = [] # storing an array of Photo
       photos.each do |photo|
         photo_data = {}
         photo_data = photos_config.find { |e| e['filename'] == photo[:filename] } if photos_config
-        self.data['photos'] << Photo.new(photo[:filename], photo[:url], photo_data)
+
+        self.data['photos'] << Photo.new(@site, photo[:filename], self, photo_data)
       end
 
       # gallery page configuration
-      if site.config[CONFIG_GALLERIES_ATTR]
-        attr = site.config[CONFIG_GALLERIES_ATTR].find { |e| e['name'] == self.name}
+      if @site.config[CONFIG_GALLERIES_ATTR]
+        attr = @site.config[CONFIG_GALLERIES_ATTR].find { |e| e['name'] == self.name }
         if attr
           attr.each { |k, v| self.data[k] = v }
         end
       end
     end
 
+
+    def top?
+      self.data['top'] and self.data['top'] == true
+    end
+
     def read_yaml(*)
     end
 
@@ -93,16 +135,45 @@ module Jekyll
   end
 
   class Photo
-    attr_accessor :filename, :url, :data
+    attr_accessor :filename, :url, :data, :thumbnail_url
 
-    def initialize(filename, url, options=nil)
-      self.filename = filename
-      self.url = url
+    def initialize(site, filename, gallery, options=nil)
+      @site = site
+      @gallery = gallery
       self.data = options || {}
+      self.data['url'] = URI.escape("/#{gallery.gen_dir}/#{gallery.gallery_dir_name}/#{filename}")
+      self.data['filename'] = filename
+      self.filename = filename
+
+
+      @thumbs_dir = site.config['thumbnails_dir']
+      generate_thumbnails if @thumbs_dir
+
     end
 
     def to_liquid
-      self.data.merge({ 'url' => self.url })
+      self.data
+    end
+
+    def generate_thumbnails
+      size_x = @site.config['thumbnail_x'] || 100
+      size_y = @site.config['thumbnail_y'] || 100
+
+      full_thumbs_path = "#{@site.dest}/#{@thumbs_dir}/#{@gallery.gallery_dir_name}"
+      FileUtils.mkdir_p(full_thumbs_path, :mode => 0755)
+      if File.file?("#{full_thumbs_path}/#{self.filename}") == false or File.mtime("#{@gallery.gallery_dir}/#{self.filename}") > File.mtime("#{full_thumbs_path}/#{self.filename}")
+        begin
+          m_image = ImageList.new("#{@gallery.gallery_dir}/#{self.filename}")
+          m_image.send("resize_to_fit!", size_x, size_y)
+          puts "Writing thumbnail to #{full_thumbs_path}/#{self.filename}"
+          m_image.write("#{full_thumbs_path}/#{self.filename}")
+        rescue
+          puts "error"
+          puts $!
+        end
+        GC.start
+      end
+      self.data['thumbnail_url'] = URI.escape("/#{@thumbs_dir}/#{@gallery.gallery_dir_name}/#{self.filename}")
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-galleries
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - allenlsy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-20 00:00:00.000000000 Z
+date: 2014-03-13 00:00:00.000000000 Z
 dependencies: []
 description: Jekyll plugin to automatically generate photo gallery (album) from image
   folder.
@@ -32,7 +32,7 @@ rdoc_options:
 - --line-numbers
 - --all
 - --title
-- jekyll-galleries Application documentation (v0.7.0)
+- jekyll-galleries Application documentation (v0.8.0)
 - --main
 - ChangeLog
 require_paths: