increments-schedule 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 501eab35a37755a0835d33c702bc318210c03cba
-  data.tar.gz: e3b4f292a2330768e3b339f351b158120e024ec1
+  metadata.gz: 9b8c9a536348bdcdb4ba014247949c1d75702d32
+  data.tar.gz: 897a83acff15520acd8894a84ad9f59b87b04c78
 SHA512:
-  metadata.gz: f3c1f0c47e3dbae0b1274b99135cc9483e2c032feafc39cf6edac3e9b23f38999eb553c85992c8dbab880fe4fa332c38dea45418898a782939de5d129772b2c7
-  data.tar.gz: 1e2a41b3290928493cc03a35cedbaa4d7e044c44da87e3c7b06f8217a9e8e63ca0ceaaeb5b81848e4c7d46c229fc739210375f89ba26f2a1e546cd23125eb9c3
+  metadata.gz: a264fc1c3822c9c9576eef0be7bff725965fdd5ab7614de7238c30a12f079e5e92d91f453920f5dfe8065ac43b0e7312ccce6e8cf66b8ac27937626f30f805fd
+  data.tar.gz: a40ad96539b574c50eae7ed418bb4b2e9a0410583ccf22b46ea64df02c86ecd687840953113e95b756a8ba66a99e8742beb35f54227b6fcb47b9deb85df02d07

data/README.md

@@ -16,19 +16,43 @@ gem 'increments-schedule'
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install increments-schedule
-
-## Usage
+```bash
+$ gem install increments-schedule
+```
 
-* `Increments::Schedule.each_super_hanakin`
-* `Increments::Schedule.each_pay_day`
-* `Increments::Schedule.each_remote_work_day`
-* `Increments::Schedule.each_normal_remote_work_day`
-* `Increments::Schedule.each_special_remote_work_day`
+## APIs
+
+### Predicate Methods
+
+* `Increments::Schedule.super_hanakin?(date)`
+* `Increments::Schedule.pay_day?(date)`
+* `Increments::Schedule.work_day?(date)`
+* `Increments::Schedule.office_work_day?(date)`
+* `Increments::Schedule.remote_work_day?(date)`
+* `Increments::Schedule.normal_remote_work_day?(date)`
+* `Increments::Schedule.special_remote_work_day?(date)`
+* `Increments::Schedule.rest_day?(date)`
+* `Increments::Schedule.weekend?(date)`
+* `Increments::Schedule.holiday?(date)`
+
+### Enumeration Methods
+
+* `Increments::Schedule.each_super_hanakin(max_date = Date.today + 365)`
+* `Increments::Schedule.each_pay_day(max_date = Date.today + 365)`
+* `Increments::Schedule.each_work_day(max_date = Date.today + 365)`
+* `Increments::Schedule.each_office_work_day(max_date = Date.today + 365)`
+* `Increments::Schedule.each_remote_work_day(max_date = Date.today + 365)`
+* `Increments::Schedule.each_normal_remote_work_day(max_date = Date.today + 365)`
+* `Increments::Schedule.each_special_remote_work_day(max_date = Date.today + 365)`
+* `Increments::Schedule.each_rest_day(max_date = Date.today + 365)`
+* `Increments::Schedule.each_weekend(max_date = Date.today + 365)`
+* `Increments::Schedule.each_holiday(max_date = Date.today + 365)`
 
 ## Development
 

data/README.md.erb

@@ -0,0 +1,67 @@
+[![Gem Version](http://img.shields.io/gem/v/increments-schedule.svg?style=flat)](http://badge.fury.io/rb/increments-schedule)
+[![Dependency Status](http://img.shields.io/gemnasium/increments/increments-schedule.svg?style=flat)](https://gemnasium.com/increments/increments-schedule)
+[![Build Status](https://travis-ci.org/increments/increments-schedule.svg?branch=master&style=flat)](https://travis-ci.org/increments/increments-schedule)
+
+# Increments::Schedule
+
+Find out our special remote days and eagerly wait for them!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'increments-schedule'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install increments-schedule
+```
+
+## APIs
+
+### Predicate Methods
+
+<%=
+methods = Increments::Schedule.public_instance_methods.select do |method|
+  method.to_s.end_with?('?')
+end
+
+methods.map do |method|
+  "* `Increments::Schedule.#{method}(date)`"
+end.join("\n")
+%>
+
+### Enumeration Methods
+
+<%=
+methods = Increments::Schedule.public_instance_methods.select do |method|
+  method.to_s.start_with?('each_')
+end
+
+methods.map do |method|
+  "* `Increments::Schedule.#{method}(max_date = Date.today + 365)`"
+end.join("\n")
+%>
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/increments-schedule/fork )
+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 a new Pull Request

data/Rakefile

@@ -8,4 +8,37 @@ end
 
 RuboCop::RakeTask.new
 
-task ci: [:spec, :rubocop]
+desc 'Generate README.md from README.md.erb'
+task :readme do
+  puts 'Generating README.md...'
+  File.write('README.md', generate_readme)
+  puts 'Done.'
+end
+
+namespace :readme do
+  task :validate do
+    puts 'Validating README.md...'
+
+    unless File.read('README.md') == generate_readme
+      fail <<-END.gsub(/^\s+\|/, '').chomp
+        |README.md and README.md.erb are out of sync!
+        |If you need to modify the content of README.md:
+        |  * Edit README.md.erb.
+        |  * Run `bundle exec rake readme`.
+        |  * Commit both files.
+      END
+    end
+
+    puts 'Done.'
+  end
+end
+
+def generate_readme
+  require 'erb'
+  require 'increments/schedule'
+  readme = File.read('README.md.erb')
+  erb = ERB.new(readme, nil, '-')
+  erb.result(binding)
+end
+
+task ci: %w(spec rubocop readme:validate)

data/lib/increments/schedule.rb

@@ -5,30 +5,12 @@ module Increments
   module Schedule
     extend self # rubocop:disable ModuleFunction
 
-    [
-      [:each_super_hanakin,           :super_hanakin?],
-      [:each_pay_day,                 :pay_day?],
-      [:each_remote_work_day,         :remote_work_day?],
-      [:each_normal_remote_work_day,  :normal_remote_work_day?],
-      [:each_special_remote_work_day, :special_remote_work_day?]
-    ].each do |enumeration_method, predicate_method|
-      define_method(enumeration_method) do |max_date = nil, &block|
-        return to_enum(__method__, max_date) unless block
-
-        max_date ||= Date.today + 365
-
-        Date.today.upto(max_date) do |date|
-          block.call(date) if send(predicate_method, date)
-        end
-      end
-    end
-
     def super_hanakin?(date)
-      pay_day?(date) && date.friday?
+      date.friday? && pay_day?(date)
     end
 
     def pay_day?(date)
-      return !rest_day?(date) if date.day == 25
+      return work_day?(date) if date.day == 25
       next_basic_pay_day = Date.new(date.year, date.month, 25)
       next_basic_pay_day = next_basic_pay_day.next_month if date > next_basic_pay_day
       date.next_day.upto(next_basic_pay_day).all? do |date_until_basic_pay_day|
@@ -36,12 +18,20 @@ module Increments
       end
     end
 
+    def work_day?(date)
+      !rest_day?(date)
+    end
+
+    def office_work_day?(date)
+      work_day?(date) && !remote_work_day?(date)
+    end
+
     def remote_work_day?(date)
       normal_remote_work_day?(date) || special_remote_work_day?(date)
     end
 
     def normal_remote_work_day?(date)
-      date.monday? && !rest_day?(date)
+      date.monday? && work_day?(date)
     end
 
     def special_remote_work_day?(date)
@@ -49,10 +39,6 @@ module Increments
         !normal_office_work_day?(date - 1) && !normal_office_work_day?(date + 1)
     end
 
-    def office_work_day?(date)
-      !rest_day?(date) && !remote_work_day?(date)
-    end
-
     def rest_day?(date)
       weekend?(date) || holiday?(date)
     end
@@ -65,6 +51,20 @@ module Increments
       HolidayJapan.check(date)
     end
 
+    public_instance_methods.select { |name| name.to_s.end_with?('?') }.each do |predicate_method|
+      enumeration_method = 'each_' + predicate_method.to_s.sub(/\?\z/, '')
+
+      define_method(enumeration_method) do |max_date = nil, &block|
+        return to_enum(__method__, max_date) unless block
+
+        max_date ||= Date.today + 365
+
+        Date.today.upto(max_date) do |date|
+          block.call(date) if send(predicate_method, date)
+        end
+      end
+    end
+
     private
 
     def normal_office_work_day?(date)

data/lib/increments/schedule/version.rb

@@ -1,5 +1,5 @@
 module Increments
   module Schedule
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: increments-schedule
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Yuji Nakayama
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2015-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: holiday_japan
@@ -52,6 +52,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- README.md.erb
 - Rakefile
 - bin/console
 - bin/setup