oso-oso 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e511f86c5a330c1bb071824398085362def8ba7
-  data.tar.gz: da3baaad23fb6e28c8ef0558bbf1deb659c03700
+  metadata.gz: 8c00a51f40789d269beb2d63e29ad12b76565d94
+  data.tar.gz: 8f66dfdb31532125fd3593ddcfb7c3e76fd81df5
 SHA512:
-  metadata.gz: 9d55c689e8ffc0e3f7b533f54d3e622f77bd7f563182fc7b9dfc047a7a9b1554ed02711fbb8326f55fed76529dde2040d6f829bd4439a63773c9bb58ffb8c8a3
-  data.tar.gz: 60b1c8f83803656373a108a64159636292bc91c1840292e7c01ea0c74961533d076ceaa6576010ecdf9dc062bc60c6b112e9900b726db227a322aa52c41f40e0
+  metadata.gz: 6ac0a230d40ecab86a7896249eb875fa43a16705a0594c9b55acd9d21215bff572ce1abb18da0593455f1a3c749354453808b779bed3dbf14e171f8b26b7511c
+  data.tar.gz: 910cccfb441f515b20bcd1c21fc02a3f293b4445ed4526e2b8a2a921d97062df23156bc2726587269139a79edd687bd8d5b9fa79776bbc5910045f2205e58923

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oso-oso (0.2.5)
+    oso-oso (0.2.6)
       ffi (~> 1.0)
 
 GEM

data/Makefile

@@ -8,3 +8,6 @@ install: rust
 
 test: install
 	bundle exec rake spec
+
+repl:
+	bundle exec oso

data/bin/oso

@@ -0,0 +1,7 @@
+#!/usr/bin/env -S bundle exec ruby
+#-*-ruby-*-
+
+require 'bundler/setup'
+require 'oso'
+
+Oso.new.repl(load: true)

data/lib/oso/oso.rb

@@ -1,47 +1,21 @@
 # frozen_string_literal: true
 
+require_relative 'polar/polar'
+
 module Oso
   # Oso authorization API.
-  class Oso
+  class Oso < Polar::Polar
     def initialize
-      @polar = ::Oso::Polar.new
+      super
       register_class(Http, name: 'Http')
       register_class(PathMapper, name: 'PathMapper')
     end
 
-    def load_file(file)
-      polar.load_file(file)
-    end
-
-    def load_str(str)
-      polar.load_str(str)
-    end
-
-    def register_class(cls, name: nil) # rubocop:disable Naming/MethodParameterName
-      if block_given?
-        polar.register_class(cls, name: name, from_polar: Proc.new)
-      else
-        polar.register_class(cls, name: name)
-      end
-    end
-
     def allow(actor:, action:, resource:)
-      polar.query_pred('allow', args: [actor, action, resource]).next
+      query_predicate('allow', actor, action, resource).next
       true
     rescue StopIteration
       false
     end
-
-    def query_predicate(name, *args)
-      polar.query_pred(name, args: args)
-    end
-
-    def load_queued_files
-      polar.load_queued_files
-    end
-
-    private
-
-    attr_reader :polar
   end
 end

data/lib/oso/polar.rb

@@ -2,6 +2,7 @@
 
 require 'oso/polar/errors'
 require 'oso/polar/ffi'
+require 'oso/polar/host'
 require 'oso/polar/polar'
 require 'oso/polar/predicate'
 require 'oso/polar/query'

data/lib/oso/polar/errors.rb

@@ -40,6 +40,7 @@ module Oso
     class DuplicateInstanceRegistrationError < PolarRuntimeError; end
     class InvalidCallError < PolarRuntimeError; end
     class InvalidConstructorError < PolarRuntimeError; end
+    class InvalidQueryTypeError < PolarRuntimeError; end
     class InlineQueryFailedError < PolarRuntimeError; end
     class NullByteInPolarFileError < PolarRuntimeError; end
     class UnexpectedPolarTypeError < PolarRuntimeError; end

data/lib/oso/polar/ffi.rb

@@ -6,9 +6,11 @@ module Oso
   module Polar
     module FFI
       LIB = ::FFI::Platform::LIBPREFIX + 'polar.' + ::FFI::Platform::LIBSUFFIX
-      LIB_PATH = File.expand_path(File.join(__dir__, "../../../ext/oso-oso/lib/#{LIB}"))
-      # @TODO: Fall back to this if there's no release build libs. Easier for dev.
-      # LIB_PATH = File.expand_path(File.join(__dir__, "../../../../../target/debug/#{LIB}"))
+      RELEASE_PATH = File.expand_path(File.join(__dir__, "../../../ext/oso-oso/lib/#{LIB}"))
+      DEV_PATH = File.expand_path(File.join(__dir__, "../../../../../target/debug/#{LIB}"))
+      # If the lib exists in the ext/ dir, use it. Otherwise, fall back to
+      # checking the local Rust target dir.
+      LIB_PATH = File.file?(RELEASE_PATH) ? RELEASE_PATH : DEV_PATH
 
       # Wrapper classes defined upfront to fix Ruby loading issues. Actual
       # implementations live in the sibling `ffi/` directory and are `require`d

data/lib/oso/polar/ffi/polar.rb

@@ -15,7 +15,6 @@ module Oso
           attach_function :new_id, :polar_get_external_id, [FFI::Polar], :uint64
           attach_function :new_query_from_str, :polar_new_query, [FFI::Polar, :string], FFI::Query
           attach_function :new_query_from_term, :polar_new_query_from_term, [FFI::Polar, :string], FFI::Query
-          attach_function :new_query_from_repl, :polar_query_from_repl, [FFI::Polar], FFI::Query
           attach_function :register_constant, :polar_register_constant, [FFI::Polar, :string, :string], :int32
           attach_function :free, :polar_free, [FFI::Polar], :int32
         end
@@ -76,15 +75,6 @@ module Oso
           query
         end
 
-        # @return [FFI::Query]
-        # @raise [FFI::Error] if the FFI call returns an error.
-        def new_query_from_repl
-          query = Rust.new_query_from_repl(self)
-          raise FFI::Error.get if query.null?
-
-          query
-        end
-
         # @param name [String]
         # @param value [Hash<String, Object>]
         # @raise [FFI::Error] if the FFI call returns an error.

data/lib/oso/polar/host.rb

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+module Oso
+  module Polar
+    # Translate between Polar and the host language (Ruby).
+    class Host
+      protected
+      # @return [FFI::Polar]
+      attr_reader :ffi_polar
+      # @return [Hash<String, Class>]
+      attr_reader :classes
+      # @return [Hash<String, Object>]
+      attr_reader :constructors
+      # @return [Hash<Integer, Object>]
+      attr_reader :instances
+
+      public
+      def initialize(ffi_polar)
+        @ffi_polar = ffi_polar
+        @classes = {}
+        @constructors = {}
+        @instances = {}
+      end
+
+      def initialize_copy(other)
+        @ffi_polar = other.ffi_polar
+        @classes = other.classes.dup
+        @constructors = other.constructors.dup
+        @instances = other.instances.dup
+      end
+
+      # Fetch a Ruby class from the {#classes} cache.
+      #
+      # @param name [String]
+      # @return [Class]
+      # @raise [UnregisteredClassError] if the class has not been registered.
+      def get_class(name)
+        raise UnregisteredClassError, name unless classes.key? name
+
+        classes[name]
+      end
+
+      # Store a Ruby class in the {#classes} cache.
+      #
+      # @param cls [Class] the class to cache
+      # @param name [String] the name to cache the class as. Defaults to the name of the class.
+      # @return [String] the name the class is cached as.
+      # @raise [UnregisteredClassError] if the class has not been registered.
+      def cache_class(cls, name:, constructor:)
+        name = cls.name if name.nil?
+        raise DuplicateClassAliasError, name: name, old: get_class(name), new: cls if classes.key? name
+
+        classes[name] = cls
+        if constructor.nil?
+          constructors[name] = :new
+        elsif constructor.respond_to? :call
+          constructors[name] = constructor
+        else
+          raise InvalidConstructorError
+        end
+        name
+      end
+
+      # Fetch a constructor from the {#constructors} cache.
+      #
+      # @param name [String]
+      # @return [Symbol] if constructor is the default of `:new`.
+      # @return [Proc] if a custom constructor was registered.
+      # @raise [UnregisteredConstructorError] if the constructor has not been registered.
+      def get_constructor(name)
+        raise MissingConstructorError, name unless constructors.key? name
+
+        constructors[name]
+      end
+
+      # Check if an instance has been cached.
+      #
+      # @param id [Integer]
+      # @return [Boolean]
+      def instance?(id)
+        case id
+        when Integer
+          instances.key? id
+        else
+          instances.value? id
+        end
+      end
+
+      # Fetch a Ruby instance from the {#instances} cache.
+      #
+      # @param id [Integer]
+      # @return [Object]
+      # @raise [UnregisteredInstanceError] if the ID has not been registered.
+      def get_instance(id)
+        raise UnregisteredInstanceError, id unless instance? id
+
+        instances[id]
+      end
+
+      # Cache a Ruby instance, fetching a {#new_id} if one isn't provided.
+      #
+      # @param instance [Object]
+      # @param id [Integer]
+      # @return [Integer]
+      def cache_instance(instance, id: nil)
+        id = ffi_polar.new_id if id.nil?
+        instances[id] = instance
+        id
+      end
+
+      # Construct and cache a Ruby instance.
+      #
+      # @param cls_name [String]
+      # @param fields [Hash<String, Hash>]
+      # @param id [Integer]
+      # @raise [PolarRuntimeError] if instance construction fails.
+      def make_instance(cls_name, fields:, id:) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        constructor = get_constructor(cls_name)
+        fields = Hash[fields.map { |k, v| [k.to_sym, to_ruby(v)] }]
+        instance = if constructor == :new
+                     if fields.empty?
+                       get_class(cls_name).__send__(:new)
+                     else
+                       get_class(cls_name).__send__(:new, **fields)
+                     end
+                   elsif fields.empty?
+                     constructor.call
+                   else
+                     constructor.call(**fields)
+                   end
+        cache_instance(instance, id: id)
+      rescue StandardError => e
+        raise PolarRuntimeError, "Error constructing instance of #{cls_name}: #{e}"
+      end
+
+      # Check if the left class is more specific than the right class
+      # with respect to the given instance.
+      #
+      # @param instance_id [Integer]
+      # @param left_tag [String]
+      # @param right_tag [String]
+      # @return [Boolean]
+      def subspecializer?(instance_id, left_tag:, right_tag:)
+        mro = get_instance(instance_id).class.ancestors
+        mro.index(get_class(left_tag)) < mro.index(get_class(right_tag))
+      rescue StandardError
+        false
+      end
+
+      # Check if instance is an instance of class.
+      #
+      # @param instance_id [Integer]
+      # @param class_tag [String]
+      # @return [Boolean]
+      def isa?(instance_id, class_tag:)
+        instance = get_instance(instance_id)
+        cls = get_class(class_tag)
+        instance.is_a? cls
+      rescue PolarRuntimeError
+        false
+      end
+
+      # Check if two instances unify
+      #
+      # @param left_instance_id [Integer]
+      # @param right_instance_id [Integer]
+      # @return [Boolean]
+      def unify?(left_instance_id, right_instance_id)
+        left_instance = get_instance(left_instance_id)
+        right_instance = get_instance(right_instance_id)
+        left_instance == right_instance
+      rescue PolarRuntimeError
+        false
+      end
+
+      # Turn a Ruby value into a Polar term that's ready to be sent across the
+      # FFI boundary.
+      #
+      # @param value [Object]
+      # @return [Hash<String, Object>]
+      def to_polar_term(value) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+        value = case true # rubocop:disable Lint/LiteralAsCondition
+                when value.instance_of?(TrueClass) || value.instance_of?(FalseClass)
+                  { 'Boolean' => value }
+                when value.instance_of?(Integer)
+                  { 'Number' => { 'Integer' => value } }
+                when value.instance_of?(Float)
+                  { 'Number' => { 'Float' => value } }
+                when value.instance_of?(String)
+                  { 'String' => value }
+                when value.instance_of?(Array)
+                  { 'List' => value.map { |el| to_polar_term(el) } }
+                when value.instance_of?(Hash)
+                  { 'Dictionary' => { 'fields' => value.transform_values { |v| to_polar_term(v) } } }
+                when value.instance_of?(Predicate)
+                  { 'Call' => { 'name' => value.name, 'args' => value.args.map { |el| to_polar_term(el) } } }
+                when value.instance_of?(Variable)
+                  # This is supported so that we can query for unbound variables
+                  { 'Variable' => value }
+                else
+                  { 'ExternalInstance' => { 'instance_id' => cache_instance(value) } }
+                end
+        { 'value' => value }
+      end
+
+      # Turn a Polar term passed across the FFI boundary into a Ruby value.
+      #
+      # @param data [Hash<String, Object>]
+      # @option data [Integer] :id
+      # @option data [Integer] :offset Character offset of the term in its source string.
+      # @option data [Hash<String, Object>] :value
+      # @return [Object]
+      # @raise [UnexpectedPolarTypeError] if type cannot be converted to Ruby.
+      def to_ruby(data) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+        tag, value = data['value'].first
+        case tag
+        when 'String', 'Boolean'
+          value
+        when 'Number'
+          value.values.first
+        when 'List'
+          value.map { |el| to_ruby(el) }
+        when 'Dictionary'
+          value['fields'].transform_values { |v| to_ruby(v) }
+        when 'ExternalInstance'
+          get_instance(value['instance_id'])
+        when 'Call'
+          Predicate.new(value['name'], args: value['args'].map { |a| to_ruby(a) })
+        else
+          raise UnexpectedPolarTypeError, tag
+        end
+      end
+    end
+  end
+end

data/lib/oso/polar/polar.rb

@@ -1,21 +1,28 @@
 # frozen_string_literal: true
 
 require 'json'
+require 'pp'
 require 'set'
 
 module Oso
   module Polar
     # Create and manage an instance of the Polar runtime.
-    class Polar # rubocop:disable Metrics/ClassLength
+    class Polar
+      # @return [Host]
+      attr_reader :host
+
       def initialize
-        @ffi_instance = FFI::Polar.create
-        @calls = {}
-        @classes = {}
-        @constructors = {}
-        @instances = {}
+        @ffi_polar = FFI::Polar.create
+        @host = Host.new(ffi_polar)
         @load_queue = Set.new
       end
 
+      # Replace the current Polar instance but retain all registered classes and constructors.
+      def clear
+        load_queue.clear
+        @ffi_polar = FFI::Polar.create
+      end
+
       # Enqueue a Polar policy file for loading into the KB.
       #
       # @param name [String]
@@ -38,23 +45,32 @@ module Oso
       def load_str(str, filename: nil) # rubocop:disable Metrics/MethodLength
         raise NullByteInPolarFileError if str.chomp("\0").include?("\0")
 
-        ffi_instance.load_str(str, filename: filename)
+        ffi_polar.load_str(str, filename: filename)
         loop do
-          next_query = ffi_instance.next_inline_query
+          next_query = ffi_polar.next_inline_query
           break if next_query.nil?
 
           begin
-            Query.new(next_query, polar: self).results.next
+            Query.new(next_query, host: host).results.next
           rescue StopIteration
             raise InlineQueryFailedError
           end
         end
       end
 
-      # Replace the current Polar instance but retain all registered classes and
-      # constructors.
-      def clear
-        @ffi_instance = FFI::Polar.create
+      # Query for a predicate, parsing it if necessary.
+      def query(query)
+        load_queued_files
+        new_host = host.dup
+        case query
+        when String
+          ffi_query = ffi_polar.new_query_from_str(query)
+        when Predicate
+          ffi_query = ffi_polar.new_query_from_term(new_host.to_polar_term(query))
+        else
+          raise InvalidQueryTypeError
+        end
+        Query.new(ffi_query, host: new_host).results
       end
 
       # Query for a predicate.
@@ -62,245 +78,69 @@ module Oso
       # @param name [String]
       # @param args [Array<Object>]
       # @raise [Error] if the FFI call raises one.
-      def query_pred(name, args:)
-        clear_query_state
-        load_queued_files
-        pred = Predicate.new(name, args: args)
-        query_ffi_instance = ffi_instance.new_query_from_term(to_polar_term(pred))
-        Query.new(query_ffi_instance, polar: self).results
+      def query_predicate(name, *args)
+        query(Predicate.new(name, args: args))
       end
 
       # Start a REPL session.
       #
       # @raise [Error] if the FFI call raises one.
-      def repl # rubocop:disable Metrics/MethodLength
-        clear_query_state
+      def repl(load: false) # rubocop:disable Metrics/MethodLength
+        ARGV.map { |f| load_file(f) } if load
         load_queued_files
+
         loop do
-          query = Query.new(ffi_instance.new_query_from_repl, polar: self)
-          results = query.results.to_a
+          print('> ')
+          begin
+            query = STDIN.readline.chomp.chomp(';')
+          rescue EOFError
+            return
+          end
+
+          begin
+            ffi_query = ffi_polar.new_query_from_str(query)
+          rescue ParseError => e
+            puts("Parse error: " + e.to_s)
+            next
+          end
+
+          begin
+            results = Query.new(ffi_query, host: host).results.to_a
+          rescue PolarRuntimeError => e
+            puts(e.to_s)
+            next
+          end
+
           if results.empty?
-            puts 'False'
+            pp false
           else
             results.each do |result|
-              puts result
+              if result.empty?
+                pp true
+              else
+                pp result
+              end
             end
           end
         end
       end
 
-      # Get a unique ID from Polar.
-      #
-      # @return [Integer]
-      # @raise [Error] if the FFI call raises one.
-      def new_id
-        ffi_instance.new_id
-      end
-
       # Register a Ruby class with Polar.
       #
       # @param cls [Class]
       # @param name [String]
       # @param from_polar [Proc]
       # @raise [InvalidConstructorError] if provided an invalid 'from_polar' constructor.
-      def register_class(cls, name: nil, from_polar: nil) # rubocop:disable Naming/MethodParameterName
-        # TODO(gj): should this take 3 args: cls (Class), constructor_cls
-        # (Option<Class>) that defaults to cls, and constructor_method
-        # (Option<Symbol>) that defaults to :new?
-        name = cls.name if name.nil?
-        raise DuplicateClassAliasError, name: name, old: get_class(name), new: cls if classes.key? name
-
-        classes[name] = cls
-        if from_polar.nil?
-          constructors[name] = :new
-        elsif from_polar.respond_to? :call
-          constructors[name] = from_polar
-        else
-          raise InvalidConstructorError
+      def register_class(cls, name: nil, from_polar: nil)
+        if block_given?
+          from_polar = Proc.new
         end
-
+        name = host.cache_class(cls, name: name, constructor: from_polar)
         register_constant(name, value: cls)
       end
 
       def register_constant(name, value:)
-        ffi_instance.register_constant(name, value: to_polar_term(value))
-      end
-
-      # Register a Ruby method call, wrapping the call result in a generator if
-      # it isn't already one.
-      #
-      # @param method [#to_sym]
-      # @param call_id [Integer]
-      # @param instance [Hash]
-      # @param args [Array<Hash>]
-      # @raise [InvalidCallError] if the method doesn't exist on the instance or
-      #   the args passed to the method are invalid.
-      def register_call(method, call_id:, instance:, args:)
-        return if calls.key?(call_id)
-
-        args = args.map { |a| to_ruby(a) }
-        if instance["value"].has_key? "ExternalInstance"
-          instance_id = instance["value"]["ExternalInstance"]["instance_id"]
-          instance = get_instance(instance_id)
-        else
-          instance = to_ruby(instance)
-        end
-        result = instance.__send__(method, *args)
-        result = [result].to_enum unless result.is_a? Enumerator # Call must be a generator.
-        calls[call_id] = result.lazy
-      rescue ArgumentError, NoMethodError
-        raise InvalidCallError
-      end
-
-      # Retrieve the next result from a registered call and pass it to {#to_polar_term}.
-      #
-      # @param id [Integer]
-      # @return [Hash]
-      # @raise [StopIteration] if the call has been exhausted.
-      def next_call_result(id)
-        to_polar_term(calls[id].next)
-      end
-
-      # Construct and cache a Ruby instance.
-      #
-      # @param cls_name [String]
-      # @param fields [Hash<String, Hash>]
-      # @param id [Integer]
-      # @raise [PolarRuntimeError] if instance construction fails.
-      def make_instance(cls_name, fields:, id:) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-        constructor = get_constructor(cls_name)
-        fields = Hash[fields.map { |k, v| [k.to_sym, to_ruby(v)] }]
-        instance = if constructor == :new
-                     if fields.empty?
-                       get_class(cls_name).__send__(:new)
-                     else
-                       get_class(cls_name).__send__(:new, **fields)
-                     end
-                   elsif fields.empty?
-                     constructor.call
-                   else
-                     constructor.call(**fields)
-                   end
-        cache_instance(instance, id: id)
-      rescue StandardError => e
-        raise PolarRuntimeError, "Error constructing instance of #{cls_name}: #{e}"
-      end
-
-      # Check if an instance has been cached.
-      #
-      # @param id [Integer]
-      # @return [Boolean]
-      def instance?(id)
-        instances.key? id
-      end
-
-      # Fetch a Ruby instance from the {#instances} cache.
-      #
-      # @param id [Integer]
-      # @return [Object]
-      # @raise [UnregisteredInstanceError] if the ID has not been registered.
-      def get_instance(id)
-        raise UnregisteredInstanceError, id unless instance? id
-
-        instances[id]
-      end
-
-      # Check if the left class is more specific than the right class for the
-      # given instance.
-      #
-      # @param instance_id [Integer]
-      # @param left_tag [String]
-      # @param right_tag [String]
-      # @return [Boolean]
-      def subspecializer?(instance_id, left_tag:, right_tag:)
-        mro = get_instance(instance_id).class.ancestors
-        mro.index(get_class(left_tag)) < mro.index(get_class(right_tag))
-      rescue StandardError
-        false
-      end
-
-      # Check if instance is an instance of class.
-      #
-      # @param instance_id [Integer]
-      # @param class_tag [String]
-      # @return [Boolean]
-      def isa?(instance_id, class_tag:)
-        instance = get_instance(instance_id)
-        cls = get_class(class_tag)
-        instance.is_a? cls
-      rescue PolarRuntimeError
-        false
-      end
-
-      # Check if two instances unify
-      #
-      # @param left_instance_id [Integer]
-      # @param right_instance_id [Integer]
-      # @return [Boolean]
-      def unify?(left_instance_id, right_instance_id)
-        left_instance = get_instance(left_instance_id)
-        right_instance = get_instance(right_instance_id)
-        left_instance == right_instance
-      rescue PolarRuntimeError
-        false
-      end
-
-      # Turn a Ruby value into a Polar term that's ready to be sent across the
-      # FFI boundary.
-      #
-      # @param value [Object]
-      # @return [Hash<String, Object>]
-      def to_polar_term(value) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
-        value = case true # rubocop:disable Lint/LiteralAsCondition
-                when value.instance_of?(TrueClass) || value.instance_of?(FalseClass)
-                  { 'Boolean' => value }
-                when value.instance_of?(Integer)
-                  { 'Number' => { 'Integer' => value } }
-                when value.instance_of?(Float)
-                  { 'Number' => { 'Float' => value } }
-                when value.instance_of?(String)
-                  { 'String' => value }
-                when value.instance_of?(Array)
-                  { 'List' => value.map { |el| to_polar_term(el) } }
-                when value.instance_of?(Hash)
-                  { 'Dictionary' => { 'fields' => value.transform_values { |v| to_polar_term(v) } } }
-                when value.instance_of?(Predicate)
-                  { 'Call' => { 'name' => value.name, 'args' => value.args.map { |el| to_polar_term(el) } } }
-                when value.instance_of?(Variable)
-                  # This is supported so that we can query for unbound variables
-                  { 'Variable' => value }
-                else
-                  { 'ExternalInstance' => { 'instance_id' => cache_instance(value) } }
-                end
-        { 'value' => value }
-      end
-
-      # Turn a Polar term passed across the FFI boundary into a Ruby value.
-      #
-      # @param data [Hash<String, Object>]
-      # @option data [Integer] :id
-      # @option data [Integer] :offset Character offset of the term in its source string.
-      # @option data [Hash<String, Object>] :value
-      # @return [Object]
-      # @raise [UnexpectedPolarTypeError] if type cannot be converted to Ruby.
-      def to_ruby(data) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
-        tag, value = data['value'].first
-        case tag
-        when 'String', 'Boolean'
-          value
-        when 'Number'
-          value.values.first
-        when 'List'
-          value.map { |el| to_ruby(el) }
-        when 'Dictionary'
-          value['fields'].transform_values { |v| to_ruby(v) }
-        when 'ExternalInstance'
-          get_instance(value['instance_id'])
-        when 'Call'
-          Predicate.new(value['name'], args: value['args'].map { |a| to_ruby(a) })
-        else
-          raise UnexpectedPolarTypeError, tag
-        end
+        ffi_polar.register_constant(name, value: host.to_polar_term(value))
       end
 
       # Load all queued files, flushing the {#load_queue}.
@@ -313,69 +153,10 @@ module Oso
 
       private
 
-      # @return [Hash<Integer, Enumerator>]
-      attr_reader :calls
-      # @return [Hash<String, Class>]
-      attr_reader :classes
-      # @return [Hash<String, Object>]
-      attr_reader :constructors
       # @return [FFI::Polar]
-      attr_reader :ffi_instance
-      # @return [Hash<Integer, Object>]
-      attr_reader :instances
+      attr_reader :ffi_polar
       # @return [Array<String>]
       attr_reader :load_queue
-
-      # Clear the instance and call caches.
-      def clear_query_state
-        calls.clear
-        instances.clear
-      end
-
-      # Query for a Polar string.
-      #
-      # @param str [String]
-      # @return [Enumerator]
-      def query_str(str)
-        clear_query_state
-        load_queued_files
-        query_ffi_instance = ffi_instance.new_query_from_str(str)
-        Query.new(query_ffi_instance, polar: self).results
-      end
-
-      # Cache a Ruby instance, fetching a {#new_id} if one isn't provided.
-      #
-      # @param instance [Object]
-      # @param id [Integer]
-      # @return [Integer]
-      def cache_instance(instance, id: nil)
-        id = new_id if id.nil?
-        instances[id] = instance
-        id
-      end
-
-      # Fetch a Ruby class from the {#classes} cache.
-      #
-      # @param name [String]
-      # @return [Class]
-      # @raise [UnregisteredClassError] if the class has not been registered.
-      def get_class(name)
-        raise UnregisteredClassError, name unless classes.key? name
-
-        classes[name]
-      end
-
-      # Fetch a constructor from the {#constructors} cache.
-      #
-      # @param name [String]
-      # @return [Symbol] if constructor is the default of `:new`.
-      # @return [Proc] if a custom constructor was registered.
-      # @raise [UnregisteredConstructorError] if the constructor has not been registered.
-      def get_constructor(name)
-        raise MissingConstructorError, name unless constructors.key? name
-
-        constructors[name]
-      end
     end
   end
 end

data/lib/oso/polar/query.rb

@@ -6,20 +6,58 @@ module Oso
     class Query
       attr_reader :results
 
-      # @param ffi_instance [FFI::Query]
-      # @param polar [Polar]
-      def initialize(ffi_instance, polar:)
-        @ffi_instance = ffi_instance
-        @polar = polar
+      # @param ffi_query [FFI::Query]
+      # @param ffi_polar [FFI::Polar]
+      def initialize(ffi_query, host:)
+        @calls = {}
+        @ffi_query = ffi_query
+        @host = host
         @results = start
       end
 
       private
 
+      # @return [Hash<Integer, Enumerator>]
+      attr_reader :calls
       # @return [FFI::Query]
-      attr_reader :ffi_instance
-      # @return [Polar]
-      attr_reader :polar
+      attr_reader :ffi_query
+      # @return [Host]
+      attr_reader :host
+
+      # Send result of predicate check across FFI boundary.
+      #
+      # @param result [Boolean]
+      # @param call_id [Integer]
+      # @raise [Error] if the FFI call raises one.
+      def question_result(result, call_id:)
+        ffi_query.question_result(result, call_id: call_id)
+      end
+
+      # Register a Ruby method call, wrapping the call result in a generator if
+      # it isn't already one.
+      #
+      # @param method [#to_sym]
+      # @param call_id [Integer]
+      # @param instance [Hash]
+      # @param args [Array<Hash>]
+      # @raise [InvalidCallError] if the method doesn't exist on the instance or
+      #   the args passed to the method are invalid.
+      def register_call(method, call_id:, instance:, args:)
+        return if calls.key?(call_id)
+
+        args = args.map { |a| host.to_ruby(a) }
+        if instance['value'].key? 'ExternalInstance'
+          instance_id = instance['value']['ExternalInstance']['instance_id']
+          instance = host.get_instance(instance_id)
+        else
+          instance = host.to_ruby(instance)
+        end
+        result = instance.__send__(method, *args)
+        result = [result].to_enum unless result.is_a? Enumerator # Call must be a generator.
+        calls[call_id] = result.lazy
+      rescue ArgumentError, NoMethodError
+        raise InvalidCallError
+      end
 
       # Send next result of Ruby method call across FFI boundary.
       #
@@ -27,16 +65,16 @@ module Oso
       # @param call_id [Integer]
       # @raise [Error] if the FFI call raises one.
       def call_result(result, call_id:)
-        ffi_instance.call_result(result, call_id: call_id)
+        ffi_query.call_result(result, call_id: call_id)
       end
 
-      # Send result of predicate check across FFI boundary.
+      # Retrieve the next result from a registered call and pass it to {#to_polar_term}.
       #
-      # @param result [Boolean]
-      # @param call_id [Integer]
-      # @raise [Error] if the FFI call raises one.
-      def question_result(result, call_id:)
-        ffi_instance.question_result(result, call_id: call_id)
+      # @param id [Integer]
+      # @return [Hash]
+      # @raise [StopIteration] if the call has been exhausted.
+      def next_call_result(id)
+        host.to_polar_term(calls[id].next)
       end
 
       # Fetch the next result from calling a Ruby method and prepare it for
@@ -48,8 +86,8 @@ module Oso
       # @param instance_id [Integer]
       # @raise [Error] if the FFI call raises one.
       def handle_call(method, call_id:, instance:, args:)
-        polar.register_call(method, call_id: call_id, instance: instance, args: args)
-        result = JSON.dump(polar.next_call_result(call_id))
+        register_call(method, call_id: call_id, instance: instance, args: args)
+        result = JSON.dump(next_call_result(call_id))
         call_result(result, call_id: call_id)
       rescue InvalidCallError, StopIteration
         call_result(nil, call_id: call_id)
@@ -65,19 +103,19 @@ module Oso
       def start # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
         Enumerator.new do |yielder| # rubocop:disable Metrics/BlockLength
           loop do # rubocop:disable Metrics/BlockLength
-            event = ffi_instance.next_event
+            event = ffi_query.next_event
             case event.kind
             when 'Done'
               break
             when 'Result'
