publishable 0.1.3 → 0.2.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -1,3 +1,22 @@
+## MAC OS
 .DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
 pkg
-db/test.sqlite3
+
+## PROJECT::SPECIFIC
+db/test.sqlite3

data/LICENSE

@@ -1,5 +1,5 @@
-Copyright (c) 2009 Martin Linkhorst
- 
+Copyright (c) 2010 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
@@ -7,14 +7,14 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -6,15 +6,11 @@ h1. Publishable
 
 h2. Setup
 
-you need a datetime column in your table and call publishable in your class body
+you need a datetime column called published_at in your table and call publishable in your class body
 
 <pre>
-  class Model < ActiveRecord::Base
+  class Album < ActiveRecord::Base
     publishable
-  
-    # OR
-  
-    publishable :made_public_on # if your column is not named published_at
   end
 </pre>
 
@@ -24,12 +20,10 @@ h2. Methods
   album = Album.new
 
   album.published?    # => false
-  album.publish!
+  album.publish!      # calls :save afterwards
   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.
+Copyright (c) 2010 Martin Linkhorst, released under the MIT license.

data/Rakefile

@@ -1,21 +1,46 @@
 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"]
+  Jeweler::Tasks.new do |gem|
+    gem.name = "publishable"
+    gem.summary = "Adds publishing functionality to your active record model"
+    gem.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."
+    gem.email = "m.linkhorst@googlemail.com"
+    gem.homepage = "http://github.com/linki/publishable"
+    gem.authors = ["Martin Linkhorst"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.files.include 'lib/**/*.rb'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install jeweler"
-end
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "publishable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.2.1

data/db/schema.rb

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

data/lib/publishable/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails/railtie'
+
+module Publishable
+  class Railtie < Rails::Railtie
+    initializer 'publishable.initialize' do |app|
+      ActiveRecord::Base.extend Publishable::ClassMethods
+    end
+  end
+end

data/lib/publishable.rb

@@ -1,72 +1,31 @@
+require 'publishable/railtie' if defined?(Rails)
+
 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}.#{quoted_publishable_column_name} IS NOT NULL AND #{quoted_table_name}.#{quoted_publishable_column_name} <= ?", Time.now.utc] }
-        else
-          { :conditions => ["#{quoted_table_name}.#{quoted_publishable_column_name} IS NULL OR #{quoted_table_name}.#{quoted_publishable_column_name} > ?", Time.now.utc] }
-        end
+    def publishable
+      scope :published, lambda { |time = Time.now|
+        where('published_at IS NOT NULL AND published_at <= ?', time.utc)
       }
 
-      class_eval do
-        class << self
-          attr_accessor :publishable_column_name
-
-          def unpublished
-            published(false)
-          end
-          
-          def quoted_publishable_column_name
-            ActiveRecord::Base.connection.quote_column_name(publishable_column_name)
-          end
-        end
-        
-        self.publishable_column_name = column
-
-        def published?
-          !!published
-        end
-        
-        def unpublished?
-          !published?
-        end
-
-        def published
-          send(self.class.publishable_column_name) && send(self.class.publishable_column_name) <= Time.now
-        end
-
-        def published=(boolean)
-          TRUE_VALUES.include?(boolean) ? publish : unpublish
-        end
-        
-        def publish(time = Time.now)
-          self.send("#{self.class.publishable_column_name}=", time.utc) unless published?
-        end
-        
-        def unpublish
-          self.send("#{self.class.publishable_column_name}=", nil)
-        end
+      scope :unpublished, lambda { |time = Time.now|
+        where('published_at IS NULL OR published_at > ?', time.utc)
+      }
       
-        def publish!
-          unless published?
-            publish
-            save(false)
-          end
-        end
+      include InstanceMethods
+    end
+  end
+  
+  module InstanceMethods
+    def published?(time = Time.now)
+      published_at ? published_at <= time : false
+    end
 
-        def unpublish!
-          unpublish
-          update_attribute(self.class.publishable_column_name, send(publishable_column_name))
-        end
-      end
+    def publish(time = Time.now)
+      self.published_at = time unless published?
+    end
+    
+    def publish!(time = Time.now)
+      publish(time) && save
     end
   end
 end

data/publishable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{publishable}
-  s.version = "0.1.3"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Linkhorst"]
-  s.date = %q{2009-12-11}
+  s.date = %q{2010-09-29}
   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 = [
@@ -17,15 +17,16 @@ Gem::Specification.new do |s|
      "README.textile"
   ]
   s.files = [
-    ".gitignore",
+    ".document",
+     ".gitignore",
      "LICENSE",
      "README.textile",
      "Rakefile",
      "VERSION",
      "db/schema.rb",
      "lib/publishable.rb",
+     "lib/publishable/railtie.rb",
      "publishable.gemspec",
-     "rails/init.rb",
      "spec/publishable_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
@@ -33,7 +34,7 @@ Gem::Specification.new do |s|
   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.rubygems_version = %q{1.3.7}
   s.summary = %q{Adds publishing functionality to your active record model}
   s.test_files = [
     "spec/publishable_spec.rb",
@@ -44,10 +45,13 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
     else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
     end
   else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
   end
 end
 

data/spec/publishable_spec.rb

@@ -1,126 +1,66 @@
-require File.join(File.dirname(__FILE__), "spec_helper")
+require File.expand_path('../spec_helper', __FILE__)
 
-class Model < ActiveRecord::Base
-  include Publishable
+class Album < ActiveRecord::Base
+  extend Publishable::ClassMethods
   publishable
 end
 
 describe Publishable do
-  ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => 'db/test.sqlite3'
+  ActiveRecord::Base.establish_connection :adapter  => 'sqlite3',
+                                          :database => File.expand_path('../../db/test.sqlite3', __FILE__)
   load('db/schema.rb')
   
   before do
-    Model.delete_all
-    @model = Model.new
+    Album.delete_all
+    @album = Album.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
-      @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 not be published" do
+    # nil or false
+    @album.published_at.should be_false
+    @album.should_not be_published
     
-    it "should ask :publishable_column_name" do
-      Model.expects(:publishable_column_name).returns(:published_at)
-      @model.published?
-    end
+    # in the future
+    @album.published_at = Time.now + 60
+    @album.should_not be_published
   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(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(tomorrow)
-      @model.publish(tomorrow)      
-    end
+  it "should be published" do
+    # now
+    @album.published_at = Time.now
+    @album.should be_published
     
-    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
+    # in the past
+    @album.published_at = Time.now - 60
+    @album.should be_published
   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
+  it "should be publishable" do
+    @album.should_not be_published
+    @album.publish
+    @album.should be_published
   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
+  it "should persist" do
+    @album.expects(:publish).returns(true)
+    @album.expects(:save)
+    @album.publish!
   end
-
-  describe "named scopes" do
+  
+  describe "scope" 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)          
+      @album_1 = Album.create!(:published_at => nil)
+      @album_2 = Album.create!(:published_at => Time.now.utc - 60)
+      @album_3 = Album.create!(:published_at => Time.now.utc)
+      @album_4 = Album.create!(:published_at => Time.now.utc + 60)
     end
-    
+  
     it "should find published records" do
-      Model.published.all.should        == [@model_2, @model_3]
-      Model.published(true).all.should  == [@model_2, @model_3]
+      Album.published.should == [@album_2, @album_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_name.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_name.should == :made_available_on
+      Album.unpublished.should == [@album_1, @album_4]
     end
   end
 end

data/spec/spec.opts

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

data/spec/spec_helper.rb

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

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: publishable
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Martin Linkhorst
@@ -9,10 +14,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-11 00:00:00 +10:00
+date: 2010-09-29 00:00:00 +02:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
 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: []
@@ -23,6 +42,7 @@ extra_rdoc_files:
 - LICENSE
 - README.textile
 files: 
+- .document
 - .gitignore
 - LICENSE
 - README.textile
@@ -30,8 +50,8 @@ files:
 - VERSION
 - db/schema.rb
 - lib/publishable.rb
+- lib/publishable/railtie.rb
 - publishable.gemspec
-- rails/init.rb
 - spec/publishable_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -45,21 +65,25 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Adds publishing functionality to your active record model

data/rails/init.rb

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