keisan 0.8.3 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d96dbb0d0fa1401f10443f46ce6fd273c2a370155a25f8b248f8f387d20c039f
-  data.tar.gz: a02847f4342e2dc70335a7489772a71f5d17dd70b1f6f9f0a845a9bb6e2be40a
+  metadata.gz: d539ead6f33b2151b228dfe6c30a0e3f7d40bb7b1113c90b851d020e04106df5
+  data.tar.gz: c36af3538e6f448c285b9857aa5ea14e3bc90853e5d3f4a74fd726d8b0c35068
 SHA512:
-  metadata.gz: fd68bfc3f9722a21419fc47c66a92abdfab529be641ea6e2c39385b8f3d014736a5ce9d7ad679554abae9d29c9ce03e1fb37ef0cd806b17f0fa6608aa82491f9
-  data.tar.gz: 242f78fc02f1c45673d977b505ec7f933cb11b5d098f8895c741fa0b8821640badab1046190935996c850296014ab0685864ec2a92bdb951f096c961eadfb2cd
+  metadata.gz: 67557029c43754d862406fc0491594b94dcc4dac5a925e518232accfd75c42582f8e5d11b5f99eec7f44dcb1ea29ea31f087668bf70a68c56fa25fc4ca8f2929
+  data.tar.gz: 2451bd2dbe844af1bc3a4f2ec9d0819aeb4df52f96bd45dbbc5ada1993b2c6003245c8f6191ce3f5dc59de18b106f313e07dedd3aef9ba670525d4bacabfb43a

data/.github/workflows/ruby.yml

@@ -0,0 +1,28 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec

data/README.md

@@ -178,6 +178,22 @@ calculator.evaluate("x = 11; {let x = 12}; x")
 #=> 11
 ```
 
+##### Comments
+
+When working with multi-line blocks of code, sometimes comments are useful to include.
+Comments are parts of a string from the `#` character to the end of a line (indicated by a newline character `"\n"`).
+
+```
+calculator = Keisan::Calculator.new
+calculator.evaluate("""
+  # This is a comment
+  x = 'foo'
+  x += '#bar' # Notice that `#` inside strings is not part of the comment
+  x # Should print 'foo#bar'
+""")
+#=> "foo#bar"
+```
+
 ##### Lists
 
 Just like in Ruby, lists can be defined using square brackets, and indexed using square brackets

data/lib/keisan/ast/block.rb

@@ -17,8 +17,8 @@ module Keisan
         child.unbound_functions(local)
       end
 
-      def contains_a?(klass)
-        super || child.contains_a?(klass)
+      def traverse(&block)
+        super(&block) || child.traverse(&block)
       end
 
       def deep_dup

data/lib/keisan/ast/cell.rb

@@ -15,8 +15,8 @@ module Keisan
         node.unbound_functions(context)
       end
 
-      def contains_a?(klass)
-        super || node.contains_a?(klass)
+      def traverse(&block)
+        super(&block) || node.traverse(&block)
       end
 
       def deep_dup

data/lib/keisan/ast/hash.rb

@@ -21,8 +21,16 @@ module Keisan
         end
       end
 
-      def contains_a?(klass)
-        super || @hash.any? {|k, v| k.to_node.contains_a?(klass) || v.contains_a?(klass) }
+      def traverse(&block)
+        value = super(&block)
+        return value if value
+        @hash.each do |k, v|
+          value = k.to_node.traverse(&block)
+          return value if value
+          value = v.traverse(&block)
+          return value if value
+        end
+        false
       end
 
       def evaluate(context = nil)

data/lib/keisan/ast/node.rb

@@ -37,12 +37,26 @@ module Keisan
         value(context)
       end
 
+      # Takes a block, and does a DFS down the AST, evaluating the received block
+      # at each node, passing in the node as the single argument. If the block
+      # returns a truthy value at any point, the DFS ends and the return value is
+      # percolated up the tree.
+      def traverse(&block)
+        block.call(self)
+      end
+
       def contains_a?(klass)
         case klass
         when Array
-          klass.any? {|k| is_a?(k) }
+          klass.any? do |k|
+            traverse do |node|
+              node.is_a?(k)
+            end
+          end
         else
-          is_a?(klass)
+          traverse do |node|
+            node.is_a?(klass)
+          end
         end
       end
 

data/lib/keisan/ast/parent.rb

@@ -25,8 +25,14 @@ module Keisan
         end
       end
 
-      def contains_a?(klass)
-        super || children.any? {|child| child.contains_a?(klass) }
+      def traverse(&block)
+        value = super(&block)
+        return value if value
+        children.each do |child|
+          value = child.traverse(&block)
+          return value if value
+        end
+        false
       end
 
       def freeze

data/lib/keisan/calculator.rb

@@ -4,11 +4,12 @@ module Keisan
 
     # Note, allow_recursive would be more appropriately named:
     # allow_unbound_functions_in_function_definitions, but it is too late for that.
-    def initialize(context: nil, allow_recursive: false, allow_blocks: true, allow_multiline: true)
+    def initialize(context: nil, allow_recursive: false, allow_blocks: true, allow_multiline: true, allow_random: true)
       @context = context || Context.new(
         allow_recursive: allow_recursive,
         allow_blocks: allow_blocks,
-        allow_multiline: allow_multiline
+        allow_multiline: allow_multiline,
+        allow_random: allow_random
       )
     end
 
@@ -28,6 +29,10 @@ module Keisan
       context.allow_multiline
     end
 
+    def allow_random
+      context.allow_random
+    end
+
     def evaluate(expression, definitions = {})
       Evaluator.new(self).evaluate(expression, definitions)
     end

data/lib/keisan/context.rb

@@ -4,13 +4,15 @@ module Keisan
       :variable_registry,
       :allow_recursive,
       :allow_multiline,
-      :allow_blocks
+      :allow_blocks,
+      :allow_random
 
     def initialize(parent: nil,
                    random: nil,
                    allow_recursive: false,
                    allow_multiline: true,
                    allow_blocks: true,
+                   allow_random: true,
                    shadowed: [])
       @parent = parent
       @function_registry = Functions::Registry.new(parent: @parent&.function_registry)
@@ -19,6 +21,7 @@ module Keisan
       @allow_recursive   = allow_recursive
       @allow_multiline   = allow_multiline
       @allow_blocks      = allow_blocks
+      @allow_random      = allow_random
     end
 
     def allow_recursive!
@@ -111,7 +114,13 @@ module Keisan
     end
 
     def random
-      @random || @parent&.random || Random.new
+      raise Keisan::Exceptions::InvalidExpression.new("Context does not permit expressions with randomness") unless allow_random
+      @random ||= @parent&.random || Random.new
+    end
+
+    def set_random(random)
+      raise Keisan::Exceptions::InvalidExpression.new("Context does not permit expressions with randomness") unless allow_random
+      @random = random
     end
 
     protected

data/lib/keisan/functions/enumerable_function.rb

@@ -21,14 +21,17 @@ module Keisan
         context ||= Context.new
 
         operand, arguments, expression = operand_arguments_expression_for(ast_function, context)
+        
+        # Extract underlying operand for cells
+        real_operand = operand.is_a?(AST::Cell) ? operand.node : operand
 
-        case operand
+        case real_operand
         when AST::List
-          evaluate_list(operand, arguments, expression, context).evaluate(context)
+          evaluate_list(real_operand, arguments, expression, context).evaluate(context)
         when AST::Hash
-          evaluate_hash(operand, arguments, expression, context).evaluate(context)
+          evaluate_hash(real_operand, arguments, expression, context).evaluate(context)
         else
-          raise Exceptions::InvalidFunctionError.new("Unhandled first argument to #{name}: #{operand}")
+          raise Exceptions::InvalidFunctionError.new("Unhandled first argument to #{name}: #{real_operand}")
         end
       end
 

data/lib/keisan/string_and_group_parser.rb

@@ -9,24 +9,26 @@ module Keisan
     end
 
     class StringPortion < Portion
-      attr_reader :string
+      attr_reader :string, :escaped_string
 
       def initialize(expression, start_index)
         super(start_index)
 
         @string = expression[start_index]
+        @escaped_string = expression[start_index]
         @end_index = start_index + 1
 
         while @end_index < expression.size
           if expression[@end_index] == quote_type
             @string << quote_type
+            @escaped_string << quote_type
             @end_index += 1
             # Successfully parsed the string
             return
           end
 
-          n, c = process_next_character(expression, @end_index)
-          @string << c
+          n, c = get_potentially_escaped_next_character(expression, @end_index)
+          @escaped_string << c
           @end_index += n
         end
 
@@ -44,9 +46,13 @@ module Keisan
       private
 
       # Returns number of processed input characters, and the output character
-      def process_next_character(expression, index)
-        # escape character
-        if expression[index] == "\\"
+      # If a sequence like '\"' is encountered, the first backslash escapes the
+      # second double-quote, and the two characters will act as a one double-quote
+      # character.
+      def get_potentially_escaped_next_character(expression, index)
+        @string << expression[index]
+        if expression[index] == "\\" && index + 1 < expression.size
+          @string << expression[index + 1]
           return [2, escaped_character(expression[index + 1])]
         else
           return [1, expression[index]]
@@ -129,7 +135,7 @@ module Keisan
 
         while index < expression.size
           case expression[index]
-          when STRING_CHARACTER_REGEX, OPEN_GROUP_REGEX, CLOSED_GROUP_REGEX
+          when STRING_CHARACTER_REGEX, OPEN_GROUP_REGEX, CLOSED_GROUP_REGEX, COMMENT_CHARACTER_REGEX
             break
           else
             index += 1
@@ -149,9 +155,40 @@ module Keisan
       end
     end
 
+    class CommentPortion < Portion
+      attr_reader :string
+
+      def initialize(expression, start_index)
+        super(start_index)
+
+        if expression[start_index] != '#'
+          raise Keisan::Exceptions::TokenizingError.new("Comment should start with '#'")
+        else
+          index = start_index + 1
+        end
+
+        while index < expression.size
+          break if expression[index] == "\n"
+          index += 1
+        end
+
+        @end_index = index
+        @string = expression[start_index...end_index]
+      end
+
+      def size
+        string.size
+      end
+
+      def to_s
+        string
+      end
+    end
+
     # An ordered array of "portions", which
     attr_reader :portions, :size
 
+    COMMENT_CHARACTER_REGEX = /[#]/
     STRING_CHARACTER_REGEX = /["']/
     OPEN_GROUP_REGEX = /[\(\{\[]/
     CLOSED_GROUP_REGEX = /[\)\}\]]/
@@ -176,6 +213,11 @@ module Keisan
         when CLOSED_GROUP_REGEX
           raise Keisan::Exceptions::TokenizingError.new("Tokenizing error, unexpected closing brace #{expression[start_index]}")
 
+        when COMMENT_CHARACTER_REGEX
+          portion = CommentPortion.new(expression, index)
+          index += portion.size
+          @portions << portion
+
         else
           portion = OtherPortion.new(expression, index)
           index += portion.size

data/lib/keisan/tokenizer.rb

@@ -24,14 +24,16 @@ module Keisan
     attr_reader :expression, :tokens
 
     def initialize(expression)
-      @expression = self.class.normalize_expression(expression)
+      @expression = expression
 
-      portions = StringAndGroupParser.new(@expression).portions
+      portions = StringAndGroupParser.new(expression).portions.reject do |portion|
+        portion.is_a? StringAndGroupParser::CommentPortion
+      end
 
       @tokens = portions.inject([]) do |tokens, portion|
         case portion
         when StringAndGroupParser::StringPortion
-          tokens << Tokens::String.new(portion.to_s)
+          tokens << Tokens::String.new(portion.escaped_string)
         when StringAndGroupParser::GroupPortion
           tokens << Tokens::Group.new(portion.to_s)
         when StringAndGroupParser::OtherPortion
@@ -43,21 +45,8 @@ module Keisan
       end
     end
 
-    def self.normalize_expression(expression)
-      expression = normalize_line_delimiters(expression)
-      expression = remove_comments(expression)
-    end
-
     private
 
-    def self.normalize_line_delimiters(expression)
-      expression.gsub(/\n/, ";")
-    end
-
-    def self.remove_comments(expression)
-      expression.gsub(/#[^;]*/, "")
-    end
-
     def tokenize!(scan)
       scan.map do |scan_result|
         i = scan_result.find_index {|token| !token.nil?}

data/lib/keisan/version.rb

@@ -1,3 +1,3 @@
 module Keisan
-  VERSION = "0.8.3"
+  VERSION = "0.8.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keisan
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.8
 platform: ruby
 authors:
 - Christopher Locke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-18 00:00:00.000000000 Z
+date: 2021-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmath
@@ -115,9 +115,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -328,7 +328,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: An equation parser and evaluator

data/.travis.yml

@@ -1,9 +0,0 @@
-sudo: false
-language: ruby
-before_install:
-  - gem install bundler
-rvm:
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0