radiant-snippets-extension 1.0.0

data/README.md

@@ -0,0 +1,7 @@
+# Snippets
+
+Use Snippets as reusable bits of content.
+
+This extension was pulled from the original core.
+
+Created by Radiant CMS Development Team. 

data/Rakefile

@@ -0,0 +1,109 @@
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rdoc/task'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => [:spec, :features]
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :features => 'spec:integration'
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  desc "Run the Cucumber features"
+  Cucumber::Rake::Task.new(:integration) do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+    # t.feature_pattern = "#{extension_root}/features/**/*.feature"
+    t.profile = "default"
+  end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the snippets extension.'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SnippetsExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/app/controllers/admin/snippets_controller.rb

@@ -0,0 +1,8 @@
+class Admin::SnippetsController < Admin::ResourceController
+  paginate_models
+  only_allow_access_to :index, :show, :new, :create, :edit, :update, :remove, :destroy,
+    :when => [:designer, :admin],
+    :denied_url => { :controller => 'admin/pages', :action => 'index' },
+    :denied_message => 'You must have designer privileges to perform this action.'
+  
+end

data/app/helpers/admin/snippets_helper.rb

@@ -0,0 +1,41 @@
+module Admin::SnippetsHelper
+  def snippet_edit_javascripts
+    <<-CODE
+    
+    var tagReferenceWindows = {};
+    function loadTagReference() {
+      var pageType = 'Page';
+      if (!tagReferenceWindows[pageType])
+        tagReferenceWindows[pageType] = new Popup.AjaxWindow("#{admin_reference_path('tags')}?class_name=" + encodeURIComponent(pageType), {reload: false});
+      var window = tagReferenceWindows[pageType];
+      if('Page' != pageType) {
+        $('tag_reference_link').highlight();
+        window.show();
+      } else {
+        window.toggle();
+      }
+      lastPageType = pageType;
+      return false;
+    }
+
+    var lastFilter = '#{@snippet.filter_id}';
+    var filterWindows = {};
+    function loadFilterReference() {
+      var filter = $F("snippet_filter_id");
+      if (filter != "") {
+        if (!filterWindows[filter]) filterWindows[filter] = new Popup.AjaxWindow("#{admin_reference_path('filters')}?filter_name="+encodeURIComponent(filter), {reload: false});
+        var window = filterWindows[filter];
+        if(lastFilter != filter) {
+          window.show();
+        } else {
+          window.toggle();
+        }
+        lastFilter = filter;
+      } else {
+        alert('No documentation for filter.');
+      }
+      return false;
+    }
+    CODE
+  end
+end

data/app/models/snippet.rb

@@ -0,0 +1,23 @@
+class Snippet < ActiveRecord::Base
+  
+  # Default Order
+  default_scope :order => 'name'
+  
+  # Associations
+  belongs_to :created_by, :class_name => 'User'
+  belongs_to :updated_by, :class_name => 'User'
+
+  # Validations
+  validates_presence_of :name
+  validates_length_of :name, :maximum => 100
+  validates_length_of :filter_id, :maximum => 25, :allow_nil => true
+  validates_format_of :name, :with => %r{^\S*$}
+  validates_uniqueness_of :name
+  
+  object_id_attr :filter, TextFilter
+
+  def after_initialize
+    self.filter_id ||= Radiant::Config['defaults.snippet.filter'] if new_record?
+  end
+
+end

data/app/views/admin/snippets/_form.html.haml

@@ -0,0 +1,33 @@
+- form_for [:admin, @snippet], :html => {'data-onsubmit_status' => onsubmit_status(@snippet)} do |f|
+  = f.hidden_field :lock_version
+  = render_region :form_top, :locals => {:f => f}
+  .form_area
+    - render_region :form, :locals => {:f => f} do |form|
+      - form.edit_title do
+        %p.title
+          = f.label :name, t('name')
+          = f.text_field :name, :class => 'textbox activate', :maxlength => 100
+      - form.edit_content do
+        %p.content
+          = f.label :content, t('body') 
+          ~ f.text_area :content, :class => "textarea large", :style => "width: 100%"
+      - form.edit_filter do
+        .set
+          %p
+            = f.label :filter_id, t('filter')
+            = f.select :filter_id, filter_options_for_select(f.object.filter_id), :id => 'snippet_filter'
+            %span.reference_links
+              == #{t('reference')}:
+              %span{:id => "filter_reference_link"}
+                = link_to_function t('filter'), "loadFilterReference();"
+              %span{:id => "tag_reference_link"}
+                = link_to_function t('available_tags'), "loadTagReference('Page');"
+  - render_region :form_bottom, :locals => {:f => f} do |form_bottom|
+    - form_bottom.edit_buttons do
+      .buttons{:style=>"clear: left"}
+        = save_model_button(@snippet)
+        = save_model_and_continue_editing_button(@snippet)
+        = t('or')
+        = link_to t('cancel'), admin_snippets_url
+    - form_bottom.edit_timestamp do
+      = updated_stamp @snippet

data/app/views/admin/snippets/edit.html.haml

@@ -0,0 +1,9 @@
+- @page_title = @snippet.name + ' ' + t('snippet') + ' - ' + default_page_title
+
+- render_region :main do |main|
+  - main.edit_header do
+    %h1= t('edit_snippet')  
+  - main.edit_form do
+    = render :partial => 'form'
+
+- content_for 'page_scripts', snippet_edit_javascripts

data/app/views/admin/snippets/index.html.haml

@@ -0,0 +1,33 @@
+- @page_title = t('snippets') + ' - ' + default_page_title
+
+.outset
+  = render_region :top
+  %table.index#snippets
+    %thead
+      %tr
+        - render_region :thead do |thead|
+          - thead.title_header do
+            %th.name= t('snippet')
+          - thead.actions_header do
+            %th.actions{:style=>"width:9em"}= t('modify')
+    %tbody
+      - if @snippets.any?
+        - @snippets.each do |snippet|
+          %tr[snippet]
+            - render_region :tbody, :locals => {:snippet => snippet} do |tbody|
+              - tbody.title_cell do
+                %td.name
+                  = link_to image('snippet', :alt => '') + ' ' + snippet.name, edit_admin_snippet_url(snippet)
+              - tbody.actions_cell do
+                %td.actions
+                  = link_to image('minus') + ' ' + t('remove'), remove_admin_snippet_url(snippet), :class => "action"
+      - else
+        %tr
+          %td.empty{:colspan => admin.snippet.index.tbody.length}= t('no_snippets')
+
+- render_region :bottom do |bottom|
+  - bottom.new_button do
+    #actions
+      = pagination_for(@snippets)
+      %ul
+        %li= link_to image('plus') + " " + t('new_snippet'), new_admin_snippet_url, :class => 'action_button'

data/app/views/admin/snippets/new.html.haml

@@ -0,0 +1,7 @@
+- render_region :main do |main|
+  - main.edit_header do
+    %h1= t('new_snippet')  
+  - main.edit_form do
+    = render :partial => 'form'
+
+- content_for 'page_scripts', snippet_edit_javascripts

data/app/views/admin/snippets/remove.html.haml

@@ -0,0 +1,17 @@
+%h1= t('remove_snippet')
+
+%p 
+  = t('text.snippets.remove_warning')
+
+%table.index#snippets
+  %tbody
+    %tr.node.level_1
+      %td.snippet
+        = image('snippet', :alt => "")
+        %span.title= @snippet.name
+
+- form_for [:admin, @snippet], :html => {:method => :delete, 'data-onsubmit_status'=>"Removing snippet…"} do
+  .buttons
+    %input.button{:type=>"submit", :value => t('delete_snippet')}/
+    = t('or')
+    = link_to t('cancel'), admin_snippets_url

data/config/initializers/radiant_config.rb

@@ -0,0 +1,3 @@
+Radiant.config do |config|
+  # config.define "setting.name", :default => 'value', :select_from => ['foo', 'bar']
+end

data/config/locales/en.yml

@@ -0,0 +1,16 @@
+---
+en:
+  snippet: 'Snippet'   
+  snippets: 'Snippets'
+  config:
+    defaults:
+      snippet:
+        filter: "snippet filter"
+  delete_snippet: 'Delete Snippet'
+  edit_snippet: 'Edit Snippet'
+  new_snippet: 'New Snippet'
+  no_snippets: 'No Snippets'
+  remove_snippet: 'Remove Snippet'
+  text:
+    snippets:
+      remove_warning: 'Are you sure you want to <strong class="warning">permanently remove</strong> the following snippet?'

data/config/routes.rb

@@ -0,0 +1,5 @@
+ActionController::Routing::Routes.draw do |map|
+  map.namespace :admin, :member => { :remove => :get } do |admin|
+    admin.resources :snippets
+  end
+end

data/cucumber.yml

@@ -0,0 +1 @@
+default: --format progress features --tags ~@proposed,~@in_progress

data/features/admin/configuration.feature

@@ -0,0 +1,9 @@
+Feature: Rich configuration
+  In order to control site delivery
+  an administrator
+  wants to change the configuration of the site
+  
+  Scenario: Reviewing configuration
+    Given I am logged in as "admin"
+    And I go to the "configuration" admin page
+    Then I should see "Snippet Filter"

data/features/admin/pagination.feature

@@ -0,0 +1,27 @@
+Feature: Paginating admin views
+  In order to reduce load time and page bulk
+  a content editor
+  wants longer resource lists to be paginated 
+  
+  Background:
+    Given There are many snippets
+    And I am logged in as "designer"
+    And I go to the "snippets" admin page
+
+  Scenario: More snippets than we want to show on one page
+    Then I should see "first"
+    And I should not see "snippet_50"
+    And I should see page 1 of the results
+    And I should see pagination controls
+    And I should see a depagination link
+
+    When I follow "2" within "div.pagination"
+    Then I should see page 2 of the results
+    And I should see "snippet_50"
+
+    When I follow "show all"
+    # Then I should mention the request parameters
+    Then I should see all the snippets
+    And I should not see pagination controls
+    And I should not see a depagination link
+    

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/radiant-snippets-extension.rb

@@ -0,0 +1,8 @@
+module RadiantSnippetsExtension
+  VERSION     = "1.0.0"
+  SUMMARY     = "Snippets for Radiant CMS"
+  DESCRIPTION = "Makes Radiant better by adding snippets!"
+  URL         = "http://github.com/radiant"
+  AUTHORS     = ["Jim Gay"]
+  EMAIL       = ["radiant@radiantcms.org"]
+end

data/lib/snippet_tags.rb

@@ -0,0 +1,80 @@
+module SnippetTags
+  include Radiant::Taggable
+  
+  class TagError < StandardError; end
+  
+  desc %{
+    Renders the snippet specified in the @name@ attribute within the context of a page.
+
+    *Usage:*
+
+    <pre><code><r:snippet name="snippet_name" /></code></pre>
+
+    When used as a double tag, the part in between both tags may be used within the
+    snippet itself, being substituted in place of @<r:yield/>@.
+
+    *Usage:*
+
+    <pre><code><r:snippet name="snippet_name">Lorem ipsum dolor...</r:snippet></code></pre>
+  }
+  tag 'snippet' do |tag|
+    required_attr(tag, 'name')
+    name = tag['name']
+
+    snippet = snippet_cache(name.strip)
+    
+    if snippet
+      tag.locals.yield = tag.expand if tag.double?
+      tag.globals.page.render_snippet(snippet)
+    else
+      raise TagError.new("snippet '#{name}' not found")
+    end
+  end
+
+  def snippet_cache(name)
+    @snippet_cache ||= {}
+
+    snippet = @snippet_cache[name]
+    unless snippet
+      snippet = Snippet.find_by_name(name)
+      @snippet_cache[name] = snippet
+    end
+    snippet
+  end
+  private :snippet_cache
+
+  desc %{
+    Used within a snippet as a placeholder for substitution of child content, when
+    the snippet is called as a double tag.
+
+    *Usage (within a snippet):*
+    
+    <pre><code>
+    <div id="outer">
+      <p>before</p>
+      <r:yield/>
+      <p>after</p>
+    </div>
+    </code></pre>
+
+    If the above snippet was named "yielding", you could call it from any Page,
+    Layout or Snippet as follows:
+
+    <pre><code><r:snippet name="yielding">Content within</r:snippet></code></pre>
+
+    Which would output the following:
+
+    <pre><code>
+    <div id="outer">
+      <p>before</p>
+      Content within
+      <p>after</p>
+    </div>
+    </code></pre>
+
+    When called in the context of a Page or a Layout, @<r:yield/>@ outputs nothing.
+  }
+  tag 'yield' do |tag|
+    tag.locals.yield
+  end
+end

data/lib/tasks/snippets_extension_tasks.rake

@@ -0,0 +1,47 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :snippets do
+      
+      desc "Runs the migration of the Snippets extension"
+      task :migrate => :environment do
+        require 'radiant/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/radiant-snippets-extension.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "radiant-snippets-extension"
+
+Gem::Specification.new do |s|
+  s.name        = "radiant-snippets-extension"
+  s.version     = RadiantSnippetsExtension::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = RadiantSnippetsExtension::AUTHORS
+  s.email       = RadiantSnippetsExtension::EMAIL
+  s.homepage    = RadiantSnippetsExtension::URL
+  s.summary     = RadiantSnippetsExtension::SUMMARY
+  s.description = RadiantSnippetsExtension::DESCRIPTION
+
+  ignores = if File.exist?('.gitignore')
+    File.read('.gitignore').split("\n").inject([]) {|a,p| a + Dir[p] }
+  else
+    []
+  end
+  s.files         = Dir['**/*'] - ignores
+  s.test_files    = Dir['test/**/*','spec/**/*','features/**/*'] - ignores
+  # s.executables   = Dir['bin/*'] - ignores
+  s.require_paths = ["lib"]
+end

data/snippets_extension.rb

@@ -0,0 +1,52 @@
+# Uncomment this if you reference any of your controllers in activate
+# require_dependency "application_controller"
+require "radiant-snippets-extension"
+
+class SnippetsExtension < Radiant::Extension
+  version     RadiantSnippetsExtension::VERSION
+  description RadiantSnippetsExtension::DESCRIPTION
+  url         RadiantSnippetsExtension::URL
+
+  def activate
+    
+    if defined?(Radiant::Exporter)
+      Radiant::Exporter.exportable_models << Snippet
+      Radiant::Exporter.template_models << Snippet
+    end
+    
+    Page.class_eval do
+      include SnippetTags
+    end
+    
+    Radiant::AdminUI.class_eval do
+      attr_accessor :snippet
+      alias_method :snippets, :snippet
+
+      def load_default_snippet_regions
+        OpenStruct.new.tap do |snippet|
+          snippet.edit = Radiant::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 = Radiant::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
+    end
+    
+    admin.snippet ||= Radiant::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,23 @@
+cd ~
+git clone git://github.com/radiant/radiant.git
+cd ~/radiant
+if [[ $RADIANT_VERSION != "master" ]]
+then
+  git checkout -b $RADIANT_VERSION $RADIANT_VERSION
+fi
+cp -r ~/builds/*/radiant-snippets-extension vendor/extensions/snippets
+gem install bundler --pre
+echo 'gem "radiant-snippets-extension", :path => "vendor/extensions/snippets"' >> 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
+bundle exec rake db:migrate:extensions

data/spec/ci/script

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

data/spec/controllers/admin/snippets_controller_spec.rb

@@ -0,0 +1,110 @@
+require File.dirname(__FILE__) + "/../../spec_helper"
+
+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,38 @@
+class SnippetsDataset < Dataset::Base
+  
+  def load
+    create_snippet "first", :content => "test"
+    create_snippet "another", :content => "another test"
+    create_snippet "markdown", :filter_id => "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

data/spec/lib/radiant/admin_ui_spec.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + "/../../spec_helper"
+
+describe Radiant::AdminUI do
+  let(:admin) do
+    @admin = Radiant::AdminUI.new
+    @admin.snippet = @admin.load_default_snippet_regions
+    @admin
+  end
+  
+  subject{ admin }
+  its(:snippet){ should_not be_nil }
+  its(:snippets){ should_not be_nil }
+  
+  context 'edit Region' do
+    subject{ admin.snippet.edit }
+    its(:main){ should == %w{ edit_header edit_form } }
+    its(:form){ should == %w{ edit_title edit_content edit_filter } }
+    its(:form_bottom){ should == %w{ edit_buttons edit_timestamp } }
+  end
+  
+  context 'new Region' do
+    subject{ admin.snippet.new }
+    its(:main){ should == %w{ edit_header edit_form } }
+    its(:form){ should == %w{ edit_title edit_content edit_filter } }
+    its(:form_bottom){ should == %w{ edit_buttons edit_timestamp } }
+  end
+  
+  subject{ admin.snippet.index }
+  its(:top){ should == [] }
+  its(:thead){ should == %w{ title_header actions_header } }
+  its(:tbody){ should == %w{ title_cell actions_cell } }
+  its(:bottom){ should == %w{ new_button } }
+end

data/spec/models/page_spec.rb

@@ -0,0 +1,80 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Page rendering snippets" do
+  dataset :pages, :snippets
+  
+  test_helper :render
+  
+  let(:page){ pages(:home) }
+  
+  it 'should render a snippet' do
+    page.render_snippet(snippets(:first)).should == 'test'
+  end
+
+  it 'should render a snippet with a filter' do
+    page.render_snippet(snippets(:markdown)).should match(%r{<p><strong>markdown</strong></p>})
+  end
+
+  it 'should render a snippet with a tag' do
+    page.render_snippet(snippets(:radius)).should == 'Home'
+  end
+  
+  describe "<r:snippet>" do
+    it "should render the contents of the specified snippet" do
+      page.should render('<r:snippet name="first" />').as('test')
+    end
+
+    it "should render an error when the snippet does not exist" do
+      page.should render('<r:snippet name="non-existant" />').with_error("snippet 'non-existant' not found")
+    end
+
+    it "should render an error when not given a 'name' attribute" do
+      page.should render('<r:snippet />').with_error("`snippet' tag must contain a `name' attribute.")
+    end
+
+    it "should filter the snippet with its assigned filter" do
+      page.should render('<r:page><r:snippet name="markdown" /></r:page>').matching(%r{<p><strong>markdown</strong></p>})
+    end
+
+    it "should maintain the global page inside the snippet" do
+      pages(:parent).should render('<r:snippet name="global_page_cascade" />').as("#{page.title} " * page.children.count)
+    end
+
+    it "should maintain the global page when the snippet renders recursively" do
+      pages(:child).should render('<r:snippet name="recursive" />').as("Great GrandchildGrandchildChild")
+    end
+
+    it "should render the specified snippet when called as an empty double-tag" do
+      page.should render('<r:snippet name="first"></r:snippet>').as('test')
+    end
+
+    it "should capture contents of a double tag, substituting for <r:yield/> in snippet" do
+      page.should render('<r:snippet name="yielding">inner</r:snippet>').
+        as('Before...inner...and after')
+    end
+
+    it "should do nothing with contents of double tag when snippet doesn't yield" do
+      page.should render('<r:snippet name="first">content disappears!</r:snippet>').
+        as('test')
+    end
+
+    it "should render nested yielding snippets" do
+      page.should render('<r:snippet name="div_wrap"><r:snippet name="yielding">Hello, World!</r:snippet></r:snippet>').
+      as('<div>Before...Hello, World!...and after</div>')
+    end
+
+    it "should render double-tag snippets called from within a snippet" do
+      page.should render('<r:snippet name="nested_yields">the content</r:snippet>').
+        as('<snippet name="div_wrap">above the content below</snippet>')
+    end
+
+    it "should render contents each time yield is called" do
+      page.should render('<r:snippet name="yielding_often">French</r:snippet>').
+        as('French is Frencher than French')
+    end
+  end
+
+  it "should do nothing when called from page body" do
+    page.should render('<r:yield/>').as("")
+  end
+end

data/spec/models/snippet_spec.rb

@@ -0,0 +1,59 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Snippet do
+  dataset :snippets
+  test_helper :validations
+  
+  before :each do
+    @original_filter = Radiant::Config['defaults.snippet.filter']
+    @snippet = @model = Snippet.new(snippet_params)
+  end
+
+  after :each do
+    Radiant::Config['defaults.snippet.filter'] = @original_filter
+  end
+
+  it "should take the filter from the default filter" do
+    Radiant::Config['defaults.snippet.filter'] = "Textile"
+    snippet = Snippet.new :name => 'new-snippet'
+    snippet.filter_id.should == "Textile"
+  end
+
+  it "shouldn't override existing snippets filters with the default filter" do
+    snippet = Snippet.find(:first, :conditions => {:filter_id => nil})
+    Radiant::Config['defaults.snippet.filter'] = "Textile"
+    snippet.reload
+    snippet.filter_id.should_not == "Textile"
+  end
+  
+  it 'should validate length of' do
+    {
+      :name => 100,
+      :filter_id => 25
+    }.each do |field, max|
+      assert_invalid field, ('this must not be longer than %d characters' % max), 'x' * (max + 1)
+      assert_valid field, 'x' * max
+    end
+  end
+  
+  it 'should validate presence of' do
+    [:name].each do |field|
+      assert_invalid field, 'this must not be blank', '', ' ', nil
+    end
+  end
+  
+  it 'should validate uniqueness of' do
+    assert_invalid :name, 'this name is already in use', 'first', 'another', 'markdown'
+    assert_valid :name, 'just-a-test'
+  end
+  
+  it 'should validate format of name' do
+    assert_valid :name, 'abc', 'abcd-efg', 'abcd_efg', 'abc.html', '/', '123'
+    assert_invalid :name, 'cannot contain spaces or tabs'
+  end
+  
+  it 'should allow the filter to be specified' do
+    @snippet = snippets(:markdown)
+    @snippet.filter.should be_kind_of(MarkdownFilter)
+  end
+end

data/spec/models/user_action_observer_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe UserActionObserver do
+  dataset :users, :pages_with_layouts, :snippets
+  
+  before(:each) do
+    @user = users(:existing)
+    UserActionObserver.current_user = @user
+  end
+  
+  it 'should observe create' do
+    [
+      Snippet.create!(snippet_params)
+    ].each do |model|
+      model.created_by.should == @user
+    end
+  end
+  
+  it 'should observe update' do
+    [
+      snippets(:first)
+    ].each do |model|
+      model.attributes = model.attributes.dup
+      model.save.should == true
+      model.updated_by.should == @user
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{RADIANT_ROOT}/spec/spec_helper"
+
+Dataset::Resolver.default << (File.dirname(__FILE__) + "/datasets")
+
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-snippets-extension
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+  - Jim Gay
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-05 00:00:00 Z
+dependencies: []
+
+description: Makes Radiant better by adding snippets!
+email: 
+  - radiant@radiantcms.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - cucumber.yml
+  - radiant-snippets-extension.gemspec
+  - Rakefile
+  - README.md
+  - snippets_extension.rb
+  - app/controllers/admin/snippets_controller.rb
+  - app/helpers/admin/snippets_helper.rb
+  - app/models/snippet.rb
+  - app/views/admin/snippets/_form.html.haml
+  - app/views/admin/snippets/edit.html.haml
+  - app/views/admin/snippets/index.html.haml
+  - app/views/admin/snippets/new.html.haml
+  - app/views/admin/snippets/remove.html.haml
+  - config/routes.rb
+  - config/initializers/radiant_config.rb
+  - config/locales/en.yml
+  - features/admin/configuration.feature
+  - features/admin/pagination.feature
+  - features/admin/snippets_management.feature
+  - features/step_definitions/admin/snippet_steps.rb
+  - features/support/env.rb
+  - features/support/paths.rb
+  - lib/radiant-snippets-extension.rb
+  - lib/snippet_tags.rb
+  - lib/tasks/snippets_extension_tasks.rake
+  - spec/spec.opts
+  - spec/spec_helper.rb
+  - spec/ci/before_script
+  - spec/ci/script
+  - spec/controllers/admin/snippets_controller_spec.rb
+  - spec/datasets/snippets_dataset.rb
+  - spec/lib/radiant/admin_ui_spec.rb
+  - spec/models/page_spec.rb
+  - spec/models/snippet_spec.rb
+  - spec/models/user_action_observer_spec.rb
+homepage: http://github.com/radiant
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.9
+signing_key: 
+specification_version: 3
+summary: Snippets for Radiant CMS
+test_files: 
+  - spec/spec.opts
+  - spec/spec_helper.rb
+  - spec/ci/before_script
+  - spec/ci/script
+  - spec/controllers/admin/snippets_controller_spec.rb
+  - spec/datasets/snippets_dataset.rb
+  - spec/lib/radiant/admin_ui_spec.rb
+  - spec/models/page_spec.rb
+  - spec/models/snippet_spec.rb
+  - spec/models/user_action_observer_spec.rb
+  - features/admin/configuration.feature
+  - features/admin/pagination.feature
+  - features/admin/snippets_management.feature
+  - features/step_definitions/admin/snippet_steps.rb
+  - features/support/env.rb
+  - features/support/paths.rb