rails-gallery 0.3.0 → 0.3.1

data/README.md

@@ -53,6 +53,8 @@ In `application.js` manifest file:
 //= require jquery/jquery.tmpl.min
 ```
 
+Note: For galleria, you need to specify the theme to use.
+
 ## Touch-Touch
 
 ```javascript
@@ -105,7 +107,7 @@ Change `mode = 'carousel'` to `'fullview'`
 
 To adjust placement of thumbnails, use: `prependTo` or `appendTo` in `gallery/responsive.js`:
 
-``javascript
+```javascript
   _addImageWrapper= function() {
     
     // adds the structure for the large image and the navigation buttons (if total items > 1)
@@ -116,7 +118,7 @@ To adjust placement of thumbnails, use: `prependTo` or `appendTo` in `gallery/re
 *Automatic slideshow*
 
 I wanted the same thing and I find a way to do it.
-In the file gallery.js, in the function _initCarousel add these lines after: 
+In the file gallery.js, in the function `_initCarousel` add these lines after: 
 
 `$esCarousel.elastislide( 'setCurrent', current );`
 
@@ -155,61 +157,23 @@ $(document).ready(function() {
 
 See [galleria.io](http://galleria.io) for more info.
 
-## Rails engine usage
-
-This gem is a Rails 3+ engine :)
-
-Some *HAML* views (partials) are included in `app/views/gallery`
-
-## Rails views usage
-
-```ruby
-class PropertiesController < ApplicationController
-  def show
-    @property = property
-  end
-
-  protected
+[quick start](http://galleria.io/docs/getting_started/quick_start/)
 
-  def property
-    Hashie::Mash.new  title: 'A beautiful property', 
-                      description: decription,
-                      photos: photos
-  end
+```javascript
+  Galleria.loadTheme('gallery/galleria/classic.min.js');
 
-  def description
-    %q{Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent mauris arcu, auctor ac rhoncus non,  libero. Nulla dolor velit, volutpat a bibendum ut, hendrerit id mi. Pellentesque convallis erat in mi interdum rutrum. Phasellus interdum velit nulla.
-    }
-  end  
+  // configure
+  Galleria.configure({
+      imageCrop: true,
+      transition: 'fade'
+  });  
 
-  def photos
-    @photos ||= RGallery::Photos.new nil, photo_class: Property::Photo
-    5.times do
-      @photos.pages << 6.times.map {|n| (Kernel.rand(7) + 1).to_s }
-    end
-    @photos
-  end
-end
+  Galleria.run('#galleria');
 ```
 
-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'}
-
-```
+### Model Configuration
 
-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 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.
@@ -219,6 +183,11 @@ Here is a rough example:
 ```ruby
 class Property
   class Photo < RGallery::Photo
+    def initialize property, options = {}
+      super
+    end
+    alias_method :property, :obj
+
     def path
       File.join folder, super
     end
@@ -233,22 +202,28 @@ class Property
     end
 
     def folder
-      'responsive-gallery/images'
+      'gallery/images'
+    end
+
+    # Here we expect to create each photo with the 
+    # id being set to a Property object
+    def property
+      id
     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}"
+      "property-#{property.picture}"
     end    
 
     def title
-      'property title'
+      property.title
     end
 
     def alt
-      'property alt'
+      title
     end
     
     def self.extension
@@ -271,10 +246,74 @@ In order to help debug the configuration of the photo class, you can use the vie
 
 Or you can include the `RailsGallery::PhotoValidation` module anywhere you want to leverage these methods!
 
-Then in your `properties/show.html.haml`:
+
+## Rails engine usage
+
+The `RailsGallery::ViewHelper` is inluded into ActionView::Base by the engine.
+
+The following are the main methods exposed:
+
+* gallery_image type, photo
+* gallery_imageset type, photo
+
+Example usage:
+
+```haml
+= gallery_image :responsive, photo`
+= gallery_imageset :galleria, photo`
+```
+
+The photo argument must be a kind of `RGallery::Photo::
+
+### Controller and partials
+
+Some *HAML* views (partials) are included in `app/views/gallery`
+
+### Rails views usage
+
+First set up photos in your controller.
+
+```ruby
+class PropertiesController < ApplicationController
+  def show
+    @property = property
+  end
+
+  protected
+
+  def property
+    Hashie::Mash.new  title: 'A beautiful property', 
+                      description: decription,
+                      photos: photos
+  end
+
+  def description
+    %q{Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent mauris arcu, auctor ac rhoncus non,  libero. Nulla dolor velit, volutpat a bibendum ut, hendrerit id mi. Pellentesque convallis erat in mi interdum rutrum. Phasellus interdum velit nulla.
+    }
+  end  
+
+  def photos
+    @photos ||= RGallery::Photos.new nil, photo_class: Property::Photo
+    5.times do |n|
+      # using a paginator to get a page of properties
+      @photos.pages << Property.page(n)
+    end
+    @photos
+  end
+end
+```
+
+In `property/show.html.haml`, render one of the partials of this gem, sending it the list of photos as a local variable `photo`:
+
+```haml
+.gallery
+  = render partial: 'gallery/gallery', locals: { photos: @property.photos}
+```
 
 *Responsive Gallery*
 
+In your `properties/show.html.haml`:
+
 ```haml
 = render partial: 'gallery/template/responsive'
 = render partial: 'gallery/responsive', locals: { photos: @property.photos }
@@ -309,7 +348,7 @@ The engine includes a `config/locales/rails_gallery.yml` file, currently only wi
 
 ## View helpers
 
-There are also some view helpers included in `rails-gallery/view_helper.rb`
+There are some view helpers included in `rails-gallery/view_helper.rb`
 
 `= gallery_image type, photo`
 
@@ -346,6 +385,25 @@ Iterate photos, first page visible, then remaining pages invisible.
       = gallery_image :responsive, photo`
 ```
 
+## Responsive gallery support
+
+The RGallery also supports 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'}
+
+```
+
 ### Shortcuts for view helpers
 
 ```haml
@@ -368,7 +426,7 @@ Iterate photos, first page visible, then remaining pages invisible.
 
 ## 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)
+The View Helpers 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:
 

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

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

@@ -2,8 +2,8 @@ module RGallery
   class Page < PhotoConfig
     include Enumerable
 
-    def initialize photo_ids = [], options = {}
-      @photo_ids = photo_ids
+    def initialize photo_objs = [], options = {}
+      @photo_objs = photo_objs
       super options
     end
 
@@ -18,9 +18,9 @@ module RGallery
       end
     end
 
-    def << photo_ids
-      @photo_ids ||= []
-      @photo_ids += [photo_ids].flatten
+    def << photo_objs
+      @photo_objs ||= []
+      @photo_objs += [photo_objs].flatten
     end
 
     def add_photo_sources sources_hash
@@ -40,12 +40,12 @@ module RGallery
       @photos << photo_class.new(key, options.merge(:sources => srclist))
     end
 
-    def photo_ids
-      @photo_ids ||= []
+    def photo_objs
+      @photo_objs ||= []
     end   
 
     def photos
-      @photos ||= photo_ids.map {|id| photo_class.new id, options } 
+      @photos ||= photo_objs.map {|obj| photo_class.new obj, options } 
     end   
 
     delegate :empty?, to: :photos 

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

@@ -1,14 +1,16 @@
 module RGallery
   class Photo
-    attr_reader :id, :sizing, :sources, :options
+    attr_reader :obj, :sizing, :sources, :options
 
-    def initialize id, options = {}
-      @id = id
+    def initialize obj, options = {}
+      @obj = obj
       self.sources = options.delete :sources
       @sizing = options.delete :sizing
       @options = options
     end
 
+    alias_method :id, :obj
+
     # map [{src: 'banner-HD.jpeg', sizing: '2x'}, {src: 'banner-phone.jpeg', sizing: '100w'}]
     # into -> "banner-HD.jpeg 2x, banner-phone.jpeg 100w
     def srcset

data/rails-gallery.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "rails-gallery"
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-gallery
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -322,7 +322,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3945990969777321608
+      hash: 1161090395313718102
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: