radiant-children_config-extension 1.0.0

data/README.md

@@ -0,0 +1,50 @@
+# Children Config
+
+Allows you to define new default page parts on every page.
+Based on the [default\_page\_parts extension](https://github.com/santry/radiant-default-page-parts-extension), originally created by Sean Santry.
+
+## How to use
+
+Let's say you want all pages under "Events" to have the page parts "location", "description" and "date" by default. 
+Simply add a "children_config" page part to the "Events" page. In the content of that page part, put: 
+
+    ---
+    - parts
+      - name: location
+        filter: none
+      - name: description
+        filter: markdown
+      - name: date
+        filter: none
+
+If you are using the [page_parts extension](https://github.com/digitalpulp/radiant-page_parts-extension), you can also pass the desired page part type like so:
+
+    ---
+    - parts
+      - name: location
+        filter: none
+        page_part_type: location_page_part
+      - name: description
+        filter: markdown
+      - name: date
+        filter: none
+        page_part_type: date_page_part
+
+Another feature is to automatically create children for every new event page:
+
+    ---
+    - parts
+      - name: location
+        filter: none
+        page_part_type: location_page_part
+      - name: description
+        filter: markdown
+      - name: date
+        filter: none
+        page_part_type: date_page_part
+    - children
+      - title: News
+        status: published
+        parts:
+          - name: body
+            content: "<r:children:each><div><r:content /></div></r:children:each>"

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 '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, :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 children_config extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ChildrenConfigExtension'
+  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/children_config_extension.rb

@@ -0,0 +1,13 @@
+# Uncomment this if you reference any of your controllers in activate
+# require_dependency 'application_controller'
+require 'radiant-children_config-extension/version'
+class ChildrenConfigExtension < Radiant::Extension
+  version RadiantChildrenConfigExtension::VERSION
+  description "Allows you to override the configuration of page parts for new children under a given page."
+  url "https://github.com/jomz/radiant-children_config-extension"
+  
+  def activate
+    Page.send :include, ChildrenConfig::PageExtensions
+    Admin::PagesController.send :include, ChildrenConfig::PagesControllerExtensions
+  end
+end

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,3 @@
+---
+en:
+  children config: Children Config

data/config/routes.rb

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

data/cucumber.yml

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

data/features/admin/children_config.feature

@@ -0,0 +1,7 @@
+Feature: Children config
+  Scenario: With a children_config part
+    Given I am logged in as "existing"
+    And there is a homepage
+    When I edit the "home" page
+    And I press "Foo"
+    Then I should see "boo"

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 :children_config
+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 "children_config" admin page
+  # 
+  # would direct the request to the path you provide in the value:
+  # 
+  #   admin_children_config_path
+  # 
+  PathMatchers = {} unless defined?(PathMatchers)
+  PathMatchers.merge!({
+    # /children_config/i => 'admin_children_config_path'
+  })
+  
+end
+
+World(NavigationHelpers)

data/lib/children_config/page_extensions.rb

@@ -0,0 +1,64 @@
+module ChildrenConfig::PageExtensions
+  def self.included(base)
+    base.class_eval do
+      after_save :create_children
+      
+      def self.new_with_page_parts(config = Radiant::Config, parts = String)
+        begin
+          unless parts.empty?
+            config = YAML::load(parts)
+            if config.is_a?(Array) && config.select{|c| c.has_key? "parts"}.size > 0
+              page = new
+              options = {}
+              config.select{|c| c.has_key? "parts"}.first["parts"].each do |part|
+                options[:name] = part['name']
+                options[:content] = part['content']
+                default_filter = part['filter'].to_s.camelize
+                options[:filter_id] = ["SmartyPants", "Markdown", "Textile", "WymEditor", "CKEditor"].include?(default_filter) ? "#{default_filter}" : ""
+                # Consider page part type if page_parts extension is present
+                if PagePart.column_names.include? "page_part_type"
+                  options[:page_part_type] = part['page_part_type'].to_s.camelize
+                end
+                page.parts << PagePart.new(options)
+              end
+              page
+            end
+          else
+            new_with_defaults(config)
+          end
+        rescue
+          new_with_defaults(config)
+        end
+      end
+      
+      
+    end
+  end
+  
+  def create_children
+    if updated_at == created_at and parent and children_config = parent.part(:children_config).try(:content)
+      config = YAML::load(children_config)
+      if config.is_a?(Array) && config.select{|c| c.has_key? "children"}.size > 0
+        config.select{|c| c.has_key? "children"}.first["children"].each do |child|
+          options = {}
+          options[:parent_id] = self.id
+          options[:status_id] = Status[child['status'].downcase.to_sym].id
+          page = Page.new(options)
+          page.breadcrumb = page.title = child['title']
+          page.slug = child['title'].slugify
+          if child.has_key? "parts"
+            child["parts"].each do |part|
+              part["page_part_type"] = part["page_part_type"].to_s.camelize
+              page.parts.build(part)
+            end
+          else
+            page.parts.concat default_page_parts(Radiant::Config)
+          end
+          raise page.errors.full_messages.join ", " unless page.valid?
+          page.save
+        end
+      
+      end
+    end
+  end
+end

data/lib/children_config/pages_controller_extensions.rb

@@ -0,0 +1,19 @@
+module ChildrenConfig::PagesControllerExtensions
+  def self.included(base)
+    base.class_eval do
+      alias :original_new :new
+
+      def new
+        unless params[:page_id].blank?
+          parent_page = Page.find(params[:page_id]);
+          child_parts = parent_page.part("children_config").content
+          self.model = model_class.new_with_page_parts(config, child_parts)
+        else
+          self.model = model_class.new_with_defaults(config)
+          self.model.slug = '/'
+        end
+        response_for :singular
+      end
+    end
+  end
+end

data/lib/radiant-children_config-extension/version.rb

@@ -0,0 +1,3 @@
+module RadiantChildrenConfigExtension
+  VERSION = '1.0.0'
+end

data/lib/radiant-children_config-extension.rb

@@ -0,0 +1,2 @@
+module RadiantChildrenConfigExtension
+end

data/lib/tasks/children_config_extension_tasks.rake

@@ -0,0 +1,55 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :children_config do
+      
+      desc "Runs the migration of the Children Config extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          ChildrenConfigExtension.migrator.migrate(ENV["VERSION"].to_i)
+          Rake::Task['db:schema:dump'].invoke
+        else
+          ChildrenConfigExtension.migrator.migrate
+          Rake::Task['db:schema:dump'].invoke
+        end
+      end
+      
+      desc "Copies public assets of the Children Config to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from ChildrenConfigExtension"
+        Dir[ChildrenConfigExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(ChildrenConfigExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+        unless ChildrenConfigExtension.root.starts_with? RAILS_ROOT # don't need to copy vendored tasks
+          puts "Copying rake tasks from ChildrenConfigExtension"
+          local_tasks_path = File.join(RAILS_ROOT, %w(lib tasks))
+          mkdir_p local_tasks_path, :verbose => false
+          Dir[File.join ChildrenConfigExtension.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 = ChildrenConfigExtension.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-children_config-extension.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "radiant-children_config-extension/version"
+
+Gem::Specification.new do |s|
+  s.name        = "radiant-children_config-extension"
+  s.version     = RadiantChildrenConfigExtension::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Your Name"]
+  s.email       = ["your email"]
+  s.homepage    = "http://yourwebsite.com/children_config"
+  s.summary     = %q{Children Config for Radiant CMS}
+  s.description = %q{Makes Radiant better by adding children_config!}
+  
+  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"]
+  
+  s.post_install_message = %{
+  Add this to your radiant project with:
+    config.gem 'radiant-children_config-extension', :version => '~>#{RadiantChildrenConfigExtension::VERSION}'
+  }
+end

data/spec/controllers/admin/pages_controller_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Admin::PagesController do
+  dataset :home_page, :users, :children_config
+  
+  before do
+    login_as :admin
+  end
+  
+  it "should create the parts defined in children_config instead of the defaults" do
+    get :new, :page_id => page_id(:services)
+    response.should be_success
+    page = assigns(:page)
+    page.parts.map(&:name).join(" ").should eql("location description dat")
+  end
+  
+end

data/spec/datasets/children_config_dataset.rb

@@ -0,0 +1,16 @@
+class ChildrenConfigDataset < Dataset::Base
+  uses :home_page
+
+  def load
+    create_page "Services", :slug => "services", :parent_id => page_id(:home) do
+      create_page_part "children_config", :content => "---
+- name: location
+  filter: none
+- name: description
+  filter: markdown
+- name: date
+  filter: none"
+    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,91 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-children_config-extension
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Your Name
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-24 00:00:00 Z
+dependencies: []
+
+description: Makes Radiant better by adding children_config!
+email: 
+- your email
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- children_config_extension.rb
+- config/initializers/radiant_config.rb
+- config/locales/en.yml
+- config/routes.rb
+- cucumber.yml
+- features/admin/children_config.feature
+- features/support/env.rb
+- features/support/paths.rb
+- lib/children_config/page_extensions.rb
+- lib/children_config/pages_controller_extensions.rb
+- lib/radiant-children_config-extension/version.rb
+- lib/radiant-children_config-extension.rb
+- lib/tasks/children_config_extension_tasks.rake
+- radiant-children_config-extension.gemspec
+- Rakefile
+- README.md
+- spec/controllers/admin/pages_controller_spec.rb
+- spec/datasets/children_config_dataset.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: http://yourwebsite.com/children_config
+licenses: []
+
+post_install_message: "\n  Add this to your radiant project with:\n    config.gem 'radiant-children_config-extension', :version => '~>1.0.0'\n  "
+rdoc_options: []
+
+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.8.5
+signing_key: 
+specification_version: 3
+summary: Children Config for Radiant CMS
+test_files: 
+- spec/controllers/admin/pages_controller_spec.rb
+- spec/datasets/children_config_dataset.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- features/admin/children_config.feature
+- features/support/env.rb
+- features/support/paths.rb