nth_week_with_rules 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 374127cc6058286b380bc250993f13a62e968852
-  data.tar.gz: ea996afd125f19092f13480519263ae6c3c49a68
+SHA256:
+  metadata.gz: 37a3231942f64048c3a5a827dd1b89e9f1ca001df80816985c791fa95c9df796
+  data.tar.gz: 387b4eb799ec0bf11450c0b74af12d68ffcb6b3ee802250f41b4fb34a4d16665
 SHA512:
-  metadata.gz: 6459ce06b3e9a54d00e7cc44a923e8255e4424e18abe6ca2e49fb7cd07a330aa66208adbc0a7e653c568dc73a010f5b072821c0a7b0fdb70ff6db9fd4e98a7aa
-  data.tar.gz: 7383aaa90d1455f441f24a7d080c557530b66f6c4ffdc5fac2d5e513f878868b27082390447a4939fa9368849ed68ab37b2fb4a4f2243695cd3815652ce76cd0
+  metadata.gz: 5f35db9dcb49e3d29a2fc81f2efb714458c965ec419f543b2c966e8af6d843af110e2c941565a76503988c0eca30f29c3436f95e614ec0dc573dc41902a6e709
+  data.tar.gz: 940b8b5e92c290d365de81f1d7eba9ace2fc9f363de8414636ee96824a8861d075ed8cb6b6a8b398a383c184f4a75f465d84de4a3fda34b7f474717a0ecefd53

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 ka
+Copyright (c) 2016-2023 ka
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/nth_week_with_rules/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NthWeekWithRules
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/nth_week_with_rules.rb

@@ -1,33 +1,32 @@
+# frozen_string_literal: true
+
 require "nth_week_with_rules/version"
 
+# Additional features module to be included in `Date` class
 module NthWeekWithRules
-  # @param [Fixnum] first_wday 0, 1, 2, 3, 4, 5 or 6 (default is 0)
+  class InvalidMonthSelectError < StandardError; end
+
+  # @param [Integer] first_wday 0, 1, 2, 3, 4, 5 or 6 (default is 0)
   # @param [Symbol] month_select :normal, :before, :after, :many (default is :normal)
-  # @param [Fixnum] base 0 or 1 (default is 1)
-  # @return [Fixnum] An integer from 1 to 6 (from 0 to 5 if **base** is 0)
+  # @param [Integer] base 0 or 1 (default is 1)
+  # @return [Integer] An integer from 1 to 6 (from 0 to 5 if **base** is 0)
   def nth_week(first_wday: 0, month_select: :normal, base: 1)
-    start_date  = first_date_of_week(first_wday: first_wday)
-    end_date    = start_date + 7
+    start_date = first_date_of_week(first_wday: first_wday)
+    end_date = start_date + 7
 
     week = (start_date.day + 5) / 7
     case month_select
     when :normal
-      if start_date.month != end_date.month && self.month == end_date.month
-        week = 0
-      end
+      week = 0 if start_date.month != end_date.month && month == end_date.month
     when :before
       # Do nothing
     when :after
-      if start_date.month != end_date.month
-        week = 0
-      end
+      week = 0 if start_date.month != end_date.month
     when :many
       middle_date = start_date + 3
-      if start_date.month != end_date.month && middle_date.month == end_date.month
-        week = 0
-      end
+      week = 0 if start_date.month != end_date.month && middle_date.month == end_date.month
     else
-      # Error
+      raise InvalidMonthSelectError
     end
     base + week
   end
@@ -35,7 +34,7 @@ module NthWeekWithRules
   # @param [Fixnum] first_wday 0, 1, 2, 3, 4, 5 or 6 (default is 0)
   # @return [Date] first date of the week of this instance's date
   def first_date_of_week(first_wday: 0)
-    self - ((self.wday - first_wday) % 7)
+    self - ((wday - first_wday) % 7)
   end
 end
 

metadata

@@ -1,99 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: nth_week_with_rules
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - ka
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2016-04-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.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: test-unit-notify
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.13'
-- !ruby/object:Gem::Dependency
-  name: guard-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
+date: 2023-06-27 00:00:00.000000000 Z
+dependencies: []
 description: Calculate n-th week of the date with some rules
 email:
 - ka.kaosf@gmail.com
@@ -101,22 +17,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
-- Guardfile
 - LICENSE.txt
-- README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/nth_week_with_rules.rb
 - lib/nth_week_with_rules/version.rb
-- nth_week_with_rules.gemspec
 homepage: https://github.com/kaosf/nth_week_with_rules
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/kaosf/nth_week_with_rules
+  source_code_uri: https://github.com/kaosf/nth_week_with_rules
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -124,17 +34,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Calculate n-th week of the date with some rules
 test_files: []
-has_rdoc: 

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/Gemfile

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

data/Guardfile

@@ -1,7 +0,0 @@
-# vim: ft=ruby
-
-guard :minitest do
-  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
-  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
-  watch(%r{^test/test_helper\.rb$})      { 'test' }
-end

data/README.md

@@ -1,118 +0,0 @@
-# NthWeekWithRules
-
-Calculate n-th week of the date with some rules.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'nth_week_with_rules'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install nth_week_with_rules
-
-## Usage
-
-```ruby
-require 'nth_week_with_rules'
-
-date = Date.new(2016, 4, 1)
-
-date.nth_week #=> 1 (means 1st week of 2016-04)
-
-date.nth_week(month_select: before) #=> 5 (means 5th week of 2016-03)
-# :before option makes the method to take a before month
-# if the week is over 2 months.
-
-date = Date.new(2016, 3, 31)
-
-date.nth_week(month_select: :after) #=> 1 (means 1st week of 2016-04)
-# :after option makes the method to take a after month
-# if the week is over 2 months.
-
-date = Date.new(2016, 9, 1)
-
-date.nth_week(month_select: :many) #=> 5 (means 5th week of 2016-08)
-# :many option makes the method to take a month which has many days.
-# 2016-08-28, 2016-08-29, 2016-08-30, 2016-08-31: 4 days
-# 2016-09-01, 2016-09-02, 2016-09-03:             3 days
-
-date = Date.new(2016, 4, 30)
-
-date.nth_week(first_wday: 6) #=> 6 (means 6th week of 2016-04)
-# Do all calculations on the calendar that Saturday is the first wday.
-# If the first wday of a calendar is Saturday, 2016-04 becomes below:
-#
-# Sa Su Mo Tu We Th Fr
-#                    1
-#  2  3  4  5  6  7  8
-#  9 10 11 12 13 14 15
-# 16 17 18 19 20 21 22
-# 23 24 25 26 27 28 29
-# 30
-#
-# So 2016-04-01 is the 6th week of 2016-04.
-
-date = Date.new(2016, 4, 1)
-date.nth_week          #=> 1
-date.nth_week(base: 0) #=> 0
-# You can get 0 base indices. The default base is 1.
-```
-
-Of cource you can use a complex rule.
-
-```ruby
-date = Date.new(2016, 4, 1)
-date.nth_week(first_wday: 3, month_select: :before, base: 0) #=> 5
-```
-
-...Is it really correct? Yes!
-
-```
-# Start from Wednesday (wday 3)
-#
-#      March 2016
-# We Th Fr Sa Su Mo Tu
-#                    1  0th (start from 0th because of base 0 specification)
-#  2  3  4  5  6  7  8  1st
-#  9 10 11 12 13 14 15  2nd
-# 16 17 18 19 20 21 22  3rd
-# 23 24 25 26 27 28 29  4th
-# 30 31                 5th
-#
-#      April 2016
-# We Th Fr Sa Su Mo Tu
-#        1  2  3  4  5  0th (2016-04-01 is here! And select_month is :before)
-#  6  7  8  9 10 11 12  1st
-# 13 14 15 16 17 18 19  ...
-# 20 21 22 23 24 25 26
-# 27 28 29 30
-```
-
-So, 2016-04-01 is the 5th week of 2016-03.
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-Run `bundle exec guard` for the automatic testing.
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/kaosf/nth_week_with_rules.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
-Copyright (C) 2016 ka

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = Dir["test/**/test_*.rb"]
-  t.verbose = true
-end
-
-task default: :test

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "nth_week_with_rules"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/nth_week_with_rules.gemspec

@@ -1,28 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'nth_week_with_rules/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "nth_week_with_rules"
-  spec.version       = NthWeekWithRules::VERSION
-  spec.authors       = ["ka"]
-  spec.email         = ["ka.kaosf@gmail.com"]
-
-  spec.summary       = %q{Calculate n-th week of the date with some rules}
-  spec.description   = %q{Calculate n-th week of the date with some rules}
-  spec.homepage      = "https://github.com/kaosf/nth_week_with_rules"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 11.1"
-  spec.add_development_dependency "test-unit", "~> 3.1"
-  spec.add_development_dependency "test-unit-notify", "~> 1.0"
-  spec.add_development_dependency "guard", "~> 2.13"
-  spec.add_development_dependency "guard-minitest", "~> 2.4"
-end