devnull 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ab9b2bd9353de1577f8f63817a253c45737ed89a
-  data.tar.gz: af8ebecb37ab062fdbfb1486b87fa3e07d626b2a
+SHA256:
+  metadata.gz: 30a3665b27660f382a7d97f7f49b7a13def698682d58cfec2cd253820f29acc9
+  data.tar.gz: a777f742513fd6a881ce8517a1a968c70e0b87b51ca56c6a88bacdae126e4941
 SHA512:
-  metadata.gz: a03f5dbdedf57b83c2754612b19bdc9f492369c87875b4572c29ea6449a6f58facd248161659606cb2c207807356c236ee15fb701413d0dc572896f77b0a27fa
-  data.tar.gz: abb6eb752a74ba70377f592f77600a67979ed17cd906a973bb7cfc74be307a5a1039854583e8be57873b8bbda28fa387259d4381c436d3a9152abdca561dec10
+  metadata.gz: 88cbca218e8ac9a1318b92e7b91d3723470ac49f95ea0bb85d0d39719f9c6a72e9c90a00dbe5b46c128872e9c47169dc1560de846f619d58263e6ff013441324
+  data.tar.gz: 299c4bac1b8cdc5827c39f25acc48080cc5362578f2c97380871c04e956634c68bee1dfea36141724ebf2b65eb62d6aa17d53ddbbb1a1f0b110efbac65f15aa2

data/History.txt

@@ -13,3 +13,7 @@ https://github.com/maraigue/devnull/pull/1
 * Moved the location of code 'VERSION = "A.B.C"' (Thanks Patrik Wenger!)
 
 https://github.com/maraigue/devnull/commit/5c8d40b7e03c07a96ae647bc302eec74abfc224d#commitcomment-8379713
+
+=== 0.1.3 / 2019-05-24
+
+* Updated the document

data/{README.txt → README.md}

@@ -1,84 +1,100 @@
-= devnull
-
-home  :: https://rubygems.org/gems/devnull
-code  :: https://github.com/maraigue/devnull
-
-== DESCRIPTION:
-
-Ruby implementation of null file (like /dev/null on Un*x, NUL on Windows)
-
-== SYNOPSIS:
-
-DevNull instance works like an IO object. For example:
-
-  dn = DevNull.new
-  dn.puts "foo" # => nil (do nothing)
-  dn.gets # => nil
-  dn.read # => ""
-
-The library may be a good solution if you would like to switch whether an input/output file is needed. For example:
-
-  def some_process(arg, logfile = nil)
-    # You may set an IO object as 'logfile'.
-    # If so, logs are written to the file.
-    
-    result = process1(arg)
-    logfile.puts result if logfile
-    
-    result = process2(arg)
-    logfile.puts result if logfile
-    
-    result = process3(arg)
-    logfile.puts result if logfile
-  end
-
-can be rewritten as follows:
-
-  def some_process(arg, logfile = DevNull.new)
-    logfile.puts process1(arg)
-    logfile.puts process2(arg)
-    logfile.puts process3(arg)
-  end
-
-== INSTALLATION:
-
-Installed by RubyGems with the command (recommended):
-
-  $ gem install devnull
-
-Or you can use it with downloading devnull.rb file and load it by `require "./devnull"`.
-
-== DEVELOPERS:
-
-(auto-generation by Hoe https://rubygems.org/gems/hoe)
-
-After checking out the source, run:
-
-  $ rake newb
-
-This task will install any missing dependencies, run the tests/specs, and generate the RDoc.
-
-== LICENSE
-
-(The MIT License)
-
-Copyright (c) 2011 H.Hiro (Maraigue)
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# devnull
+
+website :: http://rubygems.org/gems/devnull
+
+Source code / Documentation :: https://github.com/maraigue/devnull
+
+## Description
+
+Ruby implementation of null file (like /dev/null on Un*x, NUL on Windows)
+
+## Note
+
+You can do the similar with a built-in constant [File::NULL](https://docs.ruby-lang.org/ja/latest/method/File=3a=3aConstants/c/NULL.html): the object `open(File::NULL, "rw")` behaves almost the same as the object `DevNull.new`.
+
+After the library is developed ([at Ruby 1.9.3](https://svn.ruby-lang.org/repos/ruby/tags/v1_9_3_0/NEWS)), Ruby introduced the built-in constant `File::NULL` that represents the *name* of the (environment-dependent) null file.  
+Notice that, different from `open(File::NULL, "rw")`, `DevNull.new` does *not* use file-opening API.
+
+## Synopsis
+
+DevNull instance works like an IO object. For example:
+
+```ruby
+dn = DevNull.new
+dn.puts "foo" # => nil (do nothing)
+dn.gets # => nil
+dn.read # => ""
+```
+
+The library may be a good solution if you would like to switch whether an input/output file is needed. For example:
+
+```ruby
+def some_process(arg, logfile = nil)
+  # You may set an IO object as 'logfile'.
+  # If so, logs are written to the file.
+  
+  result = process1(arg)
+  logfile.puts result if logfile
+  
+  result = process2(arg)
+  logfile.puts result if logfile
+  
+  result = process3(arg)
+  logfile.puts result if logfile
+end
+```
+
+can be rewritten as follows:
+
+```ruby
+def some_process(arg, logfile = DevNull.new)
+  logfile.puts process1(arg)
+  logfile.puts process2(arg)
+  logfile.puts process3(arg)
+end
+```
+
+## Installation
+
+Installed by RubyGems with the command (recommended):
+
+  $ gem install devnull
+
+Or you can use it with downloading devnull.rb file and load it by `require "./devnull"`.
+
+## Developers
+
+(auto-generation by Hoe https://rubygems.org/gems/hoe)
+
+After checking out the source, run:
+
+```sh
+$ rake newb
+```
+
+This task will install any missing dependencies, run the tests/specs, and generate the RDoc.
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2011- H.Hiro (Maraigue)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/devnull.rb

@@ -34,7 +34,7 @@
 require "enumerator"
 
 class DevNull
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
   
   def initialize
     # do nothing

metadata

@@ -1,65 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: devnull
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - H.Hiro (maraigue)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-20 00:00:00.000000000 Z
+date: 2019-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '3.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '3.17'
 description: Ruby implementation of null file (like /dev/null on Un*x, NUL on Windows)
-email:
-- main@hhiro.net
+email: main@hhiro.net
 executables: []
 extensions: []
 extra_rdoc_files:
 - History.txt
-- README.txt
+- README.md
 files:
 - History.txt
-- README.txt
+- README.md
 - lib/devnull.rb
 - spec/devnull_spec.rb
 - spec/spec_helper.rb
-homepage: https://rubygems.org/gems/devnull
+homepage: http://rubygems.org/gems/devnull
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
 rdoc_options:
 - "--main"
-- README.txt
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -73,8 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby implementation of null file (like /dev/null on Un*x, NUL on Windows)