repeatable 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03a465c906b9b2d7fdff5ffc02f1d101f87d3ab8
-  data.tar.gz: d29495e2f3820d482dc6a7e71c21623db1d8a8bf
+  metadata.gz: 49614dbb77808403fec7ce7b17f8e6b4c5c6ee99
+  data.tar.gz: 19759e4931d334759c54f6a80c9856fe92bc01e3
 SHA512:
-  metadata.gz: 857276ebf76281f5aa7b2c71599417aeb1da1e7fc0f5bbda36806f5165b47eb92a10ede29e510351858eb0b32a3c5dbb2e82f485cacecf9e8547e2ec1605ec07
-  data.tar.gz: 4f5cc44ae471c8bf0006c4570c09e829b803f44cb5661c3dc9fce721e1ed519ecc3b5373016b70d9ad6a2952c96b0fc75dfd2f51d27875fdc2ec555ee9d652fd
+  metadata.gz: 89a121c2ecf46fbb6cd89bf150a00dff53452fa2cbfddaf4bff89255455f7bab86aa09d50ea0e5a4d60de7306f70096657dfb2f63a59b2092aa2fe5bb9bb149c
+  data.tar.gz: f0c55a63c03e9055b40cc90183ad176eb75027411a71de000a4f95c0f57a6dd85b9ee98a4c581539475c9712fb08f4e59c13f765b3711abb9b2c5719ecf65416

data/CHANGELOG.md

@@ -0,0 +1,59 @@
+## CHANGELOG
+
+### Unreleased
+
+[Commits](https://github.com/molawson/repeatable/compare/v0.4.0...master)
+
+### 0.4.0 (2015-06-29)
+
+Features:
+
+* Define equivalence `#==` for `Expression` and `Schedule` objects
+* Define hash equality `#eql?` for `Expression::Date` objects
+* Remove `ActiveSupport` dependency
+
+[Commits](https://github.com/molawson/repeatable/compare/v0.3.0...v0.4.0)
+
+### 0.3.0 (2015-03-11)
+
+Features:
+
+* Ensure `end_date` on or after `start_date` for `Schedule#occurrences` ([@danott][])
+* Consider any invalid argument to `Schedule.new` a `ParseError` ([@danott][])
+
+[Commits](https://github.com/molawson/repeatable/compare/v0.2.1...v0.3.0)
+
+### 0.2.1 (2015-03-09)
+
+Features:
+
+* Add `ParseError` class for better error handling
+* Extract `Parser` class from `Schedule`
+
+Bugfixes:
+
+* Enable `Schedule` to take a hash with string keys
+
+[Commits](https://github.com/molawson/repeatable/compare/v0.2.0...v0.2.1)
+
+### 0.2.0 (2015-03-03)
+
+Features:
+
+* Add `Schedule#to_h` and `Expression#to_h` methods
+* Enable building a `Schedule` from composed `Expression` objects
+
+Bugfixes:
+
+* Fix default case equality for `Expression::Base` to work with classes and instances
+
+[Commits](https://github.com/molawson/repeatable/compare/v0.1.0...v0.2.0)
+
+### 0.1.0 (2015-02-23)
+
+Initial Release
+
+[Commits](https://github.com/molawson/repeatable/compare/531d40c...v0.1.0)
+
+
+[@danott]: https://github.com/danott

data/README.md

@@ -138,6 +138,29 @@ schedule.to_h
   #    can be used to recreate an identical Schedule object at a later time
 ```
 
+#### Equivalence
+
+Both `Repeatable::Schedule` and all `Repeatable::Expression` classes have equivalence `#==` defined according to what's appropriate for each class, so regardless of the order of arguments passed to each, you can tell whether one object is equivalent to the other in terms of whether or not, when asked the same questions, you'd receive the same results from each.
+
+```ruby
+Repeatable::Expression::DayInMonth.new(day: 1) == Repeatable::Expression::DayInMonth.new(day: 1)
+  # => true
+
+first = Repeatable::Expression::DayInMonth.new(day: 1)
+fifteenth = Repeatable::Expression::DayInMonth.new(day: 15)
+first == fifteenth
+  # => false
+
+union = Repeatable::Expression::Union.new(first, fifteenth)
+another_union = Repeatable::Expression::Union.new(fifteenth, first)
+union == another_union
+  # => true (order of Union and Intersection arguments doesn't their affect output)
+
+Repeatable::Schedule.new(union) == Repeatable::Schedule.new(another_union)
+  # => true (their expressions are equivalent, so they'll produce the same results)
+
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/repeatable/expression/base.rb

@@ -23,6 +23,15 @@ module Repeatable
           "Don't use Expression::Base directly. Subclasses must implement `#to_h`"
         )
       end
+
+      private
+
+      def hash_key
+        self.class.name.split('::').last
+          .gsub(/(?<!\b)[A-Z]/) { "_#{Regexp.last_match[0]}" }
+          .downcase
+          .to_sym
+      end
     end
   end
 end

data/lib/repeatable/expression/date.rb

@@ -0,0 +1,26 @@
+module Repeatable
+  module Expression
+    class Date < Base
+
+      def to_h
+        Hash[hash_key, attributes]
+      end
+
+      def ==(other)
+        other.is_a?(self.class) && attributes == other.attributes
+      end
+
+      alias eql? ==
+
+      def hash
+        [attributes.values, self.class.name].hash
+      end
+
+      protected
+
+      def attributes
+        Hash[instance_variables.map { |name| [name[1..-1].to_sym, instance_variable_get(name)] }]
+      end
+    end
+  end
+end

data/lib/repeatable/expression/day_in_month.rb

@@ -1,6 +1,6 @@
 module Repeatable
   module Expression
-    class DayInMonth < Base
+    class DayInMonth < Date
       def initialize(day:)
         @day = day
       end
@@ -9,10 +9,6 @@ module Repeatable
         date.day == day
       end
 
-      def to_h
-        { day_in_month: { day: day } }
-      end
-
       private
 
       attr_reader :day

data/lib/repeatable/expression/range_in_year.rb

@@ -1,6 +1,6 @@
 module Repeatable
   module Expression
-    class RangeInYear < Base
+    class RangeInYear < Date
       def initialize(start_month:, end_month: start_month, start_day: 0, end_day: 0)
         @start_month = start_month
         @end_month = end_month

data/lib/repeatable/expression/set.rb

@@ -2,21 +2,25 @@ module Repeatable
   module Expression
     class Set < Base
       def initialize(*elements)
-        @elements = elements.flatten
+        @elements = elements.flatten.uniq
       end
 
       def <<(element)
-        elements << element
+        elements << element unless elements.include?(element)
         self
       end
 
       def to_h
-        hash = {}
-        hash[self.class.name.demodulize.underscore.to_sym] = elements.map(&:to_h)
-        hash
+        Hash[hash_key, elements.map(&:to_h)]
       end
 
-      private
+      def ==(other)
+        other.is_a?(self.class) &&
+          elements.size == other.elements.size &&
+          other.elements.all? { |e| elements.include?(e) }
+      end
+
+      protected
 
       attr_reader :elements
     end

data/lib/repeatable/expression/weekday.rb

@@ -1,6 +1,6 @@
 module Repeatable
   module Expression
-    class Weekday < Base
+    class Weekday < Date
       def initialize(weekday:)
         @weekday = weekday
       end
@@ -9,10 +9,6 @@ module Repeatable
         date.wday == weekday
       end
 
-      def to_h
-        { weekday: { weekday: weekday } }
-      end
-
       private
 
       attr_reader :weekday

data/lib/repeatable/expression/weekday_in_month.rb

@@ -1,6 +1,6 @@
 module Repeatable
   module Expression
-    class WeekdayInMonth < Base
+    class WeekdayInMonth < Date
       def initialize(weekday:, count:)
         @weekday = weekday
         @count = count
@@ -10,10 +10,6 @@ module Repeatable
         day_matches?(date) && week_matches?(date)
       end
 
-      def to_h
-        { weekday_in_month: { weekday: weekday, count: count } }
-      end
-
       private
 
       attr_reader :weekday, :count

data/lib/repeatable/parser.rb

@@ -25,7 +25,7 @@ module Repeatable
     end
 
     def expression_for(key, value)
-      klass = "repeatable/expression/#{key}".classify.safe_constantize
+      klass = expression_klass(key.to_s)
       case klass
       when nil
         fail(ParseError, "Unknown mapping: Can't map key '#{key.inspect}' to an expression class")
@@ -40,5 +40,14 @@ module Repeatable
     def symbolize_keys(hash)
       hash.each_with_object({}) { |(k, v), a| a[k.to_sym] = v }
     end
+
+    def expression_klass(string)
+      camel_cased_string = string
+        .capitalize
+        .gsub(/(?:_)(?<word>[a-z\d]+)/i) { Regexp.last_match[:word].capitalize }
+      Repeatable::Expression.const_get(camel_cased_string)
+    rescue NameError => e
+      raise if e.name && e.name.to_s != camel_cased_string
+    end
   end
 end

data/lib/repeatable/schedule.rb

@@ -1,5 +1,3 @@
-require 'active_support/core_ext/string/inflections'
-
 module Repeatable
   class Schedule
     def initialize(arg)
@@ -44,7 +42,11 @@ module Repeatable
       expression.to_h
     end
 
-    private
+    def ==(other)
+      other.is_a?(self.class) && expression == other.expression
+    end
+
+    protected
 
     attr_reader :expression
   end

data/lib/repeatable/version.rb

@@ -1,3 +1,3 @@
 module Repeatable
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/repeatable.rb

@@ -13,6 +13,7 @@ require 'repeatable/parse_error'
 require 'repeatable/expression'
 require 'repeatable/expression/base'
 
+require 'repeatable/expression/date'
 require 'repeatable/expression/weekday'
 require 'repeatable/expression/weekday_in_month'
 require 'repeatable/expression/day_in_month'

data/repeatable.gemspec

@@ -16,8 +16,6 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '>= 3.0'
-
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: repeatable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mo Lawson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-11 00:00:00.000000000 Z
+date: 2015-06-29 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -77,6 +63,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -87,6 +74,7 @@ files:
 - lib/repeatable/conversions.rb
 - lib/repeatable/expression.rb
 - lib/repeatable/expression/base.rb
+- lib/repeatable/expression/date.rb
 - lib/repeatable/expression/day_in_month.rb
 - lib/repeatable/expression/intersection.rb
 - lib/repeatable/expression/range_in_year.rb
@@ -124,3 +112,4 @@ signing_key:
 specification_version: 4
 summary: Describe recurring event schedules and calculate their occurrences
 test_files: []
+has_rdoc: