refinerycms-image-gallery 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "rdoc", ">= 0"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Vinicius Zago
+
+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,49 @@
+# Dynamic Image gallery for Refinery CMS
+
+ This gem is based on refinerycms-page-images gem, with this gem is simple to create a more then one gallery tab in your engines with dynamic columns.
+
+## Requirements
+
+ * refinerycms >= 1.0.8
+ 
+## Features 
+
+ * Select multiple images from the image picker and insert on your engine.
+ * Include dynamic fields in gallery for each engine, this is editable in each image.
+ * Reordering images with a simple drag into order.
+
+## Install
+
+  Add this line to your applications `Gemfile`
+	
+	gem 'refinerycms-image-gallery'
+	
+  Run:
+	
+	bundle install
+	
+## Usage
+ 
+ Creating new gallery for your engine:
+	
+	rails g refinerycms_image_gallery singular_engine_name:gallery_name attribute:type
+	
+  For example, if you wanna create new gallery called Top for Post engine:
+	
+	rails g refinerycms_image_gallery post:top caption:string photographer:string
+	
+  This generate a new tab Top Gallery in Posts engine.
+
+
+  But if you wanna generate a new gallery for a engine that already have a gallery, only do this:
+
+	rails g refinerycms_image_gallery post:bottom
+	
+  This generate a new tab Bottom gallery in Posts engine with the same attributes.
+
+  Note: When you run this line, automaticly generate models, views and run a migrate with relationship between engine and images.
+
+## TODO
+ 
+  * CSS
+  * Implement refinery Modules in generator

data/Rakefile

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+require 'psych'
+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 = "refinerycms-image-gallery"
+  gem.homepage = "http://github.com/ginga/refinerycms-image-gallery"
+  gem.license = "MIT"
+  gem.summary = "Multi-purpose image-gallery for RefineryCMS."
+  gem.description = "Image Gallery for RefineryCMS that supports another fields like author, subtitles etc."
+  gem.email = "mvinicius.zago@gmail.com"
+  gem.authors = ["Vinicius Zago"]
+  gem.executables = ["refinerycms_image_gallery"]
+  gem.files.include 'lib/templates/**/*'
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "refinerycms-image-gallery #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/refinerycms_image_gallery

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'refinerycms-image-gallery.rb'

data/lib/refinerycms-image-gallery.rb

@@ -0,0 +1,275 @@
+class RefinerycmsImageGalleryGenerator < ::Refinery::Generators::EngineInstaller
+  attr_accessor :attributes, :name, :plural_class_name, :plural_name, :file_path
+  
+  source_root Pathname.new(File.expand_path('../templates', __FILE__))
+  
+  ######### Initialize generator with params #########
+  def initialize(*args)
+    super
+    @args = @_initializer.first
+    
+    @title = @args.first.split(":")
+    @name = @title[0]
+    @chunk = @title[1]
+    @attributes = []
+    @column_name = []
+    
+    # For each param include in migration a new column
+    @args.each do |arg|
+      unless @args.first == arg
+        name = arg.split(":")[0]
+        type = arg.split(":")[1]
+        @column_name << name
+        @attributes << Rails::Generators::GeneratedAttribute.new(name, type)
+      end
+    end
+ 
+    # Pluralize and camelize the class name
+    @plural_name = @name.pluralize
+    @plural_class_name = @name.pluralize.camelize
+    
+    # Check if migration already exists
+    @check_migration = ActiveRecord::Base.connection.table_exists?("#{@plural_name}_images")  
+
+    # Create @attributes variable for new gallery
+    if @attributes.empty? && @check_migration
+      @columns_exc = ["id", "#{@name}_id", "image_id", "position", "chunk", "created_at", "updated_at"]
+      "#{@plural_class_name}Image".constantize.column_names.each_with_index do |name, i|
+        type = "#{@plural_class_name}Image".constantize.columns[i].type
+        if @columns_exc.index("#{name}").nil?
+          @attributes << Rails::Generators::GeneratedAttribute.new(name, type)
+        end   
+      end
+    end
+
+    # Define view class path
+    @file_path = "app/views/admin/#{@plural_name}/"
+  end
+  
+  ##############################################################################
+  ############################# GENERATE MIGRATION #############################
+  ##############################################################################
+  
+  ######### Create a migration relationsheep beetween model and images #########
+  def self.next_migration_number(path)
+    ActiveRecord::Generators::Base.next_migration_number(path)
+  end
+
+  def generate_migration
+    unless @check_migration
+      migration_template 'migration.rb', "db/migrate/create_#{plural_name}_images"
+      run "rake db:migrate"
+    end
+  end 
+  
+  ##############################################################################
+  ######################## OVERRIDE FILES IF NECESSARY #########################
+  ##############################################################################
+  
+  ######### Override the image model if not exists ######### 
+  def override_image_model
+    run "rake refinery:override model=image"
+  end unless File.exists?("app/models/image.rb")
+  
+  ######### Override the class model if not exists ######### 
+  def override_class_model
+    unless File.exists?("app/models/#{@name}.rb")
+      run "rake refinery:override model=#{@name}"
+    end
+  end 
+  
+  ######### Override your class admin/_form item if not exists #########
+  def override_class_form
+    unless File.exists?("app/views/admin/#{@plural_name}/_form.html.erb")
+      run "rake refinery:override view=admin/#{plural_name}/_form"
+    end
+  end 
+  
+  ######### Override inset image view if not exists ######### 
+    def override_insert_image
+      run "rake refinery:override view=admin/images/insert"
+    end unless File.exists?("app/views/admin/images/insert.html.erb")
+    
+  ######### Override refinery admin javascript ######### 
+  def override_javascripts
+    run "rake refinery:override javascript=refinery/admin"
+  end unless File.exists?("public/javascripts/refinery/admin.js")
+  
+  ##############################################################################
+  ############################## GENERATE MODELS ###############################
+  ##############################################################################
+  
+  ######### Create relationsheep model #########
+  def create_model
+    unless @check_migration
+      template 'models/model.rb', File.join('app/models', "#{plural_name}_image.rb")
+    end
+  end
+    
+  ######### Insert into models new relations #########
+  def insert_into_model
+    unless @check_migration
+      @columns = []
+      @column_name.each do |column|
+        @columns << ":" + column.to_s + " => image_data['#{column}']"
+      end
+    
+      # Insert into image model
+      insert_into_file "app/models/image.rb", :after => "image_accessor :image\n" do
+        "\thas_many :#{plural_name}_images\n" +
+        "\thas_many :#{plural_name}, :through => :#{plural_name}_images\n"
+      end   
+    
+      # Insert into object model
+      insert_into_file "app/models/#{@name}.rb", :after => "ActiveRecord::Base\n" do
+        "\n\thas_many :#{plural_name}_images\n" +
+        "\thas_many :images, :through => :#{plural_name}_images\n" +
+        "\n\tdef images_attributes=(data)
+      #{plural_class_name}Image.delete_all(:#{@name}_id => self.id)
+      data.each_with_index do | ( k, image_data ), i |
+        if image_data['id'].present?
+          image_gallery = self.#{plural_name}_images.new(
+                                                          :image_id => image_data['id'].to_i, 
+                                                          :position => i, 
+                                                          :chunk => image_data['chunk'], 
+                                                          #{@columns.join(', ')}
+                                                        )
+          self.#{plural_name}_images << image_gallery
+        end
+        self.touch
+      end
+    end\n"
+      end   
+    end
+  end
+  
+  ##############################################################################
+  ########################## GENERATE VIEWS TEMPLATES ##########################
+  ##############################################################################
+  
+  ######### Insert into view image gallery tab #########
+  def add_tab_to_form
+    unless File.exists?("#{file_path}/_images_field_#{@chunk}.html.erb")
+      page_parts = open("app/views/admin/#{@plural_name}/_form.html.erb").grep(/page_parts/)
+      
+      if page_parts.empty?
+        insert_into_file "app/views/admin/#{@plural_name}/_form.html.erb",
+          :before => '<%= render :partial => "/shared/admin/form_actions",' do
+            "\n\t<div class='field'>" +
+              "\n\t\t<div id='page-tabs' class='clearfix ui-tabs ui-widget ui-widget-content ui-corner-all'>" +
+                "\n\t\t\t<ul id='page_parts'>" +
+                  "\n\t\t\t\t<li class='ui-state-default'>" +
+                    "\n\t\t\t\t\t<%= link_to '#{@chunk.camelize} Gallery', '##{@chunk}_gallery' %>" +
+                  "\n\t\t\t</li>"+
+                "\n\t\t\t</ul>" +
+                
+                "\n\n\t\t\t<div id='page_part_editors'>" +
+                  "\n\t\t\t\t<div class='page_part' id='#{@chunk}_gallery'>" +
+                    "\n\t\t\t\t\t<%= render :partial => 'images', :locals => { :f => f, :chunk_name => '#{@chunk}' } -%>" +
+                  "\n\t\t\t\t</div>" +
+                "\n\t\t\t</div>" +
+              "\n\t\t</div>" +
+            "\n\t</div>\n"
+        end 
+      else
+        insert_into_file "app/views/admin/#{@plural_name}/_form.html.erb",
+          :after => "<ul id='page_parts'>" do
+            "\n\t\t<li class='ui-state-default'>" +
+              "\n\t\t\t<%= link_to '#{@chunk.camelize} Gallery', '##{@chunk}_gallery' %>" +
+            "\n\t\t</li>"
+        end 
+  
+        insert_into_file "app/views/admin/#{@plural_name}/_form.html.erb",
+          :after => "<div id='page_part_editors'>" do
+            "\n\t\t<div class='page_part' id='#{@chunk}_gallery'>" +
+              "\n\t\t\t<%= render :partial => 'images', :locals => { :f => f, :chunk_name => '#{@chunk}' } -%>" +
+            "\n\t\t</div>"
+        end
+      end
+    end
+  end
+  
+  ######### Insert into form partial the javascripts and css #########
+  def add_js_and_css_to_form
+    unless @check_migration
+      page_options = open("app/views/admin/#{@plural_name}/_form.html.erb").grep(/content_for :javascripts/)
+      
+      if page_options.empty?
+        insert_into_file "app/views/admin/#{@plural_name}/_form.html.erb",
+          :before => "<%= form_for" do
+            "<% content_for :javascripts do %>" +
+              "\n\t<script>" +
+                "\n\t\t$(document).ready(function(){" +
+                  "\n\t\t\tpage_options.init(false, '', '');" +
+                "\n\t\t});" +
+              "\n\t</script>"+
+              "\n\t<%= javascript_include_tag 'gallery' %>" +
+            "\n<% end %>" +
+          
+            "\n\n<% content_for :stylesheets do %>" +
+              "\n\t<%= stylesheet_link_tag 'gallery' %>" +
+            "\n<% end %>\n\n"
+        end
+      else
+        insert_into_file "app/views/admin/#{@plural_name}/_form.html.erb",
+          :after => "<% content_for :javascripts do %>" do
+            "\n\t<%= javascript_include_tag 'gallery' %>"
+        end
+        
+        insert_into_file "app/views/admin/#{@plural_name}/_form.html.erb",
+          :before => "<% content_for :javascripts do %>" do
+            "\n<% content_for :stylesheets do %>" +
+              "\n\t<%= stylesheet_link_tag 'gallery' %>" +
+            "\n<% end %>\n"
+        end
+      end
+    end
+  end
+  
+  ######### Insert into insert image template new params #########
+  def insert_image_params
+    unless @check_migration
+      insert_into_file "app/views/admin/images/insert.html.erb",
+        :after => 'image_dialog.init(<%= @callback.present? ? "self.parent.#{@callback}" : "null" %>' do
+          ", '<%= params[:chunk] %>'"
+      end
+    end
+  end
+  
+  ######### Create view partial templates for images in gallery #########
+  def create_view_templates
+    unless @check_migration
+      template 'views/images.html.erb', File.join(file_path, "_images.html.erb")
+      template 'views/image.html.erb', File.join(file_path, "_image.html.erb")
+      template 'views/images_field.html.erb', File.join(file_path, "_images_field_#{@chunk}.html.erb")
+    else
+      unless File.exists?("#{file_path}/_images_field_#{@chunk}.html.erb")
+        template 'views/images_field.html.erb', File.join(file_path, "_images_field_#{@chunk}.html.erb")
+      end
+    end
+  end
+  
+  ##############################################################################
+  ########################## GENERATE JAVASCRIPTS/CSS ##########################
+  ##############################################################################
+
+  ######### Inserto into admin javascript chunk params #########
+  def insert_chunk_admin_js
+    js_admin_path = "public/javascripts/refinery/admin.js"
+    unless @check_migration
+      insert_into_file "#{js_admin_path}","\n, chunk: null", :after => ", callback: null"
+      insert_into_file "#{js_admin_path}", ",chunk", :after => ", init: function(callback"  
+      insert_into_file "#{js_admin_path}","\n\t\tthis.chunk = chunk;", :after => "this.callback = callback;"
+      insert_into_file "#{js_admin_path}", ", this.chunk", :after => "this.callback(img_selected"
+    end
+  end
+
+  def copy_javascript
+    template "javascripts/gallery.js", File.join("public/javascripts", "gallery.js") unless @check_migration
+  end unless File.exists?("public/javascripts/gallery.js")
+  
+  def copy_css
+    template "stylesheets/gallery.css", File.join("public/stylesheets", "gallery.css")  unless @check_migration
+  end unless File.exists?("public/stylesheets/gallery.css")
+
+end

data/lib/templates/javascripts/coffeescripts/gallery.coffee

@@ -0,0 +1,91 @@
+# Function to Add New Image
+image_added = (image, chunk) ->
+  image_id = $(image).attr('id').replace 'image_', '' # Get image id for new list item id
+  new_list = $("li.empty_#{chunk}").clone() # Clone empty li to new list
+  new_list.find('input').next().val image_id # Set input image_id value = image_id
+  new_list.find('span').html($(image).attr('alt'))
+
+  # Set random values items id/name
+  id = parseInt(image_id + Math.random() * 101)
+  $('input', new_list).each (i,input) ->
+    input = $(input)
+    input.attr('name', input.attr('name').replace(/images_attributes\]\[[\d]+/, "images_attributes][" + id))
+    input.attr('id', input.attr('id').replace(/images_attributes_[\d]+/, "images_attributes_" + id))
+
+  # Append thumb to new list
+  img = $("<img />").attr({
+    title: $(image).attr('title')
+    , alt: $(image).attr('alt')
+    , src: $(image).attr('data-grid')
+  }).appendTo(new_list)
+
+  # Get dynamic items and set id/val
+  dynamic_items = new_list.find "#dynamic_items"
+  dynamic_items.attr 'id', "dynamic_items_#{image_id}"
+  dynamic_items.find("input").val ""
+
+  # Remove class and show new list
+  new_list.attr('id', "image_#{image_id}").removeClass 'empty'
+  new_list.attr('id', "image_#{image_id}").removeClass "empty_#{chunk}"
+  new_list.show()
+
+  # Append new list to correct gallery
+  target = "#page_images_#{chunk}"
+  new_list.appendTo target
+
+# Function to edit image fields
+jQuery ->
+  # Edit image fields
+  $('.edit_image').live 'click', ->
+    image_id = $(this).parents().parents().attr('id').replace 'image_', '' # Get image id
+    items = $(this).parents().parents().find("#dynamic_items_#{image_id}")[0] # Get dynamic items of this list
+    open_edit_image items, image_id # Call function open modal
+
+  # Delete image from gallery
+  $('.delete_image').live 'click', ->
+    rm = confirm "Are you sure delete this image?"
+    if(rm == true)
+      $(this).parents('li').first().remove()
+    else
+      return false
+
+  # Reoder images
+  $('li.image_field').live 'hover', ->
+    chunk = $(this).find('input').first().val()
+    $("#page_images_#{chunk}").sortable()
+
+# Dialog dynamic items
+open_edit_image = (items, image_id) ->
+  # Clone dynamic fields for modal
+  fields = $(items).clone()
+  input = fields.find('input')
+
+  # For each input create a textarea for edit
+  input.each (i, inp) ->
+    title = $(inp).attr('class').replace 'edit_items_', ''
+    value = $(inp).val()
+    $(inp).after $("<div id='image#{image_id}_title_#{title}'><span class='ui-dialog-title' id='ui-dialog-title-1' style='width: 300px; background: #22A7F2;float:left;'>#{title}</span><textarea style='width: 290px; height: 30px;'>#{value}</textarea></div>")
+
+  # Input a submit button
+  input.after($("<div class='form-actions'><div class='form-actions-left'><a class='button' id='insert_fields'>Insert<a></div></div>"))
+
+  # Open the dialog modal
+  fields.dialog({
+               title: "Edit Image Fields",
+               modal: true,
+               resizable: false,
+               autoOpen: true,
+               height:300
+  })
+
+  # Insert click function
+  $('a#insert_fields').click ->
+    # For each input get the textarea value and change input value
+    input.each (i, inp) ->
+      title = $(inp).attr('class').replace 'edit_items_', ''
+      input_val = $(items).find("input.edit_items_#{title}")
+      input_val.val $("div#image#{image_id}_title_#{title}").find("textarea").val()
+      fields.dialog('close')
+
+    # Remove cloned div after close
+    fields.remove()

data/lib/templates/javascripts/gallery.js

@@ -0,0 +1,82 @@
+/* DO NOT MODIFY. This file was compiled Thu, 22 Sep 2011 19:50:13 GMT from
+ * /Users/vinicius/workspace/gem-gallery-image/app/coffeescripts/gallery.coffee
+ */
+
+var image_added, open_edit_image;
+image_added = function(image, chunk) {
+  var dynamic_items, id, image_id, img, new_list, target;
+  image_id = $(image).attr('id').replace('image_', '');
+  new_list = $("li.empty_" + chunk).clone();
+  new_list.find('input').next().val(image_id);
+  new_list.find('span').html($(image).attr('alt'));
+  id = parseInt(image_id + Math.random() * 101);
+  $('input', new_list).each(function(i, input) {
+    input = $(input);
+    input.attr('name', input.attr('name').replace(/images_attributes\]\[[\d]+/, "images_attributes][" + id));
+    return input.attr('id', input.attr('id').replace(/images_attributes_[\d]+/, "images_attributes_" + id));
+  });
+  img = $("<img />").attr({
+    title: $(image).attr('title'),
+    alt: $(image).attr('alt'),
+    src: $(image).attr('data-grid')
+  }).appendTo(new_list);
+  dynamic_items = new_list.find("#dynamic_items");
+  dynamic_items.attr('id', "dynamic_items_" + image_id);
+  dynamic_items.find("input").val("");
+  new_list.attr('id', "image_" + image_id).removeClass('empty');
+  new_list.attr('id', "image_" + image_id).removeClass("empty_" + chunk);
+  new_list.show();
+  target = "#page_images_" + chunk;
+  return new_list.appendTo(target);
+};
+jQuery(function() {
+  $('.edit_image').live('click', function() {
+    var image_id, items;
+    image_id = $(this).parents().parents().attr('id').replace('image_', '');
+    items = $(this).parents().parents().find("#dynamic_items_" + image_id)[0];
+    return open_edit_image(items, image_id);
+  });
+  $('.delete_image').live('click', function() {
+    var rm;
+    rm = confirm("Are you sure delete this image?");
+    if (rm === true) {
+      return $(this).parents('li').first().remove();
+    } else {
+      return false;
+    }
+  });
+  return $('li.image_field').live('hover', function() {
+    var chunk;
+    chunk = $(this).find('input').first().val();
+    return $("#page_images_" + chunk).sortable();
+  });
+});
+open_edit_image = function(items, image_id) {
+  var fields, input;
+  fields = $(items).clone();
+  input = fields.find('input');
+  input.each(function(i, inp) {
+    var title, value;
+    title = $(inp).attr('class').replace('edit_items_', '');
+    value = $(inp).val();
+    return $(inp).after($("<div id='image" + image_id + "_title_" + title + "'><span class='ui-dialog-title' id='ui-dialog-title-1' style='width: 300px; background: #22A7F2;float:left;'>" + title + "</span><textarea style='width: 290px; height: 30px;'>" + value + "</textarea></div>"));
+  });
+  input.after($("<div class='form-actions'><div class='form-actions-left'><a class='button' id='insert_fields'>Insert<a></div></div>"));
+  fields.dialog({
+    title: "Edit Image Fields",
+    modal: true,
+    resizable: false,
+    autoOpen: true,
+    height: 300
+  });
+  return $('a#insert_fields').click(function() {
+    input.each(function(i, inp) {
+      var input_val, title;
+      title = $(inp).attr('class').replace('edit_items_', '');
+      input_val = $(items).find("input.edit_items_" + title);
+      input_val.val($("div#image" + image_id + "_title_" + title).find("textarea").val());
+      return fields.dialog('close');
+    });
+    return fields.remove();
+  });
+};