chop 0.33.1 → 0.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14c0cb6f9aa8014bb534f6ba37a1c349a350b6cc46965a6ff53396e5d3109392
-  data.tar.gz: c30c721f89e926e8863f9922be49b56637857da63dbc30bc9bbd11b4a6434d73
+  metadata.gz: 97c2fe11438b99e52e5f3165ec8164eb7447c1a6238dffd4855d5a7f748b20af
+  data.tar.gz: 7e14858a804e3f58a44effecc1c5d92b24b79c59db4186c20625134f5c30c731
 SHA512:
-  metadata.gz: 304b8d1f6476118b823cde46c7c879e46b22a1d7841fbddbe557e4990aea2fb90a8e1d90375eb80f93fd7fb32b892881842aecaf817dd93962d6349a2adabf8e
-  data.tar.gz: 1ee77efff5587d689ca58d81452807cb0a2c8f0b8dde2b563ba4f36ea7f336b3aabc12c74fbf9d7efb70139b91e8b01a05a5f545ef8918d05c9bd42020ed5605
+  metadata.gz: edf192cddad2d07ebe2e8db22f0ab193600aa8d55c47e7450fc307e64cf994fafd54a899aaa8221e0c228172957e0d4ed14bb509c5493e7dba7c1358ccce78fa
+  data.tar.gz: c473cc071556c3b3142cf7027fb4015c1dbd2d4408c26d971e84917493bed80871cfd8641d222759cc9a9a2c2e430d8fb1cebefe8c8da4b184a3a67b913d80a0

data/CLAUDE.md

@@ -0,0 +1,61 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+Chop is a Ruby gem that enhances Cucumber tables with three main methods: `#create!` for creating entities (ActiveRecord/FactoryGirl support), `#diff!` for comparing tables against HTML elements (table, dl, ul, form), and `#fill_in!` for form filling. It works by monkey-patching Cucumber's DataTable class.
+
+## Development Commands
+
+### Testing
+- `rake spec` or `bundle exec rspec` - Run the full test suite
+- `rspec spec/chop/table_spec.rb` - Run a specific test file 
+- `rspec spec/chop/table_spec.rb:42` - Run a specific test by line number
+
+### Development Setup
+- `bin/setup` - Install dependencies after checkout
+- `bin/console` - Interactive console for experimentation
+
+### Multi-Version Testing
+- `bundle exec appraisal install` - Install gems for all Rails versions
+- `bundle exec appraisal rails-7.0 rspec` - Test against specific Rails version
+- `bundle exec appraisal rspec` - Test against all Rails versions
+
+### Gem Management
+- `rake build` - Build the gem
+- `rake release` - Release new version (updates version, tags, pushes)
+
+## Architecture
+
+### Core Components
+- **`Chop::DSL`** (lib/chop/dsl.rb) - Main interface providing `create!`, `diff!`, `fill_in!` methods
+- **`Chop::Create`** (lib/chop/create.rb) - Handles entity creation with transformation DSL
+- **`Chop::Diff`** (lib/chop/diff.rb) - Base class for HTML element diffing with Capybara
+- **Element-specific diffing classes**:
+  - `Chop::Table` - HTML table diffing
+  - `Chop::DefinitionList` - Definition list (`<dl>`) diffing  
+  - `Chop::UnorderedList` - Unordered list (`<ul>`) diffing
+  - `Chop::Form` - Form filling functionality
+
+### Monkey-patching Strategy
+The gem extends `Cucumber::MultilineArgument::DataTable` by prepending a module that adds the three main methods. The DSL module can also be called directly as `Chop.create!`, `Chop.diff!`, `Chop.fill_in!` to avoid monkey-patching.
+
+### Creation Strategies
+Supports pluggable creation strategies via `Chop::Create.register_creation_strategy`:
+- Default: ActiveRecord's `create!`
+- FactoryGirl/FactoryBot support built-in
+- Custom strategies can be registered
+
+### Transformation DSL
+The `#create!` method supports a rich DSL for transforming table data:
+- Field transformations: `file`, `files`, `has_one`, `has_many`, `default`, `copy`, `rename`, `delete`
+- Low-level: `field`, `transformation` for custom logic
+- Lifecycle hooks: `after` for post-creation logic
+
+## Testing Patterns
+
+- Uses RSpec with `spec_helper.rb` configuring focus and run-all behavior
+- Tests organized by component in `spec/chop/` matching `lib/chop/` structure
+- Tests cover both direct method calls and monkey-patched table behavior
+- Uses Capybara for integration testing of diffing functionality

data/lib/chop/create.rb

@@ -157,7 +157,8 @@ module Chop
       end
     end
 
-    def has_many key, klass=nil, delimiter: ", ", field: :name
+    def has_many key, klass=nil, delimiter: ", ", field: :name, find_by: nil
+      field = find_by if find_by
       klass ||= key.to_s.classify.constantize
       self.field key do |names|
         names.split(delimiter).map do |name|
@@ -166,7 +167,8 @@ module Chop
       end
     end
 
-    def has_one key, klass=nil, field: :name
+    def has_one key, klass=nil, field: :name, find_by: nil
+      field = find_by if find_by
       klass ||= key.to_s.classify.constantize
       self.field key do |name|
         klass.find_by!(field => name) if name.present?

data/lib/chop/form.rb

@@ -19,33 +19,16 @@ module Chop
         Node("")
       end
 
-      all_fields = root.all("input, textarea, select")
-      relevant_fields = all_fields.inject([]) do |fields, field|
-        next fields if field[:name].blank?
-        next fields if field[:type] == "submit"
-        next fields if field[:type] == "hidden"
-        fields + [field]
-      end
-      deduplicated_fields = relevant_fields.inject([]) do |fields, field|
-        next fields if fields.map { |field| field[:name] }.include?(field[:name])
-        fields + [field]
-      end
-      actual = deduplicated_fields.inject([]) do |fields, field|
-        next fields unless label = find_label_for(field)
-        field = Field.from(session, field)
-        fields + [[label.text(:all), field.get_value.to_s]]
-      end
+      actual = root.all(Field.combined_css_selector)
+        .filter_map { |field_element| Field.from(session, field_element) }
+        .select(&:should_include_in_diff?)
+        .uniq { |field| field.field[:name] }
+        .filter_map(&:to_diff_row)
+
       block.call(actual, root) if block_given?
       table.diff! actual, surplus_row: false, misplaced_col: false
     end
 
-    def self.find_label_for field, session: Capybara.current_session
-      if field[:id].present?
-        session.first("label[for='#{field[:id]}']", visible: :all, minimum: 0, wait: 0.1)
-      else
-        puts "cannot find label without id for #{field[:name]}"
-      end
-    end
 
     def fill_in!
       table.rows_hash.each do |label, value|
@@ -53,9 +36,63 @@ module Chop
       end
     end
 
+    class FieldFinder
+      def initialize(session, css_selector)
+        @session = session
+        @css_selector = css_selector
+      end
+
+      def find(locator)
+        return nil if locator.nil?
+
+        @locator = locator.to_s
+        @all_fields = @session.all(@css_selector)
+
+        find_by_direct_attributes ||
+        find_by_aria_label ||
+        find_by_associated_label ||
+        find_by_wrapping_label ||
+        raise_not_found
+      end
+
+      private
+
+      def find_by_direct_attributes
+        @all_fields.find do |field|
+          field[:id] == @locator ||
+          field[:name] == @locator ||
+          field[:placeholder] == @locator
+        end
+      end
+
+      def find_by_aria_label
+        @all_fields.find { |field| field[:'aria-label'] == @locator }
+      end
+
+      def find_by_associated_label
+        @all_fields.find do |field|
+          field[:id].present? &&
+          @session.first("label[for='#{field[:id]}']", visible: :all, minimum: 0, wait: 0.1)&.text(:all) == @locator
+        end
+      end
+
+      def find_by_wrapping_label
+        wrapping_label = @session.all("label", text: @locator, visible: :all, minimum: 0, wait: 0.1).find do |label|
+          label.find(@css_selector, visible: :all, minimum: 0, wait: 0.1)
+        rescue Capybara::ElementNotFound
+          false
+        end
+        wrapping_label&.find(@css_selector, visible: :all, minimum: 0, wait: 0.1)
+      end
+
+      def raise_not_found
+        raise Capybara::ElementNotFound, "Unable to find field #{@locator.inspect}"
+      end
+    end
+
     class Field < Struct.new(:session, :label, :value, :path, :field)
       def self.for session, label, value, path
-        field = session.find_field(label)
+        field = FieldFinder.new(session, combined_css_selector).find(label)
         candidates.map do |klass|
           klass.new(session, label, value, path, field)
         end.find(&:matches?)
@@ -73,12 +110,49 @@ module Chop
         end
       end
 
+      def self.css_selector
+        "input"
+      end
+
+      def self.combined_css_selector
+        candidates.map(&:css_selector).uniq.join(", ")
+      end
+
       def get_value
         field.value
       end
+
+      def should_include_in_diff?
+        field[:name].present? &&
+          field[:type] != "submit" &&
+          field[:type] != "hidden"
+      end
+
+      def label_text
+        return nil unless field[:id].present?
+        label_element = session.first("label[for='#{field[:id]}']", visible: :all, minimum: 0, wait: 0.1)
+        label_element&.text(:all)
+      end
+
+      def to_diff_row
+        return nil unless label = label_text
+        [label, diff_value]
+      end
+
+      def diff_value
+        get_value.to_s
+      end
+
+      def fill_in!
+        field.set value
+      end
     end
 
     class MultipleSelect < Field
+      def self.css_selector
+        "select"
+      end
+
       def matches?
         field.tag_name == "select" && field[:multiple].to_s == "true"
       end
@@ -94,6 +168,10 @@ module Chop
     end
 
     class Select < Field
+      def self.css_selector
+        "select"
+      end
+
       def matches?
         field.tag_name == "select" && field[:multiple].to_s == "false"
       end
@@ -107,6 +185,10 @@ module Chop
           field.find("option[value='#{selected_value}']").text
         end
       end
+
+      def diff_value
+        get_value.to_s
+      end
     end
 
     class MultipleCheckbox < Field
@@ -124,6 +206,10 @@ module Chop
         checkboxes.select(&:checked?).map(&:value).join(", ")
       end
 
+      def diff_value
+        get_value
+      end
+
       private
 
       def checkboxes
@@ -149,6 +235,10 @@ module Chop
       def get_value
         field.checked? ? "✓" : ""
       end
+
+      def diff_value
+        get_value
+      end
     end
 
     class Radio < Field
@@ -236,13 +326,19 @@ module Chop
       end
     end
 
-    class Default < Field
+    class Textarea < Field
+      def self.css_selector
+        "textarea"
+      end
+
       def matches?
-        true
+        field.tag_name == "textarea"
       end
+    end
 
-      def fill_in!
-        field.set value
+    class Default < Field
+      def matches?
+        true
       end
     end
   end

data/lib/chop/version.rb

@@ -1,3 +1,3 @@
 module Chop
-  VERSION = "0.33.1"
+  VERSION = "0.35.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chop
 version: !ruby/object:Gem::Version
-  version: 0.33.1
+  version: 0.35.0
 platform: ruby
 authors:
 - Micah Geisel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-05-10 00:00:00.000000000 Z
+date: 2025-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -133,6 +133,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - Appraisals
+- CLAUDE.md
 - Gemfile
 - LICENSE.txt
 - README.md