oso-oso 0.2.6 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c00a51f40789d269beb2d63e29ad12b76565d94
-  data.tar.gz: 8f66dfdb31532125fd3593ddcfb7c3e76fd81df5
+  metadata.gz: cf2c949f57a56b4849f24ed9593c78da58baa5a0
+  data.tar.gz: 31ac99dcfa3bba1bbbee68474a3fe3702fb7484d
 SHA512:
-  metadata.gz: 6ac0a230d40ecab86a7896249eb875fa43a16705a0594c9b55acd9d21215bff572ce1abb18da0593455f1a3c749354453808b779bed3dbf14e171f8b26b7511c
-  data.tar.gz: 910cccfb441f515b20bcd1c21fc02a3f293b4445ed4526e2b8a2a921d97062df23156bc2726587269139a79edd687bd8d5b9fa79776bbc5910045f2205e58923
+  metadata.gz: f1708d82f2531d50456ddcadb967bd024414700808e81b440836eb344f542cfda46af651382a6445a098dce9cf1e1c63c6802df73e3f97713a819d0b07ef5aae
+  data.tar.gz: d96b91d530555ed98d040c2d3c8e8e0adbdffa352cef6bd49c22e6f225c16bfa9f4c488d37468201e16e0950791581621737b94f1b9d5ffc8b8c4dffeaa4e656

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - '**/*~'
+    - 'bin/oso'
+    - 'vendor/**/*'
+  NewCops: enable

data/Gemfile

@@ -3,4 +3,3 @@
 source 'https://rubygems.org'
 
 gemspec
-

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oso-oso (0.2.6)
+    oso-oso (0.5.1)
       ffi (~> 1.0)
 
 GEM
@@ -12,18 +12,18 @@ GEM
     benchmark (0.1.0)
     byebug (11.1.3)
     coderay (1.1.3)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     e2mmap (0.1.0)
     ffi (1.13.1)
     jaro_winkler (1.5.4)
     maruku (0.7.3)
     method_source (1.0.0)
     mini_portile2 (2.4.0)
-    nokogiri (1.10.9)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -49,19 +49,19 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.85.1)
+    rubocop (0.89.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.0.3)
+      rubocop-ast (>= 0.3.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
     ruby-progressbar (1.10.1)
-    solargraph (0.39.8)
+    solargraph (0.39.14)
       backport (~> 1.1)
       benchmark
       bundler (>= 1.17.2)
@@ -88,7 +88,8 @@ DEPENDENCIES
   pry-byebug (~> 3.9.0)
   rake (~> 12.0)
   rspec (~> 3.0)
-  solargraph (~> 0.39.8)
+  rubocop (~> 0.89.1)
+  solargraph (~> 0.39.14)
   yard (~> 0.9.25)
 
 BUNDLED WITH

data/Makefile

@@ -1,13 +1,19 @@
-.PHONY: install rust test
+.PHONY: rust install test lint typecheck repl
 
 rust:
 	$(MAKE) -C ../.. rust-build
 
-install: rust
+install:
 	bundle install
 
-test: install
+test: install rust
 	bundle exec rake spec
 
-repl:
+lint: install
+	bundle exec rubocop
+
+typecheck: install
+	bundle exec solargraph typecheck
+
+repl: install rust
 	bundle exec oso

data/README.md

@@ -1,4 +1,4 @@
-# Oso::Oso
+# oso-oso
 
 ## Installation
 
@@ -18,13 +18,10 @@ Or install it yourself as:
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run
-`rake spec` to run the tests. You can also run `bin/console` for an interactive
-prompt that will allow you to experiment.
+After checking out the repo, run `bundle install` to install dependencies.
+Then, run `bundle exec rake spec` to run the tests. You can also run `bundle
+exec oso` for an interactive REPL that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
+New releases are minted and pushed to RubyGems via GitHub Actions workflows.

data/Rakefile

@@ -6,4 +6,3 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
-

data/bin/oso

@@ -4,4 +4,4 @@
 require 'bundler/setup'
 require 'oso'
 
-Oso.new.repl(load: true)
+Oso.new.repl(ARGV)

data/lib/oso/http.rb

@@ -3,7 +3,7 @@
 module Oso
   # An HTTP resource.
   class Http
-    def initialize(hostname: nil, path: nil, query: nil)
+    def initialize(hostname, path, query)
       @hostname = hostname
       @path = path
       @query = query

data/lib/oso/oso.rb

@@ -3,7 +3,7 @@
 require_relative 'polar/polar'
 
 module Oso
-  # Oso authorization API.
+  # oso authorization API.
   class Oso < Polar::Polar
     def initialize
       super
@@ -11,8 +11,15 @@ module Oso
       register_class(PathMapper, name: 'PathMapper')
     end
 
-    def allow(actor:, action:, resource:)
-      query_predicate('allow', actor, action, resource).next
+    # Query the knowledge base to determine whether an actor is allowed to
+    # perform an action upon a resource.
+    #
+    # @param actor [Object] Subject.
+    # @param action [Object] Verb.
+    # @param resource [Object] Object.
+    # @return [Boolean] An access control decision.
+    def allowed?(actor:, action:, resource:)
+      query_rule('allow', actor, action, resource).next
       true
     rescue StopIteration
       false

data/lib/oso/path_mapper.rb

@@ -4,7 +4,7 @@ module Oso
   # Map from a template string with capture groups of the form
   # `{name}` to a dictionary of the form `{name: captured_value}`
   class PathMapper
-    def initialize(template:)
+    def initialize(template)
       capture_group = /({([^}]+)})/
 
       template = template.dup

