diter 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32f5194dbd92a4f0455a122b7d26dbae4fae3d4f
-  data.tar.gz: 20708f0e49773f0ea8dbf769ebcb78850c8a8ab0
+  metadata.gz: 94747650af6e626f711d0341f35f3125ae5fec03
+  data.tar.gz: 35317fe2907e045be258f308e3a9dab624aeb6cd
 SHA512:
-  metadata.gz: b1484c8a3bbf56cd1fcb08578aa348bb6ac811c803eb9436582b9944b056c081c4d6a88a05cef9c4d2a30c665d727a24481cd2ef4403061057d2bdef92602df6
-  data.tar.gz: 2c8e03b8237eee47c4c933172fea171062e6c65a8a277a9c7bc0921385e2d41d99705b54807255936131c755352b3feebc15b0ab8a9c513ebfdd73ff2eda9911
+  metadata.gz: ce80f11fff16d7e4be457c58c36c09adbae888c1c3ac694eaed00682c8b927612e4664a5b94f78e4373c07121dcf8827c2a00a70504df615c6cf496db3c45f99
+  data.tar.gz: d77d4b939d3a87d89ed4bcacad41f8cc348e1fcfb87dd11a1b0254f36f4e7e1a5af922f1a6252a0564e21a961ad366a31e88d699557d3dee76f93a8d986a9a44

data/.yardopts

@@ -0,0 +1 @@
+-m markdown bin/*

data/README.md

@@ -52,7 +52,7 @@ Refer to [Date#strftime](https://docs.ruby-lang.org/en/2.1.0/Date.html#method-i-
 
 *Parallel execution (with xargs):*
 
-    $ bin/diter 2016-01-01 2016-01-03 | xargs -I{} -P2 -t echo date={}
+    $ diter 2016-01-01 2016-01-03 | xargs -I{} -P2 -t echo date={}
     echo date=2016-01-01
     echo date=2016-01-02
     date=2016-01-01

data/bin/diter

@@ -2,6 +2,22 @@
 
 require 'date'
 
+# `Diter` enumerate dates with some filters.
+#
+#     require 'diter'
+#
+#     from = Date.new(2016, 1, 1)
+#     to = Date.new(2016, 1, 31)
+#
+#     Diter[from, to, wday: 3].each do |date|
+#       puts date.strftime('%Y/%m/%d')
+#     end
+#     #=>
+#     #  2016/01/06
+#     #  2016/01/13
+#     #  2016/01/20
+#     #  2016/01/27
+#
 class Diter
   include Enumerable
 
@@ -9,12 +25,30 @@ class Diter
     alias [] new
   end
 
+  # Return a new instance of `Diter`.
+  #
+  # If `from` is greater than `to`, it enumerate dates in reverse order.
+  #
+  # @param [Date] from the start of dates
+  # @param [Date] to the end of dates
+  # @param [Hash] options
+  # @option options [Integer] :wday (nil) filter by the day of a week.
+  # @option options [Integer] :mday (nil) filter by the day of a month.
+  # @return [Diter]
   def initialize(from, to, options = {})
     @range = from < to ? from..to : (to..from).reverse_each
     @options = options
   end
 
+  # Calls the given block once for each date.
+  #
+  # Return `self` if no block is given.
+  #
+  # @yieldparam date [Date]
+  # @return [Diter] self
   def each
+    return self unless block_given?
+
     @range.each do |date|
       next unless filter_wday(date)
       next unless filter_mday(date)
@@ -23,6 +57,8 @@ class Diter
     end
   end
 
+  private
+
   def filter_wday(date)
     return true unless @options[:wday]
 
@@ -47,10 +83,10 @@ unless $DITER_REQUIRED # $DITER_REQUIRED is set to true in lib/diter.rb
     Process.waitpid(spawn(program, *args))
     $?.success?
   rescue Errno::EACCES, Errno::ENOEXEC
-    $stderr.puts "diter: not executable: #{args.first}"
+    $stderr.puts "diter: not executable: #{program}"
     false
   rescue Errno::ENOENT
-    $stderr.puts "diter: command not found: #{args.first}"
+    $stderr.puts "diter: command not found: #{program}"
     false
   end
 

data/diter.gemspec

@@ -1,10 +1,14 @@
 # coding: utf-8
 
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'diter/version'
+
 Gem::Specification.new do |spec|
   spec.name          = 'diter'
-  spec.version       = '0.1.1'
+  spec.version       = Diter::VERSION
   spec.authors       = ['Hikaru Ojima']
-  spec.email         = ['ojima.h@gmail.com']
+  spec.email         = ['amijo4rihaku@gmail.com']
 
   spec.summary       = 'Date iteration utility.'
   spec.description   = 'Date iteration utility.'
@@ -20,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

data/lib/diter/version.rb

@@ -0,0 +1,3 @@
+class Diter
+  VERSION = '0.1.2'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Hikaru Ojima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-10 00:00:00.000000000 Z
+date: 2016-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,9 +52,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Date iteration utility.
 email:
-- ojima.h@gmail.com
+- amijo4rihaku@gmail.com
 executables:
 - diter
 extensions: []
@@ -62,6 +76,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -70,6 +85,7 @@ files:
 - bin/diter
 - diter.gemspec
 - lib/diter.rb
+- lib/diter/version.rb
 homepage: https://github.com/ojima-h/diter
 licenses:
 - MIT