ecm_pictures 0.0.21 → 1.0.0.pre

data/README.rdoc

@@ -12,21 +12,37 @@ in your ruby on rails applictation. Orangebox is used for lightbox support.
   * Lightbox support.
   * Picture and Gallery sorting.
 
+
 = Installation
 
+
 Add it to your gemfile:
 
+  # Gemfile
   gem 'ecm_pictures'
   
 Install your bundle:
 
   > bundle install
   
-Update your layout to include the needed css and javascript:
+Generate initializer:
+
+  > rails generate ecm:pictures:install 
+
+Generatre the migrations:
+
+  > rake ecm_pictures_engine:install:migrations
+
+Migrate:
+
+  > rake db:migrate
+
+  
+== Optional: Generate locale files
+
+You may want to copy the locales to your app:
 
-  <!-- ecm pictures -->
-  <%= javascript_include_tag "ecm_pictures" %>
-  <%= stylesheet_link_tag "ecm_pictures" %>
+  > rails generate ecm:pictures:locales
   
 = Usage
 

data/app/helpers/ecm/pictures_helper.rb

@@ -3,65 +3,68 @@ module Ecm::PicturesHelper
   #
   # = Usage
   #
-  # Assume you have created a picture gallery named "Holidays 2012". You can 
+  # Assume you have created a picture gallery named "Holidays 2012". You can
   # render it in your view as follows:
-  # 
+  #
   #  <%= render_picture_gallery 'Holidays 2012' %>
   def render_picture_gallery(name, options = {})
-    begin  
+    begin
       options = {:preview_style => :thumb}.merge(options)
-      
+
       gallery = Ecm::Pictures::PictureGallery.where(:name => name.to_s).first
       gallery_identifier = gallery.to_param rescue 'missing'
 
-      content_tag(:div, :class => 'picture-gallery', :id => "picture-gallery-#{gallery_identifier}") do
-        if gallery.nil?
-          content_tag(:span, :class => 'warning') do
-            I18n.t('ecm.pictures.warnings.missing_gallery', :name => name.to_s)
-          end      
-        else
-          content_tag(:h1, gallery.name) +
-          content_tag(:p, gallery.description, {:class => 'picture-gallery-description'}) +
-          content_tag(:ul, {:class => 'pictures'}) do
-            gallery.pictures.collect do |picture|
-             content_tag(:li, {:class => 'picture', :id => "picture-#{picture.to_param}"}) do
-                concat(content_tag(:h2, picture.name, :class => 'picture-name')) unless picture.name.blank?
-                
-                # Check if we should link images or not.
-                if gallery.link_images
-                  link_options = build_link_options_for_picture_in_gallery(gallery_identifier, picture)
-                  concat(link_to(image_tag(picture.image.url(options[:preview_style]), :alt => picture.description), "#{picture.image.url}#{File.extname(picture.image_file_name)}", link_options))
-                else 
-                  concat(image_tag(picture.image.url(options[:preview_style]), :alt => picture.description))
-                end
-                concat(content_tag(:div, picture.description, :class => 'picture-description'))
-              end
-            end.join.html_safe
-          end.html_safe
+      if gallery.nil?
+        content_tag(:div, :class => 'warning missing picture-gallery') do
+          content_tag(:p, I18n.t('ecm.pictures.picture_gallery.warnings.missing', :name => name.to_s))
         end
-      end.html_safe
+      else
+        render gallery
+      end
+
     rescue Exception => e
       return e.message
-    end  
+    end
   end
-  
+
   # helper method to build link options for images inside a gallery.
   def build_link_options_for_picture_in_gallery(gallery_identifier, picture)
     link_options = {}
-    
+
     # Add gallery identifier for orange box
-    link_options = { :rel => "lightbox[#{gallery_identifier}]" }
-    
+    link_options[:rel] = "lightbox[#{gallery_identifier}]"
+
+    # Add thumbnail class for twitter bootstrap
+    link_options[:class] = "thumbnail"
+
     # build the caption
     caption = ""
-    caption << "<span class=\"caption-name\">#{picture.name}</span>" unless picture.name.blank?
-    caption << "<span class=\"caption-description\">#{picture.description}</span>" unless picture.description.blank?   
+    caption << "<div class=\"caption-name\">#{picture.name}</div>" unless picture.name.blank?
+    caption << "<div class=\"caption-description\">#{picture.description}</div>" unless picture.description.blank?
     link_options[:"data-ob_caption"] = caption if caption.size > 0
-    
+
     return link_options
   end
-  
+
   # TODO: Implement this.
   def render_picture(name, options = {})
+    begin
+      options = {:preview_style => :thumb}.merge(options)
+
+      picture = Ecm::Pictures::Picture.where(:name => name.to_s).first
+      # gallery_identifier = gallery.to_param rescue 'missing'
+
+      if picture.nil?
+        content_tag(:div, :class => 'warning missing picture') do
+          content_tag(:p, I18n.t('ecm.pictures.picture.warnings.missing', :name => name.to_s))
+        end
+      else
+        render picture
+      end
+
+    rescue Exception => e
+      return e.message
+    end
   end
 end
+

data/app/helpers/markup_helper.rb

@@ -0,0 +1,7 @@
+module MarkupHelper
+  def mu(object, method)
+    handler = object.send(method)
+    erb_string = ::ERB.new(object[method.to_sym].to_s, 0).result(binding())
+    return handler.class.new(erb_string).to_html.html_safe
+  end  
+end

data/app/models/ecm/pictures/picture.rb

@@ -7,14 +7,19 @@ class Ecm::Pictures::Picture < ActiveRecord::Base
   # attributes
   attr_accessible :description,
                   :image,
+                  :markup_language,
                   :name,
                   :picture_gallery_id,
                   :position
 
   # acts as list
   acts_as_list :scope => :picture_gallery
+
+  # acts as markup
+  acts_as_markup :language => :variable, :columns => [ :description, :description ]
   
   # callbacks
+  after_initialize :set_defaults
   before_validation :set_name_from_image_file_name, :if => Proc.new { |p| ( p.name.nil? || p.name.empty? ) }
 
   # default scope
@@ -26,14 +31,30 @@ class Ecm::Pictures::Picture < ActiveRecord::Base
 
   # paperclip
   has_attached_file :image,
-                    :styles => { :medium => "300x300>", :thumb => "100x100>" }
+                    :styles => Ecm::Pictures::Configuration.picture_image_styles
 
   # validations
   # validates :image, :attachment_presence => true
   validates_attachment_presence :image
+  validates :markup_language, :presence  => true,
+                              :inclusion => Ecm::Pictures::Configuration.markup_languages
   validates :name, :presence => true
+
+  def display_code
+    "<%= render_picture '#{self.name}' %>"
+  end
+
+  def to_s
+    name
+  end
   
   private
+
+  def set_defaults
+    if self.new_record?
+      self.markup_language ||= Ecm::Pictures::Configuration.default_markup_language
+    end
+  end
   
   def set_name_from_image_file_name
     self.name = File.basename(image_file_name, File.extname(image_file_name)) unless image_file_name.nil?

data/app/models/ecm/pictures/picture_gallery.rb

@@ -9,6 +9,7 @@ class Ecm::Pictures::PictureGallery < ActiveRecord::Base
   # attributes
   attr_accessible :description,
                   :link_images,
+                  :markup_language,
                   :name,
                   :pictures_attributes,
                   :position
@@ -18,6 +19,9 @@ class Ecm::Pictures::PictureGallery < ActiveRecord::Base
   acts_as_list
   default_scope :order => 'position ASC'
 
+  # acts as markup
+  acts_as_markup :language => :variable, :columns => [ :description ]
+
   # callbacks
   after_initialize :set_defaults
 
@@ -26,6 +30,8 @@ class Ecm::Pictures::PictureGallery < ActiveRecord::Base
   friendly_id :name, :use => :slugged
 
   # validations
+  validates :markup_language, :presence  => true,
+                              :inclusion => Ecm::Pictures::Configuration.markup_languages
   validates :name, :presence => true,
                    :uniqueness => true
 
@@ -33,11 +39,16 @@ class Ecm::Pictures::PictureGallery < ActiveRecord::Base
     "<%= render_picture_gallery '#{self.name}' %>"
   end
 
+  def to_s
+    name
+  end
+
   private
 
   def set_defaults
-    if new_record?
+    if self.new_record?
       self.link_images = true if self.link_images.nil?
+      self.markup_language ||= Ecm::Pictures::Configuration.default_markup_language
     end
   end
 end

data/app/views/ecm/pictures/picture_galleries/_picture_gallery.html.erb

@@ -0,0 +1,12 @@
+<div class="picture-gallery" id="picture-gallery-<%= picture_gallery.id %>">
+  <div class="picture-gallery-description">
+    <%= mu picture_gallery, :description %>
+  </div>
+  <div class="picture-gallery_pictures row-fluid">
+    <ul class="thumbnails">
+      <% picture_gallery.pictures.each do |picture| %>
+        <%= render :partial => 'ecm/pictures/pictures/picture_for_gallery', :locals => { :picture => picture } %>
+      <% end %>
+    </ul>
+  </div>
+</div>

data/app/views/ecm/pictures/picture_galleries/_picture_gallery_for_index.html.erb

@@ -0,0 +1,12 @@
+<div class="thumbnail picture_gallery-preview span3" id="picture-gallery-<%= picture_gallery.id %>">
+  <div class="picture-image">
+    <%= image_tag picture_gallery.pictures.first.image.url(:default_thumb) %>  
+  </div>
+  <div class="caption"> 
+    <h3><%= picture_gallery.name %></h3>
+    <div class="description"><%= mu(picture_gallery, :description) %></div>
+    <%= link_to t('ecm.pictures.actions.view'), picture_gallery, :class => 'btn btn-primary' %>
+    <span class="pull-right small picture-count"><%= Ecm::Pictures::PictureGallery.human_attribute_name(:pictures) %>: <%= picture_gallery.pictures_count %></span> 
+  </div> 
+</div>
+

data/app/views/ecm/pictures/pictures/_picture.html.erb

@@ -0,0 +1,7 @@
+<div class="row">
+  <div class="picture span3" id="picture-<%= picture.to_param %>">
+    <%= link_to("#{picture.image.url}#{File.extname(picture.image_file_name)}", :class => 'thumbnail') do %>
+      <%= image_tag(picture.image.url(:default_thumb)) %>
+    <% end %>
+  </div>
+</div>

data/app/views/ecm/pictures/pictures/_picture_for_gallery.html.erb

@@ -0,0 +1,9 @@
+<li class="span4 picture" id="picture-<%= picture.to_param %>">
+  <% if picture.picture_gallery.link_images %>
+    <%= link_to("#{picture.image.url}#{File.extname(picture.image_file_name)}", :class => 'thumbnail') do %>
+      <%= image_tag(picture.image.url(:default_thumb)) %>
+    <% end %>
+  <% else %>
+    <%= image_tag(picture.image.url(:default_thumb), :class => 'thumbnail') %>
+  <% end %>
+</li>

data/config/locales/ecm.pictures.de.yml

@@ -1,7 +1,15 @@
 de:
+  back: Zurück
   ecm:
     pictures:
+      actions:
+        view: Anzeigen
       active_admin:
-        menu: "Bilder" 
-      warnings:
-        missing_gallery: "Die Gallerie %{name} wurde nicht gefunden."
+        menu: "Bilder"
+      picture:
+        warnings:
+          missing: "Das Bild %{name} wurde nicht gefunden."
+      picture_gallery:
+        warnings:
+          missing: "Die Galerie %{name} wurde nicht gefunden."
+

data/config/locales/ecm.pictures.en.yml

@@ -0,0 +1,15 @@
+en:
+  back: back
+  ecm:
+    pictures:
+      actions:
+        view: view
+      active_admin:
+        menu: pictures
+      picture:
+        warnings:
+          missing_gallery: "Could not find picture %{name}"
+      picture_gallery:
+        warnings:
+          missing_gallery: "Could not find picture gallery %{name}"
+

data/config/locales/ecm.pictures.picture.de.yml

@@ -8,13 +8,15 @@ de:
       ecm/pictures/picture:
         created_at: Erstellt am
         description: Beschreibung
+        display_code: Anzeigecode
         image: Datei
         image_file: Datei
         image_file_name: Dateiname
         image_file_size: Größe
         image_fingerprint: Fingerabdruck
+        markup_language: Markup Sprache
         name: Name
-        picture_gallery: Gallerie
+        picture_gallery: Galerie
         position: Position
         thumbnail: Vorschau
         updated_at: Aktualisiert am

data/config/locales/ecm.pictures.picture.en.yml

@@ -0,0 +1,23 @@
+en:
+  activerecord:
+    models:
+      ecm/pictures/picture:
+        one: picture
+        other: pictures
+    attributes:
+      ecm/pictures/picture:
+        created_at: created at
+        description: description
+        display_code: display code
+        image: image
+        image_file: image
+        image_file_name: image filename
+        image_file_size: image size
+        image_fingerprint: image fingerprint
+        markup_language: markup language
+        name: name
+        picture_gallery: picture gallery
+        position: position
+        thumbnail: thumbnail
+        updated_at: updated at
+

data/config/locales/ecm.pictures.picture_gallery.de.yml

@@ -2,14 +2,15 @@ de:
   activerecord:
     models:
       ecm/pictures/picture_gallery:
-        one: Bildgallerie
-        other: Bildgallerien
+        one: Bildgalerie
+        other: Bildgalerien
     attributes:
       ecm/pictures/picture_gallery:
         created_at: Erstellt am
         description: Beschreibung
         display_code: Anzeigecode
         link_images: Bilder verlinken
+        markup_language: Markup Sprache
         name: Name
         pictures: Bilder
         pictures_count: Bilder

data/config/locales/ecm.pictures.picture_gallery.en.yml

@@ -0,0 +1,19 @@
+en:
+  activerecord:
+    models:
+      ecm/pictures/picture_gallery:
+        one: picture gallery
+        other: picture galleries
+    attributes:
+      ecm/pictures/picture_gallery:
+        created_at: created at
+        description: description
+        display_code: display code
+        link_images: link images
+        markup_language: markup language
+        name: name
+        pictures: pictures
+        pictures_count: pictures
+        position: position
+        updated_at: updated at
+

data/db/migrate/001_create_ecm_pictures_picture_galleries.rb

@@ -4,10 +4,15 @@ class CreateEcmPicturesPictureGalleries < ActiveRecord::Migration
       t.string :name
       t.text :description
       t.boolean :link_images
-      t.integer :pictures_count
+
+      # associations
+      t.integer :pictures_count, :default => 0, :null => false
       
       # acts as list
       t.integer :position
+
+      # acts as markup
+      t.string :markup_language
       
       # friendly id
       t.string :slug

data/db/migrate/002_create_ecm_pictures_pictures.rb

@@ -3,9 +3,15 @@ class CreateEcmPicturesPictures < ActiveRecord::Migration
     create_table :ecm_pictures_pictures do |t|
       t.string :name
       t.text :description
+
+      # associations
+      t.references :picture_gallery
       
       # acts as list
       t.integer :position
+
+      # acts as markup
+      t.string :markup_language
       
       # friendly id
       t.string :slug
@@ -17,9 +23,6 @@ class CreateEcmPicturesPictures < ActiveRecord::Migration
       t.string :image_content_type
       t.timestamp :image_updated_at
       t.string :image_fingerprint
-      
-      # references
-      t.references :picture_gallery
 
       t.timestamps
     end

data/lib/ecm/pictures/active_admin/ecm_pictures_picture_galleries.rb

@@ -13,14 +13,22 @@ ActiveAdmin.register Ecm::Pictures::PictureGallery do
       f.input :link_images
     end
 
+    f.inputs do
+      f.input :markup_language, :as => :select, :collection => Ecm::Pictures::Configuration.markup_languages
+    end
+
    f.inputs do
     f.has_many :pictures do |p|
       p.input :name
       if p.object.persisted?
         p.input :_destroy, :as => :boolean, :label => I18n.t('active_admin.delete')
       end
-      p.input :image, :as => :file, :hint => p.template.image_tag(p.object.image.url(:thumb))
+      p.input :image, :as => :file, :hint => p.template.image_tag(p.object.image.url(:default_thumb))
       p.input :description
+
+      p.inputs do
+        p.input :markup_language, :as => :select, :collection => Ecm::Pictures::Configuration.markup_languages
+      end
     end
   end
 
@@ -42,7 +50,7 @@ ActiveAdmin.register Ecm::Pictures::PictureGallery do
   show do
     panel Ecm::Pictures::PictureGallery.human_attribute_name(:description) do
       div do
-        ecm_pictures_picture_gallery.description
+        mu ecm_pictures_picture_gallery, :description
       end
     end
 
@@ -56,7 +64,7 @@ ActiveAdmin.register Ecm::Pictures::PictureGallery do
       table_for ecm_pictures_picture_gallery.pictures, :i18n => Ecm::Pictures::Picture do
         sortable_columns
         column :thumbnail do |picture|
-          link_to(image_tag(picture.image.url(:thumb)), admin_ecm_pictures_picture_path(picture))
+          link_to(image_tag(picture.image.url(:default_thumb)), [:admin, picture])
         end
         column :name
         column :image_file_size, :sortable => :image_file_size do |picture|

data/lib/ecm/pictures/active_admin/ecm_pictures_pictures.rb

@@ -15,13 +15,17 @@ ActiveAdmin.register Ecm::Pictures::Picture do
       f.input :description
     end
 
+    f.inputs do
+      f.input :markup_language, :as => :select, :collection => Ecm::Pictures::Configuration.markup_languages
+    end
+
     f.buttons
   end
 
   index do
     selectable_column
     column :thumbnail do |picture|
-      link_to(image_tag(picture.image.url(:thumb)), admin_ecm_pictures_picture_path(picture))
+      link_to(image_tag(picture.image.url(:default_thumb)), admin_ecm_pictures_picture_path(picture))
     end
     column :picture_gallery
     column :name
@@ -39,7 +43,13 @@ ActiveAdmin.register Ecm::Pictures::Picture do
 
     panel Ecm::Pictures::Picture.human_attribute_name(:description) do
       div do
-        ecm_pictures_picture.description
+        mu ecm_pictures_picture, :description
+      end
+    end
+
+    panel Ecm::Pictures::Picture.human_attribute_name(:display_code) do
+      div do
+        ecm_pictures_picture.display_code
       end
     end
   end

data/lib/ecm/pictures/configuration.rb

@@ -9,6 +9,17 @@ module Ecm
         yield self
       end
 
+      mattr_accessor :markup_languages
+      @@markup_languages = []
+
+      mattr_accessor :default_markup_language
+      @@default_markup_language = nil
+
+      mattr_accessor :picture_image_styles
+      @@picture_image_styles = {}
+      def picture_image_styles=(picture_image_styles)
+        @@picture_image_styles = HashWithIndifferentAccess.new(picture_image_styles)
+      end
     end
   end
 end

data/lib/ecm/pictures/engine.rb

@@ -1,24 +1,10 @@
 module Ecm
   module Pictures
     class Engine < Rails::Engine
-      paths["config/locales"] << File.dirname(__FILE__) + '/../../../config/locales'
-
-      # Enabling assets precompiling under rails 3.1 or greater
-      if Rails.version >= '3.1'
-        initializer "ecm_pictures.asset_pipeline" do |app|
-          app.config.assets.precompile << 'ecm_pictures.js'
-          app.config.assets.precompile << 'ecm_pictures.css'
-        end
-      end
-
-      config.to_prepare do
-        ApplicationController.helper(Ecm::PicturesHelper)
-      end
-
       initializer :ecm_pictures_engine do
         ActiveAdmin.setup do |active_admin_config|
           active_admin_config.load_paths += Dir[File.dirname(__FILE__) + '/active_admin']
-        end
+        end if defined?(ActiveAdmin)
       end
     end
   end

data/lib/ecm/pictures/version.rb

@@ -1,5 +1,5 @@
 module Ecm
   module Pictures
-    VERSION = "0.0.21"
+    VERSION = "1.0.0.pre"
   end  
 end

data/lib/ecm_pictures.rb

@@ -1,15 +1,9 @@
-require 'rubygems'
-
 require 'acts_as_list'
+require 'acts_as_markup'
 require 'active_admin-acts_as_list'
 require 'friendly_id'
 require 'paperclip'
 
-# Ecm::Admin should do this!
-require 'activeadmin'
-require 'sass-rails'
-require 'meta_search'
-
 require 'ecm/pictures/engine'
 require 'ecm/pictures/configuration'
 require 'ecm/pictures/version'

data/lib/generators/ecm/pictures/install/templates/ecm_pictures.rb

@@ -1,3 +1,18 @@
 Ecm::Pictures.configure do |config|
-  # config.foo = :bar
+  # markup options
+
+  # Accepted markup languages
+  config.markup_languages = %w[ markdown rdoc textile ]
+
+  # Default markup language
+  config.default_markup_language = 'textile'
+
+  # picture options
+
+  # image sizes for slider items
+  config.picture_image_styles = {
+    :small_thumb   => "80x60",
+    :medium_thumb  => "160x120",
+    :default_thumb => "260x180"
+  }
 end

data/lib/generators/ecm/pictures/locales/locales_generator.rb

@@ -7,13 +7,13 @@ module Ecm
         source_root File.expand_path('../../../../../../config/locales', __FILE__)
 
         def generate_locales
-#          copy_file "ecm.pictures.en.yml", "config/locales/ecm.pictures.en.yml"
+          copy_file "ecm.pictures.en.yml", "config/locales/ecm.pictures.en.yml"
           copy_file "ecm.pictures.de.yml", "config/locales/ecm.pictures.de.yml"
 
-#          copy_file "ecm.pictures.picture.en.yml", "config/locales/ecm.pictures.picture.en.yml"
+          copy_file "ecm.pictures.picture.en.yml", "config/locales/ecm.pictures.picture.en.yml"
           copy_file "ecm.pictures.picture.de.yml", "config/locales/ecm.pictures.picture.de.yml"
 
-#          copy_file "ecm.pictures.picture_gallery.en.yml", "config/locales/ecm.pictures.picture_gallery.en.yml"
+          copy_file "ecm.pictures.picture_gallery.en.yml", "config/locales/ecm.pictures.picture_gallery.en.yml"
           copy_file "ecm.pictures.picture_gallery.de.yml", "config/locales/ecm.pictures.picture_gallery.de.yml"
         end
       end

data/lib/tasks/ecm_pictures_tasks.rake

@@ -31,9 +31,11 @@ namespace :ecm do
 
       desc "Creates example data for galleries"
       task :populate_galleries, [] => [:environment] do |t, args|
+        require "ffaker"
         5.times do |i|
           Ecm::Pictures::PictureGallery.create! do |pg|
             pg.name = "Picture Gallery #{i}"
+            pg.description = Faker::Lorem.paragraph(rand(3))
           end
         end
       end