radiant-reorder_children-extension 1.0.0

data/README.md

@@ -0,0 +1,40 @@
+Reorder Children
+===
+
+About
+---
+
+Adds the ability to reorder the children of a certain page with drag and drop.
+Tested on Radiant 1.0.0.rc2, but should work for older versions.
+
+This extension is based on the work done by John Long in preparation for the feature to be a part
+of Radiant 0.6.1. In the interest of making it available as soon as possible, it has been packaged
+here for all the world to see.
+
+"packaged here" was actually pointing to the old radiant subversion repository, so it was regenerated in a modern Radiant,
+and cleaned up a bit.
+
+Installation
+---
+  
+    git clone git://github.com/jomz/radiant-reorder_children-extension.git vendor/extensions/reorder_children
+    
+or, add the gem to your environment.rb:
+
+    config.gem "radiant-reorder_children-extension"
+
+Then update and migrate:    
+
+    rake db:migrate:extensions
+    rake radiant:extensions:reorder:update
+
+###Added Tags
+
+Adds r:next and r:previous tags. These default to the previous and next sibling by position. 
+Add a 'by' attribute to use i.e. the published_at column.
+
+    <r:next [by="position|published_at|slug"]></r:next>
+
+[rre]: https://github.com/radiant/radiant-reorder-extension
+[jomz]: http://github.com/jomz
+[radiant]: http://radiantcms.org/

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 reorder_children extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ReorderChildrenExtension'
+  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/views/admin/pages/_reorder_extra_td.html.haml

@@ -0,0 +1,3 @@
+%td.reorder
+  - unless simple || page.respond_to?(:stop_recurring) || page.respond_to?(:tree_children) || page.children.empty?
+    = link_to image('reorder', :alt => 'Reorder'), page_reorder_children_url(:id => page)

data/app/views/admin/pages/_reorder_extra_th.html.haml

@@ -0,0 +1,2 @@
+- @stylesheets << 'admin/reorder'
+%th &nbsp;

data/app/views/admin/pages/reorder.html.haml

@@ -0,0 +1,61 @@
+:css
+  .page {
+    font-size: 120%;
+    font-weight: bold;
+    position: relative;
+    padding: 10px;
+    padding-left: 30px;
+    border-top: 1px solid #eaeaea;
+  }
+  .page .icon {
+    position: absolute;
+    margin-top: -7px;
+    left: 0px;
+  }
+  ul.pages,
+  ul.pages li {
+    list-style: none;
+    margin: 0;
+    padding: 0
+  }
+  ul.pages {
+    border-bottom: 1px solid #eaeaea;
+  }
+  ul.pages li {
+    font-size: 105%;
+    font-weight: normal;
+    padding: 10px;
+    padding-left: 52px;
+  }
+  ul.page .icon,
+  ul.pages .icon {
+    position: absolute;
+    margin-top: -7px;
+    left: 22px;
+  }
+
+%h1#reorder_pages= t('reorder_pages')
+
+%p= t('drag_and_drop_to_reorder')
+
+#page.page
+  = page_icon(@page)
+  = @page.title
+
+%ul#children.pages
+  - for child in @children
+    %li{:id => "item_#{child.id}", :class => "page"}
+      = page_icon(child)
+      = child.breadcrumb
+
+:javascript
+  Sortable.create("children", { onUpdate:function(){ $('sort_order').value = Sortable.sequence('children').join(',') } });
+
+- @javascripts << 'admin/dragdrop'
+- form_tag do
+  %p.buttons
+    = submit_tag t("buttons.save_changes"), :class => 'button'
+    = t('or')
+    = link_to t('cancel'), admin_pages_url
+  
+  %div= hidden_field_tag "sort_order"

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,5 @@
+---
+en:
+  drag_and_drop_to_reorder: Drag and drop pages to reorder. Click <strong>Save Changes</strong> when you are done.
+  reorder: Reorder
+  reorder_pages: Reorder Pages

data/config/locales/nl.yml

@@ -0,0 +1,5 @@
+---
+nl:
+  drag_and_drop_to_reorder: Versleep de pagina's om te herschikken. Klik <strong>Opslaan</strong> wanneer je klaar bent.
+  reorder: Herschikken
+  reorder_pages: Pagina's herschikken

data/config/routes.rb

@@ -0,0 +1,3 @@
+ActionController::Routing::Routes.draw do |map|
+  map.page_reorder_children  'admin/pages/reorder/:id', :controller => 'admin/pages', :action => 'reorder'
+end

data/cucumber.yml

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

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

data/lib/radiant-reorder_children-extension.rb

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

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

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

data/lib/reorder_children/page_extensions.rb

@@ -0,0 +1,13 @@
+module ReorderChildren
+  module PageExtensions
+    def included(page_base)
+      page_base.send(:before_create, :update_position)
+    end
+  
+    def update_position
+      last = Page.find(:first, :conditions => { :parent_id => parent_id }, :order => 'position DESC')
+      write_attribute('position', last.position + 1) if last
+      true
+    end
+  end
+end

data/lib/reorder_children/page_helper_extensions.rb

@@ -0,0 +1,8 @@
+module ReorderChildren
+  module PageHelperExtensions
+    def page_icon(page)
+      icon_name = page.virtual? ? 'virtual_page' : 'page'
+      image(icon_name, :class => "icon", :alt => '', :title => '')
+    end
+  end
+end

data/lib/reorder_children/pages_controller_extensions.rb

@@ -0,0 +1,23 @@
+module ReorderChildren
+  module PagesControllerExtensions
+    def reorder
+      if request.post?
+        sort_order = params[:sort_order].to_s.split(',').map { |i| Integer(i) rescue nil }.compact
+        sort_order.each_with_index do |id, index|
+          Page.update(id, :position => index)
+        end
+      
+        if defined? ResponseCache == 'constant'
+          ResponseCache.instance.clear
+        else
+          Radiant::Cache.clear
+        end
+      
+        redirect_to admin_pages_url
+      else
+        @page = Page.find(params[:id])
+        @children = @page.children
+      end
+    end
+  end
+end

data/lib/reorder_children/radius_tags.rb

@@ -0,0 +1,38 @@
+module ReorderChildren
+  module RadiusTags
+    include Radiant::Taggable
+
+    desc %{
+      Sets page context to next page sibling. For example:
+
+      <pre><code><r:next by="title"><r:link/></r:next></code></pre>
+
+      *Usage:*
+      <pre><code><r:next [by="sort_order"]>...</r:next></code></pre>
+    }
+    tag "next" do |tag|
+      by = tag.attr['by'] || "position"
+      next_page = Page.find_by_parent_id(tag.locals.page.parent_id, :conditions => ["virtual = false and status_id = 100 and #{by} > ?", tag.locals.page.send(by)], :order => "#{by} ASC")
+      if next_page
+        tag.locals.page = next_page
+        tag.expand
+      end
+    end
+
+    desc %{
+      Sets page context to previous page sibling. For example:
+      <pre><code><r:previous by="title"><r:link/></r:previous></code></pre>
+
+      *Usage:*
+      <pre><code><r:previous [by="sort_order"]>...</r:previous></code></pre>
+    }
+    tag "previous" do |tag|
+      by = tag.attr['by'] || "position"
+      previous_page = Page.find_by_parent_id(tag.locals.page.parent_id, :conditions => ["virtual = false and status_id = 100 and #{by} < ?", tag.locals.page.send(by)], :order => "#{by} DESC")
+      if previous_page
+        tag.locals.page = previous_page
+        tag.expand
+      end
+    end
+  end
+end

data/lib/tasks/reorder_children_extension_tasks.rake

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

@@ -0,0 +1,4 @@
+#content table.index .reorder {
+	padding-left:0pt;
+	width:100px;
+}

data/radiant-reorder_children-extension.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "radiant-reorder_children-extension/version"
+
+Gem::Specification.new do |s|
+  s.name        = "radiant-reorder_children-extension"
+  s.version     = RadiantReorderChildrenExtension::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Benny Degezelle"]
+  s.email       = ["benny@gorilla-webdesign.be"]
+  s.homepage    = "http://github.com/jomz/radiant-reorder_children-extension"
+  s.summary     = %q{Reorder Children for Radiant CMS}
+  s.description = %q{Makes Radiant better by adding reorder_children!}
+  
+  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-reorder_children-extension', :version => '~>#{RadiantReorderChildrenExtension::VERSION}'
+  }
+end

data/reorder_children_extension.rb

@@ -0,0 +1,41 @@
+begin
+   require_dependency 'application_controller'
+rescue MissingSourceFile
+   require_dependency 'application'
+end
+
+require 'radiant-reorder_children-extension/version'
+class ReorderChildrenExtension < Radiant::Extension
+  version RadiantReorderChildrenExtension::VERSION
+  description "Adds the ability to reorder the children of a page."
+  url "http://github.com/jomz/radiant-reorder_children-extension"
+  
+  # extension_config do |config|
+  #   config.gem 'some-awesome-gem'
+  #   config.after_initialize do
+  #     run_something
+  #   end
+  # end
+  
+  def activate
+    admin.page.index.add :sitemap_head, 'reorder_extra_th', :after => "modify_column_header"
+    admin.page.index.add :node, 'reorder_extra_td', :after => "add_child_column"
+    
+    Page.send :include, ReorderChildren::PageExtensions, ReorderChildren::RadiusTags
+    Page.reflections[:children].options[:order] = "position ASC"
+    
+    StandardTags.class_eval do
+      unless method_defined?(:children_find_options_with_position)
+        def children_find_options_with_position(tag)
+          default_options = children_find_options_without_position(tag)
+          default_options[:order].sub! /published_at/, 'position' if tag.attr.symbolize_keys[:by].nil?
+          default_options
+        end
+        alias_method_chain :children_find_options, :position
+      end
+    end
+    
+    Admin::PagesController.send :include, ReorderChildren::PagesControllerExtensions
+    Admin::PagesController.send :helper, ReorderChildren::PageHelperExtensions
+  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-reorder_children-extension
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Benny Degezelle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-14 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Makes Radiant better by adding reorder_children!
+email: 
+- benny@gorilla-webdesign.be
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/views/admin/pages/_reorder_extra_td.html.haml
+- app/views/admin/pages/_reorder_extra_th.html.haml
+- app/views/admin/pages/reorder.html.haml
+- config/initializers/radiant_config.rb
+- config/locales/en.yml
+- config/locales/nl.yml
+- config/routes.rb
+- cucumber.yml
+- features/support/env.rb
+- features/support/paths.rb
+- lib/radiant-reorder_children-extension/version.rb
+- lib/radiant-reorder_children-extension.rb
+- lib/reorder_children/page_extensions.rb
+- lib/reorder_children/page_helper_extensions.rb
+- lib/reorder_children/pages_controller_extensions.rb
+- lib/reorder_children/radius_tags.rb
+- lib/tasks/reorder_children_extension_tasks.rake
+- public/images/admin/reorder.png
+- public/stylesheets/admin/reorder.css
+- radiant-reorder_children-extension.gemspec
+- Rakefile
+- README.md
+- reorder_children_extension.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jomz/radiant-reorder_children-extension
+licenses: []
+
+post_install_message: "\n  Add this to your radiant project with:\n    config.gem 'radiant-reorder_children-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.3.7
+signing_key: 
+specification_version: 3
+summary: Reorder Children for Radiant CMS
+test_files: 
+- spec/spec.opts
+- spec/spec_helper.rb
+- features/support/env.rb
+- features/support/paths.rb