grimoire 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 200bc22b954a33f6ec11d2a41403afafacc3fe35
-  data.tar.gz: e2ebba16137affccdf764c24c08132f8668bc6ab
+  metadata.gz: 40a6acabedf3270488bbf3be2eba64330a819044
+  data.tar.gz: 0da4eaa00a46d7a6beb0d68452183e7557e55d04
 SHA512:
-  metadata.gz: a4dbcf9162fe2846c739bb71fd1a9d50e87a7f843841663b0c7878917dbbf2dbab2a6ef004498543a3d07ba03c14806e714da846f15e523918c9f9fb434f5516
-  data.tar.gz: fa8a7d53d999489bf596f3ffbf1f77d5fd04ee68b3b5e3e236aab6dc2df230f55d75f4100cca5e9a6e1d3c4d00c703e813052a1cf87cd64e5042d771be42aa9d
+  metadata.gz: e39fbd0a25f246552db87ecbc890288ab47107846485257e4e0e6bc8eed821388ac1e82dfa9416fe19a4e9a914c05e9019a7acaf2228f7a19da7274e7bc94817
+  data.tar.gz: 02d3a49f7df811b8a98a255e3234ae7ec47da17f9033b23d9a47f1e077bc2d9e40c2f4459e901a25c99769a0f90644311eee1d98e862b3608601e495f34d9efe

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.1.4
+* Provide simple system serialization support
+* Fix dependency listing from units within path
+* Allow checking existing path for constraint satisfaction
+
 # v0.1.2
 * Add JSON serialization support to utility instances
 * Add abstract for unit scoring

data/README.md

@@ -1,5 +1,64 @@
 # Grimoire
 
+Light weight generic dependency resolver. Supports weighted
+solutions via scored units.
+
+## Usage
+
+Basic usage flow:
+
+* Create a system
+
+```ruby
+system = Grimoire::System.new
+```
+
+* Add units
+
+```ruby
+system.add_units(
+  Grimoire::Unit.new(
+    :name => 'unit1',
+    :version => '1.0.0'
+  ),
+  Grimoire::Unit.new(
+    :name => 'unit1',
+    :version => '1.1.0'
+  ),
+  ...
+)
+```
+
+* Create a score keeper
+
+_NOTE: Score keeper is optional and *must* be subclassed. This example will not actually work._
+
+```ruby
+score_keeper = Grimoire::ScoreKeeper.new
+```
+
+* Create solver
+
+```ruby
+solver = Grimoire::Solver.new(
+  :system => system,
+  :score_keeper => score_keeper,
+  :requirements => [
+    ['unit1', '> 2.0.0'],
+    ['unit2', '> 1', '< 3']
+  ]
+)
+```
+
+* Generate solutions
+
+``ruby
+solutions = solver.generate!
+p solutions.pop
+```
+
+The ideal solution will be the first path on the queue.
+
 ## Info
 
 * Repository: https://github.com/spox/grimoire

data/grimoire.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
   s.license = 'Apache 2.0'
   s.add_runtime_dependency 'bogo', '~> 0.1.10'
+  s.add_runtime_dependency 'attribute_struct', '>= 0.1.12'
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'pry'
   s.files = Dir['{lib}/**/**/*'] + %w(grimoire.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)

data/lib/grimoire/path.rb

@@ -6,8 +6,9 @@ module Grimoire
 
     attribute :units, Unit, :multiple => true, :default => []
 
+    # @return [Array<DEPENDENCY_CLASS>]
     def dependencies
-      units.map(&:dependencies).flatten.uniq!
+      units.map(&:dependencies).flatten.uniq
     end
 
   end

data/lib/grimoire/solver.rb

@@ -1,3 +1,4 @@
+require 'digest/sha2'
 require 'grimoire'
 
 module Grimoire
@@ -19,7 +20,9 @@ module Grimoire
     def initialize(*_)
       super
       @world = System.new
+      @log = []
       build_world(requirements.requirements, world, system)
+      @log.clear
       world.scrub!
     end
 
@@ -35,6 +38,9 @@ module Grimoire
       root = system unless root
       deps.each do |dep|
         units = root.subset(dep.name, dep.requirement)
+        sha = Digest::SHA256.hexdigest(MultiJson.dump(units))
+        next if @log.include?(sha)
+        @log.push(sha)
         units.each do |unit|
           build_world(unit.dependencies, my_world, root)
         end
@@ -118,8 +124,9 @@ module Grimoire
     #
     # @param dep [DEPENDENCY_CLASS]
     # @param given [DEPENDENCY_CLASS]
+    # @param current [Array<Unit>] current units within path
     # @return [Array<Unit>]
-    def resolve(dep, given=nil)
+    def resolve(dep, given=nil, current=[])
       unit = given || unit_for(dep)
       if(unit.dependencies.empty?)
         [unit]
@@ -127,7 +134,7 @@ module Grimoire
         deps = [unit]
         begin
           unit.dependencies.map do |u_dep|
-            existing = deps.detect{|d| d.name == u_dep.name}
+            existing = (current + deps).detect{|d| d.name == u_dep.name}
             if(existing)
               if(u_dep.requirement.satisfied_by?(existing.version))
                 next
@@ -138,7 +145,7 @@ module Grimoire
             else
               reset_queue(u_dep.name) unless given
             end
-            deps += resolve(u_dep)
+            deps += resolve(u_dep, nil, current + deps)
             deps.compact!
             u_dep
           end.compact.map do |u_dep|  # validator
@@ -154,7 +161,7 @@ module Grimoire
         rescue Error::ResolutionPathInvalid
           retry
         end
-        deps
+        deps.uniq
       end
     end
 

data/lib/grimoire/system.rb

@@ -19,6 +19,9 @@ module Grimoire
     # @param unit [Unit]
     # @return [self]
     def add_unit(*unit)
+      if(bad_u = unit.flatten.detect{|u| !u.is_a?(Unit)})
+        raise TypeError.new "Expecting `Unit` instance but received `#{bad_u.class}`"
+      end
       [unit].flatten.compact.each do |u|
         unless(units[u.name])
           units[u.name] = []
@@ -34,8 +37,14 @@ module Grimoire
     # @param deps
     # @return [self]
     def remove_unit(unit)
+      unless(unit.is_a?(Unit))
+        raise TypeError.new "Expecting `Unit` instance but received `#{unit.class}`"
+      end
       if(units[unit.name])
         units[unit.name].delete(unit)
+        if(units[unit.name].empty?)
+          units.delete(unit.name)
+        end
       end
       self
     end
@@ -46,6 +55,9 @@ module Grimoire
     # @param constraint [REQUIREMENT_CLASS]
     # @return [Array<Unit>]
     def subset(unit_name, constraint)
+      unless(constraint.respond_to?(:requirements))
+        raise TypeError.new "Expecting `#{REQUIREMENT_CLASS}` but received `#{constraint.class}`"
+      end
       units[unit_name].find_all do |unit|
         constraint.satisfied_by?(unit.version)
       end
@@ -63,5 +75,13 @@ module Grimoire
       self
     end
 
+    # @return [String]
+    def to_json(*args)
+      MultiJson.dump(
+        Smash.new(:units => units),
+        *args
+      )
+    end
+
   end
 end

data/lib/grimoire/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grimoire
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bogo
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.10
+- !ruby/object:Gem::Dependency
+  name: attribute_struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.12
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement