ar_publish_control 0.0.9

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-11-17
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+ar_publish_control.gemspec
+lib/ar_publish_control.rb
+script/console
+script/destroy
+script/generate
+spec/ar_publish_control_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/db.rake
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on ar_publish_control, see http://ar_publish_control.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,166 @@
+This is a gem version of http://github.com/avdgaag/acts_as_publishable ( a Rails plugin)
+Thanks to Arjan van der Gaag for his original work in that plugin, which this gem is heavily based off.
+
+His plugin is Copyright (c) 2007 Arjan van der Gaag, released under the MIT license
+
+= ar_publish_control
+
+http://github.com/ismasan/ar_publish_control
+
+== DESCRIPTION:
+
+Add start/end publishing dates to your ActiveRecord models.
+
+== FEATURES/PROBLEMS:
+
+Adds published, unpublished and published_only(boolean) named_scopes to your models.
+
+== SYNOPSIS:
+
+    class Post < ActiveRecord::Base
+      publish_control
+    end
+	
+   # creating
+   @post = Post.create(params[:post])
+	
+   @post.publish!
+	
+   # With start and end dates
+   @post.update_attributes :publish_at => Time.now, :unpublish_at => 2.weeks.from_now
+	
+   # Or, in your views...
+   <% form_for @post do |f| %>
+     ...
+     <p>
+       <%= f.label :is_published, "Publish" %>
+       <%= f.check_box :is_published %>
+     </p>
+     <p>
+       <%= f.label :publish_at, "From" %>
+       <%= f.date_select :publish_at %>
+     </p>
+     <p>
+       <%= f.label :unpublish_at, "To" %>
+       <%= f.date_select :unpublish_at %>
+     </p>
+     ...
+   <% end %>
+	
+   # in your controllers
+   def index
+     @posts = Post.published
+   end
+
+   def show
+     @post = Post.published.find(params[:id])
+     @post.published? # => true
+   end
+
+   # You can nest scopes:
+   @post = current_user.posts.published(params[:id])
+    
+   @posts = current_user.posts.published.paginate(:page => params[:page])
+
+   # unpublished ones
+   @posts = Post.unpublished
+
+   # All posts if logged_in?, only published otherwise
+   @posts = Post.published_only?( !logged_in? ).paginate(:page => params[:page])
+    
+   # Unpublish
+   @post.unpublish!
+   @post.unpublished? # => true
+    
+   # You can access the ones marked as "published" but with a publish date in the future
+   @upcoming_post = Post.upcoming
+   @upcoming_post.first.upcoming? # => true
+
+   # You can fetch objects that have expired (ie. they have an unpublish_at date set in the past)
+   @expired_posts = Post.expired
+   @expired_posts.first.expired? # => true
+
+   # Finally, if you want those objects where is_published == false, regardless of dates
+   @drafts = Post.draft
+
+All of these named_scopes can be chained with other finder conditions and paginated with will_paginate
+
+== REQUIREMENTS:
+
+ActiveRecord
+
+== INSTALL:
+
+If you haven't yet, add github.com to your gem sources (you only need to do that once):
+
+    gem sources -a http://gems.github.com
+
+Now you can install the normal way:
+
+    sudo gem install ismasan-ar_publish_control
+
+Add the necessary fields to you schema, in a migration:
+
+   class AddPublishableToPosts < ActiveRecord::Migration
+     def self.up
+       add_column :posts, :is_published, :boolean, :default => true
+       add_column :posts, :publish_at, :datetime
+       add_column :posts, :unpublish_at, :datetime
+       # update existing records if you have them
+       Post.update_all "publish_at = created_at"
+     end
+     def self.down
+       remove_column :posts, :is_published
+       remove_column :posts, :publish_at
+       remove_column :posts, :unpublish_at
+     end
+   end
+	
+   rake db:migrate
+
+Then, in your Rails app's environment:
+
+    config.gem 'ismasan-ar_publish_control',:lib => 'ar_publish_control',:source => "http://gems.github.com"
+
+...Or in Merb or elsewhere
+
+    require "ar_publish_control"
+
+If you wan to unpack the gem to you app's "vendor" directory:
+
+    rake gems:unpack
+
+== TEST
+
+Test are in the spec directory (rspec). To run them, first initialize the test sqlite database
+
+    rake db:create
+
+Now you can run the specs
+
+    rake spec
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Ismael Celis
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/ar_publish_control'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('ar_publish_control', ArPublishControl::VERSION) do |p|
+  p.developer('Ismael Celis', 'ismaelct@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/ar_publish_control.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ar_publish_control}
+  s.version = "0.0.9"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ismael Celis"]
+  s.date = %q{2008-11-18}
+  s.description = %q{Publish control for ActiveRecord}
+  s.email = ["ismaelct@gmail.com"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc"]
+  s.files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "ar_publish_control.gemspec", "lib/ar_publish_control.rb", "script/console", "script/destroy", "script/generate", "spec/ar_publish_control_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/db.rake", "tasks/rspec.rake"]
+  s.has_rdoc = false
+  s.homepage = %q{http://www.estadobeta.com}
+  s.post_install_message = %q{PostInstall.txt}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ar_publish_control}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Publish control for ActiveRecord, with start and optional end dates}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<newgem>, [">= 1.1.0"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<newgem>, [">= 1.1.0"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<newgem>, [">= 1.1.0"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/lib/ar_publish_control.rb

@@ -0,0 +1,229 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module ArPublishControl
+  VERSION = '0.0.9'
+  # This is a gem version of http://github.com/avdgaag/acts_as_publishable ( a Rails plugin)
+  # Thanks to Avdaag for his awesome, super readable code which I ripped off for this gem.
+  #
+  # Specify this act if you want to show or hide your object based on date/time settings. This act lets you
+  # specify two dates two form a range in which the model is publicly available; it is unavailable outside it.
+  # 
+  # == Usage
+  # 
+  # You can add this behaviour to your model like so:
+  # 
+  #   class Post < ActiveRecord::Base
+  #     publish_control
+  #   end
+  # 
+  # Then you can use it as follows:
+  # 
+  #   post = Post.create(:title => 'Hello world')
+  #   post.published? # => true
+  #   
+  #   post.publish!
+  #   post.published? # => true
+  #   
+  #   post.unpublish!
+  #   post.published? # => false
+  #   
+  # You can use two named_scopes to find the published or unpublished objects.
+  # You can chain them with other scopes and use them on association collections:
+  #   
+  #   Post.all.count          # => 15
+  #   Post.published.count    # => 10
+  #   Post.unpublished.count  # => 5 includes upcoming and expired
+  #   Post.draft.count        # => where is_published == false regardless of date
+  #   @post.comments.published
+  #
+  #   Post.recent.published
+  #
+  #  Klass.unpublished includes all objects which is_published flag is set to false and/or are expired or upcoming.
+  #  If you specifically want those where is_published == false regardless of dates, use Klass.draft
+  # 
+  # There's a third named_scope that you can pass a boolean in order to find only published items or all of them
+  # This is useful in controller for permission-based publish control
+  #
+  #   @post       = Post.published.find(params[:id])
+  #   @comments   = @post.comments.only_published( logged_in? )
+  # 
+  # Available statuses. This constant is useful for autogenerated routes, controller actions and view helpers
+  #
+  STATUSES = [:published, :draft, :upcoming, :expired]
+  
+  module Publishable
+  
+    def self.included(base) #:nodoc:
+      base.extend ClassMethods
+    end
+  
+    module ClassMethods
+      # == Configuration options
+      #
+      # Right now this plugin has only one configuration option. Models with no publication dates
+      # are by default published, not unpublished. If you want to hide your model when it has no
+      # explicit publication date set, you can turn off this behaviour with the
+      # +publish_by_default+ (defaults to <tt>true</tt>) option like so:
+      #
+      #   class Post < ActiveRecord::Base
+      #     publish_control :publish_by_default => false
+      #   end
+      #
+      # == Database Schema
+      #
+      # The model that you're publishing needs to have two special date attributes:
+      # 
+      # * publish_at
+      # * unpublish_at
+      # 
+      # These attributes have no further requirements or required validations; they
+      # just need to be <tt>datetime</tt>-columns.
+      # 
+      # You can use a migration like this to add these columns to your model:
+      #
+      #   class AddPublicationDatesToPosts < ActiveRecord::Migration
+      #     def self.up
+      #       add_column :posts, :publish_at, :datetime
+      #       add_column :posts, :unpublish_at, :datetime
+      #     end
+      #   
+      #     def self.down
+      #       remove_column :posts, :publish_at
+      #       remove_column :posts, :unpublish_at
+      #     end
+      #   end
+      # 
+      def publish_control(options = { :publish_by_default => true })
+        # don't allow multiple calls
+        return if self.included_modules.include?(ArPublishControl::Publishable::InstanceMethods)
+        send :include, ArPublishControl::Publishable::InstanceMethods
+        
+        named_scope :published, lambda{{:conditions => published_conditions}}
+        named_scope :unpublished, lambda{{:conditions => unpublished_conditions}}
+        named_scope :upcoming, lambda{{:conditions => upcoming_conditions}}
+        named_scope :expired, lambda {{:conditions => expired_conditions}}
+        named_scope :draft, :conditions => {:is_published => false}
+        
+        named_scope :published_only, lambda {|*args|
+          bool = (args.first.nil? ? true : (args.first)) # nil = true by default
+          bool ? {:conditions => published_conditions} : {}
+        }
+        
+        validate :validate_publish_date_consistency
+        before_create :publish_by_default if options[:publish_by_default]
+      end
+      
+      # Takes a block whose containing SQL queries are limited to
+      # published objects. You can pass a boolean flag indicating
+      # whether this scope should be applied or not--for example,
+      # you might want to disable it when the user is an administrator.
+      # By default the scope is applied.
+      # 
+      # Example usage:
+      # 
+      #   Post.published_only(!logged_in?)
+      #   @post.comments.published_only(!logged_in?)
+      # 
+      
+      protected
+
+      # returns a string for use in SQL to filter the query to unpublished results only
+      # Meant for internal use only
+      def unpublished_conditions
+        t = Time.now
+        ["(#{table_name}.is_published = ? OR #{table_name}.publish_at > ?) OR (#{table_name}.unpublish_at IS NOT NULL AND #{table_name}.unpublish_at < ?)",false,t,t]
+      end
+      
+      # return a string for use in SQL to filter the query to published results only
+      # Meant for internal use only
+      def published_conditions
+        t = Time.now
+        ["(#{table_name}.is_published = ? AND #{table_name}.publish_at <= ?) AND (#{table_name}.unpublish_at IS NULL OR #{table_name}.unpublish_at > ?)",true,t,t]
+      end
+      
+      def upcoming_conditions
+        t = Time.now
+        ["(#{table_name}.is_published = ? AND #{table_name}.publish_at > ?)",true,t]
+      end
+      
+      def expired_conditions
+        t = Time.now
+        ["(#{table_name}.unpublish_at IS NOT NULL AND #{table_name}.unpublish_at < ?)",t]
+      end
+    end
+    
+    module InstanceMethods
+      
+      def after_initialize
+        write_attribute(:publish_at, Time.now) if publish_at.nil?
+      end
+      
+      # ActiveRecrod callback fired on +before_create+ to make 
+      # sure a new object always gets a publication date; if 
+      # none is supplied it defaults to the creation date.
+      def publish_by_default
+        write_attribute(:is_published, true) if is_published.nil?
+      end
+      
+      # Validate that unpublish_at is greater than publish_at
+      # publish_at must not be nil
+      def validate_publish_date_consistency
+        if unpublish_at && publish_at && unpublish_at <= publish_at
+          errors.add(:unpublish_at,"should be greater than publication date or empty")
+        end
+      end
+      
+    public
+      
+      # Return whether the current object is published or not
+      def published?
+        (is_published? && (publish_at <=> Time.now) <= 0) && (unpublish_at.nil? || (unpublish_at <=> Time.now) >= 0)
+      end
+      
+      def upcoming?
+        (is_published? && publish_at > Time.now)
+      end
+      
+      def expired?
+        (!unpublish_at.nil? && unpublish_at < Time.now)
+      end
+      
+      # Indefinitely publish the current object right now
+      def publish
+        return if published?
+        self.is_published = true
+        self.publish_at = Time.now
+        self.unpublish_at = nil
+      end
+      
+      # Same as publish, but immediatly saves the object.
+      # Raises an error when saving fails.
+      def publish!
+        publish
+        save!
+      end
+      
+      # Immediatly unpublish the current object
+      def unpublish
+        return unless published?
+        self.is_published = false
+      end
+      
+      # Same as unpublish, but immediatly saves the object.
+      # Raises an error when saving files.
+      def unpublish!
+        unpublish
+        save!
+      end
+      
+    end
+  end
+  
+  
+end
+
+require 'rubygems'
+require 'active_record'
+
+ActiveRecord::Base.send :include, ArPublishControl::Publishable

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/ar_publish_control.rb'}"
+puts "Loading ar_publish_control gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/ar_publish_control_spec.rb

@@ -0,0 +1,194 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe ArPublishControl do
+  it "should have array of available statuses" do
+    (ArPublishControl::STATUSES == [:published, :draft, :upcoming, :expired]).should be_true
+  end
+end
+
+describe Comment do
+  before(:each) do
+    Post.destroy_all
+    @published_post = Post.create do |p|
+      p.title         = 'some post'
+      p.publish_at    = 1.day.ago
+      p.unpublish_at  = 2.days.from_now
+    end
+    
+    @unpublished_post = Post.create do |p|
+      p.title         = 'some other post'
+      p.publish_at    = 1.day.from_now
+      p.unpublish_at  = 2.days.from_now
+    end
+    
+    @published_comment_in_published_post = @published_post.comments.create do |c|
+      c.body         = 'some comment'
+      c.publish_at    = 2.day.ago
+      c.unpublish_at  = 2.days.from_now
+    end
+    
+    @published_comment_in_unpublished_post = @unpublished_post.comments.create do |c|
+      c.body         = 'some other comment'
+      c.publish_at    = 1.day.ago
+      c.unpublish_at  = 2.days.from_now
+    end
+    
+    @unpublished_comment_in_published_post = @published_post.comments.create do |c|
+      c.body         = 'some other comment 2'
+      c.publish_at    = 1.day.from_now
+      c.unpublish_at  = 2.days.from_now
+    end
+    
+    @unupublished_comment_in_unpublished_post = @unpublished_post.comments.create do |c|
+      c.body         = 'some other comment 3'
+      c.publish_at    = 1.day.from_now
+      c.unpublish_at  = 2.days.from_now
+    end
+    
+  end
+  
+  it "should find published comment at class level" do
+    Comment.published.size.should == 2
+  end
+  
+  it "should find published comments in collection" do
+    @published_post.comments.published.size.should == 1
+  end
+  
+  it "should find published comments in a collection with conditions" do
+    @published_post.published_comments.size.should == 1
+  end
+  
+  it "should work with named scope at class level" do
+    Comment.published.size.should == 2
+  end
+  
+  it "should work with named scope at collection level" do
+    @published_post.comments.published.size.should == 1
+  end
+  
+  it "should find unpublished with named scope" do
+    Comment.unpublished.size.should == 2
+    @published_post.comments.unpublished.size.should == 1
+  end
+  
+  it "should chain correctly with other scopes" do
+    Comment.published.desc.should == [@published_comment_in_unpublished_post,@published_comment_in_published_post]
+  end
+  
+  it "should chain correctly with other scopes on collections" do
+    @unpublished_comment_in_published_post.publish_at = @published_comment_in_published_post.publish_at + 1.hour
+    @unpublished_comment_in_published_post.save
+    @published_post.comments.reload
+    @published_post.comments.published.desc.should == [@unpublished_comment_in_published_post,@published_comment_in_published_post]
+  end
+  
+  it "should find all with conditional flag" do
+    Comment.published_only.size.should == 2
+    Comment.published_only(true).size.should == 2
+    @published_post.comments.published_only(true).first.should == @published_comment_in_published_post
+    @published_post.comments.published_only(true).include?(@unpublished_comment_in_published_post).should be_false
+    @published_post.comments.published_only(false).include?(@unpublished_comment_in_published_post).should be_true
+    @published_post.comments.published_only(false).include?(@published_comment_in_published_post).should be_true
+  end
+  
+  it "should validate that unpublish_at is greater than publish_at" do
+    @published_comment_in_published_post.unpublish_at = @published_comment_in_published_post.publish_at - 1.minute
+    @published_comment_in_published_post.save
+    @published_comment_in_published_post.should_not be_valid
+    @published_comment_in_published_post.errors.on(:unpublish_at).should == "should be greater than publication date or empty"
+  end
+  
+end
+
+# describe Post, 'with no dates' do
+#   it "should be published" do
+#     puts "DESTROYING #{Post.count}============="
+#     Post.destroy_all
+#     puts "====================================="
+#     post = Post.create(:title => 'some post aaaaaaaaaaaaaaaaaaaaaaaaaaaa')
+#     post.published?.should be_true
+#     Post.published.include?(post).should be_true
+#   end
+# end
+
+describe Post, "unpublished by default" do
+  before(:each) do
+    Article.destroy_all
+    @a1 = Article.create(:title=>'a1')
+    @invalid = Article.create(:title=>'a2', :publish_at => '')
+  end
+  
+  it "should be valid" do
+    @a1.should be_valid
+    @a1.publish_at.should_not be_nil
+    @invalid.publish_at.should_not be_blank
+  end
+  
+  it "should be unpublished by default" do
+    @a1.published?.should_not be_true
+    Article.published.size.should == 0
+  end
+  
+  it "should publish" do
+    @a1.publish!
+    @a1.published?.should be_true
+  end
+end
+
+describe Post, 'upcoming' do
+  before(:each) do
+    Post.destroy_all
+    @p1 = Post.create(:title => 'p1',:is_published => true,:publish_at => 1.day.from_now) #upcoming
+    @p2 = Post.create(:title => 'p2',:is_published => true,:publish_at => 1.week.from_now)#upcoming
+    @p3 = Post.create(:title => 'p3',:is_published => false,:publish_at => 1.day.from_now)#unpublished
+    @p4 = Post.create(:title => 'p4',:is_published => true)#published
+  end
+  
+  it "should have upcoming" do
+    @p1.upcoming?.should be_true
+    @p2.upcoming?.should be_true
+    @p3.upcoming?.should be_false
+    @p4.upcoming?.should be_false
+    Post.upcoming.size.should == 2
+  end
+end
+
+describe Post, 'expired' do
+  before(:each) do
+    Post.destroy_all
+    @p1 = Post.create(:title => 'p1',:is_published => true,:publish_at => 2.weeks.ago) #published
+    @p2 = Post.create(:title => 'p2',:is_published => true,:publish_at => 2.weeks.ago,:unpublish_at => 1.day.ago)#expired
+    @p3 = Post.create(:title => 'p3',:is_published => false,:publish_at => 3.days.ago,:unpublish_at => 2.hours.ago)#unpublished and expired
+  end
+  
+  it "should have expired" do
+    @p1.expired?.should be_false
+    @p2.expired?.should be_true
+    @p3.expired?.should be_true
+    Post.expired.size.should == 2
+  end
+end
+
+describe Post, 'draft' do
+  before(:each) do
+    Post.destroy_all
+    @p1 = Post.create(:title => 'p1',:is_published => true,:publish_at => 2.weeks.ago) #published
+    @p2 = Post.create(:title => 'p2',:is_published => true,:publish_at => 2.weeks.ago,:unpublish_at => 1.day.ago)#expired
+    @p3 = Post.create(:title => 'p3',:is_published => false,:publish_at => 3.days.ago,:unpublish_at => 2.hours.ago)#unpublished and expired
+  end
+  
+  it "should have draft" do
+    Post.draft.count.should == 1
+    Post.draft.first.should == @p3
+  end
+end
+
+describe "new record" do
+  it "should default to Time.now" do
+    # d = Time.now
+    #     Time.stub!(:now).and_return d
+    a = Article.new
+    a.publish_at.should_not be_nil
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,47 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'ar_publish_control'
+
+ActiveRecord::Base.establish_connection(
+  :adapter=>'sqlite3',
+  :dbfile=> File.join(File.dirname(__FILE__),'db','test.db')
+)
+
+#ActiveRecord::Base.connection.query_cache_enabled = false
+
+LOGGER = Logger.new(File.dirname(__FILE__)+'/log/test.log')
+ActiveRecord::Base.logger = LOGGER
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+  
+  named_scope :recent, lambda{|limit|
+    {:order => 'created_at desc',:limit => limit}
+  }
+  
+  named_scope :desc, :order => 'publish_at desc'
+  
+  publish_control
+  
+end
+
+class Post < ActiveRecord::Base
+  
+  has_many :comments, :dependent => :destroy
+  
+  has_many :published_comments, :class_name => 'Comment', :conditions => Comment.published_conditions
+  
+  publish_control
+  
+end
+
+class Article < ActiveRecord::Base
+  publish_control :publish_by_default => false
+end

data/tasks/db.rake

@@ -0,0 +1,57 @@
+database_config = {
+  :adapter=>'sqlite3',
+  :dbfile=> File.join(File.dirname(__FILE__),'..','spec','db','test.db')
+}
+
+ActiveRecord::Base.establish_connection(database_config)
+# define a migration
+class TestSchema < ActiveRecord::Migration
+  def self.up
+    create_table :posts do |t|
+      t.string :title
+      t.boolean  :is_published
+      t.datetime :publish_at
+      t.datetime :unpublish_at
+      t.timestamps
+    end
+    
+    create_table :articles do |t|
+      t.string :title
+      t.boolean  :is_published
+      t.datetime :publish_at
+      t.datetime :unpublish_at
+      t.timestamps
+    end
+    
+    create_table :comments do |t|
+      t.text :body
+      t.boolean  :is_published
+      t.integer :post_id
+      t.datetime :publish_at
+      t.datetime :unpublish_at
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :posts
+    drop_table :comments
+    drop_table :articles
+  end
+end
+
+
+namespace :db do
+  desc "migrate test schema"
+  task :create do
+    File.unlink(database_config[:dbfile])
+    ActiveRecord::Base.connection # this creates the DB
+    # run the migration
+    TestSchema.migrate(:up)
+  end
+  
+  desc "Destroy test schema"
+  task :destroy do
+    TestSchema.migrate(:down)
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: ar_publish_control
+version: !ruby/object:Gem::Version 
+  version: 0.0.9
+platform: ruby
+authors: 
+- Ismael Celis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-05 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Add start/end publishing dates to your ActiveRecord models.
+email: 
+- ismaelct@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- ar_publish_control.gemspec
+- lib/ar_publish_control.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/ar_publish_control_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/db.rake
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/ismasan/ar_publish_control
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: ar_publish_control
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Add start/end publishing dates to your ActiveRecord models.
+test_files: []
+