option_list 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85680a61b17407ca8811fee8e2e4509909a123b1
-  data.tar.gz: a40943f96304a2bc1a4f92ec69ac314f7f7af688
+  metadata.gz: 2650da4a37bd70ae725edff131f55737c18294f8
+  data.tar.gz: 5839f281fcbd14e41f30f09df222add47661943a
 SHA512:
-  metadata.gz: c40e7604cd5ad64eb97f58d83d3aa1dc04ac673b71594dc755b54ee67d944164cd26299e30d2b18836e8cd60e3f817ec701283dd7877427dc09dad7ee93936b4
-  data.tar.gz: 3893d42f76080f06b80200b7f84cbeb7d8afddf9e53171c125d06b9099fc025e99bd3250d863a36b0ccc1f090638ed52298e50bf1394ed0908db0ce06e78777b
+  metadata.gz: 3476398579ac52edcf8b104aa3830f84d30d0a383d2ea109e73789db042d02dd7989b62d1d18d1c39279845f593d2b1a75910433d75c5d2cbc2a6dd447e547aa
+  data.tar.gz: 411ac7eb8e11b4caa050a2e422b9cc08128903dfe447091970ab008d7ab54e87175a23cd4ab61707a4813df3fdf8a72f8070b8a7debaa4d93d0bd3e50f00a473

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at peter.c.camilleri@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -1,14 +1,23 @@
-# The Option List gem.
+# OptionList
 
-This gem implements the concept that parameter validation is long and
-tedious and something needed to be done about that. This gem implements
+This gem addresses the fact that parameter validation is long and
+tedious and something needs to be done about that. This gem implements
 the idea that parameters be described separately and validated in a
 single line of client method code.
 
-This gem was my first effort in the area of gem creation, and if I'm
-honest, it is rather doubtful that it brings much to the table. Most
-of what it does has been subsumed by the Ruby Language itself, starting
-with version 1.9 and further through versions 2.0, 2.1, and 2.2.
+Most of what this gem does has been subsumed by the Ruby Language itself,
+starting with version 1.9 and further with versions 2.0 and beyond.
+
+Finally, I'd like to add a personal note about this code. This was my first
+attempt at creating a gem. As such there is very much a newbie vibe to the
+code. I hope you can chalk this up to just a part of the learning process.
+None the less, if there are improvements that you (the reader) could suggest,
+I'd really appreciate hearing about them.
+
+Thanks in advance, Peter.
+
+
+## Installation
 
 Add this line to your application's Gemfile:
 
@@ -22,44 +31,53 @@ Or install it yourself as:
 
     $ gem install option_list
 
+The options_list gem is at: ( https://rubygems.org/gems/options_list )
+
 ## Usage
 
-The use of option_list oocurs in three phases: Describing the Parameters,
+The use of option_list occurs in three phases: Describing the Parameters,
 Passing in Parameters and Validating/Accessing the Parameters. This can be
 seen in the following example:
-
-    module ReadLine
-      #Create the parameter specification (simplified for brevity)
-      @spec = OptionList.new([:buffer, :history, :no_history], {:depth => 50}) do |options|
-        fail "Depth must be an integer" unless options.depth.is_a(Integer)
-        fail "Depth must be positive" if options.depth < 1
-      end
-
-      class << self
-        attr_reader :spec
-      end
-
-      def read_line(prompt, *options)
-        @options = ReadLine.spec.select(options)
-        #Further code deleted for brevity.
-        #Somewhere along the line it records the last line.
-        buffer_line(current_line)
-        current_line
-      end
-
-      def buffer_line(line)
-        @line_buffer << line if @options.history?
-        @line_buffer.delete_at(0) if @line_buffer.length > @options.depth
-      end
-    end
-
+```ruby
+module ReadLine
+  #Create the parameter specification (simplified for brevity)
+  @spec = OptionList.new([:buffer, :history, :no_history], {:depth => 50}) do |options|
+    fail "Depth must be an integer" unless options.depth.is_a(Integer)
+    fail "Depth must be positive" if options.depth < 1
+  end
+
+  class << self
+    attr_reader :spec
+  end
+
+  def read_line(prompt, *options)
+    @options = ReadLine.spec.select(options)
+    #Further code deleted for brevity.
+    #Somewhere along the line it records the last line.
+    buffer_line(current_line)
+    current_line
+  end
+
+  def buffer_line(line)
+    @line_buffer << line if @options.history?
+    @line_buffer.delete_at(0) if @line_buffer.length > @options.depth
+  end
+end
+```
 The option_list gem is described in the The option_list User's Guide
-which covers version 1.1.1 which has no material change from 1.1.2
+which covers version 1.1.1 which has no material change from 1.1.3
 
 ## Contributing
 
-1. Fork it
+#### Plan A
+
+1. Fork it ( https://github.com/PeterCamilleri/option_list/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 new Pull Request
+
+#### Plan B
+
+Go to the GitHub repository and raise an issue calling attention to some
+aspect that could use some TLC or a suggestion or an idea.

data/lib/option_list/version.rb

@@ -1,3 +1,3 @@
 class OptionList
-  VERSION = '1.1.3'
+  VERSION = '1.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: option_list
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-07 00:00:00.000000000 Z
+date: 2016-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,6 +102,7 @@ extra_rdoc_files:
 - license.txt
 files:
 - ".gitignore"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - README.md
 - docs/OL_UG.odt
@@ -140,3 +141,4 @@ signing_key:
 specification_version: 4
 summary: Flexible, Easy Function Parameters with Validation.
 test_files: []
+has_rdoc: true