factree 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1acd242c9352248bdd755e245c55e026d16cdc0
-  data.tar.gz: b888a69e8cd08b85e1d3177e2b38b5c3f8cda78c
+  metadata.gz: ec4b10d80f3e3fda0f49c30fed2b96130b706d34
+  data.tar.gz: 7f3679094a62023d8f43af067177d43b38f5b76e
 SHA512:
-  metadata.gz: cf47060ea361430911941b26da4cef20bb527847c9f0efd522f3bac3b32d7fe94dc56d750dc91f1947598d6e6aa07bcb8573d6a462a350af2c9c17f42782795a
-  data.tar.gz: 42455c60d1d5b9ddb10a0d50cd6a7c2d4847e855453a60c9f1058bce56327dc1469684e5358c243d36db5513779ef33d4a0476ab852cec54c021038f8a4d96f2
+  metadata.gz: f9465dfadd4267524ca50b0467bd15d6c4e4df965197ad6357f0f30274421df924e7f6ae2e1e2b07eb3486c015802b1b5847319f18997773fb9cba836f5d07b9
+  data.tar.gz: b5310e3f4992629a79b3b781d602cfb47dfe218cc81200867aa3c3d23936f6d81b489f6514303a0c8290af8f352e4e68e8b54bc588ff697f5684425e54cf6c58

data/README.md

@@ -1,6 +1,6 @@
 # Factree
 [![Gem Version](https://badge.fury.io/rb/factree.svg)](https://rubygems.org/gems/factree)
-[![Build Status](https://travis-ci.org/jstrater/factree.svg?branch=master)](https://travis-ci.org/jstrater/factree)
+[![Build Status](https://travis-ci.org/ConsultingMD/factree.svg?branch=master)](https://travis-ci.org/ConsultingMD/factree)
 
 Factree provides tools for making choices based on a set of facts that are not yet known. You write a decision function that takes a set facts and returns a conclusion. Factree will run your function and make sure it has all of the facts it needs to complete. If it doesn't, then Factree will tell you what's needed to continue.
 
@@ -22,7 +22,7 @@ Or install it yourself as:
 
 ## Usage
 
-[API documentation](http://www.rubydoc.info/github/jstrater/factree/)
+[API documentation](http://www.rubydoc.info/gems/factree)
 
 ## Development
 
@@ -32,7 +32,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jstrater/factree.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ConsultingMD/factree.
 
 ## License
 

data/factree.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |spec|
   spec.name          = "factree"
   spec.version       = Factree::VERSION
   spec.authors       = ["Josh Strater"]
-  spec.email         = ["jstrater@gmail.com"]
+  spec.email         = ["josh.strater@grandrounds.com"]
 
   spec.summary       = %q{Decision trees that request facts as needed}
-  spec.homepage      = "https://github.com/jstrater/factree"
+  spec.homepage      = "https://github.com/ConsultingMD/factree"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

data/lib/factree/dsl.rb

@@ -1,7 +1,3 @@
-require 'factree/conclusion'
-require 'factree/pathfinder'
-require 'factree/aggregate'
-
 # Readable shortcuts to common functions.
 module Factree::DSL
   # Creates a {Conclusion} to return from a decision proc.

data/lib/factree/fact_source.rb

@@ -0,0 +1,105 @@
+module Factree
+  # Mixin to help define fact source classes.
+  module FactSource
+    UndefinedFactError = Class.new(StandardError)
+    UnknownFactError = Class.new(StandardError)
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # Defines a named fact along with a block used to compute the fact's value.
+      #
+      # @param [Symbol] fact_name The new fact's name
+      def def_fact(fact_name, &block)
+        raise ArgumentError, "block required" unless block_given?
+
+        all_fact_procs = fact_procs.merge(fact_name => block).freeze
+        class_variable_set(:@@_fact_procs, all_fact_procs)
+        fact_name
+      end
+
+      # @return [Array<Symbol>] Names for all of the defined facts, whether their values are known or not.
+      def fact_names
+        fact_procs.keys.freeze
+      end
+
+      # @api private
+      def fact_procs
+        class_variable_defined?(:@@_fact_procs) ?
+          class_variable_get(:@@_fact_procs) :
+          {}.freeze
+      end
+
+      # @return [Boolean] True if the fact has been defined (using {FactSource.def_fact})
+      def defined?(fact_name)
+        fact_procs.include? fact_name
+      end
+    end
+
+    # Checks to see if the value of the fact is known.
+    def known?(fact_name)
+      fetch(fact_name) { return false }
+      true
+    end
+
+    # Returns the value of the fact, or nil if the value is unknown
+    def [](fact_name)
+      fetch(fact_name) { nil }
+    end
+
+    # Returns the value of the fact.
+    #
+    # If the value is unknown, then the block will be called with the name of the fact. If no block is supplied, then an UnknownFactError will be raised.
+    def fetch(fact_name, &block)
+      ensure_defined fact_name
+      fact_proc = self.class.fact_procs[fact_name]
+
+      fact_value = nil
+      fact_known = catch(UNKNOWN_FACT) do
+        fact_value = instance_eval(&fact_proc)
+        true
+      end
+      return fact_value if fact_known
+
+      fetch_unknown(fact_name, &block)
+    end
+
+    # @api private
+    def ensure_defined(fact_name)
+      unless self.class.defined? fact_name
+        raise UndefinedFactError, "undefined fact referenced: #{fact_name}"
+      end
+    end
+
+    # @api private
+    def fetch_unknown(fact_name)
+      return yield(fact_name) if block_given?
+
+      raise UnknownFactError, "unknown fact: #{fact_name}"
+    end
+
+    # A hash mapping all of the known fact names to values.
+    def to_h
+      self.class.fact_procs.flat_map { |fact_name, _fact_proc|
+        fact_known = true
+        fact_value = fetch(fact_name) { fact_known = false }
+
+        fact_known ? [[fact_name, fact_value]] : []
+      }.to_h
+    end
+
+    # Takes several FactSources and returns a single hash containing all of their facts mixed together.
+    def self.to_combined_h(*sources)
+      sources.map(&:to_h).inject({}, &:merge)
+    end
+
+    # Calling this method in a fact proc will signal that the fact's value is unknown.
+    def unknown
+      throw UNKNOWN_FACT
+    end
+
+    UNKNOWN_FACT = "Attempted to determine the value of a fact that is unknown".freeze
+  end
+end

data/lib/factree/pathfinder.rb

@@ -1,7 +1,3 @@
-require 'factree/path'
-require 'factree/facts'
-require 'factree/facts_spy'
-
 module Factree
   # Raised when a decision proc fails to return a Conclusion as expected
   InvalidConclusionError = Class.new(StandardError)

data/lib/factree/version.rb

@@ -1,3 +1,3 @@
 module Factree
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/factree.rb

@@ -1,9 +1,13 @@
-require "factree/version"
-require "factree/conclusion"
-require "factree/path"
-require "factree/aggregate"
-require "factree/dsl"
-
 module Factree
+  autoload :Aggregate, "factree/aggregate"
+  autoload :Conclusion, "factree/conclusion"
+  autoload :DSL, "factree/dsl"
+  autoload :FactSource, "factree/fact_source"
+  autoload :Facts, "factree/facts"
+  autoload :FactsSpy, "factree/facts_spy"
+  autoload :Path, "factree/path"
+  autoload :Pathfinder, "factree/pathfinder"
+  autoload :VERSION, "factree/version"
+
   extend DSL
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factree
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Josh Strater
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-26 00:00:00.000000000 Z
+date: 2017-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,7 +82,7 @@ dependencies:
         version: '0.9'
 description: 
 email:
-- jstrater@gmail.com
+- josh.strater@grandrounds.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -102,12 +102,13 @@ files:
 - lib/factree/aggregate.rb
 - lib/factree/conclusion.rb
 - lib/factree/dsl.rb
+- lib/factree/fact_source.rb
 - lib/factree/facts.rb
 - lib/factree/facts_spy.rb
 - lib/factree/path.rb
 - lib/factree/pathfinder.rb
 - lib/factree/version.rb
-homepage: https://github.com/jstrater/factree
+homepage: https://github.com/ConsultingMD/factree
 licenses:
 - MIT
 metadata: {}