effective_regions 1.4.10 → 1.4.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acdd2fcfad642191327de27d5a9fe4aadb40c641
-  data.tar.gz: 728f38432fd882671bac83c29d6e54ada4bb2249
+  metadata.gz: 483fd3d07ea6577b19b36977370babd10af15ae8
+  data.tar.gz: c9fe3624dc933c53f563031780ec8dc53b9b0cdd
 SHA512:
-  metadata.gz: 5be4ebc7c19fd7ae234b09f20ca51b80fa57a53cd2ed619e643096764819fccb90a6c6f43801be3cf6ae6de1e6efeadfb851161134d1425bc81f2aba9c2e0b3f
-  data.tar.gz: cb1d4675193faf95635840dc263b5405c062185a5fbf6d10487366d4f01d8b6afd1609b8ebac59f42db75fb90dc8f3445a7c3c781128bb7e903ab3a7e0f86921
+  metadata.gz: c8fff7cc51e8132edf5a336080b9b501606004c56dc1eb68cb7f551d9ed4ea1ab1e57df7a19b07a0c05189d70c677c4ff02508246761f25b3ed901f8dcd319c1
+  data.tar.gz: 7665b9df3050856b0270d34a41e6e19a0811fe080a7103b67ce22d2063e165752899a8110c8e57cce3afaa10116ed6078f776fed70b7aff71b4c1d08b7b86fae

data/README.md

@@ -424,10 +424,17 @@ module Effective
   module Snippets
     class Post < Snippet
       attribute :post_id, Integer
+      attribute :all_posts, Array # We're going to assign this through the effective_region :snippet_locals option
 
       def post_object
         # We're using ::Post to refer to the app/models/post.rb rather than the Effective::Snippets::Post
-        @post ||= ::Post.find_by_id(post_id)
+        @post ||= begin
+          if all_posts.present?
+            all_posts.find { |post| post.id == post_id }
+          else
+            ::Post.find_by_id(post_id)
+          end
+        end
       end
 
     end
@@ -532,11 +539,12 @@ We can pre-populate an effective_region's default content with some posts.  Thes
 ```haml
 %h2 Posts
 
-= snippet_effective_region :sidebar_posts, :snippets => [:post] do
+= snippet_effective_region :sidebar_posts, :snippets => [:post], :snippet_locals => {:all_posts => Post.all.to_a} do
   - Post.order(:created_at).first(5).each do |post|
-    = render_snippet Effective::Snippets::Post.new(:post_id => post.id)
+    = render_snippet Effective::Snippets::Post.new(:post_id => post.id, :all_posts => [post])
 ```
 
+Using the `snippet_locals` approach as above prevents an N+1 query when each snippet has to look up its own post.
 
 ### Summary
 
@@ -549,9 +557,7 @@ Templates are small pieces of reusable HTML that can be inserted into an `effect
 
 Unlike snippets, there are no configurable options or anything.  They're just pieces of raw HTML that can be dropped in and then immediately editted.
 
-While handy, they were implemented as a bit of an after-thought, and will probably be refactored in future versions of effective_regions.
-
-They take the form of two files, a model and a view.
+They take the form of three files, a model, a view, and an optional image file.
 
 ### The Model
 
@@ -587,6 +593,15 @@ The view is defined at app/models/effective/templates/_two_column.html.haml
     %p Right column
 ```
 
+### The Image
+
+The image is used as an icon on the 'Content Templates' dialog screen.
+
+It is optional, but will raise a silent 404 error if it doesn't exist.
+
+The image should be 100x70 pixel .png file stored at /app/assets/images/effective/templates/two_column.png
+
+
 ## License
 
 MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)

data/app/controllers/effective/regions_controller.rb

@@ -48,7 +48,7 @@ module Effective
           region.content = cleanup(vals[:content])
 
           region.snippets = HashWithIndifferentAccess.new()
-          (vals[:snippets] || []).each { |snippet, vals| region.snippets[snippet] = vals }
+          (vals[:snippets] || []).each { |snippet, vals| region.snippets[snippet] = HashWithIndifferentAccess.new(vals.to_h) }
 
           # Last chance for a developer to make some changes here
           refresh_page = true if (run_before_save_method(region, regionable) rescue nil) == :refresh

data/app/helpers/effective_regions_helper.rb

@@ -43,6 +43,7 @@ module EffectiveRegionsHelper
     obj = args.first
     title = args.last.to_s.parameterize
     editable_tag = options.delete(:editable_tag) || :div
+    snippet_locals = options.delete(:snippet_locals) # These get passed into the Snippet.new() model
 
     # Set up the editable div options we need to send to ckeditor
     if effectively_editing?
@@ -76,19 +77,19 @@ module EffectiveRegionsHelper
 
     if effectively_editing? && (can_edit && options[:editable] != false) # If we need the editable div
       content_tag(editable_tag, opts) do
-        region.try(:content).present? ? render_region(region, true) : (capture(&block) if block_given?)
+        region.try(:content).present? ? render_region(region, true, snippet_locals) : (capture(&block) if block_given?)
       end
     else
-      region.try(:content).present? ? render_region(region, false) : (capture(&block) if block_given?)
+      region.try(:content).present? ? render_region(region, false, snippet_locals) : (capture(&block) if block_given?)
     end
   end
 
-  def render_region(region, can_edit = true)
+  def render_region(region, can_edit = true, snippet_locals = {})
     return '' unless region
 
     region.content.tap do |html|
       html.scan(/\[(snippet_\d+)\]/).flatten.uniq.each do |id| # find snippet_1 and replace with snippet content
-        snippet = region.snippet_objects.find { |snippet| snippet.id == id }
+        snippet = region.snippet_objects(snippet_locals).find { |snippet| snippet.id == id }
         html.gsub!("[#{id}]", render_snippet(snippet, can_edit)) if snippet
       end
     end.html_safe

data/app/models/effective/region.rb

@@ -23,11 +23,12 @@ module Effective
     # Hash of the Snippets objectified
     #
     # Returns a Hash of {'snippet_1' => CurrentUserInfo.new(snippets[:key]['options'])}
-    def snippet_objects
+    def snippet_objects(locals = {})
+      locals = {} unless locals.kind_of?(Hash)
       @snippet_objects ||= snippets.map do |key, snippet|  # Key here is 'snippet_1'
         if snippet['class_name']
           klass = "Effective::Snippets::#{snippet['class_name'].classify}".safe_constantize
-          klass.new(snippet.merge!(:region => self, :id => key)) if klass
+          klass.new(snippet.merge!(locals).merge!(:region => self, :id => key)) if klass
         end
       end.compact
     end

data/app/models/effective/snippets/snippet.rb

@@ -31,6 +31,10 @@ module Effective
         end
       end
 
+      # If you define "attribute :something, Array" in your derived class
+      # You can call effective_region post, :content :snippet_locals => {:something => [1,2,3]}
+      # And it will be assigned when the effective_region is rendered
+
       def initialize(atts = {})
         (atts || {}).each { |k, v| self.send("#{k}=", v) if respond_to?("#{k}=") }
       end

data/lib/effective_regions/version.rb

@@ -1,3 +1,3 @@
 module EffectiveRegions
-  VERSION = '1.4.10'.freeze
+  VERSION = '1.4.11'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_regions
 version: !ruby/object:Gem::Version
-  version: 1.4.10
+  version: 1.4.11
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails