electr 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6be27b7b5efaeb5cb477f1bda270e4d1b95d4fec
-  data.tar.gz: 086e216808aa9e6709ee47ff5a648a3d175779f7
+  metadata.gz: ccc906f3bbacaccdd300849c16843c4088b34b6f
+  data.tar.gz: 6e23419eb9b1435832b10a5f2179930b6e06ca0a
 SHA512:
-  metadata.gz: 9d206038f0b0f77a76fc388c1f152416f623af280a766cb93f67fdf547e200c4ad3d135f6b2db4a2c4ce2e560eb55ef43bd3dde0bc14cf83c534bc3b352c272c
-  data.tar.gz: 3877f48e19951b1b2cb78b4fa0b3ef9197b16229246e63a18e1aefa575b054cade8fd5497815beb237204c5624e58a00a39fcf417d1725743b3747f0eff4adc4
+  metadata.gz: 96d87d01a204d8437fc511155240ba7f4cf2fc775c2ab16ff6f293cecadbd5805eb37ab97caa5c9e801cade75af14e981f7d2ebd85c3e63eac5723d59259ab0b
+  data.tar.gz: c884b9a67e9b481abc08541983ff8ca272ab2a54003e961755596375f4ceba4a6814ac46acd3874aa98802775d9649ab3513957b7201a92589973b76c009b6b0

data/CHANGELOG.md

@@ -2,16 +2,39 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+
 ## [Unreleased] - unreleased
+
+## [0.0.4] - 2015-09-09
+### Added
+- Exponent operator: ^
+- New functions: sin, cos and tan
+- Using the [readline library][readline]
+- There's now a branch «development» on Github
+[readline]: https://cnswww.cns.cwru.edu/php/chet/readline/rltop.html
+
+### Modified
+- In order to use the readline library the license of Electr switch from
+  MIT to [Apache 2.0][apache2]
+[apache2]: http://www.apache.org/licenses/LICENSE-2.0
+
+### Fixed
+- Temporarily limits function's arity to one. This fixes some minor bugs in
+  the AST.
+
+
+## [0.0.3] - 2015-09-07
 ### Added
 - Quit gracefuly with Ctrl-C
 - 10,000 and 10_000 are the same as 10000
 - Electr supports negative numbers
 - Coco, a code coverage tool as a developer dependency
 - Enable Travis Continuous Integration tool
+
 ### Modified
 - One can write floating point number without a leading zero (ie `.678`).
 
+
 ## [0.0.2] - 2015-09-04
 ### Added
 - Basic Read-Eval-Print-Loop as a proof of concept. It recognizes some

data/LICENSE.txt

@@ -1,22 +1,13 @@
-Copyright (c) 2015 lkdjiin
+Copyright 2015 Xavier Nayrac
 
-MIT License
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+     http://www.apache.org/licenses/LICENSE-2.0
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,7 +1,9 @@
-# Electr [![Gem Version](https://badge.fury.io/rb/electr.png)](http://badge.fury.io/rb/electr)
+# Electr [![Gem Version](https://badge.fury.io/rb/electr.png)](http://badge.fury.io/rb/electr) [![Build Status](https://travis-ci.org/lkdjiin/electr.png)](https://travis-ci.org/lkdjiin/electr)
 
 Interactive language for electronic formulas.
 
+What's new? Take a look at [CHANGELOG.md](CHANGELOG.md).
+
 ## Rationale
 
 - I have not found an open source language or calculator at the command line,
@@ -119,12 +121,12 @@ next couple of days/weeks:
 - [x] Negative numbers
 - [x] Floating point number without a leading zero (ie `.678`)
 - [x] 10_000 or 10,000 will be the same as 10000
+- [x] More builtin functions (sin, cos, tan)
+- [x] Exponent
+- [x] Readline lib in the REPL for a better user experience
 - [ ] `*` for the multiplication if one want to
 - [ ] √ for an alternative to square root
-- [ ] More builtin functions (sin, cos, tan, etc)
-- [ ] Exponent
 - [ ] Shortcuts for function's names (ie sq and sqr for sqrt)
-- [ ] Readline lib in the REPL for a better user experience
 - [ ] All units and prefix used in electronic
 
 ## What's next?
@@ -193,3 +195,7 @@ Frink is closed source, so it doesn't meet my requirements. GNU Units is
 awesome and close to what I want but it's so huge and not at all specialized!
 I want to deal with ohms, farads, volts, etc and not with kilograms nor with
 furlongs ;)
+
+## License
+
+[Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0)

data/lib/electr.rb

@@ -1,4 +1,5 @@
 require "optparse"
+require "readline"
 
 require "electr/version"
 require "electr/exceptions"
@@ -12,15 +13,21 @@ module Electr
 
   UNARY_MINUS_INTERNAL_SYMBOL = '€'
 
+  ONE_CHAR_OPERATORS = %w( + - / ^ )
+
   # f - function
   SYMBOL_TABLE = {
     'sqrt' => 'f',
+    'sin' => 'f',
+    'cos' => 'f',
+    'tan' => 'f',
   }
 
   PRECEDENCE = {
-    '()' => {assoc: 'L', val: 99},
-    ')'  => {assoc: 'L', val: 99},
-    '('  => {assoc: 'L', val: 99},
+    '()' => {assoc: 'L', val: 100},
+    ')'  => {assoc: 'L', val: 100},
+    '('  => {assoc: 'L', val: 100},
+    '^'  => {assoc: 'L', val: 90},
     UNARY_MINUS_INTERNAL_SYMBOL => {assoc: 'R', val: 80},
     '*'  => {assoc: 'L', val: 10},
     '/'  => {assoc: 'L', val: 10},

data/lib/electr/ast/ast.rb

@@ -13,7 +13,7 @@ module Electr
       @value = nil
     end
 
-    attr_reader :value, :name
+    attr_reader :value, :name, :children
 
     # Public: Add a child node to the end of the children's list.
     #

data/lib/electr/parser/rules/expression_rule.rb

@@ -72,8 +72,13 @@ module Electr
     end
 
     def there_is_room?(node)
-      (node.value == UNARY_MINUS_INTERNAL_SYMBOL && node.size < 1) ||
-      (node.value != UNARY_MINUS_INTERNAL_SYMBOL && node.size < 2)
+      case node.name
+      when 'funcargs'
+        node.size < 1
+      else
+        (node.value == UNARY_MINUS_INTERNAL_SYMBOL && node.size < 1) ||
+        (node.value != UNARY_MINUS_INTERNAL_SYMBOL && node.size < 2)
+      end
     end
 
   end

data/lib/electr/parser/token.rb

@@ -8,7 +8,7 @@ module Electr
       end
 
       def operator?
-        ['+', '-', '/', UNARY_MINUS_INTERNAL_SYMBOL].include?(self)
+        [*ONE_CHAR_OPERATORS, UNARY_MINUS_INTERNAL_SYMBOL].include?(self)
       end
 
       def constant?

data/lib/electr/parser/tokenizer.rb

@@ -12,8 +12,6 @@ module Electr
   # - `)`
   class Tokenizer
 
-    ONE_CHAR_SYMBOLS = %w( + - / )
-
     # Create a new Tokenizer for a specific code.
     #
     # string - The String code to tokenize.
@@ -59,7 +57,7 @@ module Electr
         get_number
       elsif unary_minus?
         get_unary_minus
-      elsif ONE_CHAR_SYMBOLS.include?(@look_ahead)
+      elsif ONE_CHAR_OPERATORS.include?(@look_ahead)
         add_this_char
       elsif @look_ahead == '('
         add_this_char

data/lib/electr/repl.rb

@@ -1,4 +1,5 @@
 require "electr/repl/evaluator"
+require "electr/repl/eval_function"
 require "electr/repl/nil_evaluator"
 require "electr/repl/base_reader"
 require "electr/repl/reader"

data/lib/electr/repl/ast_reader.rb

@@ -4,13 +4,13 @@ module Electr
   # computation.
   class ASTReader < BaseReader
 
-    def initialize
-      super("E--ast> ")
+    def initialize(readline_lib = Readline)
+      super("E--ast> ", readline_lib)
     end
 
     def run
-      prompt
-      Compiler.compile_to_ast(STDIN.gets.chomp)
+      line = @readline.readline(@prompt, true)
+      Compiler.compile_to_ast(line)
     end
 
   end

data/lib/electr/repl/base_reader.rb

@@ -2,22 +2,23 @@ module Electr
 
   # Responsible of the terminal interface, that is printing the prompt
   # and reading a line of code (I know, I know, there is an «and» in the
-  # description…).
+  # description…). This is a base class intended for inheritance.
   class BaseReader
 
-    def initialize(prompt = "No prompt defined> ")
+    # Creates a new BaseReader.
+    #
+    # prompt       - String prompt to be displayed to the user.
+    # readline_lib - The app should always use Readline, but injected
+    #                the Module here could ease the tests…
+    def initialize(prompt = "No prompt defined> ",
+                   readline_lib = Readline)
       @prompt = prompt
+      @readline = readline_lib
     end
 
     def run
       raise(NotImplementedError)
     end
 
-    private
-
-    def prompt
-      print(@prompt)
-    end
-
   end
 end

data/lib/electr/repl/eval_function.rb

@@ -0,0 +1,23 @@
+module Electr
+
+  module EvalFunction
+
+    def self.eval(function_name, stack)
+      case function_name
+      when "sqrt"
+        a = stack.pop
+        stack.push(Math::sqrt(a))
+      when "sin"
+        a = stack.pop
+        stack.push(Math::sin(a))
+      when "cos"
+        a = stack.pop
+        stack.push(Math::cos(a))
+      when "tan"
+        a = stack.pop
+        stack.push(Math::tan(a))
+      end
+    end
+
+  end
+end

data/lib/electr/repl/evaluator.rb

@@ -14,7 +14,7 @@ module Electr
         when "constant" then @stack.push(constant(item.value))
         when "value" then do_value(item.value)
         when "operator" then operation(item.value)
-        when "funcname" then func(item.value)
+        when "funcname" then EvalFunction.eval(item.value, @stack)
         end
       end
 
@@ -29,14 +29,6 @@ module Electr
       end
     end
 
-    def func(name)
-      case name
-      when "sqrt"
-        a = @stack.pop
-        @stack.push(Math::sqrt(a))
-      end
-    end
-
     def operation(operand)
       if operand == UNARY_MINUS_INTERNAL_SYMBOL
         unary_minus
@@ -51,6 +43,7 @@ module Electr
     end
 
     def classic_operation(operand)
+      operand = "**" if operand == '^'
       a = @stack.pop
       b = @stack.pop
       @stack.push(a.send(operand, b))

data/lib/electr/repl/reader.rb

@@ -3,13 +3,13 @@ module Electr
   # Normal reader for the REPL.
   class Reader < BaseReader
 
-    def initialize
-      super("E> ")
+    def initialize(readline_lib = Readline)
+      super("E> ", readline_lib)
     end
 
     def run
-      prompt
-      Compiler.compile_to_pn(STDIN.gets.chomp)
+      line = @readline.readline(@prompt, true)
+      Compiler.compile_to_pn(line)
     end
 
   end

data/lib/electr/version.rb

@@ -1,3 +1,3 @@
 module Electr
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/compiler_spec.rb

@@ -26,15 +26,44 @@ describe Compiler do
     end
   end
 
-  specify do
-    result = Compiler.compile_to_ast("-pi 2")
-    result.display
-    expect(result).to be_a AST
-  end
-
   specify "#compile_to_pn" do
     result = Compiler.compile_to_pn("2 pi")
     expect(result).to be_a Array
   end
 
+  describe "Bug in the AST with `sin(pi / 2) + 1`" do
+
+    # I want the AST as follow:
+    #
+    # $ electr --ast -e "sin(2) + 1"
+    # ast
+    #   root
+    #     operator (+)
+    #       func
+    #         funcname ::= sin
+    #         funcargs
+    #           numeric ::= 2
+    #       numeric ::= 1
+    #
+    # and not as follow (this is the bug result):
+    #
+    # $ electr --ast -e "sin(2) + 1"
+    # ast
+    #   root
+    #     operator (+)
+    #       func
+    #         funcname ::= sin
+    #         funcargs
+    #           numeric ::= 2
+    #           numeric ::= 1
+    specify "sin(pi / 2) + 1" do
+      result = Compiler.compile_to_ast("sin(pi / 2) + 1")
+      operator = result.children[0].children[0]
+      expect(operator.size).to eq 2
+      funcargs = operator.children[0].children[1]
+      expect(funcargs.size).to eq 1
+    end
+
+  end
+
 end

data/spec/parser/tokenizer_spec.rb

@@ -188,4 +188,11 @@ describe Tokenizer do
     expect(tkr.next_token).to eq "11,000"
   end
 
+  specify "10 ^ 2" do
+    tkr = Tokenizer.new("10 ^ 2")
+    expect(tkr.next_token).to eq "10"
+    expect(tkr.next_token).to eq "^"
+    expect(tkr.next_token).to eq "2"
+  end
+
 end

data/spec/repl/ast_reader_spec.rb

@@ -2,13 +2,19 @@ require 'spec_helper'
 
 include Electr
 
+class TestReadline
+  def self.readline(a, b)
+    print a
+    "2 3"
+  end
+end
+
 describe ASTReader do
 
   describe ".run" do
 
     it 'prompts' do
-      allow(STDIN).to receive(:gets).and_return("2 3\n")
-      reader = ASTReader.new
+      reader = ASTReader.new(TestReadline)
 
       expect { reader.run }.to output("E--ast> ").to_stdout
     end

data/spec/repl/evaluator_spec.rb

@@ -30,6 +30,10 @@ describe Evaluator do
     {code: "2 -pi", result: -(2 * Math::PI)},
     {code: "1 - 1 + 4 - 1 - 1", result: 2},
     {code: "-(2 3)", result: -6},
+    {code: "11,000 + 22_000", result: 33_000},
+    {code: "sin(pi / 2) + 1", result: 2},
+    {code: "cos(0) - 1", result: 0},
+    {code: "tan(0) - 1", result: -1},
   ]
 
   specify "#evaluate_pn" do
@@ -44,12 +48,12 @@ describe Evaluator do
   end
 
   specify do
-    pns = Compiler.compile_to_pn("11,000 + 22_000")
+    pns = Compiler.compile_to_pn("10 ^ 2")
     
     evaluator = Evaluator.new
     result = evaluator.evaluate_pn(pns)
 
-    expect(result).to eq 33_000
+    expect(result).to eq 100
   end
 
 

data/spec/repl/reader_spec.rb

@@ -2,15 +2,18 @@ require 'spec_helper'
 
 include Electr
 
+class TestReadline
+  def self.readline(a, b)
+    print a
+    "2 3"
+  end
+end
+
 describe Reader do
 
   describe ".run" do
 
-    before do
-      allow(STDIN).to receive(:gets).and_return("2 3\n")
-    end
-
-    let(:reader) { Reader.new }
+    let(:reader) { Reader.new(TestReadline) }
 
     it 'compiles the expression from STDIN' do
       expect(reader.run.first.name).to eq 'ast'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: electr
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - lkdjiin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-07 00:00:00.000000000 Z
+date: 2015-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,6 +117,7 @@ files:
 - lib/electr/repl/ast_printer.rb
 - lib/electr/repl/ast_reader.rb
 - lib/electr/repl/base_reader.rb
+- lib/electr/repl/eval_function.rb
 - lib/electr/repl/evaluator.rb
 - lib/electr/repl/nil_evaluator.rb
 - lib/electr/repl/printer.rb