archive_tree 1.0.0.rc3 → 1.0.0

data/Gemfile

@@ -0,0 +1,19 @@
+source 'http://rubygems.org'
+
+gem 'activerecord', '~> 3.0.1'
+gem 'actionpack', '~> 3.0.1'
+
+group :development, :test do
+  gem 'mysql', '~> 2.8.0'
+
+  if RUBY_VERSION =~ /1\.9\.\d/
+    gem('ruby-debug-base19', '=0.11.23') if RUBY_VERSION == '1.9.1'
+    gem 'ruby-debug19', '~> 0.11.0'
+  else
+    gem 'ruby-debug'
+  end
+
+  gem 'rspec', '~> 2.0.0'
+  gem 'factory_girl_rails', '~> 1.0.0'
+  gem 'database_cleaner', '~> 0.6.0'
+end

data/Gemfile.lock

@@ -0,0 +1,109 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.1)
+      actionpack (= 3.0.1)
+      mail (~> 2.2.5)
+    actionpack (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+    activesupport (3.0.1)
+    archive-tar-minitar (0.5.2)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    columnize (0.3.2)
+    database_cleaner (0.6.0)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    factory_girl (1.3.2)
+    factory_girl_rails (1.0)
+      factory_girl (~> 1.3)
+      rails (>= 3.0.0.beta4)
+    i18n (0.4.2)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    mail (2.2.9)
+      activesupport (>= 2.3.6)
+      i18n (~> 0.4.1)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mysql (2.8.1)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.1)
+      actionmailer (= 3.0.1)
+      actionpack (= 3.0.1)
+      activerecord (= 3.0.1)
+      activeresource (= 3.0.1)
+      activesupport (= 3.0.1)
+      bundler (~> 1.0.0)
+      railties (= 3.0.1)
+    railties (3.0.1)
+      actionpack (= 3.0.1)
+      activesupport (= 3.0.1)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+    thor (0.14.4)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 3.0.1)
+  activerecord (~> 3.0.1)
+  database_cleaner (~> 0.6.0)
+  factory_girl_rails (~> 1.0.0)
+  mysql (~> 2.8.0)
+  rspec (~> 2.0.0)
+  ruby-debug19 (~> 0.11.0)

data/README.md

@@ -1,9 +1,15 @@
 ## Introduction
 
-ArchiveTree is a plugin for your Ruby on Rails application that makes it easy for you to generate structured trees of your records.
+ArchiveTree is a Ruby Gem for your Ruby on Rails application that makes it easy for you to generate structured trees of your records.
 
-Since it makes use of your model's _created_at_ column, ArchiveTree is ultimately compatible with most ActiveRecord Models out there.
+Since it uses a column of your choice, from any ActiveRecord Model, you will have flexibility to use in most of the Ruby on Rails applications
 
+## Compatibility
+
+The Gem was developed to work with Rails 3.0.x, running on Ruby 1.8.7 or 1.9.2.
+Since it uses SQL specific queries, it works on MySQL and PostgreSQL databases.
+
+**Note:** This gem does not work with Ruby v1.9.1.
 
 ## Installation
 
@@ -28,6 +34,14 @@ Now let's say that you wish to allow your users to sweep through your posts in a
 
 ### API
 
+#### Inclusion:
+
+In your ActiveRecord Model:
+
+<pre>
+acts_as_archive #=> defaults to :created_at
+</pre>
+
 #### Default usage:
 
 <pre>
@@ -54,15 +68,15 @@ Post.archive_tree(:months => [1]) #=> { 2010 => { 1 => [Post] },
 Post.archive_tree(:years_and_months => { 2010 => [1] }) #=> { 2010 => { 1 => [Post] } }
 </pre>
 
-### Views
+### View
 
 <pre>
-draw_archive_tree(:model_sym => :post, :route => :archive_published_at_path, :toggle => false)
+draw_archive_tree #=> defaults to: :model_sym => :post, :route => :posts_path, :toggle => true, :toggle_text => '[ + ]'
 </pre>
 
 ## Documentation
 
-This gem's documentation documentation is available at http://yardoc.org/docs/GnomesLab-archive_tree
+This gem's documentation documentation is available at http://rubydoc.info/github/GnomesLab/archive_tree/
 
 
 ## License

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+desc 'Generate documentation for the archive_tree plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ArchiveTree'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.ruby_opts = '-w'
+  end
+
+  task :default => :spec
+rescue LoadError
+  raise 'RSpec could not be loaded. Run `bundle install` to get all development dependencies.'
+end
+
+# Rubygems
+namespace :rubygems do
+  gemspec = eval(File.read('archive_tree.gemspec'))
+  Rake::GemPackageTask.new(gemspec) do |pkg|
+    pkg.gem_spec = gemspec
+  end
+
+  desc "build the gem and release it to rubygems.org"
+  task :release => :gem do
+    sh "rake spec"
+    sh "gem push pkg/archive_tree-#{gemspec.version}.gem"
+  end
+end

data/lib/archive_tree.rb

@@ -17,8 +17,8 @@
 # TODO: This module should undergo a query optimization. Furthermore, an ORM abstraction.
 module ArchiveTree
 
-  require 'archive_tree/action_view_extensions'
   autoload :Core, 'archive_tree/core'
+  autoload :ActionViewExtensions, 'archive_tree/action_view_extensions'
 
   def acts_as_archive(date_field = :created_at)
     raise ::ArgumentError, "undefined parameter #{date_field.to_s}" unless column = columns_hash[date_field.to_s]
@@ -33,5 +33,3 @@ module ArchiveTree
     attr_accessor :date_field
 
 end # ArchiveTree
-
-ActiveRecord::Base.send :extend, ArchiveTree if defined?(ActiveRecord::Base)

data/lib/archive_tree/action_view_extensions.rb

@@ -1,8 +1,73 @@
 module ArchiveTree
 
   module ActionViewExtensions
-    require 'archive_tree/action_view_extensions/draw_archive_tree'
-    ::ActionView::Base.send :include, DrawArchiveTree
+
+    # In the presence of records for a given model it draws the archive tree. Otherwise, returns an empty string
+    #
+    # This method relies on the following private methods:
+    #   * +draw_years+
+    #   * +draw_months+
+    #
+    # Default behavior
+    #   * It will attempt to create a tree of your Post model
+    #   * Will use the posts_path route
+    #   * Will display a toggle link
+    #   * Will use "[ + ]" as the text for the toggle link
+    #
+    # Options
+    #   * model_sym #=> the symbol of the model to request the archive_nodes
+    #   * route #=> the route that handles the archived posts requests
+    #   * toggle #=> when true, includes a toggle link before the years
+    #   * toggle_text #=> the text used in the toggle link
+    #
+    # Example using the default settings:
+    #   <%= draw_archive_tree %>
+    #
+    # Overriding the defaults example:
+    #   <%= draw_archive_tree :model_sym => :post, :route => :archive_published_at_path, :toggle => false %>
+
+    def draw_archive_tree(options = {})
+      options.reverse_merge!({ :model_sym => :post, :route => :posts_path, :toggle => true, :toggle_text => '[ + ]' })
+      model = options[:model_sym].to_s.capitalize.constantize
+
+      raw model.count > 0 ? draw_years(model, options[:route], options[:toggle], options[:toggle_text]) : ''
+    end # draw_archive_tree
+
+    private
+      def draw_years(model_sym, route, toggle, toggle_text) # :nodoc:
+        model = model_sym.to_s.capitalize.constantize
+        route = :posts_path unless self.respond_to? route
+
+        content_tag :ul do
+          ul_body = ""
+
+          model.archived_years.each_key do |year, count|
+            ul_body << content_tag(:li, :class => year == Time.now.year ? 'active' : 'inactive') do
+              (toggle ? link_to(toggle_text, "#", :class => "toggle") : '') + " " +
+                link_to(year, self.send(route, year)) +
+                draw_months(model_sym, route, year)
+            end
+          end
+
+          ul_body
+        end
+      end # draw_years
+
+      def draw_months(model_sym, route, year) # :nodoc:
+        model = model_sym.to_s.capitalize.constantize
+
+        content_tag :ul do
+          ul_body = ""
+
+          model.archived_months(:year => year).each_pair do |month, count|
+            ul_body << content_tag(:li, link_to("#{Date::MONTHNAMES[month]} (#{count})",
+                                                self.send(route, year, month < 10 ? "0#{month}" : month)))
+          end
+
+          ul_body
+        end
+      end # draw_months
+
   end # ActionViewExtensions
 
 end # ArchiveTree

data/spec/db/models.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  acts_as_archive
+end

data/spec/db/schema.rb

@@ -0,0 +1,14 @@
+ActiveRecord::Schema.define(:version => 20100803160738) do
+
+  create_table "posts", :force => true do |t|
+    t.string   "title",        :null => false
+    t.text     "body",         :null => false
+    t.datetime "published_at", :null => true
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "posts", ["created_at"], :name => "index_posts_on_created_at"
+  add_index "posts", ["published_at"], :name => "index_posts_on_published_at"
+
+end

data/spec/factories/posts_factory.rb

@@ -0,0 +1,6 @@
+Factory.define(:post) do |p|
+  p.sequence(:title) { |n| "Post Title #{n}" }
+  p.sequence(:body) { |n| "This is the #{n}th post. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer dictum, neque ut imperdiet pellentesque, nulla tellus tempus magna, sed consectetur orci metus a justo. Aliquam ac congue nunc. Mauris a tortor ut massa egestas tempus. Pellentesque tincidunt fermentum diam sagittis ullamcorper. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer dictum." }
+  p.sequence(:published_at) { |n| Time.now - n.month }
+  p.created_at Time.now
+end

data/spec/lib/action_view_extensions/action_view_extensions_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe ArchiveTree::ActionViewExtensions do
+
+  before :each do
+    @helper = ActionView::Base.new
+
+    # Inject routes into ActionView::Base
+    @helper.instance_eval do
+      def posts_path(*)
+        '/blog/2010'
+      end
+
+      def dummy_path(*)
+        '/dummy/2010'
+      end
+    end
+  end
+
+  describe "draw_achive_tree" do
+
+    it "should be included in ActionView::Base" do
+      @helper.should respond_to :draw_archive_tree
+    end # included
+
+    describe "without posts" do
+      it "returns an empty string when the archive tree is empty" do
+        @helper.draw_archive_tree.should be_empty
+      end
+    end # without posts
+
+    describe "with posts" do
+      before :each do
+        Factory.create :post, :created_at => Date.new(Time.now.year, 1, 1)
+        Factory.create :post, :created_at => Date.new(Time.now.year, 2, 1)
+      end
+
+      it "should return the archive tree for all records" do
+        @helper.draw_archive_tree.should == %Q{<ul><li class=\"active\"><a href=\"#\" class=\"toggle\">[ + ]</a> <a href=\"/blog/2010\">2010</a><ul><li><a href=\"/blog/2010\">January (1)</a></li><li><a href=\"/blog/2010\">February (1)</a></li></ul></li></ul>}
+      end
+    end # with posts
+
+    describe "overridable" do
+      before :each do
+        Factory.create :post, :created_at => Date.new(Time.now.year, 1, 1)
+        Factory.create :post, :created_at => Date.new(Time.now.year, 2, 1)
+      end
+
+      it "allows the model name to be overriden" do
+        lambda { @helper.draw_archive_tree(:model_sym => :hello) }.should raise_error NameError
+      end
+
+      it "allows the route to be overriden" do
+        @helper.draw_archive_tree(:route => :dummy_path).should == %Q{<ul><li class=\"active\"><a href=\"#\" class=\"toggle\">[ + ]</a> <a href=\"/dummy/2010\">2010</a><ul><li><a href=\"/dummy/2010\">January (1)</a></li><li><a href=\"/dummy/2010\">February (1)</a></li></ul></li></ul>}
+      end
+
+      it "defaults to the hardcoded route whenever the provided route is unknown" do
+        1.upto(10) { |i| Factory.create :post }
+        @helper.draw_archive_tree(:route => :xpto_path).should match(/ul/)
+      end
+
+      it "allows the toggle to be overriden" do
+        html = @helper.draw_archive_tree(:toggle => false)
+        html.should_not include '<a href="#" class="toggle">[ + ]</a>'
+      end
+
+      it "allows the toggle text to be overriden" do
+        html = @helper.draw_archive_tree(:toggle_text => '+toggle+')
+        html.should include '<a href="#" class="toggle">+toggle+</a>'
+      end
+
+    end # overridable
+
+  end # draw_achive_tree
+
+end # ArchiveTree::ActionViewExtensions

data/spec/lib/archive_node_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe ArchiveTree do
+  describe "archive_node" do
+
+    before :each do
+      1.upto(2) { |i| Factory.create(:post, :created_at => "#{Time.now.year}-0#{i}-01 00:00:00") }
+      1.upto(2) { |i| Factory.create(:post, :created_at => "#{Time.now.year + 1}-0#{i}-01 00:00:00") }
+    end
+
+    describe "defaults" do
+      it "uses the current year" do
+        Post.archive_node.each { |p| p.created_at.year.should == Time.now.year }
+      end
+
+      it "ignores the month" do
+        Post.archive_node.should have(2).record
+      end
+
+    end # defaults
+
+    describe "overridable" do
+      it "allows to override the year" do
+        year = Time.now.year + 1
+        Post.archive_node(:year => year).each { |p| p.created_at.year.should == year }
+      end
+
+      it "allows to select a month" do
+        Post.archive_node(:year => Time.now.year, :month => 1).each { |p| p.created_at.month.should == 1 }
+      end
+
+      it "allows to override the year and select a month" do
+        Post.archive_node(:year => Time.now.year, :month => 1).should have(1).record
+      end
+    end # overridables
+
+  end # archive_node
+end # ArchiveTree

data/spec/lib/archive_tree_core_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe ArchiveTree do
+
+  describe "self included" do
+
+    it "should extend klass with its ArchiveTree::Core" do
+      [:archived_years, :archived_months, :archive_tree, :archive_node].each do |method|
+        Post.should respond_to method
+      end
+    end
+  end # self.included
+
+end # ArchiveTree

data/spec/lib/archive_tree_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe ArchiveTree do
+
+  describe "acts_as_archive" do
+
+    it "should be a class method of ActiveRecord::Base" do
+      ActiveRecord::Base.should respond_to :acts_as_archive
+    end
+
+    it "should raise exception for undefined fields" do
+      lambda do
+        class Post < ActiveRecord::Base
+          acts_as_archive :dummy
+        end
+      end.should raise_error(ArgumentError)
+    end
+
+    it "should raise exception for invalid fields" do
+      lambda do
+        class Post < ActiveRecord::Base
+          acts_as_archive :body
+        end
+      end.should raise_error(ArgumentError)
+    end
+
+  end # acts_as_archive
+
+  describe "archive tree" do
+
+    before :each do
+      [2007, 2008, 2009, 2010].each do |year|
+        5.times { |i| Factory.create(:post, :created_at => "#{year}-#{01 + i}-01 00:00:00") }
+      end
+    end
+
+    describe "default behavior" do
+
+      it "should return an empty hash when there are no records" do
+        Post.destroy_all
+
+        Post.archive_tree.should == {}
+      end
+
+      it "should return the archive tree for all posts" do
+        tree = {}
+        [2007, 2008, 2009, 2010].each_with_index do |year, year_index|
+          tree[year] = {}
+          0.upto(4).each { |i| tree[year][i+1] = [Post.find(Post.first.id + year_index*5 + i)] }
+        end
+
+        Post.archive_tree.should == tree
+      end
+
+    end # default behavior
+
+    describe "years to sweep" do
+
+      it "accepts a years key in the options hash and complies to it" do
+        tree = {}
+        [2009, 2010].each_with_index do |year, year_index|
+          tree[year] = {}
+          0.upto(4).each { |i| tree[year][i+1] = [Post.find(10 + Post.first.id + year_index*5 + i)] }
+        end
+
+        Post.archive_tree(:years => [2009, 2010]).should == tree
+      end
+
+    end # years to sweep
+
+    describe "months to sweep" do
+
+      it "should only sweep January" do
+        tree = {}
+        [2007, 2008, 2009, 2010].each_with_index do |year, year_index|
+          tree[year] = {}
+          tree[year][1] = [Post.find(Post.first.id + year_index*5)]
+        end
+
+        Post.archive_tree(:months => [1]).should == tree
+      end
+
+    end # months to sweep
+
+    describe "years and months" do
+
+      it "should comply with the requested years and months filter" do
+        tree = { 2007 => { 1 => [Post.find(Post.first.id)] },
+                 2008 => { 2 => [Post.find(Post.first.id + 6)], 3 => [Post.find(Post.first.id + 7)] } }
+
+        Post.archive_tree(:years_and_months => { 2007 => [1], 2008 => [2, 3] }).should == tree
+      end
+
+    end # years and months
+
+  end # archive_tree
+
+end # ArchiveTree

data/spec/lib/archived_months_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe ArchiveTree do
+
+  describe "archived months" do
+
+    before :each do
+      2.times do |i|
+        Factory.create(:post, :created_at => "#{Time.now.year + i}-01-01 00:00:00")
+        Factory.create(:post, :created_at => "#{Time.now.year + i}-02-01 00:00:00")
+      end
+    end
+
+    it "returns an empty hash if no records exist for a given year" do
+      Post.archived_months(:year => 3000).should == {}
+    end
+
+    it "returns an integer months counter hash" do
+      Post.archived_months.should == { 1 => 1, 2 => 1 }
+    end
+
+    it "defaults it's sweep year to the current year" do
+      Factory.create :post, :created_at => "#{Time.now.year}-#{12}-01 00:00:00"
+      Post.archived_months == { 1 => 1, 2 => 1, 12 => 1 }
+    end
+
+    it "allows the invoker to specify the year being sweeped" do
+      Post.archived_months(:year => (Time.now.year + 1)).should == { 1 => 1, 2 => 1 }
+    end
+
+    it "allows the type of month name to be specified as short" do
+      Post.archived_months(:month_names => :short).should == { "Jan" => 1, "Feb" => 1 }
+    end
+
+    it "allows the type of month name to be specified as long" do
+      Post.archived_months(:month_names => :long).should == { "January" => 1, "February" => 1 }
+    end
+
+    it "defaults to :month_names => :int whenever an unknown value is passed" do
+      Post.archived_months(:month_names => :invalid_value).should == { 1 => 1, 2 => 1 }
+    end
+
+    it "discards dates that are null" do
+      Post.first.update_attributes(:created_at => nil)
+      Post.archived_months.should == { 2 => 1 }
+    end
+  end # archived_months
+
+end # ArchiveTree

data/spec/lib/archived_years_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe ArchiveTree do
+
+  describe "archived years" do
+
+    it "returns an empty hash if no years are archived" do
+      Post.archived_years.should == {}
+    end
+
+    it "returns a years counter hash" do
+      2.times { |i| Factory.create(:post, :created_at => "#{Time.now.year + i}-#{01 + i}-01 00:00:00") }
+
+      Post.archived_years.should == { Time.now.year => 1, (Time.now.year + 1) => 1 }
+    end
+
+    it "discards dates that are null" do
+      2.times { |i| Factory.create(:post, :created_at => "#{Time.now.year + i}-#{01 + i}-01 00:00:00") }
+
+      Post.last.update_attributes(:created_at => nil)
+
+      Post.archived_years.should == { Time.now.year => 1 }
+    end
+
+  end # archived_years
+
+end # ArchiveTree

data/spec/spec_helper.rb

@@ -0,0 +1,69 @@
+$:.unshift File.dirname(__FILE__) unless $:.include? File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '..') unless $:.include? File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'init'
+  require 'erb'
+  require 'logger'
+  require 'rspec'
+  require 'active_record'
+  require 'database_cleaner'
+  require 'factory_girl'
+
+  RSpec.configure do |config|
+    config.debug = true
+    # == Mock Framework
+    config.mock_with :rspec
+
+    # database_cleaner
+    config.before(:suite) do
+      DatabaseCleaner.strategy = :transaction
+      DatabaseCleaner.clean_with(:truncation)
+    end
+
+    config.before(:each) do
+      DatabaseCleaner.start
+    end
+
+    config.after(:each) do
+      DatabaseCleaner.clean
+    end
+  end
+rescue LoadError => load_error
+  puts "Please run bundle install"
+rescue StandardError => e
+  puts "Something went wrong while loading the environment."
+  throw e
+end
+
+# Requires supporting files with custom matchers and macros, etc, in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Requires all supporting factories
+Dir.glob(File.join(File.dirname(__FILE__), 'factories', '*_factory.rb')).each { |f| require f }
+
+# ActiveRecord Test database configurations
+database_yml_file = File.expand_path('../config/database.yml', __FILE__)
+
+begin
+  if File.exists?(database_yml_file)
+    active_record_configuration = YAML.load_file(database_yml_file)['test']
+    ActiveRecord::Base.establish_connection(active_record_configuration)
+    ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), 'log', 'test.log'))
+
+    ActiveRecord::Base.silence do
+      ActiveRecord::Migration.verbose = false
+
+      load File.join(File.dirname(__FILE__), 'db', 'schema.rb')
+      load File.join(File.dirname(__FILE__), 'db' , 'models.rb')
+    end
+
+    # The config/database.yml is in the spec folder
+    DatabaseCleaner.app_root = File.expand_path('spec')
+  else
+    raise "Please create #{database_yml} first. Take a look at the database.sample.yml in the config folder."
+  end
+rescue StandardError => e
+  puts "Something went wrong while attempting to load your database file, or while configuring ActiveRecord."
+  throw e
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: archive_tree
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 1
   - 0
   - 0
