radiant-archive_tabs-extension 1.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+*.swp
+*.gem

data/README.md

@@ -0,0 +1,38 @@
+# Archive Tabs
+
+Display Archive pages in their own paginated tab.
+
+Archive page types often contain the most child pages, with Radiant's tree based navigation this can often lead to very long lists. Archive tabs creates a tab for each Archive Page Type which contains a paginated list of it's children.
+
+Archive pages will no longer display their children on the main Pages index page.
+
+Tested against Radiant v1.0.0 and probably won't be back ported to older versions
+
+It's a monkey patch so use at your own risk.
+
+
+## Installation
+
+Install as a gem :
+
+```
+gem install radiant-archive_tabs-extension
+```
+
+Ensure Archive Tabs is loaded last :
+
+```
+config.extensions = [ :all, :archive_tabs ]
+```
+
+Load Archive Tabs by adding the gem :
+
+```
+config.gem 'radiant-archive_tabs-extension', :version => '1.0.0'
+```
+
+
+## To Do
+
+- Add search filter ?
+- Look into why will_paginate isn't creating the correct urls, currently using a js hack to fix this

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 Archive Tabs extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ArchiveTabsExtension'
+  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/_redirect_cancel.html.haml

@@ -0,0 +1,8 @@
+- if extracted?(model.parent)
+  :javascript
+    function redirect_cancel(event) {
+      window.location = "#{url_for index_page_for_model_with_extract}"
+      event.stop()
+    }
+
+    $$('#new_page .buttons a, #edit_page .buttons a').invoke('observe', 'click', redirect_cancel)

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

@@ -0,0 +1,36 @@
+- @page_title = t('pages') + ' - ' + default_page_title
+
+.outset
+  = render_region :top
+  %table.index#pages{:summary=>t('page_hierarchy')}
+    %thead
+      %tr
+        - render_region :sitemap_head do |sitemap_head|
+          - sitemap_head.title_column_header do
+            %th.name= t('page') 
+          - sitemap_head.status_column_header do
+            %th.status= t('status')
+          - sitemap_head.actions_column_header do
+            %th.actions= t('modify')
+    %tbody
+      - if models
+        - models.each do |child|
+          = render_node child
+      - else
+        %tr
+          %td.empty{:colspan => admin.page.index.node.length}= t('no_pages')
+  = render_region :bottom
+
+#actions
+  = pagination_for(models, :depaginate => false)
+
+  %ul
+    %li= link_to image('plus') + ' ' + t('add') + ' ' + model.title.singularize, new_admin_page_child_path, :class => 'action_button'
+
+:javascript
+  function redirect_pagination(element) {
+    window.location = Event.element(event).readAttribute('href').replace('.html', '')
+    event.stop()
+  }
+
+  $$('.pagination a').invoke('observe', 'click', redirect_pagination)

data/archive_tabs_extension.rb

@@ -0,0 +1,24 @@
+require 'radiant-archive_tabs-extension/version'
+require 'radiant-archive_tabs-extension/admin/node_helper'
+require 'radiant-archive_tabs-extension/admin/pages_controller'
+
+class ArchiveTabsExtension < Radiant::Extension
+  version RadiantArchiveTabsExtension::VERSION
+  description "Display Archive pages in their own paginated tab"
+  url "http://github.com/jsntv200/radiant-archive_tabs-extension"
+
+  def activate
+    Admin::NodeHelper.send :include, RadiantArchiveTabsExtension::Admin::NodeHelper
+    Admin::PagesController.send :include, RadiantArchiveTabsExtension::Admin::PagesController
+
+    admin.page.edit.add :main, 'redirect_cancel', :after => 'form_bottom'
+
+    if Page.table_exists?
+      tab 'Content' do
+        ArchivePage.all(:order => 'slug ASC').each do |page|
+          add_item page.title, "/admin/pages/#{page.id}/children"
+        end
+      end
+    end
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+---
+en:
+  archive_tabs: 'Archive Tabs'
+  add: 'Add'

data/lib/radiant-archive_tabs-extension/admin/node_helper.rb

@@ -0,0 +1,39 @@
+module RadiantArchiveTabsExtension
+  module Admin
+    module NodeHelper
+      def self.included(base)
+        base.class_eval do
+          # TODO: duplicated in pages_controller
+          def extracted?(page)
+            page.class == ArchivePage
+          end
+
+          alias_method_chain :expanded, :extract
+          alias_method_chain :expander, :extract
+          alias_method_chain :children_class, :extract
+          alias_method_chain :children_for, :extract
+        end
+      end
+
+      # Never render the children on admin/pages
+      def expanded_with_extract
+        extracted?(@current_node) ? false : expanded_without_extract
+      end
+
+      # Don't display the expander arrow on admin/pages
+      def expander_with_extract(level)
+        extracted?(@current_node) ? '' : expander_without_extract(level)
+      end
+
+      # Force the no_children class to diable the SiteMapBehavior js on admin/pages
+      def children_class_with_extract
+        extracted?(@current_node) ? ' no_children' : children_class_without_extract
+      end
+
+      # Disable adding children on the index page, admin/pages/:page_id/children
+      def children_for_with_extract(page)
+        page.respond_to?(:parent) && extracted?(page.parent) ? [] : children_for_without_extract(page)
+      end
+    end
+  end
+end

data/lib/radiant-archive_tabs-extension/admin/pages_controller.rb

@@ -0,0 +1,61 @@
+module RadiantArchiveTabsExtension
+  module Admin
+    module PagesController
+      def self.included(base)
+        base.class_eval do
+          # TODO: duplicated in node_helper
+          def extracted?(page)
+            page.class == ArchivePage
+          end
+
+          helper_method :extracted?, :index_page_for_model_with_extract
+          alias_method_chain :load_models, :extract
+          alias_method_chain :index, :extract
+          alias_method_chain :index_page_for_model, :extract
+       end
+      end
+
+      def load_models_with_extract
+        if params[:page_id]
+          self.model = Page.find(params[:page_id])
+
+          if extracted?(self.model)
+            acts_as_tree_options
+            self.class.paginate_models :per_page => Radiant.config['admin.pagination.per_page']
+          end
+        end
+
+        load_models_without_extract
+      end
+
+      def index_with_extract
+        if extracted?(self.model)
+          render :action => 'archive_index'
+        else
+          index_without_extract
+        end
+      end
+
+      def index_page_for_model_with_extract
+        if model && extracted?(model.parent)
+          acts_as_tree_options
+          parts = {:action => "index", :page_id => model.parent_id}
+
+          if i = model.self_and_siblings.index(model)
+            p = (i / Radiant.config['admin.pagination.per_page'].to_i) + 1
+            parts[:p] = p if p && p > 1
+          end
+
+          parts
+        else
+          index_page_for_model_without_extract
+        end
+      end
+
+      # TODO: Probably a better way to do this but it works
+      def acts_as_tree_options
+        Page.acts_as_tree :order => 'virtual ASC, published_at DESC'
+      end
+    end
+  end
+end

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

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

data/lib/radiant-archive_tabs-extension.rb

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

data/lib/tasks/archive_tabs_extension_tasks.rake

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

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "radiant-archive_tabs-extension/version"
+
+Gem::Specification.new do |s|
+  s.name        = "radiant-archive_tabs-extension"
+  s.version     = RadiantArchiveTabsExtension::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jason Taylor"]
+  s.email       = ["jsntv200@gmail.com"]
+  s.homepage    = "http://github.com/jsntv200/radiant-archive_tabs-extension"
+  s.summary     = %q{Archive tabs extension for Radiant CMS}
+  s.description = %q{Display Archive pages in their own paginated tab}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.post_install_message = %{
+  Edit your Radiant environment.rb file and add the following :
+
+  1. Ensure Archive Tabs is loaded last
+
+    config.extensions = [ :all, :archive_tabs ]
+
+  2. Load Archive Tabs by adding the gem
+
+    config.gem 'radiant-archive_tabs-extension', :version => '#{RadiantArchiveTabsExtension::VERSION}'
+  }
+end

data/spec/controllers/admin/pages_controller_spec.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Admin::PagesController do
+  dataset :users, :archive_pages
+
+  before :each do
+    login_as :existing
+  end
+
+  describe "viewing the admin index" do
+    integrate_views
+
+    before :each do
+      get :index
+    end
+
+    it "should have a secondary navigation" do
+      response.should be_success
+      response.should have_tag('ul#secondary_navigation')
+    end
+
+    it "should have a Pages link" do
+      response.should be_success
+      response.should have_tag('a', :text => 'Pages')
+    end
+
+    it "should have a News link" do
+      response.should be_success
+      response.should have_tag('a', :text => 'News')
+    end
+  end
+
+  describe "viewing the admin extract index" do
+    before :each do
+      get :index, :page_id => ArchivePage.first.id
+    end
+
+    it "should be an ArchivePage" do
+      response.should be_success
+      assigns(:page).should be_kind_of(ArchivePage)
+    end
+
+    it "should render the archive_index template" do
+      response.should be_success
+      response.should render_template('archive_index')
+    end
+
+    it "should be paginated" do
+      response.should be_success
+      controller.paginated?.should be_true
+    end
+  end
+
+  describe "#new" do
+    it "should redirect to the archive parent" do
+      get :new, :page_id => page_id(:news)
+      response.should be_success
+      controller.index_page_for_model_with_extract.should == {:action => 'index', :page_id => page_id(:news)}
+    end
+  end
+
+  describe "#edit" do
+    it "should redirect to paginated archive parent" do
+      Admin::PagesController.send :paginate_models, {:per_page => 2}
+      get :edit, :id => pages(:news).children.first.id
+      response.should be_success
+      controller.index_page_for_model_with_extract.should == {:action => 'index', :page_id => page_id(:news), :p => 2}
+    end
+  end
+end

data/spec/datasets/archive_pages.rb

@@ -0,0 +1,12 @@
+class ArchivePagesDataset < Dataset::Base
+  uses :home_page
+
+  def load
+    create_page 'News', :class_name => 'ArchivePage' do
+      create_page 'Article 1', :published_at => DateTime.parse('2000-12-01 08:41:07')
+      create_page 'Article 2', :published_at => DateTime.parse('2001-02-09 08:42:04')
+      create_page 'Article 3', :published_at => DateTime.parse('2001-02-24 12:02:43')
+      create_page 'Article 4', :published_at => DateTime.parse('2001-03-06 03:32:31')
+    end
+  end
+end

data/spec/helpers/admin/node_helper_spec.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + "/../../spec_helper"
+
+describe Admin::NodeHelper do
+  before :each do
+    @archive = mock_model(ArchivePage)
+    @archive.stub!(:extracted?).and_return(true)
+  end
+
+  it "should not expand the current node" do
+    assigns[:current_node] = @archive
+    helper.expanded.should be_false
+  end
+
+  it "should have a no_children class for the current node" do
+    assigns[:current_node] = @archive
+    helper.children_class.should == " no_children"
+  end
+
+  it "should not render an arrow for the current node" do
+    assigns[:current_node] = @archive
+    helper.expander(0).should == ""
+  end
+
+  it "should return no children if the parent is an ArchivePage" do
+    @page = mock_model(Page)
+    @page.stub!(:extracted?).and_return(false)
+    @page.stub!(:parent).and_return(@archive)
+    assigns[:current_node] = @page
+    helper.children_for(@page).should == []
+  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,89 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-archive_tabs-extension
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jason Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-23 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: Display Archive pages in their own paginated tab
+email: 
+- jsntv200@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- README.md
+- Rakefile
+- app/views/admin/pages/_redirect_cancel.html.haml
+- app/views/admin/pages/archive_index.html.haml
+- archive_tabs_extension.rb
+- config/locales/en.yml
+- lib/radiant-archive_tabs-extension.rb
+- lib/radiant-archive_tabs-extension/admin/node_helper.rb
+- lib/radiant-archive_tabs-extension/admin/pages_controller.rb
+- lib/radiant-archive_tabs-extension/version.rb
+- lib/tasks/archive_tabs_extension_tasks.rake
+- radiant-archive_tabs-extension.gemspec
+- spec/controllers/admin/pages_controller_spec.rb
+- spec/datasets/archive_pages.rb
+- spec/helpers/admin/node_helper_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jsntv200/radiant-archive_tabs-extension
+licenses: []
+
+post_install_message: "\n  Edit your Radiant environment.rb file and add the following :\n\n  1. Ensure Archive Tabs is loaded last\n\n    config.extensions = [ :all, :archive_tabs ]\n\n  2. Load Archive Tabs by adding the gem\n\n    config.gem 'radiant-archive_tabs-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.5.0
+signing_key: 
+specification_version: 3
+summary: Archive tabs extension for Radiant CMS
+test_files: 
+- spec/controllers/admin/pages_controller_spec.rb
+- spec/datasets/archive_pages.rb
+- spec/helpers/admin/node_helper_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb