couch_scheduler 0.0.1 → 0.1.0

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/features/couch_publish_integration.feature

@@ -7,14 +7,14 @@ Feature: CouchPublish Integration
     Given an Article model that includes CouchPublish and CouchVisible
     When I create several published articles scheduled now and in the future
     And I create several unpublished articles scheduled now and in the future
-    When I call "Article.by_schedule_and_published"
+    When I call "Article.by_schedule :published => true"
     Then I should receive the published documents scheduled now
-    When I call "Article.by_schedule_and_unpublished"
+    When I call "Article.by_schedule :unpublished => true"
     Then I should receive the unpublished documents scheduled now
     When I wait till the future
-    And I call "Article.by_schedule_and_published"
+    And I call "Article.by_schedule :published => true"
     Then I should receive the published documents scheduled in the future
-    When I call "Article.by_schedule_and_unpublished"
+    When I call "Article.by_schedule :unpublished => true"
     Then I should receive the unpublished documents scheduled in the future
  
   @focus
@@ -24,12 +24,12 @@ Feature: CouchPublish Integration
     And I create 3 published articles schedule in the future
     And I create 4 unpublished articles scheduled now
     And I create 7 unpublished articles schedule in the future
-    When I call "Article.count_schedule_and_published"
+    When I call "Article.count_schedule :published => true"
     Then I should receive 2
-    When I call "Article.count_schedule_and_unpublished"
+    When I call "Article.count_schedule :unpublished => true"
     Then I should receive 4
     When I wait till the future
-    And I call "Article.count_schedule_and_published"
+    And I call "Article.count_schedule :published => true"
     Then I should receive 3
-    When I call "Article.count_schedule_and_unpublished"
+    When I call "Article.count_schedule :unpublished => true"
     Then I should receive 7   

data/features/couch_visible_and_couch_publish_integration.feature

@@ -6,30 +6,40 @@ Feature: CouchVisible and CouchPublish Integration
   Scenario: Query for shown, published documents within a schedule
     Given a Slide model that includes CouchVisible, CouchPublish and CouchScheduler
     When I create several shown, published slides scheduled now and in the future
+    And I create several shown, unpublished slides scheduled now and in the future
     And I create several hidden, published slides scheduled now and in the future
-    When I call "Slide.by_schedule_and_published_and_shown"
+    And I create several hidden, unpublished slides scheduled now and in the future
+    When I call "Slide.by_schedule :published => true, :shown => true"
     Then I should receive the shown, published documents scheduled now
-    When I call "Slide.by_schedule_and_published_and_hidden"
+    When I call "Slide.by_schedule :published => true, :hidden => true"
     Then I should receive the hidden, published documents scheduled now
     When I wait till the future
-    And I call "Slide.by_schedule_and_published_and_shown"
+    And I call "Slide.by_schedule :published => true, :shown => true"
     Then I should receive the shown, published documents scheduled in the future
-    When I call "Slide.by_schedule_and_published_and_hidden"
+    When I call "Slide.by_schedule :published =>true, :hidden => true"
     Then I should receive the hidden, published documents scheduled in the future
  
   @focus
   Scenario: Count of shown and hidden documents within a schedule
     Given a Slide model that includes CouchVisible, CouchPublish and CouchScheduler
     When I create 2 shown, published slides scheduled now
+    When I create 6 shown, unpublished slides scheduled now
     And I create 3 shown, published slides schedule in the future
+    And I create 9 shown, unpublished slides schedule in the future
     And I create 4 hidden, published slides scheduled now
+    And I create 12 hidden, unpublished slides scheduled now
     And I create 7 hidden, published slides schedule in the future
-    When I call "Slide.count_schedule_and_published_and_shown"
+    And I create 21 hidden, unpublished slides schedule in the future
+    When I call "Slide.count_schedule :published => true, :shown => true"
     Then I should receive 2
-    When I call "Slide.count_schedule_and_published_and_hidden"
+    When I call "Slide.count_schedule :published => true"
+    Then I should receive 6
+    When I call "Slide.count_schedule"
+    Then I should receive 24
+    When I call "Slide.count_schedule :published =>true, :hidden => true"
     Then I should receive 4
     When I wait till the future
-    And I call "Slide.count_schedule_and_published_and_shown"
+    And I call "Slide.count_schedule :published => true, :shown => true"
     Then I should receive 3
-    When I call "Slide.count_schedule_and_published_and_hidden"
+    When I call "Slide.count_schedule :published =>true, :hidden => true"
     Then I should receive 7

data/features/couch_visible_integration.feature

@@ -7,14 +7,14 @@ Feature: CouchVisible Integration
     Given an Post model that includes CouchVisible and CouchScheduler
     When I create several shown posts scheduled now and in the future
     And I create several hidden posts scheduled now and in the future
-    When I call "Post.by_schedule_and_shown"
+    When I call "Post.by_schedule :shown => true"
     Then I should receive the shown documents scheduled now
-    When I call "Post.by_schedule_and_hidden"
+    When I call "Post.by_schedule :hidden => true"
     Then I should receive the hidden documents scheduled now
     When I wait till the future
-    And I call "Post.by_schedule_and_shown"
+    And I call "Post.by_schedule :shown => true"
     Then I should receive the shown documents scheduled in the future
-    When I call "Post.by_schedule_and_hidden"
+    When I call "Post.by_schedule :hidden => true"
     Then I should receive the hidden documents scheduled in the future
   
   @focus 
@@ -24,12 +24,12 @@ Feature: CouchVisible Integration
     And I create 3 shown posts schedule in the future
     And I create 4 hidden posts scheduled now
     And I create 7 hidden posts schedule in the future
-    When I call "Post.count_schedule_and_shown"
+    When I call "Post.count_schedule :shown => true"
     Then I should receive 2
-    When I call "Post.count_schedule_and_hidden"
+    When I call "Post.count_schedule :hidden => true"
     Then I should receive 4
     When I wait till the future
-    And I call "Post.count_schedule_and_shown"
+    And I call "Post.count_schedule :shown => true"
     Then I should receive 3
-    When I call "Post.count_schedule_and_hidden"
+    When I call "Post.count_schedule :hidden => true"
     Then I should receive 7   

data/features/step_definitions/couch_visible_and_couch_publish_integration.rb

@@ -16,6 +16,15 @@ When /^I create several shown, published slides scheduled now and in the future$
   5.times { @published_shown_future << Slide.create(:start => 1.day.from_now, :end => 2.days.from_now).tap {|a| a.show!; a.publish! } }
 end
 
+When /^I create several shown, unpublished slides scheduled now and in the future$/ do
+  @unpublished_shown_now = []
+  @unpublished_shown_future = []
+
+  5.times { @unpublished_shown_now << Slide.create(:start => Time.now, :end => 1.day.from_now).tap {|a| a.show!} }
+  5.times { @unpublished_shown_future << Slide.create(:start => 1.day.from_now, :end => 2.days.from_now).tap {|a| a.show!} }
+end
+
+
 When /^I create several hidden, published slides scheduled now and in the future$/ do
   @published_hidden_now = []
   @published_hidden_future = []
@@ -24,6 +33,14 @@ When /^I create several hidden, published slides scheduled now and in the future
   5.times { @published_hidden_future << Slide.create(:start => 1.day.from_now, :end => 2.days.from_now).tap {|a| a.hide!; a.publish! } }
 end
 
+When /^I create several hidden, unpublished slides scheduled now and in the future$/ do
+  @unpublished_hidden_now = []
+  @unpublished_hidden_future = []
+
+  5.times { @unpublished_hidden_now    << Slide.create(:start => Time.now, :end => 1.day.from_now).tap {|a| a.hide! } }
+  5.times { @unpublished_hidden_future << Slide.create(:start => 1.day.from_now, :end => 2.days.from_now).tap {|a| a.hide! } }
+end
+
 Then /^I should receive the shown, published documents scheduled now$/ do
   @result.collect(&:id).sort.should == @published_shown_now.collect(&:id).sort
 end
@@ -59,3 +76,23 @@ When /^I create (\d+) hidden, published slides schedule in the future$/ do |num|
   @published_hidden_future = []
   num.to_i.times { @published_hidden_future << Slide.create(:start => 1.day.from_now, :end => 2.days.from_now).tap {|a| a.hide!; a.publish!}}
 end
+
+When /^I create (\d+) shown, unpublished slides scheduled now$/ do |num|
+  @unpublished_shown_future = []
+  num.to_i.times { @unpublished_shown_future << Slide.create(:start => Time.now, :end => 1.day.from_now).tap {|a| a.show!}}
+end
+
+When /^I create (\d+) shown, unpublished slides schedule in the future$/ do |num|
+  @unpublished_shown_future = []
+  num.to_i.times { @unpublished_shown_future << Slide.create(:start => 1.day.from_now, :end => 2.days.from_now).tap {|a| a.show!}}
+end
+
+When /^I create (\d+) hidden, unpublished slides scheduled now$/ do |num|
+  @unpublished_hidden_now = []
+  num.to_i.times { @unpublished_hidden_now << Slide.create(:start => Time.now, :end => 1.day.from_now).tap {|a| a.hide!}}
+end
+
+When /^I create (\d+) hidden, unpublished slides schedule in the future$/ do |num|
+  @unpublished_hidden_future = []
+  num.to_i.times { @unpublished_hidden_future << Slide.create(:start => 1.day.from_now, :end => 2.days.from_now).tap {|a| a.hide!}}
+end

data/lib/couch_scheduler.rb

@@ -1,5 +1,5 @@
 require 'couchrest_model'
-require 'couch_scheduler/time_massager'
+require 'couch_scheduler/options'
 require 'couch_scheduler/map'
 require 'couch_scheduler/couch_visible_integration'
 require 'couch_scheduler/couch_publish_integration'

data/lib/couch_scheduler/couch_publish_and_couch_visible_integration.rb

@@ -2,25 +2,24 @@ module CouchScheduler
   module CouchVisibleCouchPublishIntegration
     def self.included(base)
       base.extend ClassMethods
-      base.view_by :couch_schedule_and_published_and_shown, :map => Map.new(base, :published, :shown).to_s, :reduce => '_count'
+      base.view_by :couch_schedule_and_published_and_shown,  :map => Map.new(base, :published, :shown).to_s,  :reduce => '_count'
       base.view_by :couch_schedule_and_published_and_hidden, :map => Map.new(base, :published, :hidden).to_s, :reduce => '_count'
     end
 
     module ClassMethods
-      def by_schedule_and_published_and_shown(options={})
-        by_couch_schedule_and_shown CouchScheduler::TimeMassager.massage(options)
-      end
-
-      def by_schedule_and_published_and_hidden(options={})
-        by_couch_schedule_and_hidden CouchScheduler::TimeMassager.massage(options)
-      end
-
-      def count_schedule_and_published_and_shown(options={})
-        count_by_map :by_schedule_and_published_and_shown, options
-      end
+      def by_schedule(options={})
+        shown       = options[:shown]
+        hidden      = options[:hidden]
+        published   = options[:published]
+        unpublished = options[:unpublished]
 
-      def count_schedule_and_published_and_hidden(options={})
-        count_by_map :by_schedule_and_published_and_hidden, options
+        if shown == true && published == true
+          by_couch_schedule_and_published_and_shown CouchScheduler::Options.new(options).to_hash
+        elsif hidden == true && published == true
+          by_couch_schedule_and_published_and_hidden CouchScheduler::Options.new(options).to_hash
+        else
+          super
+        end
       end
     end
   end

data/lib/couch_scheduler/couch_publish_integration.rb

@@ -3,24 +3,21 @@ module CouchScheduler
     def self.included(base)
       base.extend ClassMethods
       base.view_by :couch_schedule_and_unpublished, :map => Map.new(base, :unpublished).to_s, :reduce => '_count'
-      base.view_by :couch_schedule_and_published, :map => Map.new(base, :published).to_s, :reduce => '_count'
+      base.view_by :couch_schedule_and_published,   :map => Map.new(base, :published).to_s,   :reduce => '_count'
     end
 
     module ClassMethods
-      def by_schedule_and_published(options={})
-        by_couch_schedule_and_published CouchScheduler::TimeMassager.massage(options)
-      end
-
-      def by_schedule_and_unpublished(options={})
-        by_couch_schedule_and_unpublished CouchScheduler::TimeMassager.massage(options)
-      end
-
-      def count_schedule_and_published(options={})
-        count_by_map :by_schedule_and_published, options
-      end
+      def by_schedule(options={})
+        published   = options[:published]
+        unpublished = options[:unpublished]
 
-      def count_schedule_and_unpublished(options={})
-        count_by_map :by_schedule_and_unpublished, options
+        if published == true || unpublished == false
+          by_couch_schedule_and_published CouchScheduler::Options.new(options).to_hash
+        elsif unpublished == true || published == false
+          by_couch_schedule_and_unpublished CouchScheduler::Options.new(options).to_hash
+        else
+          super
+        end
       end
     end
   end

data/lib/couch_scheduler/couch_scheduler.rb

@@ -21,7 +21,7 @@ module CouchScheduler
 
   module ClassMethods
     def by_schedule(options={})
-      by_couch_schedule CouchScheduler::TimeMassager.massage(options)
+      by_couch_schedule CouchScheduler::Options.new(options).to_hash
     end
 
     def count_schedule(options={})

data/lib/couch_scheduler/couch_visible_integration.rb

@@ -7,20 +7,17 @@ module CouchScheduler
     end
 
     module ClassMethods
-      def by_schedule_and_shown(options={})
-        by_couch_schedule_and_shown CouchScheduler::TimeMassager.massage(options)
-      end
-
-      def by_schedule_and_hidden(options={})
-        by_couch_schedule_and_hidden CouchScheduler::TimeMassager.massage(options)
-      end
-
-      def count_schedule_and_shown(options={})
-        count_by_map :by_schedule_and_shown, options
-      end
+      def by_schedule(options={})
+        shown = options.delete :shown
+        hidden = options.delete :hidden
 
-      def count_schedule_and_hidden(options={})
-        count_by_map :by_schedule_and_hidden, options
+        if shown == true || hidden == false
+          by_couch_schedule_and_shown CouchScheduler::Options.new(options).to_hash
+        elsif hidden == true || shown == false
+          by_couch_schedule_and_hidden CouchScheduler::Options.new(options).to_hash
+        else
+          super
+        end
       end
     end
   end

data/lib/couch_scheduler/{time_massager.rb → options.rb}

@@ -1,7 +1,14 @@
 module CouchScheduler
-  module TimeMassager
-    extend self
+  class Options
+    def initialize(options)
+      @options = massage options.dup
+    end
 
+    def to_hash
+      @options
+    end
+    
+    private
     def massage(options)
       if !options[:startkey] && !options[:key]
         options = {:key => format_time(Time.now), :reduce => false}.merge options
@@ -11,10 +18,14 @@ module CouchScheduler
         options[option] = format_time options[option] if options[option].kind_of?(Time)
       end
 
+      options.delete :shown
+      options.delete :hidden
+      options.delete :published
+      options.delete :unpublished
+
       options
     end
 
-    private
     def format_time(t)
       [t.year, t.month - 1, t.day, 0, 0, 0]
     end

data/readme.markdown

@@ -25,6 +25,7 @@ You can now provide start and end dates for your articles:
     @article.end   = 6.days.from_now
     @article.save
 
+
 ## Validation
 
 `CouchSchedule` will use `ActiveModel` validation to ensure that your `end` is after your `start`:
@@ -34,6 +35,7 @@ You can now provide start and end dates for your articles:
     @article.save #==> false
     @artile.errors #==> [:end, " must be greater than start"]
 
+
 ## Uses?
 
 Now what can you do with these start and end dates? One use: publishing. 
@@ -46,6 +48,8 @@ Let's imagine that you only to display this article on your website between the
 
     @article.within_schedule? #==> false
 
+### Query (.by_schedule)
+
 You can also query the databases for all of the articles currently within their schedule via `by_schedule`:
 
     Article.by_schedule
@@ -68,54 +72,52 @@ Like `by_schedule`, `count_schedule` supports all the usual map/reduce options:
     Article.count_schedule :key => 10.days.from_now
       #==> the count of all articles that are within their start/end dates 10 days from now
 
+
 ## CouchPublish Integration
 
-If you include `CouchScheduler` into a model that already includes `CouchPublish`, then you get a new map function for free, `by_schedule_and_published`:
+If you include `CouchScheduler` into a model that already includes `CouchPublish`, then you can pass `:publish => true` and `:unpublish => true`:
     
     # with a class definition like this:
     class Article < CouchRest::Model::Base
       include CouchPublish
       include CouchScheduler
+
       property :title
     end
 
     # you can query for all published and currently scheduled documents like this:
-    Article.by_schedule_and_published
+    Article.by_schedule :published => true
       #==> returns all documents that are published and currently within their schedule
     
     # you can also query for the unpublished and currently scheduled documents like this:
-    Article.by_schedule_and_unpublished
+    Article.by_schedule :unpublished => true
+
+You can also pass `:published => true` and `:unpublished => true` to the `count_schedule` method.
 
-You'll also get `count_schedule_and_published` and `count_schedule_and_unpublished` for free.
 
 ## CouchVisible Integration
 
 If you include `CouchScheduler` into a model that includes `CouchVisible`, you'll get the following map/reduce functions for free:
 
-    Article.by_schedule_and_shown
+    Article.by_schedule :shown => true
       #==> all articles that are currently within their start and end dates and are shown
 
-    Article.by_schedule_and_hidden
+    Article.by_schedule :hidden => true
       #==> all articles that are currently within their start and end dates and are hidden
 
-    Article.count_schedule_and_shown
-    Article.count_schedule_and_hidden
-
-## CouchPublish/CouchVisible integration
+    Article.count_schedule :shown  => true
+    Article.count_schedule :hidden => true
 
-If you include `CouchScheduler` into a model that includes both `CouchVisible` and `CouchPublish`, you'll get the following map/reduce functions for free:
 
-    Article.by_schedule_and_published_and_shown
-    Article.by_schedule_and_published_and_hidden
-    Article.by_schedule_and_unpublished_and_shown
-    Article.by_schedule_and_unpublished_and_hidden
+## CouchPublish/CouchVisible integration
 
-And of course, all the corresponding `count` methods are available:
+If you include `CouchScheduler` into a model that includes both `CouchVisible` and `CouchPublish`, you can pass `:published => true`, `:unpublished => true`, `:shown => true`, `:hidden => true` to your schedule query methods:
 
-    Article.count_schedule_and_published_and_shown
-    Article.count_schedule_and_published_and_hidden
-    Article.count_schedule_and_unpublished_and_shown
-    Article.count_schedule_and_unpublished_and_hidden
+    Article.by_schedule    :published   => true, :shown  => true
+    Article.by_schedule    :unpublished => true, :hidden => true
+    Article.count_schedule :published   => true, :shown  => true
+    Article.count_schedule :unpublished => true, :hidden => true 
+ 
 
 ## LICENSE
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: couch_scheduler
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Matt Parker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-20 00:00:00 Z
+date: 2011-07-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: cucumber
@@ -133,7 +133,7 @@ files:
 - lib/couch_scheduler/couch_scheduler.rb
 - lib/couch_scheduler/couch_visible_integration.rb
 - lib/couch_scheduler/map.rb
-- lib/couch_scheduler/time_massager.rb
+- lib/couch_scheduler/options.rb
 - lib/couch_scheduler.rb
 - VERSION
 - readme.markdown