hermitage 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@hermitage --create

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hermitage.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alexander Borovykh
+
+MIT License
+
+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,175 @@
+# Hermitage
+
+Ruby library for generation of image galleries (thumbnails and full size images viewer).
+
+## Requirements
+
+Hermitage requires Ruby on Rails version >= 3.1 with support of jQuery and CoffeeScript (jquery-rails and coffee-rails gems, respectively).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hermitage'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hermitage
+
+Also you have to run installation script to create config file and add require statement to your application.js file.
+
+    rails generate hermitage:install
+
+## Quick Start
+
+Add this line to your view:
+
+    render_gallery_for @images # or any other array of objects with image attachments
+
+It is enough in theory.
+
+## Usage
+
+The example from Quick Start section works well when you are using Paperclip gem for file attachment and your model looks like this:
+
+    class Image < ActiveRecord::Base
+      attr_accessible :file
+      has_attached_file :file, styles: { thumbnail: "100x100>" }
+    end
+
+Then
+
+    render_gallery_for @images
+
+will render markup for the gallery.
+
+In other cases some configuration is necessary.
+
+### Options
+
+You can pass options hash to `render_gallery_for` method if you want to customize Hermitage behavior.
+
+#### Specify Image Path
+
+E.g. your `Photo` model has methods `image_full` and `image_thumb` that return path to full image and its thumbnail, respectively.
+Then you can write in your view file:
+
+    render_gallery_for @photos, attribute_full_size: 'image_full', attribute_thumbnail: 'image_thumb'
+
+Then Hermitage will use the specified methods to get paths to your images and thumbnails.
+
+If the only method returns both paths according to passed parameters you can specify it like this:
+
+    render_gallery_for @posts, attribute_full_size: 'attachment(:full)', attribute_thumbnail: 'attachment(:thumbnail)'
+
+#### Markup
+
+Hermitage renders markup that will look nice with Twitter Bootstrap by default:
+
+    <ul class="thumbnails">
+      <li class="span4">
+        <a href="/path/to/full/image" class="thumbnail" rel="hermitage">
+          <img src="/path/to/thumbnail" />
+        </a>
+      </li>
+    </ul>
+
+You can configure any element of this markup by overwriting `list_tag`, `item_tag`, `list_class`, `item_class`, `link_class` and `image_class` properties.
+
+For example this line of code:
+
+    render_gallery_for @images, list_tag: :div, item_tag: :p, item_class: 'image'
+
+will render the following markup:
+
+    <div class="thumbnails">
+      <p class="image">
+        <a href="/path/to/full/image" class="thumbnail" rel="hermitage">
+          <img src="/path/to/thumbnail" />
+        </a>
+      </p>
+    </div>
+
+### Configuration
+
+It is more handy to use configs to customize Hermitage behavior.
+
+When you call `render_gallery_for` method Hermitage looks for config with name formed by the plural form of class name of the first element in passed array.
+In the example above Hermitage tries to find :images config because first argument of `render_gallery_for` method was array of Image instances.
+If there is no proper config :default config is used.
+
+Hermitage configs are described in config/initializers/hermitage.rb file.
+
+#### Overwrite Defaults
+
+You can overwrite :default config. These changes will be applied to all the galleries in your application.
+
+Uncoment the following lines in config/initializers/hermitage.rb file and make some changes here:
+
+    Hermitage.configs[:default].merge!({
+      attribute_full_size: 'image.url(:medium)',
+      attribute_thumbnail: 'image.url(:small)'
+    })
+
+Now Hermitage will use `image.url` method with :medium or :small argument to get images for the gallery.
+
+#### Custom Configs
+
+When there are several galleries that need different markup it is better to use custom configs.
+
+For example there are 2 models in your application:
+
+    class Picture < ActiveRecord::Base
+      def image_path(style = :large)
+        # magically returns correct image url for :large and :small styles
+      end
+    end
+
+and
+
+    class Post < ActiveRecord::Base
+      attr_accessible :attachment
+      has_attached_file :attachment, styles: { tiny: "200x200>" }
+    end
+
+Suppose that pictures should be rendered with Twitter Bootstrap style, but posts should be wrapped by simple blocks.
+Then your config/initializers/hermitage.rb could looks like this:
+
+    # Some rules for :default config if needed...
+
+    Hermitage.configs[:pictures] = {
+      attribute_full_size: 'image_path',
+      attribute_thumbnail: 'image_path(:small)'
+    }
+
+    Hermitage.configs[:pictures] = {
+      attribute_full_size: 'attachment',
+      attribute_thumbnail: 'attachment(:tiny)',
+      list_tag: :div,
+      item_tag: div,
+      list_class: 'posts',
+      item_class: 'post'
+    }
+
+Now when you write `render_gallery_for @pictures` or `render_gallery_for @posts` Hermitage will automatically choose the proper config.
+
+#### Configs Priority
+
+You have noticed that it is not neccessary to specify every parameter in config or options block.
+So, Hermitage looks for parameters with the following priority:
+
+* It uses all parameters from default config;
+* Then it overwrites some of them by custom config's parameters if they were specified;
+* Finally it overwrites both of them by the values from options hash passed to `render_gallery_for` method (if there are such values, of course).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/app/assets/javascripts/hermitage.js.coffee

