week_of_month 1.2.1 → 1.2.2

data/.gitignore

@@ -0,0 +1,24 @@
+## Netbeans
+nbproject/
+
+## Aptans
+.project
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+# IDEA / RUBYMINE
+.idea
+
+## PROJECT::GENERAL
+tags
+coverage
+rdoc
+doc
+.yardoc
+pkg

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+

data/Gemfile.lock

@@ -0,0 +1,8 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES

data/README.rdoc

@@ -0,0 +1,111 @@
+= Week Of Month
+
+Week Of Month is a library which gives you week_of_month method on Date and Time 
+class object, that returns week of the month. It basically extends the Date and Time
+class with several useful date helpers.
+
+== Getting Started
+
+Week Of Month is released as a Ruby Gem. The gem is to be installed within a Ruby
+or Rails application. To install, simply add the following to your Gemfile:
+
+  gem 'week_of_month'
+  
+== Usage
+             
+ It returns week split of that date's month
+  
+ Date.new(2012,1,1).week_split
+  
+ => [[1, 2, 3, 4, 5, 6, 7],
+    [8, 9, 10, 11, 12, 13, 14], 
+    [15, 16, 17, 18, 19, 20, 21], 
+    [22, 23, 24, 25, 26, 27, 28], 
+    [29, 30, 31]]
+  
+ It returns month's week in which the date lies
+    
+ Date.new(2012,1,1).week_of_month
+ => 1
+
+ It return true if date lies in first week of month, else false.
+       
+ Date.new(2012,1,1).first_week?
+ => true
+   
+ It returns true if date lies in second week of month, else false.
+   
+ Date.new(2012,1,9).second_week?
+ => true
+    
+ It returns true if date lies in last week of month, else false.
+  
+ Date.new(2012,1,31).last_week?
+  => true
+  
+ It returns total number of weeks in month.
+  
+ Date.new(2012,1,31).total_weeks
+  => 5
+  
+ It returns month's week in which the date lies
+   
+ Date.new(2012,1,31).week_of_month_in_eng
+ => "Fifth"
+   
+== Tools Being Used
+
+We believe strongly in not writing code unless we have to, so Week Of Month is built using
+
+Ruby Date Class
+    
+Ruby Time Class
+
+== Version History
+  
+1.2.1
+  
+Support for Time class
+  
+Methods Added
+
+name_of_week_day, name_of_month, week_end?, working_day?,
+all_sundays_in_month, all_mondays_in_month, all_tuesdays_in_month,
+all_wednesdays_in_month, all_thursdays_in_month, all_fridays_in_month,
+all_saturdays_in_month
+  
+1.1.0
+  
+ActiveSupport Dependency removed
+  
+Methods Added
+  
+january?, february?, march?, april?, may?, june?, july?,
+august?, september?, october?, november?, december?, last_day_of_month
+  
+== Contributing to Week Of Month
+
+  Fork, fix, then send me a pull request.
+  
+== Copyright
+
+(The MIT License)
+
+Copyright (c) 2012 Sachin Singh. See LICENSE for details.
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['lib/test/modules/test*.rb']
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/lib/modules/constant.rb

@@ -0,0 +1,41 @@
+#!/bin/env ruby
+# encoding: utf-8
+
+# @author Sachin Singh
+
+module WeekOfMonth
+  module Constant
+    
+    # hash containg english words from one to seventh
+    WEEK_IN_ENG = { 1 => 'First', 2 => 'Second', 3 => 'Third',
+                    4 => 'Fourth', 5 => 'Fifth', 6 => 'Sixth', 7 => 'Seventh'}
+
+    # hash containg french words from one to seventh
+    WEEK_IN_FR  = { 1 => 'First', 2 => 'Second', 3 => 'Third',
+                    4 => 'Quatrième', 5 => 'Cinquième', 6 => 'sixième', 7 => 'septième'}
+
+    # hash containg german words from one to seventh
+    WEEK_IN_GER = { 1 => 'First', 2 => 'Second', 3 => 'Dritten',
+                    4 => 'Vierte', 5 => 'Fünfte', 6 => 'Sechste', 7 => 'siebte'}
+
+    # hash containg japneese words from one to seventh
+    WEEK_IN_JAP = { 1 => '最初', 2 => '秒', 3 => 'サード',
+                    4 => '第4回', 5 => '第五', 6=> 'シックス', 7 =>  '第7' }
+    
+    # hash containg month name with days in that month(in non leap yaer)
+    MONTH_WITH_DAY = { :january => 31, :february => 28, :march => 31,
+                       :april => 30, :may => 31, :june => 30, :july => 31,
+                       :august => 31, :september => 30, :october => 31,
+                       :november => 30, :december => 31 }
+
+    # hash containg month names with their sequence 
+    MONTH_WITH_SEQUENCE = { :january => 1, :february => 2, :march => 3,
+                            :april => 4, :may => 5, :june => 6, :july => 7,
+                            :august => 8, :september => 9, :october => 10,
+                            :november => 11, :december => 12 }
+   
+   # array of days names ordered starting with sunday and ending with saturday.
+    DAYS_IN_SEQUENCE = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday",
+                         "Saturday"]
+  end
+end

data/lib/modules/day.rb

@@ -0,0 +1,64 @@
+#!/bin/env ruby
+# encoding: utf-8
+
+# @author Sachin Singh
+
+module WeekOfMonth
+  module Day
+
+    # gives array of days in month
+    # Date.new(2012,1,1).days_array
+    #   => [ 1, 2, 3, 4, 5, 6, 7, 8, 9,
+    #        10, 11, 12, 13, 14, 15, 16,
+    #        17, 18, 19, 20, 21, 22, 23,
+    #        24, 25, 26, 27, 28, 29, 30,
+    #        31]
+    # @return [Array]
+    def days_array
+      day = self.beginning_of_month.to_date.wday
+      array = []
+      array[day] = 1
+      (2..self.end_of_month.mday).each {|i| array << i }
+      array
+    end
+
+    # Date.new(2012,11,1).name_of_week_day
+    #   => 'Thursday'
+    # @return [String]
+    def name_of_week_day
+      self.class.new(year,month,day).strftime('%A')
+    end
+      
+    # this code generates method names like 'upcomong_monday' and 'previous_monday'
+    # Date.new(2013,1,1).upcoming_monday
+    # => #<Date: 2013-01-07 ((2456300j,0s,0n),+0s,2299161j)>
+    # Date.new(2013,1,1).previous_monday
+    # => #<Date: 2012-12-31 ((2456293j,0s,0n),+0s,2299161j)>
+    { 'upcoming' => '+', 'previous' => '-' }.each_pair do |key,value|
+      Date::DAYNAMES.each do |day_name|
+        name = "#{key}_#{day_name.downcase}".to_sym
+        check = "#{day_name.downcase}?".to_sym
+        define_method(name) do
+          date = eval "self"
+          if date.send(check)
+            if date.class == Date
+              date = date.send(value,7) 
+            elsif date.class == Time
+              date = date.send(value,(60 * 60 * 24 * 7))
+            end
+           else
+             until date.send(check)
+               if date.class == Date
+                 date = date.send(value,1) 
+               elsif date.class == Time
+                 date = date.send(value,(60 * 60 * 24))
+               end
+             end
+           end
+           date
+        end
+      end
+    end
+   
+  end
+end

data/lib/modules/month.rb

