casegen 2.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee14f6a724a837cba03b3ec269718713400ad45e2b49b11c3e9022abe56e4587
-  data.tar.gz: 1b2ccea7698217314e4722f4c3543e2b54566e6d2c003d3f00e7942b46802962
+  metadata.gz: 5bb2b1a19cbb5b53da68ce37c7b2c9ff99f9105636520405c0ec18e47c7aed2c
+  data.tar.gz: a7e541670d1fd620b92069310bded11e8f182aea34fcd3e9ec01d09c0dd8e66d
 SHA512:
-  metadata.gz: a3b8a1f42c2bff9fa37a147e96807123afa94941c41588f00903f8cb82541bd90ca0ab72b4fdf53dd319d9fb7e557cbf39485bcaa38b24b69870eb1e193c5470
-  data.tar.gz: 7fb847d1589799ef522a3fde0ff1f8d6322c67045fb555ed809baa98432b66f86b07cb339ddfc703e232e3a905b71721b85eb1add2bf8bada8704e1a7106b78f
+  metadata.gz: e1b6a5a094ba06210a78f9193f46fac19c1331a7d265364da322a6dc470b5c8b4cf32e5b7d284d2ad0982d0a87297dfbda41853b89eda23535c1d0ed61db7333
+  data.tar.gz: ed7a0b9ba8572d495b49ff9d5d7baf74ba04cd75aae70ee062eb7f4bdbbcedde460758868bc12bf1db53dece726809022bb2d38a8f2c3bab92f0f6b59521d30e

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
+3.3.3

data/Gemfile

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

data/Gemfile.lock

@@ -1,25 +1,82 @@
 PATH
   remote: .
   specs:
