monthify 0.0.1

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in month.gemspec
+gemspec
+
+gem 'rspec'
+gem 'activesupport'
+gem 'guard'
+gem 'guard-rspec'
+gem 'rb-fsevent'

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Matt Royal
+
+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,29 @@
+# Monthify
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'monthify'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install monthify
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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

data/Rakefile

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

data/lib/monthify/core_ext/object.rb

@@ -0,0 +1,13 @@
+module Monthify
+  module CoreExt
+    module Object
+      def to_month
+        ::Kernel::Month(self)
+      end
+    end
+  end
+end
+
+class ::Object
+  include Monthify::CoreExt::Object
+end

data/lib/monthify/core_ext.rb

@@ -0,0 +1,6 @@
+require 'monthify/core_ext/object'
+
+module Monthify
+  module CoreExt
+  end
+end

data/lib/monthify/month.rb

@@ -0,0 +1,104 @@
+require "active_support/core_ext"
+
+module Monthify
+  class Month
+    include Comparable
+
+    attr_reader :month, :year
+
+    def self.current
+      today = Date.current
+      new(today.year, today.month)
+    end
+
+    def self.containing(datish)
+      Month.new(datish.year, datish.month)
+    end
+
+    def self.load(date_yaml)
+      date = YAML.load(date_yaml)
+      Month.containing(date)
+    end
+
+    def self.dump(month)
+      YAML.dump(month.first_day)
+    end
+
+    def initialize(year, month)
+      @year, @month = year, month
+    end
+
+    def first_day
+      Date.new(year, month, 1)
+    end
+
+    def last_day
+      first_day.end_of_month
+    end
+
+    def first_moment
+      first_day.beginning_of_day
+    end
+
+    def last_moment
+      last_day.end_of_day
+    end
+
+    def previous
+      self - 1.month
+    end
+
+    def next
+      self + 1.month
+    end
+
+    def date_range
+      Range.new(first_day, last_day)
+    end
+
+    def time_range
+      Range.new(first_moment, last_moment)
+    end
+
+    def contains?(datish)
+      date = datish.to_date
+      year == date.year && month == date.month
+    end
+
+    def +(duration)
+      Month.containing(first_day + duration)
+    end
+
+    def -(duration)
+      Month.containing(first_day - duration)
+    end
+
+    def <=>(other)
+      if year == other.year
+        month <=> other.month
+      else
+        year <=> other.year
+      end
+    end
+
+    def hash
+      [self.class, year, month].hash
+    end
+
+    def to_s
+      "%d/%02d" % [year, month]
+    end
+  end
+end
+
+module ::Kernel
+  def Month(convertee)
+    if convertee.is_a?(Month)
+      convertee
+    elsif convertee.respond_to?(:to_date)
+      Month.containing(convertee.to_date)
+    else
+      raise ArgumentError, "Don't know how to convert #{convertee.inspect} to Month"
+    end
+  end
+end

data/lib/monthify/version.rb

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

data/lib/monthify.rb

@@ -0,0 +1,7 @@
+require 'monthify/version'
+require 'monthify/month'
+require 'monthify/core_ext'
+
+module Monthify
+  ::Month = Monthify::Month
+end

data/monthify.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'monthify/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "monthify"
+  gem.version       = Monthify::VERSION
+  gem.authors       = ["Matt Royal"]
+  gem.email         = ["mroyal@gmail.com"]
+  gem.description   = %q{The missing Month class every project ends up needing}
+  gem.summary       = %q{}
+  gem.homepage      = "https://github.com/matt-royal/monthify"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('activesupport')
+end

data/spec/lib/monthify/core_ext/object_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'monthify'
+
+
+describe Monthify::CoreExt::Object do
+  it 'is included in Object' do
+    Object.should be_a(Monthify::CoreExt::Object)
+  end
+end
+
+describe ::Object do
+  describe "#to_month" do
+    it 'returns the result of Kernel::Month()' do
+      receiver = ::Object.new
+      result = double(:result)
+
+      ::Kernel.should_receive(:Month).with(receiver).
+        and_return(result)
+      receiver.to_month.should == result
+    end
+  end
+end

data/spec/lib/monthify/month_spec.rb

@@ -0,0 +1,253 @@
+require 'spec_helper'
+require 'monthify'
+
+describe Month do
+  describe '.current' do
+    it 'is the current month' do
+      Month.current.month.should == Date.current.month
+      Month.current.year.should == Date.current.year
+    end
+  end
+
+  describe '.containing' do
+    it 'returns the month containing the date' do
+      Month.containing(Date.new(2011, 1, 15)).should == Month.new(2011, 1)
+    end
+
+    it 'returns the month containing the time' do
+      Month.containing(Time.local(2012, 3, 15, 6, 9)).should == Month.new(2012, 3)
+    end
+  end
+
+  context 'serialization:' do
+    describe '.load' do
+      it 'converts date YAML into a Month' do
+        date_yaml = YAML.dump(Date.new(2011, 5, 22))
+        Month.load(date_yaml).should == Month.new(2011, 5)
+      end
+    end
+
+    describe '.dump' do
+      it 'converts a Month to the YAML representation of its first day' do
+        Month.dump(Month.new(2013, 8)).should == YAML.dump(Date.new(2013, 8, 1))
+      end
+    end
+
+  end
+
+  describe "#initialize" do
+    it 'sets month and year' do
+      Month.new(2012,1).month.should == 1
+      Month.new(2012,1).year.should == 2012
+    end
+  end
+
+  describe "#first_day" do
+    it 'is the first day of the month' do
+      Month.new(2011, 7).first_day.should == Date.new(2011, 7, 1)
+    end
+  end
+
+  describe "#last_day" do
+    it 'is the last day of the month' do
+      Month.new(2011, 7).last_day.should == Date.new(2011, 7, 31)
+      Month.new(2011, 2).last_day.should == Date.new(2011, 2, 28)
+    end
+  end
+
+
+  describe "#first_moment" do
+    it 'is the time at the start of the first day of the month' do
+      Month.new(2011, 7).first_moment.should == Time.local(2011, 7, 1, 0, 0, 0, 0)
+    end
+  end
+
+  describe "#last_moment" do
+    it 'is the time at the end of the last day of the month' do
+      Month.new(2011, 7).last_moment.usec.should == 999_999
+      Month.new(2011, 7).last_moment.should == Time.local(2011, 7, 31).end_of_day
+    end
+  end
+
+  describe "#next" do
+    it 'is the next month' do
+      Month.new(2011, 11).next.should == Month.new(2011, 12)
+      Month.new(2011, 12).next.should == Month.new(2012, 1)
+    end
+  end
+
+  describe "#previous" do
+    it 'is the previous month' do
+      Month.new(2011, 2).previous.should == Month.new(2011, 1)
+      Month.new(2011, 1).previous.should == Month.new(2010, 12)
+    end
+  end
+
+  describe "#date_range" do
+    let(:month) { Month.new(2011, 3) }
+
+    it 'is the range of days in the month' do
+      month.date_range.should == Range.new(month.first_day, month.last_day)
+    end
+  end
+
+  describe "#time_range" do
+    let(:month) { Month.new(2011, 3) }
+
+    it 'is the range of times from the start to the end of the month' do
+      Month.new(2011, 3).time_range.should == Range.new(month.first_moment, month.last_moment)
+    end
+  end
+
+  describe "#contains?" do
+    let(:month) { Month.new(2012, 6) }
+    subject { month.contains?(datish) }
+
+    context 'with a Date in the month' do
+      let(:datish) { Date.new(2012, 6, 7) }
+      it { should == true }
+    end
+
+    context 'with a Date in another month' do
+      let(:datish) { Date.new(2012, 7, 1) }
+      it { should == false }
+    end
+
+    context 'with a Time in the month' do
+      let(:datish) { Time.local(2012, 6, 7, 12, 30) }
+      it { should == true }
+    end
+
+    context 'with a Time in another month' do
+      let(:datish) { Time.local(2012, 7, 1, 0, 0) }
+      it { should == false }
+    end
+
+    context 'with an object that has a #to_date in the month' do
+      let(:datish) {
+        double(:datish_in_month, to_date: Date.new(2012, 6, 7))
+      }
+      it { should == true }
+    end
+
+    context 'with an object that has a #to_date in another month' do
+      let(:datish) {
+        double(:datish_in_another_month, to_date: Date.new(2012, 7, 1))
+      }
+
+      it { should == false }
+    end
+  end
+
+  describe "comparison:" do
+    let(:dec_2010) { Month.new(2010, 12) }
+    let(:jan_2011) { Month.new(2011, 1) }
+    let(:jan_2011_dup) { Month.new(2011, 1) }
+    let(:feb_2011) { Month.new(2011, 2) }
+
+    describe "==" do
+      it 'is true for two copies of the same month' do
+        jan_2011.should == jan_2011_dup
+      end
+      it 'is false for a different month' do
+        jan_2011.should_not == feb_2011
+      end
+      it 'is false for a non-month' do
+        jan_2011.should_not == Object.new
+      end
+    end
+
+    describe '<=>' do
+      it 'is 0 for the same month' do
+        (jan_2011 <=> jan_2011_dup).should == 0
+      end
+
+      it 'is 1 for an earlier month' do
+        (jan_2011 <=> dec_2010).should == 1
+      end
+
+      it 'is -1 for a later month' do
+        (jan_2011 <=> feb_2011).should == -1
+      end
+    end
+
+    it 'is Comparable' do
+      Month.current.should be_a(Comparable)
+    end
+  end
+
+  describe "+" do
+    let(:month) { Month.new(2012, 8) }
+
+    it 'correctly adds month durations' do
+      (month + 1.month).should == month.next
+      (month + 6.months).should == Month.new(2013, 2)
+    end
+
+    it 'correctly adds year durations' do
+      (month + 1.year).should == Month.new(2013, 8)
+      (month + 50.years).should == Month.new(2062, 8)
+    end
+  end
+
+  describe "-" do
+    let(:month) { Month.new(2012, 8) }
+
+    it 'correctly subtracts month durations' do
+      (month - 1.month).should == month.previous
+      (month - 6.months).should == Month.new(2012, 2)
+    end
+
+    it 'correctly subtracts year durations' do
+      (month - 1.year).should == Month.new(2011, 8)
+      (month - 50.years).should == Month.new(1962, 8)
+    end
+  end
+
+  describe "#hash" do
+    it 'is the same for two equal months' do
+      Month.new(2010, 3).hash.should == Month.new(2010, 3).hash
+    end
+
+    it 'is different for two different months' do
+      Month.new(2010, 3).hash.should_not == Month.new(2000, 1).hash
+    end
+  end
+
+  describe "#to_s" do
+    it 'is in the format YYYY/MM' do
+      Month.new(2010, 2).to_s.should == '2010/02'
+    end
+  end
+
+  describe "Kernel::Month()" do
+    it 'returns Month objects unchanged' do
+      month = Month.current
+      Kernel::Month(month).should == month
+      Kernel::Month(month).should eq month
+    end
+
+    it 'converts a date to its Month' do
+      Kernel::Month(Date.current).should == Month.current
+    end
+
+    it 'converts a time to its Month' do
+      Kernel::Month(Time.now).should == Month.current
+    end
+
+    it 'converts an object that has a date representation to the right Month' do
+      datish = double(:datish, to_date: Date.new(2001, 4))
+      Kernel::Month(datish).should == Month.new(2001, 4)
+    end
+
+    it 'raises for other inputs' do
+      expect {
+        Kernel::Month(0)
+      }.to raise_exception(ArgumentError)
+
+      expect {
+        Kernel::Month(nil)
+      }.to raise_exception(ArgumentError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: monthify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matt Royal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The missing Month class every project ends up needing
+email:
+- mroyal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/monthify.rb
+- lib/monthify/core_ext.rb
+- lib/monthify/core_ext/object.rb
+- lib/monthify/month.rb
+- lib/monthify/version.rb
+- monthify.gemspec
+- spec/lib/monthify/core_ext/object_spec.rb
+- spec/lib/monthify/month_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/matt-royal/monthify
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/lib/monthify/core_ext/object_spec.rb
+- spec/lib/monthify/month_spec.rb
+- spec/spec_helper.rb