rails_proof 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1500c170053642438fbc0cbc5fa9ef30430ce37fe788b8478c18c7c62b20f603
-  data.tar.gz: e28a65c12b6619ffe852da881e7420efc63da2ce5b84af05966d036234e46447
+  metadata.gz: f5bc052c6972058b263ddf1afd897bd78eabda2639d407fc3ec4f652abed5eb9
+  data.tar.gz: 65317ae8a4a383083becd070161200fedbe24f2d884e7c9e0da431b09572abec
 SHA512:
-  metadata.gz: f1395a5300acda174dafd78f1f6486871e39d43a861b52db6c462563c0f208f235ed9488801d999e60adc5e420123bfc31a0fa4a0b658421af230efd8dbef117
-  data.tar.gz: '081d3e8cac32707be3aadb419fd0d467c7f5a94b5bb31753072f3fbb57f391aa48ca137eb5b020df66f39368ab0e4148d690a27503d5ce4b93b93f72f3a2898f'
+  metadata.gz: 15cfa004f2adf092a455e0d86d249364d0ff1a25fbfbced29f0a7067c22e519993013209500c86deae31e190157030723dcdc2360d42860ddbe40b3790a72bce
+  data.tar.gz: b88cc75ef1f4bd2d6bd91ba54d3288484ca0604124874f92d51ce0d45473b7428febb482a41d3b00217bfffd9d9f77288da9b0e264c5b1f38f14a2c6d3b5abf2

data/lib/generators/rails_proof/test/test_generator.rb

@@ -11,6 +11,7 @@ require "rails_proof/controller_test_coverage_plan"
 require "rails_proof/controller_test_writer"
 require "rails_proof/ai_test_planner"
 require "rails_proof/ai_test_executor"
+require "rails_proof/test_file_inserter"
 
 module RailsProof
   class TestGenerator < Rails::Generators::Base
@@ -170,10 +171,12 @@ module RailsProof
         @controller_inspector = RailsProof::ControllerInspector.new(
           @controller_class
         )
+
         @controller_test_plan = RailsProof::ControllerTestPlan.new(
           @controller_inspector
         )
-        @controller_coverage_plan =
+
+        @controller_test_coverage_plan =
           RailsProof::ControllerTestCoveragePlan.new(
             @controller_test_plan,
             @test_inspector
@@ -181,7 +184,7 @@ module RailsProof
       else
         @controller_inspector = nil
         @controller_test_plan = nil
-        @controller_coverage_plan = nil
+        @controller_test_coverage_plan = nil
       end
     end
 
@@ -334,10 +337,10 @@ module RailsProof
       end
 
       say "Coverage:"
-      say "  Covered: #{@controller_coverage_plan.covered_count}"
-      say "  Missing: #{@controller_coverage_plan.missing_count}"
+      say "  Covered: #{@controller_test_coverage_plan.covered_count}"
+      say "  Missing: #{@controller_test_coverage_plan.missing_count}"
 
-      @controller_coverage_plan.missing_concerns.each do |concern|
+      @controller_test_coverage_plan.missing_concerns.each do |concern|
         say "    #{concern[:description]}"
       end
     end
@@ -509,10 +512,10 @@ module RailsProof
       )
 
       if @absolute_test_file_path.file?
