smart_month 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 (Derek Perez | www.derekperez.com)
+
+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

@@ -0,0 +1,33 @@
+NOTE: Please read the wiki for usage examples and to see how you can help our project!
+
+SmartMonth is a "bodysnatcher" plugin that takes boring Date month fixnums and replaces them with a rich toolkit of functionality. You can use SmartMonth to:
+
+- Determine the first tuesday of any month in any year.
+- Determine all of the fridays of any month in any year.
+- Iterate through all the days of a month.
+- Determine how many days of the month there are.
+- Determine the first and last days of the month.
+- And other fun date/month related things!
+
+This is designed to be an extension of not only Time.now.month, but adds a new Month class to the ruby object model.
+
+Keep in mind, this is 1.1, and may break things that rely on Time.now.month being a Fixnum. I've tried to fix this by making sure #to_i works as expected, but it may be an issue, handle with care.
+
+Examples:
+
+	Time.now.month.every_tuesday #=> [array of tuesdays for the current month]
+	Month.april.first_wednesday #=> Date object corresponding to the first wednesday of april.
+	Month.may.every_monday_and_friday #=> {:monday=>[...],:friday=>[...]}
+	Month.june(2012).last_monday #=> Date object corresponding to the last monday in june 2012.
+
+	# iterator:
+	Month.june(2004).each do |day|
+		day.to_day #=> name of day (Saturday, Sunday, etc.)
+		day.to_i #=> value between 1 and the last day of the month corresponding.
+	end
+
+Check the included documentation (rdoc) or the documentation site http://www.derekperez.com/projects/smartmonth
+for more info on usage!
+
+Copyright (c) 2009 (Derek Perez | www.derekperez.com), released under the MIT license
+

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "smart_month"
+    gemspec.summary = 'SmartMonth is a "bodysnatcher" plugin that takes boring Date month fixnums and replaces them with a rich toolkit of
+functionality.'
+    gemspec.description = "You can use SmartMonth to: \n" +
+    "- Determine the first tuesday of any month in any year. \n" +
+    "- Determine all of the fridays of any month in any year. \n" +
+    "- Iterate through all the days of a month. \n" +
+    "- Determine how many days of the month there are. \n" +
+    "- Determine the first and last days of the month. \n" +
+    "- And other fun date/month related things!"
+    gemspec.email = "derek@derekperez.com"
+    gemspec.homepage = "http://github.com/perezd/smart_month"
+    gemspec.authors = ["Derek Perez", "Jonathan Silverman"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Runs unit test suite.'
+Rake::TestTask.new do |test|
+  test.libs << './test'
+  test.test_files = FileList['test/unit/*test.rb']
+  test.verbose = true
+end
+
+desc 'Runs Ruby Standard Library tests for date and time.'
+task :test_ruby do
+  puts `mspec test/spec`
+end
+
+desc 'Generate documentation for the smart_month plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SmartMonth'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/month.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH << File.dirname(__FILE__) + '/smart_month'
+
+require 'calculations'
+require 'collection'
+require 'math'
+require 'magic'
+require 'util'
+require 'rulesets'
+
+class Month
+  # gather the modules
+  include SmartMonth::Calculations
+  include SmartMonth::Collection
+  include SmartMonth::Math
+  include SmartMonth::Util
+  include SmartMonth::Magic
+  # abstraction that returns an array of months.
+  NAMES = Date::MONTHNAMES
+  # abstraction that returns an array of day names.
+  DAYS = Date::DAYNAMES  
+  # constructor, takes 2 optional arguments, if you don't provide them, it will default to
+  # the current month and year.
+  def initialize(month = Time.now.mon, year = Time.now.year)
+    @date = Date.new(year,( month.is_a?(Integer) ? month : Month::NAMES.index(month.to_s.capitalize) ) ,1) 
+  end
+end

data/lib/smart_month.rb

@@ -0,0 +1,11 @@
+require 'date'
+require File.expand_path(File.dirname(__FILE__)) + '/month'
+require File.expand_path(File.dirname(__FILE__)) + '/smart_month/extensions/date'
+
+# inject smart_month system into the Time class.
+class ::Time
+  def month
+    return Month.new(self.mon,self.year)
+  end
+end
+

data/lib/smart_month/calculations.rb

@@ -0,0 +1,87 @@
+module SmartMonth
+  # Responsible for all core month/week calculations.
+  module Calculations  
+    # returns the first date of the day requested. 
+    # if no day is defined, it returns the very first day of the month.
+    def first(day = nil)
+     (day.nil?) ? @date : nth_weekday(day,1)
+    end
+
+    # returns the second date of the day requested.
+    def second(day)
+      nth_weekday(day,2)
+    end
+
+    # returns the third date of the day requested.
+    def third(day)
+      nth_weekday(day,3)
+    end
+    
+    # returns the fourth (or potentially last), date of the day requested.
+    def fourth(day)
+      nth_weekday(day,4) || self.last(day)
+    end
+
+    # returns last date of the day requested.
+    # if no day is defined, it returns the very last day of the month.
+    def last(day = nil)
+     (day.nil?) ? Date.new(@date.year,@date.month,-1) : every(day).last
+    end
+
+    # returns an array of dates of the day requested.
+    # if an array of dates are passed in, a hash of day names containing
+    # the corresponding date are returned.
+    def every!(*days)
+     days = [days].flatten
+     if days.size == 1
+       dates = []
+       (1..5).each do |week|
+          dates << nth_weekday(days.first,week)
+       end
+       dates.compact!
+     else
+       dates = {}
+       days.each do |day|
+         day = day.to_sym
+         dates[day] = []
+         (1..5).each do |week|
+            dates[day] << nth_weekday(day,week)
+         end
+         dates[day].compact!
+       end
+     end
+     dates
+    end
+    
+    # this returns the same data as #every! but removes the hash
+    # organization of the data.
+    def every(*days)
+      days = every!(days)
+      (days.is_a?(Array)) ? days : days.values.flatten
+    end
+    
+    # returns the total number of days in month.
+    def size
+      self.last.day.to_i
+    end
+    alias_method :length, :size
+    
+    private
+
+    # this is the heart of the calculations module.
+    def nth_weekday(day,limit = 0)
+      raise RuntimeError, "#{day} is not a valid day of the week" unless Month::DAYS.collect{|d| d.downcase}.include?(day.to_s)
+      limit -= 1 # make more sense to humans
+      requested_weekday = Month::DAYS.collect{|d| d.downcase}.index(day.to_s)
+      iter_date = Date.new(@date.year,@date.month,1)
+      # find the first day that works
+      until iter_date.wday == requested_weekday
+        iter_date +=1
+      end
+      # then add a multipler based on the limit
+      iter_date = iter_date + (limit*7)
+      # if the date we've iterated to doesn't exist in this month, send out a nil.
+      return iter_date unless iter_date.month != @date.month
+    end  
+  end
+end

data/lib/smart_month/collection.rb

@@ -0,0 +1,51 @@
+module SmartMonth
+  # Responsible for all collection-based functionality.
+  module Collection
+    
+    # allows for increment by copy
+    def next
+      if @date.month + 1 > 12
+        Month.new(1,@date.year+1)
+      else
+        Month.new(@date.month+1,@date.year)
+      end
+    end
+
+    # allows for in place incrementing by 1
+    def next!
+      if @date.month + 1 > 12
+        @date = Date.new(@date.year+1,@date.month,1)
+      else
+        @date = Date.new(@date.year,@date.month+1,1)
+      end
+    end
+
+    # allows for deincrement by copy
+    def previous
+      if @date.month - 1 == 0
+        Month.new(12,@date.year-1)
+      else
+        Month.new(@date.month-1,@date.year)
+      end
+    end
+    alias_method :prev, :previous
+
+    # allows for in place deincrementing by 1
+    def previous!
+      if @date.month - 1 == 0
+        @date = Date.new(@date.year-1,12,1)
+      else
+        @date = Date.new(@date.year,@date.month-1,1)
+      end
+    end
+    alias_method :prev!, :previous!
+    
+    # allows us to iterate internally on the days of a given month.
+    def each(first = 1, last = self.last.day, &block)
+     (1..self.last.day).each do |e|
+       block.call(Date.new(@date.year,@date.month,e))
+     end
+     return self
+    end
+  end
+end

data/lib/smart_month/extensions/date.rb

@@ -0,0 +1,19 @@
+# mixin some new methods to the Date class.
+class Date
+  
+  # this is to make date objects more console-friendly
+  def inspect
+    strftime("%a, %d %b %Y")
+  end
+
+  # allows a date to retrun the current day its set to as an integer
+  def to_i
+    self.day.to_i
+  end
+  
+  # allows a date to return the day of the week it currently is as a string
+  def to_day
+    Month::DAYS[self.wday]
+  end
+
+end

data/lib/smart_month/magic.rb

@@ -0,0 +1,71 @@
+module SmartMonth
+  # Magic is responsible for the rails-like dynamic "magic finders".
+  module Magic
+    
+    # extends the Month class with the Month factory
+    def self.included(base)
+      base.extend MonthFactory
+    end
+    
+    # This module allows your code to ignore the class instantiation, simply do Month.june!
+    module MonthFactory
+      # singleton month factory
+      def method_missing(meth,*args)
+        return new(meth.to_s.capitalize, (args.first || Time.now.year)) if Month::NAMES.include? meth.to_s.capitalize
+      end
+      
+      # this allows you to essentially treat the month as a hash or array object to construct new months.
+      def [](month)
+         new(month)
+      end
+    end
+    
+    # nice catchall to allow rails-esque APIs if you choose to.
+    def method_missing(meth)
+      raw = meth.to_s.split("_")
+      
+      # execute lookup using week as positioning control
+      if week_position?(raw[0]) && raw[1] == "and"
+        results = []
+        # parse the request
+        arg = raw.slice!(raw.index(raw.last))
+        funcs = parse_arguments(raw)
+        # execute
+        funcs.each do |func|
+          results << self.send(func,arg) if week_position?(func)
+        end
+        return results
+        
+      # execute an every pattern on n-days
+      elsif raw[0] == "every"
+        # parse the request
+        func = raw.slice!(0)
+        args = parse_arguments(raw)
+        # execute
+        return self.every(args)
+        
+      # revert to basic singular lookup or raise an exception
+      elsif self.respond_to?(raw[0]) 
+        func = raw.slice!(0)
+        return self.send(func,raw) if week_position?(func)
+      else
+        raise NoMethodError
+      end
+    end
+  
+    private 
+    
+    # a quicky helper for breaking up text to args.
+    def parse_arguments(args)
+      args.select { |a| a != 'and' }
+    end
+    
+    # this is used a lot for validity and sanitizing.
+    def week_position?(compare)
+      [compare].flatten.each do |comp|
+        %w(first second third fourth last).include?(comp)
+      end
+    end
+    
+  end
+end

data/lib/smart_month/math.rb

@@ -0,0 +1,41 @@
+module SmartMonth
+  # Responsible for all math related functionality.
+  module Math
+    
+    # adds a number to the month value and returns a Fixnum.
+    def +(int)
+      self.to_i + int
+    end
+
+    # subtracts a number to the month value and returns a Fixnum.
+    def -(int)
+      self.to_i - int
+    end
+    
+    # multiplies a number to the month value and returns a Fixnum.
+    def *(int)
+      self.to_i * int
+    end
+
+    # divides a number to the month value and returns a Fixnum.
+    def /(int)
+      self.to_i / int
+    end
+    
+    # exponents a number to the month value and returns a Fixnum.
+    def **(int)
+      self.to_i ** int
+    end
+    
+    # modulos a number to the month value and returns a Fixnum.
+    def %(int)
+      self.to_i % int
+    end
+    
+    # compares the current month to another month.
+    def ==(month)
+      self.inspect! == month.inspect! 
+    end
+    
+  end
+end

data/lib/smart_month/rulesets.rb

@@ -0,0 +1,151 @@
+require 'yaml'
+
+module SmartMonth
+  class Rulesets
+    
+    ## LOADING RULES FROM YAML STREAM OR YAML FILE
+    
+    # this allows importing of rules into the system as
+    # a raw yaml stream
+    def self.load_yaml(yaml)
+      @@rulesets = YAML::load(yaml)
+      self.new.send(:activate_rules!)
+    end
+    
+    # this allows import of rules into the system as
+    # a yaml file on disk
+    def self.load_file(path)
+      File.open(path) { |yaml| self.load_yaml(yaml) }
+    end
+    
+    ## MANUAL RULE MANAGEMENT
+    
+    # manually add a rule to the system. The rule argument should be a string,
+    # an optional year argument can be passed if using a "natural frequency"
+    def self.add_rule(name, rule, year = nil)
+      @@rulesets = {} unless defined? @@rulesets
+      if rule.is_a?(String)
+        # define rule
+        rule_hash = { name => {'when' => rule } }
+        rule_hash[name]['year'] = year unless year.nil? 
+        # merge and inject
+        @@rulesets.merge!(rule_hash) 
+        self.new.send(:inject_rule,name,@@rulesets[name])
+      end
+    end
+    
+    # updating and adding rules should do the same thing
+    class << self
+      alias_method :update_rule, :add_rule
+    end
+    
+    # manually remove an existing rule from the system.
+    def self.remove_rule(name)
+      begin
+        name = name.gsub(' ','_').downcase
+        @@rulesets.delete_if { |k,v| k.downcase == name }
+        Date.class_eval  { eval("undef is_#{name}?") }
+        Month.class_eval { eval("undef #{name}")}
+      rescue
+       return false
+      end
+      return true
+    end
+  
+    protected 
+    
+    # iterates through all the rules currently defined in the class and injects them
+    # if they are not currently implemented.
+    def activate_rules!
+      @@rulesets.each_key do |rule|
+        inject_rule(rule, @@rulesets[rule])
+      end
+    end
+    
+    # this method parses and defines the methods in our pre-existing ruby classes
+    def inject_rule(name,rule)
+      meth_name = name.gsub(' ','_').downcase
+      type, data = parse(rule)
+      # don't define the rulset methods if they might override existing methods!
+      define_methods(type,meth_name,data) unless Month.respond_to?(meth_name) || Date.respond_to?(meth_name)
+    end
+    
+    ## PARSER STRATEGIES
+    
+    # factory method for determing which parsing strategy to use based on the rule.
+    def parse(rule)
+      (Month::NAMES.include?(rule['when'].split[0].capitalize)) ? parse_string_as_date(rule) : parse_string_as_frequency(rule)
+    end
+    
+    
+    # this is the parsing process for basic "date as string" rules
+    # (eg: 'December 12th, 2005' or 'March 15th')
+    def parse_string_as_date(rule)
+      # first attempt to parse the string and load structure
+      month,day,year = rule['when'].split
+      year = Time.now.year.to_i if year.nil?
+      data = {:year => year.to_i, :month => Month.new(month).to_i, :day => day.to_i}
+      return [:date,data]
+    end
+    
+    # this is the parsing process for basic "date as frequency" rules
+    # (eg: 'every tuesday and saturday' or 'every monday in march and april')
+    def parse_string_as_frequency(rule)
+      data,context = rule['when'].split('in')
+      data = data.rstrip.gsub(' ','_').downcase unless data.nil?
+      unless context.nil?
+        context = context.gsub(/(\,|and)/,'').split
+        context.collect {|ctx| ctx.downcase }
+      end
+      return [:freq, data, context, rule['year'].to_i]
+    end    
+    
+    ## METHOD DEFINITION
+    
+    ## The folowing methods are used to alter the existing objects in memory
+    # through the use of meta-programming. 
+    
+    private
+    
+    # do not define the alias unless the root is defined properly
+    def define_methods(type,meth_name,data)
+      define_alias(meth_name,data) if define_root(type,meth_name,data)
+    end
+    
+    # define root definition for lookup directly into the Month class
+    def define_root(type,meth_name,data)
+      return false unless [:date,:freq].include?(type)
+      begin
+        # algorithm template
+        context = "([#{data[:month]}].flatten.include?(self.month))"
+        fail = 'nil'
+        # determine lookup based on requested strategy
+        case type
+          when :date: qry = "Date.new(#{data[:year]},#{data[:month]},#{data[:day]})"
+          when :freq: qry = 'true'
+          else qry = 'nil'
+        end
+        # evaluate the custom rule into the function
+        Month.send(:define_method,meth_name) {
+          eval "#{context} ? #{qry} : #{fail}"
+        }
+      rescue
+        return false
+      end
+      return true
+    end
+    
+    # alias root definition as boolean directly into the Date class
+    def define_alias(meth_name,data)
+      begin
+        Date.send(:define_method, "is_#{meth_name}?") {
+          [Month[data[:month]].send(meth_name)].flatten.include?(self)
+        }
+      rescue
+        return false
+      end
+      return true
+    end
+    
+  end
+end