mutest 0.0.9 → 0.0.10

data/README.md

@@ -4,6 +4,22 @@ mutest
 
 `mutest` is a mutation testing tool for ruby designed to help audit the thoroughness of your test suite and encourage you to write more robust code.
 
+## Relationship to `mutant`
+
+`mutest` is a fork of the [mutant](https://github.com/mbj/mutant) project with a few minor additions. There are a handful of mutations which have been added, removed, or altered (see the [CHANGELOG](CHANGELOG.md) for details) as well as an inline disable comment system. This means that `mutest` allows you to do something like this:
+
+```ruby
+# mutest:disable
+dont_mutate(me: true) # This line is not mutated because of the significant comment above.
+mutate(me: true) # This line would continue to be mutated.
+```
+
+The `mutant` project, however, only allows disabling mutations on the method selector level and these subjects must be passed as a command line argument to the `mutant` executable.
+
+Otherwise, `mutest` project is effectively identical to `mutant`, which is the brainchild and excellent work of [Markus Schirp](https://github.com/mbj).
+
+###### Note: Referring to the mutant documentation may be helpful for using `mutest`, as it is generally applicable.
+
 ## How it works
 
 `mutest` parses your ruby code, inserts modifications, and then runs your test suite. If your test suite still _passes_ after `mutest` has mutated your code, you have an _alive_ mutation--meaning your tests do not thoroughly cover the modified part of your code. If your tests _fail_ after the code has been modified, the mutation is _killed_. This means that your test suite was able to detect the semantic change and provide adequate coverage of that condition.

data/Rakefile

@@ -13,6 +13,6 @@ namespace :metrics do
 
     arguments.concat(%w[-- Mutest*])
 
-    Kernel.system(*arguments) or fail 'Mutant task is not successful'
+    Kernel.system(*arguments) or raise 'Mutest task is not successful'
   end
 end

data/lib/mutest.rb

@@ -38,7 +38,7 @@ module Mutest
   def self.ci?
     ENV.key?('CI')
   end
-end # Mutest
+end
 
 require 'mutest/version'
 require 'mutest/env'
@@ -136,7 +136,6 @@ require 'mutest/mutator/node/send'
 require 'mutest/mutator/node/send/binary'
 require 'mutest/mutator/node/send/conditional'
 require 'mutest/mutator/node/send/attribute_assignment'
-require 'mutest/mutator/node/send/index'
 require 'mutest/mutator/node/when'
 require 'mutest/mutator/node/class'
 require 'mutest/mutator/node/define'
@@ -152,6 +151,8 @@ require 'mutest/mutator/node/regopt'
 require 'mutest/mutator/node/resbody'
 require 'mutest/mutator/node/rescue'
 require 'mutest/mutator/node/match_current_line'
+require 'mutest/mutator/node/index'
+require 'mutest/mutator/node/procarg_zero'
 require 'mutest/loader'
 require 'mutest/context'
 require 'mutest/scope'
@@ -242,5 +243,5 @@ module Mutest
       reporter:          Reporter::CLI.build($stdout),
       zombie:            false
     )
-  end # Config
-end # Mutest
+  end
+end

data/lib/mutest/actor.rb

@@ -3,7 +3,7 @@ module Mutest
   module Actor
     # Error raised when actor signalling protocol is violated
     class ProtocolError < RuntimeError
-    end # ProtocolError
+    end
 
     # Undefined message payload
     Undefined = Class.new do
@@ -30,7 +30,7 @@ module Mutest
       def self.new(_type, _payload = Undefined)
         super
       end
-    end # Message
+    end
 
     # Binding to other actors sender for simple RPC
     class Binding
@@ -44,9 +44,10 @@ module Mutest
       def call(type)
         other.call(Message.new(type, mailbox.sender))
         message = mailbox.receiver.call
-        fail ProtocolError, "Expected #{type} but got #{message.type}" unless type.equal?(message.type)
+        raise ProtocolError, "Expected #{type} but got #{message.type}" unless type.equal?(message.type)
+
         message.payload
       end
-    end # Binding
-  end # Actor
-end # Mutest
+    end
+  end
+end

data/lib/mutest/actor/env.rb

@@ -23,6 +23,6 @@ module Mutest
       def new_mailbox
         Mailbox.new
       end
-    end # Env
-  end # Actor
-end # Mutest
+    end
+  end
+end

data/lib/mutest/actor/mailbox.rb

@@ -2,7 +2,8 @@ module Mutest
   module Actor
     # Unbound mailbox
     class Mailbox
-      include Adamantium::Flat, Concord::Public.new(:receiver, :sender)
+      include Concord::Public.new(:receiver, :sender)
+      include Adamantium::Flat
 
       # New mailbox
       #
@@ -26,6 +27,6 @@ module Mutest
       def bind(other)
         Binding.new(self, other)
       end
-    end # Mailbox
-  end # Actor
-end # Mutest
+    end
+  end
+end

data/lib/mutest/actor/receiver.rb

@@ -2,7 +2,8 @@ module Mutest
   module Actor
     # Receiver side of an actor
     class Receiver
-      include Adamantium::Flat, Concord.new(:condition_variable, :mutex, :messages)
+      include Concord.new(:condition_variable, :mutex, :messages)
+      include Adamantium::Flat
 
       # Receives a message, blocking
       #
@@ -12,7 +13,7 @@ module Mutest
           message = try_blocking_receive
           return message unless message.equal?(Undefined)
         end
-        fail ProtocolError
+        raise ProtocolError
       end
 
       private
@@ -34,6 +35,6 @@ module Mutest
           end
         end
       end
-    end # Receiver
-  end # Actor
-end # Mutest
+    end
+  end
+end

data/lib/mutest/actor/sender.rb

@@ -2,7 +2,8 @@ module Mutest
   module Actor
     # Sender for messages to acting thread
     class Sender
-      include Adamantium::Flat, Concord.new(:condition_variable, :mutex, :messages)
+      include Concord.new(:condition_variable, :mutex, :messages)
+      include Adamantium::Flat
 
       # Send a message to actor
       #
@@ -17,6 +18,6 @@ module Mutest
 
         self
       end
-    end # Sender
-  end # Actor
-end # Mutest
+    end
+  end
+end

data/lib/mutest/ast.rb

@@ -14,7 +14,8 @@ module Mutest
     # @return [nil]
     #   otherwise
     def self.find_last_path(node, &predicate)
-      fail ArgumentError, 'block expected' unless block_given?
+      raise ArgumentError, 'block expected' unless block_given?
+
       path = []
       walk(node, [node]) do |candidate, stack|
         path = stack.dup if predicate.call(candidate)
@@ -40,5 +41,5 @@ module Mutest
       end
     end
     private_class_method :walk
-  end # AST
-end # Mutest
+  end
+end

data/lib/mutest/ast/meta.rb

@@ -2,6 +2,6 @@ module Mutest
   module AST
     # Node meta information mixin
     module Meta
-    end # Meta
-  end # AST
-end # Mutest
+    end
+  end
+end

data/lib/mutest/ast/meta/const.rb

@@ -4,7 +4,9 @@ module Mutest
     module Meta
       # Metadata for const nodes
       class Const
-        include NamedChildren, Concord.new(:node), NodePredicates
+        include NodePredicates
+        include Concord.new(:node)
+        include NamedChildren
 
         children :base, :name
 
@@ -16,7 +18,7 @@ module Mutest
         def possible_top_level?
           base.nil? || n_cbase?(base)
         end
-      end # Const
-    end # Meta
-  end # AST
-end # Mutest
+      end
+    end
+  end
+end

data/lib/mutest/ast/meta/optarg.rb

@@ -4,7 +4,8 @@ module Mutest
     module Meta
       # Metadata for optional argument nodes
       class Optarg
-        include NamedChildren, Concord.new(:node)
+        include Concord.new(:node)
+        include NamedChildren
 
         UNDERSCORE = '_'.freeze
 
@@ -18,7 +19,7 @@ module Mutest
         def used?
           !name.to_s.start_with?(UNDERSCORE)
         end
-      end # Optarg
-    end # Meta
-  end # AST
-end # Mutest
+      end
+    end
+  end
+end

data/lib/mutest/ast/meta/resbody.rb

@@ -4,12 +4,13 @@ module Mutest
     module Meta
       # Metadata for resbody nodes
       class Resbody
-        include NamedChildren, Concord.new(:node)
+        include Concord.new(:node)
+        include NamedChildren
 
         children :captures, :assignment, :body
 
         public :captures, :assignment, :body
-      end # Resbody
-    end # Meta
-  end # AST
-end # Mutest
+      end
+    end
+  end
+end

data/lib/mutest/ast/meta/restarg.rb

@@ -4,12 +4,13 @@ module Mutest
     module Meta
       # Metadata for restarg nodes
       class Restarg
-        include NamedChildren, Concord.new(:node)
+        include Concord.new(:node)
+        include NamedChildren
 
         children :name
 
         public :name
-      end # Restarg
-    end # Meta
-  end # AST
-end # Mutest
+      end
+    end
+  end
+end

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

@@ -4,7 +4,9 @@ module Mutest
     module Meta
       # Metadata for send nodes
       class Send
-        include NamedChildren, Concord.new(:node), NodePredicates
+        include NodePredicates
+        include Concord.new(:node)
+        include NamedChildren
 
         children :receiver, :selector
 
@@ -28,14 +30,7 @@ module Mutest
           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?
@@ -43,13 +38,6 @@ module Mutest
             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]
