pinspec 0.1.0

data/templates/spec_support.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module PinspecSupport
+  def pinspec_guard_env!(expected)
+    actual = ENV["TZ"].to_s
+    return if expected.to_s.empty?
+    return if actual == expected.to_s
+
+    raise <<~MESSAGE
+      pinspec: this pin was captured with TZ=#{expected}, but this process has
+      TZ=#{actual.empty? ? '(unset)' : actual}.
+
+      The target reads the process clock (see the warning in this spec's header),
+      so the pinned values are only valid under the capture's timezone. Re-run with
+      TZ=#{expected}, or re-capture under this one.
+    MESSAGE
+  end
+
+  def pinspec_refs(records, result = nil)
+    refs = {}
+
+    records.each do |name, record|
+      next if record.nil?
+
+      refs["#{record.class.table_name}:#{record.id}"] = name.to_s
+    end
+
+    if defined?(ActiveRecord::Base) && result.is_a?(ActiveRecord::Base) && !result.id.nil?
+      refs["#{result.class.table_name}:#{result.id}"] = "__returned__"
+    end
+
+    refs
+  end
+
+  def pinspec_jobs_from(refs_for, fk_map)
+    pinspec_clear_sinks
+    result = yield
+    refs = refs_for.call(result)
+
+    jobs = ActiveJob::Base.queue_adapter.enqueued_jobs.map do |job|
+      {
+        "job" => job[:job].to_s,
+        "queue" => job[:queue].to_s,
+        "args" => PinspecSerializer.normalize(job[:args], refs: refs, fk_map: fk_map)
+      }
+    end
+
+    [result, jobs]
+  end
+
+  def pinspec_deliveries
+    ActionMailer::Base.deliveries.map do |mail|
+      { "to" => Array(mail.to).join(","), "subject" => mail.subject.to_s }
+    end
+  end
+
+  def pinspec_clear_sinks
+    if defined?(ActiveJob::Base) && ActiveJob::Base.queue_adapter.respond_to?(:enqueued_jobs)
+      ActiveJob::Base.queue_adapter.enqueued_jobs.clear
+      ActiveJob::Base.queue_adapter.performed_jobs.clear
+    end
+
+    ActionMailer::Base.deliveries.clear if defined?(ActionMailer::Base)
+  end
+end
+
+RSpec.configure do |config|
+  config.include PinspecSupport, pinspec: true
+
+  config.around(:each, pinspec: true) do |example|
+    previous = defined?(ActiveJob::Base) ? ActiveJob::Base.queue_adapter : nil
+    ActiveJob::Base.queue_adapter = :test if defined?(ActiveJob::Base)
+
+    if defined?(ActionMailer::Base)
+      ActionMailer::Base.delivery_method = :test
+      ActionMailer::Base.perform_deliveries = true
+    end
+
+    example.run
+
+    ActiveJob::Base.queue_adapter = previous if previous
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: pinspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rehan Munir
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: |
+  Point pinspec at a Rails service object or model method and it works out how to
+  invoke it, executes it against your test database, and emits an idiomatic RSpec
+  file that freezes the current behavior - then verifies that file runs green in
+  your app's own test environment.
+email:
+- rehanir.munir@gmail.com
+executables:
+- pinspec
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/pinspec
+- lib/pinspec.rb
+- lib/pinspec/analyzer/app_profile_reader.rb
+- lib/pinspec/analyzer/factory_registry.rb
+- lib/pinspec/analyzer/inflector.rb
+- lib/pinspec/analyzer/schema_reader.rb
+- lib/pinspec/analyzer/source.rb
+- lib/pinspec/analyzer/target_parser.rb
+- lib/pinspec/cli.rb
+- lib/pinspec/emit/namer.rb
+- lib/pinspec/emit/spec_writer.rb
+- lib/pinspec/emit/stability_filter.rb
+- lib/pinspec/errors.rb
+- lib/pinspec/inputs/boundary.rb
+- lib/pinspec/inputs/corpus.rb
+- lib/pinspec/inputs/hydrator.rb
+- lib/pinspec/inputs/redactor.rb
+- lib/pinspec/inputs/sample_runner.rb
+- lib/pinspec/inputs/sampler.rb
+- lib/pinspec/report/summary.rb
+- lib/pinspec/runner/capture.rb
+- lib/pinspec/runner/probe_generator.rb
+- lib/pinspec/runner/sandbox.rb
+- lib/pinspec/setup/context_builder.rb
+- lib/pinspec/setup/dependency_resolver.rb
+- lib/pinspec/tags.rb
+- lib/pinspec/types.rb
+- lib/pinspec/validate/mutation_adapter.rb
+- lib/pinspec/validate/pin_scorer.rb
+- lib/pinspec/verify/verifier.rb
+- lib/pinspec/version.rb
+- templates/factory_build.rb
+- templates/serializer.rb
+- templates/spec_support.rb
+homepage: https://github.com/rehanmunir/pinspec
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/rehanmunir/pinspec
+  changelog_uri: https://github.com/rehanmunir/pinspec/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/rehanmunir/pinspec/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Characterization-test harness for legacy Rails codebases.
+test_files: []