solve 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 868022031f083b30e7c32a6d424896fb2fb08367
-  data.tar.gz: 5d50e154ab203dbddd6888616295fc683f26672c
+  metadata.gz: 96b860730518abd99eb79c2d9b847fc6b4b13d5c
+  data.tar.gz: 95635f8ef60cce43ff1b92e7800e749ef1666659
 SHA512:
-  metadata.gz: 56abef15a6d5da9a0e31e1ed88cc46ce9acb7aab8526ec7aaf0c615e8f09cfa1fbb0b361349282640813328fecc954f9eb75fea5d73764176964b771c1a467ec
-  data.tar.gz: 0a079122af8824f23e23c69649092b4f32c7cbb44f72e4fc9d754350c45a48580280e758bb8e94269d6edba99ed026c379399d1edd38fe49afa53b70acfbc84c
+  metadata.gz: 5742cdbaecdfae7a0dac68f377331b96ee1200ca469e4317a647ec4fb23710520afd46051468ce9509ba81952c508cbb12dccc50323f35c00aa75d2c6f20df43
+  data.tar.gz: f6602ad5b6a9e9e07e052e779727b9a8f24abc267443af2e9902f6536dcb99b430841f1d72e8ea62b2edfa20b789740675326c6a2499ce4e5bdd35a9a117f61a

data/lib/solve.rb

@@ -8,8 +8,12 @@ module Solve
   require_relative 'solve/graph'
   require_relative 'solve/solver'
   require_relative 'solve/version'
+  require_relative 'solve/tracers'
 
   class << self
+    # @return [Solve::Formatter]
+    attr_reader :tracer
+
     # A quick solve. Given the "world" as we know it (the graph) and a list of
     # requirements (demands) which must be met. Return me the best solution of
     # artifacts and verisons that I should use.
@@ -20,7 +24,10 @@ module Solve
     # @param [Array<Solve::Demand>, Array<String, String>] demands
     #
     # @option options [#say] :ui (nil)
-    #   a ui object for output
+    #   a ui object for output, this will be used to output from a Solve::Tracers::HumanReadable if
+    #   no other tracer is provided in options[:tracer]
+    # @option options [AbstractTracer] :tracer (nil)
+    #   a Tracer object that is used to format and output tracing information
     # @option options [Boolean] :sorted (false)
     #   should the output be a sorted list rather than a Hash
     #
@@ -28,6 +35,7 @@ module Solve
     #
     # @return [Hash]
     def it!(graph, demands, options = {})
+      @tracer = options[:tracer] || Solve::Tracers.build(options[:ui])
       Solver.new(graph, demands, options[:ui]).resolve(options)
     end
   end

data/lib/solve/gem_version.rb

@@ -1,3 +1,3 @@
 module Solve
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/solve/solver.rb

@@ -94,24 +94,20 @@ module Solve
     # @return [Hash, List] Returns a hash like { "Artifact Name" => "Version",... }
     #   unless options[:sorted], then it returns a list like [["Artifact Name", "Version],...]
     def resolve(options = {})
-      trace("Attempting to find a solution")
+      Solve.tracer.start
       seed_demand_dependencies
 
       while unbound_variable = variable_table.first_unbound
         possible_values_for_unbound = possible_values_for(unbound_variable)
-        trace("Searching for a value for #{unbound_variable.artifact}")
-        trace("Constraints are")
-        constraint_table.constraints_on_artifact(unbound_variable.artifact).each do |constraint|
-          trace("\t#{constraint}")
-        end
-        trace("Possible values are #{possible_values_for_unbound}")
+        constraints = constraint_table.constraints_on_artifact(unbound_variable.artifact)
+        Solve.tracer.searching_for(unbound_variable, constraints, possible_values)
 
         while possible_value = possible_values_for_unbound.shift
           possible_artifact = graph.get_artifact(unbound_variable.artifact, possible_value.version)
           possible_dependencies = possible_artifact.dependencies
           all_ok = possible_dependencies.all? { |dependency| can_add_new_constraint?(dependency) }
           if all_ok
-            trace("Attempting to use #{possible_artifact}")
+            Solve.tracer.trying(possible_artifact)
             add_dependencies(possible_dependencies, possible_artifact)
             unbound_variable.bind(possible_value)
             break
@@ -119,15 +115,13 @@ module Solve
         end
 
         unless unbound_variable.bound?
-          trace("Could not find an acceptable value for #{unbound_variable.artifact}")
           backtrack(unbound_variable)
         end
       end
 
       solution = (options[:sorted]) ? build_sorted_solution : build_unsorted_solution
 
-      trace("Found Solution")
-      trace(solution)
+      Solve.tracer.solution(solution)
 
       solution
     end
@@ -266,7 +260,7 @@ module Solve
 
       def add_dependencies(dependencies, source)
         dependencies.each do |dependency|
-          trace("Adding constraint #{dependency.name} #{dependency.constraint} from #{source}")
+          Solve.tracer.add_constraint(dependency, source)
           variable_table.add(dependency.name, source)
           constraint_table.add(dependency, source)
           dependency_domain = graph.versions(dependency.name, dependency.constraint)
@@ -289,41 +283,36 @@ module Solve
       end
 
       def reset_possible_values_for(variable)
-        trace("Resetting possible values for #{variable.artifact}")
+        Solve.tracer.reset_domain(variable)
         possible_values[variable.artifact] = nil
-        x = possible_values_for(variable)
-        trace("Possible values are #{x}")
-        x
+        possible_values_for(variable).tap { |values| Solve.tracer.possible_values(values) }
       end
 
       def backtrack(unbound_variable)
+        Solve.tracer.backtrack(unbound_variable)
         previous_variable = variable_table.before(unbound_variable.artifact)
 
         if previous_variable.nil?
-          trace("Cannot backtrack any further")
+          Solve.tracer.cannot_backtrack
           raise Errors::NoSolutionError
         end
 
-        trace("Unbinding #{previous_variable.artifact}")
+        Solve.tracer.unbind(previous_variable)
 
         source = previous_variable.value
         removed_variables = variable_table.remove_all_with_only_this_source!(source)
         removed_variables.each do |removed_variable|
           possible_values[removed_variable.artifact] = nil
-          trace("Removed variable #{removed_variable.artifact}")
+          Solve.tracer.remove_variable(removed_variable)
         end
         removed_constraints = constraint_table.remove_constraints_from_source!(source)
         removed_constraints.each do |removed_constraint|
-          trace("Removed constraint #{removed_constraint.name} #{removed_constraint.constraint}")
+          Solve.tracer.remove_constraint(removed_constraint)
         end
         previous_variable.unbind
         variable_table.all_after(previous_variable.artifact).each do |variable|
           new_possibles = reset_possible_values_for(variable)
         end
       end
-
-      def trace(message)
-        ui.say(message) unless ui.nil?
-      end
   end
 end

data/lib/solve/tracers.rb

@@ -0,0 +1,50 @@
+module Solve
+  module Tracers
+    class << self
+      # @param [#say] ui
+      #
+      # @returns [AbstractTracer]
+      def build(ui)
+        unless ui.respond_to?(:say)
+          Solve::Tracers::Silent.new
+        else
+          Solve::Tracers::HumanReadable.new(ui)
+        end
+      end
+    end
+
+    class AbstractTracer
+      class << self
+        private
+
+          def must_define(*args)
+            args.each do |method|
+              define_method(method.to_sym) do |*args|
+                raise AbstractFunction, "##{method} must be defined on #{self.class}"
+              end
+            end
+          end
+      end
+
+      TRACER_METHODS = [
+        :start,
+        :searching_for,
+        :add_constraint,
+        :possible_values,
+        :trying,
+        :backtrack,
+        :cannot_backtrack,
+        :solution,
+        :reset_domain,
+        :unbind,
+        :remove_variable,
+        :remove_constraint,
+      ]
+
+      must_define *TRACER_METHODS
+    end
+  end
+end
+
+require_relative 'tracers/human_readable'
+require_relative 'tracers/silent'

data/lib/solve/tracers/human_readable.rb

@@ -0,0 +1,67 @@
+module Solve
+  module Tracers
+    class HumanReadable < AbstractTracer
+      extend Forwardable
+
+      attr_reader :ui
+
+      def_delegator :ui, :say
+
+      # @param [#say] ui
+      def initialize(ui)
+        @ui = ui
+      end
+
+      def start
+        say("Attempting to find a solution")
+      end
+
+      def searching_for(unbound_variable, constraints, possible_values)
+        say("Searching for a value for #{unbound_variable.artifact}")
+        say("Constraints are #{constraints.join("\n\t")}")
+        possible_values(possible_values)
+      end
+
+      def possible_values(possible_values)
+        say("Possible values are #{possible_values.map(&:to_s).join("\n\t")}")
+      end
+
+      def trying(artifact)
+        say("Attempting to use #{artifact.to_s}")
+      end
+
+      def backtrack(unbound_variable)
+        say("Could not find an acceptable value for #{unbound_variable.artifact.to_s}")
+      end
+
+      def cannot_backtrack
+        say("Cannot backtrack any further")
+      end
+
+      def solution(solution)
+        say("Found Solution")
+        say(solution)
+      end
+
+      def add_constraint(dependency, source)
+        say("Adding constraint #{dependency.name} #{dependency.constraint} from #{source.to_s}")
+      end
+
+      def reset_domain(variable)
+        say("Resetting possible values for #{variable.artifact.to_s}")
+      end
+
+      def unbind(variable)
+        say("Unbinding #{variable.artifact.to_s}")
+      end
+
+      def remove_variable(variable)
+        say("Removed variable #{variable.artifact.to_s}")
+      end
+
+      def remove_constraint(constraint)
+        say("Removed constraint #{constraint.name} #{constraint.constraint}")
+      end
+    end
+  end
+end

data/lib/solve/tracers/silent.rb

@@ -0,0 +1,17 @@
+module Solve
+  module Tracers
+    class Silent < AbstractTracer
+      class << self
+        def empty_method(*args)
+          args.each do |method|
+            define_method(method.to_sym) do |*args|
+            end
+          end
+        end
+      end
+
+      empty_method *AbstractTracer::TRACER_METHODS
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solve
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Jamie Winsor
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby version constraint solver
 email:
@@ -43,6 +43,9 @@ files:
 - lib/solve/solver/serializer.rb
 - lib/solve/solver/variable_row.rb
 - lib/solve/solver/variable_table.rb
+- lib/solve/tracers.rb
+- lib/solve/tracers/human_readable.rb
+- lib/solve/tracers/silent.rb
 - lib/solve/version.rb
 - solve.gemspec
 - spec/acceptance/solutions_spec.rb