data/lib/oso/polar/errors.rb

@@ -5,16 +5,12 @@ module Oso
     # Base error type for Oso::Polar.
     class Error < ::RuntimeError
       attr_reader :stack_trace
-      
+
       # @param message [String]
       # @param details [Hash]
       def initialize(message = nil, details: nil)
         @details = details
-        if details and details.key?("stack_trace")
-          @stack_trace = details['stack_trace']
-        else
-          @stack_trace = nil
-        end
+        @stack_trace = details&.fetch('stack_trace', nil)
         super(message)
       end
     end
@@ -31,6 +27,7 @@ module Oso
     class UnsupportedError < PolarRuntimeError; end
     class PolarTypeError < PolarRuntimeError; end
     class StackOverflowError < PolarRuntimeError; end
+    class FileLoadingError < PolarRuntimeError; end
 
     # Errors originating from this side of the FFI boundary.
 
@@ -41,12 +38,17 @@ module Oso
     class InvalidCallError < PolarRuntimeError; end
     class InvalidConstructorError < PolarRuntimeError; end
     class InvalidQueryTypeError < PolarRuntimeError; end
-    class InlineQueryFailedError < PolarRuntimeError; end
     class NullByteInPolarFileError < PolarRuntimeError; end
     class UnexpectedPolarTypeError < PolarRuntimeError; end
+    class InlineQueryFailedError < PolarRuntimeError; # rubocop:disable Style/Documentation
+      # @param source [String]
+      def initialize(source)
+        super("Inline query failed: #{source}")
+      end
+    end
     class PolarFileExtensionError < PolarRuntimeError # rubocop:disable Style/Documentation
-      def initialize
-        super('Polar files must have .pol or .polar extension.')
+      def initialize(file)
+        super("Polar files must have .polar extension. Offending file: #{file}")
       end
     end
     class PolarFileNotFoundError < PolarRuntimeError # rubocop:disable Style/Documentation
@@ -59,7 +61,7 @@ module Oso
       # @param as [String]
       # @param old [Class]
       # @param new [Class]
-      def initialize(name:, old:, new:) # rubocop:disable Naming/MethodParameterName
+      def initialize(name:, old:, new:)
         super("Attempted to alias #{new} as '#{name}', but #{old} already has that alias.")
       end
     end

data/lib/oso/polar/ffi.rb

@@ -5,7 +5,7 @@ require 'ffi'
 module Oso
   module Polar
     module FFI
-      LIB = ::FFI::Platform::LIBPREFIX + 'polar.' + ::FFI::Platform::LIBSUFFIX
+      LIB = "#{::FFI::Platform::LIBPREFIX}polar.#{::FFI::Platform::LIBSUFFIX}"
       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
@@ -37,7 +37,20 @@ module Oso
       # Wrapper class for Error FFI pointer + operations.
       class Error < ::FFI::AutoPointer
         def self.release(ptr)
-          Rust.free(ptr)
+          Rust.free(ptr) unless ptr.null?
+        end
+      end
+      # Wrapper class for Message FFI pointer + operations.
+      class Message < ::FFI::AutoPointer
+        def self.release(ptr)
+          Rust.free(ptr) unless ptr.null?
+        end
+      end
+
+      # Wrapper class for Source FFI pointer.
+      class Source < ::FFI::AutoPointer
+        def self.release(ptr)
+          Rust.free(ptr) unless ptr.null?
         end
       end
     end
@@ -49,3 +62,5 @@ require 'oso/polar/ffi/polar'
 require 'oso/polar/ffi/query'
 require 'oso/polar/ffi/query_event'
 require 'oso/polar/ffi/error'
