hiccup 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b30ca9bc9c9e2acf7107c08c0dd88ed0a869585c
-  data.tar.gz: 68dd036beda7f04cb915eae77a5fe0033b2454f3
+  metadata.gz: 76c7bd6b71cf03ea4f9897a640bb377c9b99fbcd
+  data.tar.gz: 5d8d072d237f71ce14cc1e31da9ba3bb6917a854
 SHA512:
-  metadata.gz: 66f8701394c598462e4178ccc5a10c915591c2206060a37c1724832a66c15712ea07652717e8f7d0bfdf8aa05c854507932b4b04907c219f5da62b8a58d8437f
-  data.tar.gz: c644a16b5d0c552c04ed193229236764d160f075f6679383f129812057da61ebb7d936976f0dffe70f0944f31a1e96e05dcbd2025f96a623c5ddeb6a22f04522
+  metadata.gz: 89735aa481b1b83673566f0aebc0454c8a391a0f385db052d6ca727ce731247b897318ff1df39ad0d6b6d9e98f0c7953bfe1076a8ded0aa54c459556dba099b5
+  data.tar.gz: 5867b146eaecda8e888c3399cf7f46e63d163e5acfe09f63696d6856ef775cf3690e4da4f77f92dbbe75ade0a2e102e1aaac9968a2df0f5541ef2045fb89cd5c

data/.travis.yml

@@ -0,0 +1,6 @@
+# .travis.yml
+language: ruby
+rvm:
+  - 2.0.0
+script:
+  - bundle exec rake test

data/README.mdown

@@ -1,8 +1,11 @@
 # Hiccup
 
-Hiccup mixes a-la-cart recurrence features into your recurring model. It doesn't dictate the data structure of your model, just the interface. It works just like Devise does for authenticatable models.
+[![Build Status](https://travis-ci.org/boblail/hiccup.png?branch=master)](https://travis-ci.org/boblail/hiccup)
+[![Code Climate](https://codeclimate.com/github/boblail/hiccup.png)](https://codeclimate.com/github/boblail/hiccup)
 
-Hiccup does provide an extremely lightweight `Schedule` class that mixes in all of Hiccup's feature, but you don't have to use Hiccup's Schedul if you don't want to.
+Hiccup mixes a-la-cart recurrence features into your recurring model. It doesn't dictate the data structure of your model, just the interface. It works like Devise does for authenticatable models.
+
+Hiccup does provide a lightweight `Schedule` class that mixes in all of Hiccup's feature, but you don't have to use Hiccup's Schedule if you don't want to.
 
 ### Usage
 
@@ -52,14 +55,57 @@ Schedule.new(:kind => :monthly, :monthly_pattern => [[2, "Sunday"], [4, "Sunday"
 
 Supplies methods for creating instances of a recurring pattern
 
+Examples
+
+```ruby
+schedule = Schedule.new(
+  :kind => :weekly,
+  :weekly_pattern => %w{Monday Wednesday Friday},
+  :start_date => Date.new(2009, 3, 15))
+
+# includes?
+schedule.includes? Date.new(2009, 5, 20) # => true
+schedule.includes? Date.new(2009, 3, 15) # => false (3/15/09 is a Sunday)
+
+# occurrences_between
+schedule.occurrences_between(
+  Date.new(2009, 3, 26),
+  Date.new(2009, 3, 31)) #=> [Fri, 27 Mar 2009, Mon, 30 Mar 2009]
+
+# n_occurrences_before
+schedule.n_occurrences_before(3, Date.new(2009, 3, 31)) # => [Mon, 30 Mar 2009, Fri, 27 Mar 2009, Wed, 25 Mar 2009]
+```
+
+
+
 ### Validatable
 
 Mixes in ActiveModel validations for recurrence models
 
+
+
 ### Humanizable
 
 Represents a recurring pattern in a human-readable string
 
+Examples:
+
+```ruby
+# A monthly recurrence
+schedule = Schedule.new(:kind => :monthly, :monthly_pattern => [[-1, "Tuesday"]])
+schedule.humanize # => "The last Tuesday of every month"
+
+# With skips
+schedule = Schedule.new(:kind => :weekly, :weekly_pattern => %w[Sunday], :skip => 2)
+schedule.humanize # => "Every other Sunday"
+
+# An anniversary
+schedule = Schedule.new(:kind => :annually, start_date: Date.new(2012, 10, 1))
+schedule.humanize # => "Every year on October 1"
+```
+
+
+
 ### Inferable
 
 Infers a schedule from an array of dates
@@ -77,6 +123,31 @@ schedule = Schedule.infer %w{2012-3-6 2012-3-8 2012-3-15 2012-3-20 2012-3-27 201
 schedule.humanize # => "Every Tuesday and Thursday"
 ```
 
+
+
 ### Serializable
 
 Supports serializing and deserializing a recurrence pattern to an array of formats
+
+Examples:
+
+```ruby
+schedule = Schedule.from_ical <<-ICAL
+DTSTART;VALUE=DATE-TIME:20090101T000000Z
+RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=TU,TH
+ICAL
+schedule.humanize # => "Tuesday and Thursday of every other week"
+
+schedule = Schedule.new(
+  :kind => :weekly,
+  :weekly_pattern => %w{Tuesday Thursday},
+  :start_date => DateTime.new(2009, 1, 1),
+  :skip => 2)
+schedule.to_ical # => "DTSTART;VALUE=DATE-TIME:20090101T000000Z\nRRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=TU,TH\n"
+```
+
+
+
+## License
+
+Copyright (c) 2012 Bob Lail, released under the MIT license

data/hiccup.gemspec

@@ -13,11 +13,11 @@ Gem::Specification.new do |s|
   
   s.rubyforge_project = "hiccup"
   
-  s.add_dependency "activesupport", "~> 3.2.8"
+  s.add_dependency "activesupport", ">= 3.2.8"
   s.add_dependency "builder"
   
   s.add_development_dependency "ri_cal"
-  s.add_development_dependency "rails", "~> 3.2.8"
+  s.add_development_dependency "rails", ">= 3.2.8"
   s.add_development_dependency "turn"
   s.add_development_dependency "simplecov"
   s.add_development_dependency "shoulda-context"

data/lib/hiccup/enumerable.rb

@@ -53,6 +53,8 @@ module Hiccup
       date == first_occurrence_on_or_after(date)
     end
     alias :contains? :occurs_on
+    alias :includes? :occurs_on
+    alias :member? :occurs_on
     alias :predicts? :occurs_on
     
     

data/lib/hiccup/schedule.rb

@@ -1,5 +1,5 @@
 require "hiccup"
-require "active_model/validations"
+require "active_model"
 
 
 module Hiccup

data/lib/hiccup/version.rb

@@ -1,3 +1,3 @@
 module Hiccup
-  VERSION = "0.5.3"
+  VERSION = "0.5.4"
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: hiccup
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Bob Lail
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.8
 - !ruby/object:Gem::Dependency
@@ -56,14 +56,14 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.8
 - !ruby/object:Gem::Dependency
@@ -132,6 +132,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .simplecov
+- .travis.yml
 - Gemfile
 - README.mdown
 - Rakefile
@@ -192,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: hiccup
-rubygems_version: 2.0.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A library for working with things that recur