be-let-it-be 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a90cf24bfc3bff9e7fae3cf454c213cb9e98d2e75f7fa2a0461579de14ae9f55
+  data.tar.gz: bb50797917fcf5dd15d3bf51b4a71d7353a9425341e15fd6ab5a052192c98e39
+SHA512:
+  metadata.gz: 17c94400b69be02e85c41769ab2ac214d6c38ca56f9d86748158589a06d0d65f7c17774573b61086e0e557a7a485fdbce8008c584b115d551221f15fffe347f1
+  data.tar.gz: 790225081995f8772b01b8ae08273d6fceddd6907a15c09e14bc8e8164db3fdfd0b1062195d12aa752705a12ad8e5473c84316b5d4c0d613c4b6bdeb3b0d644d

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-06-08
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 moznion
+
+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,158 @@
+# be-let-it-be
+
+[![Ruby](https://github.com/moznion/be-let-it-be/actions/workflows/main.yml/badge.svg)](https://github.com/moznion/be-let-it-be/actions/workflows/main.yml)
+
+A command-line tool that automatically converts RSpec's `let` and `let!` declarations to `let_it_be` where it's safe to do so. The tool runs your tests after each conversion to ensure they still pass, making the optimization process safe and reliable.
+
+## Motivation
+
+One of the main motivations is to improve test speed.
+
+### What is `let_it_be`?
+
+`let_it_be` is a helper provided by the [test-prof](https://github.com/test-prof/test-prof) gem that caches test data across examples instead of recreating it for each test. This can significantly improve test performance, especially for expensive object creation like database records.
+
+### Performance Benefits
+
+Using `let_it_be` can significantly improve test performance by:
+
+- Reducing database queries
+- Minimizing object instantiation overhead
+- Sharing immutable test data across examples
+
+Performance gains are especially noticeable with:
+
+- Factory-created database records
+- Complex object initialization
+- Large test suites
+
+## How It Works
+
+1. Parse: Analyzes your RSpec file using Ruby's Abstract Syntax Tree
+2. Identify: Finds all `let` and `let!` declarations
+3. Convert & Test: For each declaration:
+  - Converts it to `let_it_be`
+  - Runs your tests
+  - Keeps the change if tests pass, reverts if they fail
+4. Save: Writes the successfully converted file, or it outputs the result if it's in dryrun mode
+
+## Example Conversion
+
+Before:
+
+```ruby
+RSpec.describe User do
+  let!(:admin) { create(:user, admin: true) }
+  let(:user) { create(:user) }
+  let(:posts) { user.posts }
+  let(:mutable_array) { [] }
+
+  it "modifies the array" do
+    mutable_array << 1
+    expect(mutable_array).to eq([1])
+  end
+end
+```
+
+After:
+
+```ruby
+RSpec.describe User do
+  let_it_be(:admin) { create(:user, admin: true) }
+  let_it_be(:user) { create(:user) }
+  let(:posts) { user.posts }  # Kept as 'let' due to dependency
+  let(:mutable_array) { [] }  # Kept as 'let' because tests modify it
+
+  it "modifies the array" do
+    mutable_array << 1
+    expect(mutable_array).to eq([1])
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development, :test do
+  gem 'be-let-it-be'
+end
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install be-let-it-be
+```
+
+## Prerequisites
+
+- Ruby 3.3.0 or higher
+- Your project must have [test-prof](https://github.com/test-prof/test-prof) installed, as `let_it_be` is a feature provided by that gem
+
+## Usage
+
+### Basic Usage
+
+Convert a single spec file:
+
+```bash
+be-let-it-be convert spec/models/user_spec.rb
+```
+
+### Options
+
+- `--dryrun` - Show what would be converted without making actual changes
+- `--verbose` - Display detailed processing information
+- `--rspec_cmd` - Customize the RSpec command used for verification (default: "rspec")
+
+### Examples
+
+```bash
+# Dry-run to preview changes
+be-let-it-be convert spec/models/user_spec.rb --dryrun
+
+# Verbose output for debugging
+be-let-it-be convert spec/models/user_spec.rb --verbose
+
+# Use custom RSpec command
+be-let-it-be convert spec/models/user_spec.rb --rspec_cmd="rspec --format progress"
+```
+
+## When NOT to Use `let_it_be`
+
+The tool automatically detects when conversions would break tests, but it's good to understand when `let_it_be` isn't appropriate:
+
+- Mutable objects: When tests modify the object state
+- Test-specific state: When the value depends on test-specific setup
+- Fresh instances: When each test requires a completely new instance
+
+## Current Limitations
+
+- Originally, the replacement of `let` and `let!` should adopt the combination that provides the most optimized execution time. However, attempting to do so would likely cause combinatorial explosion, making it non-trivial to implement. Therefore, we currently use a simple approach of replacing them in order of appearance. We plan to address this optimization in the future.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/moznion/be-let-it-be. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/moznion/be-let-it-be/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the be-let-it-be project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/moznion/be-let-it-be/blob/main/CODE_OF_CONDUCT.md).
+

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/bin/be-let-it-be

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "be_let_it_be"
+
+BeLetItBe::CLI.start(ARGV)

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "be_let_it_be"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/be_let_it_be/analyzer.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "parser/current"
+
+module BeLetItBe
+  class Analyzer
+    def initialize(file)
+      @ast = Parser::CurrentRuby.parse(File.read(file))
+    end
+
+    def find_lets
+      traverse(@ast, [])
+    end
+
+    private
+
+    def traverse(node, lets)
+      # FIXME: lets should be immutable
+      return lets unless node.is_a?(Parser::AST::Node)
+
+      let_info = extract_let_info(node)
+      lets << let_info unless let_info.nil?
+
+      node.children.each do |child|
+        traverse(child, lets) if child.is_a?(Parser::AST::Node)
+      end
+
+      lets
+    end
+
+    def extract_let_info(node)
+      return nil unless node.type == :send
+      return nil unless node.children[0].nil?
+
+      method_name = node.children[1]
+      return nil unless %i[let let!].include?(method_name)
+
+      args = node.children[2]
+      let_name = args.children[0]
+      return nil unless args && args.type == :sym
+
+      line = node.location.line
+
+      {type: method_name, name: let_name, line:, node:}
+    end
+  end
+end

data/lib/be_let_it_be/cli.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "thor"
+require "parser/current"
+require "unparser"
+require "open3"
+
+module BeLetItBe
+  class CLI < Thor
+    desc "convert FILE", "Convert let/let! to let_it_be in RSpec file"
+    option :dryrun, type: :boolean, default: false, desc: "Show what would be converted without modifying files"
+    option :verbose, type: :boolean, default: false, desc: "Show the processing output verboselly"
+    option :rspec_cmd, type: :string, default: "bundle exec rspec", desc: "RSpec command to check the behaviour"
+
+    def convert(file)
+      @processed_let_lines = []
+
+      unless File.exist?(file)
+        error "File not found: #{file}"
+        exit 1
+      end
+
+      unless run_rspec(file)
+        error "Initial RSpec test failed. Aborting."
+        exit 1
+      end
+      say "Initial tests passed. Starting conversion..."
+
+      temp_file = file + ".temp"
+      begin
+        File.write(temp_file, File.read(file))
+
+        processed_num = 0
+        converted_count = 0
+        lets = extract_let_info(file)
+        num_of_lets = lets.length
+
+        if num_of_lets.zero?
+          say "no let/let! in the given spec; do nothing"
+          exit 0
+        end
+
+        say "Found #{num_of_lets} let/let! definitions:"
+        lets.each { |let| say "  - #{let[:type]} :#{let[:name]} at #{file}:#{let[:line]}" }
+
+        until lets.empty?
+          processed_num += 1
+          converter = Converter.new(temp_file)
+          let = lets.first
+
+          say "[#{processed_num}/#{num_of_lets}] Testing conversion of #{let[:type]} :#{let[:name]} at #{file}:#{let[:line]}"
+
+          if converter.try_conversion_single_let(let, temp_file, -> { run_rspec(temp_file) })
+            say "  ✓ Converted to let_it_be"
+            converter = Converter.new(temp_file) # pile the converted items
+            converted_count += 1
+          else
+            say "  ✗ Keeping original #{let[:type]} (test failed with let_it_be)"
+          end
+
+          @processed_let_lines << let[:line]
+          lets = extract_let_info(temp_file)
+        end
+
+        if converted_count > 0
+          if options[:dryrun]
+            puts File.read(temp_file)
+          else
+            File.write(file, File.read(temp_file))
+          end
+          say "✅ Successfully converted #{converted_count} out of #{lets.size} definitions to let_it_be"
+        else
+          say "❌ No conversions were possible (all tests failed with let_it_be)"
+        end
+      ensure
+        File.unlink(temp_file) if File.exist?(temp_file)
+      end
+    end
+
+    private
+
+    def extract_let_info(file)
+      analyzer = Analyzer.new(file)
+      lets = analyzer.find_lets
+
+      lets.filter { |l| !@processed_let_lines.include?(l[:line]) }
+    end
+
+    def say(msg)
+      return unless options[:verbose]
+
+      puts msg
+    end
+
+    def run_rspec(file)
+      cmd = "#{options[:rspec_cmd]} #{file}"
+      say "Running: #{cmd}"
+
+      stdout, stderr, status = Open3.capture3(cmd)
+
+      say "RSpec output:"
+      say stdout
+      say stderr if stderr && !stderr.empty?
+
+      status.success?
+    end
+  end
+end

data/lib/be_let_it_be/converter.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "parser/current"
+require "unparser"
+require "tempfile"
+
+module BeLetItBe
+  class Converter
+    def initialize(file)
+      @file = file
+    end
+
+    def try_conversion_single_let(let_info, output_file, exam)
+      source = File.read(@file)
+      buffer = Parser::Source::Buffer.new(@file, source:)
+
+      temp_rewriter = Parser::Source::TreeRewriter.new(buffer)
+      apply_single_conversion(let_info, temp_rewriter)
+      File.write(output_file, temp_rewriter.process)
+
+      passed = exam.call
+      unless passed
+        File.write(output_file, source) # revert changes
+      end
+      passed
+    end
+
+    private
+
+    def apply_single_conversion(let_info, rewriter)
+      node = let_info[:node]
+      method_range = node.loc.selector
+
+      rewriter.replace(method_range, "let_it_be")
+    end
+  end
+end

data/lib/be_let_it_be/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BeLetItBe
+  VERSION = "0.0.1"
+end

data/lib/be_let_it_be.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "be_let_it_be/version"
+require_relative "be_let_it_be/cli"
+require_relative "be_let_it_be/analyzer"
+require_relative "be_let_it_be/converter"
+
+module BeLetItBe
+  class Error < StandardError; end
+end

data/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ]
+}

data/sig/be_let_it_be.rbs

@@ -0,0 +1,4 @@
+module BeLetItBe
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: be-let-it-be
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- moznion
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: unparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: A command-line tool that analyzes RSpec files and converts let/let! to
+  let_it_be where tests still pass
+email:
+- moznion@mail.moznion.net
+executables:
+- be-let-it-be
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/be-let-it-be
+- bin/console
+- bin/setup
+- lib/be_let_it_be.rb
+- lib/be_let_it_be/analyzer.rb
+- lib/be_let_it_be/cli.rb
+- lib/be_let_it_be/converter.rb
+- lib/be_let_it_be/version.rb
+- renovate.json
+- sig/be_let_it_be.rbs
+homepage: https://github.com/moznion/be-let-it-be
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/moznion/be-let-it-be
+  source_code_uri: https://github.com/moznion/be-let-it-be
+  changelog_uri: https://github.com/moznion/be-let-it-be/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Convert RSpec let/let! to let_it_be where possible
+test_files: []