+require 'oso/polar/ffi/message'
+require 'oso/polar/ffi/source'

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

@@ -22,7 +22,7 @@ module Oso
         #
         # @return [::Oso::Polar::Error] if there's an FFI error.
         # @return [::Oso::Polar::FFIErrorNotFound] if there isn't one.
-        def self.get # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        def self.get # rubocop:disable Metrics/MethodLength
           error = Rust.get
           return ::Oso::Polar::FFIErrorNotFound if error.null?
 
@@ -48,7 +48,7 @@ module Oso
         # @param msg [String]
         # @param details [Hash<String, Object>]
         # @return [::Oso::Polar::ParseError] the object converted into the expected format.
-        private_class_method def self.parse_error(kind, msg:, details:) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+        private_class_method def self.parse_error(kind, msg:, details:) # rubocop:disable Metrics/MethodLength
           case kind
           when 'ExtraToken'
             ::Oso::Polar::ParseError::ExtraToken.new(msg, details: details)
@@ -83,6 +83,8 @@ module Oso
             ::Oso::Polar::PolarTypeError.new(msg, details: details)
           when 'StackOverflow'
             ::Oso::Polar::StackOverflowError.new(msg, details: details)
+          when 'FileLoading'
+            ::Oso::Polar::FileLoadingError.new(msg, details: details)
           else
             ::Oso::Polar::PolarRuntimeError.new(msg, details: details)
           end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Oso
+  module Polar
+    module FFI
+      # Wrapper class for Message FFI pointer + operations.
+      class Message < ::FFI::AutoPointer
+        # @return [String]
+        def to_s
+          @to_s ||= read_string.force_encoding('UTF-8')
+        end
+
+        Rust = Module.new do
+          extend ::FFI::Library
+          ffi_lib FFI::LIB_PATH
+
+          attach_function :free, :string_free, [Message], :int32
+        end
+
+        def process
+          message = JSON.parse(to_s)
+          kind = message['kind']
+          msg = message['msg']
+
+          case kind
+          when 'Print'
+            puts(msg)
+          when 'Warning'
+            warn(format('[warning] %<msg>s', msg: msg))
+          end
+        end
+
+        private_constant :Rust
+      end
+    end
+  end
+end

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

@@ -10,12 +10,13 @@ module Oso
           ffi_lib FFI::LIB_PATH
 
           attach_function :new, :polar_new, [], FFI::Polar
-          attach_function :load_str, :polar_load, [FFI::Polar, :string, :string], :int32
-          attach_function :next_inline_query, :polar_next_inline_query, [FFI::Polar], FFI::Query
+          attach_function :load, :polar_load, [FFI::Polar, :string, :string], :int32
+          attach_function :next_inline_query, :polar_next_inline_query, [FFI::Polar, :uint32], FFI::Query
           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_str, :polar_new_query, [FFI::Polar, :string, :uint32], FFI::Query
+          attach_function :new_query_from_term, :polar_new_query_from_term, [FFI::Polar, :string, :uint32], FFI::Query
           attach_function :register_constant, :polar_register_constant, [FFI::Polar, :string, :string], :int32
+          attach_function :next_message, :polar_next_polar_message, [FFI::Polar], FFI::Message
           attach_function :free, :polar_free, [FFI::Polar], :int32
         end
         private_constant :Rust
@@ -32,15 +33,18 @@ module Oso
         # @param src [String]
         # @param filename [String]
         # @raise [FFI::Error] if the FFI call returns an error.
-        def load_str(src, filename: nil)
-          raise FFI::Error.get if Rust.load_str(self, src, filename).zero?
+        def load(src, filename: nil)
+          loaded = Rust.load(self, src, filename)
+          process_messages
+          raise FFI::Error.get if loaded.zero?
         end
 
         # @return [FFI::Query] if there are remaining inline queries.
         # @return [nil] if there are no remaining inline queries.
         # @raise [FFI::Error] if the FFI call returns an error.
         def next_inline_query
-          query = Rust.next_inline_query(self)
+          query = Rust.next_inline_query(self, 0)
+          process_messages
           query.null? ? nil : query
         end
 
@@ -59,7 +63,8 @@ module Oso
         # @return [FFI::Query]
         # @raise [FFI::Error] if the FFI call returns an error.
         def new_query_from_str(str)
-          query = Rust.new_query_from_str(self, str)
+          query = Rust.new_query_from_str(self, str, 0)
+          process_messages
           raise FFI::Error.get if query.null?
 
           query
@@ -69,7 +74,8 @@ module Oso
         # @return [FFI::Query]
         # @raise [FFI::Error] if the FFI call returns an error.
         def new_query_from_term(term)
