casegen 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee14f6a724a837cba03b3ec269718713400ad45e2b49b11c3e9022abe56e4587
-  data.tar.gz: 1b2ccea7698217314e4722f4c3543e2b54566e6d2c003d3f00e7942b46802962
+  metadata.gz: e5e215e499369c78f12bd5d6a0fec866176d1312dbeb439f7c3be80eb5e13edd
+  data.tar.gz: 43b213fdec1a20d90b49a6977b8901188bf148eb39ed37392f2236c116f1ce19
 SHA512:
-  metadata.gz: a3b8a1f42c2bff9fa37a147e96807123afa94941c41588f00903f8cb82541bd90ca0ab72b4fdf53dd319d9fb7e557cbf39485bcaa38b24b69870eb1e193c5470
-  data.tar.gz: 7fb847d1589799ef522a3fde0ff1f8d6322c67045fb555ed809baa98432b66f86b07cb339ddfc703e232e3a905b71721b85eb1add2bf8bada8704e1a7106b78f
+  metadata.gz: a0f2722a36ff8497bac7c8b2b60ba7fe26d437be2af76808ea6ba9948a4d4e2f7072bfc505b7e91a612f48d0ace2dbdf2df972fa32eca8f28a118c7548004dc1
+  data.tar.gz: 4dc6709949e06c88e1f3d5d99bacfbe74a8f9452fb498aa299e411d011cd4f167e373fd16933ae882881319634efc98db3d23faf98bbee3d07babf4ba8a2dfe3

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,109 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: disable
+  Exclude:
+    - bin/*
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+    - module_inclusion
+    - public_class_methods
+    - initializer
+    - public_methods
+    - protected_methods
+    - private_methods
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/LineLength:
+  Enabled: false
+  Max: 120
+  AllowHeredoc: true
+  AllowURI: true
+  URISchemes: http, https
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Metrics:
+  Enabled: true
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - 'test/**/*.rb'
+  IgnoredMethods: ['included', 'namespace']
+
+Metrics/ClassLength:
+  Exclude:
+    - 'Rakefile'
+    - 'spec/**/*.rb'
+    - 'test/**/*.rb'
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 15
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+Style/BlockComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+  Enabled: true
+
+Style/GuardClause:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Technically this performs better, and I got no problem with it.
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+Style/WhenThen:
+  Enabled: true
+
+Style/WordArray:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.6.1
+2.6.6

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-gemspec
+gemspec

data/Gemfile.lock

@@ -1,25 +1,70 @@
 PATH
   remote: .
   specs:
-    casegen (2.0.0)
+    casegen (3.0.0)
       tablesmith
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.11.3)
-    rake (12.3.1)
-    tablesmith (0.4.1)
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.9.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    tablesmith (0.6.2)
       text-table
     text-table (1.2.4)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   casegen!
-  minitest
   rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
 
 BUNDLED WITH
-   1.17.3
+   2.2.27

data/README.md

@@ -1,132 +1,23 @@
 # CaseGen
 
-CaseGen is a small Ruby external DSL for generating combinations of variables,
-optionally restricted by a set of rules.
+CaseGen is a small Ruby gem for generating combinations of variables, optionally
+restricted by a set of rules.  
 
 ## Usage
 
-This input file:
+The [`doc`](/doc) folder has a few examples demonstrating how you can use this
+gem. The [`specs`](/spec) also demonstrate various input and output options.
 
-		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)
-		----------
 
+## Breaking Changes in 3.0
 
-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:
+Versions 1 and 2 were based on a DSL format. Version 3.0 removed the DSL 
+to just use plain Ruby.
 
-   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.
+<a href="https://github.com/cornutum/tcases">tcases</a> is one to check out.
+Another is <a href="https://www.satisfice.com/download/allpairs">AllPairs</a> by
+James Bach.

data/Rakefile

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
-require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
 
-desc 'Run tests'
-Rake::TestTask.new do |t|
-  t.pattern = 'test/**/*test*.rb'
-  # t.verbose = true
-end
+RuboCop::RakeTask.new
 
-task default: :test
+task default: [:spec, 'rubocop:auto_correct']

data/bin/casegen

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 gem 'casegen'
 require 'casegen'
 
-CLabs::CaseGen::CaseGen.new(File.read(ARGV[0]))
+CLabs::CaseGen::CaseGen.new(File.read(ARGV[0]))

data/casegen.gemspec

@@ -1,26 +1,30 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'casegen'
+# frozen_string_literal: true
+
+require_relative 'lib/casegen'
 
 Gem::Specification.new do |gem|
   gem.name = 'casegen'
-  gem.version = CLabs::CaseGen::CaseGen.version
+  gem.version = '3.0.0'
   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.description = 'Simple tool to generate use cases restricted by sets of rules'
+  gem.summary = 'Simple tool 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.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables   = 'casegen'
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.required_ruby_version = '~> 2.3'
+  gem.required_ruby_version = '~> 2.5'
 
   gem.add_dependency 'tablesmith'
 
-  gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rubocop'
+  gem.add_development_dependency 'rubocop-performance'
+  gem.add_development_dependency 'rubocop-rake'
+  gem.add_development_dependency 'rubocop-rspec'
 end

data/doc/bounding_box.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative '../lib/casegen'
+
+# Presuming a 300x300 bounding box, we need images to test edge cases.
+
+bounding_box_relation = %w[inside outside]
+
+sets = {
+  width: bounding_box_relation,
+  height: bounding_box_relation,
+  aspect: %w[wide tall],
+  result: [:expect]
+}
+
+rules = {
+  exclude: [
+    {width: 'inside', height: 'outside', aspect: 'wide',
+     note: 'a narrower image cannot have a wide aspect'},
+    {width: 'outside', height: 'inside', aspect: 'tall',
+     note: 'a shorter image cannot have a tall aspect'},
+  ],
+  expect: [
+    {width: 'inside', height: 'inside', aspect: 'wide', result: '200x100'},
+    {width: 'inside', height: 'inside', aspect: 'tall', result: '100x200'},
+    {width: 'inside', height: 'outside', aspect: 'tall', result: '100x400'},
+    {width: 'outside', height: 'inside', aspect: 'wide', result: '400x100'},
+    {width: 'outside', height: 'outside', aspect: 'wide', result: '500x400'},
+    {width: 'outside', height: 'outside', aspect: 'tall', result: '400x500'},
+  ]
+}
+
+if __FILE__ == $PROGRAM_NAME
+  puts CaseGen.generate(sets, rules, :exclude_as_table).to_s
+else
+  Fixtures.add(:box, sets, rules)
+end