refinerycms-slideshow 2.0.10.2 → 2.0.10.3

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+## 2.0.10.2 [2013-09-02]
+
+* FIX: Locale picker not available in the back
+* FIX: Duplicates didn't take into account the same slideshow in uniqueness validation
+* FEATURE: Slideshows attached to objects!
+
+## 2.0.10.2 [2013-08-01]
+
+* Title method not present but needed in refinery dashboard tab
+
+## 2.0.10.1 [2013-08-01]
+
+* Fixed bug with locale files and routes not present in gem.
+
+## 2.0.10.0 [2013-07-31]
+
+* Initial version: Slide and slideshow models + Refinery back

data/README.md

@@ -10,9 +10,62 @@ Current status
 
 The plugin right now includes a backend that allow us to create a slideshow and attach it slides with images, videos and an html body.
 
+It also includes a way to attach a slideshow to an object and add it to that object's admin.
+
+
+Attaching an Slideshow to a model
+===================================
+
+To attach an slideshow to a model you must:
+
+1) Generate a migration with an slideshow id field `rails g migration AddSlideshowToModel slideshow_id:integer`
+
+2) Include the slideshow concern into the model and attach the slideshow
+
+```ruby
+class Model < ActiveRecord::Base
+
+  include Refinery::Slideshow::Concerns::ModelWithSlideShow
+
+  attach_slideshow :slideshow
+
+end
+```
+
+This will use the previously created slideshow_id field to create a `belongs_to` relationship, so if you want another name for your slideshow (e.g. `attach_slideshow :cool_slideshow`) you will have to name your id_field in a different way in the migration (e.g. `rails g migration AddSlideshowToModel cool_slideshow_id:integer`)
+
+3) Use the slides partial in this model's admin:
+
+```ruby
+  <%= render 'refinery/slideshow/admin/slides/index', slideshow: f.object.slideshow %>
+```
+
+4) Depending on your scenary you may (or may not) need to initialize your slideshow attribute. By default, every time you access to the attached slideshow we are creating it:
+
+```ruby
+  object_model.slideshow # -> Voilá! We have created one slideshow on DB
+```
+
+But sometimes you don't want this behaviour (e.g. I only want blog posts from some category to include a slideshow). You can achieve this by overwriting a special method in the class called `needs_slideshow?`.
+
+```ruby
+
+class Model < ActiveRecord::Base
+
+  include Refinery::Slideshow::Concerns::ModelWithSlideShow
+
+  attach_slideshow :slideshow
+
+  def needs_slideshow?
+    # Just return a boolean. True if we must create it, False if we must not
+  end
+
+end
+```
+
+Again, if you use some different slideshow name (we used previously `cool_slideshow`) this method would be named after that slideshow name (`needs_cool_slideshow?`)
+
 To Do
 =====
 
-* Attach a slideshow to an object: "This product must have an slideshow", "I want an slideshow in this refinery page"... Imagine if we just can reuse the slideshow admin!
-
 * Some default front helpers: This way we could have a slideshow running without any extra front effort

data/app/models/refinery/slideshow/slideshow.rb

@@ -1,10 +1,19 @@
 class Refinery::Slideshow::Slideshow < ActiveRecord::Base
-  attr_accessible :uid
+  attr_accessible :uid, :attached, :attached_type, :attached_id
 
   has_many :slides
+  belongs_to :attached, polymorphic: true
+
+  validate :uid_not_blank_if_not_attached
+
+  def uid_not_blank_if_not_attached
+    errors.add(:uid, :blank) if self.uid.blank? && self.attached.nil?
+    errors.add(:uid, :taken) if self.attached.nil? && !self.class.where(uid: uid).detect{|s| s != self }.nil?
+  end
+
+
+  scope :not_attached, ->() { where(attached_type: nil, attached_id: nil) }
 
-  validates :uid, presence: true
-  validates :uid, uniqueness: true
 
   # Needed for the dashboard's activity list
   def title

data/app/views/refinery/slideshow/admin/shared/_locale_picker.html.erb

@@ -0,0 +1,11 @@
+<input type='hidden' name='switch_locale' id='switch_locale' value='<%= local_assigns[:current_locale] %>' />
+<% if (locales ||= Refinery::I18n.frontend_locales).present? and locales.many? %>
+  <ul id='switch_locale_picker' class='clearfix'>
+    <% locales.each do |locale| %>
+      <li<%= raw(" class='selected'") if locale.to_s == local_assigns[:current_locale].to_s %>>
+        <%= link_to refinery_icon_tag("flags/#{locale}.png", :size => "32x22"),
+                    refinery.url_for(:switch_locale => locale) %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>

data/app/views/refinery/slideshow/admin/slides/_form.html.erb

@@ -1,4 +1,9 @@
 <%= form_for [refinery, :slideshow_admin, @slideshow, object],  html: {multipart: true} do |f| -%>
+
+  <%= render "refinery/slideshow/admin/shared/locale_picker",
+              :current_locale => Thread.current[:globalize_locale] if Refinery.i18n_enabled? %>
+
+
   <%= render '/refinery/admin/error_messages',
               :object => object,
               :include_object_name => true %>

data/app/views/refinery/slideshow/admin/slides/_index.html.erb

@@ -1,7 +1,7 @@
 <section id='records'>
-  <%= render 'refinery/slideshow/admin/slides/records', records: records %>
+  <%= render 'refinery/slideshow/admin/slides/records', records: slideshow.slides %>
 </section>
 <aside id='actions'>
-  <%= render 'refinery/slideshow/admin/slides/actions', records: records, slideshow: slideshow %>
+  <%= render 'refinery/slideshow/admin/slides/actions', records: slideshow.slides, slideshow: slideshow %>
 </aside>
-<%= render '/refinery/admin/make_sortable', :tree => false, update_url: refinery.update_positions_slideshow_admin_slideshow_slides_path(slideshow) if !searching? and controller.class.sortable? and records.count > 1 %>
+<%= render '/refinery/admin/make_sortable', :tree => false, update_url: refinery.update_positions_slideshow_admin_slideshow_slides_path(slideshow) if !searching? and controller.class.sortable? and slideshow.slides.count > 1 %>

data/app/views/refinery/slideshow/admin/slideshows/edit.html.erb

@@ -1,6 +1,6 @@
 <%= render 'refinery/slideshow/admin/slideshows/form', object: @slideshow %>
 
 <h2><%= t '.slides' %></h2>
-<%= render 'refinery/slideshow/admin/slides/index', records: @slideshow.slides, slideshow: @slideshow %>
+<%= render 'refinery/slideshow/admin/slides/index', slideshow: @slideshow %>
 
 

data/config/locales/en/views/admin/slideshows.yml

@@ -7,6 +7,8 @@ en:
             create_new: Create new slide
             reorder: Reorder
             reorder_done: Reorder Done
+          edit:
+            title: Edit slide in slideshow %{slideshow}
           new:
             title: "New slide in slideshow '%{slideshow}'"
           records:

data/config/locales/es/views/admin/slideshows.yml

@@ -7,6 +7,8 @@ es:
             create_new: Crear nueva diapositiva
             reorder: Reordenar
             reorder_done: Terminar reordenación
+          edit:
+            title: Editar diapositiva en carrusel %{slideshow}
           new:
             title: "Nueva diapositiva para el carrusel '%{slideshow}'"
           records:

data/db/migrate/20130818180729_add_attached_to_slideshow.rb

@@ -0,0 +1,6 @@
+class AddAttachedToSlideshow < ActiveRecord::Migration
+  def change
+    add_column Refinery::Slideshow::Slideshow.table_name, :attached_type, :string
+    add_column Refinery::Slideshow::Slideshow.table_name, :attached_id, :integer
+  end
+end

data/lib/refinery/slideshow.rb

@@ -4,6 +4,7 @@ module Refinery
 
   module Slideshow
     require 'refinery/slideshow/engine'
+    require 'refinery/slideshow/concerns'
     attr_writer :root
 
     class << self

data/lib/refinery/slideshow/concerns.rb

