radiant-archive-extension 1.0.0

data/README

@@ -0,0 +1,29 @@
+= Archive
+
+The Archive extension extracts the Archive pages from their original place
+in the Radiant distribution.
+
+== Archive page
+
+An archive page provides behavior similar to a blog archive or a news
+archive. Child page URLs are altered to be in %Y/%m/%d format
+(2004/05/06).
+    
+An archive page can be used in conjunction with the "Archive Year Index",
+"Archive Month Index", and "Archive Day Index" page types to create year,
+month, and day indexes.
+
+== Archive Index pages
+
+To create a year/month/day index for an archive, create a child page for the
+archive and assign the "Archive [Year/Month/Day] Index" page type to it.
+
+An index page makes following tags available to you:
+
+<r:archive:children>...</r:archive:children>
+  Grants access to a subset of the children of the archive page
+  that match the specific year/month/day which the index page is rendering.
+
+The title and breadcrumb attributes of an index page are rendered using Ruby's
+Time#strftime method.  Please refer to documentation for Time#strftime to
+format these attributes.

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 extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ArchiveExtension'
+  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/models/archive_day_index_page.rb

@@ -0,0 +1,32 @@
+class ArchiveDayIndexPage < Page
+  
+  def allowed_children
+    []
+  end
+  
+  description %{
+    To create a day index for an archive, create a child page for the
+    archive and assign the "Archive Day Index" page type to it.
+    
+    A day index page makes following tags available to you:
+    
+    <r:archive:children>...</r:archive:children>
+      Grants access to a subset of the children of the archive page
+      that match the specific year which the index page is rendering.
+  }
+  
+  include ArchiveIndexTagsAndMethods
+  desc %{
+      Grants access to a subset of the children of the archive page
+      that match the specific day which the index page is rendering.
+      
+      *Usage*:
+       <pre><code><r:archive:children>...</r:archive:children></code></pre>
+  }
+  tag "archive:children" do |tag|
+    year, month, day = $1, $2, $3 if request_uri =~ %r{/(\d{4})/(\d{2})/(\d{2})/?$}
+    tag.locals.children = ArchiveFinder.day_finder(parent.children, year, month, day)
+    tag.expand
+  end
+  
+end

data/app/models/archive_finder.rb

@@ -0,0 +1,60 @@
+class ArchiveFinder
+  
+  def initialize(&block)
+    @block = block
+  end
+  
+  def find(method, options = {})
+    @block.call(method, options)
+  end
+  
+  # stub for page tag finding
+  def all(options ={})
+    self.find(:all, options)
+  end
+  
+  class << self
+    def year_finder(finder, year)
+      new do |method, options|
+        start = Time.local(year)
+        finish = start.next_year
+        add_condition(options, "published_at >= ? and published_at < ?", start, finish)
+        finder.find(method, options)
+      end
+    end
+    
+    def month_finder(finder, year, month)
+      new do |method, options|
+        start = Time.local(year, month)
+        finish = start.next_month
+        add_condition(options, "published_at >= ? and published_at < ?", start, finish)
+        finder.find(method, options)
+      end
+    end
+    
+    def day_finder(finder, year, month, day)
+      new do |method, options|
+        start = Time.local(year, month, day)
+        finish = start.tomorrow
+        add_condition(options, "published_at >= ? and published_at < ?", start, finish)
+        finder.find(method, options)
+      end
+    end
+    
+    private
+      
+      def concat_conditions(a, b)
+        sql = "(#{ [a.shift, b.shift].compact.join(") AND (") })"
+        params = a + b
+        [sql, *params]
+      end
+      
+      def add_condition(options, *condition)
+        old = options[:conditions] || []
+        conditions = concat_conditions(old, condition)
+        options[:conditions] = conditions
+        options
+      end
+      
+  end
+end

data/app/models/archive_month_index_page.rb

@@ -0,0 +1,32 @@
+class ArchiveMonthIndexPage < Page
+  
+  def allowed_children
+    []
+  end
+  
+  description %{
+    To create a month index for an archive, create a child page for the
+    archive and assign the "Archive Month Index" page type to it.
+    
+    A month index page makes following tags available to you:
+    
+    <r:archive:children>...</r:archive:children>
+      Grants access to a subset of the children of the archive page
+      that match the specific year which the index page is rendering.
+  }
+  
+  include ArchiveIndexTagsAndMethods
+  desc %{
+      Grants access to a subset of the children of the archive page
+      that match the specific month which the index page is rendering.
+      
+      *Usage*:
+       <pre><code><r:archive:children>...</r:archive:children></code></pre>
+  }
+  tag "archive:children" do |tag|
+    year, month = $1, $2 if request_uri =~ %r{/(\d{4})/(\d{2})/?$}
+    tag.locals.children = ArchiveFinder.month_finder(parent.children, year, month)
+    tag.expand
+  end
+  
+end

data/app/models/archive_page.rb

@@ -0,0 +1,77 @@
+class ArchivePage < Page
+  cattr_accessor :allowed_children
+  cattr_accessor :single_use_children
+  @@single_use_children = [ArchiveDayIndexPage, ArchiveMonthIndexPage, ArchiveYearIndexPage, FileNotFoundPage]
+  @@allowed_children = [self.default_child, *@@single_use_children]
+  
+  def allowed_children
+    overlap = @@allowed_children & (existing_child_types - [default_child])
+    
+    (@@allowed_children - overlap)
+  end
+  
+  def existing_child_types
+    children(:select => 'DISTINCT class_name', :order => nil).collect{|p| p.class }.uniq
+  end
+
+  description %{
+    An archive page provides behavior similar to a blog archive or a news
+    archive. Child page URLs are altered to be in %Y/%m/%d format
+    (2004/05/06).
+    
+    An archive page can be used in conjunction with the "Archive Year Index",
+    "Archive Month Index", and "Archive Day Index" page types to create year,
+    month, and day indexes.
+  }
+  
+  def child_path(child)
+    year, month, day = $1, ($2 || 1).to_i, ($3 || 1).to_i if child.request and child.request.request_uri =~ %r{/(\d{4})(?:/(\d{2})(?:/(\d{2}))?)?/?$}
+    
+    if year && %w{ ArchiveYearIndexPage ArchiveMonthIndexPage ArchiveDayIndexPage }.include?(child.class_name)
+      date = Date.new(year.to_i, month, day)
+      if ArchiveYearIndexPage === child
+        clean_path "#{ path }/#{ date.strftime '%Y' }/"
+      elsif ArchiveMonthIndexPage === child
+        clean_path "#{ path }/#{ date.strftime '%Y/%m' }/"
+      else ArchiveDayIndexPage === child
+        clean_path "#{ path }/#{ date.strftime '%Y/%m/%d/' }/"
+      end
+    else
+      if child.published_at?
+        clean_path "#{ path }/#{ child.published_at.strftime '%Y/%m/%d' }/#{ child.slug }"
+      else
+        clean_path "#{ path }/#{ Time.zone.now.strftime '%Y/%m/%d' }/#{ child.slug }"
+      end
+    end
+  end
+  def child_url(child)
+    ActiveSupport::Deprecation.warn("`child_url' has been deprecated; use `child_path' instead.", caller)
+    child_path(child)
+  end
+  
+  def find_by_path(path, live = true, clean = false)
+    path = clean_path(path) if clean
+    if path =~ %r{^#{ self.path }(\d{4})(?:/(\d{2})(?:/(\d{2})(?:/([-_.A-Za-z0-9]*))?)?)?/?$}
+      year, month, day, slug = $1, $2, $3, $4
+      children.find_by_class_name(
+        case
+        when slug.present?
+          found = children.find_by_slug(slug)
+          return found if found
+        when day.present?
+          'ArchiveDayIndexPage'
+        when month.present?
+          'ArchiveMonthIndexPage'
+        else
+          'ArchiveYearIndexPage'
+        end
+      )
+    else
+      super
+    end
+  end
+  def find_by_url(*args)
+    ActiveSupport::Deprecation.warn("`find_by_url' has been deprecated; use `find_by_path' instead.", caller)
+    find_by_path(*args)
+  end
+end

data/app/models/archive_year_index_page.rb

@@ -0,0 +1,32 @@
+class ArchiveYearIndexPage < Page
+  
+  def allowed_children
+    []
+  end
+  
+  description %{
+    To create a year index for an archive, create a child page for the
+    archive and assign the "Archive Year Index" page type to it.
+    
+    A year index page makes following tags available to you:
+    
+    <r:archive:children>...</r:archive:children>
+      Grants access to a subset of the children of the archive page
+      that match the specific year which the index page is rendering.
+  }
+  
+  include ArchiveIndexTagsAndMethods
+  desc %{
+      Grants access to a subset of the children of the archive page
+      that match the specific year which the index page is rendering.
+      
+      *Usage*:
+       <pre><code><r:archive:children>...</r:archive:children></code></pre>
+  }
+  tag "archive:children" do |tag|
+    year = $1 if request_uri =~ %r{/(\d{4})/?$}
+    tag.locals.children = ArchiveFinder.year_finder(parent.children, year)
+    tag.expand
+  end
+  
+end

data/archive_extension.rb

@@ -0,0 +1,20 @@
+# Uncomment this if you reference any of your controllers in activate
+# require_dependency 'application_controller'
+require 'radiant-archive-extension/version'
+class ArchiveExtension < Radiant::Extension
+  version RadiantArchiveExtension::VERSION
+  description "Provides page types for news or blog archives."
+  url "http://radiantcms.org/"
+    
+  def activate
+    # allow bootstrap
+    if Page.table_exists?
+      Page.class_eval do
+        def allowed_children_with_archive
+          allowed_children_without_archive.reject { |p| p.name =~ /Archive(Day|Month|Year)IndexPage/ }
+        end
+        alias_method_chain :allowed_children, :archive
+      end
+    end
+  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:
+  archive: Archive

data/config/routes.rb

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

data/cucumber.yml

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

data/features/archive_content.feature

@@ -0,0 +1,51 @@
+Feature: Serving pages from front-end
+  In order to view the website content properly
+  a visitor
+  wants to see archive enhancements
+  
+  Scenario: Archive page basic rendering
+    Given I am logged in as "existing"
+    When I edit the "archive" page
+    And I fill in the "body" content with the text
+      """
+      <h1>Articles</h1>
+      <r:children:each><p><r:link /></p>
+      </r:children:each><p>Thanks for reading!</p>
+      """
+    And I press "Save Changes"
+    And I visit the "archive" page
+    Then the page should render
+      """
+      <h1>Articles</h1>
+      <p><a href="/archive/2000/01/01/article-z/">Article Z</a></p>
+      <p><a href="/archive/2000/01/02/early-post/">Early Post</a></p>
+      <p><a href="/archive/2000/01/03/z-post/">Z Post</a></p>
+      <p><a href="/archive/2000/01/04/a-post/">A Post</a></p>
+      <p><a href="/archive/2001/02/02/article-y/">Article Y</a></p>
+      <p><a href="/archive/2002/03/03/article-x/">Article X</a></p>
+      <p><a href="/archive/2003/04/04/article-w/">Article W</a></p>
+      <p><a href="/archive/2004/05/05/article-v/">Article V</a></p>
+      <p>Thanks for reading!</p>
+      """
+
+  
+  Scenario: Archive Monthly Index children rendering
+    Given I am logged in as "existing"
+    When I edit the "month_index" page
+    And I fill in the "body" content with the text
+      """
+      <h1>This Month's Articles</h1>
+      <r:archive:children:each><p><r:link /></p>
+      </r:archive:children:each><p>Thanks for reading the Monthly Archive!</p>
+      """
+    And I press "Save Changes"
+    And I visit "/archive/2000/01/"
+    Then the page should render
+      """
+      <h1>This Month's Articles</h1>
+      <p><a href="/archive/2000/01/01/article-z/">Article Z</a></p>
+      <p><a href="/archive/2000/01/02/early-post/">Early Post</a></p>
+      <p><a href="/archive/2000/01/03/z-post/">Z Post</a></p>
+      <p><a href="/archive/2000/01/04/a-post/">A Post</a></p>
+      <p>Thanks for reading the Monthly Archive!</p>
+      """

data/features/step_definitions/web_steps.rb

@@ -0,0 +1,7 @@
+Given /^I visit the "([^"]*)" page$/ do |slug|
+  visit Page.find_by_slug(slug).path
+end
+
+Given /^I visit "([^"]*)"$/ do |path|
+  visit path
+end

data/features/support/datasets_loader.rb

@@ -0,0 +1,3 @@
+Cucumber::Rails::World.class_eval do
+  dataset :users, :archive
+end

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 :archive
+end

data/features/support/matchers.rb

@@ -0,0 +1,3 @@
+Dir.glob("#{RADIANT_ROOT}/spec/matchers/*.rb").each do |matcher|
+  require matcher
+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 "archive" admin page
+  # 
+  # would direct the request to the path you provide in the value:
+  # 
+  #   admin_archive_path
+  # 
+  PathMatchers = {} unless defined?(PathMatchers)
+  PathMatchers.merge!({
+    # /archive/i => 'admin_archive_path'
+  })
+  
+end
+
+World(NavigationHelpers)

data/lib/archive_index_tags_and_methods.rb

@@ -0,0 +1,77 @@
+module ArchiveIndexTagsAndMethods
+  
+  include Radiant::Taggable
+  
+  desc %{
+    Scope tags for an ArchivePage
+  }
+  tag "archive" do |tag|
+    tag.expand
+  end
+  
+  [:title, :breadcrumb].each do |method|
+    tag method.to_s do |tag|
+      setup_date_parts
+      page = tag.locals.page
+      unless @year.nil?
+        Date.new((@year || 1).to_i, (@month || 1).to_i, (@day || 1).to_i).strftime(page.send(method))
+      else
+        page.send(method)
+      end
+    end
+  end
+  
+  desc %{
+    Display the year for the current Archive
+  }
+  tag "archive:year" do |tag|
+    setup_date_parts
+    @year.to_i unless @year.nil?
+  end
+  
+
+  desc %{
+    Display the month for the current Archive
+  }
+  tag "archive:month" do |tag|
+    setup_date_parts
+    Date.new(@year.to_i, @month.to_i, 1).strftime('%B') rescue ''
+  end
+  
+
+  desc %{
+    Display the day for the current Archive
+  }
+  tag "archive:day" do |tag|
+    setup_date_parts
+    @day.to_i unless @day.nil?
+  end
+  
+
+  desc %{
+    Display the day of the week for the current Archive
+  }
+  tag "archive:day_of_week" do |tag|
+    setup_date_parts
+    Date.new(@year.to_i, @month.to_i, @day.to_i).strftime('%A') rescue ''
+  end
+  
+  tag("archive:children:first") { "unimplemented" }
+  tag("archive:children:last" ) { "unimplemented" }
+  tag("archive:children:count") { "unimplemented" }
+  
+  def virtual?
+    true
+  end
+  
+  private
+    
+    def request_uri
+      request.request_uri unless request.nil?
+    end
+    
+    def setup_date_parts
+      @year, @month, @day = $1, $2, $3 if request_uri =~ %r{/(\d{4})(?:/(\d{2})(?:/(\d{2}))?)?/?$}
+    end
+  
+end

data/lib/radiant-archive-extension.rb

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

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

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

data/lib/tasks/archive_extension_tasks.rake

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

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "radiant-archive-extension/version"
+
+Gem::Specification.new do |s|
+  s.name        = "radiant-archive-extension"
+  s.version     = RadiantArchiveExtension::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Radiant CMS Dev Team"]
+  s.email       = ["radiant@radiantcms.org"]
+  s.homepage    = "http://radiantcms.org"
+  s.summary     = %q{Archive for Radiant CMS}
+  s.description = %q{Provides page types for news or blog archives.}
+  
+  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-archive-extension', :version => '~>#{RadiantArchiveExtension::VERSION}'
+  }
+end

data/spec/datasets/archive_dataset.rb

@@ -0,0 +1,55 @@
+class ArchiveDataset < Dataset::Base
+  uses :home_page
+  
+  def load
+    create_page "Archive", :class_name => "ArchivePage" do
+      create_page "Year Index", :class_name => "ArchiveYearIndexPage", :title => "%Y Archive", :virtual => true # dataset won't load this
+      create_page "Month Index", :class_name => "ArchiveMonthIndexPage", :title => "%B %Y Archive", :virtual => true # dataset won't load this
+      create_page "Day Index", :class_name => "ArchiveDayIndexPage", :title => "%B %d, %Y Archive", :virtual => true # dataset won't load this
+      %w{Z Y X W V}.each_with_index do |letter, index|
+        i = index + 1
+        create_page "Article #{letter}", :published_at => Time.local(1999+i, i, i).to_s(:db)
+      end
+      create_page "Early Post", :published_at => Time.local(2000, 01, 02).to_s(:db)
+      create_page "Z Post", :published_at => Time.local(2000, 01, 03).to_s(:db)
+      create_page "A Post", :published_at => Time.local(2000, 01, 04).to_s(:db)
+      create_page "Draft Article", :status_id => Status[:draft].id, :published_at => nil
+    end
+  end
+  
+  helpers do
+    describe "Archive index page", :shared => true do
+      it "should be virtual" do
+        @page.should be_virtual
+      end
+      
+      it "should render <r:archive:children:first /> as unimplemented" do
+        @page.should render('<r:archive:children:first><r:slug /></r:archive:children:first>').as('unimplemented')
+      end
+
+      it "should render <r:archive:children:last /> as unimplemented" do
+        @page.should render('<r:archive:children:last><r:slug /></r:archive:children:last>').as('unimplemented')
+      end
+
+      it "should <r:archive:children:count /> as unimplemented" do
+        @page.should render('<r:archive:children:count><r:slug /></r:archive:children:count>').as('unimplemented')
+      end
+      
+      it "should render the <r:archive:year /> tag" do
+        @page.should render("<r:archive:year />").as("2000").on("/archive/2000/")
+      end
+      
+      it "should render the <r:archive:month /> tag" do
+        @page.should render("<r:archive:month />").as("June").on("/archive/2000/06/")
+      end
+      
+      it "should render the <r:archive:day /> tag" do
+        @page.should render('<r:archive:day />').as("9").on('/archive/2000/06/09/')
+      end
+      
+      it "should render the <r:archive:day_of_week /> tag" do
+        @page.should render('<r:archive:day_of_week />').as('Friday').on("/archive/2000/06/09/")
+      end
+    end
+  end
+end

data/spec/models/archive_day_index_page_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ArchiveDayIndexPage do
+  dataset :archive
+  
+  before :each do
+    @page = pages(:day_index)
+  end
+  
+  its(:allowed_children){ should == [] }
+  
+  it_should_behave_like "Archive index page"
+  
+  it "should render the <r:archive:children:each /> tag" do
+    @page.should render('<r:archive:children:each><r:slug /> </r:archive:children:each>').as('article-y ').on('/archive/2001/02/02/')
+    @page.should render('<r:archive:children:each><r:slug /> </r:archive:children:each>').as('article-y ').on('/archive/2001/02/02')
+  end
+  
+  it "should render the <r:title /> tag with interpolated date" do
+    @page.should render('<r:title />').as('June 09, 2000 Archive').on('/archive/2000/06/09/')
+  end
+
+  it "should render the <r:breadcrumb /> tag with interpolated date" do
+    @page.should render('<r:breadcrumb />').as('June 09, 2000 Archive').on('/archive/2000/06/09/')
+  end
+
+  it "should render the <r:url /> tag with interpolated date" do
+    @page.should render('<r:url />').as('/archive/2000/06/09/').on('/archive/2000/06/09')
+  end
+end

data/spec/models/archive_month_index_page_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ArchiveMonthIndexPage do
+  dataset :archive
+  
+  before :each do
+    @page = pages(:month_index)
+  end
+  
+  its(:allowed_children){ should == [] }
+  
+  it_should_behave_like "Archive index page"
+  
+  it "should render the <r:archive:children:each /> tag" do
+    @page.should render('<r:archive:children:each><r:slug /> </r:archive:children:each>').as('article-y ').on('/archive/2001/02/')
+    @page.should render('<r:archive:children:each><r:slug /> </r:archive:children:each>').as('article-y ').on('/archive/2001/02')
+  end
+  
+  it "should render the <r:title /> tag with interpolated date" do
+    @page.should render('<r:title />').as('June 2000 Archive').on('/archive/2000/06/')
+  end
+
+  it "should render the <r:breadcrumb /> tag with interpolated date" do
+    @page.should render('<r:breadcrumb />').as('June 2000 Archive').on('/archive/2000/06/')
+  end
+
+  it "should render the <r:path /> tag with interpolated date" do
+    @page.should render('<r:path />').as('/archive/2000/06/').on('/archive/2000/06')
+  end
+
+  it "should properly render the <r:path /> tag of an archive child with interpolated date" do
+    @page.should render('<r:archive:children:each><r:path /> </r:archive:children:each>').as('/archive/2000/01/01/article-z/ /archive/2000/01/02/early-post/ /archive/2000/01/03/z-post/ /archive/2000/01/04/a-post/ ').on('/archive/2000/01/')
+  end
+end

data/spec/models/archive_page_spec.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ArchivePage do
+  dataset :archive
+  
+  let(:archive){ pages(:archive) }
+  
+  it "should not render archive index pages" do
+    archive.should render('<r:children:each><r:slug /> </r:children:each>').as('article-z early-post z-post a-post article-y article-x article-w article-v ')
+  end
+  
+  it "should scope child URLs by date" do
+    pages(:article_z).url.should == '/archive/2000/01/01/article-z/'
+  end
+  
+  it "should scope unpublished children by the current date" do
+    pages(:draft_article).url.should == '/archive/' + Time.zone.now.strftime('%Y/%m/%d') + '/draft-article/'
+  end
+  
+  it "should find the year index" do
+    archive.find_by_path('/archive/2000/').should == pages(:year_index)
+  end
+  
+  it "should find the month index" do
+    archive.find_by_path('/archive/2000/06/').should == pages(:month_index)
+  end
+  
+  it "should find the day index" do
+    archive.find_by_path('/archive/2000/06/09/').should == pages(:day_index)
+  end
+  
+  it "should find child URLs from the homepage" do
+    pages(:home).find_by_path('/archive/2000/01/01/article-z/').should == pages(:article_z)
+  end
+  
+  its(:single_use_children){ should == [ArchiveDayIndexPage, ArchiveMonthIndexPage, ArchiveYearIndexPage, FileNotFoundPage]}
+  its(:allowed_children){ should == [Page, *ArchivePage.single_use_children]}
+  
+  describe '#existing_child_types' do
+    it 'should return a unique array of classes of the page children' do
+      archive.existing_child_types.should == archive.children.all(:select => 'DISTINCT class_name').collect{|p| p.class }.uniq
+    end
+  end
+  
+  describe '#allowed_children' do
+    context 'when no children exist' do
+      subject{ ArchivePage.new }
+      its(:allowed_children){ should == ArchivePage.allowed_children }
+    end
+    it 'should remove any existing single_use_children from the allowed_children' do
+      existing_except_default = archive.existing_child_types - [archive.default_child]
+      used_allowed_children = ArchivePage.allowed_children & existing_except_default
+      archive.allowed_children.should == (ArchivePage.allowed_children - used_allowed_children)
+    end
+  end
+end

data/spec/models/archive_year_index_page_spec.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ArchiveYearIndexPage do
+  dataset :archive
+  
+  before :each do
+    @page = pages(:year_index)
+  end
+  
+  its(:allowed_children){ should == [] }
+  
+  it_should_behave_like "Archive index page"
+  
+  it "should render the <r:archive:children:each /> tag" do
+    @page.should render('<r:archive:children:each><r:slug /> </r:archive:children:each>').as('article-y ').on('/archive/2001/')
+    @page.should render('<r:archive:children:each><r:slug /> </r:archive:children:each>').as('article-y ').on('/archive/2001')
+  end
+  
+  it "should render the <r:title /> tag with interpolated date" do
+    @page.should render('<r:title />').as('2000 Archive').on('/archive/2000')
+  end
+
+  it "should render the <r:breadcrumb /> tag with interpolated date" do
+    @page.should render('<r:breadcrumb />').as('2000 Archive').on('/archive/2000')
+  end
+
+  it "should render the <r:url /> tag with interpolated date" do
+    @page.should render('<r:url />').as('/archive/2000/').on('/archive/2000')
+  end
+
+end

data/spec/models/page_spec.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Page do
+  its(:default_child){ should == Page}
+  its(:allowed_children){ should == [Page, *Page.descendants.sort_by(&:name)].select(&:in_menu?).reject{|p| p.name =~ /Archive(Day|Month|Year)IndexPage/}}
+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,111 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-archive-extension
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Radiant CMS Dev Team
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-11 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Provides page types for news or blog archives.
+email: 
+- radiant@radiantcms.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/models/archive_day_index_page.rb
+- app/models/archive_finder.rb
+- app/models/archive_month_index_page.rb
+- app/models/archive_page.rb
+- app/models/archive_year_index_page.rb
+- archive_extension.rb
+- config/initializers/radiant_config.rb
+- config/locales/en.yml
+- config/routes.rb
+- cucumber.yml
+- features/archive_content.feature
+- features/step_definitions/web_steps.rb
+- features/support/datasets_loader.rb
+- features/support/env.rb
+- features/support/matchers.rb
+- features/support/paths.rb
+- lib/archive_index_tags_and_methods.rb
+- lib/radiant-archive-extension/version.rb
+- lib/radiant-archive-extension.rb
+- lib/tasks/archive_extension_tasks.rake
+- radiant-archive-extension.gemspec
+- Rakefile
+- README
+- spec/datasets/archive_dataset.rb
+- spec/models/archive_day_index_page_spec.rb
+- spec/models/archive_month_index_page_spec.rb
+- spec/models/archive_page_spec.rb
+- spec/models/archive_year_index_page_spec.rb
+- spec/models/page_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://radiantcms.org
+licenses: []
+
+post_install_message: "\n  Add this to your radiant project with:\n    config.gem 'radiant-archive-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.6.2
+signing_key: 
+specification_version: 3
+summary: Archive for Radiant CMS
+test_files: 
+- spec/datasets/archive_dataset.rb
+- spec/models/archive_day_index_page_spec.rb
+- spec/models/archive_month_index_page_spec.rb
+- spec/models/archive_page_spec.rb
+- spec/models/archive_year_index_page_spec.rb
+- spec/models/page_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- features/archive_content.feature
+- features/step_definitions/web_steps.rb
+- features/support/datasets_loader.rb
+- features/support/env.rb
+- features/support/matchers.rb
+- features/support/paths.rb