grimoire 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40a6acabedf3270488bbf3be2eba64330a819044
-  data.tar.gz: 0da4eaa00a46d7a6beb0d68452183e7557e55d04
+  metadata.gz: 9e488dfe4964214969754e066c275034a4663d67
+  data.tar.gz: 015e51d0f9a05e51a00b5f0b41c4de77764c77f6
 SHA512:
-  metadata.gz: e39fbd0a25f246552db87ecbc890288ab47107846485257e4e0e6bc8eed821388ac1e82dfa9416fe19a4e9a914c05e9019a7acaf2228f7a19da7274e7bc94817
-  data.tar.gz: 02d3a49f7df811b8a98a255e3234ae7ec47da17f9033b23d9a47f1e077bc2d9e40c2f4459e901a25c99769a0f90644311eee1d98e862b3608601e495f34d9efe
+  metadata.gz: d4756adf5a06f61ed26b4732e7f8848b1a063f47372577578038be52ff8532e31d2c0f8e789612d9131d23aad8c27528fad05753d751b4bef6f821f8670253ce
+  data.tar.gz: 387138f63f6e94ee25c359be79359266721441b3f0779452fc20f871f525f1e2df03954a43702cf9473de8c10899c2249aa6ca547a2df7cad887d632dced909e

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.1.6
+* Add debug output if UI is available for output
+* Update exception errors to provide more detail/context
+* Provide better type checking prior to processing
+
 # v0.1.4
 * Provide simple system serialization support
 * Fix dependency listing from units within path

data/README.md

@@ -52,7 +52,7 @@ solver = Grimoire::Solver.new(
 
 * Generate solutions
 
-``ruby
+```ruby
 solutions = solver.generate!
 p solutions.pop
 ```

data/lib/grimoire.rb

@@ -20,6 +20,34 @@ module Grimoire
   autoload :UnitScoreKeeper, 'grimoire/unit_score_keeper'
   autoload :Utility, 'grimoire/utility'
 
+  class << self
+
+    # @return [Bogo::Ui]
+    attr_reader :ui
+
+    # Set Ui instance
+    #
+    # @param ui [Bogo::Ui]
+    # @return [Bogo::Ui]
+    def ui=(ui)
+      unless(ui.respond_to?(:debug))
+        raise TypeError.new "Expecting type `Bogo::Ui` but received `#{ui.class}`"
+      end
+      @ui = ui
+    end
+
+
+    # Write debug message
+    def debug(*args)
+      if(ui)
+        if(block_given?)
+          args.push(yield)
+        end
+        ui.debug(*args)
+      end
+    end
+  end
+
 end
 
 require 'grimoire/version'

data/lib/grimoire/requirement_list.rb

@@ -5,7 +5,7 @@ module Grimoire
   # Requirment list for solver
   class RequirementList < Utility
     attribute :name, String, :required => true, :coerce => lambda{|val| val.to_s}
-    attribute :requirements, DEPENDENCY_CLASS, :multiple => true, :default => [], :coerce => lambda{|val| DEPENDENCY_CLASS.new(val.first, *val.last)}
+    attribute :requirements, DEPENDENCY_CLASS, :multiple => true, :default => [], :coerce => lambda{|val| Grimoire.const_get(:DEPENDENCY_CLASS).new(val.first, *val.last)}
   end
 
 end

data/lib/grimoire/solver.rb

@@ -13,6 +13,7 @@ module Grimoire
     attribute :requirements, RequirementList, :required => true
     attribute :system, System, :required => true
     attribute :score_keeper, UnitScoreKeeper
+    attribute :result_limit, Integer, :required => true, :default => 1
 
     # @return [System] subset of full system based on requirements
     attr_reader :world
@@ -39,11 +40,16 @@ module Grimoire
       deps.each do |dep|
         units = root.subset(dep.name, dep.requirement)
         sha = Digest::SHA256.hexdigest(MultiJson.dump(units))
-        next if @log.include?(sha)
+        if(@log.include?(sha))
+          debug "Units checksum already added to world. Skipping. (`#{sha}`)"
+          next
+        end
+        debug "Logging units checksum for world addition. (`#{sha}`)"
         @log.push(sha)
         units.each do |unit|
           build_world(unit.dependencies, my_world, root)
         end
+        debug "Units added to world: #{MultiJson.dump(units.map{|u| {u.name => u.version} })}"
         my_world.add_unit(units)
       end
     end
@@ -108,6 +114,9 @@ module Grimoire
     # @raises [Error::UnitUnavailable]
     def unit_for(dep)
       unit = nil
+      if(queues[dep.name].nil?)
+        raise KeyError.new "No valid units for requested name found within system! (`#{dep.name}`)"
+      end
       until(unit || queues[dep.name].empty?)
         unit = queues[dep.name].pop
         unit = nil unless dep.requirement.satisfied_by?(unit.version)
@@ -158,7 +167,8 @@ module Grimoire
               end
             end
           end
-        rescue Error::ResolutionPathInvalid
+        rescue Error::ResolutionPathInvalid => e
+          debug "Resolution path deadend: #{e} (trying new path)"
           retry
         end
         deps.uniq
@@ -169,30 +179,32 @@ module Grimoire
     #
     # @return [Bogo::PriorityQueue<Path>]
     def generate!
+      if(requirements.requirements.empty?)
+        raise ArgumentError.new 'No cookbook constraints provided within Batali file!'
+      end
       custom_unit = Unit.new(
         :name => '~_SOLVER_UNIT_~',
         :version => '1.0.0',
         :dependencies => requirements.requirements
       )
       count = 0
+      debug "Solver Unit: #{MultiJson.dump(custom_unit)}"
+      debug{ "Solver world context of unit system: #{world.inspect}" }
       results = Bogo::PriorityQueue.new
       begin
-        until(count > MAX_GENERATION_LOOPS)
+        until(count >= result_limit)
           result = resolve(nil, custom_unit)
           results.push(Path.new(:units => result.slice(1, result.size)), count)
           count += 1
         end
-      rescue Error::UnitUnavailable
+      rescue Error::UnitUnavailable => e
+        debug "Failed to unit: #{e}"
         count = nil
       end
-      unless(count.nil?)
-        raise Error::MaximumGenerationLoopsExceeded.new("Exceeded maximum allowed loops for path generation: #{MAX_GENERATION_LOOPS}")
+      if(results.empty?)
+        raise Error::NoSolution.new("Failed to generate valid path for requirements: `#{custom_unit.dependencies}`")
       else
-        if(results.empty?)
-          raise Error::NoSolution.new("Failed to generate valid path for requirements: `#{custom_unit.dependencies.inspect}`")
-        else
-          results
-        end
+        results
       end
     end
 

data/lib/grimoire/system.rb

@@ -58,6 +58,9 @@ module Grimoire
       unless(constraint.respond_to?(:requirements))
         raise TypeError.new "Expecting `#{REQUIREMENT_CLASS}` but received `#{constraint.class}`"
       end
+      unless(units[unit_name])
+        raise KeyError.new("Failed to locate any units loaded in system with requested name: `#{unit_name}`")
+      end
       units[unit_name].find_all do |unit|
         constraint.satisfied_by?(unit.version)
       end
@@ -83,5 +86,13 @@ module Grimoire
       )
     end
 
+    # @return [String]
+    def inspect
+      "<#{self.class}:#{self.object_id}>: " <<
+        units.to_a.sort_by(&:first).map do |name, units|
+        "#{name}: #{units.map(&:version).sort.map(&:to_s).join(', ')}"
+      end.join("\n")
+    end
+
   end
 end

data/lib/grimoire/unit.rb

@@ -6,8 +6,8 @@ module Grimoire
   class Unit < Utility
 
     attribute :name, String, :required => true
-    attribute :dependencies, DEPENDENCY_CLASS, :multiple => true, :default => [], :coerce => lambda{|val| DEPENDENCY_CLASS.new(val.first, *val.last)}
-    attribute :version, VERSION_CLASS, :required => true, :coerce => lambda{|val| VERSION_CLASS.new(val)}
+    attribute :dependencies, DEPENDENCY_CLASS, :multiple => true, :default => [], :coerce => lambda{|val| Grimoire.const_get(:DEPENDENCY_CLASS).new(val.first, *val.last)}
+    attribute :version, VERSION_CLASS, :required => true, :coerce => lambda{|val| Grimoire.const_get(:VERSION_CLASS).new(val)}
 
   end
 

data/lib/grimoire/utility.rb

@@ -20,6 +20,12 @@ module Grimoire
     def to_json(*args)
       MultiJson.dump(data, *args)
     end
+
+    # Write debug message
+    def debug(*args, &block)
+      Grimoire.debug(*args, &block)
+    end
+
   end
 
 end

data/lib/grimoire/version.rb

@@ -1,4 +1,4 @@
 module Grimoire
   # Current library version
-  VERSION = Gem::Version.new('0.1.4')
+  VERSION = Gem::Version.new('0.1.6')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grimoire
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bogo