refinerycms-sl-snippets 1.0.0

data/refinerycms-snippets.gemspec

@@ -0,0 +1,106 @@
+Gem::Specification.new do |s|
+  s.platform          = Gem::Platform::RUBY
+  s.name              = %q{refinerycms-sl-snippets}
+  s.version           = %q{1.0.0}
+  s.description       = %q{Ruby on Rails Snippets engine for Refinery CMS}
+  s.date              = %q{2012-09-05}
+  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             = [
+    'app',
+    'app/models',
+    'app/models/refinery',
+    'app/models/refinery/snippet.rb',
+    'app/models/refinery/snippet_page_part.rb',
+    'app/controllers',
+    'app/controllers/refinery',
+    'app/controllers/refinery/admin',
+    'app/controllers/refinery/admin/snippets_controller.rb',
+    'app/controllers/refinery/admin/snippets_page_parts_controller.rb',
+    'app/assets',
+    'app/assets/stylesheets',
+    'app/assets/stylesheets/page-snippet-picker.css',
+    'app/assets/javascripts',
+    'app/assets/javascripts/part-snippets-select.js',
+    'app/assets/javascripts/page-snippet-picker.js',
+    'app/views',
+    'app/views/refinery',
+    'app/views/refinery/admin',
+    'app/views/refinery/admin/snippets',
+    'app/views/refinery/admin/snippets/index.html.erb',
+    'app/views/refinery/admin/snippets/edit.html.erb',
+    'app/views/refinery/admin/snippets/_snippet.html.erb',
+    'app/views/refinery/admin/snippets/new.html.erb',
+    'app/views/refinery/admin/snippets/_locale_picker.html.erb',
+    'app/views/refinery/admin/snippets/_snippets.html.erb',
+    'app/views/refinery/admin/snippets/_records.html.erb',
+    'app/views/refinery/admin/snippets/_form.html.erb',
+    'app/views/refinery/admin/snippets/_actions.html.erb',
+    'app/views/refinery/admin/snippets/_sortable_list.html.erb',
+    'app/views/refinery/admin/snippets_page_parts',
+    'app/views/refinery/admin/snippets_page_parts/add.html.erb',
+    'app/views/refinery/admin/snippets_page_parts/remove.html.erb',
+    'app/views/refinery/admin/pages',
+    'app/views/refinery/admin/pages/tabs',
+    'app/views/refinery/admin/pages/tabs/_snippets_field.html.erb',
+    'app/views/refinery/admin/pages/tabs/_snippets_content.html.erb',
+    'app/views/refinery/admin/pages/tabs/_snippets.html.erb',
+    'app/views/refinery/admin/pages/tabs/_snippets_list_item.html.erb',
+    'app/views/admin',
+    'app/views/admin/pages',
+    'app/views/admin/pages/tabs',
+    'app/views/admin/pages/tabs/_snippets_field.html.erb',
+    'lib',
+    'lib/generators',
+    'lib/generators/refinery',
+    'lib/generators/refinery/snippets_generator.rb',
+    'lib/refinery',
+    'lib/refinery/snippets.rb',
+    'lib/refinery/snippets',
+    'lib/refinery/snippets/version.rb',
+    'lib/refinery/snippets/tabs.rb',
+    'lib/refinery/snippets/engine.rb',
+    'lib/refinerycms-snippets.rb',
+    'lib/gemspec.rb',
+    'lib/tasks',
+    'lib/tasks/snippets.rake',
+    'lib/extensions',
+    'lib/extensions/application_helper_extensions.rb',
+    'lib/extensions/page_extensions.rb',
+    'db',
+    'db/seeds.rb',
+    'db/migrate',
+    'db/migrate/1_create_snippets.rb',
+    'db/migrate/6_remove_position_from_snippets.rb',
+    'db/migrate/2_translate_snippets.rb',
+    'db/migrate/3_create_snippets_page_parts.rb',
+    'spec',
+    'spec/models',
+    'spec/models/page_spec.rb',
+    'spec/models/snippet_spec.rb',
+    'spec/helpers',
+    'spec/helpers/application_helper_spec.rb',
+    'refinerycms-snippets.gemspec',
+    'config',
+    'config/routes.rb',
+    'config/locales',
+    'config/locales/nl.yml',
+    'config/locales/en.yml',
+    'config/locales/es.yml',
+    'config/locales/cs.yml',
+    'readme.md',
+    'features',
+    'features/support',
+    'features/support/paths.rb',
+    'features/step_definitions',
+    'features/step_definitions/snippet_steps.rb',
+    'features/manage_snippets.feature'
+  ]
+  s.require_path = 'lib'
+end

