jaina 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 021a99a70e1f530c83857667a7c0defdd785abc635931167fe2a9bd45bf1393f
-  data.tar.gz: fe1956e513688b643365ed85a55a02226a18b5adc75ee202130f7b1dab8404ab
+  metadata.gz: 850df9cc5e4a4962b435569da878367493a801ac0f842760157083e8f5fba578
+  data.tar.gz: 79cb4a3a71d81205b4d6647a04de688b084b6108373d9cc274a11ca390fffadd
 SHA512:
-  metadata.gz: 0d147dbfe65aef16511b703b52100b00f28b81695c1e18906b166180c49629cd6b8cc07ccf362022a04fc7897f0e9625e3a10969d52ad2a7f3606755941c8a6e
-  data.tar.gz: 39ca3e5fadb5341a29f363f4ec3426395edb214c4041620ccea19282d49602edeef417b641659dc38d17e01a81b9baf696258e8f86b3455f20f4cf9979791610
+  metadata.gz: 5253d6c057ef220178518f8793cbb7e40e091556a8efec5ee48d443c582408e2122b27cc098747f1b0d620d470604b041e1c8cf66ddd8eb7ffa4486fbd63f08a
+  data.tar.gz: 54d7867f5ee7ec104e2a46d8311f69c6cf3cab25b5d635a64458ee18ce1f94778cd3794425474346e371d576f4a6183f62a4363fb181ebe27507c9b36c44f231

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.3.0] - 2019-06-21
+- Support for initial context: `Jaina.evaluate(program, **initial_context)`
+
 ## [0.2.0] - 2019-06-21
 ### Added
 - `#evaluate(context)` implementation for all core operators (`AND`, `OR`, `NOT`);

data/README.md

@@ -28,6 +28,7 @@ require 'jaina'
 - [Parse your code (build AST)](#parse-your-code-build-ast)
 - [Evaluate your code](#evaluate-your-code)
 - [List registered operands and operators](#list-and-fetch-registered-operands-and-operators)
+- [Full example](#full-example)
 
 ---
 
@@ -117,6 +118,9 @@ ast.evaluate
 
 # --- or ---
 Jaina.evaluate('A AND B AND (C OR D) OR A AND (C OR E)')
+
+# --- you can set initial context of your program ---
+Jaina.evaluate('A AND B', login: 'admin', logged_in: true)
 ```
 
 ---
@@ -144,6 +148,53 @@ Jaina.fetch_expression("KEK")
 
 ---
 
+### Full example
+
+```ruby
+# step 1: register new operand
+class AddNumber < Jaina::TerminalExpr
+  token 'ADD'
+
+  def evaluate(context)
+    context.set(:current_value, context.get(:current_value) + 10)
+  end
+end
+
+# step 2: register another new operand
+class CheckNumber < Jaina::TerminalExpr
+  token 'CHECK'
+
+  def evaluate(context)
+    context.get(:current_value) < 0
+  end
+end
+
+class InitState < Jaina::TerminalExpr
+  token 'INIT'
+
+  def evaluate(context)
+    context.set(:current_value, 0)
+  end
+end
+
+# step 3: register new oeprands
+Jaina.register_expression(AddNumber)
+Jaina.register_expression(CheckNumber)
+Jaina.register_expression(InitState)
+
+# step 4: run your program
+
+# NOTE: with initial context
+Jaina.evaluate('CHECK AND ADD', current_value: -1) # => false
+Jaina.evaluate('CHECK AND ADD', current_value: 2) # => 12
+
+# NOTE: without initial context
+Jaina.evaluate('INIT AND ADD') # => 10
+Jaina.evaluate('INIT AND (CHECK OR ADD)') # => 12
+```
+
+---
+
 ## Contributing
 
 - Fork it ( https://github.com/0exp/jaina/fork )

data/lib/jaina.rb

@@ -24,12 +24,13 @@ module Jaina
     end
 
     # @param program [String]
+    # @param initial_context [Hash<Symbol,Any>]
     # @return [Any]
     #
     # @api public
     # @since 0.1.0
-    def evaluate(program)
-      parse(program).evaluate
+    def evaluate(program, **initial_context)
+      parse(program).evaluate(**initial_context)
     end
 
     # @param expression_klass [Class{Jaina::Parser::Expression::Operator::Abstract}]

data/lib/jaina/parser/ast.rb

@@ -49,11 +49,12 @@ class Jaina::Parser::AST
     @ast_tree = ast_tree
   end
 
+  # @param initial_context [Hash<Symbol,Any>]
   # @return [Any]
   #
   # @api private
   # @since 0.1.0
-  def evaluate
-    Jaina::Parser::AST::Evaluator.evaluate(self)
+  def evaluate(**initial_context)
+    Jaina::Parser::AST::Evaluator.evaluate(self, **initial_context)
   end
 end

data/lib/jaina/parser/ast/context.rb

@@ -8,12 +8,13 @@ class Jaina::Parser::AST::Context
   # @since 0.1.0
   UndefinedContextKeyError = Class.new(Error)
 
+  # @param initial_context [Hash<Symbol,Any>]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def initialize
-    @data = {}
+  def initialize(**initial_context)
+    @data = {}.merge!(initial_context)
     @access_lock = Mutex.new
   end
 

data/lib/jaina/parser/ast/evaluator.rb

@@ -4,17 +4,18 @@
 # @since 0.1.0
 module Jaina::Parser::AST::Evaluator
   class << self
+    # @param initial_context [Hash<Symbol,Any>]
     # @param ast [Jaina::Parser::AST]
     # @return [Any]
     #
     # @api private
     # @since 0.1.0
-    def evaluate(ast)
+    def evaluate(ast, **initial_context)
       # NOTE: build shared context for a program
-      context = Jaina::Parser::AST::Context.new
+      context = Jaina::Parser::AST::Context.new(**initial_context)
 
       # NOTE: evaluate the root expression of AST
-      # NOTE: root is an atity of type [Jaina::Parser::Expression::Operator::Abstract]
+      # NOTE: root is an entity of type [Jaina::Parser::Expression::Operator::Abstract]
       ast.root.evaluate(context)
     end
   end

data/lib/jaina/parser/ast/tree.rb

@@ -21,8 +21,9 @@ class Jaina::Parser::AST::Tree
   # @since 0.1.0
   attr_reader :expression
 
-  # @param initial_program [String]
-  # @param expression [Jaina::Parser::Expression::Operator::Abstract]
+  # @option initial_program [String]
+  # @option ast_oriented_program [String]
+  # @option expression [Jaina::Parser::Expression::Operator::Abstract]
   # @return [void]
   #
   # @api private
@@ -36,6 +37,6 @@ class Jaina::Parser::AST::Tree
   # @return [Jaina::Parser::Expression::operator::Abstract]
   #
   # @api private
-  # @since 0.1.0
+  # @since 0.3.0
   alias_method :root, :expression
 end

data/lib/jaina/parser/expression/operator/or.rb

@@ -23,7 +23,7 @@ module Jaina::Parser::Expression::Operator
     # @api private
     # @since 0.2.0
     def left_expression
-      expressions.first
+      expressions[0]
     end
 
     # @return [Jaina::Parser::Expression::Operator::Abstract]
@@ -31,7 +31,7 @@ module Jaina::Parser::Expression::Operator
     # @api private
     # @since 0.2.0
     def right_expression
-      expressions.second
+      expressions[1]
     end
   end
 end

data/lib/jaina/version.rb

@@ -5,5 +5,5 @@ module Jaina
   #
   # @api public
   # @since 0.0.0
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jaina
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rustam Ibragimov