trusty-snippets-extension 1.0.0

data/features/admin/snippets_management.feature

@@ -0,0 +1,82 @@
+Feature: Managing snippets
+  In order to share content between layouts and pages, as a designer I want to
+  manage a collection of snippets
+  
+  Background:
+    Given I am logged in as "designer"
+  
+  Scenario: List snippets
+    When I follow "Design" within "#navigation"
+    And I follow "Snippets"
+    Then I should see "first"
+    And I should see "another"
+    And I should see "markdown"
+    # And a host of others
+  
+  Scenario: Create a snippet
+    When I follow "Design" within "#navigation"
+    And I follow "Snippets"
+    And I follow "New Snippet"
+    And I fill in "Name" with "Mine"
+    And I fill in "Body" with "My snippet"
+    And I press "Create Snippet"
+    Then I should be on the snippets list
+    And I should see "Mine"
+  
+  Scenario: Display form errors
+    When I follow "Design" within "#navigation"
+    And I follow "Snippets"
+    And I follow "New Snippet"
+    And I fill in "Body" with "My snippet"
+    And I press "Create Snippet"
+    Then I should see an error message
+    And I should see the form
+  
+  Scenario: Continue editing
+    When I follow "Design" within "#navigation"
+    And I follow "Snippets"
+    And I follow "New Snippet"
+    And I fill in "Name" with "Mine"
+    And I fill in "Body" with "My snippet"
+    And I press "Save and Continue Editing"
+    Then I should see "Edit Snippet"
+    And I should see the form
+  
+  Scenario: View a snippet
+    When I view a filtered snippet
+    Then I should see "Edit Snippet"
+    And I should see "Markdown"
+  
+  Scenario: Delete a snippet with confirmation
+    When I follow "Design" within "#navigation"
+    And I follow "Snippets"
+    And I follow "Remove"
+    Then I should see "permanently remove"
+    And I should see "another"
+    When I press "Delete Snippet"
+    Then I should not see "another"
+      
+  Scenario Outline: Admins and designers can see and edit snippets
+    Given I am logged in as "<username>"
+    And I should see "Design"
+    When I follow "Design" within "#navigation"
+    And I follow "Snippets"
+    And I should not see "You must have designer privileges"
+    And I follow "first"
+    Then I should see "Edit Snippet"
+    
+    Examples:
+      | username  |
+      | admin     |
+      | designer |
+  
+  Scenario Outline: Ordinary users cannot edit snippets
+    Given I am logged in as "<username>"
+    And I should not see "Design"
+    When I go to the "snippets" admin page
+    Then I should see "You must have designer privileges"
+
+    Examples:
+      | username  |
+      | existing  |
+      | another   |

data/features/step_definitions/admin/snippet_steps.rb

@@ -0,0 +1,25 @@
+Given /^There are many snippets$/ do
+  100.times do |i|
+    Snippet.create(:name => "snippet_#{i}", :content => "This is snippet #{i}")
+  end
+end
+
+Given /^There are few snippets$/ do
+  #
+end
+
+Then /^I should see all the snippets$/ do
+  Snippet.all.each do |snippet|
+    response.body.should have_tag('tr.snippet') do
+      with_tag("a", :text => snippet.name)
+    end
+  end
+end
+
+When /^I view a snippet$/ do
+  visit "/admin/snippets/#{snippets(:first).id}"
+end
+
+When /^I view a filtered snippet$/ do
+  visit "/admin/snippets/#{snippets(:markdown).id}"
+end

data/features/support/env.rb

@@ -0,0 +1,11 @@
+# Sets up the Rails environment for Cucumber
+ENV["RAILS_ENV"] = "test"
+# Extension root
+extension_env = File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
+require extension_env+'.rb'
+
+Dir.glob(File.join(RADIANT_ROOT, "features", "**", "*.rb")).each {|step| require step unless step =~ /datasets_loader\.rb$/}
+ 
+Cucumber::Rails::World.class_eval do
+  dataset :snippets
+end

data/features/support/paths.rb

@@ -0,0 +1,22 @@
+module NavigationHelpers
+  
+  # Extend the standard PathMatchers with your own paths
+  # to be used in your features.
+  # 
+  # The keys and values here may be used in your standard web steps
+  # Using:
+  #
+  #   When I go to the "snippets" admin page
+  # 
+  # would direct the request to the path you provide in the value:
+  # 
+  #   admin_snippets_path
+  # 
+  PathMatchers = {} unless defined?(PathMatchers)
+  PathMatchers.merge!({
+    /snippets/i => 'admin_snippets_path'
+  })
+  
+end
+
+World(NavigationHelpers)

data/lib/snippets/engine.rb

@@ -0,0 +1,5 @@
+module Snippets
+  class Engine < Rails::Engine
+    paths["app/helpers"] = []
+  end
+end

data/lib/tasks/snippets_extension_tasks.rake

@@ -0,0 +1,47 @@
+namespace :trusty do
+  namespace :extensions do
+    namespace :snippets do
+      
+      desc "Runs the migration of the Snippets extension"
+      task :migrate => :environment do
+        require 'trusty_cms/extension_migrator'
+        if ENV["VERSION"]
+          SnippetsExtension.migrator.migrate(ENV["VERSION"].to_i)
+          Rake::Task['db:schema:dump'].invoke
+        else
+          SnippetsExtension.migrator.migrate
+          Rake::Task['db:schema:dump'].invoke
+        end
+      end
+      
+      desc "Copies public assets of the Snippets to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from SnippetsExtension"
+        Dir[SnippetsExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(SnippetsExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+      end  
+      
+      desc "Syncs all available translations for this ext to the English ext master"
+      task :sync => :environment do
+        # The main translation root, basically where English is kept
+        language_root = SnippetsExtension.root + "/config/locales"
+        words = TranslationSupport.get_translation_keys(language_root)
+        
+        Dir["#{language_root}/*.yml"].each do |filename|
+          next if filename.match('_available_tags')
+          basename = File.basename(filename, '.yml')
+          puts "Syncing #{basename}"
+          (comments, other) = TranslationSupport.read_file(filename, basename)
+          words.each { |k,v| other[k] ||= words[k] }  # Initializing hash variable as empty if it does not exist
+          other.delete_if { |k,v| !words[k] }         # Remove if not defined in en.yml
+          TranslationSupport.write_file(filename, basename, comments, other)
+        end
+      end
+    end
+  end
+end

data/lib/trusty-snippets-extension.rb

@@ -0,0 +1,8 @@
+module TrustySnippetsExtension
+  VERSION     = "1.0.0"
+  SUMMARY     = "Snippets for Trusty CMS"
+  DESCRIPTION = "Makes Trusty better by adding snippets!"
+  URL         = "http://github.com/pgharts/trusty-snippets-extension"
+  AUTHORS     = ["Jim Gay", "Eric Sipple"]
+  EMAIL       = ["sipple@trustarts.org"]
+end

data/snippets_extension.rb

@@ -0,0 +1,69 @@
+# Uncomment this if you reference any of your controllers in activate
+# require_dependency "application_controller"
+require "trusty-snippets-extension"
+
+class SnippetsExtension < TrustyCms::Extension
+  version     TrustySnippetsExtension::VERSION
+  description TrustySnippetsExtension::DESCRIPTION
+  url         TrustySnippetsExtension::URL
+
+  def activate
+    
+    if defined?(Radiant::Exporter)
+      TrustyCms::Exporter.exportable_models << Snippet
+      TrustyCms::Exporter.template_models << Snippet
+    end
+    
+    Page.class_eval do
+      include SnippetTags
+    end
+
+    TrustyCms::AdminUI.class_eval do
+      attr_accessor :snippet
+
+      alias_method :snippets, :snippet
+
+      def load_default_snippet_regions
+        OpenStruct.new.tap do |snippet|
+          snippet.edit = TrustyCms::AdminUI::RegionSet.new do |edit|
+            edit.main.concat %w{edit_header edit_form}
+            edit.form.concat %w{edit_title edit_content edit_filter}
+            edit.form_bottom.concat %w{edit_buttons edit_timestamp}
+          end
+          snippet.index = TrustyCms::AdminUI::RegionSet.new do |index|
+            index.top.concat %w{}
+            index.thead.concat %w{title_header actions_header}
+            index.tbody.concat %w{title_cell actions_cell}
+            index.bottom.concat %w{new_button}
+          end
+          snippet.new = snippet.edit
+        end
+      end
+
+      def load_default_snippet_file_regions
+        OpenStruct.new.tap do |snippet|
+          snippet.show = TrustyCms::AdminUI::RegionSet.new do |edit|
+            edit.main.concat %w{ header }
+            edit.display_content.concat %w{ title content }
+            edit.bottom.concat %w{ timestamp }
+          end
+          snippet.index = TrustyCms::AdminUI::RegionSet.new do |index|
+            index.top.concat %w{}
+            index.thead.concat %w{title_header}
+            index.tbody.concat %w{title_cell}
+            index.bottom.concat %w{new_button}
+          end
+        end
+      end
+    end
+    
+    admin.snippet       ||= TrustyCms::AdminUI.load_default_snippet_regions
+    
+    UserActionObserver.instance.send :add_observer!, ::Snippet
+                                 
+    tab 'Design' do
+      add_item "Snippets", "/admin/snippets"
+    end
+    
+  end
+end

data/spec/ci/before_script

@@ -0,0 +1,22 @@
+git clone git://github.com/radiant/radiant.git test_app
+cd test_app
+
+if [[ $RADIANT_VERSION != "master" ]]
+then
+  git checkout -t origin/$RADIANT_VERSION
+fi
+gem install bundler --pre
+echo 'gemspec' >> Gemfile
+echo 'gem "radiant-snippets-extension", :path => ".."' >> Gemfile
+bundle install
+
+case $DB in
+  "mysql" )
+    mysql -e 'create database radiant_test;'
+    cp spec/ci/database.mysql.yml config/database.yml;;
+  "postgres" )
+    psql -c 'create database radiant_test;' -U postgres
+    cp spec/ci/database.postgresql.yml config/database.yml;;
+esac
+
+bundle exec rake db:migrate

