mutant 0.8.10 → 0.8.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37c56c026986c92dd3afb4306adaea0d80b130f2
-  data.tar.gz: 0513911185fbe4a6967146e75ebec39e77537875
+  metadata.gz: 2b6726d9cc7696a22bc3de412e2aec93c6098212
+  data.tar.gz: 1c68cebbe3bd9faf603b604621a5af7cfb6402d1
 SHA512:
-  metadata.gz: 838d0e823d5666c5b615aa4c3f94af69c90034873cf07bc113524dfad2b265cdda16b350d189e410ff0229657fc425ddb0d34d442f19091a11151f2757f10b06
-  data.tar.gz: 60493346edfd51f98857e94c286de02c6293933ad379331f4513f18ec82b35f5c93ae5b6f14f8a196ac69d071004ba8529bd0ef902acf8ea8a32eb471b41f4b3
+  metadata.gz: c9a1dd4866a3264565adccb269d212b0609bdd806fc94e9f42b3366deb951967c48d0595f6044158a1719155557af450fb949821eadb7699432aa73262e7e1cf
+  data.tar.gz: 2cb50707ab5a178bb9eb8d1288251e978db32fbd92efddc1a4417e772df2ec4f2cefa86fceaeeb2dc5a7b7a654afe9c9182d548183a733497d17fdc9459515ea

data/.rubocop.yml

@@ -1,10 +1,7 @@
 AllCops:
-  Include:
-    - 'Gemfile'
   Exclude:
-    - 'Gemfile.devtools'
     - 'vendor/**/*'
     - 'tmp/**/*'
     - 'test_app/**/*'
-    - 'benchmarks/**/*'
     - 'bin/mutant'
+  TargetRubyVersion: 2.2

data/Changelog.md

@@ -1,3 +1,11 @@
+# v0.8.11 2016-01-xx
+
+* Add support for rspec-3.5
+* Remove misleading --debug option
+* Remove misleading --expect-coverage option
+* Add basic support for regexp mutations (machinery and simple anchor mutations)
+* Add support for mutating csend (duck tape operator) into regular sends
+
 # v0.8.10 2016-01-24
 
 * Add support for parser 2.3 (via unparser 0.2.5)

data/README.md

@@ -7,10 +7,11 @@ mutant
 [![Inline docs](http://inch-ci.org/github/mbj/mutant.png)](http://inch-ci.org/github/mbj/mutant)
 [![Gem Version](https://img.shields.io/gem/v/mutant.svg)](https://rubygems.org/gems/mutant)
 [![Flattr](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/thing/1823010/mbjmutant-on-GitHub)
+[![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.
 
-The idea is that if code can be changed and your tests do not notice, either that code isn't being covered
+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 supports ruby >= 2.1, while support for JRuby is planned.
@@ -25,7 +26,7 @@ Installation
 ------------
 
 As mutant right now only supports rspec, install the gem `mutant-rspec` via your preferred method.
-It'll pull the `mutant` gem (in correct version), that contains the main engine.
+It'll pull the `mutant` gem (in the correct version), that contains the main engine.
 
 ```ruby
 gem install mutant-rspec
@@ -48,29 +49,24 @@ mutant --include lib --require virtus --use rspec Virtus::Attribute.build
 mutant --include lib --require virtus --use rspec Virtus::Attribute#type
 ```
 
-Configuration
--------------
+Rails
+-------
 
-Occasionally mutant will produce a mutation with an infinite runtime. When this happens
-mutant will look like it is running indefinitely without killing a remaining mutation. To
-avoid mutations like this, consider adding a timeout around your tests. For example, in
-RSpec you can add the following to your `spec_helper`:
+To mutation test Rails models with rspec, comment out ```require 'rspec/autorun'``` from your spec_helper.rb file.  Having done so you should be able to use commands like the following:
 
-```ruby
-config.around(:each) do |example|
-  Timeout.timeout(5_000, &example)
-end
+```sh
+RAILS_ENV=test bundle exec mutant -r ./config/environment --use rspec User
 ```
 
-which will fail specs which run for longer than 5 seconds.
+Passing in RSpec Options
+------------------------
 
-Rails
--------
+**NOTE: Experimental**
 
-To mutation test Rails models with rspec comment out ```require 'rspec/autorun'``` from your spec_helper.rb file.  Having done so you should be able to use commands like the following:
+You can control some aspects of RSpec using the `SPEC_OPTS` environment variable as usual. If you want mutant to only pay attention to specs in a certain directory, you can run
 
 ```sh
-RAILS_ENV=test bundle exec mutant -r ./config/environment --use rspec User
+SPEC_OPTS="--pattern spec/subdir_only/**/*_spec.rb" mutant --use rspec SomeClass
 ```
 
 Limitations
@@ -121,8 +117,8 @@ Mutant cannot emit mutations for...
     end
     ```
 
-Mutation-Operators:
--------------------
+Mutation-Operators
+------------------
 
 Mutant supports a wide range of mutation operators. An exhaustive list can be found in the [mutant-meta](https://github.com/mbj/mutant/tree/master/meta).
 The `mutant-meta` is arranged to the AST-Node-Types of parser. Refer to parsers [AST documentation](https://github.com/whitequark/parser/blob/master/doc/AST_FORMAT.md) in doubt.
@@ -220,34 +216,66 @@ Mutation output is grouped by selection groups. Each group contains three sectio
    -----------------------
    ```
 
-Presentations
--------------
+Concurrency
+-----------
 
-There are some presentations about mutant in the wild:
+By default, mutant will test mutations in parallel by running up to one process for each core on your system. You can control the number of processes created using the `--jobs` argument.
 
-* [RailsConf 2014](http://railsconf.com/) / http://confreaks.com/videos/3333-railsconf-mutation-testing-with-mutant
-* [Wrocloverb 2014](http://wrocloverb.com/) / https://www.youtube.com/watch?v=rz-lFKEioLk
-* [eurucamp 2013](http://2013.eurucamp.org/) / FrOSCon-2013 http://slid.es/markusschirp/mutation-testing
-* [Cologne.rb](http://www.colognerb.de/topics/mutation-testing-mit-mutant) / https://github.com/DonSchado/colognerb-on-mutant/blob/master/mutation_testing_slides.pdf
+Mutant forks a new process for each mutation to be tested to prevent side affects in your specs and the lack of thread safety in rspec from impacting the results.
 
-Blog posts
-----------
+If the code under test relies on a database, you may experience problems when running mutant because of conflicting data in the database. For example, if you have a test like this:
+```
+m = MyModel.create!(...)
+expect(MyModel.first.name).to eql(m.name)
+```
+It might fail if some other test wrote a record to the MyModel table at the same time as this test was executed. (It would find the MyModel record created by the other test.) Most of these issues can be fixed by writing more specific tests. Here is a concurrent safe version of the same test:
+```
+m = MyModel.create!(...)
+expect(MyModel.find_by_id(m.id).name).to eql(m.name)
+```
+You may also try wrapping your test runs in transactions.
 
-Sorted by recency:
+Note that some databases, SQLite in particular, are not designed for concurrent access and will fail if used in this manner. If you are using SQLite, you should set the `--jobs` to 1.
 
-* [How to write better code using mutation testing (November 2015)][blockscore]
-* [How good are your Ruby tests? Testing your tests with mutant (June 2015)][arkency1]
-* [Mutation testing and continuous integration (May 2015)][arkency2]
-* [Why I want to introduce mutation testing to the `rails_event_store` gem (April 2015)][arkency3]
-* [Mutation testing with mutant (April 2014)][sitepoint]
-* [Mutation testing with mutant (January 2013)][solnic]
+Neutral (noop) Tests
+--------------------
 
-[blockscore]: https://blog.blockscore.com/how-to-write-better-code-using-mutation-testing/
-[sitepoint]: http://www.sitepoint.com/mutation-testing-mutant/
-[arkency1]: http://blog.arkency.com/2015/06/how-good-are-your-ruby-tests-testing-your-tests-with-mutant/
-[arkency2]: http://blog.arkency.com/2015/05/mutation-testing-and-continuous-integration/
-[arkency3]: http://blog.arkency.com/2015/04/why-i-want-to-introduce-mutation-testing-to-the-rails-event-store-gem/  
-[solnic]: http://solnic.eu/2013/01/23/mutation-testing-with-mutant.html
+Mutant will also test the original, unmutated, version your code. This ensures that mutant is able to properly setup and run your tests.
+If an error occurs while mutant/rspec is running testing the original code, you will receive an error like the following:
+```
+--- Neutral failure ---
+Original code was inserted unmutated. And the test did NOT PASS.
+Your tests do not pass initially or you found a bug in mutant / unparser.
+...
+Test Output:
+marshal data too short
+```
+Currently, troubleshooting these errors requires using a debugger and/or modyifying mutant to print out the error. You will want to rescue and inspect exceptions raised in this method: lib/mutant/integration/rspec.rb:call
+
+Only Mutating Changed Code
+--------------------------
+
+Running mutant for the first time on an existing codebase can be a rather disheartening experience due to the large number of alive mutations found! Mutant has a setting that can help. Using the `--since` argument, mutant will only mutate code that has been modified. This allows you to introduce mutant into an existing code base without drowning in errors. Example usage that will mutate all code changed between master and the current branch:
+```
+mutant --include lib --require virtus --since master --use rspec Virtus::Attribute#type
+```
+
+Known Problems
+==============
+
+Mutations with Infinite Runtimes
+---------------------------------
+
+Occasionally mutant will produce a mutation with an infinite runtime. When this happens
+mutant will look like it is running indefinitely without killing a remaining mutation. To
+avoid mutations like this, consider adding a timeout around your tests. For example, in
+RSpec you can add the following to your `spec_helper`:
+```ruby
+config.around(:each) do |example|
+  Timeout.timeout(5, &example)
+end
+```
+which will fail specs which run for longer than 5 seconds.
 
 The Crash / Stuck Problem (MRI)
 -------------------------------
@@ -277,6 +305,17 @@ References:
 * [Upstream bug redmine](https://bugs.ruby-lang.org/issues/10460)
 * [Upstream bug github](https://github.com/ruby/ruby/pull/822)
 
+Presentations
+-------------
+
+There are some presentations about mutant in the wild:
+
+* [RailsConf 2014](http://railsconf.com/) / http://confreaks.com/videos/3333-railsconf-mutation-testing-with-mutant
+* [Wrocloverb 2014](http://wrocloverb.com/) / https://www.youtube.com/watch?v=rz-lFKEioLk
+* [eurucamp 2013](http://2013.eurucamp.org/) / FrOSCon-2013 http://slid.es/markusschirp/mutation-testing
+* [Cologne.rb](http://www.colognerb.de/topics/mutation-testing-mit-mutant) / https://github.com/DonSchado/colognerb-on-mutant/blob/master/mutation_testing_slides.pdf
+
+
 Planning a presentation?
 ------------------------
 
@@ -296,6 +335,25 @@ assumptions based on the absence of docs, use the tool authors brain to fill the
 
 Hint, same applies to papers.
 
+Blog posts
+----------
+
+Sorted by recency:
+
+* [How to write better code using mutation testing (November 2015)][blockscore]
+* [How good are your Ruby tests? Testing your tests with mutant (June 2015)][arkency1]
+* [Mutation testing and continuous integration (May 2015)][arkency2]
+* [Why I want to introduce mutation testing to the `rails_event_store` gem (April 2015)][arkency3]
+* [Mutation testing with mutant (April 2014)][sitepoint]
+* [Mutation testing with mutant (January 2013)][solnic]
+
+[blockscore]: https://blog.blockscore.com/how-to-write-better-code-using-mutation-testing/
+[sitepoint]: http://www.sitepoint.com/mutation-testing-mutant/
+[arkency1]: http://blog.arkency.com/2015/06/how-good-are-your-ruby-tests-testing-your-tests-with-mutant/
+[arkency2]: http://blog.arkency.com/2015/05/mutation-testing-and-continuous-integration/
+[arkency3]: http://blog.arkency.com/2015/04/why-i-want-to-introduce-mutation-testing-to-the-rails-event-store-gem/  
+[solnic]: http://solnic.eu/2013/01/23/mutation-testing-with-mutant.html
+
 Support
 -------
 
@@ -306,8 +364,19 @@ Your options:
 * [GitHub Issues](https://github.com/mbj/mutant/issues)
 * Ping me on [twitter](https://twitter.com/_m_b_j_)
 
-There is also a mutant [slack chat](https://mutation-testing.slack.com/).
-@mention [@\_m\_b\_j\_](https://twitter.com/_m_b_j_) on twitter for an invite.
+There is also a mutation testing slack chat. Get an invite [here](https://mutation-testing-slack.herokuapp.com).
+For discussing this project, join [#mutant](https://mutation-testing.slack.com/messages/#mutant).
+
+Other Channels:
+
+- [#cosmic-ray](https://mutation-testing.slack.com/messages/cosmic-ray): for discussing `cosmic-ray`, the python mutation testing tool.
+- [#devtools](https://mutation-testing.slack.com/messages/devtools): for discussing the `devtools` metagem.
+- [#general](https://mutation-testing.slack.com/messages/general): for general discussions about mutation testing.
+- [#mutagen](https://mutation-testing.slack.com/messages/mutagen): for discussing `mutagen`, the javascript mutation testing tool.
+- [#random](https://mutation-testing.slack.com/messages/random): for misc. off topic discussion.
+- [#stryker](https://mutation-testing.slack.com/messages/stryker): for discussing `stryker`, the javascript mutation testing tool.
+- [#wtf-dev](https://mutation-testing.slack.com/messages/wtf-dev): for sharing software development wtfs.
+
 
 Credits
 -------

data/Rakefile

@@ -9,30 +9,16 @@ namespace :metrics do
   task mutant: :coverage do
     arguments = %w[
       bundle exec mutant
-      --ignore-subject Mutant::Meta*
       --include lib
       --since HEAD~1
       --require mutant
       --use rspec
       --zombie
     ]
-    arguments.concat(%W[--jobs 4]) if ENV.key?('CIRCLE_CI')
+    arguments.concat(%w[--jobs 4]) if ENV.key?('CIRCLECI')
 
     arguments.concat(%w[-- Mutant*])
 
-    success = Kernel.system(*arguments) or fail 'Mutant task is not successful'
-  end
-end
-
-desc 'Generate mutation operator listing'
-task :list do
-  require 'mutant'
-  # TODO: Add a nice public interface
-  registry = Mutant::Mutator::Registry.send(:registry)
-  registry.keys.select do |key|
-    key.is_a?(Symbol)
-  end.sort.each do |type|
-    mutator = registry.fetch(type)
-    puts '%-18s: %s' % [type, mutator.name.sub(/\AMutant::Mutator::Node::/, '')]
+    Kernel.system(*arguments) or fail 'Mutant task is not successful'
   end
 end

data/circle.yml

@@ -1,7 +1,7 @@
 ---
 machine:
   ruby:
-    version: '2.2'
+    version: '2.3.0'
 dependencies:
   pre:
     - bundle -v | grep -Fx "Bundler version 1.10.6" || gem install bundler --version 1.10.6

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
-threshold: 18
-total_score: 1171
+threshold: 16
+total_score: 1284

data/config/flog.yml

@@ -1,2 +1,2 @@
 ---
-threshold: 29.3
+threshold: 27.7

data/config/reek.yml

@@ -32,6 +32,7 @@ LongParameterList:
   enabled: true
   exclude:
   - Mutant::Matcher::Method::Instance#self.build
+  - Mutant::Meta::Example::DSL # 3 vars
   max_params: 2
 LongYieldList:
   enabled: true
@@ -42,7 +43,6 @@ NestedIterators:
   exclude:
   - Mutant#self.singleton_subclass_instance
   - Mutant::CLI#parse
-  - Mutant::Isolation::Fork#self.call
   - Mutant::Mutator::Node::Arguments#emit_argument_mutations
   - Mutant::Mutator::Node::Resbody#mutate_captures
   - Mutant::Mutator::Util::Array::Element#dispatch
@@ -65,12 +65,12 @@ TooManyInstanceVariables:
   exclude:
   - Mutant::Mutator # 4 vars
   - Mutant::Parallel::Master # 4 vars
+  - Mutant::Meta::Example::DSL # 4 vars
   max_instance_variables: 3
 TooManyMethods:
   enabled: true
   exclude:
   - Mutant::CLI
-  - Mutant::Meta::Example::Verification
   - Mutant::Mutator::Node
   - Mutant::Parallel::Master
   max_methods: 10
@@ -79,7 +79,6 @@ TooManyStatements:
   exclude:
   - Mutant::CLI#add_debug_options
   - Mutant::CLI#add_environment_options
-  - Mutant::Isolation::Fork#self.call
   - Mutant::Reporter::CLI::Printer::Config#run
   - Mutant::Reporter::CLI::Printer::EnvProgress#run
   - Mutant::Runner#run_driver
@@ -130,7 +129,7 @@ UtilityFunction:
   - Mutant::Integration::Null#call
   - Mutant::Integration::Rspec#parse_example
   - Mutant::Integration::Rspec#parse_expression # intentional, private
-  - Mutant::Meta::Example::Verification#format_mutation
+  - Mutant::Meta::Example::Verification#format_mutations # intentional, private
   - Mutant::Reporter::CLI::Format::Progressive#new_buffer
   - Mutant::Reporter::CLI::Printer::StatusProgressive#object # False positive calls super
   - Mutant::Repository::Diff#tracks? # intentional, private

data/config/rubocop.yml

@@ -11,20 +11,15 @@ BlockNesting:
 
 # Align with the style guide.
 CollectionMethods:
+  Enabled: true
   PreferredMethods:
     collect:  'map'
     inject:   'reduce'
     find:     'detect'
     find_all: 'select'
 
-# Do not force public/protected/private keyword to be indented at the same
-# level as the def keyword. My personal preference is to outdent these keywords
-# because I think when scanning code it makes it easier to identify the
-# sections of code and visually separate them. When the keyword is at the same
-# level I think it sort of blends in with the def keywords and makes it harder
-# to scan the code and see where the sections are.
 AccessModifierIndentation:
-  Enabled: false
+  EnforcedStyle: outdent
 
 # Limit line length
 LineLength:
@@ -34,9 +29,17 @@ LineLength:
 Documentation:
   Enabled: false
 
-# Do not always use &&/|| instead of and/or.
+# Permit
+#
+#     boolean_check? or fail
+#
+# Reject
+#
+#     if foo or bar
+#       ...
+#     end
 AndOr:
-  Enabled: false
+  EnforcedStyle: conditionals
 
 # Do not favor modifier if/unless usage when you have a single-line body
 IfUnlessModifier:
@@ -72,7 +75,7 @@ MultilineOperationIndentation:
 
 # Prefer String#% over Kernel#sprintf
 FormatString:
-  Enabled: false
+  EnforcedStyle: percent
 
 # Use square brackets for literal Array objects
 PercentLiteralDelimiters:
@@ -95,11 +98,6 @@ SymbolArray:
 EndAlignment:
   AlignWith: variable
 
-# Do not always align parameters when it is easier to read
-AlignParameters:
-  Exclude:
-    - spec/**/*_spec.rb
-
 # Prefer #kind_of? over #is_a?
 ClassCheck:
   EnforcedStyle: kind_of?
@@ -135,8 +133,47 @@ ParallelAssignment:
 
 # Allow additional specs
 ExtraSpacing:
-  Enabled: false
+  AllowForAlignment: true
 
 # Buggy
 FormatParameterMismatch:
   Enabled: false
+
+# Different preference
+SignalException:
+  EnforcedStyle: semantic
+
+# Do not use `alias`
+Alias:
+  EnforcedStyle: prefer_alias_method
+
+# Teaching people to ignore singleton class is pointless
+RedundantFreeze:
+  Enabled: false
+
+# Do not waste my horizontal or vertical space
+IndentArray:
+  Enabled: false
+
+# Prefer
+#
+#     some_receiver
+#       .foo
+#       .bar
+#       .baz
+#
+# Over
+#
+#     some_receiver.foo
+#                  .bar
+#                  .baz
+MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# Align keys and values in a multiline hash
+AlignHash:
+  EnforcedColonStyle: table
+
+# Prefer `public_send` and `__send__` over `send`
+Send:
+  Enabled: true