ice_cube 0.7.6 → 0.7.7

data/lib/ice_cube/deprecated.rb

@@ -0,0 +1,28 @@
+module Deprecated
+
+  # Define a deprecated alias for a method
+  # @param [Symbol] name - name of method to define
+  # @param [Symbol] replacement - name of method to replace (alias)
+  def deprecated_alias(name, replacement)
+    # Create a wrapped version
+    define_method(name) do |*args, &block|
+      warn "IceCube: ##{name} deprecated (please use ##{replacement})"
+      send replacement, *args, &block
+    end
+  end
+
+  # Deprecate a defined method
+  # @param [Symbol] name - name of deprecated method
+  # @param [Symbol] replacement - name of the desired replacement
+  def deprecated(name, replacement)
+    # Replace old method
+    old_name = :"#{name}_without_deprecation"
+    alias_method old_name, name
+    # And replace it with a wrapped version
+    define_method(name) do |*args, &block|
+      warn "IceCube: ##{name} deprecated (please use ##{replacement})"
+      send old_name, *args, &block
+    end
+  end
+
+end

data/lib/ice_cube/rule.rb

@@ -30,12 +30,12 @@ module IceCube
 
     # Yaml implementation
     def to_yaml(*args)
-      defined?(Psych) ? Psych::dump(to_hash) : YAML::dump(to_hash, *args)
+      IceCube::use_psych? ? Psych::dump(to_hash) : YAML::dump(to_hash, *args)
     end
 
     # From yaml
     def self.from_yaml(yaml)
-      from_hash defined?(Psych) ? Psych::load(yaml) : YAML::load(yaml)
+      from_hash IceCube::use_psych? ? Psych::load(yaml) : YAML::load(yaml)
     end
 
     # Expected to be overridden by subclasses

data/lib/ice_cube/schedule.rb

@@ -4,17 +4,20 @@ module IceCube
 
   class Schedule
 
+    extend ::Deprecated
+
     # Get the start time
     attr_accessor :start_time
-    alias :start_date :start_time
-    alias :start_date= :start_time=
+    deprecated_alias :start_date, :start_time
+    deprecated_alias :start_date=, :start_time=
     
     # Get the duration
     attr_accessor :duration
 
     # Get the end time
     attr_accessor :end_time
-    alias :end_date :end_time
+    deprecated_alias :end_date, :end_time
+    deprecated_alias :end_date=, :end_time=
 
     # Create a new schedule
     def initialize(start_time = nil, options = {})
@@ -32,8 +35,9 @@ module IceCube
       add_recurrence_rule rule
       time
     end
-    alias :rdate :add_recurrence_time
-    alias :add_recurrence_date :add_recurrence_time
+    alias :rtime :add_recurrence_time
+    deprecated_alias :rdate, :rtime
+    deprecated_alias :add_recurrence_date, :add_recurrence_time
 
     # Add an exception time to the schedule
     def add_exception_time(time)
@@ -42,8 +46,9 @@ module IceCube
       add_exception_rule rule
       time
     end
-    alias :exdate :add_exception_time
-    alias :add_exception_date :add_exception_time
+    alias :extime :add_exception_time
+    deprecated_alias :exdate, :extime
+    deprecated_alias :add_exception_date, :add_exception_time
 
     # Add a recurrence rule to the schedule
     def add_recurrence_rule(rule)
@@ -85,8 +90,9 @@ module IceCube
     def recurrence_times
       @all_recurrence_rules.select { |r| r.is_a?(SingleOccurrenceRule) }.map(&:time)
     end
-    alias :rdates :recurrence_times
-    alias :recurrence_dates :recurrence_times
+    alias :rtimes :recurrence_times
+    deprecated_alias :rdates, :rtimes
+    deprecated_alias :recurrence_dates, :recurrence_times
 
     # Remove a recurrence time
     def remove_recurrence_time(time)
@@ -96,15 +102,17 @@ module IceCube
       end
       time if found
     end
-    alias :remove_recurrence_date :remove_recurrence_time
-    alias :remove_rdate :remove_recurrence_time
+    alias :remove_rtime :remove_recurrence_time
+    deprecated_alias :remove_recurrence_date, :remove_recurrence_time
+    deprecated_alias :remove_rdate, :remove_rtime
 
     # Get the exception times that are on the schedule
     def exception_times
       @all_exception_rules.select { |r| r.is_a?(SingleOccurrenceRule) }.map(&:time)
     end
