month 1.3.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 074b88d35639de246321396e3deb7986c75d0e6e
-  data.tar.gz: 4a359d04e6abb0cde293420bc6193234d47b9c8e
+SHA256:
+  metadata.gz: c6f2cb49e56df71efa50a5d0b1d0defa911997bb7b1f064ce4820cbb171d64b7
+  data.tar.gz: 3d16daecccc4d6b4a8287e870f6114d51e148478aa7f26bf295a805020f9b670
 SHA512:
-  metadata.gz: 2f41916e6b14eab832a57b778ac39b988346e2554a313228e2c8affe4a944605ad503954fcb9aae43d77ef6b04fe0a046489e65db967e7f7f7fa7836785035bf
-  data.tar.gz: d8ce70bc5f52728efce01d298fdec98a5312549236ad9458e9950cb16cd71bb1cd5b61878b324d5db2a9a7c7284f6fd302540118b6901cdbce86c305cdf25dd5
+  metadata.gz: 9dcaed88e8f32858f302b14369a7f095bbe5e237d89599ed74bd430956946e3297c52eba4f639b94b17b7f8b9060e7b208d4360d3f8812f2ab2fc41a7970dc62
+  data.tar.gz: 6d0627f52ef61f665be335c66734cf9e0fcce5d0751bf9bf08c07aaf195b6209fb970cf0696625d3667dce68350fcc7c55e34fbb7b2c7ba45bdf13acc14a5de0

data/CHANGES.md

@@ -0,0 +1,53 @@
+# 1.7.1
+
+* Added CHANGES.md to gem files
+
+* Fixed outdated changelog_uri
+
+# 1.7.0
+
+* Added optional YAML integration
+
+This makes it possible to dump/load month objects to/from YAML as scalar values. For example:
+
+    require 'month/yaml'
+
+    puts YAML.dump([Month.today])
+
+This functionality is not enabled by default, due to the use of Module#prepend.
+
+# 1.6.0
+
+* Added Month#month alias for Month#number
+
+* Added Month#iso8601 alias for Month#to_s
+
+# 1.5.0
+
+* Added Month#<< and Month#>> methods (@pboling)
+
+* Added Month.today method
+
+* Added Month.now method
+
+# 1.4.0
+
+* Fixed comparison with nil objects / ActiveRecord serialization
+
+# 1.3.0
+
+* Month objects are now frozen on initialization (@replaid, #4)
+
+# 1.2.0
+
+* Added step argument to Month#step and upto/downto methods (@jkr2255, #3)
+
+# 1.1.0
+
+* Fixed fence-post error with addition (@fhwang, #2)
+
+* Added subtraction functionality for calculating number of months between two month objects (@aprikip, #1)
+
+# 1.0.0
+
+* New version!

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright the authors and contributors. All rights reserved.
+Copyright (c) 2014-2020 TIMCRAFT
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -1,12 +1,19 @@
 # month
 
-[![Gem Version](https://badge.fury.io/rb/month.svg)](https://badge.fury.io/rb/month) [![Build Status](https://api.travis-ci.org/timcraft/month.svg?branch=master)](https://travis-ci.org/timcraft/month)
+![Gem Version](https://badge.fury.io/rb/month.svg)
+![Build Status](https://github.com/readysteady/month/workflows/Test/badge.svg)
 
 
-A little Ruby library for working with months.
+Ruby gem for working with months.
 
 
-## Installation
+## Install
+
+Using Bundler:
+
+    $ bundle add month
+
+Using RubyGems:
 
     $ gem install month
 

data/lib/month.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'date'
 
 class Month
@@ -17,7 +18,7 @@ class Month
   }
 
   def initialize(year, number)
-    unless NAMES.has_key?(number)
+    unless NAMES.key?(number)
       raise ArgumentError, 'invalid month number'
     end
 
@@ -28,10 +29,14 @@ class Month
 
   attr_reader :year, :number
 
+  alias_method :month, :number
+
   def to_s
     "#@year-#{@number.to_s.rjust(2, '0')}"
   end
 
+  alias_method :iso8601, :to_s
+
   def name
     NAMES.fetch(@number)
   end
@@ -51,6 +56,8 @@ class Month
   end
 
   def <=>(month)
+    return unless month.class == self.class
+
     if @year == month.year
       @number <=> month.number
     else
@@ -70,6 +77,18 @@ class Month
 
   alias_method :succ, :next
 
+  def >>(n)
+    self + n
+  end
+
+  alias_method :next_month, :>>
+
+  def <<(n)
+    self - n
+  end
+
+  alias_method :prev_month, :<<
+
   def step(limit, step = 1)
     raise ArgumentError if step.zero?
 
@@ -112,7 +131,7 @@ class Month
     if object.is_a?(Integer)
       self + (-object)
     else
-      (year * 12 + @number) - (object.year * 12 + object.number)
+      12 * (year - object.year) + (@number - object.number)
     end
   end
 
@@ -139,11 +158,17 @@ class Month
   end
 end
 
-def Month.parse(string)
-  if string =~ /\A(\d{4})-(\d{2})\z/
-    Month.new($1.to_i, $2.to_i)
-  else
-    raise ArgumentError, 'invalid month'
+class Month
+  REGEXP = /\A(\d{4})-(\d{2})\z/
+
+  private_constant :REGEXP
+
+  def self.parse(string)
+    if string =~ REGEXP
+      Month.new($1.to_i, $2.to_i)
+    else
+      raise ArgumentError, 'invalid month'
+    end
   end
 end
 
@@ -158,6 +183,14 @@ def Month(object)
   end
 end
 
+def Month.today
+  Month(Date.today)
+end
+
+def Month.now
+  Month(Time.now)
+end
+
 class Month
   module Methods
     NAMES.each do |number, name|

data/lib/month/yaml.rb

@@ -0,0 +1,23 @@
+require 'yaml'
+
+class Month
+  def encode_with(coder)
+    coder.represent_scalar(nil, to_s)
+  end
+
+  module ScalarScannerPatch
+    REGEXP = /\A(\d{4})-(\d{2})\z/
+
+    def tokenize(string)
+      if !string.empty? && string.match(REGEXP)
+        return Month.new($1.to_i, $2.to_i)
+      end
+
+      super string
+    end
+
+    YAML::ScalarScanner.prepend(self)
+  end
+
+  private_constant :ScalarScannerPatch
+end

data/month.gemspec

@@ -1,16 +1,20 @@
 Gem::Specification.new do |s|
   s.name = 'month'
-  s.version = '1.3.0'
+  s.version = '1.7.1'
   s.license = 'MIT'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
-  s.homepage = 'http://github.com/timcraft/month'
-  s.description = 'A little Ruby library for working with months'
+  s.homepage = 'https://github.com/readysteady/month'
+  s.description = 'Ruby gem for working with months'
   s.summary = 'See description'
-  s.files = Dir.glob('{lib,spec}/**/*') + %w(LICENSE.txt README.md month.gemspec)
+  s.files = Dir.glob('lib/**/*.rb') + %w[CHANGES.md LICENSE.txt README.md month.gemspec]
   s.required_ruby_version = '>= 1.9.3'
-  s.add_development_dependency('rake', '~> 10.0')
-  s.add_development_dependency('minitest', '~> 5.0')
   s.require_path = 'lib'
+  s.metadata = {
+    'homepage' => 'https://github.com/readysteady/month',
+    'source_code_uri' => 'https://github.com/readysteady/month',
+    'bug_tracker_uri' => 'https://github.com/readysteady/month/issues',
+    'changelog_uri' => 'https://github.com/readysteady/month/blob/main/CHANGES.md'
+  }
 end

metadata

@@ -1,60 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: month
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.7.1
 platform: ruby
 authors:
 - Tim Craft
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-09 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-description: A little Ruby library for working with months
+date: 2020-11-03 00:00:00.000000000 Z
+dependencies: []
+description: Ruby gem for working with months
 email:
 - mail@timcraft.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGES.md
 - LICENSE.txt
 - README.md
 - lib/month.rb
+- lib/month/yaml.rb
 - month.gemspec
-- spec/month_spec.rb
-homepage: http://github.com/timcraft/month
+homepage: https://github.com/readysteady/month
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage: https://github.com/readysteady/month
+  source_code_uri: https://github.com/readysteady/month
+  bug_tracker_uri: https://github.com/readysteady/month/issues
+  changelog_uri: https://github.com/readysteady/month/blob/main/CHANGES.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -69,9 +46,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: See description
 test_files: []

data/spec/month_spec.rb

@@ -1,315 +0,0 @@
-require 'minitest/autorun'
-
-require_relative '../lib/month'
-
-describe 'Month' do
-  describe 'constructor' do
-    it 'raises an exception when initialized with an invalid number' do
-      proc { Month.new(2014, 0) }.must_raise(ArgumentError)
-      proc { Month.new(2014, 100) }.must_raise(ArgumentError)
-    end
-
-    it 'returns frozen instances' do
-      month = Month.new(2017, 1)
-      month.frozen?.must_equal(true)
-    end
-  end
-
-  describe 'year method' do
-    it 'returns the integer year of the month' do
-      Month.new(2014, 1).year.must_equal(2014)
-    end
-  end
-
-  describe 'number method' do
-    it 'returns the integer number of the month' do
-      Month.new(2014, 1).number.must_equal(1)
-    end
-  end
-
-  describe 'to_s method' do
-    it 'returns a string containing the year and zero padded number of the month' do
-      Month.new(2014, 1).to_s.must_equal('2014-01')
-    end
-  end
-
-  describe 'name method' do
-    it 'returns the name of the month' do
-      Month.new(2014, 1).name.must_equal(:January)
-    end
-  end
-
-  describe 'january predicate method' do
-    it 'returns true if the month is january' do
-      Month.new(2014, 1).january?.must_equal(true)
-    end
-
-    it 'returns false otherwise' do
-      Month.new(2014, 2).january?.must_equal(false)
-    end
-  end
-
-  describe 'february predicate method' do
-    it 'returns true if the month is february' do
-      Month.new(2014, 2).february?.must_equal(true)
-    end
-
-    it 'returns false otherwise' do
-      Month.new(2014, 1).february?.must_equal(false)
-    end
-  end
-
-  it 'supports being used as a hash key' do
-    hash, n = Hash.new(0), 10
-
-    n.times { hash[Month.new(2014, 1)] += 1 }
-
-    hash.count.must_equal(1)
-    hash[Month.new(2014, 1)].must_equal(n)
-  end
-
-  it 'supports comparison between month objects' do
-    Month.new(2014, 1).must_be_kind_of(Comparable)
-
-    (Month.new(2014, 1) == Month.new(2014, 1)).must_equal(true)
-    (Month.new(2014, 1) == Month.new(2014, 2)).must_equal(false)
-
-    (Month.new(2014, 1) < Month.new(2014, 2)).must_equal(true)
-    (Month.new(2014, 2) > Month.new(2014, 1)).must_equal(true)
-  end
-
-  it 'supports being used in a range' do
-    range = Month.new(2014, 1) .. Month.new(2014, 4)
-
-    range.map(&:number).must_equal([1, 2, 3, 4])
-  end
-
-  describe 'next method' do
-    it 'returns a month object denoting the next month' do
-      Month.new(2014, 1).next.must_equal(Month.new(2014, 2))
-      Month.new(2014, 12).next.must_equal(Month.new(2015, 1))
-    end
-  end
-
-  describe 'succ method' do
-    it 'returns a month object denoting the next month' do
-      Month.new(2014, 1).succ.must_equal(Month.new(2014, 2))
-      Month.new(2014, 12).succ.must_equal(Month.new(2015, 1))
-    end
-  end
-
-  describe 'step method' do
-    it 'calls the block for every month until the given limit' do
-      months = []
-
-      Month.new(2014, 1).step(Month.new(2014, 3)) { |month| months << month }
-
-      months.must_equal([Month.new(2014, 1), Month.new(2014, 2), Month.new(2014, 3)])
-    end
-
-    it 'returns an enumerator if no block was given' do
-      months = Month.new(2014, 1).step(Month.new(2014, 3))
-
-      months.must_be_instance_of(Enumerator)
-
-      months.next.must_equal(Month.new(2014, 1))
-      months.next.must_equal(Month.new(2014, 2))
-      months.next.must_equal(Month.new(2014, 3))
-    end
-
-    it 'raises an exception when the given step argument is zero' do
-      proc { Month.new(2014, 1).step(Month.new(2014, 3), 0) }.must_raise(ArgumentError)
-    end
-
-    it 'increases by the given number of months if the step argument is positive' do
-      months = []
-
-      Month.new(2014, 1).step(Month.new(2014, 3), 2) { |month| months << month }
-
-      months.must_equal([Month.new(2014, 1), Month.new(2014, 3)])
-    end
-
-    it 'decreases by the given number of months if the step argument is negative' do
-      months = []
-
-      Month.new(2014, 3).step(Month.new(2014, 1), -1) { |month| months << month }
-
-      months.must_equal([Month.new(2014, 3), Month.new(2014, 2), Month.new(2014, 1)])
-    end
-  end
-
-  describe 'upto method' do
-    it 'calls the block for every month until the given limit' do
-      months = []
-
-      Month.new(2014, 1).upto(Month.new(2014, 3)) { |month| months << month }
-
-      months.must_equal([Month.new(2014, 1), Month.new(2014, 2), Month.new(2014, 3)])
-    end
-
-    it 'returns an enumerator if no block was given' do
-      months = Month.new(2014, 1).upto(Month.new(2014, 3))
-
-      months.must_be_instance_of(Enumerator)
-
-      months.next.must_equal(Month.new(2014, 1))
-      months.next.must_equal(Month.new(2014, 2))
-      months.next.must_equal(Month.new(2014, 3))
-    end
-  end
-
-  describe 'downto method' do
-    it 'calls the block for every month until the given limit' do
-      months = []
-
-      Month.new(2014, 3).downto(Month.new(2014, 1)) { |month| months << month }
-
-      months.must_equal([Month.new(2014, 3), Month.new(2014, 2), Month.new(2014, 1)])
-    end
-
-    it 'returns an enumerator if no block was given' do
-      months = Month.new(2014, 3).downto(Month.new(2014, 1))
-
-      months.must_be_instance_of(Enumerator)
-
-      months.next.must_equal(Month.new(2014, 3))
-      months.next.must_equal(Month.new(2014, 2))
-      months.next.must_equal(Month.new(2014, 1))
-    end
-  end
-
-  describe 'addition' do
-    it 'returns a month object denoting the given number of months after self' do
-      (Month.new(2014, 1) + 1).must_equal(Month.new(2014, 2))
-      (Month.new(2014, 1) + 12).must_equal(Month.new(2015, 1))
-      (Month.new(2014, 1) + 18).must_equal(Month.new(2015, 7))
-      (Month.new(2013, 11) + 1).must_equal(Month.new(2013, 12))
-      (Month.new(2013, 11) + 2).must_equal(Month.new(2014, 1))
-    end
-  end
-
-  describe 'subtraction' do
-    it 'returns a month object denoting the given number of months before self' do
-      (Month.new(2014, 2) - 1).must_equal(Month.new(2014, 1))
-      (Month.new(2014, 1) - 1).must_equal(Month.new(2013, 12))
-      (Month.new(2014, 1) - 12).must_equal(Month.new(2013, 1))
-      (Month.new(2014, 1) - 18).must_equal(Month.new(2012, 7))
-      (Month.new(2013, 12) - 1).must_equal(Month.new(2013, 11))
-      (Month.new(2014, 1) - 2).must_equal(Month.new(2013, 11))
-    end
-
-    it 'returns the number of months between the given month and self' do
-      (Month.new(2014, 3) - Month.new(2014, 1)).must_equal(2)
-      (Month.new(2015, 1) - Month.new(2014, 1)).must_equal(12)
-      (Month.new(2077, 4) - Month.new(2070, 4)).must_equal(84)
-    end
-  end
-
-  describe 'include predicate method' do
-    it 'returns true if the month includes the given date' do
-      Month.new(2014, 1).include?(Date.new(2014, 1, 1)).must_equal(true)
-    end
-
-    it 'returns false otherwise' do
-      Month.new(2014, 1).include?(Date.new(2014, 2, 1)).must_equal(false)
-    end
-  end
-
-  describe 'case equals method' do
-    it 'returns true if the month includes the given date' do
-      (Month.new(2014, 1) === Date.new(2014, 1, 1)).must_equal(true)
-    end
-
-    it 'returns false otherwise' do
-      (Month.new(2014, 1) === Date.new(2014, 2, 1)).must_equal(false)
-    end
-  end
-
-  describe 'start_date method' do
-    it 'returns a date object denoting the first day of the month' do
-      Month.new(2014, 1).start_date.must_equal(Date.new(2014, 1, 1))
-    end
-  end
-
-  describe 'end_date method' do
-    it 'returns a date object denoting the last day of the month' do
-      Month.new(2014, 1).end_date.must_equal(Date.new(2014, 1, 31))
-    end
-  end
-
-  describe 'dates method' do
-    it 'returns the range of dates in the month' do
-      dates = Month.new(2014, 1).dates
-      dates.must_be_instance_of(Range)
-      dates.count.must_equal(31)
-      dates.all? { |date| Date === date }.must_equal(true)
-      dates.first.must_equal(Date.new(2014, 1, 1))
-      dates.last.must_equal(Date.new(2014, 1, 31))
-    end
-  end
-
-  describe 'length method' do
-    it 'returns the integer number of days in the month' do
-      Month.new(2014, 1).length.must_equal(31)
-      Month.new(2014, 2).length.must_equal(28)
-    end
-  end
-end
-
-describe 'Month parse method' do
-  it 'returns the month corresponding to the given string representation' do
-    Month.parse('2014-01').must_equal(Month.new(2014, 1))
-  end
-
-  it 'raises an exception if the format of the string is not as expected' do
-    proc { Month.parse('January 2014') }.must_raise(ArgumentError)
-  end
-end
-
-describe 'Month method' do
-  it 'returns the month of the given date object' do
-    Month(Date.new(2014, 1, 1)).must_equal(Month.new(2014, 1))
-  end
-
-  it 'returns the month of the given time object' do
-    Month(Time.at(1234567890)).must_equal(Month.new(2009, 2))
-  end
-
-  it 'returns the month of the given datetime object' do
-    Month(DateTime.parse('2001-02-03T04:05:06+07:00')).must_equal(Month.new(2001, 2))
-  end
-
-  it 'returns the month of the given integer unix timestamp' do
-    Month(1234567890).must_equal(Month.new(2009, 2))
-  end
-
-  it 'idempotently returns the given month' do
-    month = Month.new(2014, 1)
-
-    Month(month).object_id.must_equal(month.object_id)
-  end
-end
-
-describe 'A method defined in Month::Methods' do
-  include Month::Methods
-
-  it 'returns a month object denoting that month in the given year' do
-    month = January 2014
-    month.must_equal(Month.new(2014, 1))
-
-    month = February 2014
-    month.must_equal(Month.new(2014, 2))
-  end
-
-  it 'returns a date object when given two arguments' do
-    date = January 31, 2014
-    date.must_equal(Date.new(2014, 1, 31))
-
-    date = February 28, 2014
-    date.must_equal(Date.new(2014, 2, 28))
-  end
-
-  it 'raises an exception if given too many arguments' do
-    proc { January 1, 2, 3 }.must_raise(ArgumentError)
-  end
-end