natural_number_string 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 558a4c943d3c6c6e40dcc8498c4b989cf781acfc
-  data.tar.gz: bc1d1f75537a0e95f78810e562d41834b709e90d
+  metadata.gz: 7e0504b7f544a6843459856190216f8d1e0a5477
+  data.tar.gz: cd9fc346e86d669293020d477e43a4ad328b1df9
 SHA512:
-  metadata.gz: 2af6dc71c6f4c2fd87feb89eacb362b443b92fd078eabaf9337727429bfbfe3d04e8f612deffbd843f07f87c620d126d555fb6480d6c19f4d864317d0fa0749e
-  data.tar.gz: 4a4f57132abb386b4614b588f85c2d78cfeeaa343d90840765cdb593e354ac0766f982ecfd23f531cd2fa2ae4f2cb43499a55a28ee4faf2931e25abe5d608df5
+  metadata.gz: 51b0b489d8e8eca0bcb729117e4ef2aa6b2741b951dc4cde5ed72d9290eaa8285240cc57c889d44a09414ee81c86b883e264c12e36da17e94c630b4ae1f13d70
+  data.tar.gz: 791504ff2664cab2933482efc91df4d3d549c4d912c98f2a87d7c2cdb8386c8ed7d06b5849a24197dd1bd8fcc68f951d60e7317ec94b5cf89d0dba2ff7e28c20

data/Gemfile

@@ -3,8 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in natural_number_string.gemspec
 gemspec
 
-group :development do
-  gem 'rubocop', group: :test
-  gem 'byebug', group: :test if RUBY_VERSION >= '2.0.0'
-  gem 'parse_gemspec-cli'
-end
+gem 'rubocop'
+gem 'byebug' if RUBY_VERSION >= '2.0.0'
+gem 'parse_gemspec-cli'
+gem 'yard'

data/README.md

@@ -1,6 +1,6 @@
 # NaturalNumberString
 
-[![Gem version][gem-image]][gem-url] [![Travis-CI Status][travis-image]][travis-url]
+[![Gem version][gem-image]][gem-url] [![Travis-CI Status][travis-image]][travis-url] [![yard docs][docs-image]][docs-url]
 
 > Check the string is a natural number.
 
@@ -59,6 +59,8 @@ value.
 value.
 
 
+And [details][docs-url].
+
 ## Changelog
 
 [changelog.md](./changelog.md).
@@ -103,3 +105,5 @@ The gem is available as open source under the terms of the [MIT License](http://
 [travis-image]: https://img.shields.io/travis/packsaddle/ruby-natural_number_string/master.svg?style=flat-square&label=build%20%28linux%29
 [gem-url]: https://rubygems.org/gems/natural_number_string
 [gem-image]: http://img.shields.io/gem/v/natural_number_string.svg?style=flat-square
+[docs-url]: http://www.rubydoc.info/gems/natural_number_string
+[docs-image]: https://img.shields.io/badge/yard-docs-blue.svg?style=flat-square

data/Rakefile

@@ -7,3 +7,12 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task default: :test
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+DOC_FILES = ['lib/**/*.rb']
+DOC_OPTIONS = ['--debug', '--verbose']
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = DOC_FILES
+  t.options = DOC_OPTIONS if Rake.application.options.trace
+end

data/changelog.md

@@ -1,3 +1,9 @@
+<a name="1.0.0"></a>
+# [1.0.0](https://github.com/packsaddle/ruby-natural_number_string/compare/v0.3.1...v1.0.0) (2015-09-27)
+
+Add yard document.
+
+
 <a name="0.3.1"></a>
 ## [0.3.1](https://github.com/packsaddle/ruby-natural_number_string/compare/v0.3.0...v0.3.1) (2015-09-26)
 

data/lib/natural_number_string.rb

@@ -3,10 +3,67 @@ require 'natural_number_string/version'
 module NaturalNumberString
   module_function
 
+  # Check the string is a positive integer or zero
+  # @param value [Object] any object
+  # @return [Boolean] the string is a positive integer or zero
+  # @example Use include
+  #   class Example
+  #     include NaturalNumberString
+  #     def example
+  #       zero_or_positive_integer_string?('1') #=> true
+  #       zero_or_positive_integer_string?('100000000000000') #=> true
+  #       zero_or_positive_integer_string?('0') #=> true
+  #
+  #       zero_or_positive_integer_string?(nil) #=> false
+  #       zero_or_positive_integer_string?('') #=> false
+  #       zero_or_positive_integer_string?(1) #=> false
+  #       zero_or_positive_integer_string?('1.1') #=> false
+  #       zero_or_positive_integer_string?('-1') #=> false
+  #     end
+  #   end
+  # @example Use direct
+  #   NaturalNumberString.zero_or_positive_integer_string?('1') #=> true
+  #   NaturalNumberString
+  #   .zero_or_positive_integer_string?('100000000000') #=> true
+  #   NaturalNumberString.zero_or_positive_integer_string?('0') #=> true
+  #
+  #   NaturalNumberString.zero_or_positive_integer_string?(nil) #=> false
+  #   NaturalNumberString.zero_or_positive_integer_string?('') #=> false
+  #   NaturalNumberString.zero_or_positive_integer_string?(1) #=> false
+  #   NaturalNumberString.zero_or_positive_integer_string?('1.1') #=> false
+  #   NaturalNumberString.zero_or_positive_integer_string?('-1') #=> false
   def zero_or_positive_integer_string?(value)
     value.is_a?(String) && /^\d+$/ =~ value ? true : false
   end
 
+  # Check the string is a positive integer
+  # @param value [Object] any object
+  # @return [Boolean] the string is a positive integer
+  # @example Use include
+  #   class Example
+  #     include NaturalNumberString
+  #     def example
+  #       positive_integer_string?('1') #=> true
+  #       positive_integer_string?('100000000000000') #=> true
+  #
+  #       positive_integer_string?(nil) #=> false
+  #       positive_integer_string?('') #=> false
+  #       positive_integer_string?(1) #=> false
+  #       positive_integer_string?('1.1') #=> false
+  #       positive_integer_string?('-1') #=> false
+  #       positive_integer_string?('0') #=> false
+  #     end
+  #   end
+  # @example Use direct
+  #   NaturalNumberString.positive_integer_string?('1') #=> true
+  #   NaturalNumberString.positive_integer_string?('100000000000') #=> true
+  #
+  #   NaturalNumberString.positive_integer_string?(nil) #=> false
+  #   NaturalNumberString.positive_integer_string?('') #=> false
+  #   NaturalNumberString.positive_integer_string?(1) #=> false
+  #   NaturalNumberString.positive_integer_string?('1.1') #=> false
+  #   NaturalNumberString.positive_integer_string?('-1') #=> false
+  #   NaturalNumberString.positive_integer_string?('0') #=> false
   def positive_integer_string?(value)
     value.is_a?(String) && /^[1-9]\d*$/ =~ value ? true : false
   end

data/lib/natural_number_string/version.rb

@@ -1,3 +1,3 @@
 module NaturalNumberString
-  VERSION = '0.3.1'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: natural_number_string
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - sanemat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-26 00:00:00.000000000 Z
+date: 2015-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,3 +103,4 @@ signing_key:
 specification_version: 4
 summary: Check the string is a natural number.
 test_files: []
+has_rdoc: