mutant 0.8.20 → 0.8.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71ac041e8b933f1efd758494731566ff133404300a860e41362211c607fe5f0f
-  data.tar.gz: d49c6b977cbe88912d3c93203473a3704c4287737fbe3fff14a46aaf951bc2a9
+  metadata.gz: c6bbd702d5eebd39b5e1b55fe8ec3ee4a8c6cce207046b014340345409ac1478
+  data.tar.gz: d95121d3aff3ae3c764036a0b36229a2332aaf3b2f72b358b9098c6a694a0cac
 SHA512:
-  metadata.gz: 5f241945cdedc4d38fd3328b4321c0e685d87c3102d73c122baae658daf5b9b42423b9aa12070e23e42abae6f3232f5752d67cdc27c49c16d8fa150c259655be
-  data.tar.gz: 1400ba91b8275ee4c6a12af48ed05bd6bf1a0c290e16a227f87a81a251e536d269c71d9ca8d9d7fc4e4ba6b7dc02d3360061b2809fb21c58fcef9c7d708b89b6
+  metadata.gz: ef46516211349d4abad952ed4f285b2ba9d5d638fbfb666cd607cd9f46135acae8d06389a7658eaa3e25de243d1fec7ce6b3ae9fca83cfa1cdd83cb30cd4bb78
+  data.tar.gz: 12ee7c1507ddb9098d50da9db92b4dd8774140670b9c5b8c80c74e69c005617fa5b9abe30750e231328485ad43dc181e49564cf5e4ad2e16ba32310c72a36541

data/.circleci/config.yml

@@ -35,8 +35,6 @@ jobs:
       - run: bundle install
       - run: bundle exec rake metrics:rubocop
       - run: bundle exec rake metrics:reek
-      - run: bundle exec rake metrics:flay
-      - run: bundle exec rake metrics:flog
   mutant:
     <<: *defaults
     steps:

data/Changelog.md

@@ -1,3 +1,7 @@
+# v0.8.21 2018-12-03
+
+* Change to modern ast format via unparser-0.4.1.
+
 # v0.8.20 2018-11-27
 
 * Replace internal timers with monotonic ones.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mutant (0.8.19)
+    mutant (0.8.20)
       abstract_type (~> 0.0.7)
       adamantium (~> 0.2.0)
       anima (~> 0.3.0)
@@ -15,9 +15,9 @@ PATH
       parser (~> 2.5.1)
       procto (~> 0.0.2)
       regexp_parser (~> 1.2)
-      unparser (~> 0.3.0)
-    mutant-rspec (0.8.19)
-      mutant (~> 0.8.19)
+      unparser (~> 0.4.0)
+    mutant-rspec (0.8.20)
+      mutant (~> 0.8.20)
       rspec-core (>= 3.4.0, < 4.0.0)
 
 GEM
@@ -45,22 +45,22 @@ GEM
       equalizer (~> 0.0.9)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
-    devtools (0.1.21)
+    devtools (0.1.22)
       abstract_type (~> 0.0.7)
       adamantium (~> 0.2.0)
       anima (~> 0.3.0)
       concord (~> 0.1.5)
-      flay (~> 2.10.0)
-      flog (~> 4.6.1)
-      mutant (~> 0.8.16)
-      mutant-rspec (~> 0.8.16)
+      flay (~> 2.12.0)
+      flog (~> 4.6.2)
+      mutant (~> 0.8.19)
+      mutant-rspec (~> 0.8.19)
       procto (~> 0.0.3)
       rake (~> 12.3.0)
-      reek (~> 5.0.2)
+      reek (~> 5.2.0)
       rspec (~> 3.8.0)
       rspec-core (~> 3.8.0)
       rspec-its (~> 1.2.0)
-      rubocop (~> 0.59.0)
+      rubocop (~> 0.60.0)
       simplecov (~> 0.16.1)
       yard (~> 0.9.16)
       yardstick (~> 0.9.9)
@@ -68,7 +68,7 @@ GEM
     docile (1.3.1)
     equalizer (0.0.11)
     erubis (2.7.0)
-    flay (2.10.0)
+    flay (2.12.0)
       erubis (~> 2.7.0)
       path_expander (~> 1.0)
       ruby_parser (~> 3.0)
@@ -100,7 +100,7 @@ GEM
     procto (0.0.3)
     rainbow (3.0.0)
     rake (12.3.1)
-    reek (5.0.2)
+    reek (5.2.0)
       codeclimate-engine-rb (~> 0.4.0)
       kwalify (~> 0.7.0)
       parser (>= 2.5.0.0, < 2.6, != 2.5.1.1)
@@ -122,14 +122,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.59.2)
+    rubocop (0.60.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
+      unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.0)
     ruby_parser (3.11.0)
       sexp_processor (~> 4.9)
@@ -141,7 +141,7 @@ GEM
     simplecov-html (0.10.2)
     thread_safe (0.3.6)
     unicode-display_width (1.4.0)
-    unparser (0.3.0)
+    unparser (0.4.0)
       abstract_type (~> 0.0.7)
       adamantium (~> 0.2.0)
       concord (~> 0.1.5)
@@ -162,8 +162,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.10)
-  devtools (~> 0.1.21)
+  devtools (~> 0.1.22)
   mutant!
   parallel (~> 1.3)
 

data/README.md

@@ -7,12 +7,29 @@ mutant
 [![Gem Version](https://img.shields.io/gem/v/mutant.svg)](https://rubygems.org/gems/mutant)
 [![Slack Status](https://mutation-testing-slack.herokuapp.com/badge.svg)](https://mutation-testing.slack.com/messages/mutant)
 
-Mutant is a mutation testing tool for Ruby.
+## What is Mutant?
 
-The idea is that if code can be changed and your tests do not notice, then either that code isn't being covered
-or it does not have a speced side effect.
+Mutant is a mutation testing tool for Ruby. Mutation testing is a technique to verify semantic coverage of your code.
 
-Mutant supports ruby >= 2.5, MRI only.
+## Why do I want it?
+
+Mutant adds to your toolbox: Detection of uncovered semantics in your code.
+Coverage becomes a meaninful metric!
+
+On each detection of uncovered semantics you have the opportunity to:
+
+* Delete dead code, as you do not want the extra semantics not specified by the tests
+* Add (or improve a test) to cover the unwanted semantics.
+* Learn something new about the semantics of Ruby and your direct and indirect dependencies.
+
+## How Do I use it?
+
+* Start with reading the [nomenclature](/docs/nomenclature.md) documentation.
+* Than select and setup your [integration](/docs/nomenclature.md#interation), also make sure
+  you can reproduce the examples in the integration specific documentation.
+* Identify your preferred mutation testing strategy. Its recommended to start at the commit level,
+  to test only the code you had been touching. See the [incremental](#only-mutating-changed-code)
+  mutation testing documentation.
 
 Mutant uses a pure Ruby [parser](https://github.com/whitequark/parser) and an [unparser](https://github.com/mbj/unparser)
 to do its magic.

data/config/rubocop.yml

@@ -173,14 +173,13 @@ IndentArray:
 MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
-# Align keys and values in a multiline hash
-AlignHash:
-  EnforcedColonStyle: table
-
 # Prefer `public_send` and `__send__` over `send`
 Send:
   Enabled: true
 
+Layout/AlignHash:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 Layout/SpaceInsideArrayLiteralBrackets:

data/docs/mutant-minitest.md

@@ -55,6 +55,7 @@ All the setup described above is already done.
 
 ```sh
 git clone https://github.com/mbj/auom
+cd auom
 bundle install # gemfile references mutant-minitest already
 bundle exec mutant --include lib --require auom --use minitest -- 'AUOM*'
 ```
@@ -143,5 +144,6 @@ Mutations/s:     107.60
 Coverage:        99.90%
 ```
 
-This shows mutant detected the redundant alive conditional.
-Feel free to also remove some tests. Or do other modifications to either tests or code.
+This shows mutant detected the alive mutation. Which shows the conditional we deliberately added above is redundant.
+
+Feel free to also remove some tests. Or do other modifications to either test or code.

data/docs/mutant-rspec.md

@@ -1,29 +1,119 @@
 mutant-rspec
 ============
 
-The integration into rspec.
+Before starting with mutant its recommended to understand the
+[nomenclature](/docs/nomenclature.md).
 
-Install `mutant-rspec` and use the `--use rspec` switch in your mutant command line.
+## Setup
+
+To add mutant to your rspec code base you need to:
+
+1. Add `mutant-rspec` as development dependency to your `Gemfile` or `.gemspec`
+
+   This may look like:
+
+   ```ruby
+   # A gemfile
+   gem 'mutant-rspec'
+   ```
+
+2. Run mutant against the rspec integration
+
+   ```sh
+   bundle exec mutant --include lib --require 'your_library.rb' --use rspec -- 'YourLibrary*'
+   ```
+
+## Run through example
+
+This uses [mbj/auom](https://github.com/mbj/auom) a small library that
+has 100% mutation coverage. Its tests execute very fast and do not have any IO
+so its a good playground example to interact with.
+
+All the setup described above is already done.
 
 ```sh
-bundle exec mutant --include lib --require 'your_code' --use rspec -- 'YourCode*'
+git clone https://github.com/mbj/auom
+cd auom
+bundle install # gemfile references mutant-rspec already
+bundle exec mutant --include lib --require auom --use rspec -- 'AUOM*'
 ```
 
-Examples
---------
+This prints a report like:
 
+```sh
+Mutant configuration:
+Matcher:         #<Mutant::Matcher::Config match_expressions: [AUOM*]>
+Integration:     Mutant::Integration::Rspec
+Jobs:            8
+Includes:        ["lib"]
+Requires:        ["auom"]
+Subjects:        23
+Mutations:       1003
+Results:         1003
+Kills:           1003
+Alive:           0
+Runtime:         51.52s
+Killtime:        200.13s
+Overhead:        -74.26%
+Mutations/s:     19.47
+Coverage:        100.00%
 ```
-cd virtus
-# Run mutant on virtus namespace
-bundle exec mutant --include lib --require virtus --use rspec Virtus*
-# Run mutant on specific virtus class
-bundle exec mutant --include lib --require virtus --use rspec Virtus::Attribute
-# Run mutant on specific virtus class method
-bundle exec mutant --include lib --require virtus --use rspec Virtus::Attribute.build
-# Run mutant on specific virtus instance method
-bundle exec mutant --include lib --require virtus --use rspec Virtus::Attribute#type
+
+Now lets try adding some redundant (or unspecified) code:
+
+```sh
+patch -p1 <<'PATCH'
+--- a/lib/auom/unit.rb
++++ b/lib/auom/unit.rb
+@@ -170,7 +170,7 @@ module AUOM
+     # TODO: Move defaults coercions etc to .build method
+     #
+     def self.new(scalar, numerators = nil, denominators = nil)
+-      scalar = rational(scalar)
++      scalar = rational(scalar) if true
+
+       scalar, numerators   = resolve([*numerators], scalar, :*)
+       scalar, denominators = resolve([*denominators], scalar, :/)
+PATCH
 ```
 
+Running mutant again prints the following:
+
+```sh
+evil:AUOM::Unit.new:/home/mrh-dev/example/auom/lib/auom/unit.rb:172:45e17
+@@ -1,9 +1,7 @@
+ def self.new(scalar, numerators = nil, denominators = nil)
+-  if true
+-    scalar = rational(scalar)
+-  end
++  scalar = rational(scalar)
+   scalar, numerators = resolve([*numerators], scalar, :*)
+   scalar, denominators = resolve([*denominators], scalar, :/)
+   super(scalar, *[numerators, denominators].map(&:sort)).freeze
+ end
+-----------------------
+Mutant configuration:
+Matcher:         #<Mutant::Matcher::Config match_expressions: [AUOM*]>
+Integration:     Mutant::Integration::Rspec
+Jobs:            8
+Includes:        ["lib"]
+Requires:        ["auom"]
+Subjects:        23
+Mutations:       1009
+Results:         1009
+Kills:           1008
+Alive:           1
+Runtime:         50.93s
+Killtime:        190.09s
+Overhead:        -73.21%
+Mutations/s:     19.81
+Coverage:        99.90%
+```
+
+This shows mutant detected the alive mutation. Which shows the conditional we deliberately added above is redundant.
+
+Feel free to also remove some tests. Or do other modifications to either test or code.
+
 Test-Selection
 --------------
 

data/lib/mutant.rb

@@ -135,7 +135,6 @@ require 'mutant/mutator/node/send'
 require 'mutant/mutator/node/send/binary'
 require 'mutant/mutator/node/send/conditional'
 require 'mutant/mutator/node/send/attribute_assignment'
-require 'mutant/mutator/node/send/index'
 require 'mutant/mutator/node/when'
 require 'mutant/mutator/node/class'
 require 'mutant/mutator/node/define'
@@ -151,6 +150,8 @@ require 'mutant/mutator/node/regopt'
 require 'mutant/mutator/node/resbody'
 require 'mutant/mutator/node/rescue'
 require 'mutant/mutator/node/match_current_line'
+require 'mutant/mutator/node/index'
+require 'mutant/mutator/node/procarg_zero'
 require 'mutant/loader'
 require 'mutant/context'
 require 'mutant/scope'

data/lib/mutant/ast/meta/send.rb

@@ -30,14 +30,7 @@ module Mutant
           naked_proc? || proc_new?
         end
 
-        # Test if AST node is a valid assignment target
-        #
-        # @return [Boolean]
-        def assignment?
-          index_assignment? || attribute_assignment?
-        end
-
-        # Test if AST node is an attribute assignment?
+        # Test if AST node is a valid attribute assignment
         #
         # @return [Boolean]
         def attribute_assignment?
@@ -45,13 +38,6 @@ module Mutant
           selector.to_s.end_with?(ATTRIBUTE_ASSIGNMENT_SELECTOR_SUFFIX)
         end
 
-        # Test if AST node is an index assign
-        #
-        # @return [Boolean]
-        def index_assignment?
-          selector.equal?(INDEX_ASSIGNMENT_SELECTOR)
-        end
-
         # Test for binary operator implemented as method
         #
         # @return [Boolean]

data/lib/mutant/ast/types.rb

@@ -7,44 +7,67 @@ module Mutant
     # :reek:TooManyConstants
     # rubocop:disable Metrics/ModuleLength
     module Types
-      symbolset = ->(strings) { strings.map(&:to_sym).to_set.freeze }
-
-      ASSIGNABLE_VARIABLES = symbolset.(%w[ivasgn lvasgn cvasgn gvasgn])
+      ASSIGNABLE_VARIABLES = Set.new(%i[ivasgn lvasgn cvasgn gvasgn]).freeze
 
       INDEX_ASSIGN_OPERATOR = :[]=
 
       # Set of nodes that cannot be on the LHS of an assignment
-      NOT_ASSIGNABLE         = symbolset.(%w[int float str dstr class module self nil])
+      NOT_ASSIGNABLE         = Set.new(%i[int float str dstr class module self nil]).freeze
 
       # Set of op-assign types
-      OP_ASSIGN              = symbolset.(%w[or_asgn and_asgn op_asgn])
+      OP_ASSIGN              = Set.new(%i[or_asgn and_asgn op_asgn]).freeze
       # Set of node types that are not valid when emitted standalone
-      NOT_STANDALONE         = symbolset.(%w[splat restarg block_pass])
-      INDEX_OPERATORS        = symbolset.(%w[[] []=])
-      UNARY_METHOD_OPERATORS = symbolset.(%w[~@ +@ -@ !])
+      NOT_STANDALONE         = Set.new(%i[splat restarg block_pass]).freeze
+      INDEX_OPERATORS        = Set.new(%i[[] []=]).freeze
+      UNARY_METHOD_OPERATORS = Set.new(%i[~@ +@ -@ !]).freeze
 
       # Operators ruby implements as methods
-      METHOD_OPERATORS = symbolset.(%w[
-        <=> === []= [] <= >= == !~ != =~ <<
-        >> ** * % / | ^ & < > + - ~@ +@ -@ !
-      ])
+      METHOD_OPERATORS = Set.new(%i[
+        !
+        !=
+        !~
+        %
+        &
+        *
+        **
+        +
+        +@
+        -
+        -@
+        /
+        <
+        <<
+        <=
+        <=>
+        ==
+        ===
+        =~
+        >
+        >=
+        >>
+        []
+        []=
+        ^
+        |
+        ~@
+      ]).freeze
 
-      BINARY_METHOD_OPERATORS = symbolset.(
+      BINARY_METHOD_OPERATORS = Set.new(
         METHOD_OPERATORS - (INDEX_OPERATORS + UNARY_METHOD_OPERATORS)
       )
 
-      OPERATOR_METHODS = symbolset.(
+      OPERATOR_METHODS = Set.new(
         METHOD_OPERATORS + INDEX_OPERATORS + UNARY_METHOD_OPERATORS
-      )
+      ).freeze
 
       # Nodes that are NOT handled by mutant.
       #
       # not - 1.8 only, mutant does not support 1.8
       #
-      BLACKLIST = symbolset.(%w[not])
+      BLACKLIST = Set.new(%i[not]).freeze
 
       # Nodes generated by regular expression body parsing
-      REGEXP = symbolset.(%w[
+      REGEXP = Set.new(%i[
         regexp_alnum_posixclass
         regexp_alpha_posixclass
         regexp_alpha_property
@@ -154,15 +177,17 @@ module Mutant
         regexp_xgrapheme_type
         regexp_zero_or_more_escape
         regexp_zero_or_one_escape
-      ])
+      ]).freeze
 
       # Nodes that are NOT generated by parser but used by mutant / unparser.
-      GENERATED = symbolset.(%w[empty])
+      GENERATED = Set.new(%i[empty]).freeze
 
-      EXTRA = symbolset.(GENERATED + REGEXP)
+      # Nodes missing from parser metadata
+      MISSING = Set.new(%i[index indexasgn lambda procarg0]).freeze
 
-      # All node types mutant handles
-      ALL = symbolset.((Parser::Meta::NODE_TYPES + EXTRA) - BLACKLIST)
+      ALL = Set.new(
+        (Parser::Meta::NODE_TYPES + GENERATED + REGEXP + MISSING) - BLACKLIST
+      ).freeze
     end # Types
   end # AST
 end # Mutant