hermitage 0.0.4.1 → 0.0.5.2

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 0.0.5 ###
+
+* Loading animation added
+* Original, thumbnail and title options can be lambdas
+* Bug with looped gallery with the only one image fixed
+* Wrong behavior with Turbolinks when user clicks back in browser fixed
+
 ### 0.0.4.1 ###
 
 * RailsRenderCore is not a child of ActionView::Base anymore

data/README.md

@@ -5,6 +5,8 @@
 
 Ruby library for generation of image galleries (thumbnails and original images viewer).
 
+There is a [demo](http://immaculatepine.github.io/hermitage/demo/default.html) with customization examples at project's [homepage](http://immaculatepine.github.io/hermitage/).
+
 ## Requirements
 
 Hermitage requires Ruby on Rails version >= 3.1 with support of jQuery and CoffeeScript (jquery-rails and coffee-rails gems, respectively).
@@ -69,6 +71,10 @@ If the only method returns both paths according to passed parameters you can spe
 
     render_gallery_for @posts, original: 'attachment(:full)', thumbnail: 'attachment(:thumbnail)'
 
+Also you can specify those values by lambdas:
+
+    render_gallery_for @posts, original: -> post { post.attachment(:full) }, thumbnail: -> post { post.attachment(:thumbnail) }
+
 #### Markup
 
 Hermitage renders markup that will look nice with Twitter Bootstrap by default:
@@ -140,8 +146,8 @@ You can overwrite :default config. These changes will be applied to all the gall
 Uncoment the following lines in config/initializers/hermitage.rb file and make some changes here:
 
     Hermitage.configure :default do
-      original 'image.url(:medium)'
-      thumbnail 'image.url(:small)'
+      original -> item { item.image.url(:medium) }
+      thumbnail -> item { image.url(:small) }
     end
 
 Now Hermitage will use `image.url` method with :medium or :small argument to get images for the gallery.
@@ -170,11 +176,13 @@ Then your config/initializers/hermitage.rb could looks like this:
 
     # Some rules for :default config if needed...
 
+    # Setup by lambdas...
     Hermitage.configure :pictures do
-      original 'image_path'
-      thumbnail 'image_path(:small)'
+      original -> item { item.image_path }
+      thumbnail -> item { item.image_path(:small) }
     end
 
+    # ...or by strings
     Hermitage.configure :posts do
       original 'attachment'
       thumbnail 'attachment(:tiny)'
@@ -223,6 +231,9 @@ You can customize the following parameters:
 * `image.styles` - any custom CSS for current image
 * `bottomPanel.styles` - any custom CSS for bottom panel
 * `bottomPanel.text.styles` - any custom CSS for text block of bottom panel
+* `loader.image` - custom image for loader
+* `loader.timeout` - timeout before loader animation should appear
+* `loader.styles` - custom styles for loader
 * `minimumSize.width` - minimum width of scaled image, px
 * `minimumSize.height` - minimum height of scaled image, px
 * `animationDuration` - duration of UI animations, ms

data/app/assets/javascripts/{hermitage.js.coffee → hermitage.js.coffee.erb}

@@ -115,6 +115,15 @@ root.hermitage =
           color: '#FAFAFA'
       styles: {}
 
+  loaderTimer: undefined
+  loader:
+    default:
+      attributes: { class: 'loader' }
+      styles: {}
+    styles: {}
+    image: '<%= asset_path 'hermitage-loader.gif' %>'
+    timeout: 100
+
   # Minimum size of scaled image, px
   minimumSize:
     width: 100
@@ -285,6 +294,26 @@ createBotomPanel = ->
   createElement($('<div>'), hermitage.bottomPanel.text)
     .appendTo(bottomPanel)
 
+createLoader = ->
+  loadImage hermitage.loader.image, ->
+    createElement($('<img>'), hermitage.loader)
+      .attr('src', hermitage.loader.image)
+      .appendTo($('#hermitage'))
+      .hide()
+      .center()
+
+clearLoaderTimer = -> clearTimeout(hermitage.loaderTimer) if hermitage.loaderTimer
+
+showLoader = ->
+  clearLoaderTimer()
+  hermitage.loaderTimer = setTimeout \
+    -> $('#hermitage .loader').show(),
+    hermitage.loader.timeout
+
+hideLoader = ->
+  clearLoaderTimer()
+  $('#hermitage .loader').hide()
+
 # Shows original image of the chosen one
 openGallery = (image) ->
   $('#hermitage')
@@ -296,11 +325,14 @@ openGallery = (image) ->
   createLeftNavigationButton()
   createCloseButton()
   createBotomPanel()
+  createLoader()
 
   showImage(indexOfImage(image))
   
 # Shows image with specified index from images array
 showImage = (index, direction = undefined) ->
+  showLoader()
+
   img = createElement($('<img />'), hermitage.image)
     .attr('src', sourceFor(index))
     .hide()
@@ -366,7 +398,6 @@ closeGallery = ->
     $('#hermitage').hide()
                    .empty()
 
-
 # Moves image to correct position and sets correct size.
 # Then it calls adjusting methods for navigation and close buttons.
 # Attributes:
@@ -377,7 +408,6 @@ closeGallery = ->
 #   * 'right' - move from the right bound of screen
 #   * 'left' - move from the left bound of screen
 adjustImage = (withAnimation = false, image = undefined, direction = undefined) ->
-
   if image is undefined
     image = $('#hermitage img.current')
     return unless image.length is 1
@@ -426,9 +456,12 @@ adjustImage = (withAnimation = false, image = undefined, direction = undefined)
     else
       image.fadeIn(hermitage.animationDuration)
 
+    hideLoader()
+
     adjustNavigationButtons(withAnimation, image)
     adjustCloseButton(withAnimation, image)
     adjustBottomPanel(withAnimation)
+    $('#hermitage .loader').center()
 
 # Moves navigation buttons to proper positions
 adjustNavigationButtons = (withAnimation, current) ->
@@ -479,12 +512,16 @@ adjustBottomPanel = (withAnimation) ->
     panel.fadeIn(hermitage.animationDuration)
 
 canShowNextAfter = (index) ->
+  return false if hermitage.images.length < 2
+
   if index < hermitage.images.length - 1
     true
   else
     hermitage.looped
 
 canShowPreviousBefore = (index) ->
+  return false if hermitage.images.length < 2
+
   if index > 0
     true
   else
@@ -522,4 +559,4 @@ previousIndexBefore = (index) ->
 
 # Initialize gallery on page load
 $(document).ready(hermitage.init)
-$(document).on('page:load', hermitage.init)
+$(document).on('page:change', hermitage.init)

data/hermitage.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['immaculate.pine@gmail.com']
   spec.description   = %q{Ruby library for image galleries generation.}
   spec.summary       = %q{Ruby library for image galleries generation (thumbnails and original images viewer).}
-  spec.homepage      = 'https://github.com/ImmaculatePine/hermitage'
+  spec.homepage      = 'http://immaculatepine.github.io/hermitage/'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)

