yn 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76494b0413198d1dddc1193c3dad64ed0ef784833844e297c921762705d907d1
-  data.tar.gz: 83d86d57e2e03730107cadf8cc85edc78e9b16e102e8e035f94da4b26c12a43e
+  metadata.gz: 8e256eaf3264537746200a081ead79be85e33989e45e39252363f0ac3eb20a4d
+  data.tar.gz: d27bd13bec779a3e40eb0573581e681ef974ca837a7b8ce81a181075b4097213
 SHA512:
-  metadata.gz: fbd71cca44cedd5680ece2c4c93b4ec6ccac380a9631d05c43772a3d0ef4948ca75aa482774d86780ace89975a2230946ceebcf5631468d83b8643104b24e6c6
-  data.tar.gz: d37e0a1f046fc710722ec07f4f978f9f67ee935afc7435e9034caf88b934013d2046daa33f4326665143a45869f2e5652d536cd93895f8e77f73ae110b76db64
+  metadata.gz: b37454e5970f5832d396243651e53af733acd9714281dea1b60bf7353db960f84b78b22f02aa25e08a836fb6cba3883a2b08644eaff97d3e840b61cd2f295bd2
+  data.tar.gz: 489f2ca931c71cfd6bbb58a600d5a91bfc288b1c052196c3919e570ffd1d60e04ed549e2d7a823bfd2618d3ead6382a8ec6c3233e1e4ee75df5f9dd47e957647

data/.yardstick.yml

@@ -1,29 +1,22 @@
 threshold: 100
 rules:
   ApiTag::Presence:
-    enabled: false
-    exclude: []
+    enabled: true
   ApiTag::Inclusion:
-    enabled: false
-    exclude: []
+    enabled: true
   ApiTag::ProtectedMethod:
     enabled: true
-    exclude: []
   ApiTag::PrivateMethod:
     enabled: true
-    exclude: []
   ExampleTag:
-    enabled: false
-    exclude:
+    enabled: true
   ReturnTag:
-    enabled: false
+    enabled: true
   Summary::Presence:
-    enabled: false
+    enabled: true
   Summary::Length:
     enabled: false
   Summary::Delimiter:
-    enabled: false
-    exclude: []
+    enabled: true
   Summary::SingleLine:
     enabled: false
-    exclude: []

data/CHANGELOG.md

@@ -3,3 +3,17 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2019-12-01
+### Changed
+- Fully documented all classes and methods
+- Required Ruby 2.3 or higher in the gemspec
+### Added
+- Integrated the gem with CodeClimate for code coverage and maintainability reports
+
+## [0.1.0] - 2019-12-01
+### Added
+- Initial core functionality
+- Codebase maintenance tools
+
+[Unreleased]: https://github.com/wilsonsilva/yn/compare/v1.0.0...HEAD

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at wilson.dsigns@gmail.com. All
+reported by contacting the project team at me@wilsonsiva.net All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/README.md

@@ -2,6 +2,8 @@
 
 [![Gem Version](https://badge.fury.io/rb/yn.svg)](https://badge.fury.io/rb/yn)
 [![Build Status](https://travis-ci.org/wilsonsilva/yn.svg?branch=master)](https://travis-ci.org/wilsonsilva/yn)
+[![Maintainability](https://api.codeclimate.com/v1/badges/96e1447d3ad45f1ca681/maintainability)](https://codeclimate.com/github/wilsonsilva/yn/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/96e1447d3ad45f1ca681/test_coverage)](https://codeclimate.com/github/wilsonsilva/yn/test_coverage)
 [![Security](https://hakiri.io/github/wilsonsilva/yn/master.svg)](https://hakiri.io/github/wilsonsilva/yn/master)
 [![Inline docs](http://inch-ci.org/github/wilsonsilva/yn.svg?branch=master)](http://inch-ci.org/github/wilsonsilva/yn)
 
@@ -122,8 +124,8 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Credits
 
-This is a port of [Sindre Sorhus](https://github.com/sindresorhus) JavaScript's [yn](https://github.com/sindresorhus/yn)
-. I'm a big fan of his work!
+This is a port of [Sindre Sorhus](https://github.com/sindresorhus) JavaScript's [yn](https://github.com/sindresorhus/yn).
+I'm a big fan of his work!
 
 ## Code of Conduct
 

data/lib/yn.rb

@@ -3,6 +3,52 @@ require 'yn/lenient'
 
 # Encapsulates all the code of the gem in a meaningful namespace.
 module Yn
+  # Parses yes/no like values
+  #
+  # @example Parsing yes-like values
+  #   Yn.parse('y') # => true
+  #   Yn.parse('yes') # => true
+  #   Yn.parse('Yes') # => true
+  #   Yn.parse('YES') # => true
+  #   Yn.parse('1') # => true
+  #   Yn.parse(1) # => true
+  #   Yn.parse('on') # => true
+  #   Yn.parse('true') # => true
+  #   Yn.parse(true) # => true
+  #
+  # @example Parsing no-like values
+  #   Yn.parse('n') # => false
+  #   Yn.parse('no') # => false
+  #   Yn.parse('No') # => false
+  #   Yn.parse('NO') # => false
+  #   Yn.parse('0') # => false
+  #   Yn.parse(0) # => false
+  #   Yn.parse('off') # => false
+  #   Yn.parse('false') # => false
+  #   Yn.parse(false) # => false
+  #
+  # @example Allowing typos in the words yes or no
+  #   Yn.parse('y7s', lenient: true) # => true
+  #   Yn.parse('tes', lenient: true) # => true
+  #   Yn.parse('yes', lenient: true) # => true
+  #   Yn.parse('mo', lenient: true) # => false
+  #   Yn.parse('nl', lenient: true) # => false
+  #   Yn.parse('no', lenient: true) # => false
+  #   Yn.parse('something-else', lenient: true) # => nil
+  #
+  # @example Using a default value
+  #   Yn.parse('falso', default: false) # => false
+  #   Yn.parse('verdadeiro', default: true) # => true
+  #
+  # @param [Object] input The input object or string to be converted
+  # @param [Object] lenient Whether typos in words +yes+ and +no+ are allowed or not
+  # @param [Object] default Value returned when the +input+ isn't considered +yes+ or +no+
+  #
+  # @return [Boolean|nil] +true+ if the input is a yes-like value, +false+ if the input is a no-like value
+  # and +nil+ or +default+ otherwise.
+  #
+  # @api public
+  #
   def self.parse(input, lenient: false, default: nil)
     input = input.to_s.strip
 

data/lib/yn/lenient.rb

@@ -1,6 +1,6 @@
 # Encapsulates all the code of the gem in a meaningful namespace.
 module Yn
-  # Allows very small typos in the inputs.
+  # Gracefully handles typos in the words +yes+ or +no+.
   class Lenient
     YES_MATCH_SCORE_THRESHOLD = 2
     NO_MATCH_SCORE_THRESHOLD = 1.25
@@ -60,6 +60,16 @@ module Yn
       ['l', 0.25]
     ].to_h
 
+    # Returns +true+ or +false+ if input resembles the words +yes+ or +no+ respectively,
+    # or the given +default+ otherwise
+    #
+    # @param [String] input The string to compare with the words +yes+ or +no+
+    # @param [Object] default Value returned when the +input+ doesn't resemble the words +yes+ or +no+
+    #
+    # @return [Object]
+    #
+    # @api private
+    #
     def call(input, default)
       return true if get_yes_match_score(input) >= YES_MATCH_SCORE_THRESHOLD
       return false if get_no_match_score(input) >= NO_MATCH_SCORE_THRESHOLD
@@ -69,6 +79,14 @@ module Yn
 
     private
 
+    # Returns a match score with word +yes+ between 0 and 3
+    #
+    # @param [String] input The string to compare with the word +yes+
+    #
+    # @return [Fixnum|Float]
+    #
+    # @api private
+    #
     def get_yes_match_score(input)
       y, e, s = input.split('')
 
@@ -79,6 +97,14 @@ module Yn
       score
     end
 
+    # Returns a match score with word +no+ between 0 and 2
+    #
+    # @param [String] input The string to compare with the word +no+
+    #
+    # @return [Fixnum|Float]
+    #
+    # @api private
+    #
     def get_no_match_score(input)
       n, o = input.split('')
 

data/lib/yn/version.rb

@@ -1,3 +1,3 @@
 module Yn
-  VERSION = '0.1.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/yn.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri'] = 'https://github.com/wilsonsilva/yn'
   spec.metadata['changelog_uri']   = 'https://github.com/wilsonsilva/yn/blob/master/CHANGELOG.md'
 
+  spec.required_ruby_version = '>= 2.3'
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yn
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Wilson Silva
@@ -305,7 +305,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="