rails-gallery 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec",    ">= 2.8.0"
+  gem "rdoc",     ">= 3.12"
+  gem "bundler",  ">= 1.0.0"
+  gem "jeweler",  ">= 1.8.4"
+  gem "simplecov",">= 0.5"
+end

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  jeweler (>= 1.8.4)
+  rdoc (>= 3.12)
+  rspec (>= 2.8.0)
+  simplecov (>= 0.5)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Kristian Mandrup
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,298 @@
+# Photo Gallery components for Rails
+
+Popular Javascript Photo galleries/carousels ready to use with Rails 3+.
+
+## Usage
+
+`gem 'rails-gallery'
+
+## Galleries included
+
+* slideshow
+* responsive
+* galleria
+
+Please add more using a similar convention as is used for these galleries ;)
+
+## Configuration
+
+In `application.css` manifest file:
+
+```css
+/*
+ * require responsive-gallery
+ * require gallery/responsive/elastislide
+ * require gallery/responsive/style
+ * require gallery/slideshow
+ * require gallery/galleria
+*/
+```
+
+Using Compass, f.ex in `application.css.scss.erb`
+
+```
+@import 'gallery/responsive/elastislide';
+@import 'gallery/responsive/style';
+@import 'gallery/slideshow';
+@import 'gallery/galleria';
+```
+
+In `application.js` manifest file:
+
+```javascript
+//= require gallery/responsive
+//= require gallery/slideshow
+//= require gallery/galleria
+
+//= require jquery.easing-1.3
+//= require jquery.elastislide
+//= require jquery.tmpl.min
+```
+
+## Minimalistic Slideshow gallery
+
+See [minimalistic-slideshow-gallery](http://tympanus.net/codrops/2010/07/05/minimalistic-slideshow-gallery/) for more info.
+
+
+### Customization
+
+Pls Fill in here ;)
+
+## Responsive gallery
+
+See [responsive-image-gallery](http://tympanus.net/codrops/2011/09/20/responsive-image-gallery/) for more info.
+
+### Customization
+
+*Remove thumbnails*
+
+Change `mode = 'carousel'` to `'fullview'`
+
+*Remove 'mode' bar*
+
+```css
+.rg-view{
+  display: none;
+}
+
+.rg-thumbs {
+  padding-top: 10px;
+}
+```
+
+*placement of thumbnails*
+
+To adjust placement of thumbnails, use: `prependTo` or `appendTo` in `gallery/responsive.js`:
+
+``javascript
+  _addImageWrapper= function() {
+    
+    // adds the structure for the large image and the navigation buttons (if total items > 1)
+    // also initializes the navigation events
+    $('#img-wrapper-tmpl').tmpl( {itemsCount : itemsCount} ).prependTo( $rgGallery )
+```
+
+*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 `$esCarousel.elastislide( ‘setCurrent’, current );` (~ line 103):
+
+```javascript
+window.setInterval(function(){
+_navigate( ‘right’ );
+}, 5000);
+```
+
+You just have to change 5000 to the value you want (milliseconds).
+
+## Galleria
+
+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
+
+  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
+      @photos.pages << 6.times.map {|n| (Kernel.rand(7) + 1).to_s }
+    end
+    @photos
+  end
+end
+```
+
+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:
+
+```ruby
+class Property
+  class Photo < RGallery::Photo
+    def path
+      File.join folder, super
+    end
+
+    # mogrify -path fullpathto/temp2 -resize 60x60% -quality 60 -format jpg *.png
+
+    # this will take all png files in your current directory (temp), 
+    # resize to 60% (of largest dimension and keep aspect ratio), 
+    # set jpg quality to 60 and convert to jpg.
+    def thumb
+      File.join folder, 'thumbs', file_path
+    end
+
+    def folder
+      'responsive-gallery/images'
+    end
+
+    def title
+      'property title'
+    end
+
+    def alt
+      'property alt'
+    end
+    
+    def self.extension
+      :jpg
+    end
+  end
+end
+```
+
+See the `lib/rails-gallery/rgallery/photos.rb
+
+Then in your `properties/show.html.haml`:
+
+*Responsive Gallery*
+
+```haml
+= render partial: 'gallery/template/responsive'
+= render partial: 'gallery/responsive', locals: { photos: @property.photos }
+```
+
+Note :Currently only the *responsive* gallery uses a template, and thus requires rendering an extra partial.
+
+*Slideshow Gallery*
+
+```haml
+= render partial: 'gallery/slideshow', locals: { photos: @property.photos }
+```
+
+*Galleria*
+
+```haml
+= render partial: 'gallery/galleria', locals: { photos: @property.photos }
+```
+
+All galleries should follow this convention (or as close as possible)
+
+## Labels
+
+Note that all gallery labels are rendered using Rails I18n `I18n.t`.
+You should include appropriate translations for the following keys under 'rgallery':
+
+* previous
+* next
+* photos_loading
+
+The engine includes a `config/locales/rails_gallery.yml` file, currently only with english translation mappings. Include a `config/locales/rails_gallery.yml` file in your Rails app and override or supply you additional translation mappings ;)
+
+## View helpers
+
+There are also some view helpers included in `rails-gallery/view_helper.rb`
+
+`= gallery_image type, photo`
+
+Simple example:
+
+Iterate all photos as a "single page".
+
+```haml
+- photos.all.each do |photo|
+  = gallery_image :responsive, photo`
+```
+
+Pages example:
+
+Iterate photos, one page at a time.
+
+```haml
+- photos.pages.each do |photo|
+  = gallery_image :responsive, photo`
+```
+
+Advanced example:
+
+Iterate photos, first page visible, then remaining pages invisible.
+
+```haml
+.page.visible
+  - photos.page(:first).photos.each do |photo|
+    = gallery_image :responsive, photo`
+
+- photos.pages.remainder.each do |page|
+  .page.hidden
+    - page.photos.each do |photo|
+      = gallery_image :responsive, photo`
+```
+
+Enjoy!
+
+## Adding more galleries
+
+Simply follow the existing conventions (see the code).
+
+*ViewHelpers*
+
+ Add the gallery name to the `#galleries` class method of the `ViewHelper` and create a module for that gallery with a `[name]_gallery_image(photo)` method.
+
+Then add gallery client-side pieces to the assets folder following conventions and make sure that your css files (and possible js files) references the icons used (and any other asset) correctly  using `/assets/` in the path ;)
+
+## TODO
+
+Would perhaps be nice to allow pages/albums to have info assigned, such as title and/or description, tags etc. ?
+
+## Contributing to rails-gallery
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Kristian Mandrup. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rails-gallery"
+  gem.homepage = "http://github.com/kristianmandrup/rails-gallery"
+  gem.license = "MIT"
+  gem.summary = %Q{Javascript galleries & carousels for instant use with Rails 3+ :)}
+  gem.description = %Q{Adds popular javascript galleries to asset pipeline and includes a few Rails Gallery utils and helpers}
+  gem.email = "kmandrup@gmail.com"
+  gem.authors = ["Kristian Mandrup"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rails-gallery #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

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

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

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

@@ -0,0 +1,15 @@
+#rg-gallery.rg-gallery
+  .rg-thumbs
+    // Elastislide Carousel Thumbnail Viewer
+    .es-carousel-wrapper
+      .es-nav
+        %span.es-nav-prev
+          = t('rgallery.previous')
+        %span.es-nav-next
+          = t('rgallery.next')
+      .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