scrap4rb 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96286449e9afa50fcf63563ab4c24e5ea34422d4b78aef3c8ba5c5fecd0dad0a
-  data.tar.gz: 75e1b075bdc33a520a45c1cf95b5e20f484d6893969e5b138f1e6514e0fda703
+  metadata.gz: 6b7d1598905c975218cc1e268749cb4ab21ef2277fc28414536dcb6e8c0132fd
+  data.tar.gz: ca6df9174a9d75f3a3cdbef37213a2b9f596b15b6661f402c1705d674c085f7e
 SHA512:
-  metadata.gz: 76526de107521d564ae46d855eb70920b67f1029a9cf13d8f1831ba8ad2db2173a9a550926ec8e01ebb849f1559d153f8d095157e76dd632005a0e68619ca062
-  data.tar.gz: 0c6caaaf36b1d12058035482a7f8af88fabd089da3b8f3c54ccd08992bcadb1c80baa2fdf27204dfe866ddd378ac09a5368a623771a79057fdeeebc2a40a5daa
+  metadata.gz: 1f858b26273076b66cfc9d2f1abde656f81a18c0cd0129a075ea9f5f33b180b0e90f4c9032562829a1417b4c19d39965982f45ecef3a947cced2e1af31631a04
+  data.tar.gz: d01334fa91516614bbb58a909650bb99f2acb3100741daef2bd4b66ed8bdad2f630bd60f633adb0f30e431c73ecd68750e82d2d11ef6d9e32cf9c5921c8a71fe

data/CHANGELOG.md

@@ -6,6 +6,17 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [0.2.2] - 2026-11-01
+
+### Added
+- The `symmetric-fixture` smell, penalty 3. It fires when one arrange form gives the same number or string twice, such as `Zone.new(area_m2: 50, plint_m: 50)`. A test like that cannot tell a swap of the two fields apart. It is not a SCRAP smell. See Deviations from SCRAP in the README.
+
+## [0.2.1] - 2026-10-16
+
+### Fixed
+- The README tells you to run scrap4rb from the project root when you run it from a checkout. From the scrap4rb folder, scrap4rb does not find the shared assertion helpers of the project, and a test that uses one reads as `no-assertions`.
+- The README lists all structure errors, limits the 35% low-assertion rule to files with more than two tests, and lists three more deviations from SCRAP.
+
 ## [0.2.0] - 2026-10-15
 
 ### Changed
@@ -37,6 +48,8 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
   `describe`/`it` blocks. A `define_method` test inside a loop over a table
   (`CASES.each`) is one table-driven test that spans the loop.
 
-[Unreleased]: https://github.com/roberthopman/scrap4rb/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/roberthopman/scrap4rb/compare/v0.2.2...HEAD
+[0.2.2]: https://github.com/roberthopman/scrap4rb/compare/v0.2.1...v0.2.2
+[0.2.1]: https://github.com/roberthopman/scrap4rb/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/roberthopman/scrap4rb/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/roberthopman/scrap4rb/releases/tag/v0.1.0

data/README.md

@@ -22,10 +22,11 @@ Or add it to a Gemfile:
 gem "scrap4rb", group: :development
 ```
 
-From a checkout you can run it without installing:
+From a checkout you can run it without installing. Run it from the project root, because scrap4rb finds the shared assertion helpers from the current directory:
 
 ```bash
-ruby -Ilib exe/scrap4rb path/to/project/test
+cd path/to/project
+ruby -I path/to/scrap4rb/lib path/to/scrap4rb/exe/scrap4rb
 ```
 
 ## Usage
@@ -52,6 +53,8 @@ The comparison gives each changed file a verdict: `improved`, `worse`, `mixed` o
 
 ## Output
 
+An example, with some lines left out and some lines shortened:
+
 ```
 test/models/smelly_test.rb
   score 48.46 HIGH  mode LOCAL  ai AUTO_REFACTOR  tests=6 avg=12.78 max=18.26
@@ -85,8 +88,8 @@ EXTRACT    A group of tests where a shared helper pays for itself
 
 Structure errors:
 
-  - a `test` inside a `test`
-  - a `setup`, `teardown`, `describe`, `context` or `class` inside a test
+  - a `test`, `it` or `specify` inside a test
+  - a `setup`, `teardown`, `before`, `after`, `describe`, `context`, `def setup` or `class` inside a test
   - a second `def test_x` with the same name in one class (the first one never runs)
   - parse errors
 
