refinerycms-snippets 0.4.1 → 0.5

data/app/controllers/admin/{snippets_page_controller.rb → snippets_page_parts_controller.rb}

@@ -1,14 +1,16 @@
 module Admin
-  class SnippetsPageController < Admin::BaseController
+  class SnippetsPagePartsController < Admin::BaseController
     
     def add
       @page = Page.find(params[:id])
+      @part = PagePart.find(params[:part_id])
       @snippet = Snippet.find(params[:snippet_id])
-
-      sp = SnippetPage.new(:page => @page, :snippet => @snippet)
+      before_body = params[:before_body] == 'true' ? true : false
+      
+      sp = SnippetPagePart.new(:page_part => @part, :snippet => @snippet, :before_body => before_body)
 
       if sp.save
-         flash[:notice] = "Snippet #{@snippet.title} was successfully added to page."
+         flash[:notice] = "Snippet #{@snippet.title} was successfully added."
       end
       
       render :layout => false if request.xhr?
@@ -16,14 +18,16 @@ module Admin
 
     def remove
       @page = Page.find(params[:id])
+      @part = PagePart.find(params[:part_id])
       @snippet = Snippet.find(params[:snippet_id])
+      before_body = params[:before_body] == 'true' ? true : false
 
-      sp = SnippetPage.where(:page_id => @page, :snippet_id => @snippet)
+      sp = SnippetPagePart.where(:page_part_id => @part, :snippet_id => @snippet, :before_body => before_body)
       
       removed = sp.first.destroy() unless sp.empty?
 
       if removed
-         flash[:notice] = "Snippet #{@snippet.title} was successfully removed from page."
+         flash[:notice] = "Snippet #{@snippet.title} was successfully removed."
       end
       
       render :layout => false if request.xhr?

data/app/models/snippet.rb

@@ -1,27 +1,42 @@
 class Snippet < ActiveRecord::Base
-  
+
   acts_as_indexed :fields => [:title, :body]
 
   validates :title, :presence => true, :uniqueness => true
 
   translates :body
 
-  has_many :snippet_page, :dependent => :destroy
-  has_many :pages, :through => :snippet_page
+  has_many :snippet_page_parts, :dependent => :destroy
+  has_many :page_parts, :through => :snippet_page_parts
 
-  def self.inactive(page)
-      @page = page
-      snippets = scoped      
-      snippets = snippets.where('id NOT IN (?)', @page.snippets) unless @page.snippets.empty?
-      snippets
-  end
+  named_scope :for_page, lambda{ |page|
+    raise RuntimeError.new("Couldn't find Snippet for a nil Page") if page.blank?
+    joins(:page_parts => :page).where(:pages => {:id => page.id})
 
+  }
+
+  scope :before, where(:snippets_page_parts => {:before_body => true})
+  scope :after, where(:snippets_page_parts => {:before_body => false}) 
+  
   # rejects any page that has not been translated to the current locale.
   scope :translated, lambda {
     pages = Arel::Table.new(Snippet.table_name)
     translations = Arel::Table.new(Snippet.translations_table_name)
 
     includes(:translations).where(
-      translations[:locale].eq(Globalize.locale)).where(pages[:id].eq(translations[:snippet_id]))
+                                  translations[:locale].eq(Globalize.locale)).where(pages[:id].eq(translations[:snippet_id]))
   }
+
+  def pages
+    Page.for_snippet(self)
+  end
+
+  def before?(part)
+    part.snippets.before.include? self
+  end
+
+  def after?(part)
+    part.snippets.after.include? self
+  end
+
 end

data/app/models/snippet_page_part.rb

@@ -0,0 +1,14 @@
+class SnippetPagePart < ActiveRecord::Base
+  
+  set_table_name 'snippets_page_parts'
+  
+  belongs_to :snippet, :foreign_key => :snippet_id
+  belongs_to :page_part, :foreign_key => :page_part_id
+
+  validates_uniqueness_of :snippet_id,  :scope => [:page_part_id, :before_body]
+  
+  before_save do |snippet_page_part|
+    snippet_page_part.position = (SnippetPagePart.where('page_part_id = ?', snippet_page_part.page_part_id).maximum(:position) || -1) + 1
+  end
+  
+end

data/app/views/admin/pages/tabs/_snippets_content.html.erb

@@ -1,7 +1,14 @@
 <% if @page.new_record? %>
-<div class="msg alert"><%= t('.please_save_page_before') %></div>
+  <div class="msg alert"><%= t('.please_save_page_before') %></div>
 <% else %>
-<%= render :partial => '/admin/pages/tabs/snippets_field' %>
+  <div id="part-snippets-menu">
+    <ul>
+    <% @page.parts.each do |part|%>
+      <li><%= link_to(part.title, :anchor => "part-#{part.id}") %> |</li>
+    <% end %>
+    </ul>
+  </div>
+  <%= render :partial => '/admin/pages/tabs/snippets_field', :collection => @page.parts, :as => :part %>
 <% end %>
 
 <% content_for :stylesheets do %>
@@ -9,4 +16,7 @@
 <% end %>
 <% content_for :javascripts do %>
   <%= javascript_include_tag 'page-snippet-picker' %>
-<% end %>
+<% end %>
+<% content_for :javascripts do %>
+  <%= javascript_include_tag 'part-snippets-select' %>
+<% end %>

data/app/views/admin/pages/tabs/_snippets_field.html.erb

@@ -1,52 +1,48 @@
-<div id="active-snippets">
-<% if @page.snippets.any? %>
-  <h2><%= t('.active') %></h2>
-  <ul>
-  <% @page.snippets.each do |snippet| %>
-    <li class='clearfix record <%= cycle('on', 'on-hover') %>' >
-    <span class='title'>
-      <%= snippet.title %>
-      <% if ::Refinery::I18n.frontend_locales.many? and
-            (locales = snippet.translations.collect{|t| t.locale}).present? %>
-        <span class='preview'>
-          <% locales.each do |locale| %>
-            <%= refinery_icon_tag "flags/#{locale}.png", :size => '16x11' %>
-          <% end %>
-        </span>
-      <% end %>
-    </span>
-    <span class='actions'>
-      <%= link_to refinery_icon_tag('application_edit.png'), edit_admin_snippet_path(snippet),
-           :title => t('.edit') %>
-      <%= link_to refinery_icon_tag('delete.png'), url_for({:controller => 'snippets_page', :action => 'remove', :snippet_id => snippet.id, :id => @page.id}),
-          :title => t('.remove'),
-          :class => 'remove-snippet' %>
-    </span>
-    </li>
-  <% end %>
-  </ul>
-<% end %>
-</div>
+<div id="<%= "part-#{part.id}" %>" class="part-snippets">
+  <h1><%= part.title %></h1>
+  <div class="active-snippets">
+    <% if part.snippets.before.any? %>
+      <h2><%= t('.before_body') %></h2>
+      <ul>
+        <%= render :partial => '/admin/pages/tabs/snippets_list_item', :collection => part.snippets.before, :as => :snippet, :locals => {:part => part, :before_body => true} %>
+      </ul>
+    <% end %>
+    <% if part.snippets.after.any? %>
+      <h2><%= t('.after_body') %></h2>
+      <ul>
+        <%= render :partial => '/admin/pages/tabs/snippets_list_item', :collection => part.snippets.after, :as => :snippet, :locals => {:part => part, :before_body => false} %>
+      </ul>
+    <% end %>
+  </div>
 
-<div id="inactive-snippets">
-<% inactive_snippets = Snippet.inactive(@page) %>
-<% if inactive_snippets.length > 0 %>
-  <h2><%= t('.inactive') %></h2>
-  <ul>
-    <% inactive_snippets.each do |snippet| %>
-    <li class='clearfix record <%= cycle('on', 'on-hover') %>' >
-      <span class="title"><%= snippet.title %></span>
-      <span class="actions">
-        <a class="add_icon add-snippet" href="<%= url_for({:controller => 'snippets_page', :action => 'add', :snippet_id => snippet.id, :id => @page.id}) %>">Add</a>
-      </span>
-    </li>
+  <div class="inactive-snippets">
+    <% inactive_snippets = Snippet.all %>
+    <% if inactive_snippets.length > 0 %>
+      <h2><%= t('.inactive') %></h2>
+      <ul>
+        <% inactive_snippets.each do |snippet| %>
+          <li class='clearfix record <%= cycle('on', 'on-hover') %>' >
+            <span class="title"><%= snippet.title %></span>
+            <div class="actions">
+              <% unless snippet.after?(part) %>
+                <%= link_to t('.add_after_body'), {:controller => 'snippets_page_parts', :action => 'add', :id => @page.id, :snippet_id => snippet.id, :part_id => part.id}, :class => 'add_icon add-snippet' %>
+              <% else %>
+                <span class="add_icon add-snippet"><%= t('.add_after_body') %></span>
+              <% end %>
+              <% unless snippet.before?(part) %>
+                <%= link_to t('.add_before_body'), {:controller => 'snippets_page_parts', :action => 'add', :id => @page.id, :snippet_id => snippet.id, :part_id => part.id, :before_body => 'true'}, :class => 'add_icon add-snippet' %>
+              <% else %>
+                <span class="add_icon add-snippet"><%= t('.add_before_body') %></span>
+              <% end %>
+            </div>
+          </li>
+        <% end %>
+      </ul>
     <% end %>