@@ -0,0 +1,68 @@
+# @author Sachion Singh 
+
+require_relative 'constant'
+
+module WeekOfMonth
+  module Month
+
+    include WeekOfMonth::Constant
+
+    # this code generates method named like january?..december?
+    # to check whether a month is january or march? etc.
+    # @return [Boolean]
+    MONTH_WITH_DAY.keys.each do |month_name|
+      define_method((month_name.to_s + '?').to_sym) do
+        MONTH_WITH_SEQUENCE[month_name] == month
+      end
+    end
+    
+    # returns day of last day of month for a given date.
+    # Date.new(2012,11,1).last_day_of_month
+    #   => 30
+    # @return [Fixnum]
+    def last_day_of_month
+      if leap? && february?
+        29
+      else
+        MONTH_WITH_DAY[MONTH_WITH_SEQUENCE.key(month)]
+      end
+    end
+
+    # returns date of last day of month for a given date.
+    # Date.new(2012,11,1).end_of_month
+    #   => #<Date: 2012-11-30 ((2456262j,0s,0n),+0s,2299161j)>
+    # @return [Date]
+    def end_of_month
+      self.class.new(year,month,last_day_of_month)
+    end
+
+    # returns date of first day of month for a given date.    
+    # Date.new(2012,11,1).beginning_of_month
+    #   => #<Date: 2012-11-01 ((2456233j,0s,0n),+0s,2299161j)>
+    # @return [Date]
+    def beginning_of_month
+      self.class.new(year,month,1)
+    end
+
+    # returns name of month for a given date.    
+    # Date.new(2012,11,1).name_of_month
+    #   => "November"
+    # @return [String]
+    def name_of_month
+      self.class.new(year,month,day).strftime('%B')
+    end
+
+    # this code generates method named like 'all_mondays_in_month',
+    # 'all_tuesdays_in_month' etc. for all seven days of week
+    # Date.new(2012,11,1).all_mondays_in_month
+    #   => [5, 12, 19, 26]
+    # @return [Array]
+    DAYS_IN_SEQUENCE.each_with_index do |day_name, i|
+      method_name = "all_#{day_name.downcase}s_in_month".to_sym
+      define_method(method_name) do
+        week_split.map{|d| d[i] }.compact
+      end
+    end
+    
+  end
+end

data/lib/modules/week.rb

@@ -0,0 +1,179 @@
+# @author Sachion Singh 
+
+require_relative 'constant'
+
+module WeekOfMonth
+  module Week
+
+    include WeekOfMonth::Constant
+
+    # returns week of month for a given date
+    # Date.new(2012,11,15).week_of_month
+    #   => 3
+    # @return [Fixnum]
+    def week_of_month
+      week_split.each_with_index do |o,i|
+        return (i + 1) if o.include?(self.day)
+      end
+    end
+    
+    # checks whether the given day lies in first week of month
+    # Date.new(2012,11,1).first_week?
+    #   => true
+    # @return [Boolean]
+    def first_week?
+      week_split[0].include?((self.day))
+    end
+    
+    # checks whether the given day lies in second week of month
+    # Date.new(2012,11,8).second_week?
+    #   => true
+    # @return [Boolean]
+    def second_week?
+      week_split[1].include?((self.day))
+    end
+
+    # checks whether the given day lies in last week of month
+    # Date.new(2012,11,8).last_week?
+    #   => false
+    # @return [Boolean]
+    def last_week?
+      week_split.last.include?((self.day))
+    end
+
+    # returns total number of weeks in month
+    # Date.new(2012,11,8).total_weeks
+    #   => 5
+    # @return [Fixnum]
+    def total_weeks
+      week_split.size
+    end
+
+    # checks whether the given day is saturday or sunday.
+    # Date.new(2012,11,8).week_end?
+    #   => false
+    # @return [Boolean]
+    def week_end?
+      saturday? || sunday?
+    end
+
+    # checks whether the given day is not saturday or sunday.
+    # Date.new(2012,11,8).working_day?
+    #   => true
+    # @return [Boolean]
+    def working_day?
+      !week_end?
+    end
+
+    # returns week split of the month for the given date
+    # example-
+    # Date.new(2012,1,1).week_split
+    #   => [[1, 2, 3, 4, 5, 6, 7],
+    #       [8, 9, 10, 11, 12, 13, 14], 
+    #       [15, 16, 17, 18, 19, 20, 21], 
+    #       [22, 23, 24, 25, 26, 27, 28], 
+    #       [29, 30, 31]
+    # @return [Array] 
+    def week_split
+      days_array.each_slice(7).to_a
+    end
+
+    # this code generates method like 'week_of_month_eng', 'week_of_month_fr' etc.
+    # Date.new(2012,11,15).week_of_month_in_eng
+    #   => 'Third'
+    # Date.new(2012,11,30).week_of_month_in_fr
+    #   => "Cinquième"
+    # @return [String] 
+    ['eng', 'fr', 'ger', 'jap'].each do |lang|
+      method_name = "week_of_month_in_#{lang}"
+      define_method(method_name) do
+        eval "WEEK_IN_#{lang.upcase}[week_of_month]"
+      end
+    end
+    
+    # it returns days past in the week
+    # Date.new(2012,11,15).days_past_in_week
+    #   => 4
+    # Time.new(2012,11,30).days_past_in_week
+    #   => 5
+    # @return [Fixnum] 
+    def days_past_in_week
+      self.to_date.cwday
+    end
+    
+    # it returns days left in the week
+    # Date.new(2012,11,15).days_left_in_week
+    #   => 3
+    # Time.new(2012,11,30).days_left_in_week
+    #   => 2
+    # @return [Fixnum]
+    def days_left_in_week
+      7 - days_past_in_week
+    end
+    
+    # it returns date of the first day(sunday) of the week
+    # Date.new(2012,11,15).beginning_of_week
+    #   => #<Date: 2012-11-12 ((2456244j,0s,0n),+0s,2299161j)>
+    # Time.new(2012,11,30).beginning_of_week
+    #   => 2012-11-29 23:59:55 +0530
+    # @return [Date || Time] 
+    def beginning_of_week
+      self.class.new(year,month,current_week.detect {|i| !i.nil?})
+    end
+    
+    # it returns date of the last day(saturday) of the week
+    # Date.new(2012,11,15).end_of_week
+    #   => #<Date: 2012-11-19 ((2456251j,0s,0n),+0s,2299161j)>
+    # Time.new(2012,11,30).end_of_week
+    #   => 2012-11-30 00:00:02 +0530
+    # @return [Date || Time] 
+    def end_of_week
+      if current_week.index(self.day) == 6
+        self.class.new(year,month,current_week.last)
+      elsif current_week.index(self.day) < 6
+        if self.class == Date
+          self +  (6 -  current_week.index(self.day))
+        elsif self.class == Time
+          self +  (60 * 60 * 24  * (6 -  current_week.index(self.day)))
+        end
+      end
+    end
+    
+    # it returns date of the next week day.
+    # Date.new(2012,11,15).next_week
+    #   => #<Date: 2012-11-22 ((2456254j,0s,0n),+0s,2299161j)>
+    # Time.new(2012,11,30).next_week
+    #   => 2012-11-30 00:00:07 +0530
+    # @return [Date || Time] 
+    def next_week
+      if self.class == Date
+        self + 7 
+      elsif self.class == Time
+        self + (60 * 60 * 24 * 7)
+      end
+    end
+    
+    # it returns date of the previous week day.
+    # Date.new(2012,11,15).previous_week
+    #   => #<Date: 2012-11-08 ((2456240j,0s,0n),+0s,2299161j)>
+    # Time.new(2012,11,30).previous_week
+    #   => 2012-11-29 23:59:53 +0530
+    # @return [Date || Time] 
+    def previous_week
+      if self.class == Date
+        self - 7 
+      elsif self.class == Time
+        self - (60 * 60 * 24 * 7)
+      end
+    end
+    
+    # it returns array of days in current week.
+    # Date.new(2013,1,13).current_week
+    # => [7, 8, 9, 10, 11, 12, 13]
+    # @return [Array]    
+    def current_week
+      week_split.select{|c| c.include?((self.day))}.flatten
+    end
+    
+  end
+end