acts_as_event_owner 1.0.0 → 1.1.0

data/README.textile

@@ -1,6 +1,6 @@
 h1. ActsAsEventOwner
 
-ActsAsEventOwner is an ActiveRecord extension that adds calendar event management to any ActiveRecord model. Models that declare themselves as @acts_as_event_owner@ gain two @has_many@ associations- one for the event specifications, and one for the event occurrences.  
+ActsAsEventOwner is an ActiveRecord extension that adds calendar event management to any ActiveRecord model. Models that declare themselves as @acts_as_event_owner@ gain two @has_many@ associations- one for the event specifications, and one for the event occurrences.
 
 ActsAsEventOwner supports recurring events, with roughly the same recurrence rule capabilities as Apple's iCal application. Under the hood, ActsAsEventOwner uses "ri_cal":http://github.com/rubyredrick/ri_cal to provide recurring event support.
 
@@ -8,7 +8,7 @@ h1. Installation
 
 h2. Rails 2.3.x
 
-ActsAsEventOwner is available both as a gem and as a plugin. 
+ActsAsEventOwner is available both as a gem and as a plugin.
 
 h3. Installing as a Rails 2.3.x plugin
 
@@ -53,7 +53,7 @@ Then do:
 
 <pre>
   bundle install
-~</pre>
+</pre>
 
 h3. Rails 3 post-installation steps
 
@@ -70,22 +70,25 @@ h1. Usage
   class User < ActiveRecord::Base
     acts_as_event_owner
   end
-  
+
   @user = User.create :name => 'Alvin Seville'
-  @user.event_specifications.create :description => 'acquire cheese balls', 
-    :start_at => Date.today.to_time.utc, 
+  @user.event_specifications.create :description => 'acquire cheese balls',
+    :start_at => Date.today.to_time.utc,
     :repeat => :daily,
     :generate => false
-  
+
   @user.events # => []
-  
+
   @user.events.generate :from => Date.today.to_time.utc, :to => Date.today.to_time.utc + 1.week
-  
+
   # override the description on a per-generate basis
-  @user.events.generate :from => Date.today.to_time.utc, :to => Date.today.to_time.utc + 1.week, 
+  @user.events.generate :from => Date.today.to_time.utc - 1.day, :to => Date.today.to_time.utc + 1.week,
     :attributes => { :description => 'acquire cheese balls, like, right away!' }
-  
-  @user.events # => (7 ActsAsEventOwner::EventOccurrence objects)
+
+  @user.events # => (8 ActsAsEventOwner::EventOccurrence objects)
+
+  @user.events.past # => (1 ActsAsEventOwner::EventOccurrence objects)
+  @user.events.upcoming #=> (7 ActsAsEventOwner::EventOccurrence objects)
 </pre>
 
 h2. Adding custom fields
@@ -103,92 +106,92 @@ ActsAsEventOwner supports recurrence rules roughly equivalent to those supported
 h3. One-time event
 
 <pre>
-  EventSpecification.create :description => 'pick up laundry', 
+  EventSpecification.create :description => 'pick up laundry',
     :start_at => Time.parse("4:00pm")
 </pre>
 
 h3. Every day
 
 <pre>
-  EventSpecification.create :description => 'eat breakfast', 
-    :start_at => Time.parse("7:30am"), 
+  EventSpecification.create :description => 'eat breakfast',
+    :start_at => Time.parse("7:30am"),
     :repeat => :daily
 </pre>
 
 h3. Every three days
 
 <pre>
-  EventSpecification.create :description => 'call mom', 
-    :start_at => Time.parse("10:30am"), 
-    :repeat => :daily, 
+  EventSpecification.create :description => 'call mom',
+    :start_at => Time.parse("10:30am"),
+    :repeat => :daily,
     :frequency => 3
 </pre>
 
 h3. On Monday, Wednesday, and Friday of each week
 
 <pre>
-  EventSpecification.create :description => 'go to the gym', 
-    :start_at => Time.parse("6:30am"), 
-    :repeat => :weekly, 
+  EventSpecification.create :description => 'go to the gym',
+    :start_at => Time.parse("6:30am"),
+    :repeat => :weekly,
     :on => [ :mo, :we, :fr ]
 </pre>
 
 h3. On Thursday, every other week
 
 <pre>
-  EventSpecification.create :description => 'clean the bathroom', 
-    :start_at => Time.parse("8:00pm"), 
-    :repeat => :weekly, 
+  EventSpecification.create :description => 'clean the bathroom',
+    :start_at => Time.parse("8:00pm"),
+    :repeat => :weekly,
     :frequency => 2, :on => [ :th ]
 </pre>
 
 h3. On the 10th and 25th of each month
 
 <pre>
-  EventSpecification.create :description => 'pick up paycheck', 
-    :start_at => Time.parse("9:30am"), 
-    :repeat => :monthly, 
+  EventSpecification.create :description => 'pick up paycheck',
+    :start_at => Time.parse("9:30am"),
+    :repeat => :monthly,
     :on => [ 10, 25 ]
 </pre>
 
 h3. On the last Saturday of each month
 
 <pre>
-  EventSpecification.create :description => 'run a marathon', 
-    :start_at => Time.parse("6:30am"), 
-    :repeat => :monthly, 
-    :on_the => :last, 
+  EventSpecification.create :description => 'run a marathon',
+    :start_at => Time.parse("6:30am"),
+    :repeat => :monthly,
+    :on_the => :last,
     :target => [ :sa ]
 </pre>
 
 h3. On the last weekday of each month
 
 <pre>
-  EventSpecification.create :description => 'wine tasting', 
-    :start_at => Time.parse("6:30pm"), 
-    :repeat => :monthly, 
-    :on_the => :last, 
+  EventSpecification.create :description => 'wine tasting',
+    :start_at => Time.parse("6:30pm"),
+    :repeat => :monthly,
+    :on_the => :last,
     :target => :wkday
 </pre>
 
 h3. Every April 15th
 
 <pre>
-  EventSpecification.create :description => 'pay taxes', 
-    :start_at => Time.parse("4/15/2010 5:00pm"), 
+  EventSpecification.create :description => 'pay taxes',
+    :start_at => Time.parse("4/15/2010 5:00pm"),
     :repeat => :yearly
 </pre>
 
 h3. On the second Thursday in May, every other year, until Dec 31, 2012
 
 <pre>
-  EventSpecification.create :description => 'freak out', 
-    :start_at => Time.now.utc, 
-    :repeat => :yearly, 
-    :frequency => 2, 
-    :on => [ 5 ], 
-    :on_the => :second, 
-    :target => [ :th ], 
+  EventSpecification.create :description => 'freak out',
+    :start_at => Time.now.utc,
+    :repeat => :yearly,
+    :frequency => 2,
+    :on => [ 5 ],
+    :on_the => :second,
+    :target => [ :th ],
     :until => Time.parse("12/31/2012")
 </pre>
 

data/acts_as_event_owner.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_event_owner}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Danny Burkes"]
-  s.date = %q{2010-10-17}
+  s.date = %q{2010-11-27}
   s.description = %q{Simple calendar events for any ActiveRecord model}
   s.email = %q{dburkes@netable.com}
   s.extra_rdoc_files = [

data/lib/acts_as_event_owner/core.rb

@@ -3,7 +3,7 @@ module ActsAsEventOwner
     def self.included(base)
       base.send :extend, ClassMethods
     end
-  
+
     module ClassMethods
       def acts_as_event_owner options = {}
         include InstanceMethods
@@ -15,18 +15,26 @@ module ActsAsEventOwner
               proxy_owner.event_specifications.find(:all, :conditions => "until IS NULL OR until >= '#{Time.now.utc.to_s(:db)}'").each {|spec| spec.generate_events(options)}
               self.reload
             end
-            
+
             def <<(obj)
               raise ActsAsEventOwner::Exception.new("Do not add events directly- add event specifications, then call events.generate")
             end
-            
+
             def build(attributes={})
               raise ActsAsEventOwner::Exception.new("Do not build events directly- build event specifications, then call events.generate")
             end
-            
+
             def create(attributes={})
               raise ActsAsEventOwner::Exception.new("Do not create events directly- build event specifications, then call events.generate")
             end
+
+            def upcoming
+              find(:all, :conditions => ["start_at >= ?", Time.now.utc])
+            end
+
+            def past
+              find(:all, :conditions => ["start_at < ?", Time.now.utc])
+            end
           end
         end
       end

data/lib/acts_as_event_owner/version.rb

@@ -1,3 +1,3 @@
 module ActsAsEventOwner
-  VERSION = "1.0.0" unless defined? ActsAsEventOwner::VERSION
+  VERSION = "1.1.0" unless defined? ActsAsEventOwner::VERSION
 end

data/spec/acts_as_event_owner/core_spec.rb

@@ -7,32 +7,32 @@ describe ActsAsEventOwner::Core do
     @now = Time.now.utc
     @bod = Date.today.to_time.utc
   end
-  
+
   it "adds associations to the host object" do
     lambda {
       @user.events
       @user.event_specifications
     }.should_not raise_error
   end
-  
+
   it "adds event specifications to the host object" do
     lambda {
       @user.event_specifications.create :description => 'walk the dog', :start_at => @now, :repeat => :daily, :frequency => 1
     }.should change(EventSpecification, :count).by(1)
-    
+
     specs = @user.reload.event_specifications
     specs.size.should == 1
   end
-  
+
   it "adds events to the host object" do
     @user.event_specifications.create :description => 'walk the dog', :start_at => @now, :repeat => :daily, :frequency => 1, :generate => false
     @user.event_specifications.create :description => 'go to the gym', :start_at => @now, :repeat => :daily, :frequency => 2, :generate => false
-    
+
     lambda {
       @user.events.generate :from => @bod, :to => @bod + 1.week
     }.should change(EventOccurrence, :count).by(11)
   end
-  
+
   it "injects events into the association immediately" do
     @user.event_specifications.create :description => 'walk the dog', :start_at => @now, :repeat => :daily, :frequency => 1, :generate => false
     @user.events.should be_empty
@@ -40,7 +40,7 @@ describe ActsAsEventOwner::Core do
     @user.events.should be_present
     @user.events.size.should == 7
   end
-  
+
   describe "events association" do
     before(:each) do
       @new_event = EventOccurrence.new
@@ -58,5 +58,20 @@ describe ActsAsEventOwner::Core do
     it "raises an exception if #create is called" do
       lambda { @user.events.create @new_event.attributes }.should raise_error(ActsAsEventOwner::Exception)
     end
+
+    describe "extensions" do
+      before(:each) do
+        @user.event_specifications.create :description => 'walk the dog', :start_at => @bod - 7.days, :repeat => :daily, :frequency => 1
+        @user.events.length.should == 30
+      end
+
+      it "provides an extension for upcoming events" do
+        @user.events.upcoming.length.should == 22
+      end
+
+      it "provides an extension for past events" do
+        @user.events.past.length.should == 8
+      end
+    end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Danny Burkes
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-17 00:00:00 -07:00
+date: 2010-11-27 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency