date_plus 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac057d70451cc0db7f56314183931c251834a5e5
+  data.tar.gz: c98b42f0ffa14e3015af8c3cca9624aca895a28e
+SHA512:
+  metadata.gz: 7dffd0416344b012f538c06de7047342a66fecc0e18e05e6f2a6c5d5b4ed32fd5502961747aa02ddfdfa56ad4193b5e1db44f883aafed4200e041d665b6602b4
+  data.tar.gz: 4ad3656e75714bc4c8903df047236e90ba3a20caebfbd55eaababfd98afeed89c40cf2fd2c843355a7de0bd3499a0bcfee535960d6ec778d31e04b47265831e3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in date_plus.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yaniv Savir
+
+MIT License
+
+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,103 @@
+# DatePlus
+
+Additional methods for date objects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'date_plus'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install date_plus
+
+## Usage
+
+Date_plus adds methods directly to instances of Date objects:
+
+```ruby
+date_object = Date.new(2014, 7, 24)
+# => #<Date: 2014-07-24 ((2456863j,0s,0n),+0s,2299161j)>
+```
+
+### Methods for weekday and month names
+
+```ruby
+date_object.weekday_name
+=> "Thursday"
+
+date_object.month_name
+=> "July"
+```
+
+### Find a specific future date
+```ruby
+date_object.next_instance_of(:month => 12, :day => 5)
+# => #<Date: 2014-12-05 ((2456997j,0s,0n),+0s,2299161j)>
+
+date_object.next_instance_of(:month_name => 'July', :day => 4, :weekday_name => 'Sunday')
+# => #<Date: 2021-07-04 ((2459400j,0s,0n),+0s,2299161j)>
+
+# next_instance_of accepts any combination of date methods
+```
+
+### Start and end of time periods
+
+```ruby
+date_object.start_of_week
+# => #<Date: 2014-07-20 ((2456859j,0s,0n),+0s,2299161j)>
+
+date_object.end_of_week
+# => #<Date: 2014-07-26 ((2456865j,0s,0n),+0s,2299161j)>
+
+date_object.start_of_month
+# => #<Date: 2014-07-01 ((2456840j,0s,0n),+0s,2299161j)>
+
+date_object.end_of_month
+# => #<Date: 2014-07-31 ((2456870j,0s,0n),+0s,2299161j)>
+
+date_object.start_of_year
+# #<Date: 2014-01-01 ((2456659j,0s,0n),+0s,2299161j)>
+
+date_object.end_of_year
+# => #<Date: 2014-12-31 ((2457023j,0s,0n),+0s,2299161j)>
+```
+
+### Next or future instance of specific date values
+
+```ruby
+date_object.future_instance_of_weekday('sunday')
+# => #<Date: 2014-07-27 ((2456866j,0s,0n),+0s,2299161j)>
+
+date_object.future_instance_of_day(21)
+# => #<Date: 2014-08-21 ((2456891j,0s,0n),+0s,2299161j)>
+
+date_object.future_instance_of_month('March')
+# => #<Date: 2015-03-01 ((2457083j,0s,0n),+0s,2299161j)>
+
+# Each of the above methods my optionally be given a second integer parameter n
+# to return the nth instance from the date
+date_object.future_instance_of_weekday('sunday', 4)
+# => #<Date: 2014-08-17 ((2456887j,0s,0n),+0s,2299161j)>
+
+# a second integer argument will find the nth future weekday
+date_object.future_instance_of_month('march', 6)
+# => #<Date: 2020-03-01 ((2458910j,0s,0n),+0s,2299161j)>
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+### Things to Contribute
+* Optimization
+* Additional appropriate methods

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/date_plus.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'date_plus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "date_plus"
+  spec.version       = DatePlus::VERSION
+  spec.authors       = ["Yaniv Savir"]
+  spec.email         = ["saviry@gmail.com"]
+  spec.description   = %q{Additional methods for date objects}
+  spec.summary       = %q{Filling in necessary holes and eliminating unnecessary steps in date objects}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/date_plus.rb

@@ -0,0 +1,119 @@
+require "date_plus/version"
+require 'date'
+
+class Date
+
+  def weekday_name
+    self.strftime('%A')
+  end
+
+  def month_name
+    self.strftime('%B')
+  end
+
+  def start_of_week
+    self - cwday
+  end
+
+  def start_of_month
+    self - day + 1
+  end
+
+  def start_of_year
+    self - yday + 1
+  end
+
+  def end_of_week
+    self + (6 - cwday)
+  end
+
+  def end_of_month
+    Date.civil(year, month, -1)
+  end
+
+  def end_of_year
+    Date.civil(year, -1, -1)
+  end
+
+  # options can accept any method that responds to date
+  # so long as the criteria matches the output of that method
+  def next_instance_of(options)
+    options.each { |k, v| options[k] = v.downcase.capitalize if v.class == String }
+    return check_dates_by_year(self, end_of_year, options)
+  end
+
+  def future_instance_of_weekday(weekday, instances_away=1)
+    raise 'Argument passed is not a weekday' unless weekday.class == String || !weekday_names.include?(weekday.downcase.capitalize)
+    fixnum_or_nil_or_error(instances_away)
+    self.step(self + (7 * instances_away), step=+1).reverse_each do |current_day|
+      return current_day if current_day.weekday_name == weekday.downcase.capitalize
+    end
+  end
+
+  def future_instance_of_day(day, instances_away=1)
+    valid_day_or_error(day)
+    fixnum_or_nil_or_error(instances_away)
+    self.step(self + (31 * instances_away), step=+1).reverse_each do |current_day|
+      return current_day if current_day.day === day
+    end
+  end
+
+  def future_instance_of_month(month_name, instances_away=1)
+    valid_month_or_error(month_name)
+    fixnum_or_nil_or_error(instances_away)
+    months = []
+    first_of_month = Date.today.start_of_month
+    (instances_away * 12).times do
+      months.push(first_of_month)
+      first_of_month = first_of_month.next_month
+    end
+    months.reverse.each {|first_of_month| return first_of_month if first_of_month.month == Date.parse(month_name).month }
+  end
+
+  def future_year(instances_away)
+    fixnum_nil_or_error(instances_away)
+    year = Date.today.start_of_year
+    years = []
+    (instances_away + 1).times {years.push(year); year = year.next_year}
+    return years.last
+  end
+
+  private
+
+  def weekday_names
+    ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']
+  end
+
+  def month_names
+    ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']
+  end
+
+  def matches_value(field, value)
+    self.send(field) == value
+  end
+
+  def valid_condition(field, condition)
+    self.send(field) == condition
+  end
+
+  def check_dates_by_year(start_date, end_date, options)
+    start_date.step(end_date, step=+1) do |date|
+      return date if options.all? { |k, v| date.valid_condition(k, v) }
+    end
+    next_year_start = end_date + 1
+    check_dates_by_year(next_year_start, next_year_start.end_of_year, options)
+  end
+
+  def fixnum_or_nil_or_error(arg)
+    raise 'Argument passed is not an integer' unless arg.class == Fixnum || arg.nil?
+  end
+
+  def valid_day_or_error(arg)
+    raise 'Argument passed is not a valid day' unless arg.class == Fixnum && 0 < arg && arg < 32
+  end
+
+  def valid_month_or_error(arg)
+    raise 'Argument passed is not a valid month' unless arg.class == String && month_names.include?(arg.downcase.capitalize)
+  end
+
+end

data/lib/date_plus/version.rb

@@ -0,0 +1,3 @@
+module DatePlus
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: date_plus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yaniv Savir
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Additional methods for date objects
+email:
+- saviry@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- date_plus.gemspec
+- lib/date_plus.rb
+- lib/date_plus/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Filling in necessary holes and eliminating unnecessary steps in date objects
+test_files: []