-  - rc3
-  version: 1.0.0.rc3
+  version: 1.0.0
 platform: ruby
 authors: 
 - Diogo Almeida
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-03 00:00:00 +00:00
+date: 2010-11-09 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,36 +29,100 @@ dependencies:
         segments: 
         - 3
         - 0
-        - 0
-        version: 3.0.0
+        - 1
+        version: 3.0.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: actionpack
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
+        - 3
         - 0
-        version: "0"
-  type: :development
+        - 1
+        version: 3.0.1
+  type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: database_cleaner
+  name: mysql
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
+        - 2
+        - 8
         - 0
-        version: "0"
+        version: 2.8.0
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 11
+        - 0
+        version: 0.11.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: factory_girl_rails
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  version_requirements: *id007
 description: ArchiveTree is a Ruby Gem that makes it easy for you to create beautiful chronological archive trees of your models. For instance, you can create a tree for your blog posts.
 email: 
 - mail@gnomeslab.com
@@ -70,12 +133,24 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/archive_tree/action_view_extensions/draw_archive_tree.rb
 - lib/archive_tree/action_view_extensions.rb
 - lib/archive_tree/core.rb
 - lib/archive_tree.rb
+- Gemfile
+- Gemfile.lock
 - MIT-LICENSE
+- Rakefile
 - README.md
+- spec/db/models.rb
+- spec/db/schema.rb
+- spec/factories/posts_factory.rb
+- spec/lib/action_view_extensions/action_view_extensions_spec.rb
+- spec/lib/archive_node_spec.rb
+- spec/lib/archive_tree_core_spec.rb
+- spec/lib/archive_tree_spec.rb
+- spec/lib/archived_months_spec.rb
+- spec/lib/archived_years_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/GnomesLab/archive_tree/
 licenses: []
@@ -85,6 +160,7 @@ rdoc_options: []
 
 require_paths: 
 - lib
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
@@ -109,6 +185,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Creates chronological trees of your models based on their created_at column value.
+summary: Creates chronological trees of your models based on column of your choice.
 test_files: []
 

data/lib/archive_tree/action_view_extensions/draw_archive_tree.rb

@@ -1,76 +0,0 @@
-module ArchiveTree
-  module ActionViewExtensions
-
-    # Defines the helper methods that will be included in the ActionView::Base in 
-    # order to return the html representation of the archive tree
-    module DrawArchiveTree
-
-      # In the presence of records for a given model it draws the archive tree. Otherwise, returns an empty string
-      #
-      # This method relies on the following private methods:
-      #   * +draw_years+
-      #   * +draw_months+
-      #
-      # Default behavior
-      #   * It will attempt to create a tree of your Post model
-      #   * Will use the posts_path route
-      #   * Will display a toggle link
-      #   * Will use "[ + ]" as the text for the toggle link
-      #
-      # Options
-      #   * model_sym #=> the symbol of the model to request the archive_nodes
-      #   * route #=> the route that handles the archived posts requests
-      #   * toggle #=> when true, includes a toggle link before the years
-      #   * toggle_text #=> the text used in the toggle link
-      #
-      # Example using the default settings:
-      #   <%= draw_archive_tree %>
-      #
-      # Overriding the defaults example:
-      #   <%= draw_archive_tree :model_sym => :post, :route => :archive_published_at_path, :toggle => false %>
-
-      def draw_archive_tree(options = {})
-        options.reverse_merge!({ :model_sym => :post, :route => :posts_path, :toggle => true, :toggle_text => '[ + ]' })
-        model = options[:model_sym].to_s.capitalize.constantize
-
-        raw model.count > 0 ? draw_years(model, options[:route], options[:toggle], options[:toggle_text]) : ''
-      end # draw_archive_tree
-
-      private
-        def draw_years(model_sym, route, toggle, toggle_text) # :nodoc:
-          model = model_sym.to_s.capitalize.constantize
-          route = :posts_path unless self.respond_to? route
-
-          content_tag :ul do
-            ul_body = ""
-
-            model.archived_years.each_key do |year, count|
-              ul_body << content_tag(:li, :class => year == Time.now.year ? 'active' : 'inactive') do
-                (toggle ? link_to(toggle_text, "#", :class => "toggle") : '') + " " +
-                  link_to(year, self.send(route, year)) +
-                  draw_months(model_sym, route, year)
-              end
-            end
-
-            ul_body
-          end
-        end
-
-        def draw_months(model_sym, route, year) # :nodoc:
-          model = model_sym.to_s.capitalize.constantize
-
-          content_tag :ul do
-            ul_body = ""
-
-            model.archived_months(:year => year).each_pair do |month, count|
-              ul_body << content_tag(:li, link_to("#{Date::MONTHNAMES[month]} (#{count})",
-                                                  self.send(route, year, month < 10 ? "0#{month}" : month)))
-            end
-
-            ul_body
-          end
-        end
-    end # DrawArchiveTree
-
-  end # ActionViewExtensions
-end # ArchiveTree