-    casegen (2.0.0)
+    casegen (3.0.1)
       tablesmith
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.11.3)
-    rake (12.3.1)
-    tablesmith (0.4.1)
+    ast (2.4.3)
+    diff-lcs (1.6.2)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    regexp_parser (2.10.0)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.4)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
+    rubocop (1.76.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.45.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.45.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.6.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
+    tablesmith (0.7.0)
       text-table
     text-table (1.2.4)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   casegen!
-  minitest
   rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
 
 BUNDLED WITH
-   1.17.3
+   2.6.9

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.1'
   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

data/doc/cart.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative '../lib/casegen'
+
+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 = {
+  exclude: [
+    {
+      criteria: %(shipping == "Ground" && ship_to_country == "Outside US" ),
+      description: 'Our ground shipper will only ship things within the US',
+    },
+    {
+      criteria: -> { payment == 'Check' && bill_to_country == 'Outside US' },
+      description: 'Our bank will not accept checks written from banks outside the US.',
+    },
+    {
+      criteria: -> { payment == 'Online Bank' && amount >= 1_000 },
+      description: <<~_,
+        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.
+      _
+    },
+    {
+      criteria: -> { ship_to_country == 'US' && bill_to_country == 'Outside US' },
+      description: "If we're shipping to the US, billing party cannot be outside US"
+    },
+  ]
+}
+
+if __FILE__ == $PROGRAM_NAME
+  puts CaseGen.generate(sets, rules, :exclude_as_text).to_s
+else
+  Fixtures.add(:cart, sets, rules)
+end

data/doc/expect_only.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../lib/casegen'
+
+sets = {
+  duration: [12, 24, 36, 60],
+  unit: [60, 3600],
+  result: [:expect]
+}
+
+rules = {
+  expect: [
+    {duration: 12, unit: 60, result: '12m'},
+    {duration: 12, unit: 3600, result: '12h'},
+    {duration: 24, unit: 60, result: '24m'},
+    {duration: 24, unit: 3600, result: '1d'},
+    {duration: 36, unit: 60, result: '36m'},
+    {duration: 36, unit: 3600, result: '1d 12h'},
+    {duration: 60, unit: 60, result: '1h'},
+    {duration: 60, unit: 3600, result: '2d 12h'},
+  ]
+}
+
+if __FILE__ == $PROGRAM_NAME
+  puts CaseGen.generate(sets, rules, :exclude_inline).to_s
+else
+  Fixtures.add(:duration, sets, rules)
+end

data/doc/pricing.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative '../lib/casegen'
+
+sets = {
+  subtotal: [25, 75, 200],
+  discount: %w[0% 10% 20%],
+  promo: %w[none apr fall],
+  total: [:expect]
+}
+
+rules = {
+  exclude: [
+    {
+      criteria: %(subtotal < 100 && discount == '20%'),
+      description: 'Total must be above $100 to apply the 20% discount',
+    },
+    {
+      criteria: %((subtotal < 50) && discount == '10%'),
+      note: 'Total must be above $50 to apply the 10% discount',
+    },
+    {
+      criteria: %(discount != '20%' && subtotal == 200),
+      reason: 'Orders over 100 automatically get 20% discount',
+    },
+    {
+      criteria: %(discount != '10%' && subtotal == 75),
+      reason: 'Orders between 50 and 100 automatically get 10% discount',
+    },
+    {
+      criteria: %(discount == '20%' && promo != 'none'),
+      reason: '20% discount cannot be combined with promo',
+    },
+  ],
+  expect: [
+    {subtotal: 25, promo: 'none', total: '25.00'},
+    {subtotal: 25, promo: 'apr', total: '17.50', reason: 'apr promo is 30%'},
+    {subtotal: 25, promo: 'fall', total: '16.25', note: 'fall promo is 35%'},
+    {subtotal: 75, promo: 'none', total: '67.50', note: '10% discount'},
+    {subtotal: 75, promo: 'apr', total: '47.25', reason: '10% + apr promo is 30%'},
+    {subtotal: 75, promo: 'fall', total: '43.88', note: '10% + fall promo is 35%'},
+    {subtotal: 200, promo: 'none', total: '160.00', note: '20% discount'},
+  ]
+}
+
+if __FILE__ == $PROGRAM_NAME
+  puts CaseGen.generate(sets, rules, :exclude_as_text)
+else
+  Fixtures.add(:pricing, sets, rules)
+end

data/doc/ruby_array.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../lib/case_gen'
+
+raise "This doesn't currently work. Do I even want to keep it?"
+
+# CLabs::CaseGen::CaseGen.new(DATA.read)
+
+# Outputs
+#
+# DataSubmitCase = Struct.new(:role, :authorization_code, :submit_enabled)
+#
+# cases = [DataSubmitCase.new("admin", "none", "true"),
+#          DataSubmitCase.new("admin", "invalid", "true"),
+#          DataSubmitCase.new("admin", "valid", "true"),
+#          DataSubmitCase.new("standard", "none", "false"),
+#          DataSubmitCase.new("standard", "invalid", "false"),
+#          DataSubmitCase.new("standard", "valid", "true")]
+
+__END__
+
+sets
+----
+role: admin, standard
+authorization code: none, invalid, valid
+submit enabled: true, false
+
+rules(sets)
+-----------
+exclude role = admin AND submit enabled = false
+  Admin role can always submit
+
+exclude role = standard AND authorization code = none AND submit enabled = true
+exclude role = standard AND authorization code = invalid AND submit enabled = true
+exclude role = standard AND authorization code = valid AND submit enabled = false
+  Standard role can only submit when authorization code is valid
+
+
+ruby_array(rules)
+-------------
+DataSubmitCase

data/lib/case_gen/combination.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module CaseGen
+  class Combination
+    attr_reader :names, :excluded_by_rule
+
+    def initialize(hash_pairs)
+      @names = hash_pairs.map do |h|
+        k = h.first.first
+        v = h.first.last
+        append(k, v)
+        k
+      end
+    end
+
+    def hash_row
+      {}.tap do |h|
+        @names.each do |ivar|
+          h[ivar] = instance_variable_get("@#{ivar}")
+        end
+      end
+    end
+
+    def append(key, value)
+      @names << key if defined?(@names)
+      instance_variable_set("@#{key}", value)
+      self.class.attr_accessor key
+    end
+
+    def exclude_with(rule)
+      @excluded_by_rule = rule
+    end
+
+    def excluded?
+      !@excluded_by_rule.nil?
+    end
+  end
+end