timeleap 0.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Pierre Sugar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,41 @@
+# syc-timeleap
+
+Creates dynamically date methods to jump through time
+
+## Usage
+
+    time_leap = SycTimeLeap::TimeLeap.new
+    time_leap.now
+    => #<Date: 2014-06-12 ((2456823j,0s,0n),+0s,2299161j)> 
+    time_leap.in2days
+    => #<Date: 2014-06-14 ((2456823j,0s,0n),+0s,2299161j)> 
+
+## Methods
+
+There are two forms how to invoke the methods. Actually the methods have to be
+unique (see Short Forms) to be recognized
+
+### Long Forms
+* in2days|weeks|months|years
+* back1day|week|month|year
+* yesterday
+* today
+* tomorrow
+* nextmonday|tuesday|wednesday|thursday|friday|saturday|sunday
+* previousmonday|tuesday|wednesday|thursday|friday|saturday|sunday
+* monday|tuesday|wednesday|thursday|friday|saturday|sundayin2weeks|months|years
+* monday|tuesday|wednesday|thursday|friday|saturday|sundayback1week|month|year
+
+### Short Forms
+* i2d|w|m|y
+* b2d|w|m|y
+* y
+* tod
+* tom
+* nmo|tu|we|th|fr|sa|su
+* pmo|tu|we|th|fr|sa|su
+* mo|tu|we|th|fr|sa|sui2w|m|y
+* mo|tu|we|th|fr|sa|sub2w|m|y
+
+## Contact
+<pierre@sugaryourcoffee.de>

data/lib/syctimeleap/time_leap.rb

@@ -0,0 +1,142 @@
+require 'date'
+
+# Provides date operations like in_1_day
+module SycTimeleap
+
+  # Base class for date operations
+  class TimeLeap
+
+    # Holds the weekdays of the week starts with sunday at index 0
+    WEEKDAYS = { "su" => [0, "sunday"], 
+                 "mo" => [1, "monday"], 
+                 "tu" => [2, "tuesday"],
+                 "we" => [3, "wednesday"], 
+                 "th" => [4, "thursday"], 
+                 "fr" => [5, "friday"],
+                 "sa" => [6, "saturday"] }
+
+    # The base date that is used to calculate date operations
+    attr_accessor :now
+
+    # Creates a new Temp and initializes it with the current date if no date
+    # is provided
+    def initialize(date = Time.now.to_date)
+      @now = date
+    end
+
+    # Provides the date calculation methods dynamically
+    def method_missing(name, *args)
+      add_regex = %r{
+        ^([ib])(?:n|ack)?
+        (?:\.|_|-| )?
+        (\d+)
+        (?:\.|_|-| )?
+        ([dwmy])
+        (?:ays?|eeks?|onths?|ears?)?$
+      }x
+
+      weekday_regex = %r{
+        ^(tod|tom|y)(?:a?y?|o?r?r?o?w?|e?s?t?e?r?d?a?y?)?$
+      }xi
+      
+      next_weekday_regex = %r{
+        ^(n|p)(?:e?x?t|r?e?v?i?o?u?s?)?
+        (?:\.|_| |-)?
+        (mo|tu|we|th|fr|sa|su)
+        (?:n?|e?s?|d?n?e?s?|u?r?s?|i?|t?u?r?|n?)(?:d?a?y?)$ 
+      }xi
+
+      next_weekday_in_regex = %r{
+        ^(mo|tu|we|th|fr|sa|su)
+        (?:n?|e?s?|d?n?e?s?|u?r?s?|i?|t?u?r?|n?)(?:d?a?y?)(?:_?)
+        (i|b)
+        (?:n?|a?c?k?)(?:_?)
+        (\d+)(?:_?)([dwmy])(?:a?y?s?|e?e?k?s?|o?n?t?h?s?|e?a?r?s?)$
+      }xi
+
+      return add($1, $2, $3)      if name =~ add_regex
+      return weekday($1)          if name =~ weekday_regex
+      return next_weekday($1, $2) if name =~ next_weekday_regex
+      return next_weekday_in($1, $2, $3, $4) if name =~ next_weekday_in_regex
+      super 
+    end
+
+    # Determines whether to move back or forward in time and returns the
+    # distance in days, weeks, months or years
+    # Example: move(10, 'd') adds 10 days to :now
+    def add(direction, count, distance)
+      count = direction.downcase == 'b' ? -count.to_i : count.to_i
+
+      case distance
+      when 'd'
+        @now + count
+      when 'w'
+        @now + count * 7
+      when 'm'
+        @now >> count
+      when 'y'
+        @now >> count * 12
+      end
+
+    end
+
+    # Returns yesterday, today or tomorrow
+    def weekday(weekday)
+      case weekday
+      when 'tod'
+        @now
+      when 'tom'
+        @now + 1
+      when 'y'
+        @now - 1
+      end
+    end
+
+    # Returns the next or previous weekday
+    # Exampel: next_monday or n_mo
+    # Su Mo Tu We Th Fr Sa
+    #  0  1  2  3  4  5  6
+    #     x                 Today
+    #           *           Next Wednesday
+    #                       @now + (3 - 1 + 7) % 7 = +2
+    #              x        Today 
+    #  *                    Next Sunday
+    #                       @now + (0 - 4 + 7) % 7 = +3
+    #        x              Today
+    #           *           Previous Wednesday
+    #                       @now + (3 - 2 + 7) % -7 = -6
+    #               x       Today
+    #        *              Previous Tuesday
+    #                       @now + (2 - 4 + 7) % -7 = -2
+    def next_weekday(direction, abbreviated_weekday)
+      count = direction.downcase == 'n' ? 1 : -1
+
+      weekday = WEEKDAYS[abbreviated_weekday.downcase]
+      raise "No valid weekday: #{abbreviated_weekday}" if weekday.nil?
+
+      offset = @now.send("#{weekday[1]}?") ? count * 7 : 0
+      @now + (weekday[0] - @now.wday + 7) % (count * 7) + offset
+    end
+
+    # Returns the next weekday in n days, weeks, month or years
+    # Example: monday_in_3_weeks or mo_i_3_w
+    def next_weekday_in(weekday_abbreviation, direction, count, distance)
+      count = direction.downcase == 'b' ? -count.to_i : count.to_i
+      weekday = WEEKDAYS[weekday_abbreviation.downcase]
+
+      case distance.downcase
+      when "d"
+      when "w"
+        (@now + count * 7) + weekday[0] - @now.wday  
+      when "m"
+        future = @now >> count
+        future + weekday[0] - future.wday
+      when "y"
+        future = @now >> count * 12
+        future + weekday[0] - future.wday
+      end
+    end
+
+  end
+
+end