@@ -103,6 +106,7 @@ large-example              more than 20 lines                               4
 helper-hidden-complexity   more than 8 lines hidden in local helpers        4
 temp-resource-work         files, directories, threads or processes         3
 literal-heavy-setup        a string over 5 lines, a hash or array over 10   3
+symmetric-fixture          the same value twice in one arrange fixture      3
 ```
 
 A short test with one or two assertions and few subjects is an "API contract" test. SCRAP excuses it from the low-assertion-density and large-example smells.
@@ -136,16 +140,19 @@ The policy numbers (weights, thresholds, levels) are SCRAP's, unchanged.
 ## Deviations from SCRAP
 
   - A test whose whole body is one context block, such as `travel_to(...) do ... end`, is unwrapped before the phase count. In Ruby that block is test context, not arrange code.
-  - A call to an assertion helper defined in `test/test_helper.rb`, `test/application_system_test_case.rb`, `test/test_helpers/` or `test/support/` counts as one assertion. SCRAP only reads the spec file itself. Without this rule, every test that uses a shared assertion helper would be "no-assertions".
+  - A call to an assertion helper defined in `test/test_helper.rb`, `test/application_system_test_case.rb`, `test/test_helpers/` or `test/support/` counts as one assertion. scrap4rb finds these files from the current directory. SCRAP only reads the spec file itself. Without this rule, every test that uses a shared assertion helper would be "no-assertions".
   - A loop over a literal hash (`{ 5 => 0, 6 => 10 }.each`) counts as table-driven, the same as a loop over an array of arrays.
   - `--compare` does not call new tests that use a helper a helper regression. See `docs/compare-verdict.md`.
+  - `symmetric-fixture` is not a SCRAP smell. It fires when one arrange form gives the same number or string twice, as in `Zone.new(area_m2: 50, plint_m: 50)`. A test like that cannot tell a swap of the two fields apart. The values `0`, `1` and `""` do not count, because a test about zero cannot pick another value. Assertions and shared `setup` blocks are not read: a repeated value in an expected result is the result, and one repeated value in a shared fixture would mark every test in the class.
+  - The `where` lines show only for a file with more than one describe block or class. SCRAP shows them for each file.
+  - A `describe` inside a `describe` is not a structure error, because minitest/spec nests them. A second test with the same name is a structure error. SCRAP has no such check.
 
 ## Notes for Rails suites
 
 Two SCRAP rules can disagree with common Rails practice. Decide for your own suite.
 
   - **multiple-phases**: a system test that asserts after each click (to prove that the page changed before the next step) has several phases, and SCRAP gives it 5 points.
-  - **Low-assertion files**: a file is not STABLE when more than 35% of its tests have one assertion or fewer. A suite with "one behavior, one assertion" tests will have many LOCAL files for this reason only.
+  - **Low-assertion files**: a file with more than two tests is not STABLE when more than 35% of its tests have one assertion or fewer. A suite with "one behavior, one assertion" tests will have many LOCAL files for this reason only.
 
 ## Development
 
@@ -159,9 +166,9 @@ The golden tests run the executable against the fixture suite in `test/fixtures/
 
 ## Credits
 
-SCRAP is by Robert C. Martin (Uncle Bob): [github.com/unclebob/scrap](https://github.com/unclebob/scrap). The algorithm, the metrics, the smells and the policy numbers in scrap4rb come from SCRAP. scrap4rb is an independent Ruby implementation. It contains no SCRAP source code.
+SCRAP is by Robert C. Martin (Uncle Bob): [github.com/unclebob/scrap](https://github.com/unclebob/scrap). The algorithm, the metrics, the smells and the policy numbers in scrap4rb come from SCRAP, except the `symmetric-fixture` smell, which is listed under Deviations from SCRAP. scrap4rb is an independent Ruby implementation. It contains no SCRAP source code.
 
-scrap4rb 0.1.0 follows SCRAP at commit [`f793b28`](https://github.com/unclebob/scrap/tree/f793b28906d3c60e30b128e1ec08df6269a72b13) (2026-03-17). When SCRAP changes its rules or numbers, scrap4rb can differ until it follows again.
+scrap4rb follows SCRAP at commit [`f793b28`](https://github.com/unclebob/scrap/tree/f793b28906d3c60e30b128e1ec08df6269a72b13) (2026-03-17). When SCRAP changes its rules or numbers, scrap4rb can differ until it follows again.
 
 Related tools by the same author: [crap4clj](https://github.com/unclebob/crap4clj), [crap4java](https://github.com/unclebob/crap4java), [crap4go](https://github.com/unclebob/crap4go) and [clj-mutate](https://github.com/unclebob/clj-mutate).
 

data/lib/scrap4rb/example.rb

@@ -108,7 +108,7 @@ module Scrap4rb
         m[:large_literals] <= 0 && m[:subject_symbols].size <= 4 && phases <= 1 && line_count <= 18
     end
 
-    def smells(m, line_count, phases, table_driven, api_contract)
+    def smells(m, line_count, phases, table_driven, api_contract, symmetric_fixture = false)
       [
         [m[:assertions].zero?, "no-assertions", 10],
         [m[:assertions] == 1 && line_count > 10 && !table_driven && !api_contract, "low-assertion-density", 6],
@@ -117,6 +117,7 @@ module Scrap4rb
         [line_count > 20 && !api_contract, "large-example", 4],
         [m[:temp_resources].positive?, "temp-resource-work", 3],
         [m[:large_literals].positive?, "literal-heavy-setup", 3],
+        [symmetric_fixture, "symmetric-fixture", 3],
         [m[:helper_hidden_lines] > 8, "helper-hidden-complexity", 4]
       ].select(&:first).map { { label: _2, penalty: _3 } }
     end
@@ -131,12 +132,13 @@ module Scrap4rb
       setup_depth = api ? [0, m[:max_setup_depth] - 2].max : m[:max_setup_depth]
       branch_penalty = m[:table_driven] ? m[:table_branches] : m[:branches] + m[:table_branches]
       branch_penalty = [0, branch_penalty - 2].max if api
-      found = smells(m, line_count, phases, m[:table_driven], api)
       complexity_score = saturating(1 + branch_penalty + setup_depth + m[:helper_calls])
 
       setup = inherited_setup + forms.select { context_head?(_1) }
       asserts = forms.select { phase(_1, ctx) == :assert }
       arrange = forms.reject { phase(_1, ctx) == :assert }
+      symmetric = arrange.any? { |f| [f, *descendants(f)].any? { symmetric_fixture?(_1) } }
+      found = smells(m, line_count, phases, m[:table_driven], api, symmetric)
       setup_signatures = form_signatures(setup)
       literal_signatures = body.flat_map { large_literal_signatures(_1) }
       {

data/lib/scrap4rb/syntax.rb

@@ -14,6 +14,7 @@ module Scrap4rb
     BLOCK_CALLS = %i[describe context].to_set
     SETUP_CALLS = %i[setup before].to_set
     LET_CALLS = %i[let let! subject].to_set
+    DEGENERATE_VALUES = [0, 1, "0", "1", ""].freeze
 
     extend self
 
@@ -93,6 +94,33 @@ module Scrap4rb
       end
     end
 
+    def fixture_value(node)
+      value = case node
+              when Prism::IntegerNode, Prism::FloatNode then node.value
+              when Prism::StringNode then node.unescaped
+              end
+      value unless DEGENERATE_VALUES.include?(value)
+    end
+
+    def argument_groups(call)
+      hashes, plain = (call.arguments&.arguments || []).partition { _1.is_a?(Prism::HashNode) || _1.is_a?(Prism::KeywordHashNode) }
+      [plain] + hashes.map { _1.elements.grep(Prism::AssocNode).map(&:value) }
+    end
+
+    def repeated_fixture_values?(nodes)
+      values = nodes.filter_map { fixture_value(_1) }
+      values.size >= 2 && values.uniq.size < values.size
+    end
+
+    def symmetric_fixture?(node)
+      groups = case node
+               when Prism::ArrayNode then [node.elements]
+               when Prism::CallNode then argument_groups(node)
+               else []
+               end
+      groups.any? { repeated_fixture_values?(_1) }
+    end
+
     def control_call?(node)
       assertion?(node) || context_head?(node) || stub_call?(node) || TABLE_CALLS.include?(node.name) || node.name == :loop ||
         TEST_CALLS.include?(node.name) || SETUP_CALLS.include?(node.name) || !node.name.match?(/\A[a-z_]/i)

data/lib/scrap4rb/version.rb

@@ -1,3 +1,3 @@
 module Scrap4rb
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scrap4rb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Robert Hopman