-  </ul>
-<% end %>
+  </div>
 </div>
 
 
 
 
 
-

data/app/views/admin/pages/tabs/_snippets_list_item.html.erb

@@ -0,0 +1,20 @@
+<li class='clearfix record <%= cycle('on', 'on-hover') %>' >
+  <span class='title'>
+    <%= snippet.title %>
+    <% if ::Refinery::I18n.frontend_locales.many? and
+           (locales = snippet.translations.collect{|t| t.locale}).present? %>
+      <span class='preview'>
+        <% locales.each do |locale| %>
+          <%= refinery_icon_tag "flags/#{locale}.png", :size => '16x11' %>
+        <% end %>
+      </span>
+    <% end %>
+  </span>
+  <span class='actions'>
+    <%= link_to refinery_icon_tag('application_edit.png'), edit_admin_snippet_path(snippet),
+        :title => t('.edit') %>
+    <%= link_to refinery_icon_tag('delete.png'), url_for({:controller => 'snippets_page_parts', :action => 'remove', :id => @page.id, :snippet_id => snippet.id, :part_id => part.id, :before_body => before_body}),
+        :title => t('.remove'),
+        :class => 'remove-snippet' %>
+  </span>
+</li>

data/config/locales/en.yml

@@ -23,9 +23,13 @@ en:
         snippets_field:
           active: Active
           inactive: Inactive
+          add_after_body: Add after body
+          add_before_body: Add before body
+          after_body: After body
+          before_body: Before body
+        snippets_list_item:
           remove: Remove
           edit: Edit
-          add: Add
   snippets:
     show:
       other: Other Snippets

data/config/routes.rb

@@ -6,7 +6,7 @@ Refinery::Application.routes.draw do
         post :update_positions
       end
       
-      resources :snippets_page do
+      resources :snippets_page_parts do
         member do
           get 'add'
           get 'remove'

data/db/migrate/4_create_snippets_page_parts.rb

@@ -0,0 +1,19 @@
+class CreateSnippetsPageParts < ActiveRecord::Migration
+
+  def self.up
+    create_table :snippets_page_parts do |t|
+      t.integer :snippet_id, :null => false, :references => [:snippets, :id]
+      t.integer :page_part_id, :null => false, :references => [:page_parts, :id]
+      t.integer :position, :null => false, :default => 0
+      t.boolean :before_body, :null => false, :default => false
+    end
+
+    add_index :snippets_page_parts, :snippet_id
+    add_index :snippets_page_parts, :page_part_id
+  end
+
+  def self.down
+    drop_table :snippet_page_parts
+  end
+
+end

data/db/migrate/5_drop_snippet_page.rb

@@ -0,0 +1,20 @@
+class DropSnippetPage < ActiveRecord::Migration
+
+  def self.up
+    remove_index :snippet_page, :snippet_id
+    remove_index :snippet_page, :page_id
+    drop_table :snippet_page
+  end
+
+  def self.down
+    create_table :snippet_page do |t|
+      t.integer :snippet_id, :null => false, :references => [:snippets, :id]
+      t.integer :page_id, :null => false, :references => [:pages, :id]
+      t.integer :position, :null => false, :default => 0
+    end
+
+    add_index :snippet_page, :snippet_id
+    add_index :snippet_page, :page_id
+  end
+  
+end

data/lib/extensions/page_extensions.rb

@@ -0,0 +1,25 @@
+module Extensions
+  module Page
+
+    def self.included(base)
+
+      base.class_eval do
+
+        named_scope :for_snippet, lambda{ |snippet|
+          raise RuntimeError.new("Couldn't find Pages for a nil Snippet") if snippet.blank?
+          {
+            :joins => {:parts, :snippets},
+            :conditions => {:snippets_page_parts => {:snippet_id => snippet.id}}
+          }
+        }
+
+        def snippets
+          Snippet.for_page(self)
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/extensions/pages_helper_extensions.rb

