mutant 0.8.8 → 0.8.9

data/lib/mutant/mutator/node/send/index.rb

@@ -17,8 +17,6 @@ module Mutant
             # Perform dispatch
             #
             # @return [undefined]
-            #
-            # @api private
             def dispatch
               emit_naked_receiver
               emit_value_mutations
@@ -30,8 +28,6 @@ module Mutant
             # Mutate indices
             #
             # @return [undefined]
-            #
-            # @api private
             def mutate_indices
               children_indices(INDEX_RANGE).each do |index|
                 delete_child(index)
@@ -42,8 +38,6 @@ module Mutant
             # Emit index read
             #
             # @return [undefined]
-            #
-            # @api private
             def emit_index_read
               emit_type(receiver, :[], *children[INDEX_RANGE])
             end

data/lib/mutant/mutator/node/splat.rb

@@ -13,8 +13,6 @@ module Mutant
         # Perform dispatch
         #
         # @return [undefined]
-        #
-        # @api private
         def dispatch
           emit_singletons
           emit_expression_mutations

data/lib/mutant/mutator/node/super.rb

@@ -12,8 +12,6 @@ module Mutant
         # Emit mutations
         #
         # @return [undefined]
-        #
-        # @api private
         def dispatch
           emit_singletons
           emit(N_EMPTY_SUPER)

data/lib/mutant/mutator/node/when.rb

@@ -12,8 +12,6 @@ module Mutant
         # Emit mutations
         #
         # @return [undefined]
-        #
-        # @api private
         def dispatch
           if body
             mutate_body
@@ -26,8 +24,6 @@ module Mutant
         # Emit condition mutations
         #
         # @return [undefined]
-        #
-        # @api private
         def mutate_conditions
           conditions = children.length - 1
           children[0..-2].each_index do |index|
@@ -39,8 +35,6 @@ module Mutant
         # Emit body mutations
         #
         # @return [undefined]
-        #
-        # @api private
         def mutate_body
           mutate_child(body_index)
         end
@@ -52,8 +46,6 @@ module Mutant
         #
         # @return [nil]
         #   otherwise
-        #
-        # @api private
         def body
           children[body_index]
         end
@@ -61,8 +53,6 @@ module Mutant
         # Index of body node
         #
         # @return [Fixnum]
-        #
-        # @api private
         def body_index
           children.length - 1
         end

data/lib/mutant/mutator/node/yield.rb

@@ -12,8 +12,6 @@ module Mutant
         # Emit mutations
         #
         # @return [undefined]
-        #
-        # @api private
         def dispatch
           super
           emit_singletons

data/lib/mutant/mutator/node/zsuper.rb

@@ -12,8 +12,6 @@ module Mutant
         # Emit mutations
         #
         # @return [undefined]
-        #
-        # @api private
         def dispatch
           emit_singletons
           emit(N_EMPTY_SUPER)

data/lib/mutant/mutator/registry.rb

@@ -6,8 +6,6 @@ module Mutant
       # Initialize object
       #
       # @return [undefined]
-      #
-      # @api private
       def initialize
         @registry = {}
       end
@@ -21,8 +19,6 @@ module Mutant
       # @param [Class:Mutator] mutator
       #
       # @return [self]
-      #
-      # @api private
       def register(type, mutator)
         fail RegistryError, "Invalid type registration: #{type}" unless AST::Types::ALL.include?(type)
         fail RegistryError, "Duplicate type registration: #{type}" if @registry.key?(type)
@@ -38,8 +34,6 @@ module Mutant
       #
       # @raise [ArgumentError]
       #   raises argument error when mutator class cannot be found
-      #
-      # @api private
       def lookup(node)
         type = node.type
         @registry.fetch(type) do

data/lib/mutant/mutator/util.rb

@@ -13,8 +13,6 @@ module Mutant
       #
       # @return [self]
       #   otherwise
-      #
-      # @api private
       def self.each(object, parent, &block)
         return to_enum(__method__, object, parent) unless block_given?
 
@@ -30,8 +28,6 @@ module Mutant
       # @param [Object] generated
       #
       # @return [Boolean]
-      #
-      # @api private
       def new?(generated)
         !input.eql?(generated)
       end

data/lib/mutant/mutator/util/array.rb

@@ -13,8 +13,6 @@ module Mutant
           # Emit element presence mutations
           #
           # @return [undefined]
-          #
-          # @api private
           def dispatch
             input.each_index do |index|
               dup = dup_input
@@ -33,8 +31,6 @@ module Mutant
           # Emit mutations
           #
           # @return [undefined]
-          #
-          # @api private
           def dispatch
             input.each_with_index do |element, index|
               Mutator.each(element).each do |mutation|
@@ -52,8 +48,6 @@ module Mutant
         # Emit mutations
         #
         # @return [undefined]
-        #
-        # @api private
         def dispatch
           run(Element)
           run(Presence)

data/lib/mutant/mutator/util/symbol.rb

@@ -12,8 +12,6 @@ module Mutant
         # Emit mutations
         #
         # @return [undefined]
-        #
-        # @api private
         def dispatch
           emit((input.to_s + POSTFIX).to_sym)
         end

data/lib/mutant/parallel.rb

@@ -9,8 +9,6 @@ module Mutant
       # Scheduler status
       #
       # @return [Object]
-      #
-      # @api private
       def status
         binding.call(__method__)
       end
@@ -18,19 +16,15 @@ module Mutant
       # Stop master gracefully
       #
       # @return [self]
-      #
-      # @api private
       def stop
         binding.call(__method__)
         self
       end
     end # Driver
 
-    # Run async computation returing driver
+    # Run async computation returning driver
     #
     # @return [Driver]
-    #
-    # @api private
     def self.async(config)
       Driver.new(config.env.new_mailbox.bind(Master.call(config)))
     end
@@ -44,43 +38,53 @@ module Mutant
       # @param [Object]
       #
       # @return [self]
-      #
-      # @api private
       abstract_method :result
 
       # Sink status
       #
       # @return [Object]
-      #
-      # @api private
       abstract_method :status
 
       # Test if processing should stop
       #
       # @return [Boolean]
-      #
-      # @api private
       abstract_method :stop?
     end # Sink
 
     # Job to push to workers
     class Job
-      include Adamantium::Flat, Anima.new(:index, :payload)
+      include Adamantium::Flat, Anima.new(
+        :index,
+        :payload
+      )
     end # Job
 
     # Job result object received from workers
     class JobResult
-      include Adamantium::Flat, Anima.new(:job, :payload)
+      include Adamantium::Flat, Anima.new(
+        :job,
+        :payload
+      )
     end # JobResult
 
     # Parallel run configuration
     class Config
-      include Adamantium::Flat, Anima.new(:env, :processor, :source, :sink, :jobs)
+      include Adamantium::Flat, Anima.new(
+        :env,
+        :jobs,
+        :processor,
+        :sink,
+        :source
+      )
     end # Config
 
     # Parallel execution status
     class Status
-      include Adamantium::Flat, Anima.new(:payload, :done, :active_jobs)
+      include Adamantium::Flat, Anima.new(
+        :active_jobs,
+        :done,
+        :payload
+      )
     end
 
   end # Parallel

data/lib/mutant/parallel/master.rb

@@ -11,8 +11,6 @@ module Mutant
       # @param [Config] config
       #
       # @return [Actor::Sender]
-      #
-      # @api private
       def self.call(config)
         config.env.spawn do |mailbox|
           new(config, mailbox).__send__(:run)
@@ -22,8 +20,6 @@ module Mutant
       # Initialize object
       #
       # @return [undefined]
-      #
-      # @api private
       def initialize(*)
         super
 
@@ -40,8 +36,6 @@ module Mutant
       # rubocop:disable MethodLength
       #
       # @return [undefined]
-      #
-      # @api private
       def run
         config.jobs.times do
           @workers += 1
@@ -69,8 +63,6 @@ module Mutant
       # @param [Actor::Message] message
       #
       # @return [undefined]
-      #
-      # @api private
       def handle(message)
         type, payload = message.type, message.payload
         method = MAP.fetch(type) do
@@ -82,8 +74,6 @@ module Mutant
       # Run receive loop
       #
       # @return [undefined]
-      #
-      # @api private
       def receive_loop
         handle(mailbox.receiver.call) until @workers.zero? && @stop
       end
@@ -93,8 +83,6 @@ module Mutant
       # @param [Actor::Sender] sender
       #
       # @return [undefined]
-      #
-      # @api private
       def handle_status(sender)
         status = Status.new(
           payload:     sink.status,
@@ -109,8 +97,6 @@ module Mutant
       # @param [JobResult] job_result
       #
       # @return [undefined]
-      #
-      # @api private
       def handle_result(job_result)
         @active_jobs.delete(job_result.job)
         sink.result(job_result.payload)
@@ -121,8 +107,6 @@ module Mutant
       # @param [Actor::Sender] sender
       #
       # @return [undefined]
-      #
-      # @api private
       def handle_stop(sender)
         @stop = true
         receive_loop
@@ -134,8 +118,6 @@ module Mutant
       # @param [Actor::Sender] sender
       #
       # @return [undefined]
-      #
-      # @api private
       def handle_ready(sender)
         if stop_work?
           stop_worker(sender)
@@ -151,8 +133,6 @@ module Mutant
       #   if next job is available
       #
       # @return [nil]
-      #
-      # @api private
       def next_job
         Job.new(
           index:   @index,
@@ -168,8 +148,6 @@ module Mutant
       # @param [Actor::Sender] sender
       #
       # @return [undefined]
-      #
-      # @api private
       def stop_worker(sender)
         @workers -= 1
         sender.call(Actor::Message.new(:stop))
@@ -178,8 +156,6 @@ module Mutant
       # Test if scheduling stopped
       #
       # @return [Boolean]
-      #
-      # @api private
       def stop_work?
         @stop || !source.next? || sink.stop?
       end
@@ -187,8 +163,6 @@ module Mutant
       # Job source
       #
       # @return [Source]
-      #
-      # @api private
       def source
         config.source
       end
@@ -196,8 +170,6 @@ module Mutant
       # Job result sink
       #
       # @return [Sink]
-      #
-      # @api private
       def sink
         config.sink
       end

data/lib/mutant/parallel/source.rb

@@ -12,15 +12,11 @@ module Mutant
       #
       # @raise [NoJobError]
       #   when no next job is available
-      #
-      # @api private
       abstract_method :next
 
       # Test if next job is available
       #
       # @return [Boolean]
-      #
-      # @api private
       abstract_method :next?
 
       # Job source backed by a finite array
@@ -30,8 +26,6 @@ module Mutant
         # Initialize objecto
         #
         # @return [undefined]
-        #
-        # @api private
         def initialize(*)
           super
 
@@ -41,8 +35,6 @@ module Mutant
         # Test if next job is available
         #
         # @return [Boolean]
-        #
-        # @api private
         def next?
           @next_index < jobs.length
         end
@@ -53,8 +45,6 @@ module Mutant
         #
         # @raise [NoJobError]
         #   when no next job is available
-        #
-        # @api private
         def next
           fail NoJobError unless next?
           jobs.fetch(@next_index).tap do

data/lib/mutant/parallel/worker.rb

@@ -2,15 +2,17 @@ module Mutant
   module Parallel
     # Parallel execution worker
     class Worker
-      include Adamantium::Flat, Anima.new(:mailbox, :processor, :parent)
+      include Adamantium::Flat, Anima.new(
+        :mailbox,
+        :parent,
+        :processor
+      )
 
       # Run worker
       #
       # @param [Hash<Symbol, Object] attributes
       #
       # @return [self]
-      #
-      # @api private
       def self.run(attributes)
         new(attributes).run
         self
@@ -23,8 +25,6 @@ module Mutant
       # @return [self]
       #
       # rubocop:disable Lint/Loop
-      #
-      # @api private
       def run
         begin
           parent.call(Actor::Message.new(:ready, mailbox.sender))
@@ -38,8 +38,6 @@ module Mutant
       # @param [Message] message
       #
       # @return [Boolean]
-      #
-      # @api private
       def handle(message)
         type, payload = message.type, message.payload
         case message.type
@@ -58,11 +56,18 @@ module Mutant
       # @param [Job] job
       #
       # @return [undefined]
-      #
-      # @api private
       def handle_job(job)
         result = processor.call(job.payload)
-        parent.call(Actor::Message.new(:result, JobResult.new(job: job, payload: result)))
+
+        parent.call(
+          Actor::Message.new(
+            :result,
+            JobResult.new(
+              job: job,
+              payload: result
+            )
+          )
+        )
       end
 
     end # Worker