trusty-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,3 @@
+module Admin::SnippetsHelper
+
+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 ||= TrustyCms::Config['defaults.snippet.filter'] if new_record?
+  end
+
+end

data/app/models/snippet_finder.rb

@@ -0,0 +1,24 @@
+class SnippetFinder
+  class << self
+    def find(id)
+      find_map('find',id)
+    end
+
+    def find_by_name(name)
+      find_map('find_by_name', name)
+    end
+
+    def finder_types
+      [SnippetFile, Snippet]
+    end
+
+    private
+
+    def find_map(meth, *args)
+      finder_types.find{|type|
+        found = type.send(meth, *args)
+        return found if found
+      }
+    end
+  end
+end

data/app/models/snippet_tags.rb

@@ -0,0 +1,80 @@
+module SnippetTags
+  include TrustyCms::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 = SnippetFinder.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/app/views/admin/snippets/_form.html.haml

@@ -0,0 +1,29 @@
+= 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
+            %span.reference_links
+              == #{t('reference')}:
+              %span{:id => "tag_reference_link"}
+                = link_to t('available_tags'), admin_reference_url(:tags), id: 'tag_reference'
+  - 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/_popups.html.haml

@@ -0,0 +1,4 @@
+- content_for :popups do
+  #popup_window
+    .outer
+      .content

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

@@ -0,0 +1,11 @@
+- @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'
+  - main.edit_popups do
+    = render :partial => "popups"
+
+- content_for 'page_scripts'

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,9 @@
+- render_region :main do |main|
+  - main.edit_header do
+    %h1= t('new_snippet')  
+  - main.edit_form do
+    = render :partial => 'form'
+  - main.edit_popups do
+    = render :partial => "popups"
+
+- content_for 'page_scripts'

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 @@
+if TrustyCms.config_definitions['defaults.snippet.filter'].nil?
+  TrustyCms.config.define 'defaults.snippet.filter', :select_from => lambda { TextFilter.descendants.map { |s| s.filter_name }.sort }, :allow_blank => true
+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,8 @@
+TrustyCms::Application.routes.draw do
+  namespace :admin do
+
+    resources :snippets do
+      get :remove, on: :member
+    end
+  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
+