casegen 1.3.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee14f6a724a837cba03b3ec269718713400ad45e2b49b11c3e9022abe56e4587
+  data.tar.gz: 1b2ccea7698217314e4722f4c3543e2b54566e6d2c003d3f00e7942b46802962
+SHA512:
+  metadata.gz: a3b8a1f42c2bff9fa37a147e96807123afa94941c41588f00903f8cb82541bd90ca0ab72b4fdf53dd319d9fb7e557cbf39485bcaa38b24b69870eb1e193c5470
+  data.tar.gz: 7fb847d1589799ef522a3fde0ff1f8d6322c67045fb555ed809baa98432b66f86b07cb339ddfc703e232e3a905b71721b85eb1add2bf8bada8704e1a7106b78f

data/.gitignore

@@ -0,0 +1,4 @@
+.bundle/
+.idea/
+bin/
+pkg/

data/.ruby-version

@@ -0,0 +1 @@
+2.6.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    casegen (2.0.0)
+      tablesmith
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (12.3.1)
+    tablesmith (0.4.1)
+      text-table
+    text-table (1.2.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  casegen!
+  minitest
+  rake
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Chris Morris
+
+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/README.md

@@ -0,0 +1,132 @@
+# CaseGen
+
+CaseGen is a small Ruby external DSL for generating combinations of variables,
+optionally restricted by a set of rules.
+
+## Usage
+
+This input file:
+
+		sets
+		------------
+		payment: Credit, Check, Online Bank
+		amount: 100, 1,000, 10,000
+		shipping: Ground, Air
+		ship to country: US, Outside US
+		bill to country: US, Outside US
+		
+		
+		rules(sets)
+		---------------------------
+		exclude shipping = Ground AND ship to country = Outside US
+		  Our ground shipper will only ship things within the US.
+		
+		exclude payment = Check AND bill to country == Outside US
+		  Our bank will not accept checks written from banks outside the US.
+		
+		exclude payment = Online Bank AND amount == 1,000
+		exclude payment = Online Bank AND amount == 10,000
+		  While the online bank will process amounts > $1,000, we've experienced
+		  occasional problems with their services and have had to write off some
+		  transactions, so we no longer allow this payment option for amounts greater
+		  than $1,000
+		
+		exclude ship to country = US AND bill to country = Outside US
+		  If we're shipping to the US, billing party cannot be outside US
+		
+		
+		console(rules)
+		----------
+
+
+produces this output:
+        
+        +-------------+--------+----------+-----------------+-----------------+
+        |   payment   | amount | shipping | ship to country | bill to country |
+        +-------------+--------+----------+-----------------+-----------------+
+        | Credit      | 100    | Ground   | US              | US              |
+        | Credit      | 100    | Air      | US              | US              |
+        | Credit      | 100    | Air      | Outside US      | US              |
+        | Credit      | 100    | Air      | Outside US      | Outside US      |
+        | Credit      | 1,000  | Ground   | US              | US              |
+        | Credit      | 1,000  | Air      | US              | US              |
+        | Credit      | 1,000  | Air      | Outside US      | US              |
+        | Credit      | 1,000  | Air      | Outside US      | Outside US      |
+        | Credit      | 10,000 | Ground   | US              | US              |
+        | Credit      | 10,000 | Air      | US              | US              |
+        | Credit      | 10,000 | Air      | Outside US      | US              |
+        | Credit      | 10,000 | Air      | Outside US      | Outside US      |
+        | Check       | 100    | Ground   | US              | US              |
+        | Check       | 100    | Air      | US              | US              |
+        | Check       | 100    | Air      | Outside US      | US              |
+        | Check       | 1,000  | Ground   | US              | US              |
+        | Check       | 1,000  | Air      | US              | US              |
+        | Check       | 1,000  | Air      | Outside US      | US              |
+        | Check       | 10,000 | Ground   | US              | US              |
+        | Check       | 10,000 | Air      | US              | US              |
+        | Check       | 10,000 | Air      | Outside US      | US              |
+        | Online Bank | 100    | Ground   | US              | US              |
+        | Online Bank | 100    | Air      | US              | US              |
+        | Online Bank | 100    | Air      | Outside US      | US              |
+        | Online Bank | 100    | Air      | Outside US      | Outside US      |
+        +-------------+--------+----------+-----------------+-----------------+
+        
+        exclude shipping = Ground AND ship to country = Outside US
+          Our ground shipper will only ship things within the US.
+        
+        exclude payment = Check AND bill to country == Outside US
+          Our bank will not accept checks written from banks outside the US.
+        
+        exclude payment = Online Bank AND amount == 1,000
+        
+        exclude payment = Online Bank AND amount == 10,000
+          While the online bank will process amounts > $1,000, we've experienced
+          occasional problems with their services and have had to write off some
+          transactions, so we no longer allow this payment option for amounts greater
+          than $1,000
+        
+        exclude ship to country = US AND bill to country = Outside US
+          If we're shipping to the US, billing party cannot be outside US
+     
+If you pull the source locally, you can execute this:
+
+   casegen doc/cart.sample.txt     
+        
+## FAQ
+
+How can I use this lib inside another Ruby file, instead of having a separate
+input file?
+
+sample.rb:
+
+		require "bundler/inline"
+        
+        gemfile do
+          source "https://rubygems.org"
+          gem "casegen", "~> 2.0"
+        end
+        
+		require 'casegen'
+		
+		CLabs::CaseGen::CaseGen.new(DATA.read)
+		
+		__END__
+		
+		sets
+		----
+		a: 1, 2
+		b: 3, 4
+		
+		rules(sets)
+		-----------
+		exclude a = 1
+		
+		console(rules)
+		--------------
+		
+
+### Are there other tools similar to CaseGen?
+
+<a href="http://code.google.com/p/tcases/">tcases</a> is one to check out.
+Another is <a href="http://www.satisfice.com/tools.shtml">AllPairs</a> by James
+Bach.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+desc 'Run tests'
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*test*.rb'
+  # t.verbose = true
+end
+
+task default: :test

data/TODO

@@ -0,0 +1,26 @@
+- OR not supported yet.
+- Nested booleans not supported yet.
+- performance problems
+
+    two problems: formatting table is very slow, too many iterations. Sets agent can get
+    col widths easy, but it may not be passed to the console agent, so may need to support
+    "console(rules, sets)" syntax
+
+    the actual enum product call is fairly quick, but the rules are 3x as slow. Need a way
+    to maybe hold off on generating the combinations and then hook in with a block to filter
+    them as they're being made - save another run through the whole set.
+
+- support for "assign ... when ..."
+- if condition specified has an incorrect value, notify user
+- don't require comma AND SPACE in set lists ... ? (This is currently that way to allow thousands separators in values)
+
+- this case:
+      exclude Cl = Ser         AND Rec = K12RF(1.01)
+      exclude Cl = Ser         AND Rec = G2IR(white)
+      exclude Cl = Num         AND Herf(11)
+
+  blows up without a meaningful error
+
+- meaningful exceptions still are exceptions, and you have a full stacktrace - make it purty.
+
+- LICENSE of enum lib contents.

data/bin/casegen

@@ -1,11 +1,6 @@
 #!/usr/bin/env ruby
 
-begin
-  require 'rubygems'
-  gem 'casegen'
-rescue LoadError
-end
-
+gem 'casegen'
 require 'casegen'
 
-CLabs::CaseGen::Console.new
+CLabs::CaseGen::CaseGen.new(File.read(ARGV[0]))

data/casegen.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'casegen'
+
+Gem::Specification.new do |gem|
+  gem.name = 'casegen'
+  gem.version = CLabs::CaseGen::CaseGen.version
+  gem.authors = ['chrismo']
+  gem.email = 'chrismo@clabs.org'
+  gem.description = 'Simple Ruby DSL to generate use cases restricted by sets of rules'
+  gem.summary = 'Simple Ruby DSL to generate use cases restricted by sets of rules'
+  gem.homepage = 'https://github.com/chrismo/casegen'
+  gem.license = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = 'casegen'
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '~> 2.3'
+
+  gem.add_dependency 'tablesmith'
+
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'rake'
+end

data/doc/cart.sample.rb

@@ -0,0 +1,3 @@
+require_relative '../lib/casegen'
+
+CLabs::CaseGen::CaseGen.new(File.read(File.join(__dir__, 'cart.sample.txt')))

data/{src/ruby_array.sample.txt → doc/ruby_array.sample.rb}

@@ -1,3 +1,9 @@
+require_relative '../lib/casegen'
+
+CLabs::CaseGen::CaseGen.new(DATA.read)
+
+__END__
+
 sets
 ----
 role: admin, standard

data/{src → lib}/agents/sets.rb

@@ -1,6 +1,7 @@
 require "#{File.dirname(__FILE__)}/../casegen"
 $LOAD_PATH << "#{File.expand_path(File.join(File.dirname(__FILE__), 'sets'))}"
 require 'enum/op'
+require 'tablesmith'
 
 class String
   def to_u
@@ -11,35 +12,35 @@ end
 module CLabs::CaseGen
   class Set
     attr_reader :name, :data
-  
+
     def initialize(name, data_array)
       @name = name
       @data = data_array
       strip_data
     end
-    
+
     def strip_data
       @data.collect! do |datum| datum.strip end
     end
-    
+
     def values
       @data
     end
   end
-  
+
   class Sets < Agent
     attr_accessor :sets, :combinations, :set_titles
-  
+
     def Sets.agent_id
       "casegen:sets"
     end
-    
+
     def initialize(data, reference_agents=nil)
       @data = data
       @sets = []
       parse_sets
     end
-  
+
     def parse_sets
       set_names = @data.scan(/^\s*(\w.*):/)
       set_data = @data.scan(/:(.*)/)
@@ -49,7 +50,7 @@ module CLabs::CaseGen
       end
       generate_combinations
     end
-    
+
     def generate_combinations
       arrays = []
       @set_titles = []
@@ -66,30 +67,30 @@ module CLabs::CaseGen
       EnumerableOperator::Product.new(*args).each { |tuple|
         result << tuple
       }
-      result  
+      result
     end
-    
+
     def set_names
       names = []
       @sets.each do |set| names << set.name end
       names
     end
-    
+
     def set_by_name(setname)
       @sets.detect do |set| set.name =~ /#{Regexp.escape(setname)}/ end
     end
-    
+
   end
-  
+
   class Criteria
     attr_reader :set_names, :set_values, :equalities
-    
+
     def initialize(data)
       @data = data
       @equalities = {}
       parse
     end
-    
+
     def parse
       @data.split(/AND/).each do |bit|
         set_name, set_value = bit.split(/==|=/)
@@ -102,8 +103,8 @@ module CLabs::CaseGen
       @set_names = @equalities.keys
       @set_values = @equalities.values
     end
-    
-    # hash keys should be valid set names and hash values should be valid 
+
+    # hash keys should be valid set names and hash values should be valid
     # set values in the named set
     def match(hash)
       # must match all equalities
@@ -114,20 +115,20 @@ module CLabs::CaseGen
       end
       return true
     end
-    
+
     def to_s
       @data
     end
   end
-  
+
   class Rule
     attr_reader :criteria, :description, :data
-  
+
     def initialize(rule_data)
       @data = rule_data
       parse_rule
     end
-    
+
     def parse_rule
       data = @data.sub(self.class.regexp, '')
       criteria_data, *@description = data.split(/\n/)
@@ -136,41 +137,41 @@ module CLabs::CaseGen
       @description = (@description.join("\n") + "\n").outdent.strip
     end
   end
-    
+
   class ExcludeRule < Rule
     def type_description
       "exclude"
     end
-    
+
     def ExcludeRule.regexp
       /^exclude/i
     end
-    
+
     def ExcludeRule.create(rule_data)
       return ExcludeRule.new(rule_data) if rule_data =~ regexp
       return nil
     end
   end
-  
+
   class Rules < Agent
     def Rules.agent_id
       "casegen:rules"
     end
-    
+
     def initialize(data, reference_agents=[])
       @data = data
       @agents = reference_agents
       @rules = []
       @rule_classes = []
-      ObjectSpace.each_object(Class) do |obj| 
-        @rule_classes << obj if obj.ancestors.include?(Rule) && obj != Rule 
+      ObjectSpace.each_object(Class) do |obj|
+        @rule_classes << obj if obj.ancestors.include?(Rule) && obj != Rule
       end
       parse_data
     end
-    
+
     def parse_data
       raw_rules = @data.split(/(?=^\S)/)
-      
+
       raw_rules.each do |rule|
         @rule_classes.each do |rule_class|
           @rules << rule_class.create(rule.strip)
@@ -180,7 +181,7 @@ module CLabs::CaseGen
       @rules.flatten!
       validate_rules
     end
-      
+
     def validate_rules
       @agents.each do |agent|
         if agent.class == Sets
@@ -188,7 +189,7 @@ module CLabs::CaseGen
             rule.criteria.equalities.each_pair do |set_name, set_value|
               set = agent.set_by_name(set_name)
               if set.nil?
-                raise ParserException.new("Invalid set name <#{set_name}> " + 
+                raise ParserException.new("Invalid set name <#{set_name}> " +
                   "in rule <#{rule.criteria}>. Valid set names are <#{agent.set_names.join(', ')}>.")
               end
               if !set.values.include?(set_value)
@@ -201,19 +202,19 @@ module CLabs::CaseGen
         end
       end
     end
-    
+
     def length
       @rules.length
     end
-    
+
     def [](index)
       return @rules[index]
     end
-    
+
     def each(&block)
       @rules.each(&block)
     end
-    
+
     def combinations
       return @combinations if !@combinations.nil?
       if @agents[0].class == Sets
@@ -227,7 +228,7 @@ module CLabs::CaseGen
           # combo_hash will have set names matched with set values
           agent.set_titles.each do |title|
             combo_hash[title] = combo[i]
-            i += 1 
+            i += 1
           end
           @rules.each do |rule|
             delete |= rule.criteria.match(combo_hash)
@@ -236,60 +237,36 @@ module CLabs::CaseGen
         end
         return @combinations
       end
-      return []    
+      return []
     end
-    
+
     def titles
       @agents[0].titles
     end
-    
+
     def to_s
       puts @agents[0].combinations.inspect if !@agents[0].nil?
       puts
       puts @rules.inspect
     end
   end
-  
+
   class ConsoleOutput < Agent
     def ConsoleOutput.agent_id
       "casegen:console"
     end
-    
-    def initialize(data, reference_agents)
+
+    def initialize(data, reference_agents, io=STDOUT)
       @data = data
       @agents = reference_agents
-      table = formatted_table([@agents[0].titles] + @agents[0].combinations)
-      table.each do |ary|
-        puts ary.join(' | ')
-      end
-      puts
+      table = [@agents[0].titles] + @agents[0].combinations
+      io.puts table.to_table.pretty_inspect
+      io.puts
       @agents[0].each do |rule|
-        puts rule.data
-        puts
+        io.puts rule.data
+        io.puts
       end if @agents[0].is_a?(Rules)
     end
-    
-    def formatted_table(combinations)
-      col_widths = []
-      formatted_tuples = []
-      combinations.each do |tuple|
-        col = 0
-        tuple.each do |item| 
-          col_widths[col] = item.to_s.length if col_widths[col].to_i < item.to_s.length
-          col += 1
-        end
-      end
-      
-      combinations.each do |tuple|
-        col = 0
-        formatted_tuples << tuple.collect { |item| 
-          formatted = item.to_s.ljust(col_widths[col]) if !col_widths[col].nil?
-          col += 1
-          formatted
-        }
-      end
-      formatted_tuples
-    end
   end
 
   class RubyArrayOutput < Agent