-        inject_into_file(
-          @test_file_path,
-          "\n#{writer.render}\n",
-          before: /^end\s*\z/
+        insert_rendered_tests(
+          writer.render,
+          test_class_name: "#{@current_target.class_name}Test",
+          superclass: "ActiveSupport::TestCase"
         )
       else
         create_file @test_file_path, writer.render_test_file
@@ -521,22 +524,38 @@ module RailsProof
 
     def write_missing_controller_tests
       return unless @controller_class
-      return if @controller_coverage_plan.missing_count.zero?
+      return if @controller_test_coverage_plan.missing_count.zero?
 
       writer = RailsProof::ControllerTestWriter.new(
         controller_class_name: @current_target.class_name,
-        concerns: @controller_coverage_plan.missing_concerns
+        concerns: @controller_test_coverage_plan.missing_concerns
       )
 
       if @absolute_test_file_path.file?
-        inject_into_file(
-          @test_file_path,
-          "\n#{writer.render}\n",
-          before: /^end\s*\z/
+        insert_rendered_tests(
+          writer.render,
+          test_class_name: "#{@current_target.class_name}Test",
+          superclass: "ActionDispatch::IntegrationTest"
         )
       else
         create_file @test_file_path, writer.render_test_file
       end
     end
+
+    def insert_rendered_tests(
+      rendered_test,
+      test_class_name:,
+      superclass:
+    )
+      source = @absolute_test_file_path.read
+
+      updated = RailsProof::TestFileInserter.new(
+        source: source,
+        test_class_name: test_class_name,
+        superclass: superclass
+      ).insert(rendered_test)
+
+      @absolute_test_file_path.write(updated)
+    end
   end
 end

data/lib/rails_proof/ai_test_executor.rb

@@ -4,6 +4,7 @@ require "rails_proof/ai_test_writer"
 require "rails_proof/ai_concern_filter"
 require "rails_proof/test_runner"
 require "rails_proof/review_store"
+require "rails_proof/test_file_inserter"
 
 module RailsProof
   class AiTestExecutor
@@ -34,13 +35,13 @@ module RailsProof
     end
 
     attr_reader :root,
-      :target_path,
-      :test_file_path,
-      :test_class_name,
-      :superclass,
-      :concerns,
-      :runner_class,
-      :review_store
+                :target_path,
+                :test_file_path,
+                :test_class_name,
+                :superclass,
+                :concerns,
+                :runner_class,
+                :review_store
 
     def initialize(
       root:,
@@ -124,7 +125,10 @@ module RailsProof
             test_output: test_result.output
           )
 
-        errors = ["candidate test failed against application"]
+        errors = [
+          "candidate test failed against application"
+        ]
+
         errors << persistence_error if persistence_error
 
         Result.new(
@@ -199,7 +203,9 @@ module RailsProof
       return unless state
 
       if state[:existed]
-        absolute_test_file_path.write(state[:content])
+        absolute_test_file_path.write(
+          state[:content]
+        )
       elsif absolute_test_file_path.exist?
         absolute_test_file_path.delete
       end
@@ -213,25 +219,27 @@ module RailsProof
       )
 
       if absolute_test_file_path.file?
-        insert_into_existing_file(writer.render)
+        insert_into_existing_file(
+          writer.render
+        )
       else
         absolute_test_file_path.dirname.mkpath
-        absolute_test_file_path.write(writer.render_test_file)
+
+        absolute_test_file_path.write(
+          writer.render_test_file
+        )
       end
     end
 
     def insert_into_existing_file(rendered_test)
       source = absolute_test_file_path.read
 
-      unless source.match?(/^end\s*\z/)
-        raise ArgumentError,
-          "RailsProof could not find the end of #{test_file_path}"
-      end
-
-      updated = source.sub(
-        /^end\s*\z/,
-        "\n#{rendered_test}\nend"
-      )
+      updated =
+        RailsProof::TestFileInserter.new(
+          source: source,
+          test_class_name: test_class_name,
+          superclass: superclass
+        ).insert(rendered_test)
 
       absolute_test_file_path.write(updated)
     end
@@ -245,7 +253,10 @@ module RailsProof
         test_class_name: test_class_name
       )
 
-      [path, nil]
+      [
+        path,
+        nil
+      ]
     rescue StandardError => error
       [
         nil,

data/lib/rails_proof/test_file_inserter.rb

@@ -0,0 +1,142 @@
+module RailsProof
+  class TestFileInserter
+    class Error < StandardError
+    end
+
+    attr_reader :source,
+                :test_class_name,
+                :superclass
+
+    def initialize(
+      source:,
+      test_class_name:,
+      superclass:
+    )
+      @source = source
+      @test_class_name = test_class_name
+      @superclass = superclass
+    end
+
+    def insert(rendered_test)
+      lines = source.lines
+
+      class_index, class_indent = find_test_class(lines)
+
+      closing_index = find_class_end(
+        lines,
+        class_index,
+        class_indent
+      )
+
+      indented_test = indent_rendered_test(
+        rendered_test,
+        class_indent
+      )
+
+      lines.insert(
+        closing_index,
+        "\n#{indented_test.rstrip}\n"
+      )
+
+      lines.join
+    end
+
+    private
+
+    def find_test_class(lines)
+      exact_name = test_class_name
+      short_name = test_class_name.split("::").last
+
+      exact_matches = class_matches(
+        lines,
+        exact_name
+      )
+
+      matches =
+        if exact_matches.any?
+          exact_matches
+        else
+          class_matches(
+            lines,
+            short_name
+          )
+        end
+
+      if matches.empty?
+        raise Error,
+              "RailsProof could not find " \
+              "#{test_class_name} < #{superclass}"
+      end
+
+      if matches.count > 1
+        raise Error,
+              "RailsProof found multiple candidate " \
+              "test classes for #{test_class_name}"
+      end
+
+      matches.first
+    end
+
+    def class_matches(lines, class_name)
+      pattern =
+        /\A(?<indent>[ \t]*)class\s+#{Regexp.escape(class_name)}\s*<\s*#{Regexp.escape(superclass)}\s*(?:#.*)?\r?\n?\z/
+
+      lines.each_with_index.filter_map do |line, index|
+        match = line.match(pattern)
+        next unless match
+
+        [
+          index,
+          match[:indent]
+        ]
+      end
+    end
+
+    def find_class_end(
+      lines,
+      class_index,
+      class_indent
+    )
+      pattern =
+        /\A#{Regexp.escape(class_indent)}end(?:\s*#.*)?\s*\z/
+
+      closing_index =
+        ((class_index + 1)...lines.length).find do |index|
+          lines[index].match?(pattern)
+        end
+
+      return closing_index if closing_index
+
+      raise Error,
+            "RailsProof could not find the end of #{test_class_name}"
+    end
+
+    def indent_rendered_test(
+      rendered_test,
+      class_indent
+    )
+      lines = rendered_test.rstrip.lines
+
+      nonblank_lines = lines.reject do |line|
+        line.strip.empty?
+      end
+
+      source_indent =
+        nonblank_lines
+          .map { |line| line[/\A[ \t]*/].length }
+          .min || 0
+
+      target_indent = "#{class_indent}  "
+
+      lines.map do |line|
+        if line.strip.empty?
+          ""
+        else
+          content = line[source_indent..]
+
+          "#{target_indent}#{content.rstrip}"
+        end
+      end.join("\n")
+    end
+  end
+end

data/lib/rails_proof/version.rb

@@ -1,3 +1,3 @@
 module RailsProof
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_proof
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Oak Harbor Ventures, LLC
@@ -63,6 +63,7 @@ files:
 - lib/rails_proof/review_store.rb
 - lib/rails_proof/target_discovery.rb
 - lib/rails_proof/test_coverage_plan.rb
+- lib/rails_proof/test_file_inserter.rb
 - lib/rails_proof/test_inspector.rb
 - lib/rails_proof/test_runner.rb
 - lib/rails_proof/test_writer.rb