@@ -89,7 +77,7 @@ module Mutest
             n_const?(receiver)    &&
             Const.new(receiver).name.equal?(:Proc)
         end
-      end # Send
-    end # Meta
-  end # AST
-end # Mutest
+      end
+    end
+  end
+end

data/lib/mutest/ast/meta/symbol.rb

@@ -4,12 +4,13 @@ module Mutest
     module Meta
       # Metadata for symbol nodes
       class Symbol
-        include NamedChildren, Concord.new(:node)
+        include Concord.new(:node)
+        include NamedChildren
 
         children :name
 
         public :name
-      end # Symbol
-    end # Meta
-  end # AST
-end # Mutest
+      end
+    end
+  end
+end

data/lib/mutest/ast/named_children.rb

@@ -24,7 +24,7 @@ module Mutest
         def children
           node.children
         end
-      end # InstanceMethods
+      end
 
       # Methods mixed in at class level
       module ClassMethods
@@ -80,7 +80,7 @@ module Mutest
           define_method(name, &block)
           private(name)
         end
-      end # ClassMethods
-    end # NamedChildren
-  end # AST
-end # Mutest
+      end
+    end
+  end
+end

data/lib/mutest/ast/node_predicates.rb

@@ -3,7 +3,7 @@ module Mutest
     # Module for node predicates
     module NodePredicates
       Types::ALL.each do |type|
-        fail "method: #{type} is already defined" if instance_methods(true).include?(type)
+        raise "method: #{type} is already defined" if instance_methods(true).include?(type)
 
         name = "n_#{type.to_s.chomp('?')}?"
 
@@ -12,6 +12,6 @@ module Mutest
         end
         private name
       end
-    end # NodePredicates
-  end # AST
-end # Mutest
+    end
+  end
+end

data/lib/mutest/ast/nodes.rb

@@ -15,6 +15,6 @@ module Mutest
       N_SELF              = s(:self)
       N_ZSUPER            = s(:zsuper)
       N_EMPTY_SUPER       = s(:super)
-    end # Nodes
-  end # AST
-end # Mutest
+    end
+  end
+end

data/lib/mutest/ast/regexp.rb

@@ -45,6 +45,6 @@ module Mutest
       def self.to_expression(node)
         Transformer.lookup(node.type).to_expression(node)
       end
-    end # Regexp
-  end # AST
-end # Mutest
+    end
+  end
+end

data/lib/mutest/ast/regexp/transformer.rb

@@ -52,7 +52,11 @@ module Mutest
         class ExpressionToAST
           PREFIX = :regexp
 
-          include Concord.new(:expression), Procto.call, AST::Sexp, AbstractType, Adamantium
+          include Adamantium
+          include AbstractType
+          include AST::Sexp
+          include Procto.call
+          include Concord.new(:expression)
 
           private
 
@@ -93,11 +97,14 @@ module Mutest
           def type
             :"#{PREFIX}_#{expression.token}_#{expression.type}"
           end
-        end # ExpressionToAST
+        end
 
         # Abstract node transformer
         class ASTToExpression
-          include Concord.new(:node), Procto.call, AbstractType, Adamantium
+          include Adamantium
+          include AbstractType
+          include Procto.call
+          include Concord.new(:node)
 
           # Call generic transform method and freeze result
           #
@@ -119,7 +126,7 @@ module Mutest
           def subexpressions
             node.children.map(&Regexp.public_method(:to_expression))
           end
-        end # ASTToExpression
+        end
 
         # Mixin for node transformers
         #
@@ -143,7 +150,8 @@ module Mutest
               new(table)
             end
 
-            include Concord.new(:table), Adamantium
+            include Adamantium
+            include Concord.new(:table)
 
             # Types defined by the table
             #
@@ -160,7 +168,7 @@ module Mutest
             def lookup(type)
               table.fetch(type)
             end
-          end # Table
+          end
 
           private
 
@@ -177,8 +185,8 @@ module Mutest
           def expression_class
             self.class::TABLE.lookup(node.type).regexp_class
           end
-        end # LookupTable
-      end # Transformer
-    end # Regexp
-  end # AST
-end # Mutest
+        end
+      end
+    end
+  end
+end