-              yielder << event.data['bindings'].transform_values { |v| polar.to_ruby(v) }
+              yielder << event.data['bindings'].transform_values { |v| host.to_ruby(v) }
             when 'MakeExternal'
               id = event.data['instance_id']
-              raise DuplicateInstanceRegistrationError, id if polar.instance? id
+              raise DuplicateInstanceRegistrationError, id if host.instance? id
 
               cls_name = event.data['instance']['tag']
               fields = event.data['instance']['fields']['fields']
-              polar.make_instance(cls_name, fields: fields, id: id)
+              host.make_instance(cls_name, fields: fields, id: id)
             when 'ExternalCall'
               call_id = event.data['call_id']
               instance = event.data['instance']
@@ -88,24 +126,24 @@ module Oso
               instance_id = event.data['instance_id']
               left_tag = event.data['left_class_tag']
               right_tag = event.data['right_class_tag']
-              answer = polar.subspecializer?(instance_id, left_tag: left_tag, right_tag: right_tag)
+              answer = host.subspecializer?(instance_id, left_tag: left_tag, right_tag: right_tag)
               question_result(answer, call_id: event.data['call_id'])
             when 'ExternalIsa'
               instance_id = event.data['instance_id']
               class_tag = event.data['class_tag']
-              answer = polar.isa?(instance_id, class_tag: class_tag)
+              answer = host.isa?(instance_id, class_tag: class_tag)
               question_result(answer, call_id: event.data['call_id'])
             when 'ExternalUnify'
               left_instance_id = event.data['left_instance_id']
               right_instance_id = event.data['right_instance_id']
-              answer = polar.unify?(left_instance_id, right_instance_id)
+              answer = host.unify?(left_instance_id, right_instance_id)
               question_result(answer, call_id: event.data['call_id'])
             when 'Debug'
               puts event.data['message'] if event.data['message']
               print '> '
               input = $stdin.gets.chomp!
-              command = JSON.dump(polar.to_polar_term(input))
-              ffi_instance.debug_command(command)
+              command = JSON.dump(host.to_polar_term(input))
+              ffi_query.debug_command(command)
             else
               raise "Unhandled event: #{JSON.dump(event.inspect)}"
             end

data/lib/oso/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Oso
-  VERSION = '0.2.5'
+  VERSION = '0.2.6'
 end

data/oso-oso.gemspec

@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-    files += Dir['ext/oso-oso/lib/*']
+    files + Dir['ext/oso-oso/lib/*']
   end
 
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   # Runtime dependencies

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oso-oso
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Oso Security
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -97,7 +97,8 @@ dependencies:
 description: 
 email:
 - support@osohq.com
-executables: []
+executables:
+- oso
 extensions: []
 extra_rdoc_files: []
 files:
@@ -109,8 +110,7 @@ files:
 - Makefile
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- bin/oso
 - ext/oso-oso/lib/libpolar.dylib
 - ext/oso-oso/lib/libpolar.so
 - ext/oso-oso/lib/polar.dll
@@ -125,6 +125,7 @@ files:
 - lib/oso/polar/ffi/polar.rb
 - lib/oso/polar/ffi/query.rb
 - lib/oso/polar/ffi/query_event.rb
+- lib/oso/polar/host.rb
 - lib/oso/polar/polar.rb
 - lib/oso/polar/predicate.rb
 - lib/oso/polar/query.rb

data/bin/console

@@ -1,33 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'oso'
-
-polar = Oso::Polar.new.tap do |p| # rubocop:disable Lint/UselessAssignment
-  p.load_str('f(1); f(2); g(1); g(2); h(2); k(x) := f(x), h(x), g(x);')
-  puts 'f(x)', p.send(:query_str, 'f(x)').to_a
-  puts 'k(x)', p.send(:query_str, 'k(x)').to_a
-
-  p.load_str('foo(1, 2); foo(3, 4); foo(5, 6);')
-  expected = [{ 'x' => 1, 'y' => 2 }, { 'x' => 3, 'y' => 4 }, { 'x' => 5, 'y' => 6 }]
-  raise 'AssertionError' if p.send(:query_str, 'foo(x, y)').to_a != expected
-
-  class TestClass # rubocop:disable Style/Documentation
-    def my_method
-      1
-    end
-  end
-
-  p.register_class(TestClass)
-
-  p.load_str('external(x, 3) := x = new TestClass{}.my_method;')
-  results = p.send(:query_str, 'external(1, x)')
-  p results.next
-
-  # p.load_str('testDebug() := debug(), foo(x, y), k(y);')
-  # p.send(:query_str, 'testDebug()').next
-end
-
-require 'pry'
-Pry.start

data/bin/setup

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install