availability 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3be1734eee2d550422776a8d399236e4e9fdd2ca
-  data.tar.gz: 4c98f924c2a0a12daafb846886a8be06a4a85358
+  metadata.gz: 5694685226c41dca7879ede7f7465d55bef2e355
+  data.tar.gz: bcd53b5d00090dfc2460500343fc938a6bb951f6
 SHA512:
-  metadata.gz: 0d334f811b0745a5774ca32a5e0357694abf6b72973d67c59668b93c06b44bd8b640ae5dedeae529d164265273bb4307dc94418a59d405cd6b2cd523a18fbf13
-  data.tar.gz: 71ff6a5d558627ce59c4bfafdb6e81102ea60c7e8dda203ed30b9d52513559670b2f224dc7163202ffbc604b65cac33b75a9a3e1ecdcd58cf9dbd5bad5159629
+  metadata.gz: 61392ce35039f61bb39d9d71c0801586e10a572c68befaf3f8ea000cfb8e6d538205a3f18049e4b21db28fc3ca158d768870ee92906e35b1d5066e31bc38afaa
+  data.tar.gz: 440aeb3e3f13046b00855e5e3a917ea07d2e6478a941ad87a7e2201279d91610ea3e69e91aacc32374c84e0f7adaa8962b8211845831916abecb83fc0034487c

data/README.md

@@ -5,7 +5,7 @@
 [![Gem Version](https://badge.fury.io/rb/availability.svg)](https://badge.fury.io/rb/availability)
 [read the docs][DOCS]
 
-This library uses modular arithmetic and residue classes to calculate schedule availability for dates. Time ranges within a date are handled differently. The goal is to create an easy-to-use API for schedule availability that is very fast and lightweight that is also easy and lightweight to persist in a database.
+This library uses modular arithmetic and residue classes to calculate schedule availability for dates. The goal is to create an easy-to-use API for schedule availability that is very fast and lightweight that is also easy and lightweight to persist in a database.
 
 Shout out to @dpmccabe for his [original article](http://dmcca.be/2014/01/09/recurring-subscriptions-with-ruby-rspec-and-modular-arithmetic.html) and code.
 

data/availability.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email                 = ["jacaetevha@gmail.com"]
 
   spec.summary               = %q{Calculating schedule availability}
-  spec.description           = %q{Use modular arithmetic and residue classes to calculate schedule availability for dates (times handled separately).}
+  spec.description           = %q{Use modular arithmetic and residue classes to calculate schedule availability for dates and times.}
   spec.homepage              = "https://github.com/upper-hand/availability"
   spec.license               = "Unlicense"
   spec.required_ruby_version = '>= 2.0'

data/examples/scheduler.rb

@@ -8,7 +8,7 @@ class Scheduler
   attr_reader :availabilities, :scheduled
 
   #
-  # availabilities: a list of Availability instances defining when the resource is available
+  # availabilities: a list of Availability::AbstractAvailability instances defining when the resource is available
   #
   def initialize(availabilities)
     @availabilities = validate_availabilities availabilities

data/lib/availability.rb

@@ -1,6 +1,7 @@
 require 'active_support'
 require 'active_support/core_ext'
-require_relative "availability/version"
+require_relative 'availability/version'
+require_relative 'availability/instance_variable_comparability'
 require_relative 'availability/createable'
 require_relative 'availability/exclusion'
 require_relative 'availability/abstract_availability'

data/lib/availability/abstract_availability.rb

@@ -1,6 +1,6 @@
 module Availability
   # @abstract see concrete classes: Once, Daily, Weekly, Monthly and Yearly
-  class AbstractAvailability
+  class AbstractAvailability < InstanceVariableComparability
     private_class_method :new # :nodoc:
   
     attr_accessor :capacity, :duration, :stops_by
@@ -201,6 +201,12 @@ module Availability
 
     # @!endgroup
 
+    protected
+
+    def comparability_ivar_names
+      %w{@capacity @exclusions @stops_by @duration @interval @start_time}
+    end
+
     private
 
     def compute_residue

data/lib/availability/exclusion.rb

@@ -1,5 +1,5 @@
 module Availability
-  class Exclusion
+  class Exclusion < InstanceVariableComparability
     attr_reader :rule
 
     def self.after_day(date)
@@ -48,13 +48,18 @@ module Availability
       @rule = rule
     end
 
+    def <=>(other)
+      return 1 if other.nil?
+      rule <=> other.rule
+    end
+
     def violated_by?(time)
       @rule.violated_by? time
     end
 
     private
     module Rule
-      class AfterDate
+      class AfterDate < InstanceVariableComparability
         def initialize(date)
           @date = date
         end
@@ -64,7 +69,7 @@ module Availability
         end
       end
 
-      class AfterDateAndTime
+      class AfterDateAndTime < InstanceVariableComparability
         def initialize(time)
           @after_date = AfterDate.new time.to_date
           @after_time = AfterTime.new time
@@ -75,7 +80,7 @@ module Availability
         end
       end
 
-      class AfterTime
+      class AfterTime < InstanceVariableComparability
         def initialize(date_or_time)
           @compare_to = date_or_time.to_time
         end
@@ -85,7 +90,7 @@ module Availability
         end
       end
 
-      class BeforeDate
+      class BeforeDate < InstanceVariableComparability
         def initialize(date)
           @date = date
         end
@@ -95,7 +100,7 @@ module Availability
         end
       end
 
-      class BeforeDateAndTime
+      class BeforeDateAndTime < InstanceVariableComparability
         def initialize(time)
           @before_date = BeforeDate.new time.to_date
           @before_time = BeforeTime.new time
@@ -106,7 +111,7 @@ module Availability
         end
       end
 
-      class BeforeTime
+      class BeforeTime < InstanceVariableComparability
         def initialize(date_or_time)
           @compare_to = date_or_time.to_time
         end
@@ -116,7 +121,7 @@ module Availability
         end
       end
 
-      class OnDate
+      class OnDate < InstanceVariableComparability
         def initialize(date)
           @date = date
         end
@@ -126,7 +131,7 @@ module Availability
         end
       end
 
-      class OnDayOfWeek
+      class OnDayOfWeek < InstanceVariableComparability
         def initialize(day_of_week)
           @day_of_week = day_of_week
         end

data/lib/availability/instance_variable_comparability.rb

@@ -0,0 +1,16 @@
+class InstanceVariableComparability
+  include Comparable
+  def <=>(other)
+    return 1 if other.nil?
+    comparisons = comparability_ivar_names.map do |ivar|
+      instance_variable_get(ivar) <=> other.instance_variable_get(ivar)
+    end.reject { |c| c == 0 }
+    return 0 if comparisons.empty?
+    comparisons.inject(0) { |acc, each| acc + each } >= 1 ? 1 : -1
+  end
+
+  protected
+  def comparability_ivar_names
+    instance_variables
+  end
+end

data/lib/availability/version.rb

@@ -1,3 +1,3 @@
 module Availability
-  VERSION = "0.0.4"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: availability
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Jason Rogers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Use modular arithmetic and residue classes to calculate schedule availability
-  for dates (times handled separately).
+  for dates and times.
 email:
 - jacaetevha@gmail.com
 executables: []
@@ -142,6 +142,7 @@ files:
 - lib/availability/exclusion.rb
 - lib/availability/factory_methods.rb
 - lib/availability/hourly.rb
+- lib/availability/instance_variable_comparability.rb
 - lib/availability/monthly.rb
 - lib/availability/once.rb
 - lib/availability/version.rb