rails-gallery 0.2.1 → 0.3.0

data/Gemfile

@@ -1,5 +1,8 @@
 source "http://rubygems.org"
 
+gem 'rails'
+gem 'hashie', '~> 1.2.0'
+
 group :development do
   gem "rspec",    ">= 2.8.0"
   gem "rdoc",     ">= 3.12"

data/Gemfile.lock

@@ -1,15 +1,77 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    actionmailer (3.2.8)
+      actionpack (= 3.2.8)
+      mail (~> 2.4.4)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
     diff-lcs (1.1.3)
+    erubis (2.7.0)
     git (1.2.5)
+    hashie (1.2.0)
+    hike (1.2.1)
+    i18n (0.6.0)
     jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
+    journey (1.0.4)
     json (1.7.5)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
     multi_json (1.3.6)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.8)
+      actionmailer (= 3.2.8)
+      actionpack (= 3.2.8)
+      activerecord (= 3.2.8)
+      activeresource (= 3.2.8)
+      activesupport (= 3.2.8)
+      bundler (~> 1.0)
+      railties (= 3.2.8)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
@@ -25,13 +87,25 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (>= 1.0.0)
+  hashie (~> 1.2.0)
   jeweler (>= 1.8.4)
+  rails
   rdoc (>= 3.12)
   rspec (>= 2.8.0)
   simplecov (>= 0.5)

data/README.md

@@ -4,7 +4,7 @@ Popular Javascript Photo galleries/carousels ready to use with Rails 3+.
 
 ## Usage
 
-`gem 'rails-gallery'
+`gem 'rails-gallery'`
 
 ## Galleries included
 
@@ -21,12 +21,11 @@ In `application.css` manifest file:
 
 ```css
 /*
- * require responsive-gallery
- * require gallery/responsive/elastislide
- * require gallery/responsive/style
- * require gallery/slideshow
- * require gallery/galleria
- * require gallery/touch_touch
+ *= require gallery/responsive/elastislide
+ *= require gallery/responsive
+ *= require gallery/slideshow
+ *= require gallery/galleria/classic
+ *= require gallery/touch_touch
 */
 ```
 
@@ -36,7 +35,7 @@ Using Compass, f.ex in `application.css.scss`
 @import 'gallery/responsive/elastislide';
 @import 'gallery/responsive';
 @import 'gallery/slideshow';
-@import 'gallery/galleria';
+@import 'gallery/galleria/classic';
 @import 'gallery/touch_touch';
 ```
 
@@ -46,6 +45,7 @@ In `application.js` manifest file:
 //= require gallery/responsive
 //= require gallery/slideshow
 //= require gallery/galleria
+//= require gallery/galleria/classic
 //= require gallery/touch_touch
 
 //= require jquery/jquery.easing-1.3
@@ -66,6 +66,10 @@ $(function(){
 
 See [TouchTouch](http://tutorialzine.com/2012/04/mobile-touch-gallery/) and [github repo](https://github.com/martinaglv/touchTouch)
 
+```haml
+= touchgal_image photo
+```
+
 ## Minimalistic Slideshow gallery
 
 See [minimalistic-slideshow-gallery](http://tympanus.net/codrops/2010/07/05/minimalistic-slideshow-gallery/) for more info.
@@ -188,12 +192,29 @@ class PropertiesController < ApplicationController
 end
 ```
 
+The RGallery should now also support multiple photo sources for responsive galleries:
+
+```ruby
+@photos.pages.add_photo_w_sources 'banner' => [{src: 'banner-HD', sizing: '2x'}, {src: 'banner-phone', sizing: '100w'}]
+
+Note: See module `RGallery::Pages` class.
+
+# OR
+
+@photos.pages.add_photo_sources 'banner' => [{src: 'banner-HD', sizing: '2x'}], 'logo' => [{src: 'logo-HD', sizing: '2x'}
+
+OR on individual pages
+
+@photos.page(:first).add_photo_sources 'banner' => [{src: 'banner-HD', sizing: '2x'}], 'logo' => [{src: 'logo-HD', sizing: '2x'}
+
+```
+
 This engine comes with a RGallery::Photos` model which can encapsulate your photos for display and allows you to group photos in multiple pages.
 The `RGallery::Photo` class is a base class for describing a photo. 
 
 You should create your own Photo class that inherits from `RGallery::Photo` (or implements the API), which knows how to render and describe your photos.
 
-Here a rough example:
+Here is a rough example:
 
 ```ruby
 class Property
@@ -215,6 +236,13 @@ class Property
       'responsive-gallery/images'
     end
 
+    # The filename of the picture. 
+    # Here it assumes that the id assigned is a Property object, which has a 
+    # method 'picture' which returns the picture id.
+    def filename
+      "property-#{id.picture}"
+    end    
+
     def title
       'property title'
     end
@@ -230,7 +258,18 @@ class Property
 end
 ```
 
-See the `lib/rails-gallery/rgallery/photos.rb
+See the `lib/rails-gallery/rgallery/photos.rb` for details on how to extend this class appropriately to fit your scenario.
+
+*debugging*
+
+In order to help debug the configuration of the photo class, you can use the view_helper methods:
+
+```ruby
+= validate_gallery_photo photo # prints error msg if invalid
+- validate_gallery_photo! photo # raise error if invalid
+```
+
+Or you can include the `RailsGallery::PhotoValidation` module anywhere you want to leverage these methods!
 
 Then in your `properties/show.html.haml`:
 
@@ -274,7 +313,7 @@ There are also some view helpers included in `rails-gallery/view_helper.rb`
 
 `= gallery_image type, photo`
 
-Simple example:
+*Simple example:*
 
 Iterate all photos as a "single page".
 
@@ -283,7 +322,7 @@ Iterate all photos as a "single page".
   = gallery_image :responsive, photo`
 ```
 
-Pages example:
+*Pages example:*
 
 Iterate photos, one page at a time.
 
@@ -292,7 +331,7 @@ Iterate photos, one page at a time.
   = gallery_image :responsive, photo`
 ```
 
-Advanced example:
+*Advanced example:*
 
 Iterate photos, first page visible, then remaining pages invisible.
 
@@ -307,6 +346,37 @@ Iterate photos, first page visible, then remaining pages invisible.
       = gallery_image :responsive, photo`
 ```
 
+### Shortcuts for view helpers
+
+```haml
+# galleria
+= riagal_image photo
+= riagal_imageset photo
+
+# slideshow
+= slidegal_image photo
+= slidegal_imageset photo
+
+# responsive
+= respgal_image photo
+= respgal_imageset photo
+
+# touchtouch
+= touchgal_image photo
+= touchgal_imageset photo
+```
+
+## Responsive images via "image srcset"
+
+The View Helpers also includes tag helpers to create image tags with [srcset](https://github.com/borismus/srcset-polyfill). This can be installed and used with [picturefill-rails](https://github.com/kristianmandrup/picturefill-rails)
+
+Example:
+
+```haml
+- photos.pages.each do |photo|
+  = gallery_imageset :responsive, photo`
+```
+
 Enjoy!
 
 ## Adding more galleries
@@ -321,7 +391,7 @@ Then add gallery client-side pieces to the assets folder following conventions a
 
 ## TODO
 
-Would perhaps be nice to allow pages/albums to have info assigned, such as title and/or description, tags etc. ?
+Would be nice to allow pages/albums to have info assigned, such as title and/or description, tags etc.
 
 ## Contributing to rails-gallery
  

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/app/views/gallery/_galleria.html.haml

@@ -1,4 +1,3 @@
-#galleria
+#galleria.galleria
   - photos.all.each do |photo|
-      %a{href:"/assets/#{photo.path}"}
-        = image_tag photo.path, :"data-title" => photo.title, :"data-description" => photo.description
+    = gallery_image :galleria, photo

data/app/views/gallery/_responsive.html.haml

@@ -10,6 +10,5 @@
       .es-carousel
         %ul
           - photos.all.each do |photo|
-            %li
-              %a{href:"#"}
-                = image_tag photo.thumb, :"data-large" => "/assets/#{photo.path}", :alt => photo.alt, :"data-description" => photo.title
+            = gallery_image :responsive, photo, wrap: true
+                

data/app/views/gallery/_slideshow.html.haml

@@ -13,12 +13,12 @@
     .msg_thumb_wrapper      
       - photos.page(:first).photos.each do |photo|
         %a{href: "#"}
-          = image_tag photo.thumb, alt: "/assets/#{photo.path}"
+          = gallery_image :slideshow photo
     - photos.pages.remainder.each do |page|
       .msg_thumb_wrapper{style: 'display:none'}
         - page.photos.each do |photo|
           %a{href: "#"}
-            = image_tag photo.thumb, alt: "/assets/#{photo.path}"
+            = gallery_image :slideshow, photo
     %a#msg_thumb_next.msg_thumb_next{href: '#'}
     %a#msg_thumb_prev.msg_thumb_prev{href: '#'}
     %a#msg_thumb_close.msg_thumb_close{href: '#'} 

data/lib/rails-gallery.rb

@@ -1,3 +1,4 @@
 require 'rails-gallery/rgallery'
+require 'rails-gallery/photo_validation'
 require 'rails-gallery/view_helper'
 require 'rails-gallery/engine' if defined?(::Rails::Engine)

data/lib/rails-gallery/engine.rb

@@ -2,6 +2,8 @@ module RailsGallery
   module Rails
     class Engine < ::Rails::Engine
       initializer 'rails gallery' do
+        puts "Adding RailsGallery::ViewHelper"
+
         ActionView::Base.send :include, RailsGallery::ViewHelper
       end
     end

data/lib/rails-gallery/photo_validation.rb

@@ -0,0 +1,37 @@
+module RailsGallery
+  module PhotoValidation
+    def validate_gallery_photo photo
+      return "Photo must be a kind of RGallery::Photo, was: #{photo}" unless photo.kind_of?(RGallery::Photo)
+      return 'Photo must have a #path method' unless photo.respond_to? :path
+      return 'Photo must have a #title method' unless photo.respond_to? :title
+
+      begin
+        photo.filename
+        photo.file_path
+      rescue Exception => e
+        return "filename or file_path could not be resolved for: #{photo}, cause: #{e}"
+      end
+
+      return "Photo must have a path: #{photo}" if photo.path.blank?
+      return "Photo must have a title: #{photo}" if photo.title.blank?
+      true
+    end
+
+    def validate_gallery_photo! photo
+      raise ArgumentError, "Photo must be a kind of RGallery::Photo, was: #{photo}" unless photo.kind_of?(RGallery::Photo)
+      raise ArgumentError, 'Photo must have a #path method' unless photo.respond_to? :path
+      raise ArgumentError, 'Photo must have a #title method' unless photo.respond_to? :title
+
+      begin
+        photo.filename
+        photo.file_path
+      rescue Exception => e
+        raise ::RailsGallery::ConfigurationError, "filename or file_path could not be resolved for: #{photo}, cause: #{e}"
+      end
+
+      raise ArgumentError, "Photo must have a path: #{photo}" if photo.path.blank?
+      raise ArgumentError, "Photo must have a title: #{photo}" if photo.title.blank?
+      true
+    end
+  end
+end

data/lib/rails-gallery/rgallery/page.rb

@@ -7,6 +7,39 @@ module RGallery
       super options
     end
 
+    # a source is a hash of the form:
+    # 'banner' => [{src: 'banner-HD', sizing: '2x'}, {src: 'banner-phone', sizing: '100w'}]
+    # see: add_photo_sources
+    def self.from_source sources
+      page = self.create sources.keys, options
+
+      @photos ||= sources.map do |key, srclist| 
+        photo_class.new key, options.merge(:sources => srclist)
+      end
+    end
+
+    def << photo_ids
+      @photo_ids ||= []
+      @photo_ids += [photo_ids].flatten
+    end
+
+    def add_photo_sources sources_hash
+      sources_hash.each do |source|
+        add_photo_w_sources source
+      end
+    end
+
+    def add_photo_w_sources source
+      raise ArgumentError, "Must be a hash, was: #{source}" unless source.kind_of? Hash
+      key = source.keys.first
+      srclist = source.values.first
+      raise ArgumentError, "Hash value must be an Array, was: #{srclist}" unless srclist.kind_of? Array
+
+      self.send :<<, key
+      @photos ||= []
+      @photos << photo_class.new(key, options.merge(:sources => srclist))
+    end
+
     def photo_ids
       @photo_ids ||= []
     end   

data/lib/rails-gallery/rgallery/pages.rb

@@ -23,6 +23,21 @@ module RGallery
       pages << RGallery::Page.new(photo_list, options)
     end
 
+    # a source is a hash of the form:
+    # 'banner' => [{src: 'banner-HD', sizing: '2x'}, {src: 'banner-phone', sizing: '100w'}]
+    def add_photo_w_sources source
+      pages << RGallery::Page.from_source(source, options)
+    end
+
+    # a Hash where each element is a source of the form:
+    # 'banner' => [{src: 'banner-HD', sizing: '2x'}, {src: 'banner-phone', sizing: '100w'}]
+    def add_photo_sources sources_hash
+      sources_hash.each do |source|
+        pages.add_photo_w_sources source
+      end
+    end
+
+
     delegate :empty?, to: :pages
 
     protected