radiant-group_children-extension 0.1.0

data/README.md

@@ -0,0 +1,25 @@
+# Group Children
+
+This is an extension for [Radiant][1], put together by [jomz][2]
+
+Sometimes you want to iterate over a list of children, and insert something after every n-th child.
+Or, for css reasons you want to group children per 3.
+Until now we have sometimes used javascript to alter markup, which is very ucky..
+
+Here is the solution;
+
+    <r:children:grouped per="3">
+      <div>
+        <r:children:each> ... </r:children:each>
+      </div>
+    </r:children:grouped>
+
+The children:grouped tag takes all the same arguments like children:each, except for pagination.
+Furthermore, inside children:grouped, you can use r:if\_first and r:if\_last to check if you are in the first or last group.
+The children:each within children:grouped does NOT take arguments; those have to be passed to the children:grouped tag itself.
+
+Also note that this extension does not override any of the existing tags, and should be backwards-compatible with 0.8 and earlier.
+
+
+[1]: http://radiantcms.org/ "Radiant: Content management simplified"
+[2]: http://hardcoreforkingaction.com "Hard-core forking action: a low frequency, web-tech blog by Benny Degezelle"

data/Rakefile

@@ -0,0 +1,137 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-group_children-extension"
+    gem.summary = %Q{Group Children Extension for Radiant CMS}
+    gem.description = %Q{Adds the ability to iterate over a page's children per n items.}
+    gem.email = "benny@gorilla-webdesign.be"
+    gem.homepage = "http://github.com/jomz/radiant-group_children-extension"
+    gem.authors = ["Benny Degezelle"]
+    gem.add_dependency 'radiant', ">=0.9.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package group_children as a gem."
+end
+
+# 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 '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
+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 group_children extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GroupChildrenExtension'
+  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 group_children 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/VERSION

@@ -0,0 +1 @@
+0.1.0

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+---
+en:
+  group children: Group Children

data/config/routes.rb

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

data/cucumber.yml

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

data/features/support/env.rb

@@ -0,0 +1,16 @@
+# 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}
+ 
+Cucumber::Rails::World.class_eval do
+  include Dataset
+  datasets_directory "#{RADIANT_ROOT}/spec/datasets"
+  Dataset::Resolver.default = Dataset::DirectoryResolver.new("#{RADIANT_ROOT}/spec/datasets", File.dirname(__FILE__) + '/../../spec/datasets', File.dirname(__FILE__) + '/../datasets')
+  self.datasets_database_dump_path = "#{Rails.root}/tmp/dataset"
+  
+  # dataset :group_children
+end

data/features/support/paths.rb

@@ -0,0 +1,14 @@
+def path_to(page_name)
+  case page_name
+  
+  when /the homepage/i
+    root_path
+  
+  when /login/i
+    login_path
+  # Add more page name => path mappings here
+  
+  else
+    raise "Can't find mapping from \"#{page_name}\" to a path."
+  end
+end

data/group_children_extension.rb

@@ -0,0 +1,10 @@
+class GroupChildrenExtension < Radiant::Extension
+  version "1.0"
+  description "Adds the ability to iterate over a page's children per n items."
+  url "http://github.com/jomz/radiant-group_children-extension"
+  
+  def activate
+    Array.send :include, ArrayHack    
+    Page.send :include, GroupTags
+  end
+end

data/lib/array_hack.rb

@@ -0,0 +1,9 @@
+module ArrayHack
+  def % len
+    inject([]) do |groups, value|
+      groups << [] if !groups.last || groups.last.size >= len
+      groups.last << value
+      groups
+    end
+  end
+end

data/lib/group_tags.rb

@@ -0,0 +1,111 @@
+module GroupTags
+  include Radiant::Taggable
+  
+  class TagError < StandardError; end
+  
+  desc %{
+    Cycles through groups of child pages. Inside this tag, children:each is available again.
+    Takes the same parameters as a normal children:each, except for pagination.
+    
+    *Usage:*
+    
+    <pre><code><r:children:grouped [per="number"] [limit="number"]
+     [by="published_at|updated_at|created_at|slug|title|keywords|description"]
+     [order="asc|desc"] 
+     [status="draft|reviewed|published|hidden|all"]
+     >
+     <div class="container"><r:children:each>...</r:children:each></div>
+    </r:children:grouped>
+    </code></pre>
+  }
+  tag 'children:grouped' do |tag|
+    options = children_find_options(tag)
+    group_size = tag.attr['per'].to_i || 2
+    tag.locals.groups = tag.locals.children.all(options) % group_size
+    result = []
+    tag.locals.groups.each_with_index do |group, i|
+      tag.locals.children = group
+      tag.locals.first_group = i == 0
+      tag.locals.last_group = i == tag.locals.groups.length - 1
+      result << tag.expand
+    end
+    result
+  end
+  
+  tag 'children:grouped:if_first' do |tag|
+    tag.expand if tag.locals.first_group
+  end
+  
+  tag 'children:grouped:if_last' do |tag|
+    tag.expand if tag.locals.last_group
+  end
+  
+  tag 'children:grouped:children' do |tag|
+    tag.expand
+  end
+  
+  tag 'children:grouped:children:each' do |tag|
+    result = []
+    tag.locals.children.each_with_index do |page, i|
+      tag.locals.child = page
+      tag.locals.page = page
+      tag.locals.first_child = i == 0
+      tag.locals.last_child = i == tag.locals.children.length - 1
+      result << tag.expand
+    end
+    result
+  end
+  
+  tag 'children:grouped:children:each:if_first' do |tag|
+    tag.expand if tag.locals.first_child
+  end
+  
+  tag 'children:grouped:children:each:if_last' do |tag|
+    tag.expand if tag.locals.last_child
+  end
+  
+  private
+    def children_find_options(tag)
+      attr = tag.attr.symbolize_keys
+
+      options = {}
+
+      [:limit, :offset].each do |symbol|
+        if number = attr[symbol]
+          if number =~ /^\d{1,4}$/
+            options[symbol] = number.to_i
+          else
+            raise TagError.new("`#{symbol}' attribute of `each' tag must be a positive number between 1 and 4 digits")
+          end
+        end
+      end
+
+      by = (attr[:by] || 'published_at').strip
+      order = (attr[:order] || 'asc').strip
+      order_string = ''
+      if self.attributes.keys.include?(by)
+        order_string << by
+      else
+        raise TagError.new("`by' attribute of `each' tag must be set to a valid field name")
+      end
+      if order =~ /^(asc|desc)$/i
+        order_string << " #{$1.upcase}"
+      else
+        raise TagError.new(%{`order' attribute of `each' tag must be set to either "asc" or "desc"})
+      end
+      options[:order] = order_string
+
+      status = (attr[:status] || ( dev?(tag.globals.page.request) ? 'all' : 'published')).downcase
+      unless status == 'all'
+        stat = Status[status]
+        unless stat.nil?
+          options[:conditions] = ["(virtual = ?) and (status_id = ?)", false, stat.id]
+        else
+          raise TagError.new(%{`status' attribute of `each' tag must be set to a valid status})
+        end
+      else
+        options[:conditions] = ["virtual = ?", false]
+      end
+      options
+    end
+end

data/lib/tasks/group_children_extension_tasks.rake

@@ -0,0 +1,55 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :group_children do
+      
+      desc "Runs the migration of the Group Children extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          GroupChildrenExtension.migrator.migrate(ENV["VERSION"].to_i)
+          Rake::Task['db:schema:dump'].invoke
+        else
+          GroupChildrenExtension.migrator.migrate
+          Rake::Task['db:schema:dump'].invoke
+        end
+      end
+      
+      desc "Copies public assets of the Group Children to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from GroupChildrenExtension"
+        Dir[GroupChildrenExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(GroupChildrenExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+        unless GroupChildrenExtension.root.starts_with? RAILS_ROOT # don't need to copy vendored tasks
+          puts "Copying rake tasks from GroupChildrenExtension"
+          local_tasks_path = File.join(RAILS_ROOT, %w(lib tasks))
+          mkdir_p local_tasks_path, :verbose => false
+          Dir[File.join GroupChildrenExtension.root, %w(lib tasks *.rake)].each do |file|
+            cp file, local_tasks_path, :verbose => false
+          end
+        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 = GroupChildrenExtension.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/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,95 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-group_children-extension
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Benny Degezelle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-23 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: radiant
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  type: :runtime
+  version_requirements: *id001
+description: Adds the ability to iterate over a page's children per n items.
+email: benny@gorilla-webdesign.be
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- VERSION
+- config/locales/en.yml
+- config/routes.rb
+- cucumber.yml
+- features/support/env.rb
+- features/support/paths.rb
+- group_children_extension.rb
+- lib/array_hack.rb
+- lib/group_tags.rb
+- lib/tasks/group_children_extension_tasks.rake
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jomz/radiant-group_children-extension
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Group Children Extension for Radiant CMS
+test_files: 
+- spec/spec_helper.rb