-          query = Rust.new_query_from_term(self, JSON.dump(term))
+          query = Rust.new_query_from_term(self, JSON.dump(term), 0)
+          process_messages
           raise FFI::Error.get if query.null?
 
           query
@@ -79,7 +85,21 @@ module Oso
         # @param value [Hash<String, Object>]
         # @raise [FFI::Error] if the FFI call returns an error.
         def register_constant(name, value:)
-          raise FFI::Error.get if Rust.register_constant(self, name, JSON.dump(value)).zero?
+          registered = Rust.register_constant(self, name, JSON.dump(value))
+          raise FFI::Error.get if registered.zero?
+        end
+
+        def next_message
+          Rust.next_message(self)
+        end
+
+        def process_messages
+          loop do
+            message = next_message
+            break if message.null?
+
+            message.process
+          end
         end
       end
     end

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

@@ -12,7 +12,10 @@ module Oso
           attach_function :debug_command, :polar_debug_command, [FFI::Query, :string], :int32
           attach_function :call_result, :polar_call_result, [FFI::Query, :uint64, :string], :int32
           attach_function :question_result, :polar_question_result, [FFI::Query, :uint64, :int32], :int32
+          attach_function :application_error, :polar_application_error, [FFI::Query, :string], :int32
           attach_function :next_event, :polar_next_query_event, [FFI::Query], FFI::QueryEvent
+          attach_function :next_message, :polar_next_query_message, [FFI::Query], FFI::Message
+          attach_function :source, :polar_query_source_info, [FFI::Query], FFI::Source
           attach_function :free, :query_free, [FFI::Query], :int32
         end
         private_constant :Rust
@@ -21,6 +24,7 @@ module Oso
         # @raise [FFI::Error] if the FFI call returns an error.
         def debug_command(cmd)
           res = Rust.debug_command(self, cmd)
+          process_messages
           raise FFI::Error.get if res.zero?
         end
 
@@ -41,14 +45,45 @@ module Oso
           raise FFI::Error.get if res.zero?
         end
 
+        # @param result [Boolean]
+        # @param call_id [Integer]
+        # @raise [FFI::Error] if the FFI call returns an error.
+        def application_error(message)
+          res = Rust.application_error(self, message)
+          raise FFI::Error.get if res.zero?
+        end
+
         # @return [::Oso::Polar::QueryEvent]
         # @raise [FFI::Error] if the FFI call returns an error.
         def next_event
           event = Rust.next_event(self)
+          process_messages
           raise FFI::Error.get if event.null?
 
           ::Oso::Polar::QueryEvent.new(JSON.parse(event.to_s))
         end
+
+        def next_message
+          Rust.next_message(self)
+        end
+
+        def process_messages
+          loop do
+            message = next_message
+            break if message.null?
+
+            message.process
+          end
+        end
+
+        # @return [String]
+        # @raise [FFI::Error] if the FFI call returns an error.
+        def source
+          res = Rust.source(self)
+          raise FFI::Error.get if res.null?
+
+          res.to_s
+        end
       end
     end
   end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Oso
+  module Polar
+    module FFI
+      # Wrapper class for Source FFI pointer.
+      class Source < ::FFI::AutoPointer
+        # @return [String]
+        def to_s
+          @to_s ||= read_string.force_encoding('UTF-8')
+        end
+
+        Rust = Module.new do
+          extend ::FFI::Library
+          ffi_lib FFI::LIB_PATH
+
+          attach_function :free, :string_free, [Message], :int32
+        end
+
+        private_constant :Rust
+      end
+    end
+  end
+end

data/lib/oso/polar/host.rb

@@ -3,8 +3,9 @@
 module Oso
   module Polar
     # Translate between Polar and the host language (Ruby).
-    class Host
+    class Host # rubocop:disable Metrics/ClassLength
       protected
+
       # @return [FFI::Polar]
       attr_reader :ffi_polar
       # @return [Hash<String, Class>]
@@ -15,6 +16,7 @@ module Oso
       attr_reader :instances
 
       public
+
       def initialize(ffi_polar)
         @ffi_polar = ffi_polar
         @classes = {}
@@ -44,9 +46,10 @@ module Oso
       #
       # @param cls [Class] the class to cache
       # @param name [String] the name to cache the class as. Defaults to the name of the class.
+      # @param constructor [Proc] optional custom constructor function. Defaults to the :new method.
       # @return [String] the name the class is cached as.
       # @raise [UnregisteredClassError] if the class has not been registered.
-      def cache_class(cls, name:, constructor:)
+      def cache_class(cls, name:, constructor:) # rubocop:disable Metrics/MethodLength
         name = cls.name if name.nil?
         raise DuplicateClassAliasError, name: name, old: get_class(name), new: cls if classes.key? name
 
@@ -73,7 +76,7 @@ module Oso
         constructors[name]
       end
 
-      # Check if an instance has been cached.
+      # Check if an instance exists in the {#instances} cache.
       #
       # @param id [Integer]
       # @return [Boolean]
@@ -97,7 +100,8 @@ module Oso
         instances[id]
       end
 
-      # Cache a Ruby instance, fetching a {#new_id} if one isn't provided.
+      # Cache a Ruby instance in the {#instances} cache, fetching a {#new_id}
+      # if one isn't provided.
       #
       # @param instance [Object]
       # @param id [Integer]
@@ -111,22 +115,29 @@ module Oso
       # Construct and cache a Ruby instance.
       #
       # @param cls_name [String]
-      # @param fields [Hash<String, Hash>]
+      # @param initargs [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
+      def make_instance(cls_name, initargs:, id:) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
         constructor = get_constructor(cls_name)
-        fields = Hash[fields.map { |k, v| [k.to_sym, to_ruby(v)] }]
         instance = if constructor == :new
-                     if fields.empty?
+                     if initargs.empty?
                        get_class(cls_name).__send__(:new)
+                     elsif initargs.is_a? Array
+                       get_class(cls_name).__send__(:new, *initargs)
+                     elsif initargs.is_a? Hash
+                       get_class(cls_name).__send__(:new, **initargs)
                      else
-                       get_class(cls_name).__send__(:new, **fields)
+                       raise PolarRuntimeError, "Bad initargs: #{initargs}"
                      end
-                   elsif fields.empty?
+                   elsif initargs.empty?
                      constructor.call
+                   elsif initargs.is_a? Array
+                     constructor.call(*initargs)
+                   elsif initargs.is_a? Hash
+                     constructor.call(**initargs)
                    else
-                     constructor.call(**fields)
+                     raise PolarRuntimeError, "Bad initargs: #{initargs}"
                    end
         cache_instance(instance, id: id)
       rescue StandardError => e
@@ -149,11 +160,11 @@ module Oso
 
       # Check if instance is an instance of class.
       #
-      # @param instance_id [Integer]
+      # @param instance [Hash<String, Object>]
       # @param class_tag [String]
       # @return [Boolean]
-      def isa?(instance_id, class_tag:)
-        instance = get_instance(instance_id)
+      def isa?(instance, class_tag:)
+        instance = to_ruby(instance)
         cls = get_class(class_tag)
         instance.is_a? cls
       rescue PolarRuntimeError
@@ -198,7 +209,7 @@ module Oso
                   # This is supported so that we can query for unbound variables
                   { 'Variable' => value }
                 else
-                  { 'ExternalInstance' => { 'instance_id' => cache_instance(value) } }
+                  { 'ExternalInstance' => { 'instance_id' => cache_instance(value), 'repr' => value.to_s } }
                 end
         { 'value' => value }
       end
@@ -226,6 +237,8 @@ module Oso
           get_instance(value['instance_id'])
         when 'Call'
           Predicate.new(value['name'], args: value['args'].map { |a| to_ruby(a) })
+        when 'Variable'
+          Variable.new(value['name'])
         else
           raise UnexpectedPolarTypeError, tag
         end

data/lib/oso/polar/polar.rb

@@ -3,36 +3,72 @@
 require 'json'
 require 'pp'
 require 'set'
+require 'digest/md5'
+
+# Missing Ruby type.
+module PolarBoolean; end
+# Monkey-patch Ruby true type.
+class TrueClass; include PolarBoolean; end
+# Monkey-patch Ruby false type.
+class FalseClass; include PolarBoolean; end
+
+# https://github.com/ruby/ruby/blob/bb9ecd026a6cadd5d0f85ac061649216806ed935/lib/bundler/vendor/thor/lib/thor/shell/color.rb#L99-L105
+def supports_color
+  $stdout.tty? && $stderr.tty? && ENV['NO_COLOR'].nil?
+end
+
+if supports_color
+  RESET = "\x1b[0m"
+  FG_BLUE = "\x1b[34m"
+  FG_RED = "\x1b[31m"
+else
+  RESET = ''
+  FG_BLUE = ''
+  FG_RED = ''
+end
+
+def print_error(error)
+  warn FG_RED + error.class.name.split('::').last + RESET
+  warn error.message
+end
 
 module Oso
   module Polar
     # Create and manage an instance of the Polar runtime.
-    class Polar
+    class Polar # rubocop:disable Metrics/ClassLength
       # @return [Host]
       attr_reader :host
 
       def initialize
         @ffi_polar = FFI::Polar.create
         @host = Host.new(ffi_polar)
-        @load_queue = Set.new
+
+        # Register built-in classes.
+        register_class PolarBoolean, name: 'Boolean'
+        register_class Integer
+        register_class Float
+        register_class Array, name: 'List'
+        register_class Hash, name: 'Dictionary'
+        register_class String
       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.
+      # Load a Polar policy file.
       #
       # @param name [String]
       # @raise [PolarFileExtensionError] if provided filename has invalid extension.
       # @raise [PolarFileNotFoundError] if provided filename does not exist.
       def load_file(name)
-        raise PolarFileExtensionError unless ['.pol', '.polar'].include? File.extname(name)
-        raise PolarFileNotFoundError, name unless File.file?(name)
+        raise PolarFileExtensionError, name unless File.extname(name) == '.polar'
 
-        load_queue << name
+        file_data = File.open(name, &:read)
+        load_str(file_data, filename: name)
+      rescue Errno::ENOENT
+        raise PolarFileNotFoundError, name
       end
 
       # Load a Polar string into the KB.
@@ -45,7 +81,7 @@ module Oso
       def load_str(str, filename: nil) # rubocop:disable Metrics/MethodLength
         raise NullByteInPolarFileError if str.chomp("\0").include?("\0")
 
-        ffi_polar.load_str(str, filename: filename)
+        ffi_polar.load(str, filename: filename)
         loop do
           next_query = ffi_polar.next_inline_query
           break if next_query.nil?
@@ -53,14 +89,22 @@ module Oso
           begin
             Query.new(next_query, host: host).results.next
           rescue StopIteration
-            raise InlineQueryFailedError
+            raise InlineQueryFailedError, next_query.source
           end
         end
       end
 
-      # Query for a predicate, parsing it if necessary.
+      # Query for a Polar predicate or string.
+      #
+      # @overload query(query)
+      #   @param query [String]
+      #   @return [Enumerator] of resulting bindings
+      #   @raise [Error] if the FFI call raises one.
+      # @overload query(query)
+      #   @param query [Predicate]
+      #   @return [Enumerator] of resulting bindings
+      #   @raise [Error] if the FFI call raises one.
       def query(query)
-        load_queued_files
         new_host = host.dup
         case query
         when String
@@ -73,58 +117,16 @@ module Oso
         Query.new(ffi_query, host: new_host).results
       end
 
-      # Query for a predicate.
+      # Query for a rule.
       #
       # @param name [String]
       # @param args [Array<Object>]
+      # @return [Enumerator] of resulting bindings
       # @raise [Error] if the FFI call raises one.
-      def query_predicate(name, *args)
+      def query_rule(name, *args)
         query(Predicate.new(name, args: args))
       end
 
-      # Start a REPL session.
-      #
-      # @raise [Error] if the FFI call raises one.
-      def repl(load: false) # rubocop:disable Metrics/MethodLength
-        ARGV.map { |f| load_file(f) } if load
-        load_queued_files
-
-        loop do
-          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?
-            pp false
-          else
-            results.each do |result|
-              if result.empty?
-                pp true
-              else
-                pp result
-              end
-            end
-          end
-        end
-      end
-
       # Register a Ruby class with Polar.
       #
       # @param cls [Class]
@@ -132,9 +134,7 @@ module Oso
       # @param from_polar [Proc]
       # @raise [InvalidConstructorError] if provided an invalid 'from_polar' constructor.
       def register_class(cls, name: nil, from_polar: nil)
-        if block_given?
-          from_polar = Proc.new
-        end
+        from_polar = Proc.new if block_given?
         name = host.cache_class(cls, name: name, constructor: from_polar)
         register_constant(name, value: cls)
       end
@@ -143,20 +143,89 @@ module Oso
         ffi_polar.register_constant(name, value: host.to_polar_term(value))
       end
 
-      # Load all queued files, flushing the {#load_queue}.
-      def load_queued_files
-        load_queue.reject! do |filename|
-          File.open(filename) { |file| load_str(file.read, filename: filename) }
-          true
-        end
+      # Start a REPL session.
+      #
+      # @param files [Array<String>]
+      # @raise [Error] if the FFI call raises one.
+      def repl(files = [])
+        files.map { |f| load_file(f) }
+        prompt = "#{FG_BLUE}query>#{RESET} "
+        # Try loading the readline module from the Ruby stdlib. If we get a
+        # LoadError, fall back to the standard REPL with no readline support.
+        require 'readline'
+        repl_readline(prompt)
+      rescue LoadError
+        repl_standard(prompt)
       end
 
       private
 
       # @return [FFI::Polar]
       attr_reader :ffi_polar