-    alias :exdates :exception_times
-    alias :exception_dates :exception_times
+    alias :extimes :exception_times
+    deprecated_alias :exdates, :extimes
+    deprecated_alias :exception_dates, :exception_times
 
     # Remove an exception time
     def remove_exception_time(time)
@@ -114,8 +122,9 @@ module IceCube
       end
       time if found
     end
-    alias :remove_exception_date :remove_exception_time
-    alias :remove_exdate :remove_exception_time
+    alias :remove_extime :remove_exception_time
+    deprecated_alias :remove_exception_date, :remove_exception_time
+    deprecated_alias :remove_exdate, :remove_extime
 
     # Get all of the occurrences from the start_time up until a
     # given Time
@@ -253,12 +262,12 @@ module IceCube
 
     # Convert the schedule to yaml
     def to_yaml(*args)
-      defined?(Psych) ? Psych::dump(to_hash, *args) : YAML::dump(to_hash, *args)
+      IceCube::use_psych? ? Psych::dump(to_hash, *args) : YAML::dump(to_hash, *args)
     end
 
     # Load the schedule from yaml
     def self.from_yaml(yaml, options = {})
-      from_hash defined?(Psych) ? Psych::load(yaml) : YAML::load(yaml), options
+      from_hash IceCube::use_psych? ? Psych::load(yaml) : YAML::load(yaml), options
     end
 
     # Convert the schedule to a hash

data/lib/ice_cube/validations/day.rb

@@ -25,7 +25,7 @@ module IceCube
       end
 
       def build_s(builder)
-        builder.piece(:day) << "#{Date::DAYNAMES[day]}s"
+        builder.piece(:day) << day
       end
 
       def build_hash(builder)
@@ -44,8 +44,18 @@ module IceCube
         :wday
       end
 
-      StringBuilder.register_formatter(:day) do |segments|
-        "on #{StringBuilder.sentence(segments)}"
+      StringBuilder.register_formatter(:day) do |validation_days|
+        # sort the days
+        validation_days.sort!
+        # pick the right shortening, if applicable
+        if validation_days == [0, 6]
+          'on Weekends'
+        elsif validation_days == (1..5).to_a
+          'on Weekdays'
+        else
+          segments = validation_days.map { |d| "#{Date::DAYNAMES[d]}s" }
+          "on #{StringBuilder.sentence(segments)}"
+        end
       end
 
     end

data/lib/ice_cube/validations/until.rb

@@ -2,11 +2,13 @@ module IceCube
 
   module Validations::Until
 
+    extend ::Deprecated
+
     # accessor
     def until_time
       @until
     end
-    alias :until_date :until_time
+    deprecated_alias :until_date, :until_time
 
     def until(time)
       @until = time

data/lib/ice_cube/version.rb

@@ -1,5 +1,5 @@
 module IceCube
 
-  VERSION = '0.7.6'
+  VERSION = '0.7.7'
 
 end

data/lib/ice_cube.rb

@@ -1,4 +1,5 @@
 require 'date'
+require 'ice_cube/deprecated'
 
 # Use psych if we can
 begin
@@ -71,4 +72,8 @@ module IceCube
   # Formatting
   TO_S_TIME_FORMAT = '%B %e, %Y'
 
+  def self.use_psych?
+    @use_psych ||= defined?(Psych) && Psych::VERSION
+  end
+
 end

data/spec/spec_helper.rb

@@ -1,13 +1,11 @@
-require File.dirname(__FILE__) + '/../lib/ice_cube'
-
 begin
-  require 'cover_me'
-  # https://github.com/markbates/cover_me/issues/50
-  at_exit do
-    CoverMe.complete!
-  end
+  require 'simplecov'
+  SimpleCov.start
 rescue LoadError
+  # okay
 end
 
+require File.dirname(__FILE__) + '/../lib/ice_cube'
+
 DAY = Time.utc(2010, 3, 1)
 WEDNESDAY = Time.utc(2010, 6, 23, 5, 0, 0)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ice_cube
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.7.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-01 00:00:00.000000000Z
+date: 2012-02-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &20210700 !ruby/object:Gem::Requirement
+  requirement: &2153297040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20210700
+  version_requirements: *2153297040
 - !ruby/object:Gem::Dependency
   name: active_support
-  requirement: &20210140 !ruby/object:Gem::Requirement
+  requirement: &2153296340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *20210140
+  version_requirements: *2153296340
 - !ruby/object:Gem::Dependency
   name: tzinfo
-  requirement: &20209560 !ruby/object:Gem::Requirement
+  requirement: &2153295880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20209560
+  version_requirements: *2153295880
 description: ice_cube is a recurring date library for Ruby.  It allows for quick,
   programatic expansion of recurring date rules.
 email: john@crepezzi.com
@@ -51,43 +51,44 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/ice_cube/single_occurrence_rule.rb
+- lib/ice_cube/builders/hash_builder.rb
+- lib/ice_cube/builders/ical_builder.rb
+- lib/ice_cube/builders/string_builder.rb
+- lib/ice_cube/deprecated.rb
+- lib/ice_cube/errors/count_exceeded.rb
+- lib/ice_cube/errors/until_exceeded.rb
+- lib/ice_cube/rule.rb
+- lib/ice_cube/rules/daily_rule.rb
+- lib/ice_cube/rules/hourly_rule.rb
+- lib/ice_cube/rules/minutely_rule.rb
+- lib/ice_cube/rules/monthly_rule.rb
+- lib/ice_cube/rules/secondly_rule.rb
+- lib/ice_cube/rules/weekly_rule.rb
+- lib/ice_cube/rules/yearly_rule.rb
 - lib/ice_cube/schedule.rb
-- lib/ice_cube/version.rb
+- lib/ice_cube/single_occurrence_rule.rb
 - lib/ice_cube/time_util.rb
-- lib/ice_cube/validations/minute_of_hour.rb
-- lib/ice_cube/validations/secondly_interval.rb
+- lib/ice_cube/validated_rule.rb
+- lib/ice_cube/validations/count.rb
+- lib/ice_cube/validations/daily_interval.rb
+- lib/ice_cube/validations/day.rb
+- lib/ice_cube/validations/day_of_month.rb
 - lib/ice_cube/validations/day_of_week.rb
+- lib/ice_cube/validations/day_of_year.rb
+- lib/ice_cube/validations/hour_of_day.rb
 - lib/ice_cube/validations/hourly_interval.rb
-- lib/ice_cube/validations/minutely_interval.rb
 - lib/ice_cube/validations/lock.rb
+- lib/ice_cube/validations/minute_of_hour.rb
+- lib/ice_cube/validations/minutely_interval.rb
 - lib/ice_cube/validations/month_of_year.rb
-- lib/ice_cube/validations/yearly_interval.rb
-- lib/ice_cube/validations/schedule_lock.rb
-- lib/ice_cube/validations/hour_of_day.rb
-- lib/ice_cube/validations/until.rb
 - lib/ice_cube/validations/monthly_interval.rb
-- lib/ice_cube/validations/day_of_year.rb
-- lib/ice_cube/validations/day_of_month.rb
+- lib/ice_cube/validations/schedule_lock.rb
 - lib/ice_cube/validations/second_of_minute.rb
+- lib/ice_cube/validations/secondly_interval.rb
+- lib/ice_cube/validations/until.rb
 - lib/ice_cube/validations/weekly_interval.rb
-- lib/ice_cube/validations/daily_interval.rb
-- lib/ice_cube/validations/count.rb
-- lib/ice_cube/validations/day.rb
-- lib/ice_cube/rules/hourly_rule.rb
-- lib/ice_cube/rules/minutely_rule.rb
-- lib/ice_cube/rules/yearly_rule.rb
-- lib/ice_cube/rules/secondly_rule.rb
-- lib/ice_cube/rules/weekly_rule.rb
-- lib/ice_cube/rules/daily_rule.rb
-- lib/ice_cube/rules/monthly_rule.rb
-- lib/ice_cube/errors/until_exceeded.rb
-- lib/ice_cube/errors/count_exceeded.rb
-- lib/ice_cube/rule.rb
-- lib/ice_cube/validated_rule.rb
-- lib/ice_cube/builders/ical_builder.rb
-- lib/ice_cube/builders/string_builder.rb
-- lib/ice_cube/builders/hash_builder.rb
+- lib/ice_cube/validations/yearly_interval.rb
+- lib/ice_cube/version.rb
 - lib/ice_cube.rb
 - spec/spec_helper.rb
 homepage: http://seejohnrun.github.com/ice_cube/
@@ -110,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ice-cube
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Ruby Date Recurrence Library