data/spec/ci/script

@@ -0,0 +1,2 @@
+cd test_app
+bundle exec rake spec:extensions EXT=snippets

data/spec/controllers/admin/snippets_controller_spec.rb

@@ -0,0 +1,110 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../snippets_spec_helper.rb')
+
+describe Admin::SnippetsController do
+  dataset :users, :snippets
+
+  before :each do
+    ActionController::Routing::Routes.reload
+    login_as :designer
+  end
+
+  it "should be an ResourceController" do
+    controller.should be_kind_of(Admin::ResourceController)
+  end
+
+  it "should handle Snippets" do
+    controller.class.model_class.should == Snippet
+  end
+
+
+  describe "show" do
+    it "should redirect to the edit action" do
+      get :show, :id => 1
+      response.should redirect_to(edit_admin_snippet_path(params[:id]))
+    end
+
+    it "should show xml when format is xml" do
+      snippet = Snippet.first
+      get :show, :id => snippet.id, :format => "xml"
+      response.body.should == snippet.to_xml
+    end
+  end
+
+  describe "with invalid snippet id" do
+    [:edit, :remove].each do |action|
+      before do
+        @parameters = {:id => 999}
+      end
+      it "should redirect the #{action} action to the index action" do
+        get action, @parameters
+        response.should redirect_to(admin_snippets_path)
+      end
+      it "should say that the 'Snippet could not be found.' after the #{action} action" do
+        get action, @parameters
+        flash[:notice].should == 'Snippet could not be found.'
+      end
+    end
+    it 'should redirect the update action to the index action' do
+      put :update, @parameters
+      response.should redirect_to(admin_snippets_path)
+    end
+    it "should say that the 'Snippet could not be found.' after the update action" do
+      put :update, @parameters
+      flash[:notice].should == 'Snippet could not be found.'
+    end
+    it 'should redirect the destroy action to the index action' do
+      delete :destroy, @parameters
+      response.should redirect_to(admin_snippets_path)
+    end
+    it "should say that the 'Snippet could not be found.' after the destroy action" do
+      delete :destroy, @parameters
+      flash[:notice].should == 'Snippet could not be found.'
+    end
+  end
+
+  {:get => [:index, :show, :new, :edit, :remove],
+   :post => [:create],
+   :put => [:update],
+   :delete => [:destroy]}.each do |method, actions|
+    actions.each do |action|
+      it "should require login to access the #{action} action" do
+        logout
+        lambda { send(method, action, :id => snippet_id(:first)) }.should require_login
+      end
+
+      if action == :show
+        it "should request authentication for API access on show" do
+          logout
+          send(method, action, :id => snippet_id(:first), :format => "xml")
+          response.response_code.should == 401
+        end
+      else
+        it "should allow access to designers for the #{action} action" do
+          lambda {
+            send(method, action, :id => snippet_id(:first))
+          }.should restrict_access(:allow => [users(:designer)],
+                                  :url => '/admin/pages')
+        end
+
+        it "should allow access to admins for the #{action} action" do
+          lambda {
+            send(method, action, :id => snippet_id(:first))
+          }.should restrict_access(:allow => [users(:designer)],
+                                   :url => '/admin/pages')
+        end
+
+        it "should deny non-designers and non-admins for the #{action} action" do
+          lambda {
+            send(method, action, :id => Snippet.first.id)
+          }.should restrict_access(:deny => [users(:non_admin), users(:existing)],
+                                   :url => '/admin/pages')
+        end
+      end
+    end
+  end
+
+  it "should clear the page cache when saved" do
+    Radiant::Cache.should_receive(:clear)
+    put :update, :id => snippet_id(:first), :snippet => {:content => "Foobar."}
+  end
+end

