month 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4009cafb1322ac57f543f1890b413d8082e504720535272ea0de0fb73d82c184
-  data.tar.gz: fdc90cf876afdc7113d69c80fa1dad52a8d54a97d391ce75b3a500fc82e185a7
+  metadata.gz: 1a6feb44a5e36d189f65a6a36a07614431c718f31b894624abf1c0205d3e8728
+  data.tar.gz: 8da0fe2b68de33fd429a78c6115b37950c6e78c7facbdffbfd73397450c3ded4
 SHA512:
-  metadata.gz: 2c1b9f286ac469bfe6b2d1281a07085ca79e5305ed3ca22c39f7545c10ca0caae84b888a31be84dc75e9e823290ef847635d1c0ef1ef2b5c28055b8b68a4206e
-  data.tar.gz: b90587bf792e723dc9b59ef8814ffc6165e251c2da8afe596075f0667208781042c140f230707470df6fbdc2cdb3938ae7e426e7a869d206fcb43cd0f846bd1a
+  metadata.gz: 4b306459da507afde4a3b43894f04c09618414a62d4150dc3b9674dcd5634bd28ca92fe43911c55ca030615ec38964533d47e1d5debe5109f4503be6ea9026f3
+  data.tar.gz: f6e32498fd1528a6926a07e17b3c9d6b515aa98593ac9be3e35909fb981d247983b5bc5bbbb8aeeb1a5113593f7898f7a9c7ff45bd0cfffaa11fdd3bf1bcaa71

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2019 TIMCRAFT
+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,6 +1,7 @@
 # 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.

data/lib/month.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'date'
 
 class Month
@@ -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
@@ -153,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
 

data/month.gemspec

@@ -1,16 +1,20 @@
 Gem::Specification.new do |s|
   s.name = 'month'
-  s.version = '1.5.0'
+  s.version = '1.6.0'
   s.license = 'MIT'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
-  s.homepage = 'https://github.com/timcraft/month'
+  s.homepage = 'https://github.com/readysteady/month'
   s.description = 'A little Ruby library 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(LICENSE.txt README.md month.gemspec)
   s.required_ruby_version = '>= 1.9.3'
-  s.add_development_dependency('rake', '~> 12')
-  s.add_development_dependency('minitest', '~> 5')
   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/master/CHANGES.md'
+  }
 end

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: month
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5'
+date: 2020-04-27 00:00:00.000000000 Z
+dependencies: []
 description: A little Ruby library for working with months
 email:
 - mail@timcraft.com
@@ -49,11 +21,14 @@ files:
 - README.md
 - lib/month.rb
 - month.gemspec
-- spec/month_spec.rb
-homepage: https://github.com/timcraft/month
+homepage: https://github.com/readysteady/month
 licenses:
 - MIT
-metadata: {}
+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/master/CHANGES.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -69,7 +44,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: See description

data/spec/month_spec.rb

@@ -1,353 +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 comparison with nil' do
-    (Month.new(2014, 1) == nil).must_equal(false)
-  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 '>> method' do
-    it 'returns a month object denoting n months after' do
-      (Month.new(2014, 1) >> 5).must_equal(Month.new(2014, 6))
-      (Month.new(2014, 12) >> 5).must_equal(Month.new(2015, 5))
-      (Month.new(2014, 12) >> -5).must_equal(Month.new(2014, 7))
-    end
-  end
-
-  describe '<< method' do
-    it 'returns a month object denoting n months before' do
-      (Month.new(2014, 1) << 5).must_equal(Month.new(2013, 8))
-      (Month.new(2014, 12) << 5).must_equal(Month.new(2014, 7))
-      (Month.new(2014, 12) << -5).must_equal(Month.new(2015, 5))
-    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 'Month today method' do
-  let(:current_date) { Date.today }
-  let(:current_month) { Month.new(current_date.year, current_date.month) }
-
-  it 'returns the current month' do
-    Month.today.must_equal(current_month)
-  end
-end
-
-describe 'Month now method' do
-  let(:current_time) { Time.now }
-  let(:current_month) { Month.new(current_time.year, current_time.month) }
-
-  it 'returns the current month' do
-    Month.now.must_equal(current_month)
-  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