mutant 0.8.19 → 0.8.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbaeba3292082f39979c87a1918f1a75a681f4cca1299fee251373779c1f381b
-  data.tar.gz: b1e57ca598f25e27d1c74e2b17d2033edb1d3b602742eb0fa62a6a7ac1f1058a
+  metadata.gz: 71ac041e8b933f1efd758494731566ff133404300a860e41362211c607fe5f0f
+  data.tar.gz: d49c6b977cbe88912d3c93203473a3704c4287737fbe3fff14a46aaf951bc2a9
 SHA512:
-  metadata.gz: 53d8e07cbcfc3ce3c8f1848ae34438f5e31ee3cbb8af8784e02e1f5a4cccc61554ac9f404d07083c0ce1210b4329de873e0ecb3e274260798484a1cabc53f758
-  data.tar.gz: 5ca7d7e28311f4c359d07f823d069b1ace3ed8b408bcb5c9f912d6f106ff469be4d38a4e7ea37afd46083d30eab818039c72f306d323ee4a364e5a6fb3b0beb8
+  metadata.gz: 5f241945cdedc4d38fd3328b4321c0e685d87c3102d73c122baae658daf5b9b42423b9aa12070e23e42abae6f3232f5752d67cdc27c49c16d8fa150c259655be
+  data.tar.gz: 1400ba91b8275ee4c6a12af48ed05bd6bf1a0c290e16a227f87a81a251e536d269c71d9ca8d9d7fc4e4ba6b7dc02d3360061b2809fb21c58fcef9c7d708b89b6

data/.circleci/config.yml

@@ -1,17 +1,55 @@
 defaults: &defaults
   working_directory: ~/mutant
-  steps:
-    - checkout
-    - run: bundle install
-    - run: bundle exec rake ci
+  docker:
+    - image: circleci/ruby:2.5.3
 version: 2
 jobs:
-  ruby_2_5:
+  unit_specs:
     <<: *defaults
-    docker:
-      - image: circleci/ruby:2.5.3
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rspec spec/unit
+  integration_minitest:
+    <<: *defaults
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rspec spec/integration -e minitest
+  integration_rspec:
+    <<: *defaults
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rspec spec/integration -e rspec
+  integration_mutation_generation:
+    <<: *defaults
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rspec spec/integration -e generation
+  metrics:
+    <<: *defaults
+    steps:
+      - checkout
+      - 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:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rake metrics:mutant
 workflows:
   version: 2
   test:
     jobs:
-      - ruby_2_5
+      - unit_specs
+      - integration_rspec
+      - integration_minitest
+      - integration_mutation_generation
+      - metrics
+      - mutant

data/Changelog.md

@@ -1,3 +1,7 @@
+# v0.8.20 2018-11-27
+
+* Replace internal timers with monotonic ones.
+
 # v0.8.19 2018-11-06
 
 * Drop support for Ruby < 2.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mutant (0.8.18)
+    mutant (0.8.19)
       abstract_type (~> 0.0.7)
       adamantium (~> 0.2.0)
       anima (~> 0.3.0)
@@ -12,13 +12,12 @@ PATH
       ice_nine (~> 0.11.1)
       memoizable (~> 0.4.2)
       morpher (~> 0.2.6)
-      parallel (~> 1.3)
       parser (~> 2.5.1)
       procto (~> 0.0.2)
       regexp_parser (~> 1.2)
-      unparser (~> 0.2.5)
-    mutant-rspec (0.8.18)
-      mutant (~> 0.8.18)
+      unparser (~> 0.3.0)
+    mutant-rspec (0.8.19)
+      mutant (~> 0.8.19)
       rspec-core (>= 3.4.0, < 4.0.0)
 
 GEM
@@ -69,7 +68,6 @@ GEM
     docile (1.3.1)
     equalizer (0.0.11)
     erubis (2.7.0)
-    ffi (1.9.25)
     flay (2.10.0)
       erubis (~> 2.7.0)
       path_expander (~> 1.0)
@@ -95,7 +93,7 @@ GEM
       ice_nine (~> 0.11.0)
       procto (~> 0.0.2)
     parallel (1.12.1)
-    parser (2.5.1.2)
+    parser (2.5.3.0)
       ast (~> 2.4.0)
     path_expander (1.0.3)
     powerpack (0.1.2)
@@ -107,14 +105,14 @@ GEM
       kwalify (~> 0.7.0)
       parser (>= 2.5.0.0, < 2.6, != 2.5.1.1)
       rainbow (>= 2.0, < 4.0)
-    regexp_parser (1.2.0)
+    regexp_parser (1.3.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-its (1.2.0)
@@ -124,7 +122,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.59.0)
+    rubocop (0.59.2)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5, != 2.5.1.1)
@@ -143,7 +141,7 @@ GEM
     simplecov-html (0.10.2)
     thread_safe (0.3.6)
     unicode-display_width (1.4.0)
-    unparser (0.2.8)
+    unparser (0.3.0)
       abstract_type (~> 0.0.7)
       adamantium (~> 0.2.0)
       concord (~> 0.1.5)
@@ -166,8 +164,8 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.10)
   devtools (~> 0.1.21)
-  ffi (~> 1.9.6)
   mutant!
+  parallel (~> 1.3)
 
 BUNDLED WITH
    1.17.1

data/README.md

@@ -12,108 +12,37 @@ Mutant is a mutation testing tool for Ruby.
 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.
-It should also work under any Ruby engine that supports POSIX-fork(2) semantics.
+Mutant supports ruby >= 2.5, MRI only.
 
 Mutant uses a pure Ruby [parser](https://github.com/whitequark/parser) and an [unparser](https://github.com/mbj/unparser)
 to do its magic.
 
-Mutant does not have really good "getting started" documentation currently so please refer to presentations and blog posts below.
+Topics
+------
 
-Installation
-------------
+* [Nomenclature](/docs/nomenclature.md)
+* [Reading Reports](/docs/reading-reports.md)
+* [Known Problems](/docs/known-problems.md)
+* [Limitations](/docs/limitations.md)
+* [Concurrency](/docs/concurrency.md)
+* [Rspec Integration](/docs/mutant-rspec.md)
+* [Minitest Integration](/docs/mutant-minitest.md)
 
-As mutant right now only supports rspec, install the gem `mutant-rspec` via your preferred method.
-It'll pull the `mutant` gem (in the correct version), that contains the main engine.
-
-```ruby
-gem install mutant-rspec
-```
-
-The minitest integration is still in the [works](https://github.com/mbj/mutant/pull/445).
-
-Examples
---------
-
-```
-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
-```
-
-Rails
--------
-
-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:
-
-```sh
-RAILS_ENV=test bundle exec mutant -r ./config/environment --use rspec User
-```
-
-Passing in RSpec Options
-------------------------
-
-**NOTE: Experimental**
-
-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
-SPEC_OPTS="--pattern spec/subdir_only/**/*_spec.rb" bundle exec mutant --use rspec SomeClass
-```
-
-Limitations
------------
-
-Mutant cannot emit mutations for...
-
-* methods defined within a closure.  For example, methods defined using `module_eval`, `class_eval`,
-  `define_method`, or `define_singleton_method`:
-
-    ```ruby
-    class Example
-      class_eval do
-        def example1
-        end
-      end
-
-      module_eval do
-        def example2
-        end
-      end
-
-      define_method(:example3) do
-      end
-
-      define_singleton_method(:example4) do
-      end
-    end
-    ```
-
-* singleton methods not defined on a constant or `self`
+Sponsoring
+----------
 
-    ```ruby
-    class Foo
-      def self.bar; end   # ok
-      def Foo.baz; end    # ok
+Mutant, as published in the opensource version, would not exist without the help
+of [contributors](https://github.com/mbj/mutant/graphs/contributors) spending lots
+of their private time.
 
-      myself = self
-      def myself.qux; end # cannot mutate
-    end
-    ```
+Additionally, the following features where sponsored by organizations:
 
-* methods defined with eval:
+* The `mutant-minitest` integration was sponsored by [Arkency](https://arkency.com/)
+* Mutant's initial concurrency support was sponsored by an undisclosed company that does
+  currently not wish to be listed here.
 
-    ```ruby
-    class Foo
-      class_eval('def bar; end') # cannot mutate
-    end
-    ```
+If your organization is interested in sponsoring a feature, general maintainership or bugfixes, contact
+[Markus Schirp](mailto:mbj@schirp-dso.com).
 
 Mutation-Operators
 ------------------
@@ -123,118 +52,6 @@ The `mutant-meta` is arranged to the AST-Node-Types of parser. Refer to parsers
 
 There is no easy and universal way to count the number of mutation operators a tool supports.
 
-Subjects
---------
-
-Mutant currently mutates code in instance and singleton methods. It is planned to support mutation
-of constant definitions and domain specific languages, DSL probably as plugins.
-
-Test-Selection
---------------
-
-Mutation testing is slow. The key to making it fast is selecting the correct set of tests to run.
-Mutant currently supports the following built-in strategy for selecting tests/specs:
-
-Mutant uses the "longest rspec example group descriptions prefix match" to select the tests to run.
-
-Example for a subject like `Foo::Bar#baz` it will run all example groups with description prefixes in
-`Foo::Bar#baz`, `Foo::Bar` and `Foo`. The order is important, so if mutant finds example groups in the
-current prefix level, these example groups *must* kill the mutation.
-
-Reading Reports
----------------
-
-Mutation output is grouped by selection groups. Each group contains three sections:
-
-1. An identifier for the current group.
-
-   **Format**:
-
-   ```text
-   [SUBJECT EXPRESSION]:[SOURCE LOCATION]:[LINENO]
-   ```
-
-   **Example**:
-
-   ```text
-   Book#add_page:Book#add_page:/home/dev/mutant-examples/lib/book.rb:18
-   ```
-
-2. A list of specs that mutant ran to try to kill mutations for the current group.
-
-   **Format**:
-
-   ```text
-   - [INTEGRATION]:0:[SPEC LOCATION]:[SPEC DESCRIPTION]
-   - [INTEGRATION]:1:[SPEC LOCATION]:[SPEC DESCRIPTION]
-   ```
-
-   **Example**:
-
-   ```text
-   - rspec:0:./spec/unit/book_spec.rb:9/Book#add_page should return self
-   - rspec:1:./spec/unit/book_spec.rb:13/Book#add_page should add page to book
-   ```
-
-3. A list of unkilled mutations diffed against the original unparsed source
-
-   **Format**:
-
-   ```text
-   [MUTATION TYPE]:[SUBJECT EXPRESSION]:[SOURCE LOCATION]:[SOURCE LINENO]:[IDENTIFIER]
-   [DIFF]
-   -----------------------
-   ```
-
-   - `[MUTATION TYPE]` will be one of the following:
-      - `evil` - a mutation of your source was not killed by your tests
-      - `neutral` your original source was injected and one or more tests failed
-   - `[IDENTIFIER]` - Unique identifier for this mutation
-
-   **Example**:
-
-   ```diff
-   evil:Book#add_page:Book#add_page:/home/dev/mutant-examples/lib/book.rb:18:01f69
-   @@ -1,6 +1,6 @@
-    def add_page(page)
-   -  @pages << page
-   +  @pages
-      @index[page.number] = page
-      self
-    end
-   -----------------------
-   evil:Book#add_page:Book#add_page:/home/dev/mutant-examples/lib/book.rb:18:b1ff2
-   @@ -1,6 +1,6 @@
-    def add_page(page)
-   -  @pages << page
-   +  self
-      @index[page.number] = page
-      self
-    end
-   -----------------------
-   ```
-
-Concurrency
------------
-
-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.
-
-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.
-
-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.
-
-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.
-
 Neutral (noop) Tests
 --------------------
 
@@ -254,55 +71,11 @@ 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:
+
 ```
 bundle exec 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)
--------------------------------
-
-Mutations generated by mutant can cause MRI to enter VM states its not prepared for.
-All MRI versions > 1.9 and < 2.2.1 are affected by this depending on your compiler flags,
-compiler version, and OS scheduling behavior.
-
-This can have the following unintended effects:
-
-* MRI crashes with a segfault. Mutant kills each mutation in a dedicated fork to isolate
-  the mutations side effects when this fork terminates abnormally (segfault) mutant
-  counts the mutation as killed.
-
-* MRI crashes with a segfault and gets stuck when handling the segfault.
-  Depending on the number of active kill jobs mutant might appear to continue normally until
-  all workers are stuck into this state when it begins to hang.
-  Currently mutant must assume that your test suite simply not terminated yet as from the outside
-  (parent process) the difference between a long running test and a stuck MRI is not observable.
-  Its planned to implement a timeout enforced from the parent process, but ideally MRI simply gets fixed.
-
-References:
-
-* [MRI fix](https://github.com/ruby/ruby/commit/8fe95fea9d238a6deb70c8953ceb3a28a67f4636)
-* [MRI backport to 2.2.1](https://github.com/ruby/ruby/commit/8fe95fea9d238a6deb70c8953ceb3a28a67f4636)
-* [Mutant issue](https://github.com/mbj/mutant/issues/265)
-* [Upstream bug redmine](https://bugs.ruby-lang.org/issues/10460)
-* [Upstream bug github](https://github.com/ruby/ruby/pull/822)
-
 Presentations
 -------------
 
@@ -313,7 +86,6 @@ There are some presentations about mutant in the wild:
 * [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?
 ------------------------