data/spec/datasets/snippets_dataset.rb

@@ -0,0 +1,44 @@
+class SnippetMarkdownFilter < TextFilter
+  def filter(text)
+    text + ' for Snippets!'
+  end
+end
+
+class SnippetsDataset < Dataset::Base
+  
+  def load
+    create_snippet "first", :content => "test"
+    create_snippet "another", :content => "another test"
+    create_snippet "markdown", :filter_id => "Snippet Markdown", :content => "**markdown**"
+    create_snippet "radius", :content => "<r:title />"
+    create_snippet "global_page_cascade", :content => "<r:children:each><r:page:title /> </r:children:each>"
+    create_snippet "recursive", :content => "<r:children:each><r:snippet name='recursive' /></r:children:each><r:title />"
+    create_snippet "yielding", :content => "Before...<r:yield/>...and after"
+    create_snippet "div_wrap", :content => "<div><r:yield/></div>"
+    create_snippet "nested_yields", :content => '<snippet name="div_wrap">above <r:yield/> below</snippet>'
+    create_snippet "yielding_often", :content => '<r:yield/> is <r:yield/>er than <r:yield/>'
+  end
+  
+  helpers do
+    def create_snippet(name, attributes={})
+      create_record :snippet, name.symbolize, snippet_params(attributes.reverse_merge(:name => name))
+    end
+    
+    def snippet_params(attributes={})
+      name = attributes[:name] || unique_snippet_name
+      { 
+        :name => name,
+        :content => "<r:content />"
+      }.merge(attributes)
+    end
+    
+    private
+    
+      def unique_snippet_name
+        @@unique_snippet_name_call_count ||= 0
+        @@unique_snippet_name_call_count += 1
+        "snippet-#{@@unique_snippet_name_call_count}"
+      end
+  end
+  
+end