publishable 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+pkg
+db/test.sqlite3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Martin Linkhorst
+ 
+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,21 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new(:spec)
+task :default => :spec
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "publishable"
+    gemspec.summary = "Adds publishing functionality to your active record model"
+    gemspec.description = "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."
+    gemspec.email = "m.linkhorst@googlemail.com"
+    gemspec.homepage = "http://github.com/linki/publishable"
+    gemspec.authors = ["Martin Linkhorst"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/db/schema.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :models, :force => true do |t|
+    t.datetime :published_at
+  end
+end

data/lib/publishable.rb

@@ -0,0 +1,68 @@
+module Publishable
+  TRUE_VALUES = ["true", true, "1", 1] unless const_defined?(:TRUE_VALUES)
+  
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    def publishable(column = :published_at, options = {})
+
+      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}.'#{publishable_column}' <= ?", Time.now.utc] }
+        else
+          { :conditions => ["#{quoted_table_name}.'#{publishable_column}' IS NULL OR #{quoted_table_name}.'#{publishable_column}' > ?", Time.now.utc] }
+        end
+      }
+
+      class_eval do
+        class << self
+          attr_accessor :publishable_column
+
+          def unpublished
+            published(false)
+          end          
+        end
+        
+        self.publishable_column = column
+
+        def published?
+          !!published
+        end
+        
+        def unpublished?
+          !published?
+        end
+
+        def published
+          send(self.class.publishable_column) && send(self.class.publishable_column) <= Time.now
+        end
+
+        def published=(boolean)
+          TRUE_VALUES.include?(boolean) ? publish : unpublish
+        end
+        
+        def publish(time = Time.now)
+          self.send("#{self.class.publishable_column}=", time.utc) unless published?
+        end
+        
+        def unpublish
+          self.send("#{self.class.publishable_column}=", nil)
+        end
+      
+        def publish!
+          unless published?
+            publish
+            save(false)
+          end
+        end
+
+        def unpublish!
+          unpublish
+          update_attribute(self.class.publishable_column, published_at)
+        end
+      end
+    end
+  end
+end

data/publishable.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{publishable}
+  s.version = "0.1.0"
+
+  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.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"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "db/schema.rb",
+     "lib/publishable.rb",
+     "publishable.gemspec",
+     "rails/init.rb",
+     "spec/publishable_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/linki/publishable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Adds publishing functionality to your active record model}
+  s.test_files = [
+    "spec/publishable_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/rails/init.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), "/../lib/publishable")
+ActiveRecord::Base.send :include, Publishable

data/spec/publishable_spec.rb

@@ -0,0 +1,126 @@
+require File.join(File.dirname(__FILE__), "/spec_helper")
+
+class Model < ActiveRecord::Base
+  include Publishable
+  publishable
+end
+
+describe Publishable do
+  ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => 'db/test.sqlite3'
+  load('db/schema.rb')
+  
+  before do
+    Model.delete_all
+    @model = Model.new
+  end
+  
+  describe "published?" do
+    it "should respond to published?" do
+      @model.should respond_to(:published?)
+    end
+
+    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.should be_published
+    end
+    
+    it "should be published? when :published_at is in the past" do
+      now = Time.now; Time.stubs(:now).returns(now)
+      @model.published_at = Time.now - 1.day
+      @model.should be_published
+    end
+    
+    it "should not be published when :published_at is in the future" do
+      now = Time.now; Time.stubs(:now).returns(now)
+      @model.published_at = Time.now + 1.day
+      @model.should_not be_published
+    end
+    
+    it "should ask :publishable_column" do
+      Model.expects(:publishable_column).returns(:published_at)
+      @model.published?
+    end
+  end
+  
+  describe "publish" do
+    it "should respond to publish" do
+      @model.should respond_to(:publish)
+    end
+
+    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.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.publish(tomorrow)      
+    end
+    
+    it "should not set :published_at again if already published?" do
+      @model.expects(:published?).once.returns(true)
+      @model.stubs(:published_at=).never
+      @model.publish
+    end
+  end
+  
+  describe "publish!" do
+    it "should respond to publish!" do
+      @model.should respond_to(:publish!)
+    end
+    
+    it "should publish and save" do
+      @model.expects(:publish).returns(true)
+      @model.expects(:save).with(false).returns(true)
+      @model.publish!
+    end
+  end
+  
+  describe "unpublished?" do
+    it "should be unpublished? when not published?" do
+      @model.expects(:published?).returns(false)
+      @model.should be_unpublished
+    end
+    
+    it "should not be unpublished? when published?" do
+      @model.expects(:published?).returns(true)
+      @model.should_not be_unpublished
+    end
+  end
+
+  describe "named scopes" do
+    before do
+      @model_1 = Model.create!(:published_at => nil)
+      @model_2 = Model.create!(:published_at => Time.now.utc - 1.day)
+      @model_3 = Model.create!(:published_at => Time.now.utc)
+      @model_4 = Model.create!(:published_at => Time.now.utc + 1.day)          
+    end
+    
+    it "should find published records" do
+      Model.published.all.should        == [@model_2, @model_3]
+      Model.published(true).all.should  == [@model_2, @model_3]
+    end
+    
+    it "should find unpublished records" do
+      Model.unpublished.all.should      == [@model_1, @model_4]
+      Model.published(false).all.should == [@model_1, @model_4]
+    end
+  end
+
+  describe "database column" do
+    it "should default to :published_at" do
+      Model.publishable_column.should == :published_at
+    end
+    
+    it "should be possible to change the column name" do
+      class Model2 < ActiveRecord::Base
+        include Publishable
+        publishable :made_available_on
+      end
+      Model2.publishable_column.should == :made_available_on
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format nested
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$: << File.join(File.dirname(__FILE__), "/../lib")
+require 'rubygems'
+require 'spec'
+
+require 'active_record'
+require 'active_support'
+
+require 'publishable'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: publishable
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Martin Linkhorst
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-03 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: 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.
+email: m.linkhorst@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- .gitignore
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- db/schema.rb
+- lib/publishable.rb
+- publishable.gemspec
+- rails/init.rb
+- spec/publishable_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/linki/publishable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Adds publishing functionality to your active record model
+test_files: 
+- spec/publishable_spec.rb
+- spec/spec_helper.rb