@@ -0,0 +1,263 @@
+root = exports ? this
+
+#
+# Data
+#
+
+# Array of images of current gallery
+root.images = []
+
+# Distance between navigation buttons and image
+root.navigation_button_margin = 10
+
+# Color of navigation button's border and symbols
+root.navigation_button_color = "#777"
+
+# Minimum distance between window borders and image
+root.window_padding_x = 50
+root.window_padding_y = 50
+
+# Minimum size of scaled image
+root.minimum_scaled_width = 100
+root.minimum_scaled_height = 100
+
+# Initializes the gallery on this page
+root.init_hermitage = ->
+  # Create simple gallery layer if it doesn't exist
+  if ($("#hermitage").length == 0)
+    hermitage = $("<div>", {id: "hermitage"})
+    $("body").append(hermitage)
+    hermitage.css("z-index", 10)
+    hermitage.hide()
+
+  # Clear old images array
+  images.length = 0
+
+  # Create new images array
+  $.each $('a[rel="hermitage"]'), ->
+    images.push($(this).attr('href'))
+
+  # Set on click handlers to all elements that
+  # have 'hermitage' rel attribute
+  $('a[rel="hermitage"]').click (event) ->
+    open_gallery(this)
+    event.preventDefault()
+
+#
+# Helpers
+#
+
+# Place element at the center of screen
+jQuery.fn.center = () ->
+  this.css("position", "fixed")
+  this.css("top", Math.max(0, (($(window).height() - $(this).outerHeight()) / 2) + $(window).scrollTop()) + "px")
+  this.css("left", Math.max(0, (($(window).width() - $(this).outerWidth()) / 2) + $(window).scrollLeft()) + "px")
+  this
+
+
+#
+# Simple gallery logic
+#
+
+# Creates overlay layer, shows it and sets its click handler
+create_overlay = () ->
+  overlay = $("<div>", {id: "overlay"})
+  $("#hermitage").append(overlay)
+
+  overlay.css("position", "fixed")
+  overlay.css("top", "0")
+  overlay.css("left", "0")
+  overlay.css("background", "#000")
+  overlay.css("display", "block")
+  overlay.css("opacity", "0.75")
+  overlay.css("filter", "alpha(opacity=75)")
+  overlay.css("width", "100%")
+  overlay.css("height", "100%")
+
+  overlay.hide()
+  overlay.fadeIn()
+
+  overlay.click (event) ->
+    close_gallery()
+
+  overlay
+
+
+# Creates base navigation button and returns it
+create_navigation_button = () ->
+  button = $("<div>")
+  $("#hermitage").append(button)
+
+  button.css("position", "fixed")
+  button.css("width", "50px")
+  button.css("display", "block")
+  button.css("cursor", "pointer")
+
+  button.css("border-width", "1px")
+  button.css("border-style", "solid")
+  button.css("border-color", navigation_button_color)
+  button.css("display", "block")
+  button.css("border-radius", "7px")
+  button.css("-webkit-border-radius", "7px")
+  button.css("-moz-border-radius", "7px")
+
+  button.css("color", navigation_button_color)
+  button.css("text-align", "center")
+  button.css("vertical-align", "middle")
+  button.css("font", "30px Tahoma,Arial,Helvetica,sans-serif")
+
+  button.hide()
+
+  button
+
+# Creates right navigation button and returns it
+create_right_navigation_button = () ->
+  button = create_navigation_button()
+  button.attr("id", "navigation-right")
+  button.css("border-top-left-radius", "0")
+  button.css("-webkit-border-top-left-radius", "0")
+  button.css("-moz-border-top-left-radius", "0")
+  button.css("border-bottom-left-radius", "0")
+  button.css("-webkit-border-bottom-left-radius", "0")
+  button.css("-moz-border-bottom-left-radius", "0")
+  button.append(">")
+
+  button.click (event) ->
+    show_next_image()
+
+  button
+
+# Create left navigation button and returns it
+create_left_navigation_button = () ->
+  button = create_navigation_button()
+  button.attr("id", "navigation-left")
+  button.css("border-top-right-radius", "0")
+  button.css("-webkit-border-top-right-radius", "0")
+  button.css("-moz-border-top-right-radius", "0")
+  button.css("border-bottom-right-radius", "0")
+  button.css("-webkit-border-bottom-right-radius", "0")
+  button.css("-moz-border-bottom-right-radius", "0")
+  button.append("<")
+
+  button.click (event) ->
+    show_previous_image()
+
+  button
+
+
+# Shows full size image of the chosen one
+open_gallery = (image) ->
+  $("#hermitage").empty()
+  $("#hermitage").show()
+  create_overlay()
+  create_right_navigation_button()
+  create_left_navigation_button()
+
+  show_image(images.indexOf($(image).attr("href")))
+  
+
+# Shows image with specified index from images array
+show_image = (index) ->
+  # Create full size image at the center of screen
+  img = $("<img />")
+  img.attr("src", images[index])
+  img.attr("class", "current")
+  img.css("cursor", "pointer")
+  img.hide()
+  
+  $("#hermitage").append(img)
+  
+  img.click (event) ->
+    if (event.pageX >= $(window).width() / 2)
+      show_next_image()
+    else
+      show_previous_image()
+
+  # When image will be loaded set correct size,
+  # center element and show it
+  $("<img />").attr("src", images[index]).load ->
+    max_width = $(window).width() - (window_padding_x + $("#navigation-left").outerWidth() + navigation_button_margin) * 2
+    max_height = $(window).height() - window_padding_y * 2
+
+    scale = 1.0
+
+    if (max_width <= minimum_scaled_width || max_height <= minimum_scaled_height)
+      if (max_width < max_height)
+        max_width = minimum_scaled_width
+        max_height = max_width * (this.height / this.width)
+      else
+        max_height = minimum_scaled_height
+        max_width = max_height * (this.width / this.height)
+
+    if (this.width > max_width || this.height > max_height)
+      scale = Math.min(max_width / this.width, max_height / this.height)
+
+    img.width(this.width * scale)
+    img.height(this.height * scale)
+
+    img.center()
+    img.fadeIn()
+    adjust_navigation_buttons()
+
+# Shows next image
+show_next_image = ->
+  current = $("img.current")
+  if (current.length == 1)
+    index = images.indexOf(current.attr("src"))
+    hide_current_image()
+    if (index < images.length - 1)
+      show_image(index + 1)
+    else
+      show_image(0)
+
+# Shows previous image
+show_previous_image = ->
+  current = $("img.current")
+  if (current.length == 1)
+    index = images.indexOf(current.attr("src"))
+    hide_current_image()
+    if (index > 0)
+      show_image(index - 1)
+    else
+      show_image(images.length - 1)
+
+# Hides current image
+hide_current_image = ->
+  current = $("img.current")
+  if (current.length == 1)
+    current.attr("class", "")
+    current.fadeOut 400, ->
+      current.remove()
+
+# Starts fade out animation and clears simple gallery at the end of animation
+close_gallery = () ->
+  $("#hermitage :not(#overlay)").fadeOut()
+  $("#overlay").fadeOut 400, ->
+    $("#hermitage").hide()
+    $("#hermitage").empty()
+
+
+# Moves navigation buttons to proper positions
+adjust_navigation_buttons = () ->
+  left = $("#navigation-left")
+  right = $("#navigation-right")
+
+  current = $(".current")
+
+  left_new_height = current.outerHeight() + "px"
+  left_new_left = (current.position().left - left.outerWidth() - navigation_button_margin) + "px"
+  left_new_top = current.position().top + "px"
+
+  right_new_height = current.outerHeight() + "px"
+  right_new_left = (current.position().left + current.outerWidth() + navigation_button_margin) + "px"
+  right_new_top = current.position().top + "px"
+
+  left.animate({ height: left_new_height, 'line-height': left_new_height, left: left_new_left, top: left_new_top}, 400)
+  right.animate({ height: right_new_height, 'line-height': right_new_height, left: right_new_left, top: right_new_top}, 400)
+
+  left.fadeIn() if (left.css("display") == "none")
+  right.fadeIn() if (right.css("display") == "none")
+
+# Initialize gallery on page load
+$(document).ready(init_hermitage)
+$(document).on('page:load', init_hermitage)

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/hermitage.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hermitage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hermitage'
+  spec.version       = Hermitage::VERSION
+  spec.authors       = ['Alexander Borovykh']
+  spec.email         = ['immaculate.pine@gmail.com']
+  spec.description   = %q{Ruby library for generation of image galleries.}
+  spec.summary       = %q{Ruby library for generation of image galleries (thumbnails and full size images viewer).}
+  spec.homepage      = 'https://github.com/ImmaculatePine/hermitage'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails', '>= 3.2'
+  spec.add_dependency 'jquery-rails'
+  spec.add_dependency 'coffee-rails'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'capybara'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'therubyracer'
+  spec.add_development_dependency 'poltergeist'
+  spec.add_development_dependency 'genspec'
+end

data/lib/generators/hermitage/install_generator.rb

@@ -0,0 +1,17 @@
+module Hermitage
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc 'Creates Hermitage configuration file at config/initializers and adds require statement to application.js file.'
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_initializer
+        template 'hermitage.rb', 'config/initializers/hermitage.rb'
+      end
+
+      def insert_require_into_application_js
+        inject_into_file 'app/assets/javascripts/application.js', "\n//= require hermitage", after: %r{^//= require +['"]?jquery['"]?$}
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# Configuration file for hermitage gem
+
+# Default config is used as base options hash for every gallery.
+# You can configure any of its options and they will be applied for every rendering.
+#
+# Hermitage.configs[:default].merge!({
+#   attribute_full_size: 'file.url',
+#   attribute_thumbnail: 'file.url(:thumbnail)',
+#   list_tag: :ul,
+#   item_tag: :li,
+#   list_class: 'thumbnails',
+#   item_class: 'span4',
+#   link_class: 'thumbnail',
+#   image_class: nil
+# })
+
+# Also you can create your own configs that will be merged with default config to overwrite default options.
+#
+# E.g. when you write
+#
+#   render_gallery_for @images
+#
+# :images config will be used.
+#
+# All available options are listed in default config above.
+#
+# Hermitage.configs[:images] = {
+
+# }

data/lib/hermitage/defaults.rb

@@ -0,0 +1,31 @@
+module Hermitage
+  module Defaults
+    # Model's attribute (or method) that returns the path to the full size image
+    ATTRIBUTE_FULL_SIZE = 'file.url'
+
+    # Model's attribute (or method) that returns the path to the image's thumbnail
+    ATTRIBUTE_THUMBNAIL = 'file.url(:thumbnail)'
+
+    # Wrapper for the whole gallery
+    LIST_TAG = :ul
+
+    # Wrapepr for each gallery item
+    ITEM_TAG = :li
+
+    # CSS classes for elements of markup
+    # (defaults are for pretty look with Twitter Bootstrap)
+    LIST_CLASS = 'thumbnails'
+    ITEM_CLASS = 'span4'
+    LINK_CLASS = 'thumbnail'
+    IMAGE_CLASS = nil
+
+    # Returns hash of default options
+    def self.to_hash
+      hash = {}
+      Hermitage::Defaults.constants.each do |c|
+        hash[c.downcase.to_sym] = Hermitage::Defaults.const_get(c)
+      end
+      hash
+    end
+  end
+end

data/lib/hermitage/engine.rb

@@ -0,0 +1,6 @@
+module Hermitage
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/hermitage/railtie.rb

@@ -0,0 +1,9 @@
+require 'hermitage/view_helpers'
+
+module Hermitage
+  class Railtie < Rails::Railtie
+    initializer 'hermitage.view_helpers' do |app|
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end 
+end

data/lib/hermitage/version.rb

@@ -0,0 +1,3 @@
+module Hermitage
+  VERSION = '0.0.1'
+end