refinerycms-sl-snippets 1.0.0

data/db/migrate/2_translate_snippets.rb

@@ -0,0 +1,20 @@
+class TranslateSnippets < ActiveRecord::Migration
+
+  def up
+    ::Refinery::Snippet.reset_column_information
+    unless ::Refinery::Snippet::Translation.table_exists?
+      ::Refinery::Snippet.create_translation_table!({
+        :body => :text
+      }, {
+        :migrate_data => true
+      })
+    end
+  end
+
+  def down
+    ::Refinery::Snippet.reset_column_information
+
+    ::Refinery::Snippet.drop_translation_table!
+  end
+
+end

data/db/migrate/3_create_snippets_page_parts.rb

@@ -0,0 +1,22 @@
+class CreateSnippetsPageParts < ActiveRecord::Migration
+
+  def up
+    unless ::Refinery::SnippetPagePart.table_exists?
+      create_table ::Refinery::SnippetPagePart.table_name 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
+        t.timestamps
+      end
+    end
+
+    add_index ::Refinery::SnippetPagePart.table_name, :snippet_id
+    add_index ::Refinery::SnippetPagePart.table_name, :page_part_id
+  end
+
+  def down
+    drop_table ::Refinery::SnippetPagePart.table_name
+  end
+
+end

data/db/migrate/6_remove_position_from_snippets.rb

@@ -0,0 +1,12 @@
+class RemovePositionFromSnippets < ActiveRecord::Migration
+
+  def self.up
+    remove_column ::Refinery::Snippet.table_name, :position
+  end
+
+  def self.down
+    add_column(::Refinery::Snippet.table_name, :position, :integer,
+               :null => :false, :default => 0)
+  end
+
+end

data/db/seeds.rb

@@ -0,0 +1,6 @@
+Refinery::User.find(:all).each do |user|
+  if user.plugins.where(:name => 'refinery_snippets').blank?
+    user.plugins.create(:name => 'refinery_snippets',
+                        :position => (user.plugins.maximum(:position) || -1) +1)
+  end
+end if defined?(Refinery::User)

data/features/manage_snippets.feature

@@ -0,0 +1,63 @@
+@snippets
+Feature: Snippets
+  In order to have snippets on my website
+  As an administrator
+  I want to manage snippets
+
+  Background:
+    Given I am a logged in refinery user
+    And I have no snippets
+
+  @snippets-list @list
+  Scenario: Snippets List
+   Given I have snippets titled UniqueTitleOne, UniqueTitleTwo
+   When I go to the list of snippets
+   Then I should see "UniqueTitleOne"
+   And I should see "UniqueTitleTwo"
+
+  @snippets-valid @valid
+  Scenario: Create Valid Snippet
+    When I go to the list of snippets
+    And I follow "Add New Snippet"
+    And I fill in "Title" with "This is a test of the first string field"
+    And I press "Save"
+    Then I should see "This is a test of the first string field was successfully added."
+    And I should have 1 snippet
+
+  @snippets-invalid @invalid
+  Scenario: Create Invalid Snippet (without title)
+    When I go to the list of snippets
+    And I follow "Add New Snippet"
+    And I press "Save"
+    Then I should see "Title can't be blank"
+    And I should have 0 snippets
+
+  @snippets-edit @edit
+  Scenario: Edit Existing Snippet
+    Given I have snippets titled "A title"
+    When I go to the list of snippets
+    And I follow "Edit this snippet" within ".actions"
+    Then I fill in "Title" with "A different title"
+    And I press "Save"
+    Then I should see "'A different title' was successfully updated."
+    And I should be on the list of snippets
+    And I should not see "A title"
+
+  @snippets-duplicate @duplicate
+  Scenario: Create Duplicate Snippet
+    Given I only have snippets titled UniqueTitleOne, UniqueTitleTwo
+    When I go to the list of snippets
+    And I follow "Add New Snippet"
+    And I fill in "Title" with "UniqueTitleTwo"
+    And I press "Save"
+    Then I should see "There were problems"
+    And I should have 2 snippets
+
+  @snippets-delete @delete
+  Scenario: Delete Snippet
+    Given I only have snippets titled UniqueTitleOne
+    When I go to the list of snippets
+    And I follow "Remove this snippet forever"
+    Then I should see "'UniqueTitleOne' was successfully removed."
+    And I should have 0 snippets
+ 

data/features/step_definitions/snippet_steps.rb

@@ -0,0 +1,14 @@
+Given /^I have no snippets$/ do
+  Snippet.delete_all
+end
+
+Given /^I (only )?have snippets titled "?([^\"]*)"?$/ do |only, titles|
+  Snippet.delete_all if only
+  titles.split(', ').each do |title|
+    Snippet.create(:title => title)
+  end
+end
+
+Then /^I should have ([0-9]+) snippets?$/ do |count|
+  Snippet.count.should == count.to_i
+end

data/features/support/paths.rb

@@ -0,0 +1,17 @@
+module NavigationHelpers
+  module Refinery
+    module Snippets
+      def path_to(page_name)
+        case page_name
+        when /the list of snippets/
+          admin_snippets_path
+
+         when /the new snippet form/
+          new_admin_snippet_path
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/extensions/application_helper_extensions.rb

@@ -0,0 +1,39 @@
+module Extensions
+  module ApplicationHelper
+
+    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| content_or_render_of(snippet)}.join
+            part_body = part.try(:body)
+            content += part_body unless part_body.nil?
+            content += part.snippets.after.map{|snippet| content_or_render_of(snippet)}.join
+          end
+        end
+
+        def content_or_render_of(snippet)
+          snippet.template? ? render(:file => snippet.template_path) : snippet.body
+        end
+
+      end
+    end
+
+  end
+end

data/lib/extensions/page_extensions.rb

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

data/lib/gemspec.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+require File.expand_path('../refinery/snippets/version', __FILE__)
+
+files = Dir.glob("**/*").flatten.reject do |file|
+  file =~ /\.gem$/
+end
+
+gemspec = <<EOF
+Gem::Specification.new do |s|
+  s.platform          = Gem::Platform::RUBY
+  s.name              = %q{refinerycms-sl-snippets}
+  s.version           = %q{#{Refinery::Snippets::VERSION}}
+  s.description       = %q{Ruby on Rails Snippets engine for Refinery CMS}
+  s.date              = %q{#{Time.now.strftime('%Y-%m-%d')}}
+  s.summary           = %q{Html snippets for Refinery CMS page}
+  s.authors           = ['Rodrigo García Suárez', 'Simplelogica', 'Marek L.']
+  s.email             = %q{rodrigo@simplelogica.net}
+  s.require_paths     = %w(lib)
+  s.homepage          = %q{https://github.com/simplelogica/refinerycms-snippets}
+  
+  s.add_dependency    'refinerycms-pages', '>= 2.0.0'
+
+  s.files             = [
+    '#{files.join("',\n    '")}'
+  ]
+  s.require_path = 'lib'
+end
+EOF
+
+File.open(File.expand_path("../../refinerycms-snippets.gemspec", __FILE__), 'w').puts(gemspec)

data/lib/generators/refinery/snippets_generator.rb

@@ -0,0 +1,22 @@
+module Refinery
+  class SnippetsGenerator < Rails::Generators::Base
+    
+    def rake_db
+      rake("refinery_snippets:install:migrations")
+    end
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def append_load_seed_data
+      append_file 'db/seeds.rb', :verbose => true do
+        <<-EOH
+
+# Added by RefineryCMS Snippets engine
+Refinery::Snippets::Engine.load_seed
+        EOH
+      end
+    end
+
+
+  end
+end

data/lib/refinery/snippets.rb

@@ -0,0 +1,29 @@
+require 'refinerycms-pages'
+
+module Refinery
+  autoload :SnippetsGenerator, 'generators/refinery/snippets_generator'
+
+  module Snippets
+    require 'refinery/snippets/engine' if defined?(Rails)
+
+    autoload :Version, 'refinery/snippets/version'
+    autoload :Tab, 'refinery/snippets/tabs'
+
+    class << self
+      attr_accessor :root
+      attr_writer :tabs
+
+      def root
+        @root ||= Pathname.new(File.expand_path('../../', __FILE__))
+      end
+
+      def tabs
+        @tabs ||= []
+      end
+
+      def version
+        ::Refinery::Snippets::Version.to_s
+      end
+    end
+  end
+end

data/lib/refinery/snippets/engine.rb

@@ -0,0 +1,49 @@
+require 'refinerycms-snippets'
+
+module Refinery
+  module Snippets
+    class Engine < Rails::Engine
+      include Refinery::Engine
+
+      isolate_namespace Refinery
+      engine_name :refinery_snippets
+
+      config.before_initialize do
+        require 'extensions/page_extensions'
+        require 'extensions/application_helper_extensions'
+      end
+
+      initializer "register refinery_snippets plugin", :after => :set_routes_reloader do |app|
+
+        Refinery::Plugin.register do |plugin|
+          plugin.pathname = root
+          plugin.name = "refinery_snippets"
+          plugin.url = proc {Refinery::Core::Engine.routes.url_helpers.admin_snippets_path}
+          plugin.menu_match = /^\/?(admin|refinery)\/snippets/
+          plugin.activity = {
+                               :class_name => :'refinery/snippet',
+                               :title => 'title'
+                             }
+        end
+      end
+
+      config.to_prepare do
+        Refinery::PagePart.module_eval do
+          has_many :snippet_page_parts, :dependent => :destroy
+          has_many :snippets, :through => :snippet_page_parts, :order => 'position ASC'
+        end
+        Refinery::Page.send :include, Extensions::Page
+        ApplicationHelper.send :include, Extensions::ApplicationHelper
+      end
+
+      config.after_initialize do
+        ::Refinery::Pages::Tab.register do |tab|
+          tab.name = "snippets"
+          tab.partial = "/refinery/admin/pages/tabs/snippets"
+        end
+
+        Refinery.register_engine(Refinery::Snippets)
+      end
+    end
+  end
+end

data/lib/refinery/snippets/tabs.rb

@@ -0,0 +1,22 @@
+module Refinery
+  module Snippets    
+    class Tab
+      attr_accessor :name, :partial
+
+      def self.register(&block)
+        tab = self.new
+
+        yield tab
+
+        raise "A tab MUST have a name!: #{tab.inspect}" if tab.name.blank?
+        raise "A tab MUST have a partial!: #{tab.inspect}" if tab.partial.blank?
+      end
+
+      protected
+
+        def initialize
+          ::Refinery::Snippets.tabs << self # add me to the collection of registered page tabs
+        end
+    end
+  end
+end

data/lib/refinery/snippets/version.rb

@@ -0,0 +1,5 @@
+module Refinery
+  module Snippets
+    VERSION = "1.0.0"
+  end
+end

data/lib/refinerycms-snippets.rb

@@ -0,0 +1 @@
+require 'refinery/snippets'

data/lib/tasks/snippets.rake

@@ -0,0 +1,13 @@
+namespace :refinery do
+  
+  namespace :snippets do
+    
+    # call this task my running: rake refinery:snippets:my_task
+    # desc "Description of my task below"
+    # task :my_task => :environment do
+    #   # add your logic here
+    # end
+  
+  end
+  
+end

data/readme.md

@@ -0,0 +1,52 @@
+# Snippets engine for Refinery CMS.
+
+## About
+
+Snippets allows you to relate one or more html blocks or erb templates to any page in Refinery. These are attached to the page parts, before or after the its html body.
+
+## Requirements
+
+* RefineryCMS with 'Pages' engine (refinerycms-pages >= 2.0.0)
+
+## TODO
+
+### to 1.5
+* improve UI 
+* Documentation
+* Tests
+
+## Install
+
+Add this line to your applications `Gemfile`
+
+    gem 'refinerycms-sl-snippets', '~> 1.0.0', :require => 'refinerycms-snippets'
+    
+Next run
+
+    bundle install
+    rails g refinerycms:snippets
+    rake db:migrate
+
+## Usage
+
+* Create Snippet on /refinery/snippets
+* Now you can attach snippet to page when you click Edit this page on `/refinery/pages`. In the Snippets tab you can select the part to which you want to attach the block and add it after and/or before the html body of the part.  
+* Next you can use content_of(@page, :part) to print the body of the part and the snippets attached to it in the pages views.
+* You have some other interesting methods to work with snippets:
+  * content_or_render_of(snippet): will return the content body (or erb template) of the snippet. 
+  * page.snippets: returns all the snippets attached to all the parts of page.
+  * snippet.pages: returns all pages to whose parts is snippet attached.
+  * snippet.before?(part): returns true if snippet is attached before part body.
+  * snippet.after?(part): return true if snippet is attached after part body.
+
+## ERB templates usage
+
+Snippets search for templates in RAILS_VIEWS_PATH/shared/snippets. The snippet searchs for a file with its same name but with all non A-Za-z0-9 characters changed to underscores. If this file exists, snippet html body is ignored and the template is rendered in its place. Methods rendering the template, if exists, in place of the body are content_of(@page, :part) and content_or_render_of(snippet).
+
+For example, a template with title "VIP clients: photos" would search in "app/views/shared/snippets" for a file named "vip_clients_photos.html.erb"; "Country & region banners: España" for "country_region_banners_espa_na" and so on.
+
+Templates are normal erb files. If you want to add complex logic to them I suggest the use of [Cells](http://cells.rubyforge.org/).
+
+## Thanks
+
+This is build upon the original refinerycms-snippets from keram: https://github.com/keram/refinerycms-snippets