month 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4eae90e4553fd130639c8f35f5feda52af6a7a4d56ec8631981fd0cadaa1895a
-  data.tar.gz: 76fb1049ecc66fdd30f145f7623ce978ea8606cd415dca8c20b63978af991b42
+  metadata.gz: df66639ee93dc9ca600737c9077b39990678aef7393d7830078ad21d86eb66cc
+  data.tar.gz: '060587dbe7b2d52ed383f6dcc0d81b631b399da160d0f1b3af373e131a174529'
 SHA512:
-  metadata.gz: 6d6ee334ce0de8c6162fb51ea14950e1d18fe085ce3818f290ab2a578a383853193c2f1606c16886dd978ee1bed750308d90a7eced6a24d7b62c3a1ed69cc71d
-  data.tar.gz: 15a1e39f3722c920152f3ae36301a149ddf520f7dce91b6591ed6b4c25cdcf5a2f46f6e2221651d8ff82007d93d4f1b46036d4d5fbb527006d646250e9324a47
+  metadata.gz: f9c7f9038cd81871fc28d3a9b3ac72e4df36368373dfb2bc31d31424c1b50b06ac1bd323fe4e2aa2768bcd22b6a766c0c0747862daa03e96c2c71abdbedc4732
+  data.tar.gz: dc1b91253191a21b1da51c563ac877083f84c7ab723cb3d69e2ca0ae4f81c007165589ae78b4bf9e0fd1ec345454f24a57a451d972f5e5056347d193b274ee63

data/CHANGES.md

@@ -1,6 +1,24 @@
+# 3.0.0
+
+* **Changed required_ruby_version to >= 3.0.0**
+
+* Added Month#deconstruct_keys method
+
+* Added Month#date_range alias for Month#dates
+
+* Added Month#start_time method and Month#end_time methods
+
+* Changed Month#name to return strings instead of symbols
+
+* Removed Month::NAMES constant
+
+# 2.1.0
+
+* Added Month#inspect method
+
 # 2.0.0
 
-* Changed required_ruby_version to >= 2.6.0
+* **Changed required_ruby_version to >= 2.6.0**
 
 * Fixed Month#next_month and Month#prev_month methods
 

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2022 TIMCRAFT
+Copyright (c) 2014-2026 TIMCRAFT
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -1,10 +1,6 @@
 # month
 
-![Gem Version](https://badge.fury.io/rb/month.svg)
-![Test Status](https://github.com/readysteady/month/actions/workflows/test.yml/badge.svg)
-
-
-Ruby gem for working with months.
+Ruby gem for working with calendar months.
 
 
 ## Install
@@ -114,13 +110,36 @@ The #length method returns the number of days in the month:
 Month.new(2014, 1).length  # 31
 ```
 
-Month objects can be used in case expressions.
+Month objects can be used in case expressions to match date/time objects:
+
+```ruby
+case datetime
+when month
+  puts "Date/time is in #{month}"
+end
+```
+
+Month objects can be used as hash keys for counting, grouping etc:
+
+```ruby
+totals = {
+  Month.new(2014, 1) => 0
+}
+```
+
+Month objects can be used in ranges:
+
+```ruby
+months = Month.new(2014, 1) .. Month.new(2014, 12)
+```
 
-Month objects can be used as hash keys.
+Month objects are comparable:
 
-Month objects can be used in ranges.
+```ruby
+Month.new(2014, 1) < Month.new(2014, 2)  # true
+```
 
-Month objects are comparable.
+Month objects are ractor-safe.
 
 
 ## Bonus extras

data/lib/month.rb

@@ -2,23 +2,12 @@
 require 'date'
 
 class Month
-  NAMES = {
-    1 => :January,
-    2 => :February,
-    3 => :March,
-    4 => :April,
-    5 => :May,
-    6 => :June,
-    7 => :July,
-    8 => :August,
-    9 => :September,
-    10 => :October,
-    11 => :November,
-    12 => :December
-  }
-
   def initialize(year, number)
-    unless NAMES.key?(number)
+    unless year.is_a?(Integer)
+      raise ArgumentError, 'invalid year'
+    end
+
+    unless number.is_a?(Integer) && number.between?(1, 12)
       raise ArgumentError, 'invalid month number'
     end
 
@@ -37,22 +26,37 @@ class Month
 
   alias_method :iso8601, :to_s
 
-  def name
-    NAMES.fetch(@number)
+  def inspect
+    "<Month: #{to_s}>"
   end
 
-  NAMES.each do |number, name|
-    define_method(:"#{name.downcase}?") do
-      @number == number
-    end
-  end
+  def name
+    Date::MONTHNAMES[@number]
+  end
+
+  def january?; @number == 1; end
+  def february?; @number == 2; end
+  def march?; @number == 3; end
+  def april?; @number == 4; end
+  def may?; @number == 5; end
+  def june?; @number == 6; end
+  def july?; @number == 7; end
+  def august?; @number == 8; end
+  def september?; @number == 9; end
+  def october?; @number == 10; end
+  def november?; @number == 11; end
+  def december?; @number == 12; end
 
   def hash
     [@year, @number].hash
   end
 
   def eql?(object)
-    object.class == self.class && object.hash == self.hash
+    object.class == self.class && object.year == @year && object.number == @number
+  end
+
+  def deconstruct_keys(keys)
+    {year: @year, number: @number}
   end
 
   def <=>(month)
@@ -143,6 +147,14 @@ class Month
 
   alias_method :===, :include?
 
+  def start_time
+    Time.new(@year, @number, 1, 0, 0, 0)
+  end
+
+  def end_time
+    Time.new(@year, @number, end_date.day, 23, 59, 59)
+  end
+
   def start_date
     Date.new(@year, @number, 1)
   end
@@ -155,6 +167,8 @@ class Month
     start_date .. end_date
   end
 
+  alias_method :date_range, :dates
+
   def length
     end_date.mday
   end
@@ -216,7 +230,9 @@ end
 
 class Month
   module Methods
-    NAMES.each do |number, name|
+    Date::MONTHNAMES.each_with_index do |name, number|
+      next if name.nil?
+
       define_method(name) do |*args|
         case args.length
         when 1

data/month.gemspec

@@ -1,15 +1,15 @@
 Gem::Specification.new do |s|
   s.name = 'month'
-  s.version = '2.0.0'
+  s.version = '3.0.0'
   s.license = 'MIT'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
-  s.email = ['mail@timcraft.com']
+  s.email = ['email@timcraft.com']
   s.homepage = 'https://github.com/readysteady/month'
-  s.description = 'Ruby gem for working with months'
-  s.summary = 'See description'
+  s.description = 'Ruby gem for working with calendar months'
+  s.summary = 'Ruby gem for working with calendar months'
   s.files = Dir.glob('lib/**/*.rb') + %w[CHANGES.md LICENSE.txt README.md month.gemspec]
-  s.required_ruby_version = '>= 2.6.0'
+  s.required_ruby_version = '>= 3.0.0'
   s.require_path = 'lib'
   s.metadata = {
     'homepage' => 'https://github.com/readysteady/month',

metadata

@@ -1,18 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: month
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Tim Craft
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: Ruby gem for working with months
+description: Ruby gem for working with calendar months
 email:
-- mail@timcraft.com
+- email@timcraft.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -31,7 +30,6 @@ metadata:
   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
@@ -39,15 +37,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
-summary: See description
+summary: Ruby gem for working with calendar months
 test_files: []