nth_day 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 748e855a150ef266a429bd80cea3eace6af0203e
+  data.tar.gz: ae1851606c0cb588a8f43f34cc6d6342c25d5ecc
+SHA512:
+  metadata.gz: 4f9d76329278cee54ab4e0cf65cf55d55c2e9220041edf8b955bddf95599f0ec97ffcb14c0aecc63ed0f47ce090e47b06cf9ebd76d3c632f5ed405bf9addf522
+  data.tar.gz: d02404b9b4110d1353231c545720388b2e979f5b323a473c7fb4f2e3a0cb5b14f5ce98bf6976d1322da7d081e406362e187304a3f856918a7407c64670aada0b

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dolan Murphy
+
+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,47 @@
+# NthDay
+
+A bite-size gem for finding the next occurrence of the *n*th *week*day of the month.  For example, you can use it to find the next "2nd Monday" that will occur. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nth_day'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nth_day
+
+## Usage
+
+Find the next occurrence of the nth day specified:
+
+    NthDay.next_occurrence("1st Tuesday") 
+
+You can also pass in a custom value for the date to start from if you don't want to find the next date from today:
+
+    NthDay.next_occurrence("1st Tuesday", Date.today - 1) 
+
+NthDay can handle abbreviated weekday names, and is case-insensitive.  As long as your name has the first two characters of the name, NthDay will recognize it:
+
+    NthDay.next_occurrence("1st Tu")
+
+## Testing
+
+NthDay uses [RSpec](http://rspec.info) for testing.  To run the tests:
+
+    $ bundle exec rspec
+
+## Contributing
+
+1. Fork it ( https://github.com/dmur/nth-day/fork )
+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 a new Pull Request
+
+

data/Rakefile

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

data/lib/nth_day.rb

@@ -0,0 +1,24 @@
+require "nth_day/version"
+require 'date'
+
+module NthDay
+  def self.next_occurrence(day, now=Date.today)
+    n = day.split.first[/\d/].to_i
+    w = self.wday_named(day.split.last)
+    now.step(now + 37).select{|d| d.nth_wday?(n, w) }.first
+  end
+
+  def self.wday_named(name)
+    ["su", "mo", "tu", "we", "th", "fr", "sa"].index(name[0..1].downcase)
+  end
+end
+
+class Date
+  def nth_wday?(n, w)
+    (self.wday == w) && (self.nth_of_wday == n)
+  end
+
+  def nth_of_wday
+    (self.mday.to_f / 7).ceil
+  end
+end

data/lib/nth_day/version.rb

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

data/nth_day.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nth_day/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nth_day"
+  spec.version       = NthDay::VERSION
+  spec.authors       = ["Dolan Murphy"]
+  spec.email         = ["admin@dmur.me"]
+  spec.summary       = %q{Query for the next nth weekday of the month.}
+  spec.description   = %q{Nth day allows you to specify dates in the format "1st Tuesday", and have returned a date for the next occurrence of that day.}
+  spec.homepage      = "http://github.com/dmur/nth-day"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/nth_day_spec.rb

@@ -0,0 +1,131 @@
+require 'nth_day'
+
+RSpec.describe Date do
+  describe "#next_nth_day" do
+    context "when 2nd Wednesday passed" do
+      let(:next_date) { NthDay.next_occurrence("2nd Wednesday") }
+
+      it "returns a date after today" do
+        (next_date > Date.today).should be(true)
+      end
+      it "returns a wednesday" do
+        (next_date.wednesday?).should be(true)
+      end
+      it "returns the 2nd wednesday of the month" do
+        (next_date.nth_of_wday).should be(2)
+      end
+    end
+
+    context "when 4th Thu passed" do
+      let(:next_date) { NthDay.next_occurrence("4th Thu") }
+
+      it "returns a date after today" do
+        (next_date > Date.today).should be(true)
+      end
+      it "returns a thursday" do
+        (next_date.thursday?).should be(true)
+      end
+      it "returns the 4th thursday of the month" do
+        (next_date.nth_of_wday).should be(4)
+      end
+    end
+  end
+
+  describe "#nth_wday?" do
+    context "when date is Thursday, Jan 1st 2015" do
+      let(:date) { Date.parse('2015-01-01') }
+
+      it "is 1st thursday" do
+        (date.nth_wday?(1, 4)).should be(true)
+      end
+
+      it "is not 1st wednesday" do
+        (date.nth_wday?(1, 3)).should be(false)
+      end
+
+      it "is not 2nd thursday" do
+        (date.nth_wday?(2, 4)).should be(false)
+      end
+    end
+
+    context "when date is Friday, Feb 20th 2015" do
+      let(:date) { Date.parse('2015-02-20') }
+
+      it "is 3rd friday" do
+        (date.nth_wday?(3, 5)).should be(true)
+      end
+
+      it "is not 3rd thursday" do
+        (date.nth_wday?(3, 4)).should be(false)
+      end
+
+      it "is not 4th friday" do
+        (date.nth_wday?(4, 5)).should be(false)
+      end
+    end
+  end
+
+  describe "#nth_of_wday" do
+    context "when Jan 1st passed" do
+      let(:nth_of_wday) { Date.parse('2015-01-01').nth_of_wday }
+
+      it "returns a number" do
+        expect(nth_of_wday).to be_a(Fixnum)
+      end
+
+      it "returns 1" do
+        expect(nth_of_wday).to be(1)
+      end
+    end
+
+    context "when Feb 24th passed" do
+      let(:nth_of_wday) { Date.parse('2015-02-24').nth_of_wday }
+
+      it "returns a number" do
+        expect(nth_of_wday).to be_a(Fixnum)
+      end
+
+      it "returns 4" do
+        expect(nth_of_wday).to be(4)
+      end
+    end
+
+    context "when March 31st passed" do
+      let(:nth_of_wday) { Date.parse('2015-03-31').nth_of_wday }
+
+      it "returns a number" do
+        expect(nth_of_wday).to be_a(Fixnum)
+      end
+
+      it "returns 5" do
+        expect(nth_of_wday).to be(5)
+      end
+    end
+  end
+
+  describe "#wday_named" do
+    it "parses full weekday names" do
+      expect(NthDay.wday_named("Monday")).to be(1)
+      expect(NthDay.wday_named("Tuesday")).to be(2)
+      expect(NthDay.wday_named("Wednesday")).to be(3)
+    end
+
+    it "parses shortened names" do
+      expect(NthDay.wday_named("Thurs")).to be(4)
+      expect(NthDay.wday_named("Fri")).to be(5)
+    end
+
+    it "doesn't care about case" do
+      expect(NthDay.wday_named("MON")).to be(1)
+    end
+
+    it "even works with 2 character names" do
+      expect(NthDay.wday_named("Su")).to be(0)
+      expect(NthDay.wday_named("Sa")).to be(6)
+    end
+
+    it "does require at least 2 chars" do
+      expect(NthDay.wday_named("S")).to be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'nth_day'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    # Enable both expect() and .should syntax
+    expectations.syntax = [:should, :expect]
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: nth_day
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dolan Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Nth day allows you to specify dates in the format "1st Tuesday", and
+  have returned a date for the next occurrence of that day.
+email:
+- admin@dmur.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nth_day.rb
+- lib/nth_day/version.rb
+- nth_day.gemspec
+- spec/nth_day_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dmur/nth-day
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Query for the next nth weekday of the month.
+test_files:
+- spec/nth_day_spec.rb
+- spec/spec_helper.rb