@@ -0,0 +1,4 @@
+module Refinery::Slideshow::Concerns
+end
+
+require 'refinery/slideshow/concerns/model_with_slideshow'

data/lib/refinery/slideshow/concerns/model_with_slideshow.rb

@@ -0,0 +1,57 @@
+module Refinery::Slideshow::Concerns::ModelWithSlideShow
+
+  extend ActiveSupport::Concern
+
+  included do
+
+    has_many :slideshows, class_name: "Refinery::Slideshow::Slideshow", as: :attached
+
+  end
+
+  module ClassMethods
+
+    def attach_slideshow slideshow_relationship_name
+
+      # We create the relationship
+      belongs_to slideshow_relationship_name, class_name: "Refinery::Slideshow::Slideshow", autosave: true
+
+      # We create a method to define if this object needs an slideshow. By default it needs it.
+      define_method "needs_#{slideshow_relationship_name}?" do
+        true
+      end
+
+      # In slideshow accesor we check if this record has no slideshow but should have it, then we create a new slideshow
+      define_method "#{slideshow_relationship_name}" do
+
+        # We try to get the slideshow using the relationship
+        local_slideshow = self[slideshow_relationship_name.to_sym]
+
+        # If slideshow is nil, and the object has been already saved and the object needs an slideshow then we create it
+        if local_slideshow.nil? && !self.new_record? && self.send("needs_#{slideshow_relationship_name}?")
+          local_slideshow = self.send("build_#{slideshow_relationship_name}", attached: self)
+          self[slideshow_relationship_name.to_sym] = local_slideshow
+          send "#{slideshow_relationship_name}=", local_slideshow
+          self.save
+        end
+
+        local_slideshow
+
+      end
+
+      # In slideshow assignation we should attach current object to the slideshow
+      define_method "#{slideshow_relationship_name}=" do |slideshow|
+        slideshow.attached = self
+        super(slideshow)
+      end
+
+      # Before saving we must check if this new slideshow has been created and create it otherwise
+      after_save do |record|
+        if self.send("needs_#{slideshow_relationship_name}?")
+          record.send(slideshow_relationship_name).nil?
+        end
+      end
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinerycms-slideshow
 version: !ruby/object:Gem::Version
-  version: 2.0.10.2
+  version: 2.0.10.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-26 00:00:00.000000000 Z
+date: 2013-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinerycms-core
@@ -60,7 +60,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.0.10
 description: RefineryCMS plugin for managing slideshows
-email: 
+email: david.brenes@the-cocktail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -77,6 +77,7 @@ files:
 - app/views/refinery/slideshow/admin/slideshows/_slideshow.html.erb
 - app/views/refinery/slideshow/admin/slideshows/_form.html.erb
 - app/views/refinery/slideshow/admin/slideshows/_index.html.erb
+- app/views/refinery/slideshow/admin/shared/_locale_picker.html.erb
 - app/views/refinery/slideshow/admin/slides/_actions.html.erb
 - app/views/refinery/slideshow/admin/slides/new.html.erb
 - app/views/refinery/slideshow/admin/slides/_inner_form.html.erb
@@ -95,14 +96,18 @@ files:
 - config/locales/en/plugin.yml
 - config/locales/en/views/admin/slideshows.yml
 - db/migrate/20130730140608_create_slides.rb
+- db/migrate/20130818180729_add_attached_to_slideshow.rb
 - db/migrate/20130731111538_add_position_to_slide.rb
 - db/migrate/20130730083202_create_slideshows.rb
 - db/migrate/20130730150101_add_translation_to_slide.rb
 - lib/refinerycms-slideshow.rb
 - lib/refinery/slideshow/engine.rb
+- lib/refinery/slideshow/concerns.rb
+- lib/refinery/slideshow/concerns/model_with_slideshow.rb
 - lib/refinery/slideshow.rb
 - README.md
-homepage: 
+- CHANGELOG.md
+homepage: https://github.com/simplelogica/refinerycms-slideshow
 licenses: []
 post_install_message: 
 rdoc_options: []