radiant-parameterized_snippets-extension 1.0.1

data/README

@@ -0,0 +1,47 @@
+= Radiant 'Parameterized Snippets' Extension
+
+Call snippets with parameters which can be reused in the snippet.
+
+
+= Installation
+
+In your Rails app directory:
+
+git clone git://github.com/manuelmeurer/radiant-parameterized-snippets-extension.git vendor/extensions/parameterized_snippets
+
+Or download the ZIP or TAR file from http://github.com/manuelmeurer/radiant-parameterized-snippets-extension/ and extract to vendor/extensions/parameterized_snippets
+
+
+= Usage
+
+In some page:
+
+  What's up with elephants?
+  
+  <r:snippet name="animal_info" animal="elephant" />
+  
+  And lions? What do lions do?
+  
+  <r:snippet name="animal_info" animal="lion" />
+
+In snippet 'animal_info':
+
+  <r:unless_var name="animal">
+    What animal do you want info about?
+    Please set the 'animal' parameter when calling this snippet!
+  </r:unless_var>
+  <r:if_var name="animal">
+    <r:if_var name="animal" matches=".*cat.*">
+      So you wanna know something about a cat?
+      Could be a 'house cat', just a 'cat' or a 'caterpillar'...
+      But it is a <r:var name="animal" />!
+    </r:if_var>
+
+    <r:unless_var name="animal" matches="ant|mouse|eagle">
+      Glad you didn't ask about ants, mice or eagles! I don't know JACK about those animals!
+    </r:if_var>
+    
+    Enimal? Is there an enimal? If yes, tell me what it is, 
+    if no, don't you dare returning an error message! <r:var name="enimal" missing="ignore" />
+  </r:if_var>
+

data/Rakefile

@@ -0,0 +1,120 @@
+# I think this is the one that should be moved to the extension Rakefile template
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# 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 'rake/rdoctask'
+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 'spec/translator'
+
+# 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
+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
+
+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
+  
+  # Hopefully no one has written their extensions in pre-0.9 style
+  # desc "Translate specs from pre-0.9 to 0.9 style"
+  # task :translate do
+  #   translator = ::Spec::Translator.new
+  #   dir = RAILS_ROOT + '/spec'
+  #   translator.translate(dir, dir)
+  # 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 parameterized_snippets extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ParameterizedSnippetsExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the parameterized_snippets extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/lib/parameterized_snippets/page_ext.rb

@@ -0,0 +1,94 @@
+module ParameterizedSnippets
+  module PageExt
+
+    include Radiant::Taggable
+
+    desc %{
+      Renders the containing elements only if the snippet was called with a certain parameter.
+      If an additional "matches" parameter containing a regular expression is used, the containing
+      elements are only rendered if the parameter exists and matches the regular expression.
+      
+      *Usage:*
+      
+      <pre><code><r:if_var name="parameter_name" [matches="regex"]>...</r:if_var></code></pre>
+      
+      *Example:*
+      
+      Some page:
+      
+      <pre><code><r:snippet name="animal_info" animal="elephant" /></code></pre>
+
+      animal_info snippet:
+      
+      <pre><code><r:if_var name="animal" matches=".le(?:ph|f)ant">...</r:if_var></code></pre>
+    }
+    tag 'snippet:if_var' do |tag|
+      tag.expand if var_exists_and_matches(tag)
+    end
+
+    desc %{
+      The opposite of the @if_var@ tag.
+      
+      *Usage:*
+      
+      <pre><code><r:unless_var name="parameter_name" [matches="regex"]>...</r:unless_var></code></pre>
+    }
+    tag 'snippet:unless_var' do |tag|
+      tag.expand unless var_exists_and_matches(tag)
+    end
+
+    desc %{
+      Outputs the value of the parameter.
+      If the value cannot be found, an error message or, if you use the 'missing' parameter, nothing is shown.
+      
+      *Usage:*
+
+      <pre><code><r:var name="parameter_name" [missing="ignore"] /></code></pre>
+      
+      *Example:*
+      
+      Some page:
+      
+      <pre><code><r:snippet name="animal_info" animal="elephant" /></code></pre>
+
+      animal_info snippet:
+      
+      <pre><code><r:var name="animal" /> # Outputs 'elephant'
+      <r:var name="enimal" missing="ignore" /> # Outputs nothing</code></pre>
+    }
+    tag 'snippet:var' do |tag|
+      ignore_missing = tag.attr['missing'] == 'ignore'
+      var = check_for_attr(tag, 'name')
+      tag_binding = get_snippet_tag_binding(tag)
+      if tag_binding && tag_binding.attr[var]
+        tag_binding.attr[var]
+      else
+        ignore_missing ? '' : "Could not find parameter '#{var}' in snippet '#{tag_binding.attributes['name']}'."
+      end
+    end
+
+    protected
+
+      def check_for_attr(tag, attr)
+        returning type = tag.attr[attr.to_s].to_s do
+          raise TagError, "Please define the '#{attr}' attribute for the tag '#{tag.name}'." unless type
+        end
+      end
+
+      def get_snippet_tag_binding(tag)
+        tag.context.instance_variable_get(:@tag_binding_stack).reverse.detect { |tag_binding| tag_binding.name == 'snippet' }
+      end
+
+      def var_exists_and_matches(tag)
+        var = check_for_attr(tag, 'name')
+        tag_binding = get_snippet_tag_binding(tag)
+        if tag.attr['matches']
+          tag_binding.attr[var] =~ /^#{tag.attr['matches']}$/
+        else
+          tag_binding.attr[var]
+        end
+      end
+
+  end
+end
+

data/lib/radiant-parameterized_snippets-extension.rb

@@ -0,0 +1,8 @@
+module RadiantParameterizedSnippetsExtension
+  AUTHORS     = 'Manuel Meurer, Michael Starke (gemification)'
+  EMAIL       = 'manuel.meurer@gmail.com'
+  DESCRIPTION = 'Allow sending parameters to snippets'
+  URL         = 'http://github.com/mstarke/radiant-parameterized-snippets-extension'
+  VERSION     = '1.0.1'
+  SUMMARY     = 'Parameters in snippets'
+end

data/lib/tasks/parameterized_snippets_extension_tasks.rake

@@ -0,0 +1,28 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :parameterized_snippets do
+      
+      desc "Runs the migration of the Parameterized Snippets extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          ParameterizedSnippetsExtension.migrator.migrate(ENV["VERSION"].to_i)
+        else
+          ParameterizedSnippetsExtension.migrator.migrate
+        end
+      end
+      
+      desc "Copies public assets of the Parameterized Snippets to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        Dir[ParameterizedSnippetsExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(ParameterizedSnippetsExtension.root, '')
+          directory = File.dirname(path)
+          puts "Copying #{path}..."
+          mkdir_p RAILS_ROOT + directory
+          cp file, RAILS_ROOT + path
+        end
+      end  
+    end
+  end
+end

data/parameterized_snippets_extension.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "radiant-parameterized_snippets-extension"
+
+Gem::Specification.new do |s|
+  s.name        = "radiant-parameterized_snippets-extension"
+  s.version     = RadiantParameterizedSnippetsExtension::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = RadiantParameterizedSnippetsExtension::AUTHORS
+  s.email       = RadiantParameterizedSnippetsExtension::EMAIL
+  s.homepage    = RadiantParameterizedSnippetsExtension::URL
+  s.summary     = RadiantParameterizedSnippetsExtension::SUMMARY
+  s.description = RadiantParameterizedSnippetsExtension::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.require_paths = ["lib"]
+end

data/parameterized_snippets_extension.rb

@@ -0,0 +1,11 @@
+class ParameterizedSnippetsExtension < Radiant::Extension
+
+  def activate
+    Page.send :include, ParameterizedSnippets::PageExt
+  end
+
+  def deactivate
+  end
+
+end
+

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+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"
+
+if File.directory?(File.dirname(__FILE__) + "/scenarios")
+  Scenario.load_paths.unshift File.dirname(__FILE__) + "/scenarios"
+end
+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,71 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-parameterized_snippets-extension
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Manuel Meurer, Michael Starke (gemification)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-04 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Allow sending parameters to snippets
+email: manuel.meurer@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/parameterized_snippets/page_ext.rb
+- lib/radiant-parameterized_snippets-extension.rb
+- lib/tasks/parameterized_snippets_extension_tasks.rake
+- parameterized_snippets_extension.gemspec
+- parameterized_snippets_extension.rb
+- Rakefile
+- README
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mstarke/radiant-parameterized-snippets-extension
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Parameters in snippets
+test_files: 
+- spec/spec.opts
+- spec/spec_helper.rb