-      # @return [Array<String>]
-      attr_reader :load_queue
+      # @return [Hash<String, String>]
+      attr_reader :loaded_names
+      # @return [Hash<String, String>]
+      attr_reader :loaded_contents
+
+      # The R and L in REPL for systems where readline is available.
+      def repl_readline(prompt)
+        while (buf = Readline.readline(prompt, true))
+          if /^\s*$/ =~ buf # Don't add empty entries to history.
+            Readline::HISTORY.pop
+            next
+          end
+          process_line(buf)
+        end
+      rescue Interrupt # rubocop:disable Lint/SuppressedException
+      end
+
+      # The R and L in REPL for systems where readline is not available.
+      def repl_standard(prompt)
+        loop do
+          puts prompt
+          begin
+            buf = $stdin.readline
+          rescue EOFError
+            return
+          end
+          process_line(buf)
+        end
+      rescue Interrupt # rubocop:disable Lint/SuppressedException
+      end
+
+      # Process a line of user input in the REPL.
+      #
+      # @param buf [String]
+      def process_line(buf) # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/AbcSize
+        query = buf.chomp.chomp(';')
+        begin
+          ffi_query = ffi_polar.new_query_from_str(query)
+        rescue ParseError => e
+          print_error(e)
+          return
+        end
+
+        begin
+          results = Query.new(ffi_query, host: host).results.to_a
+        rescue PolarRuntimeError => e
+          print_error(e)
+          return
+        end
+
+        if results.empty?
+          puts false
+        else
+          results.each do |result|
+            if result.empty?
+              puts true
+            else
+              result.each do |variable, value|
+                puts "#{variable} => #{value.inspect}"
+              end
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/oso/polar/query.rb

@@ -3,11 +3,12 @@
 module Oso
   module Polar
     # A single Polar query.
-    class Query
+    class Query # rubocop:disable Metrics/ClassLength
+      # @return [Enumerator]
       attr_reader :results
 
       # @param ffi_query [FFI::Query]
-      # @param ffi_polar [FFI::Polar]
+      # @param host [Oso::Polar::Host]
       def initialize(ffi_query, host:)
         @calls = {}
         @ffi_query = ffi_query
@@ -38,21 +39,20 @@ module Oso
       #
       # @param method [#to_sym]
       # @param call_id [Integer]
-      # @param instance [Hash]
+      # @param instance [Hash<String, Object>]
       # @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:)
+      def register_call(attribute, call_id:, instance:, args:) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         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)
+        instance = host.to_ruby(instance)
+        if args.nil?
+          result = instance.__send__(attribute)
         else
-          instance = host.to_ruby(instance)
+          args = args.map { |a| host.to_ruby(a) }
+          result = instance.__send__(attribute, *args)
         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
@@ -77,22 +77,31 @@ module Oso
         host.to_polar_term(calls[id].next)
       end
 
+      # Send application error across FFI boundary.
+      #
+      # @param message [String]
+      # @raise [Error] if the FFI call raises one.
+      def application_error(message)
+        ffi_query.application_error(message)
+      end
+
       # Fetch the next result from calling a Ruby method and prepare it for
       # transmission across the FFI boundary.
       #
       # @param method [#to_sym]
       # @param args [Array<Hash>]
       # @param call_id [Integer]
-      # @param instance_id [Integer]
+      # @param instance [Hash<String, Object>]
       # @raise [Error] if the FFI call raises one.
-      def handle_call(method, call_id:, instance:, args:)
-        register_call(method, call_id: call_id, instance: instance, args: args)
+      def handle_call(attribute, call_id:, instance:, args:)
+        register_call(attribute, 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
+      rescue InvalidCallError => e
+        application_error(e.message)
+        call_result(nil, call_id: call_id)
+      rescue StopIteration
         call_result(nil, call_id: call_id)
-        # @TODO: polar line numbers in errors once polar errors are better.
-        # raise PolarRuntimeError(f"Error calling {attribute}")
       end
 
       # Create a generator that can be polled to advance the query loop.
@@ -100,7 +109,7 @@ module Oso
       # @yieldparam [Hash<String, Object>]
       # @return [Enumerator]
       # @raise [Error] if any of the FFI calls raise one.
-      def start # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      def start # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
         Enumerator.new do |yielder| # rubocop:disable Metrics/BlockLength
           loop do # rubocop:disable Metrics/BlockLength
             event = ffi_query.next_event
@@ -113,15 +122,24 @@ module Oso
               id = event.data['instance_id']
               raise DuplicateInstanceRegistrationError, id if host.instance? id
 
-              cls_name = event.data['instance']['tag']
-              fields = event.data['instance']['fields']['fields']
-              host.make_instance(cls_name, fields: fields, id: id)
+              constructor = event.data['constructor']['value']
+              if constructor.key? 'InstanceLiteral'
+                cls_name = constructor['InstanceLiteral']['tag']
+                fields = constructor['InstanceLiteral']['fields']['fields']
+                initargs = Hash[fields.map { |k, v| [k.to_sym, host.to_ruby(v)] }]
+              elsif constructor.key? 'Call'
+                cls_name = constructor['Call']['name']
+                initargs = constructor['Call']['args'].map { |arg| host.to_ruby(arg) }
+              else
+                raise InvalidConstructorError
+              end
+              host.make_instance(cls_name, initargs: initargs, id: id)
             when 'ExternalCall'
               call_id = event.data['call_id']
               instance = event.data['instance']
-              method = event.data['attribute']
+              attribute = event.data['attribute']
               args = event.data['args']
-              handle_call(method, call_id: call_id, instance: instance, args: args)
+              handle_call(attribute, call_id: call_id, instance: instance, args: args)
             when 'ExternalIsSubSpecializer'
               instance_id = event.data['instance_id']
               left_tag = event.data['left_class_tag']
@@ -129,9 +147,9 @@ module Oso
               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']
+              instance = event.data['instance']
               class_tag = event.data['class_tag']
-              answer = host.isa?(instance_id, class_tag: class_tag)
+              answer = host.isa?(instance, class_tag: class_tag)
               question_result(answer, call_id: event.data['call_id'])
             when 'ExternalUnify'
               left_instance_id = event.data['left_instance_id']
@@ -140,8 +158,12 @@ module Oso
               question_result(answer, call_id: event.data['call_id'])
             when 'Debug'
               puts event.data['message'] if event.data['message']
-              print '> '
-              input = $stdin.gets.chomp!
+              print 'debug> '
+              begin
+                input = $stdin.readline.chomp.chomp(';')
+              rescue EOFError
+                next
+              end
               command = JSON.dump(host.to_polar_term(input))
               ffi_query.debug_command(command)
             else

data/lib/oso/version.rb

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

data/oso-oso.gemspec

@@ -5,14 +5,16 @@ require_relative 'lib/oso/version'
 Gem::Specification.new do |spec|
   spec.name          = 'oso-oso'
   spec.version       = Oso::VERSION
-  spec.authors       = ['Oso Security']
+  spec.authors       = ['Oso Security, Inc.']
   spec.email         = ['support@osohq.com']
-
-  spec.summary       = 'Oso authorization API.'
+  spec.licenses      = ['Apache-2.0']
+  spec.summary       = 'oso authorization library.'
   spec.homepage      = 'https://www.osohq.com/'
+
   spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/osohq/oso'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -32,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry-byebug', '~> 3.9.0'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'solargraph', '~> 0.39.8'
+  spec.add_development_dependency 'rubocop', '~> 0.89.1'
+  spec.add_development_dependency 'solargraph', '~> 0.39.14'
   spec.add_development_dependency 'yard', '~> 0.9.25'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oso-oso
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.5.1
 platform: ruby
 authors:
-- Oso Security
+- Oso Security, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-25 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -66,20 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.1
 - !ruby/object:Gem::Dependency
   name: solargraph
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.39.8
+        version: 0.39.14
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.39.8
+        version: 0.39.14
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +118,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".solargraph.yml"
 - Gemfile
 - Gemfile.lock
@@ -122,9 +137,11 @@ files:
 - lib/oso/polar/errors.rb
 - lib/oso/polar/ffi.rb
 - lib/oso/polar/ffi/error.rb
+- lib/oso/polar/ffi/message.rb
 - lib/oso/polar/ffi/polar.rb
 - lib/oso/polar/ffi/query.rb
 - lib/oso/polar/ffi/query_event.rb
+- lib/oso/polar/ffi/source.rb
 - lib/oso/polar/host.rb
 - lib/oso/polar/polar.rb
 - lib/oso/polar/predicate.rb
@@ -134,9 +151,11 @@ files:
 - lib/oso/version.rb
 - oso-oso.gemspec
 homepage: https://www.osohq.com/
-licenses: []
+licenses:
+- Apache-2.0
 metadata:
   homepage_uri: https://www.osohq.com/
+  source_code_uri: https://github.com/osohq/oso
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -156,5 +175,5 @@ rubyforge_project:
 rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
-summary: Oso authorization API.
+summary: oso authorization library.
 test_files: []