data/spec/helpers/application_helper_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe ApplicationHelper do
+
+  def write_template(snippet = @snippet)
+    FileUtils.mkdir_p Refinery::Snippet::TEMPLATES_DIR
+    @file = File.open("#{Refinery::Snippet::TEMPLATES_DIR}/#{snippet.template_filename}", 'w')
+    @file.write("<%= snippet.title %>")
+    @file.close
+    return @file
+  end
+  
+  before(:each) do
+    @page = Refinery::Page.create!(:title => 'Page title')
+    @part = Refinery::PagePart.create!(:title => 'Part', :body => "PART BODY")
+    @snippet_before = Refinery::Snippet.create!(:title => 'Before title', :body => "BEFORE BODY")
+    @snippet_after = Refinery::Snippet.create!(:title => 'After title', :body => "AFTER BODY")
+    Refinery::SnippetPagePart.create!(:page_part_id => @part.id, :snippet_id => @snippet_before.id, :before_body => true)
+    Refinery::SnippetPagePart.create!(:page_part_id => @part.id, :snippet_id => @snippet_after.id)
+    @page.parts << @part
+  end
+
+  after(:each) do
+    File.delete(@file.path) if @file
+  end
+  
+  it 'should give content for one part wrapped with its snippets' do
+    content_of(@page, :part).should == "BEFORE BODY<p>PART BODY</p>AFTER BODY"
+  end
+
+  it 'should render snippets templates if present' do
+    write_template(@snippet_before)
+    should_receive(:render).with({:file => @snippet_before.template_path}).and_return('TEMPLATE')
+    content_of(@page, :part).should == "TEMPLATE<p>PART BODY</p>AFTER BODY"
+  end
+
+  it "should work when body of part is nil or don't have snippets" do
+    @part.update_attributes(:body => nil)
+    @part.snippets.map(&:delete)
+    Proc.new {content_of(@page, :part)}.should_not raise_exception
+  end
+
+end

data/spec/models/page_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module Refinery
+  module Pages
+    describe Page do
+
+      before(:each) do
+        @page = Page.create!(:title => 'Page title')
+        @part = PagePart.create!(:title => 'Part', :body => "PART BODY")
+        @snippet_before = Snippet.create!(:title => 'Before title', :body => "BEFORE BODY")
+        @snippet_after = Snippet.create!(:title => 'After title', :body => "AFTER BODY")
+        SnippetPagePart.create!(:page_part_id => @part.id, :snippet_id => @snippet_before.id, :before_body => true)
+        SnippetPagePart.create!(:page_part_id => @part.id, :snippet_id => @snippet_after.id)
+        @page.parts << @part
+      end
+
+      it 'should return all snippets attached to its parts' do
+        page = Page.create!(:title => 'Other page')
+        part = PagePart.create!(:title => 'Other part', :body => "OTHER PART BODY")
+        snippet = Snippet.create!(:title => 'Other snippet', :body => "SNIPPET BODY")
+        part.snippets << snippet
+        @page.snippets.should have(2).snippets
+        @page.snippets.each do |s|
+          s.title.should_not == snippet.title
+        end
+        part.snippets.clear
+        part.save
+        page.snippets.should be_empty
+      end
+
+      it "should work when body of part is nil or don't have snippets" do
+        @part.update_attributes(:body => nil)
+        @part.snippets.map(&:delete)
+        Proc.new {@page.content_for(:part)}.should_not raise_exception
+      end
+
+    end
+  end
+end

data/spec/models/snippet_spec.rb

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+module Refinery
+  module Snippets
+    describe Snippet do
+
+      def reset_snippet(options = {})
+        @valid_attributes = {
+          :id => 1,
+          :title => "RSpec is great for testing too"
+        }
+
+        @snippet.destroy! if @snippet
+        @snippet = Snippet.create!(@valid_attributes.update(options))
+      end
+
+      def write_template(snippet = @snippet)
+        FileUtils.mkdir_p Snippet::TEMPLATES_DIR
+        @file = File.open("#{Snippet::TEMPLATES_DIR}/#{snippet.template_filename}", 'w')
+        @file.write("<%= snippet.title %>")
+        @file.close
+        return @file
+      end
+
+      before(:each) do
+        reset_snippet
+      end
+
+      after(:each) do
+        File.delete(@file.path) if @file
+      end
+
+      context "validations" do
+
+        it "rejects empty title" do
+          Snippet.new(@valid_attributes.merge(:title => "")).should_not be_valid
+        end
+
+        it "rejects non unique title" do
+          # as one gets created before each spec by reset_snippet
+          Snippet.new(@valid_attributes).should_not be_valid
+        end
+
+      end
+
+      it 'should return the page it is attached' do
+        @snippet.pages.should be_empty
+        page = Page.create!(:title => 'Page')
+        2.times do
+          other_page = Page.create!(:title => 'Other Page')
+          part = other_page.parts.create(:title => 'Other part', :body => "OTHER PART BODY")
+          part.snippets << @snippet
+        end
+
+        @snippet.pages.should have(2).pages
+        @snippet.pages.each do |p|
+          p.title.should_not == page.title
+        end
+      end
+
+      it 'should return the page it is attached to' do
+        @snippet.pages.should be_empty
+        page = Page.create!(:title => 'Page')
+        2.times do
+          part = PagePart.create!(:title => 'Other part', :body => "OTHER PART BODY")
+          part.page = Page.create!(:title => 'Other Page')
+          part.save!
+          part.snippets << @snippet
+        end
+        @snippet.pages.should have(2).pages
+        @snippet.pages.each do |p|
+          p.title.should_not == page.title
+        end
+      end
+
+      it 'should verify if template for it exists' do
+        @snippet.template?.should be_false
+        write_template
+        @snippet.template?.should be_true
+      end
+
+      it 'should sanitize its title for a filename' do
+        @snippet.template_filename.should == '_rspec_is_great_for_testing_too.html.erb'
+        @snippet.title = '/dir & folder/FooÑBar'
+        @snippet.template_filename.should == '_dir_folder_foo_bar.html.erb'
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: refinerycms-sl-snippets
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- "Rodrigo Garc\xC3\xADa Su\xC3\xA1rez"
+- Simplelogica
+- Marek L.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: refinerycms-pages
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id001
+description: Ruby on Rails Snippets engine for Refinery CMS
+email: rodrigo@simplelogica.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/models/refinery/snippet.rb
+- app/models/refinery/snippet_page_part.rb
+- app/controllers/refinery/admin/snippets_controller.rb
+- app/controllers/refinery/admin/snippets_page_parts_controller.rb
+- app/assets/stylesheets/page-snippet-picker.css
+- app/assets/javascripts/part-snippets-select.js
+- app/assets/javascripts/page-snippet-picker.js
+- app/views/refinery/admin/snippets/index.html.erb
+- app/views/refinery/admin/snippets/edit.html.erb
+- app/views/refinery/admin/snippets/_snippet.html.erb
+- app/views/refinery/admin/snippets/new.html.erb
+- app/views/refinery/admin/snippets/_locale_picker.html.erb
+- app/views/refinery/admin/snippets/_snippets.html.erb
+- app/views/refinery/admin/snippets/_records.html.erb
+- app/views/refinery/admin/snippets/_form.html.erb
+- app/views/refinery/admin/snippets/_actions.html.erb
+- app/views/refinery/admin/snippets/_sortable_list.html.erb
+- app/views/refinery/admin/snippets_page_parts/add.html.erb
+- app/views/refinery/admin/snippets_page_parts/remove.html.erb
+- app/views/refinery/admin/pages/tabs/_snippets_field.html.erb
+- app/views/refinery/admin/pages/tabs/_snippets_content.html.erb
+- app/views/refinery/admin/pages/tabs/_snippets.html.erb
+- app/views/refinery/admin/pages/tabs/_snippets_list_item.html.erb
+- app/views/admin/pages/tabs/_snippets_field.html.erb
+- lib/generators/refinery/snippets_generator.rb
+- lib/refinery/snippets.rb
+- lib/refinery/snippets/version.rb
+- lib/refinery/snippets/tabs.rb
+- lib/refinery/snippets/engine.rb
+- lib/refinerycms-snippets.rb
+- lib/gemspec.rb
+- lib/tasks/snippets.rake
+- lib/extensions/application_helper_extensions.rb
+- lib/extensions/page_extensions.rb
+- db/seeds.rb
+- db/migrate/1_create_snippets.rb
+- db/migrate/6_remove_position_from_snippets.rb
+- db/migrate/2_translate_snippets.rb
+- db/migrate/3_create_snippets_page_parts.rb
+- spec/models/page_spec.rb
+- spec/models/snippet_spec.rb
+- spec/helpers/application_helper_spec.rb
+- refinerycms-snippets.gemspec
+- config/routes.rb
+- config/locales/nl.yml
+- config/locales/en.yml
+- config/locales/es.yml
+- config/locales/cs.yml
+- readme.md
+- features/support/paths.rb
+- features/step_definitions/snippet_steps.rb
+- features/manage_snippets.feature
+homepage: https://github.com/simplelogica/refinerycms-snippets
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Html snippets for Refinery CMS page
+test_files: []
+