data/lib/generators/hermitage/templates/hermitage.rb

@@ -4,8 +4,8 @@
 # You can configure any of its options and they will be applied for every rendering.
 #
 # Hermitage.configure :default do
-#   original 'file.url'
-#   thumbnail 'file.url(:thumbnail)'
+#   original -> item { item.file.url }
+#   thumbnail -> item { item.file.url(:thumbnail) }
 #   title nil
 #   list_tag :ul
 #   item_tag :li

data/lib/hermitage/rails_render_core.rb

@@ -37,11 +37,21 @@ module Hermitage
       end
     end
 
+    # Returns value of item's attribute
+    def value_for(item, option)
+      attribute = @options[option]
+      if attribute.is_a? Proc
+        attribute.call(item)
+      else
+        eval("item.#{attribute}")
+      end
+    end
+
     # Renders link to the specific image in a gallery
     def render_link_for(item)
-      original_path = eval("item.#{@options[:original]}")
-      thumbnail_path = eval("item.#{@options[:thumbnail]}")
-      title = @options[:title] ? eval("item.#{@options[:title]}") : nil
+      original_path = value_for(item, :original)
+      thumbnail_path = value_for(item, :thumbnail)
+      title = @options[:title] ? value_for(item, :title) : nil
       image = @template.image_tag(thumbnail_path, class: @options[:image_class])
       @template.link_to(image, original_path, rel: 'hermitage', class: @options[:link_class], title: title)
     end

data/lib/hermitage/version.rb

@@ -1,3 +1,3 @@
 module Hermitage
-  VERSION = '0.0.4.1'
+  VERSION = '0.0.5.2'
 end

data/spec/lib/hermitage/view_helpers_spec.rb

@@ -20,15 +20,31 @@ describe Hermitage::ViewHelpers, type: :helper do
     context 'with options' do
       
       context 'original and thumbnail' do
-        subject { template.render_gallery_for images, original: 'photo', thumbnail: 'photo(:thumbnail)' }
         let(:images) { Array.new(2) { |i| DummyPhoto.new(i.to_s) } }
-        it { should == expected }
+
+        context 'by string' do
+          subject { template.render_gallery_for images, original: 'photo', thumbnail: 'photo(:thumbnail)' }
+          it { should == expected }
+        end
+
+        context 'by proc' do
+          subject { template.render_gallery_for images, original: -> item { item.photo }, thumbnail: -> item { item.photo(:thumbnail) } }
+          it { should == expected }
+        end
       end
 
       context 'title' do
-        subject { template.render_gallery_for images, title: 'description' }
         let(:expected) { '<ul class="thumbnails"><li class="span4"><a class="thumbnail" href="/assets/0-full.png" rel="hermitage" title="description of 0"><img alt="0 thumbnail" src="/assets/0-thumbnail.png" /></a></li><li class="span4"><a class="thumbnail" href="/assets/1-full.png" rel="hermitage" title="description of 1"><img alt="1 thumbnail" src="/assets/1-thumbnail.png" /></a></li></ul>' }
-        it { should == expected }
+
+        context 'by string' do
+          subject { template.render_gallery_for images, title: 'description' }
+          it { should == expected }
+        end
+
+        context 'by proc' do
+          subject { template.render_gallery_for images, title: -> item { item.description } }
+          it { should == expected }
+        end
       end
 
       context 'list_tag and item_tag' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hermitage
 version: !ruby/object:Gem::Version
-  version: 0.0.4.1
+  version: 0.0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2013-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -203,7 +203,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- app/assets/javascripts/hermitage.js.coffee
+- app/assets/images/hermitage-loader.gif
+- app/assets/javascripts/hermitage.js.coffee.erb
 - config.ru
 - hermitage.gemspec
 - lib/generators/hermitage/install_generator.rb
@@ -282,7 +283,7 @@ files:
 - spec/lib/hermitage/view_helpers_spec.rb
 - spec/lib/hermitage_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/ImmaculatePine/hermitage
+homepage: http://immaculatepine.github.io/hermitage/
 licenses:
 - MIT
 post_install_message: