publishing_logic 0.0.0 → 0.1.0

data/.gitignore

@@ -20,3 +20,4 @@ pkg
 
 ## PROJECT::SPECIFIC
 publishing_logic.gemspec
+.specification

data/.specification.example

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: publishing_logic
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Unboxed Consulting
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-09 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Publishing logic for ActiveRecord models
+email: enquiries@unboxedconsulting.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- features/publishing_logic.feature
+- features/step_definitions/publishing_logic_steps.rb
+- features/support/env.rb
+- lib/model_logic.rb
+- lib/publishing_logic.rb
+- rails_generators/publishing_logic_fields/publishing_logic_fields_generator.rb
+- spec/lib/model_logic_spec.rb
+- spec/publishing_logic_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/tomtt/publishing_logic
+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: Publishing logic for ActiveRecord models
+test_files: 
+- spec/lib/model_logic_spec.rb
+- spec/publishing_logic_spec.rb
+- spec/spec_helper.rb

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/lib/model_logic.rb

@@ -1,7 +1,41 @@
 module PublishingLogic
   module ModelLogic
+    PUBLISHED_CONDITIONS = <<EOT
+publishing_enabled = true AND
+(published_until is null or published_until > ?) AND
+(published_at is null or published_at < ?)
+EOT
+
     def published?
-      true
+      return false if published_at && Time.now < published_at
+      return false if published_until && Time.now > published_until
+      publishing_enabled?
     end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.instance_eval do
+        named_scope :published, lambda {{ :conditions => [PUBLISHED_CONDITIONS, Time.now.utc, Time.now.utc] }} do
+          def newest
+            find(:first, :order => "published_at DESC")
+          end
+
+          def oldest
+            find(:last, :order => "published_at DESC")
+          end
+        end
+
+        # If objects have identical published_at values, order by created_at. If these are
+        # identical as well, then order by id. This is done to ensure there is a unique
+        # ordering of objects, ordering by newest and oldest should result in arrays that are
+        # the inverse of the other.
+        named_scope :by_date_oldest_first, :order => 'published_at ASC, created_at ASC, id ASC'
+        named_scope :by_date_newest_first, :order => 'published_at DESC, created_at DESC, id DESC'
+      end
+    end
+
+    module ClassMethods
+    end
+
   end
 end

data/rails_generators/publishing_logic_fields/USAGE

@@ -0,0 +1,2 @@
+Real usage: ./script/generate publishing_logic_fields model_name [options]
+Note: The generator will fail if the model does not  exist

data/rails_generators/publishing_logic_fields/publishing_logic_fields_generator.rb

@@ -1,13 +1,14 @@
-class PublishingLogicGenerator < Rails::Generator::NamedBase
+class PublishingLogicFieldsGenerator < Rails::Generator::NamedBase
   def initialize(args, options)
     super(args, options)
   end
 
   def manifest
     record do |m|
-      m.migration_template 'publishing_logic_fields.rb', 'db/migrate', :assigns => {
+      class_name.camelize.constantize # Raise an error if model does not yet exist
+      m.migration_template 'db/migrate/add_publishing_logic_fields.rb.erb', 'db/migrate', :assigns => {
         :migration_name => "AddPublishingLogicFieldsTo#{class_name.pluralize.gsub(/::/, '')}"
-      }, :migration_file_name => "add_publishing_logic_field_to_#{file_path.gsub(/\//, '_').pluralize}"
+      }, :migration_file_name => "add_publishing_logic_fields_to_#{file_path.gsub(/\//, '_').pluralize}"
     end
   end
 end

data/rails_generators/publishing_logic_fields/templates/db/migrate/add_publishing_logic_fields.rb.erb

@@ -0,0 +1,13 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    add_column :<%= class_name.underscore.camelize.tableize %>, :publishing_enabled, :boolean
+    add_column :<%= class_name.underscore.camelize.tableize %>, :published_at, :datetime
+    add_column :<%= class_name.underscore.camelize.tableize %>, :published_until, :datetime
+  end
+
+  def self.down
+    remove_column :<%= class_name.underscore.camelize.tableize %>, :publishing_enabled
+    remove_column :<%= class_name.underscore.camelize.tableize %>, :published_at
+    remove_column :<%= class_name.underscore.camelize.tableize %>, :published_until
+  end
+end

data/spec/lib/model_logic_spec.rb

@@ -9,8 +9,156 @@ Factory.define :fun_item do |c|
 end
 
 describe PublishingLogic::ModelLogic do
-  it "should be published by default" do
-    # Factory.create(:fun_item, :publishing_enabled => true).should be_published
-    Factory.create(:fun_item).should be_published
+  def create_objects_with_different_published_at_dates
+    @object2 = Factory.create(:fun_item, :publishing_enabled => true, :published_at => 2.days.ago)
+    @object1 = Factory.create(:fun_item, :publishing_enabled => true, :published_at => 1.days.ago)
+    @object3 = Factory.create(:fun_item, :publishing_enabled => true, :published_at => 3.days.ago)
+  end
+
+  describe "published?" do
+    describe "with publishing enabled" do
+      it "should be published by default" do
+        Factory.create(:fun_item,
+                       :publishing_enabled => true,
+                       :published_at => nil,
+                       :published_until => nil).should be_published
+      end
+
+      it "should not be published if the published_at datetime is in the future" do
+        Factory.create(:fun_item,
+                       :publishing_enabled => true,
+                       :published_at => 5.seconds.from_now,
+                       :published_until => nil).should_not be_published
+      end
+
+      it "should not be published if the published_until datetime is in the past" do
+        Factory.create(:fun_item,
+                       :publishing_enabled => true,
+                       :published_at => nil,
+                       :published_until => 5.seconds.ago).should_not be_published
+      end
+    end
+    describe "with publishing disabled" do
+      it "should not be published" do
+        Factory.create(:fun_item,
+                       :publishing_enabled => false,
+                       :published_at => 1.days.ago,
+                       :published_until => 10.days.from_now).should_not be_published
+      end
+    end
+  end
+
+  describe "published named scope" do
+    it "should include published objects" do
+      fun_item = Factory.create(:fun_item, :publishing_enabled => true)
+      FunItem.published.should == [fun_item]
+    end
+
+    it "should not include any unpublished objects" do
+      fun_item = Factory.create(:fun_item, :publishing_enabled => false)
+      FunItem.published.should be_empty
+    end
+
+    # it "should not expose a published episode published an hour ago" do
+    #   article = Factory.create(:episode, :is_hidden => false, :published_at => 1.hour.from_now, :published_until => nil)
+    #   Episode.published.should == []
+    # end
+
+    it "should not include objects with a published_until in the past" do
+      Factory.create(:fun_item,
+                     :publishing_enabled => true,
+                     :published_until => 5.seconds.ago)
+      FunItem.published.should be_empty
+    end
+
+    it "should not include objects with a published_at in the future" do
+      Factory.create(:fun_item,
+                     :publishing_enabled => true,
+                     :published_at => 5.seconds.from_now)
+      FunItem.published.should be_empty
+    end
+
+    it "should get a new Time.now for each invocation of the named scope" do
+      item = Factory.create(:fun_item,
+                            :publishing_enabled => true,
+                            :published_until => 10.days.from_now)
+      mock_now = mock('now', :utc => 20.days.from_now, :to_f => 0)
+      Time.stub(:now).and_return mock_now
+      FunItem.published.should be_empty
+    end
+
+    it "should use the utc of the current time" do
+      # Make sure utc is used, which is hard to test as a behaviour
+      mock_now = mock('now')
+      Time.stub(:now).and_return mock_now
+      mock_now.should_receive(:utc).twice
+      FunItem.published
+    end
+
+    describe "newest" do
+      before do
+        create_objects_with_different_published_at_dates
+      end
+
+      it "should be the most recently published object" do
+        FunItem.published.newest.should == @object1
+      end
+    end
+    describe "oldest" do
+      it "should be the object published the longest ago" do
+        FunItem.published.oldest.should == @object3
+      end
+    end
+  end
+
+  describe "ordering by published_at" do
+    describe "by date oldest first" do
+      it "should return the items, oldest first" do
+        create_objects_with_different_published_at_dates
+        FunItem.by_date_oldest_first.map(&:id).should == [@object3,
+                                                          @object2,
+                                                          @object1].map(&:id)
+      end
+
+      it "should order by created_at date if published_ats are equal" do
+        create_objects_with_different_published_at_dates
+        @object2b = Factory.create(:fun_item,
+                                   :publishing_enabled => true,
+                                   :published_at => @object2.published_at,
+                                   :created_at => 3.days.ago)
+        FunItem.by_date_oldest_first.map(&:id).should == [@object3,
+                                                          @object2b,
+                                                          @object2,
+                                                          @object1].map(&:id)
+      end
+    end
+
+    describe "by date newest first" do
+      it "should return the items, oldest first" do
+        create_objects_with_different_published_at_dates
+        FunItem.by_date_newest_first.map(&:id).should == [@object1,
+                                                          @object2,
+                                                          @object3].map(&:id)
+      end
+
+      it "should order by created_at date if published_ats are equal" do
+        create_objects_with_different_published_at_dates
+        @object2b = Factory.create(:fun_item,
+                                   :publishing_enabled => true,
+                                   :published_at => @object2.published_at,
+                                   :created_at => 3.days.from_now)
+        FunItem.by_date_newest_first.map(&:id).should == [@object1,
+                                                          @object2b,
+                                                          @object2,
+                                                          @object3].map(&:id)
+      end
+    end
+
+    it "should have a newest first ordering that is the reverse of the oldest first ordering for identical objects" do
+      creation_time = 2.days.ago
+      publish_time = 1.days.ago
+      5.times { Factory.create(:fun_item, :created_at => creation_time, :published_at => publish_time) }
+      FunItem.by_date_newest_first.map(&:id).should == FunItem.by_date_oldest_first.map(&:id).reverse
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: publishing_logic
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Unboxed Consulting
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-09 00:00:00 +00:00
+date: 2009-12-10 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,6 +44,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- .specification.example
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -53,7 +54,9 @@ files:
 - features/support/env.rb
 - lib/model_logic.rb
 - lib/publishing_logic.rb
+- rails_generators/publishing_logic_fields/USAGE
 - rails_generators/publishing_logic_fields/publishing_logic_fields_generator.rb
+- rails_generators/publishing_logic_fields/templates/db/migrate/add_publishing_logic_fields.rb.erb
 - spec/lib/model_logic_spec.rb
 - spec/publishing_logic_spec.rb
 - spec/spec.opts