@@ -0,0 +1,35 @@
+module Extensions
+  module PagesHelper
+
+    def self.included(base)
+      base.class_eval do
+
+        ##
+        # Accessor method to get a page part from a page.
+        # Example:
+        #
+        #    content_of(Page.first, :body)
+        #
+        # Will return the body page part of the first page wrap with its
+        # attached snippets.
+        def content_of(page, part_title)
+          part = page.parts.detect do |part|
+            part.title.present? and #protecting against the problem that occurs when have nil title
+              part.title == part_title.to_s or
+              part.title.downcase.gsub(" ", "_") == part_title.to_s.downcase.gsub(" ", "_")
+          end
+
+          if part
+            content = ""
+            content += part.snippets.before.map{|snippet| snippet.try(:body)}.join
+            part_body = part.try(:body)
+            content += part_body unless part_body.nil?
+            content += part.snippets.after.map{|snippet| snippet.try(:body)}.join
+          end
+        end
+
+      end
+    end
+
+  end
+end

data/lib/refinerycms-snippets.rb

@@ -3,19 +3,27 @@ require 'refinerycms-base'
 module Refinery
   module Snippets
     class Engine < Rails::Engine
+
+      config.before_initialize do
+        require 'extensions/page_extensions'
+        require 'extensions/pages_helper_extensions'
+      end
+
       initializer "static assets" do |app|
         app.middleware.insert_after ::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/public"
       end
-      
+
       config.to_prepare do
-        Page.module_eval do
-          has_many :snippet_page, :dependent => :destroy
-          has_many :snippets, :through => :snippet_page, :order => 'position ASC'
+        PagePart.module_eval do
+          has_many :snippet_page_parts, :dependent => :destroy
+          has_many :snippets, :through => :snippet_page_parts, :order => 'position ASC'
         end
+        Page.send :include, Extensions::Page
+        PagesHelper.send :include, Extensions::PagesHelper
       end
 
       config.after_initialize do
-       ::Refinery::Pages::Tab.register do |tab|
+        ::Refinery::Pages::Tab.register do |tab|
           tab.name = "snippets"
           tab.partial = "/admin/pages/tabs/snippets"
         end
@@ -24,10 +32,10 @@ module Refinery
           plugin.url = {:controller => '/admin/snippets'}
           plugin.menu_match = /^\/?(admin|refinery)\/snippets/
           plugin.activity = [{
-            :class => Snippet
-          }, {
-            :class => SnippetPage
-          }]
+                               :class => Snippet
+                             }, {
+                               :class => SnippetPage
+                             }]
         end
       end
     end

data/public/javascripts/page-snippet-picker.js

@@ -34,7 +34,7 @@ $(document).ready(function (cms) {
 			
 			if (!this.processing) {
 				this.spinner_on();
-
+                          var partId = $('#part-snippets-select').val();
 				$.ajax({
 					url: add_url,
 					type: 'GET',
@@ -45,6 +45,8 @@ $(document).ready(function (cms) {
 					},
 					success: function (response) {
 						that.update(response);
+                                          cms.plugin.PartSnippetsSelect.init();
+                                          $('#part-snippets-select').val(partId).change();
 					}
 				});
 			}
@@ -56,7 +58,7 @@ $(document).ready(function (cms) {
 
 			if (!this.processing) {
 				this.spinner_on();
-				
+			        var partId = $('#part-snippets-select').val();
 				// console.log('remove start');
 				$.ajax({
 					url: remove_url,
@@ -69,6 +71,8 @@ $(document).ready(function (cms) {
 					},
 					success: function (response) {
 						that.update(response);
+                                          cms.plugin.PartSnippetsSelect.init();
+                                          $('#part-snippets-select').val(partId).change();
 					}
 				});
 			}

data/public/javascripts/part-snippets-select.js

@@ -0,0 +1,40 @@
+$(document).ready(function (cms) {
+  cms = cms || {};
+  cms.plugin = cms.plugin || {};
+
+  /**
+   * Generates a drop-down box for changing the displayed page part
+   * in the snippets tab in the edit page interface.
+   */
+  cms.plugin.PartSnippetsSelect = {
+
+    init: function() {
+      $('#part-snippets-menu').html(this.generateWidget());
+      this.changeVisiblePart();
+      $('#part-snippets-select').change(this.changeVisiblePart);
+    },
+
+    /**
+     * Writes the html code for the drop-down box.
+     */
+    generateWidget: function() {
+      select = '<select id="part-snippets-select">';
+      $('#part-snippets-menu a').each(function(i,e) {
+        select += '<option value="'+$(e).attr('href').split('#',2)[1]+'">'
+        select += e.text
+        select += '</option>'
+      });
+      select += '</select>';
+      return select;
+    },
+
+    changeVisiblePart: function() {
+      $('.part-snippets').css('display', 'none');
+      $('#'+$('#part-snippets-select').val()).css('display', 'block');
+    },
+
+  }
+
+  cms.plugin.PartSnippetsSelect.init();
+
+});

data/public/stylesheets/page-snippet-picker.css

@@ -6,25 +6,32 @@
         Styles for snippets administrations
 */
 
-a.add-snippet {
+a.add-snippet,
+span.add-snippet {
 	background-repeat: no-repeat;
 	background-position: left center;
 	border: none; 
 	padding-left: 20px;
 }
 
-#page_snippet_picker ul {
+span.add-snippet {
+   float: right;
+   color: lightGray;
+   margin: 3px;
+}
+
+.part-snippets ul {
 	background: #fff;
 	padding: 10px;
 	padding-bottom: 0px;
 	margin-bottom: 5px;
 }
 
-#active-snippets ul {
+.active-snippets ul {
 	margin-bottom: 15px;
 }
 
-#inactive-snippets ul {
+.inactive-snippets ul {
 	background: #fcfcfc;
 }
 
@@ -36,4 +43,28 @@ a.add-snippet {
 .msg.alert {
 	color: #f66;
 	background: #fff;
-}
+}
+
+#page_snippet_picker h1 {
+   text-align: left;
+}
+
+.part-snippets {
+   margin-bottom: 5ex;
+}
+
+.part-snippets:last-child {
+   margin-bottom: 0;
+}
+
+#page_snippet_picker div.actions {
+   display: inline;
+}
+
+#part-snippets-menu {
+   margin: 1ex;
+}
+
+#part-snippets-menu li {
+   display: inline;
+}

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: refinerycms-snippets
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 1
   prerelease: 
   segments: 
   - 0
-  - 4
-  - 1
-  version: 0.4.1
+  - 5
+  version: "0.5"
 platform: ruby
 authors: 
 - Marek L.
@@ -15,8 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-28 00:00:00 +02:00
-default_executable: 
+date: 2011-11-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: refinerycms-pages
@@ -45,13 +43,16 @@ extra_rdoc_files: []
 
 files: 
 - lib/generators/refinerycms_snippets_generator.rb
+- lib/extensions/pages_helper_extensions.rb
+- lib/extensions/page_extensions.rb
 - lib/refinerycms-snippets.rb
 - lib/tasks/snippets.rake
 - config/routes.rb
 - config/locales/en.yml
 - config/locales/nl.yml
 - app/controllers/admin/snippets_controller.rb
-- app/controllers/admin/snippets_page_controller.rb
+- app/controllers/admin/snippets_page_parts_controller.rb
+- app/models/snippet_page_part.rb
 - app/models/snippet_page.rb
 - app/models/snippet.rb
 - app/views/admin/snippets/_snippets.html.erb
@@ -65,18 +66,21 @@ files:
 - app/views/admin/snippets/_locale_picker.html.erb
 - app/views/admin/snippets/_actions.html.erb
 - app/views/admin/snippets/_snippet.html.erb
-- app/views/admin/snippets_page/remove.html.erb
-- app/views/admin/snippets_page/add.html.erb
+- app/views/admin/snippets_page_parts/remove.html.erb
+- app/views/admin/snippets_page_parts/add.html.erb
 - app/views/admin/pages/tabs/_snippets.html.erb
+- app/views/admin/pages/tabs/_snippets_list_item.html.erb
 - app/views/admin/pages/tabs/_snippets_content.html.erb
 - app/views/admin/pages/tabs/_snippets_field.html.erb
+- db/migrate/5_drop_snippet_page.rb
+- db/migrate/4_create_snippets_page_parts.rb
 - db/migrate/2_create_snippet_page.rb
 - db/migrate/1_create_snippets.rb
 - db/migrate/3_translate_snippets.rb
 - db/seeds/snippets.rb
+- public/javascripts/part-snippets-select.js
 - public/javascripts/page-snippet-picker.js
 - public/stylesheets/page-snippet-picker.css
-has_rdoc: true
 homepage: 
 licenses: []
 
@@ -106,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.4
 signing_key: 
 specification_version: 3
 summary: Html snippets for Refinery CMS page