delorean_lang 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abf633643467cfaea17671df87afddee204b361c86df7cd6a83f2a9d5dfec262
-  data.tar.gz: b6d5544061eb9cd4e1cbe604dbcd2c0f72c746a3ab4aa81837777eece9e87a58
+  metadata.gz: afc7142d7683c1fe4d606a86dd7c46eff3ae672b1eb58db13cb587c18b9ea741
+  data.tar.gz: a522e77939cbcaa4b8592980ced9281179a07e171fe3e34b69adba13661a8215
 SHA512:
-  metadata.gz: d4e00b359a7af226c2006958cbae162377c76ad6edddb575ea36ee3fa1a4db3506814dfdbb1f65d55b7fcc9a84fcf30e3ca6f34ed0f76feff0d3e039b26fe936
-  data.tar.gz: 2dc5a21daa092f7c50c3a0fa25986f0b6cd49a39eab56ce0483486a9ca0f42726f464727693c908bcb3dd7d406f86141676cb2bb09772299c9636c6bce3389c1
+  metadata.gz: 03b53dcf912b0311f12151e6fa189e797f767205cd36d6aac6547d58ab6fad6cfbe6905766caae199c15d4898360829a2249379d61634fec98062fc33753b8ae
+  data.tar.gz: d21c189ed7f03b98cc5c21525a1c031b4a6d43477291744a7016e75f411ca9aad5cafe4c2b87451059036438d5c60d6c14fc9a94fd703be7f902b802dfbe2fe2

data/.rubocop.yml

@@ -1,3 +1,4 @@
+require: rubocop-performance
 inherit_from: .rubocop_todo.yml
 
 AllCops:
@@ -75,3 +76,5 @@ Style/PerlBackrefs:
 Naming/HeredocDelimiterCase:
   Enabled: false
 
+Naming/RescuedExceptionsVariableName:
+  Enabled: false

data/README.md

@@ -159,7 +159,7 @@ Ruby.
 
 ### Calling ruby methods from Delorean
 
-Ruby methods that are called from Delorean should be whitelisted.
+There are two ways of calling ruby code from delorean. First one is to whitelist methods:
 
 ```ruby
 
@@ -184,6 +184,35 @@ By default Delorean has some methods whitelisted, such as `length`, `min`, `max`
 
 ```
 
+Another way is to define methods using `delorean_fn` and `cached_delorean_fn`.
+Use `extend Delorean::Functions` or `include Delorean::Model` in your module or class.
+
+```ruby
+class Dummy < ActiveRecord::Base
+  include Delorean::Model
+
+  delorean_fn(:heres_my_number, sig: [0, Float::INFINITY]) do |*a|
+    a.inject(0, :+)
+  end
+end
+
+module DummyModule
+  extend Delorean::Functions
+
+  delorean_fn(:heres_my_number, sig: [0, Float::INFINITY]) do |*a|
+    a.inject(0, :+)
+  end
+end
+```
+
+`heres_my_number` method will be accessible from Delorean code.
+
+```ruby
+ExampleScript:
+    a = Dummy.heres_my_number(867, 5309)'
+    b = DummyModule.heres_my_number(867, 5309)'
+```
+
 ### Caching
 
 Delorean provides `cached_delorean_function` method that will cache result based on arguments.

data/delorean.gemspec

@@ -22,5 +22,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rspec', '~> 2.1'
   gem.add_development_dependency 'rubocop'
+  gem.add_development_dependency 'rubocop-performance'
   gem.add_development_dependency 'sqlite3', '~> 1.3.10'
 end

data/lib/delorean/base.rb

@@ -162,7 +162,7 @@ module Delorean
 
         # FIXME: this is pretty hacky -- should probably merge
         # whitelist and SIG mechanisms.
-        if obj.is_a?(Class)
+        if obj.is_a?(Class) || obj.is_a?(Module)
           _e[:_engine].parse_check_call_fn(method, args.count, obj)
           return obj.send(msg, *args)
         end

data/lib/delorean/engine.rb

@@ -193,10 +193,9 @@ module Delorean
         err(UndefinedError, "Can't find class: #{class_name}")
       end
 
-      err(UndefinedError, "Access to non-class: #{class_name}") unless
-        klass.instance_of?(Class)
+      return klass if klass.instance_of?(Class) || klass.instance_of?(Module)
 
-      klass
+      err(UndefinedError, "Access to non-class/module: #{class_name}")
     end
 
     def err(exc, msg)

data/lib/delorean/functions.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Delorean
+  module Functions
+    def delorean_fn(name, options = {})
+      define_singleton_method(name) do |*args|
+        yield(*args)
+      end
+
+      sig = options[:sig]
+
+      raise 'no signature' unless sig
+
+      sig = [sig, sig] if sig.is_a? Integer
+      raise 'Bad signature' unless sig.is_a?(Array) && (sig.length == 2)
+
+      const_set(name.to_s.upcase + Delorean::SIG, sig)
+    end
+
+    # FIXME: IDEA: we just make :cache an argument to delorean_fn.
+    # That way, we don't need the cached_ flavors.  It'll make all
+    # this code a lot simpler.  We should also just add the :private
+    # mechanism here.
+
+    # By default implements a VERY HACKY class-based (per process) caching
+    # mechanism for database lookup results.  Issues include: cached
+    # values are ActiveRecord objects.  Query results can be very
+    # large lists which we count as one item in the cache.  Caching
+    # mechanism will result in large processes.
+    def cached_delorean_fn(name, options = {})
+      delorean_fn(name, options) do |*args|
+        delorean_cache_adapter = ::Delorean::Cache.adapter
+        # Check if caching should be performed
+        next yield(*args) unless delorean_cache_adapter.cache_item?(
+          klass: self, method_name: name, args: args
+        )
+
+        cache_key = delorean_cache_adapter.cache_key(
+          klass: self, method_name: name, args: args
+        )
+        cached_item = delorean_cache_adapter.fetch_item(
+          klass: self, cache_key: cache_key, default: :NF
+        )
+
+        next cached_item if cached_item != :NF
+
+        res = yield(*args)
+
+        delorean_cache_adapter.cache_item(
+          klass: self, cache_key: cache_key, item: res
+        )
+
+        # Since we're caching this object and don't want anyone
+        # changing it.  FIXME: ideally should freeze this object
+        # recursively.
+        res.freeze if res.respond_to?(:freeze)
+
+        res
+      end
+    end
+
+    def clear_lookup_cache!
+      ::Delorean::Cache.adapter.clear!(klass: self)
+    end
+  end
+end

data/lib/delorean/model.rb

@@ -1,76 +1,12 @@
 # frozen_string_literal: true
 
 require 'delorean/const'
+require 'delorean/functions'
 
 module Delorean
   module Model
     def self.included(base)
-      base.send :extend, ClassMethods
-    end
-
-    module ClassMethods
-      def delorean_fn(name, options = {})
-        define_singleton_method(name) do |*args|
-          yield(*args)
-        end
-
-        sig = options[:sig]
-
-        raise 'no signature' unless sig
-
-        if sig
-          sig = [sig, sig] if sig.is_a? Integer
-          raise 'Bad signature' unless sig.is_a?(Array) && (sig.length == 2)
-
-          const_set(name.to_s.upcase + Delorean::SIG, sig)
-        end
-      end
-
-      # FIXME: IDEA: we just make :cache an argument to delorean_fn.
-      # That way, we don't need the cached_ flavors.  It'll make all
-      # this code a lot simpler.  We should also just add the :private
-      # mechanism here.
-
-      # By default implements a VERY HACKY class-based (per process) caching
-      # mechanism for database lookup results.  Issues include: cached
-      # values are ActiveRecord objects.  Query results can be very
-      # large lists which we count as one item in the cache.  Caching
-      # mechanism will result in large processes.
-      def cached_delorean_fn(name, options = {})
-        delorean_fn(name, options) do |*args|
-          delorean_cache_adapter = ::Delorean::Cache.adapter
-          # Check if caching should be performed
-          next yield(*args) unless delorean_cache_adapter.cache_item?(
-            klass: self, method_name: name, args: args
-          )
-
-          cache_key = delorean_cache_adapter.cache_key(
-            klass: self, method_name: name, args: args
-          )
-          cached_item = delorean_cache_adapter.fetch_item(
-            klass: self, cache_key: cache_key, default: :NF
-          )
-
-          next cached_item if cached_item != :NF
-
-          res = yield(*args)
-
-          delorean_cache_adapter.cache_item(
-            klass: self, cache_key: cache_key, item: res
-          )
-
-          # Since we're caching this object and don't want anyone
-          # changing it.  FIXME: ideally should freeze this object
-          # recursively.
-          res.freeze if res.respond_to?(:freeze)
-
-          res
-        end
-      end
-
-      def clear_lookup_cache!
-        ::Delorean::Cache.adapter.clear!(klass: self)
-      end
+      base.send :extend, ::Delorean::Functions
     end
   end
 end

data/lib/delorean/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Delorean
-  VERSION = '0.5.3'.freeze
+  VERSION = '0.5.4'.freeze
 end

data/lib/delorean_lang.rb

@@ -8,8 +8,10 @@ require 'delorean/base'
 require 'delorean/debug'
 require 'delorean/delorean'
 require 'delorean/cache'
+require 'delorean/const'
 require 'delorean/engine'
 require 'delorean/error'
+require 'delorean/functions'
 require 'delorean/model'
 require 'delorean/nodes'
 require 'delorean/ruby'

data/spec/eval_spec.rb

@@ -357,6 +357,20 @@ eoc
     r.should == 867 + 5309
   end
 
+  it 'should be able to use ruby modules as values and call their methods' do
+    engine.parse defn('A:',
+                      '    a = DummyModule',
+                      '    b = a.heres_my_number(867, 5309)',
+                      '    c = M::DummyModule.heres_my_number(867, 5309)',
+                     )
+    # binding.pry
+    r = engine.evaluate('A', 'b')
+    r.should == 867 + 5309
+
+    r = engine.evaluate('A', 'c')
+    r.should == 867 + 5309
+  end
+
   it 'should ignore undeclared params sent to eval which match attr names' do
     engine.parse defn('A:',
                       '    d = 12',

data/spec/spec_helper.rb

@@ -122,6 +122,18 @@ Delorean::Ruby.whitelist.add_method :name2 do |method|
   method.called_on Dummy
 end
 
+module DummyModule
+  extend Delorean::Functions
+
+  delorean_fn(:heres_my_number, sig: [0, Float::INFINITY]) do |*a|
+    a.inject(0, :+)
+  end
+end
+
+module M
+  DummyModule = ::DummyModule
+end
+
 ######################################################################
 
 class TestContainer < Delorean::AbstractContainer

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delorean_lang
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Arman Bostani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-07 00:00:00.000000000 Z
+date: 2019-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +137,7 @@ files:
 - lib/delorean/delorean.treetop
 - lib/delorean/engine.rb
 - lib/delorean/error.rb
+- lib/delorean/functions.rb
 - lib/delorean/model.rb
 - lib/delorean/nodes.rb
 - lib/delorean/ruby.rb