data/spec/syctimeleap/time_leap_spec.rb

@@ -0,0 +1,140 @@
+require 'syctimeleap/time_leap'
+require 'date'
+
+module SycTimeleap
+
+  describe TimeLeap do
+
+    before do
+      @date = Date.new(2014, 3, 31)
+      @time_leap = TimeLeap.new(@date)
+    end
+
+    it "shows the date of the following date (e.g. in_1_day)" do
+      @time_leap.in_1_day.should eq @date + 1
+      @time_leap.i1d.should eq @date + 1
+    end
+
+    it "shows the date of the previous date (e.g. 1_day_ago)" do
+      @time_leap.back_1_day.should eq @date - 1
+      @time_leap.b1d.should eq @date - 1
+    end
+
+    it "shows the date of today plus n days" do
+      @time_leap.in_22_days.should eq @date + 22
+      @time_leap.in22days.should eq @date + 22
+    end
+
+    it "shows the date of today minus n days" do
+      @time_leap.back_22_day.should eq @date - 22
+      @time_leap.back22days.should eq @date - 22
+    end
+
+    it "shows the date of today plus n weeks" do
+      @time_leap.in_1_week.should eq @date + 7
+      @time_leap.i1w.should eq @date + 7
+      @time_leap.in2weeks.should eq @date + 14
+    end
+
+    it "shows the date of today minus n weeks" do
+      @time_leap.back_1_week.should eq @date - 7
+      @time_leap.b1w.should eq @date - 7
+      @time_leap.back2weeks.should eq @date - 14
+    end
+
+    it "shows the date of today plus n months" do
+      @time_leap.in_1_month.should eq @date >> 1
+      @time_leap.i1m.should eq @date >> 1
+      @time_leap.in3months.should eq @date >> 3
+    end
+
+    it "shows the date of today minus n months" do
+      @time_leap.back_1_month.should eq @date << 1
+      @time_leap.b1m.should eq @date << 1
+      @time_leap.back3months.should eq @date << 3
+    end
+
+    it "shows the date of today plus n years" do
+      @time_leap.in_12_years.should eq @date >> 12 * 12
+      @time_leap.i12y.should eq @date >> 12 * 12
+      @time_leap.in12years.should eq @date >> 12 * 12
+    end
+
+    it "shows the date of today minus n years" do
+      @time_leap.back_10_years.should eq @date << 10 * 12
+      @time_leap.b10y.should eq @date << 10 * 12
+      @time_leap.back10years.should eq @date << 10 * 12
+    end
+
+    it "shows the date of today" do
+      @time_leap.send("today").should eq @date
+      @time_leap.today.should eq @date
+      @time_leap.tod.should eq @date
+    end
+
+    it "shows the date of tomorrow" do
+      @time_leap.send("tomorrow").should eq @date + 1
+      @time_leap.tomorrow.should eq @date + 1
+      @time_leap.tom.should eq @date + 1
+    end
+
+    it "shows the date of yesterday" do
+      @time_leap.yesterday.should eq @date - 1
+      @time_leap.y.should eq @date - 1
+    end
+
+    it "shows the date of a next weekday (e.g. next_monday)" do
+      @time_leap.next_monday.should eq @date + 7
+      @time_leap.next_wednesday.should eq @date + 2
+      @time_leap.nwe.should eq @date + 2
+      @time_leap.NwE.should eq @date + 2
+    end
+
+    it "shows the date of a previous weekday (e.g. previous_monday)" do
+      @time_leap.previous_monday.should eq @date - 7
+      @time_leap.previous_wednesday.should eq @date - 5
+      @time_leap.pwe.should eq @date -5
+      @time_leap.PWednesDay.should eq @date -5
+      @time_leap.pReviouSWe.should eq @date -5
+    end
+
+    it "shows date of a weekday in n weeks (e.g. monday_in_2_weeks)" do
+      @time_leap.monday_in_2_weeks.should eq @date + 14
+      @time_leap.moi2w.should eq @date + 14
+      @time_leap.tuesday_in_2_weeks.should eq @date + 15
+      @time_leap.tuIN2weE.should eq @date + 15
+    end
+
+    it "shows date of a weekday n weeks ago (e.g. monday_2_weeks_ago)" do
+      @time_leap.monday_back_2_weeks.should eq @date - 14
+      @time_leap.moba2we.should eq @date - 14
+      @time_leap.tuesday_back_2_weeks.should eq @date - 13
+      @time_leap.tub2w.should eq @date - 13
+    end
+
+    it "shows date of a weekday in n months (e.g. monday_in_1_month)" do
+      @time_leap.monday_in_1_month.should eq @date + 28
+      @time_leap.moi1m.should eq @date + 28
+      @time_leap.wednesday_in_1_month.should eq @date + 30
+      @time_leap.wei1m.should eq @date + 30
+    end
+
+    it "shows date of a weekday n months before today" do
+      @time_leap.monday_back_1_month.should eq @date - 35
+      @time_leap.mob1m.should eq @date - 35
+      @time_leap.wednesday_back_1_month.should eq @date - 33
+      @time_leap.weDBA1mO.should eq @date - 33
+    end
+
+    it "shows date of a weekday in n years from today" do
+      @time_leap.monday_in_1_year.should eq Date.new(2015, 3, 30)
+      @time_leap.moi1y.should eq Date.new(2015, 3, 30)
+    end
+
+    it "shows date of a weekday n years before today" do
+      @time_leap.monday_back_1_year.should eq Date.new(2013, 4, 1)
+      @time_leap.mob1YE.should eq Date.new(2013, 4, 1)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: timeleap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Pierre Sugar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+description: 
+email: pierre@sugaryourcoffee.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/syctimeleap/time_leap.rb
+- spec/syctimeleap/time_leap_spec.rb
+- LICENSE
+- README.md
+homepage: https://github.com/sugaryourcoffee/timeleap
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Dynamically create date methods to jump through time
+test_files:
+- spec/syctimeleap/time_leap_spec.rb