acts_as_publishable 0.1.0 → 0.2

data/Manifest

@@ -1,5 +1,10 @@
 README.rdoc
 Rakefile
+acts_as_publishable.gemspec
 lib/acts_as_publishable.rb
 lib/acts_as_publishable/acts_as_publishable.rb
+spec/acts_as_publishable_spec.rb
+spec/rspec_immediate_feedback_formatter.rb
+spec/spec.opts
+spec/spec_helper.rb
 Manifest

data/README.rdoc

@@ -36,6 +36,12 @@ This finds all instances where published? returns true.
 
 The find_published finder method accepts any of the normal options as the default find method accepts.
 
+== TODO
+
+* Option for configuring whether publish_now should be OR'd or AND'd with the published_from and published_to columns
+* Add publish! and unpublish! instance methods
+* Update README to reflect  functionality (config options, validation and the scope)
+
 == License
 
 acts_as_publishable is distributed under the Simplified BSD License, copyright (c) 2010 Rasmus Bang Grouleff

data/Rakefile

@@ -2,12 +2,12 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
   
-Echoe.new('acts_as_publishable', '0.1.0') do |p|
-  p.description     = "Makes Active Record models publishable"
+Echoe.new('acts_as_publishable', '0.2') do |p|
+  p.description     = "Rails gem that adds functionality to make Active Record models publishable"
   p.url             = "http://github.com/rbgrouleff/acts_as_publishable"
   p.author          = "Rasmus Bang Grouleff"
   p.email           = "rasmus@anybite.com"
-  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.ignore_pattern  = ["tmp/*", "script/*", "watchr-runner.rb"]
   p.development_dependencies = []
 end
 

data/acts_as_publishable.gemspec

@@ -2,21 +2,21 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_publishable}
-  s.version = "0.1.0"
+  s.version = "0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rasmus Bang Grouleff"]
-  s.date = %q{2010-06-12}
-  s.description = %q{Makes Active Record models publishable}
+  s.date = %q{2010-06-23}
+  s.description = %q{Rails gem that adds functionality to make Active Record models publishable}
   s.email = %q{rasmus@anybite.com}
   s.extra_rdoc_files = ["README.rdoc", "lib/acts_as_publishable.rb", "lib/acts_as_publishable/acts_as_publishable.rb"]
-  s.files = ["README.rdoc", "Rakefile", "lib/acts_as_publishable.rb", "lib/acts_as_publishable/acts_as_publishable.rb", "Manifest", "acts_as_publishable.gemspec"]
+  s.files = ["README.rdoc", "Rakefile", "acts_as_publishable.gemspec", "lib/acts_as_publishable.rb", "lib/acts_as_publishable/acts_as_publishable.rb", "spec/acts_as_publishable_spec.rb", "spec/rspec_immediate_feedback_formatter.rb", "spec/spec.opts", "spec/spec_helper.rb", "Manifest"]
   s.homepage = %q{http://github.com/rbgrouleff/acts_as_publishable}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Acts_as_publishable", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{acts_as_publishable}
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Makes Active Record models publishable}
+  s.summary = %q{Rails gem that adds functionality to make Active Record models publishable}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/acts_as_publishable/acts_as_publishable.rb

@@ -7,27 +7,30 @@ module ActsAsPublishable
     def acts_as_publishable(options = {})
       metaclass = (class << self; self; end)
       
-      return if metaclass.included_modules.include?(ActsAsPublishable::SingletonMethods)
-      
-      send :extend, ActsAsPublishable::SingletonMethods
+      return if metaclass.included_modules.include?(ActsAsPublishable::InstanceMethods)
       
       cattr_accessor :publish_now_column, :published_from_column, :published_to_column, :default_published_now
       
       self.publish_now_column = options[:publish_now_column] || 'publish_now'
       self.published_from_column = options[:published_from_column] || 'published_from'
       self.published_to_column = options[:published_to_column] || 'published_to'
-      self.default_published_now = options[:default_published_now]
+      self.default_published_now = (options[:default_published_now] == true)
+      
+      named_scope :published, :conditions => ["#{publish_now_column} = :published OR (#{published_from_column} <= :published_from AND #{published_to_column} >= :published_to)", {:published => true, :published_from => Time.now, :published_to => Time.now}]
+      
+      before_save { |publishable| publishable[publish_now_column.to_sym] = default_published_now if publishable[publish_now_column.to_sym].nil?; true }
+      
+      validate_chronology
       
       send :include, ActsAsPublishable::InstanceMethods
     end
     
-    
-  end
-  
-  module SingletonMethods
-    def find_published(options = {})
-      scope = scoped(:conditions => ["#{publish_now_column} = :published OR (#{published_from_column} <= :published_from AND #{published_to_column} >= :published_to)", {:published => true, :published_from => Time.now, :published_to => Time.now}])
-      scope.find(:all, options)
+    def validate_chronology
+      validates_each published_to_column do |publishable, attribute, value|
+        unless value.blank? || publishable[published_from_column.to_sym].blank?
+          publishable.errors.add(attribute, :earlier_than_published_from, :default => "cannot be set earlier than #{published_from_column.to_s.humanize}") unless publishable[published_from_column.to_sym] < value
+        end
+      end
     end
   end
   

data/spec/acts_as_publishable_spec.rb

@@ -0,0 +1,166 @@
+$LOAD_PATH << File.dirname(__FILE__)
+
+require 'spec_helper'
+
+describe "Publishable with default columns" do
+  
+  before :all do
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :posts do |t|
+        t.boolean :publish_now
+        t.datetime :published_from
+        t.datetime :published_to
+      end
+    end
+
+    class Post < ActiveRecord::Base
+      acts_as_publishable
+    end
+  end
+  
+  after :all do
+    ActiveRecord::Schema.define(:version => 1) do
+      drop_table :posts
+    end
+  end
+  
+  before :each do
+    @post = Post.new
+  end
+  
+  it "has a named scope" do
+    Post.should respond_to(:published)
+  end
+  
+  it "has a class attribute for the publish_now column" do
+    Post.publish_now_column.should == 'publish_now'
+  end
+  
+  it "has a class attribute for the published_from column" do
+    Post.published_from_column.should == 'published_from'
+  end
+  
+  it "has a class attribute for the published_to column" do
+    Post.published_to_column.should == 'published_to'
+  end
+  
+  it "has a published? instance method" do
+    @post.published?.should be_false
+  end
+  
+  it "has an instance attribute called publish_now" do
+    @post.publish_now.should be_false
+  end
+  
+  it "has an instance attribute called published_from" do
+    @post.should respond_to(:published_from)
+  end
+  
+  it "has an instance attribute called published_to" do
+    @post.should respond_to(:published_to)
+  end
+  
+  it "has an instance attribute called publish_now" do
+    @post.should respond_to(:publish_now)
+  end
+  
+  it "should persist publish_now to the database" do
+    @post.publish_now = true
+    @post.save
+    Post.find(@post.id).publish_now.should be_true
+  end
+  
+  it "should persist published_to and published_from dates" do
+    tomorrow = Time.parse 'Sun Jun 20 17:03:03 +0200 2010'
+    a_day_ago = Time.parse 'Fri Jun 18 17:03:03 +0200 2010'
+    @post.published_from = a_day_ago
+    @post.published_to = tomorrow
+    @post.save_without_validation
+    Post.find(@post.id).published_from.should eql(a_day_ago)
+    Post.find(@post.id).published_to.should eql(tomorrow)
+   end
+  
+  it "is published if publish_now is true" do
+    @post.publish_now = true
+    @post.save
+    @post.published?.should be_true
+  end
+  
+  it "should be invalid if published_to is set in the past" do
+    @post.published_to = 1.day.ago
+    @post.published_from = Time.now
+    @post.valid?.should_not be_true
+  end
+end
+
+describe "Publishable with default_published_now set to true" do
+  before :all do
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :posts do |t|
+        t.boolean :publish_now
+        t.datetime :published_from
+        t.datetime :published_to
+      end
+    end
+    
+    class Post < ActiveRecord::Base
+      acts_as_publishable :default_published_now => true
+    end
+  end
+  
+  after :all do
+    ActiveRecord::Schema.define(:version => 1) do
+      drop_table :posts
+    end
+  end
+  
+  before :each do
+    @post = Post.new
+  end
+  
+  it "should be published by default" do
+    @post.save
+    @post.publish_now.should be_true
+    
+  end
+end
+
+describe "Publishable with non-default column names" do
+  before :all do
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :publishables do |t|
+        t.boolean :now
+        t.datetime :from
+        t.datetime :to
+      end
+    end
+    
+    class Publishable < ActiveRecord::Base
+      acts_as_publishable :publish_now_column => :now, :published_from_column => :from, :published_to_column => :to
+    end
+  end
+  
+  after :all do
+    ActiveRecord::Schema.define(:version => 1) do
+      drop_table :publishables
+    end
+  end
+  
+  before :each do
+    @publishable = Publishable.new
+  end
+  
+  it "should have a now column" do
+    @publishable.should respond_to(:now)
+  end
+  
+  it "should persist to and from dates" do
+    tomorrow = Time.parse 'Sun Jun 20 17:03:03 +0200 2010'
+    a_day_ago = Time.parse 'Fri Jun 18 17:03:03 +0200 2010'
+    @publishable.from = a_day_ago
+    @publishable.to = tomorrow
+    @publishable.save
+    Publishable.find(@publishable.id).from.should eql(a_day_ago)
+    Publishable.find(@publishable.id).to.should eql(tomorrow)
+   end
+end

data/spec/rspec_immediate_feedback_formatter.rb

@@ -0,0 +1,53 @@
+require 'spec/runner/formatter/base_text_formatter'
+
+# Code is based on standard SpecdocFormatter, but will print full error details as soon as they are found.
+# Successful or pending examples are written only as a dot in the output. Header is only printed if errors occur.
+#
+# To use it, add the following to your spec/spec.opts:
+#  --require
+#  lib/rspec_immediate_feedback_formatter.rb
+#  --format
+#  Spec::Runner::Formatter::ImmediateFeedbackFormatter
+
+module Spec
+  module Runner
+    module Formatter
+      class ImmediateFeedbackFormatter < BaseTextFormatter
+
+        def add_example_group(example_group)
+          super
+          @current_group = example_group.description
+        end
+      
+        def example_failed(example, counter, failure)
+          if @current_group
+            output.puts
+            output.puts @current_group
+            @current_group = nil  # only print the group name once
+          end
+
+          message = if failure.expectation_not_met?
+            "- #{example.description} (FAILED - #{counter})"
+          else
+            "- #{example.description} (ERROR - #{counter})"
+          end
+          
+          output.puts(failure.expectation_not_met? ? red(message) : magenta(message))
+          dump_failure(counter, failure)  # dump stacktrace immediately
+          output.flush
+        end
+        
+        def example_passed(example)
+          output.print green(".")
+          output.flush
+        end
+        
+        def example_pending(example, message)
+          super
+          output.print yellow(".")
+          output.flush
+        end
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--require spec/rspec_immediate_feedback_formatter.rb
+--format Spec::Runner::Formatter::ImmediateFeedbackFormatter
+--colour
+--loadby mtime
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rubygems'
+require 'active_record'
+require 'acts_as_publishable'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_publishable
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 0
-  version: 0.1.0
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - Rasmus Bang Grouleff
@@ -15,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-12 00:00:00 +02:00
+date: 2010-06-23 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
-description: Makes Active Record models publishable
+description: Rails gem that adds functionality to make Active Record models publishable
 email: rasmus@anybite.com
 executables: []
 
@@ -32,10 +31,14 @@ extra_rdoc_files:
 files: 
 - README.rdoc
 - Rakefile
+- acts_as_publishable.gemspec
 - lib/acts_as_publishable.rb
 - lib/acts_as_publishable/acts_as_publishable.rb
+- spec/acts_as_publishable_spec.rb
+- spec/rspec_immediate_feedback_formatter.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 - Manifest
-- acts_as_publishable.gemspec
 has_rdoc: true
 homepage: http://github.com/rbgrouleff/acts_as_publishable
 licenses: []
@@ -75,6 +78,6 @@ rubyforge_project: acts_as_publishable
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Makes Active Record models publishable
+summary: Rails gem that adds functionality to make Active Record models publishable
 test_files: []