option_list 1.1.1 → 1.1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDlkMWJhNDU5YmJmODU0N2IyMmEyZjNiYjcxZTc4MTI4NmJkY2RlMA==
+    NzA5ZjFjNWY2ZDQ0NTQxN2Q3MTIxYTU1N2VmYjMwYTE3YjAzYTdlYw==
   data.tar.gz: !binary |-
-    MTZiNTIxY2M0MzcyM2Q4NGNiN2E5NDcyNDY2ZWVjYjI3MjM3NDE0Zg==
+    NzE3MmExNWM1ZDZmZDUxYjhhMTY2YmMwMDhiMzk0M2UzZGYwMWRiNg==
 SHA512:
   metadata.gz: !binary |-
-    ZmUzZDYyM2MyYTBjYzVhMDQ4MjFkNDZjOWE4MmFlN2ZmMTQyNmU0MjQ3MWJm
-    YWE1ZjE0N2YyZmNmZWRhNGNlNTJmMmIxYjBlODAyZWQ2NmQwMjUzZDE4Yjk2
-    YjJlNWY4M2JjY2EyMTcwMmFiZTA1MDY2MTkxNzZjMTZkMTVmNjI=
+    NWQzOTA3YTgyYjkyZTUyNWNjYTE2NDg0MDZmNzQwM2I0NWQzMmNiOTc4ZTNh
+    ZjUyN2I5NTM1MDFlOWE0NzY3NmYxMmMxZDhiNTQ3OGZkY2JjN2I3NjhjZjlm
+    NjMyYjNiM2Q1NGNjOTZkYjRlMzAzNDhlYjNhMGE1ZGY5NzMxZDk=
   data.tar.gz: !binary |-
-    Yzk2OTZjNDBhYWMzNDFhNzFlZWQ5OTAxOTUwNzcxZDFhZDI3NjhiMjIzYjFh
-    MGIxZmFjY2M3OGNlYjdmMGYzMmMxZDRjZjIzYjFmOWU2YTUyYzYwYWI1MDI4
-    YTllOGEzYTI5ZWQzZDM0YjIyYWVlZDE1ZTJmOTBhMGFkZGYzZWU=
+    M2JiOWFhNDgyZWJiY2UwYWFmMzI0ZjE4YWMyZDE4MzgzNzAxOTA3NWI4Yzk0
+    MTE4ZjFlYmZmMmNkMDdjZDk2MjljZmY1ZGMxYTgyNWE3YWFiMThlYWY2OWRj
+    NjVlMDlkNzBjZWFlZGYwYTk2OGJjYjhlNTRhNjU5OTlhMDg1ZjU=

data/.gitignore

@@ -0,0 +1,20 @@
+*.bat
+*.zip
+*.tmp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in option_list.gemspec
+gemspec

data/README.md

@@ -0,0 +1,65 @@
+# The Option List gem.
+
+This gem implements the concept that parameter validation is long and
+tedious and something needed 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.
+
+Add this line to your application's Gemfile:
+
+    gem 'option_list'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install option_list
+
+## Usage
+
+The use of option_list oocurs 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
+
+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
+
+## Contributing
+
+1. Fork it
+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

data/lib/option_list/version.rb

@@ -0,0 +1,3 @@
+class OptionList
+  VERSION = '1.1.2'
+end

data/lib/option_list.rb

@@ -11,24 +11,24 @@ require 'set'
 #Embraced reek and git and created the user's guide to pair down rdoc mark up
 #to be less obtrusive to the code.
 #=== Version 1.1.0
-#Added a default value of false to signify that no default exists for a 
+#Added a default value of false to signify that no default exists for a
 #mandatory parameter.
 #Modified processing of array specs to avoid side effects in the parameters.
 class OptionList
 
   #The option list code version.
   def self.version
-    '1.1.1'
+    OptionList::VERSION
   end
-  
+
   #The option list code version. This is a redirect to the class method.
   def version
-    self.class.version
+    OptionList::VERSION
   end
 
-  #Create an option list from an array of option specifications. 
+  #Create an option list from an array of option specifications.
   #==== Parameters:
-  #* option_specs - The comma separated option specifications, made into an 
+  #* option_specs - The comma separated option specifications, made into an
   #  array by the splat operator.
   #* select_block - An optional block of code that is called when selections
   #  have been made. This allows for custom validations to be applied at that
@@ -41,7 +41,7 @@ class OptionList
     @mandatory  = Array.new
     @categories = Hash.new
     @default    = Hash.new
-    
+
     option_specs.each do |spec|
       if spec.is_a?(Hash)
         hash_spec(spec)
@@ -51,7 +51,7 @@ class OptionList
         error "Found #{spec.class} instead of Hash or Array."
       end
     end
-    
+
     @select_block = select_block
   end
 
@@ -66,26 +66,26 @@ class OptionList
   #==== Exceptions:
   #* ArgumentError for a number of invalid argument conditions.
   #==== Notes:
-  #After processing the selections, the selection validation block is called 
+  #After processing the selections, the selection validation block is called
   #if one was defined for the constructor.
   def select(selections=[])
     selections = [selections] unless selections.is_a?(Array)
     selected = process_selections(selections)
-    
+
     @mandatory.each do |cat|
       error "Missing mandatory setting #{cat}" unless selected[cat]
     end
-    
+
     @select_block.call(selected) if @select_block
     selected
   end
-  
+
   private  #Private stuff follows.
 
   #Process a list of option selections.
   def process_selections(selections)
     selected, dup = @default.clone, Set.new
-    
+
     selections.each do |opt|
       if opt.is_a?(Symbol)
         symbolic_selection(opt, selected, dup)
@@ -95,15 +95,15 @@ class OptionList
         error "Found #{opt.class} instead of Hash or Symbol."
       end
     end
-    
+
     selected
   end
-  
+
   #Return a internal category marker constant for value entries.
   def value_entry
     'A value entry.'
   end
-  
+
   #Process an array spec that lists all the valid values for an option. See
   #the new method for more information on these specs.
   def array_spec(spec)
@@ -113,15 +113,15 @@ class OptionList
     array_spec_default(category, default)
     array_spec_tail_rest(category, spec[2...spec_len])
   end
-  
-  #Process the first element of the array spec tail.  
+
+  #Process the first element of the array spec tail.
   def array_spec_default(category, opt)
     opt && array_spec_single(category, opt)
     @default[category] = opt
     @mandatory << category if opt == false
   end
-  
-  #Process the rest of the array spec tail.  
+
+  #Process the rest of the array spec tail.
   def array_spec_tail_rest(category, spec_tail_rest)
     spec_tail_rest.each do |opt|
       if opt
@@ -131,14 +131,14 @@ class OptionList
       end
     end
   end
-  
+
   #Process a single array spec option
   def array_spec_single(category, opt)
     duplicate_entry_check(@categories, opt, 'option')
     @categories[opt] = category
     add_option_tester(category, opt)
   end
-  
+
   #Process a hash spec that lists only the default value for an option. See
   #the new method for more information on these specs.
   def hash_spec(spec)
@@ -150,13 +150,13 @@ class OptionList
       @mandatory << category if value == false
     end
   end
-  
+
   #Set the default value of a value entry.
   def set_default_option_value(category, value)
     @categories[category] = value_entry
-    @default[category] = value    
+    @default[category] = value
   end
-  
+
   #Process a symbolic option selection.
   #==== Parameters:
   #* option - a symbol to process.
@@ -168,7 +168,7 @@ class OptionList
     hash_option_dup_check(category, dup)
     selected[category] = symbol_option
   end
-  
+
   #Process a hash of option selection values.
   #==== Parameters:
   #* options - a hash of options to process.
@@ -183,7 +183,7 @@ class OptionList
       selected[category] = value
     end
   end
-  
+
   #Validate a hash option value.
   def hash_option_value_check(value_category, value)
     if (@categories[value_category] != value_entry) && value
@@ -191,12 +191,12 @@ class OptionList
       error "Invalid option: #{value}." unless @categories[value] == value_category
     end
   end
- 
-  #Add to set with no duplicates allowed. 
+
+  #Add to set with no duplicates allowed.
   def hash_option_dup_check(category, dup)
     error "Category #{category} has multiple values." unless dup.add?(category)
   end
-  
+
   #Add query method for the selected category.
   def add_option_reader(name)
     duplicate_entry_check(@default, name, 'category')
@@ -208,13 +208,13 @@ class OptionList
     qry = (value.to_s + '?').to_sym
     @default.define_singleton_method(qry) { self[target] == value}
   end
-  
+
   #Flag any duplicate entry errors.
   def duplicate_entry_check(target, entry, detail)
-    error "Found #{entry.class}, expected Symbol." unless entry.is_a?(Symbol)   
+    error "Found #{entry.class}, expected Symbol." unless entry.is_a?(Symbol)
     error "Duplicate #{detail}: #{entry}" if target.has_key?(entry)
   end
-  
+
   #Flag any missing entry errors.
   def missing_entry_check(target, entry, detail)
     error "Unknown #{detail}: #{entry}" unless target.has_key?(entry)

data/option_list.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+#Specify the building of the option_list gem.
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'option_list/version'
+
+Gem::Specification.new do |s|
+  s.name = "option_list"
+  s.summary = "Flexible, Easy Function Parameters with Validation."
+  s.description = 'Flexible, Easy Function Parameters with Validation. '
+  s.version = OptionList::VERSION
+  s.author = ["Peter Camilleri"]
+  s.email = "peter.c.camilleri@gmail.com"
+  s.homepage = "http://teuthida-technologies.com/"
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>=1.9.3'
+
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'reek', "~> 1.3.8"
+  s.add_development_dependency 'minitest', "~> 4.7.5"
+  s.add_development_dependency 'rdoc', "~> 4.0.1"
+  s.add_development_dependency 'awesome_print'
+
+  s.files       = `git ls-files`.split($/)
+  s.test_files  = s.files.grep(%r{^(test|spec|features)/})
+  s.extra_rdoc_files = ['license.txt']
+
+  s.license = 'MIT'
+  s.has_rdoc = true
+  s.require_path = 'lib'
+end
+

data/rakefile.rb

@@ -1,11 +1,16 @@
 #!/usr/bin/env rake
+# coding: utf-8
+
 require 'rake/testtask'
 require 'rdoc/task'
+require "bundler/gem_tasks"
 
 RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = "rdoc"
-  #rdoc.main = "option_list.rb"
-  rdoc.rdoc_files = ['lib/option_list.rb', 'license.txt']
+
+  #List out all the files to be documented.
+  rdoc.rdoc_files.include("lib/**/*.rb", "license.txt", "README.md")
+
   rdoc.options << '--visibility' << 'private'
 end
 
@@ -14,6 +19,13 @@ Rake::TestTask.new do |t|
   t.verbose = false
 end
 
+desc "Run a scan for smelly code!"
 task :reek do |t|
   `reek lib\\*.rb > reek.txt`
 end
+
+desc "What version of option_list is this?"
+task :vers do |t|
+  puts
+  puts "option_list version = #{OptionList::VERSION}"
+end

data/sire.rb

@@ -0,0 +1,51 @@
+# Really simple program # 3
+# A Simple Interactive Ruby Environment
+# SIRE Version 0.2.6
+
+require 'readline'
+require 'awesome_print'
+require_relative 'lib/option_list'
+include Readline
+
+class Object 
+  def classes
+    begin
+      klass = self
+      
+      begin
+        klass = klass.class unless klass.instance_of?(Class)
+        print klass
+        klass = klass.superclass
+        print " < " if klass
+      end while klass
+      
+      puts
+    end
+  end
+end
+
+def show_args(*args)
+  args
+end
+
+puts "Welcome to SIRE Version 0.2.6"
+puts "Simple Interactive Ruby Environment"
+done = false
+
+until done
+  begin
+    line = readline('SIRE>', true)
+    result = eval line
+    ap result unless result.nil?
+  rescue Interrupt
+    done = true
+  rescue Exception => e
+    puts "#{e.class} detected: #{e}"
+    puts e.backtrace
+    puts
+  end
+end
+
+puts
+puts "Bye bye for now!"
+

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: option_list
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-10 00:00:00.000000000 Z
+date: 2014-11-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -28,30 +42,44 @@ dependencies:
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.8
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.7.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.7.5
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -73,12 +101,20 @@ extensions: []
 extra_rdoc_files:
 - license.txt
 files:
+- .gitignore
+- Gemfile
+- README.md
+- docs/OL_UG.odt
+- docs/OL_UG.pdf
+- docs/OL_UG_Version_1_1_1.pdf
 - lib/option_list.rb
-- tests/option_list_test.rb
-- rakefile.rb
+- lib/option_list/version.rb
 - license.txt
-- README
+- option_list.gemspec
+- rakefile.rb
 - reek.txt
+- sire.rb
+- tests/option_list_test.rb
 homepage: http://teuthida-technologies.com/
 licenses:
 - MIT
@@ -103,5 +139,5 @@ rubygems_version: 2.1.4
 signing_key: 
 specification_version: 4
 summary: Flexible, Easy Function Parameters with Validation.
-test_files:
-- tests/option_list_test.rb
+test_files: []
+has_rdoc: true

data/README

@@ -1,3 +0,0 @@
-This project contains the Ruby OptionList gem. A gem used to facilitate the
-passing of complex parameter options with validation and checking and
-minimal effort on the part of the caller and the callee.