publishable 0.1.2 → 0.1.3

data/README.textile

@@ -0,0 +1,35 @@
+h1. Publishable
+
+<pre>
+  gem install publishable
+</pre>
+
+h2. Setup
+
+you need a datetime column in your table and call publishable in your class body
+
+<pre>
+  class Model < ActiveRecord::Base
+    publishable
+  
+    # OR
+  
+    publishable :made_public_on # if your column is not named published_at
+  end
+</pre>
+
+h2. Methods
+
+<pre>
+  album = Album.new
+
+  album.published?    # => false
+  album.publish!
+  album.published?    # => true
+
+  Album.published.all # => finds all published albums
+</pre>
+
+please see specs for details
+
+Copyright (c) 2009 Martin Linkhorst, released under the MIT license.

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/publishable.rb

@@ -10,22 +10,26 @@ module Publishable
 
       named_scope :published, lambda { |*args|
         if args.first.nil? || TRUE_VALUES.include?(args.first)
-          { :conditions => ["#{quoted_table_name}.#{publishable_column} IS NOT NULL AND #{quoted_table_name}.#{ActiveRecord::Base.connection.quote_column_name(publishable_column)} <= ?", Time.now.utc] }
+          { :conditions => ["#{quoted_table_name}.#{quoted_publishable_column_name} IS NOT NULL AND #{quoted_table_name}.#{quoted_publishable_column_name} <= ?", Time.now.utc] }
         else
-          { :conditions => ["#{quoted_table_name}.#{publishable_column} IS NULL OR #{quoted_table_name}.#{ActiveRecord::Base.connection.quote_column_name(publishable_column)} > ?", Time.now.utc] }
+          { :conditions => ["#{quoted_table_name}.#{quoted_publishable_column_name} IS NULL OR #{quoted_table_name}.#{quoted_publishable_column_name} > ?", Time.now.utc] }
         end
       }
 
       class_eval do
         class << self
-          attr_accessor :publishable_column
+          attr_accessor :publishable_column_name
 
           def unpublished
             published(false)
-          end          
+          end
+          
+          def quoted_publishable_column_name
+            ActiveRecord::Base.connection.quote_column_name(publishable_column_name)
+          end
         end
         
-        self.publishable_column = column
+        self.publishable_column_name = column
 
         def published?
           !!published
@@ -36,7 +40,7 @@ module Publishable
         end
 
         def published
-          send(self.class.publishable_column) && send(self.class.publishable_column) <= Time.now
+          send(self.class.publishable_column_name) && send(self.class.publishable_column_name) <= Time.now
         end
 
         def published=(boolean)
@@ -44,11 +48,11 @@ module Publishable
         end
         
         def publish(time = Time.now)
-          self.send("#{self.class.publishable_column}=", time.utc) unless published?
+          self.send("#{self.class.publishable_column_name}=", time.utc) unless published?
         end
         
         def unpublish
-          self.send("#{self.class.publishable_column}=", nil)
+          self.send("#{self.class.publishable_column_name}=", nil)
         end
       
         def publish!
@@ -60,7 +64,7 @@ module Publishable
 
         def unpublish!
           unpublish
-          update_attribute(self.class.publishable_column, published_at)
+          update_attribute(self.class.publishable_column_name, send(publishable_column_name))
         end
       end
     end

data/publishable.gemspec

@@ -5,21 +5,21 @@
 
 Gem::Specification.new do |s|
   s.name = %q{publishable}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Linkhorst"]
-  s.date = %q{2009-12-03}
+  s.date = %q{2009-12-11}
   s.description = %q{Provides methods to publish and unpublish your active record models based on a datetime. Also adds named scopes to nicely filter your records. Does not touch any controller or views.}
   s.email = %q{m.linkhorst@googlemail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README"
+     "README.textile"
   ]
   s.files = [
     ".gitignore",
      "LICENSE",
-     "README",
+     "README.textile",
      "Rakefile",
      "VERSION",
      "db/schema.rb",

data/spec/publishable_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), "/spec_helper")
+require File.join(File.dirname(__FILE__), "spec_helper")
 
 class Model < ActiveRecord::Base
   include Publishable
@@ -21,7 +21,7 @@ describe Publishable do
 
     it "should be published? when :published_at is now" do
       now = Time.now; Time.stubs(:now).returns(now)
-      @model.published_at = Time.now #stub me
+      @model.published_at = Time.now
       @model.should be_published
     end
     
@@ -37,8 +37,8 @@ describe Publishable do
       @model.should_not be_published
     end
     
-    it "should ask :publishable_column" do
-      Model.expects(:publishable_column).returns(:published_at)
+    it "should ask :publishable_column_name" do
+      Model.expects(:publishable_column_name).returns(:published_at)
       @model.published?
     end
   end
@@ -50,13 +50,13 @@ describe Publishable do
 
     it "should set :published_at to current time with no parameter" do
       now = Time.now; Time.expects(:now).returns(now)
-      @model.expects(:published_at=).with(now).returns(true)
+      @model.expects(:published_at=).with(now).returns(now)
       @model.publish
     end
     
     it "should set :published_at to given time if parameter present" do
       tomorrow = Time.now + 1.day
-      @model.expects(:published_at=).with(tomorrow).returns(true)
+      @model.expects(:published_at=).with(tomorrow).returns(tomorrow)
       @model.publish(tomorrow)      
     end
     
@@ -112,7 +112,7 @@ describe Publishable do
 
   describe "database column" do
     it "should default to :published_at" do
-      Model.publishable_column.should == :published_at
+      Model.publishable_column_name.should == :published_at
     end
     
     it "should be possible to change the column name" do
@@ -120,7 +120,7 @@ describe Publishable do
         include Publishable
         publishable :made_available_on
       end
-      Model2.publishable_column.should == :made_available_on
+      Model2.publishable_column_name.should == :made_available_on
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: publishable
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Martin Linkhorst
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-03 00:00:00 +10:00
+date: 2009-12-11 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -21,11 +21,11 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README
+- README.textile
 files: 
 - .gitignore
 - LICENSE
-- README
+- README.textile
 - Rakefile
 - VERSION
 - db/schema.rb