crispr 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 321944f554596b5fd91d57f1e86190394c64d6d46d5108a13d587a60798902ab
-  data.tar.gz: f20d189e725811d51b849714654c89e3d36fc553bfb80723208a0baf2d3a545b
+  metadata.gz: d070d677dfe3f0926fff8ddf0a2f31aae859ed65a5fdeb76164eaf180a2fc921
+  data.tar.gz: 1a76d002b52a92f4ff756eb11cac032dbaccda83e23fec8bbbfa4ababbfe64a9
 SHA512:
-  metadata.gz: 74b9b78ef2c606dbaecaa0459fc21f98b25c5ec9b47ea930d6f8dd3b3638e81e3f7534f899fcf971138f349e592bef98c72bdbd497a5919de42e66887e9e9f08
-  data.tar.gz: d3c74eee1b0533eb806141b69e2d8c58b66fac2ab5aea1fc3a98a7835d5c1c603cf42d5e2825d458ee622335cd2fe949a25ad137eae6268472d4233dfee434d6
+  metadata.gz: 7bdf7c8476653270d00188101b87ae5b3de8fbcd6c6d5c572211ed35833dbbd88ad3f9e69fe9abd3921567e7914a50899bc071071f50547dc273b560b0823a5e
+  data.tar.gz: cf43c052481ebd7f10d4eaa67056d46e8e85e76419af7675e5b960b743a096e22cbd967bffebfbf86099e693e9f092847f9344e44748c1e5101dac298255ce97

data/.rubocop.yml

@@ -1,6 +1,29 @@
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 3.1
 
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 100
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 

data/bin/crispr

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "crispr"
+
+Crispr::CLI.run

data/lib/crispr/cli.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "crispr/mutator"
+require "crispr/runner"
+require "crispr/reporter"
+
+module Crispr
+  # Provides the command-line interface for the Crispr gem.
+  # Handles argument parsing and invokes the mutation and runner logic.
+  class CLI
+    def self.run(argv = ARGV)
+      command = argv.shift
+      case command
+      when "run"
+        input_path = argv.shift
+        unless input_path && File.exist?(input_path)
+          puts "Error: Please specify a valid Ruby file or directory to mutate."
+          exit 1
+        end
+
+        paths = File.directory?(input_path) ? Dir.glob("#{input_path}/**/*.rb") : [input_path]
+
+        reporter = Crispr::Reporter.new
+
+        paths.each do |path|
+          source = File.read(path)
+          mutator = Crispr::Mutator.new(source)
+          mutations = mutator.mutations
+
+          if mutations.empty?
+            puts "No mutations found in #{path}."
+            next
+          end
+
+          mutations.each_with_index do |mutated, index|
+            puts "Running mutation #{index + 1}/#{mutations.size} on #{path}..."
+            killed = Crispr::Runner.run_mutation(path: path, mutated_source: mutated)
+            reporter.record(killed: killed)
+            puts killed ? "💥 Mutation killed" : "⚠️ Mutation survived"
+          end
+        end
+
+        summary = reporter.summary
+        puts
+        puts "Mutations: #{summary[:mutations]}"
+        puts "💥 Killed: #{summary[:killed]}"
+        puts "⚠️ Survived: #{summary[:survived]}"
+        puts "Score: #{summary[:score]}%"
+      else
+        puts "Usage: crispr run path/to/file.rb"
+        exit 1
+      end
+    end
+  end
+end

data/lib/crispr/mutations/boolean_mutations.rb

@@ -0,0 +1,28 @@
+# rubocop:disable Lint/BooleanSymbol
+# frozen_string_literal: true
+
+module Crispr
+  module Mutations
+    # Provides boolean-specific AST mutations.
+    # Currently supports toggling `true` to `false` and `false` to `true`.
+    module BooleanMutations
+      # Returns a list of stringified mutated forms for the given boolean AST node.
+      #
+      # @param node [Parser::AST::Node] the AST node to inspect
+      # @return [Array<String>] mutated Ruby source code strings
+      def self.mutations_for(node)
+        return [] unless node.is_a?(Parser::AST::Node)
+
+        case node.type
+        when :true
+          [Unparser.unparse(Parser::AST::Node.new(:false))]
+        when :false
+          [Unparser.unparse(Parser::AST::Node.new(:true))]
+        else
+          []
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Lint/BooleanSymbol

data/lib/crispr/mutator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "parser/current"
+require "unparser"
+require_relative "mutations/boolean_mutations"
+
+module Crispr
+  # Mutator performs simple AST mutations on Ruby source code.
+  # Currently, it supports changing `true` literals to `false` and vice versa.
+  class Mutator
+    def initialize(source_code)
+      @source_code = source_code
+    end
+
+    def mutations
+      ast = Parser::CurrentRuby.parse(@source_code)
+      return [] unless ast
+
+      find_mutations(ast)
+    end
+
+    private
+
+    def find_mutations(node)
+      return [] unless node.is_a?(Parser::AST::Node)
+
+      local_mutations = Crispr::Mutations::BooleanMutations.mutations_for(node)
+      child_mutations = node.children.flat_map { |child| find_mutations(child) }
+
+      local_mutations + child_mutations
+    end
+  end
+end

data/lib/crispr/reporter.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Crispr
+  # Reporter collects mutation testing results and prints a summary.
+  class Reporter
+    # Initializes a new Reporter.
+    def initialize
+      @killed = 0
+      @survived = 0
+    end
+
+    # Records the result of a mutation test.
+    #
+    # @param killed [Boolean] whether the mutation was killed
+    # @return [void]
+    def record(killed:)
+      killed ? @killed += 1 : @survived += 1
+    end
+
+    # Returns the mutation score as a percentage.
+    #
+    # @return [Float] the mutation score
+    def score
+      total = @killed + @survived
+      total.zero? ? 0.0 : (@killed.to_f / total * 100).round(2)
+    end
+
+    # Returns a summary of mutation results.
+    #
+    # @return [Hash] summary statistics including totals and score
+    def summary
+      total = @killed + @survived
+      {
+        mutations: total,
+        killed: @killed,
+        survived: @survived,
+        score: score
+      }
+    end
+  end
+end

data/lib/crispr/runner.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Crispr
+  # Runner is responsible for executing tests against mutated code.
+  # It temporarily replaces the file's source with a mutated version,
+  # runs the test suite, and restores the original file afterward.
+  class Runner
+    # Runs the test suite with the mutated source code for the given file path.
+    #
+    # @param path [String] the path to the source file to mutate
+    # @param mutated_source [String] the mutated version of the file's source code
+    # @param test_path [String, nil] optional path to a specific test file to run
+    # @return [Boolean] true if the mutation was killed (test suite failed), false otherwise
+    def self.run_mutation(path:, mutated_source:, test_path: nil)
+      original_source = File.read(path)
+
+      begin
+        File.write(path, mutated_source)
+
+        test_cmd = test_path ? "bundle exec rspec #{test_path}" : "bundle exec rspec"
+        stdout, stderr, status = Open3.capture3(test_cmd)
+        killed = !status.success?
+
+        puts stdout unless status.success?
+        puts stderr unless status.success?
+
+        killed
+      ensure
+        File.write(path, original_source)
+      end
+    end
+  end
+end

data/lib/crispr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Crispr
-  VERSION = "0.1.0"
+  VERSION = "0.1.3"
 end

data/lib/crispr.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require_relative "crispr/version"
+require_relative "crispr/mutator"
+require_relative "crispr/runner"
+require_relative "crispr/cli"
 
 module Crispr
   class Error < StandardError; end

metadata

@@ -1,19 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: crispr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Aaron F Stanton
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: unparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Crispr is a mutation testing tool for Ruby that introduces small code
   mutations to verify the effectiveness of your test suite.
 email:
 - afstanton@gmail.com
-executables: []
+executables:
+- crispr
 extensions: []
 extra_rdoc_files: []
 files:
@@ -22,7 +51,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/crispr
 - lib/crispr.rb
+- lib/crispr/cli.rb
+- lib/crispr/mutations/boolean_mutations.rb
+- lib/crispr/mutator.rb
+- lib/crispr/reporter.rb
+- lib/crispr/runner.rb
 - lib/crispr/version.rb
 - sig/crispr.rbs
 homepage: https://github.com/afstanton/crispr
@@ -33,6 +68,7 @@ metadata:
   homepage_uri: https://github.com/afstanton/crispr
   source_code_uri: https://github.com/afstanton/crispr
   changelog_uri: https://github.com/afstanton/crispr/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib