factory_sloth 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93e7cdb1f418a30bf140f3b28ce646bcbf9d46302b45bb105948c32ceee042ff
+  data.tar.gz: b019faddee1c76fa58feb3129df86b6af87087c12f94ce8daddfaa5cfe14408a
+SHA512:
+  metadata.gz: eab4ae49740dc1c9ded502ea5af2558e3edc441bf7a5527f8d382ae7bb71da9dd0bac816beb75572b1c3afdc18d89c7c402e567d90c1302b95b5232f293a43a9
+  data.tar.gz: 6c184366974c8428d81f800d063c10a243c8c7989154f9c7b5dfcb27651af85723fcd04d2b24d1b84819f62ab5150eb3ee3d52c5bb8bea950c56b5ff744ba484

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2023-05-14
+
+- Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in factory_sloth.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "simplecov-cobertura", "~> 2.1"

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    factory_sloth (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    rake (13.0.6)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (2.1.0)
+      rexml
+      simplecov (~> 0.19)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+
+PLATFORMS
+  arm64-darwin-21
+  ruby
+
+DEPENDENCIES
+  factory_sloth!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  simplecov-cobertura (~> 2.1)
+
+BUNDLED WITH
+   2.4.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Janosch Müller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# FactorySloth 🦥
+
+[![Gem Version](https://badge.fury.io/rb/factory_sloth.svg)](http://badge.fury.io/rb/factory_sloth)
+[![Build Status](https://github.com/jaynetics/factory_sloth/actions/workflows/tests.yml/badge.svg)](https://github.com/jaynetics/factory_sloth/actions)
+
+`factory_sloth` is too lazy to write to the database.
+
+It finds unnecessary [factory_bot](https://github.com/thoughtbot/factory_bot) `create` calls and replaces them with less laborious `build` or `build_stubbed` calls to speed up your test suite.
+
+## Installation
+
+`bundle add factory_sloth` or `gem install factory_sloth`.
+
+## Usage
+
+Output of `factory_sloth --help`:
+
+```
+Usage: factory_sloth [path1, path2, ...] [options]
+
+Examples:
+  factory_sloth # run for all specs
+  factory_sloth spec/models
+  factory_sloth spec/foo_spec.rb spec/bar_spec.rb
+
+Options:
+    -f, --force                      Ignore ./.factory_sloth_done
+    -l, --lint                       Dont fix, just list bad create calls
+    -v, --version                    Show gem version
+    -h, --help                       Show this help
+```
+
+`factory_sloth` runs the changed specs to see if they still work. This takes a while for all possible changes - usually multiple times as long as the specs would normally take to run! For this reason, the gem creates a `.factory_sloth_done` file. This is a list of specs that have already been processed. It makes it possible to interrupt the program and continue later. You can delete this file to start over or ignore it with `-f`.
+
+While running, `factory_sloth` produces output like this:
+
+```
+Processing spec/features/sign_up_spec.rb ...
+🟡 2 create calls found, 0 replaced
+
+Processing spec/lib/string_ext_spec.rb ...
+⚪️ 0 create calls found, 0 replaced
+
+Processing spec/models/user_spec.rb ...
+- create in line 3 can be replaced with build
+- create in line 4 can be replaced with build
+🟢 3 create calls found, 2 replaced
+
+Processing spec/weird_dir/crazy_spec.rb ...
+- create in line 8 can be replaced with build_stubbed
+🔴 33 create calls found, 0 replaced (conflict)
+```
+
+The `conflict` case is rare. It only happens if individual examples were green after changing them, but at least one example failed when evaluating the whole file after all changes. This probably means that some other example was red even before making changes, or that something else is wrong with this spec file, e.g. some examples depend on other examples' side effects.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jaynetics/factory_sloth.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Similar projects
+
+- [factory_trace](https://github.com/djezzzl/factory_trace) finds unused factories
+- [rspectre](https://github.com/dgollahon/rspectre) finds unused test setup
+- [rubocop-factory_bot](https://github.com/rubocop/rubocop-factory_bot) provides rubocop linters for factories

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/factory_sloth

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative File.join(__dir__, '..', 'lib', 'factory_sloth')
+
+FactorySloth::CLI.call

data/lib/factory_sloth/cli.rb

@@ -0,0 +1,55 @@
+require 'optparse'
+
+module FactorySloth
+  module CLI
+    extend self
+
+    def call(argv = ARGV)
+      args = option_parser.parse!(argv)
+      specs = SpecPicker.call(paths: args)
+      forced_files = @force ? specs : args
+      bad_specs = FileProcessor.call(files: specs, forced_files: forced_files, dry_run: @lint)
+
+      if @lint && bad_specs.any?
+        warn "Found unnecessary create calls in:\n#{bad_specs.join("\n")}"
+        exit 1
+      end
+    end
+
+    private
+
+    def option_parser
+      OptionParser.new do |opts|
+        opts.banner = <<~SH
+          Usage: factory_sloth [path1, path2, ...] [options]
+
+          Examples:
+            factory_sloth # run for all specs
+            factory_sloth ./spec/models
+            factory_sloth ./spec/foo_spec.rb ./spec/bar_spec.rb
+
+        SH
+
+        opts.separator 'Options:'
+
+        opts.on('-f', '--force', "Ignore #{DoneTracker.file}") do
+          @force = true
+        end
+
+        opts.on('-l', '--lint', 'Dont fix, just list bad create calls') do
+          @lint = true
+        end
+
+        opts.on('-v', '--version', 'Show gem version') do
+          puts "factory_sloth #{FactorySloth::VERSION}"
+          exit
+        end
+
+        opts.on('-h', '--help', 'Show this help') do
+          puts opts
+          exit
+        end
+      end
+    end
+  end
+end

data/lib/factory_sloth/code_mod.rb

@@ -0,0 +1,62 @@
+require 'tempfile'
+
+class FactorySloth::CodeMod
+  attr_reader :change_count, :create_count, :ok, :original_code, :patched_code
+  alias_method :ok?, :ok
+
+  def self.call(code)
+    new(code).tap(&:call)
+  end
+
+  def initialize(code)
+    self.change_count = 0
+    self.original_code = code
+    self.patched_code = code
+  end
+
+  def call
+    create_calls = FactorySloth::CreateCallFinder.call(code: original_code)
+
+    # Performance note: it might be faster to write ALL possible patches for a
+    # given spec file to tempfiles first, and then run them all in a single
+    # rspec call. However, this would make it impossible to use `--fail-fast`,
+    # and might make examples fail that are not as idempotent as they should be.
+    create_calls.sort_by { |line, col| [-line, -col] }.each do |line, col|
+      try_patch(line, col, 'build') || try_patch(line, col, 'build_stubbed')
+    end
+
+    # validate whole spec after changes, e.g. to detect side-effects
+    self.ok = spec_code_passes?(patched_code)
+    self.change_count = 0 unless ok?
+    self.patched_code = original_code unless ok?
+    self.create_count = create_calls.count
+  end
+
+  def changed?
+    change_count > 0
+  end
+
+  private
+
+  attr_writer :change_count, :create_count, :ok, :original_code, :patched_code
+
+  def try_patch(line, col, variant)
+    new_patched_code =
+      patched_code.sub(/\A(?:.*\n){#{line - 1}}.{#{col}}\Kcreate/, variant)
+    if spec_code_passes?(new_patched_code, line: line)
+      puts "- create in line #{line} can be replaced with #{variant}"
+      self.patched_code = new_patched_code
+      self.change_count += 1
+    end
+  end
+
+  def spec_code_passes?(spec_code, line: nil)
+    tempfile = Tempfile.new
+    tempfile.write(spec_code)
+    tempfile.close
+    path = [tempfile.path, line].compact.map(&:to_s).join(':')
+    result = !!system("bundle exec rspec #{path} --fail-fast &> /dev/null")
+    tempfile.unlink
+    result
+  end
+end

data/lib/factory_sloth/create_call_finder.rb

@@ -0,0 +1,35 @@
+require 'ripper'
+
+class FactorySloth::CreateCallFinder < Ripper
+  attr_reader :locations
+
+  def self.call(code:)
+    new(code).tap(&:parse).locations
+  end
+
+  def initialize(...)
+    super
+    @locations = []
+  end
+  private_class_method :new
+
+  def on_ident(name, *)
+    [lineno, column] if %w[create create_list create_pair].include?(name)
+  end
+
+  def on_call(mod, _, loc, *)
+    @locations << loc if loc.instance_of?(Array) && mod == 'FactoryBot'
+  end
+
+  def on_command_call(mod, _, loc, *)
+    @locations << loc if loc.instance_of?(Array) && mod == 'FactoryBot'
+  end
+
+  def on_fcall(loc, *)
+    @locations << loc if loc.instance_of?(Array)
+  end
+
+  def on_vcall(loc, *)
+    @locations << loc if loc.instance_of?(Array)
+  end
+end

data/lib/factory_sloth/done_tracker.rb

@@ -0,0 +1,32 @@
+module FactorySloth::DoneTracker
+  extend self
+
+  def done?(path)
+    done.include?(normalize(path))
+  end
+
+  def mark_as_done(path)
+    normalized_path = normalize(path)
+    done << normalized_path
+    File.open(file, 'a') { |f| f.puts(normalized_path) }
+  end
+
+  def reset
+    File.unlink(file) if File.exist?(file)
+    done.clear
+  end
+
+  def file
+    './.factory_sloth_done'
+  end
+
+  private
+
+  def normalize(path)
+    path.start_with?('./') || path.start_with?('/') ? path : "./#{path}"
+  end
+
+  def done
+    @done ||= File.exist?(file) ? File.readlines(file, chomp: true) : []
+  end
+end

data/lib/factory_sloth/file_processor.rb

@@ -0,0 +1,47 @@
+module FactorySloth
+  module FileProcessor
+    extend self
+
+    def call(files:, forced_files: [], dry_run: false)
+      files.select do |path|
+        puts "Processing #{path} ..."
+
+        if DoneTracker.done?(path) && !forced_files.include?(path)
+          puts "🔵 Skipped (marked as done in #{DoneTracker.file})", ''
+          next
+        end
+
+        bad_creates_found = process(path, dry_run: dry_run)
+        DoneTracker.mark_as_done(path)
+        bad_creates_found
+      end
+    end
+
+    private
+
+    def process(path, dry_run:)
+      code = File.read(path)
+      result = CodeMod.call(code)
+      unless dry_run
+        File.write(path, result.patched_code) if result.changed?
+      end
+      puts result_message(result, dry_run), ''
+      result.changed?
+    end
+
+    def result_message(result, dry_run)
+      stats = "#{result.create_count} create calls found, "\
+              "#{result.change_count} #{dry_run ? 'replaceable' : 'replaced'}"
+
+      return "🔴 #{stats} (conflict)" unless result.ok?
+
+      if result.create_count == 0
+        "⚪️ #{stats}"
+      elsif result.change_count == 0
+        "🟡 #{stats}"
+      else
+        "🟢 #{stats}"
+      end
+    end
+  end
+end

data/lib/factory_sloth/spec_picker.rb

@@ -0,0 +1,17 @@
+module FactorySloth::SpecPicker
+  extend self
+
+  def call(paths:)
+    paths = ['.'] if paths.empty?
+
+    paths.each_with_object([]) do |path, acc|
+      if File.directory?(path)
+        acc.concat(Dir["#{path.chomp('/')}/**/*_spec.rb"])
+      elsif File.exist?(path)
+        acc << path
+      else
+        raise ArgumentError, "no such file: #{path}"
+      end
+    end
+  end
+end

data/lib/factory_sloth/version.rb

@@ -0,0 +1,3 @@
+module FactorySloth
+  VERSION = '1.0.0'
+end

data/lib/factory_sloth.rb

@@ -0,0 +1,9 @@
+module FactorySloth; end
+
+require_relative 'factory_sloth/cli'
+require_relative 'factory_sloth/code_mod'
+require_relative 'factory_sloth/create_call_finder'
+require_relative 'factory_sloth/done_tracker'
+require_relative 'factory_sloth/file_processor'
+require_relative 'factory_sloth/spec_picker'
+require_relative 'factory_sloth/version'

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: factory_sloth
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Janosch Müller
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-14 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- janosch84@gmail.com
+executables:
+- factory_sloth
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/factory_sloth
+- lib/factory_sloth.rb
+- lib/factory_sloth/cli.rb
+- lib/factory_sloth/code_mod.rb
+- lib/factory_sloth/create_call_finder.rb
+- lib/factory_sloth/done_tracker.rb
+- lib/factory_sloth/file_processor.rb
+- lib/factory_sloth/spec_picker.rb
+- lib/factory_sloth/version.rb
+homepage: https://github.com/jaynetics/factory_sloth
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jaynetics/factory_sloth
+  source_code_uri: https://github.com/jaynetics/factory_sloth
+  changelog_uri: https://github.com/jaynetics/factory_sloth/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key:
+specification_version: 4
+summary: Find and replace unnecessary factory_bot create calls.
+test_files: []