electr 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccc906f3bbacaccdd300849c16843c4088b34b6f
-  data.tar.gz: 6e23419eb9b1435832b10a5f2179930b6e06ca0a
+  metadata.gz: 86d47b60ef5f815792290a73257593f50f6819a1
+  data.tar.gz: 638a91fb8edea30cf2c782a972c21591efea09f8
 SHA512:
-  metadata.gz: 96d87d01a204d8437fc511155240ba7f4cf2fc775c2ab16ff6f293cecadbd5805eb37ab97caa5c9e801cade75af14e981f7d2ebd85c3e63eac5723d59259ab0b
-  data.tar.gz: c884b9a67e9b481abc08541983ff8ca272ab2a54003e961755596375f4ceba4a6814ac46acd3874aa98802775d9649ab3513957b7201a92589973b76c009b6b0
+  metadata.gz: abdf7b5b3f6282134294825cfeeb277d5d2116573f90aa50e1fb4e836ca9b9d99dcee00fccee571225631f83a3e86e856f70c9a091151edcd304355c8b391354
+  data.tar.gz: 745e6f0654ab7fea487954ebd0f7443ac18471f89a084f7dca7860c2d332c6276b8d794899c96f951fe9b5b3f0fc3ebdedb077d45c681d43b044cd90ff2c07e8

data/CHANGELOG.md

@@ -5,6 +5,17 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased] - unreleased
 
+## [0.0.5] - 2015-09-28
+### Added
+- All units and prefix used in electronic (sort of)
+- One can use * for a multiplication as well as no symbol
+- √ as an alias of sqrt
+- The version now has a codename. The current one is «Units»
+
+### Fixed
+- A bug where some illegal tokens produced an infinite loop
+
+
 ## [0.0.4] - 2015-09-09
 ### Added
 - Exponent operator: ^

data/README.md

@@ -95,22 +95,43 @@ is in Hertz.
     E> 1 / (2 pi 0.5uF sqrt(11k 22k))
     20.4617344581
 
-### Units
-
-Currently Electr knows the following units:
-
-Prefix and/or Symbol  | Name
-:-------------------: | -----
-k K kΩ                | kilo ohm
-Ω R                   | ohm
-A                     | ampere
-V                     | volt
-W                     | watt
-mA                    | milli ampere
-mV                    | milli volt
-mW                    | milli watt
-μ u μF uF             | micro farad
-p pF                  | pico farad
+### Units, Prefixes and Abbreviations
+
+Electr knows the following units:
+
+Symbol  | Name
+:-----: | -----
+A       | ampere
+Ω R     | ohm
+V       | volt
+W       | watt
+F       | farad
+Hz      | hertz
+C       | coulomb
+S ℧     | siemens
+H       | henry
+
+Units can be combined with the following prefixes:
+
+Symbol  | Name
+:-----: | -----
+k       | kilo
+M       | mega
+G       | giga
+T       | tera
+m       | milli
+μ u     | micro
+n       | nano
+p       | pico
+
+There is also the following abbreviations:
+
+Symbol  | Name
+:-----: | -----
+u μ     | micro farad
+n       | nano farad
+p       | pico farad
+k K     | kilo ohm
 
 ### What is missing?
 
@@ -124,10 +145,10 @@ next couple of days/weeks:
 - [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
+- [x] All units and prefix used in electronic
+- [x] `*` for the multiplication if one want to
+- [x] √ for an alternative to square root
 - [ ] Shortcuts for function's names (ie sq and sqr for sqrt)
-- [ ] All units and prefix used in electronic
 
 ## What's next?
 

data/documentation/precedence.md

@@ -4,5 +4,7 @@ Precedence Table
 Operator  | Description                 | Associativity
 :-------: | -------------               | --------------
 ()        | Function call               | Left
+^         | Exponent                    | Left
+-         | Unary minus                 | Right
 * /       | Multiplication and division | Left
 + -       | Addition and substraction   | Left

data/lib/electr.rb

@@ -13,11 +13,12 @@ module Electr
 
   UNARY_MINUS_INTERNAL_SYMBOL = '€'
 
-  ONE_CHAR_OPERATORS = %w( + - / ^ )
+  ONE_CHAR_OPERATORS = %w( + - * / ^ )
 
   # f - function
   SYMBOL_TABLE = {
     'sqrt' => 'f',
+    '√' => 'f',
     'sin' => 'f',
     'cos' => 'f',
     'tan' => 'f',
@@ -35,4 +36,14 @@ module Electr
     '+'  => {assoc: 'L', val:  1},
   }
 
+  UNITS = %w( A Hz W C V F R Ω S ℧ H )
+
+  PREFIXES = %w( k M G T m μ u n p )
+
+  # u μ - micro farad
+  # n   - nano farad
+  # p   - pico farad
+  # k K - kilo ohm
+  ABBREVIATIONS = %w( u μ n p k K )
+
 end

data/lib/electr/option.rb

@@ -61,7 +61,7 @@ module Electr
     private
 
     def print_version
-      puts "Electr version #{VERSION}"
+      puts "Electr version #{VERSION} (codename «#{CODENAME}»)"
       exit
     end
 

data/lib/electr/parser.rb

@@ -2,6 +2,7 @@ require "electr/parser/tokenizer"
 require "electr/parser/token"
 require "electr/parser/lexer"
 require "electr/parser/lexical_unit"
+require "electr/parser/value"
 require "electr/parser/rules"
 require "electr/parser/syntaxer"
 require "electr/parser/sya"

data/lib/electr/parser/lexical_unit.rb

@@ -19,7 +19,7 @@ module Electr
     def self.numeric(value)     ; new(:numeric, value)          ; end
     def self.operator(value)    ; new(:operator, value)         ; end
     def self.constant(value)    ; new(:constant, value)         ; end
-    def self.value(value)       ; new(:value, value)            ; end
+    def self.value(value)       ; new(:value, Value.assert(value)) ; end
     def self.name(value)        ; new(:name, value)             ; end
     def self.fname(value)       ; new(:fname, value)            ; end
     def self.fcall(value)       ; new(:fcall, value)            ; end

data/lib/electr/parser/token.rb

@@ -17,7 +17,7 @@ module Electr
 
       def value?
         # The unit part is redondant with Tokenizer.
-        self =~ /[0-9.][kKRuFpΩμAmWV]{1,}\Z/
+        self =~ /[0-9.][A-Za-zΩ℧μ]{1,}\Z/
       end
 
     end

data/lib/electr/parser/tokenizer.rb

@@ -94,13 +94,16 @@ module Electr
       add_look_ahead if @look_ahead == '-'
       add_look_ahead while @look_ahead =~ /[0-9._,]/
       if @token[-1] != '.'
-        add_look_ahead while @look_ahead =~ /[kKRuFpΩμAmWV]/
+        add_look_ahead while @look_ahead =~ /[A-Za-zΩ℧μ]/
       end
       @token
     end
 
     def get_word
-      add_look_ahead while @look_ahead =~ /\w/
+      add_look_ahead while @look_ahead =~ /[\w√]/
+      # At this step, an empty token signify that we have reached an
+      # illegal word.
+      raise(SyntaxError, @codeline) if @token.empty?
       @token
     end
 

data/lib/electr/parser/value.rb

@@ -0,0 +1,64 @@
+module Electr
+
+  class LexicalUnit::Value
+
+    def self.assert(value)
+      new(value).assert
+    end
+
+    def initialize(value)
+      @value = value
+      @unit = nil
+      @prefix = nil
+      @abbreviation = false
+      find_unit_attributes
+    end
+
+    def assert
+      if good_unit?
+        @value
+      else
+        raise(SyntaxError, "Unknow unit: #@unit in #@value")
+      end
+    end
+
+    private
+
+    def find_unit_attributes
+      find_unit
+      maybe_split_unit
+    end
+
+    def find_unit
+      index = 0
+      index += 1 while @value[index] =~ /[0-9._,-]/
+      @unit = @value[index..-1]
+    end
+
+    def maybe_split_unit
+      if abbreviation?
+        @abbreviation = true
+      elsif prefix?
+        fill_prefix_and_unit
+      end
+    end
+
+    def abbreviation?
+      @unit.size == 1 && ABBREVIATIONS.include?(@unit)
+    end
+
+    def prefix?
+      PREFIXES.include?(@unit[0])
+    end
+
+    def fill_prefix_and_unit
+      @prefix = @unit[0]
+      @unit = @unit[1..-1]
+    end
+
+    def good_unit?
+      @abbreviation || UNITS.include?(@unit)
+    end
+
+  end
+end

data/lib/electr/repl/eval_function.rb

@@ -4,7 +4,7 @@ module Electr
 
     def self.eval(function_name, stack)
       case function_name
-      when "sqrt"
+      when "sqrt", "√"
         a = stack.pop
         stack.push(Math::sqrt(a))
       when "sin"

data/lib/electr/repl/repl.rb

@@ -3,7 +3,7 @@ module Electr
   # The Read Eval Print Loop starting point.
   class Repl
 
-    BANNER = "\nElectr version #{Electr::VERSION}\n" +
+    BANNER = "\nElectr version #{VERSION} (codename «#{CODENAME}»)\n" +
              "A tiny language for electronic formulas\n\n" +
              "Hit Ctrl+C to quit Electr\n\n"
 

data/lib/electr/version.rb

@@ -1,3 +1,4 @@
 module Electr
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
+  CODENAME = "Units"
 end

data/spec/parser/lexer_spec.rb

@@ -29,4 +29,28 @@ describe Lexer do
     end
   end
 
+  describe "value" do
+
+    it "rejects unknown units" do
+      expect { Lexer.lexify("1P") }.to raise_error(Electr::SyntaxError)
+      expect { Lexer.lexify("1Q") }.to raise_error(Electr::SyntaxError)
+      expect { Lexer.lexify("1X") }.to raise_error(Electr::SyntaxError)
+    end
+
+    it "rejects unknown prefixes" do
+      expect { Lexer.lexify("1bA") }.to raise_error(Electr::SyntaxError)
+      expect { Lexer.lexify("1wW") }.to raise_error(Electr::SyntaxError)
+      expect { Lexer.lexify("1jHz") }.to raise_error(Electr::SyntaxError)
+    end
+
+    it "accepts known units" do
+      expect { Lexer.lexify("1A") }.not_to raise_error
+    end
+
+    it "accepts known prefixes" do
+      expect { Lexer.lexify("1mA") }.not_to raise_error
+    end
+
+  end
+
 end

data/spec/parser/tokenizer_spec.rb

@@ -52,6 +52,13 @@ describe Tokenizer do
     expect(tkr.next_token).to eq "300"
   end
 
+  specify "2 * 3" do
+    tkr = Tokenizer.new("2 * 3")
+    expect(tkr.next_token).to eq "2"
+    expect(tkr.next_token).to eq "*"
+    expect(tkr.next_token).to eq "3"
+  end
+
   specify "2 0.6" do
     tkr = Tokenizer.new("2 0.6")
     expect(tkr.next_token).to eq "2"
@@ -125,6 +132,11 @@ describe Tokenizer do
     expect(tkr.next_token).to eq "sqrt"
   end
 
+  specify "√(49)" do
+    tkr = Tokenizer.new("√(49)")
+    expect(tkr.next_token).to eq "√"
+  end
+
   specify "11K 22k 33kΩ" do
     tkr = Tokenizer.new("11K 22k 33kΩ")
     expect(tkr.next_token).to eq "11K"
@@ -195,4 +207,28 @@ describe Tokenizer do
     expect(tkr.next_token).to eq "2"
   end
 
+  it 'tokenize units and prefixes' do
+    units = %w( A Hz W C V F R Ω S ℧ H )
+    prefixes = %w( k M G T m μ u n p )
+
+    units.each do |unit|
+      tkr = Tokenizer.new("1#{unit}")
+      expect(tkr.next_token).to eq "1" + unit
+    end
+
+    prefixes.each do |prefix|
+      units.each do |unit|
+        tkr = Tokenizer.new("1#{prefix}#{unit}")
+        expect(tkr.next_token).to eq "1" + prefix + unit
+      end
+    end
+  end
+
+  it 'raises on illegal token' do
+    tkr = Tokenizer.new("@")
+    expect {
+      tkr.next_token
+    }.to raise_error(Electr::SyntaxError)
+  end
+
 end

data/spec/parser/value_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+include Electr
+
+describe LexicalUnit::Value do
+
+  describe "assert" do
+
+    it "rejects unknown units" do
+      unknown = %w( 1P 1Q 1X )
+      unknown.each do |unit|
+        expect {
+          LexicalUnit::Value.assert(unit)
+        }.to raise_error(Electr::SyntaxError)
+      end
+    end
+
+    it "asserts valid units" do
+      known = %w( 1V 1C 1S )
+      known.each do |unit|
+        expect { LexicalUnit::Value.assert(unit) }.not_to raise_error
+      end
+    end
+
+    it "rejects unknown prefixes" do
+      unknown = %w( 1xV 1bV 1wW )
+      unknown.each do |unit|
+        expect {
+          LexicalUnit::Value.assert(unit)
+        }.to raise_error(Electr::SyntaxError)
+      end
+    end
+
+    it "accepts valid prefixes" do
+      known = %w( 1mV 1μF 1nF )
+      known.each do |unit|
+        expect { LexicalUnit::Value.assert(unit) }.not_to raise_error
+      end
+    end
+
+    it "accepts unit abbreviations" do
+      abbreviations = %w( 1u 1μ 1n 1p 1k 1K )
+      abbreviations.each do |unit|
+        expect { LexicalUnit::Value.assert(unit) }.not_to raise_error
+      end
+    end
+
+  end
+end

data/spec/repl/evaluator_spec.rb

@@ -34,6 +34,8 @@ describe Evaluator do
     {code: "sin(pi / 2) + 1", result: 2},
     {code: "cos(0) - 1", result: 0},
     {code: "tan(0) - 1", result: -1},
+    {code: "10 ^ 2", result: 100},
+    {code: "√(49)", result: 7},
   ]
 
   specify "#evaluate_pn" do
@@ -48,12 +50,12 @@ describe Evaluator do
   end
 
   specify do
-    pns = Compiler.compile_to_pn("10 ^ 2")
+    pns = Compiler.compile_to_pn("2 * 3")
     
     evaluator = Evaluator.new
     result = evaluator.evaluate_pn(pns)
 
-    expect(result).to eq 100
+    expect(result).to eq 6
   end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: electr
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - lkdjiin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-09 00:00:00.000000000 Z
+date: 2015-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,6 +113,7 @@ files:
 - lib/electr/parser/syntaxer.rb
 - lib/electr/parser/token.rb
 - lib/electr/parser/tokenizer.rb
+- lib/electr/parser/value.rb
 - lib/electr/repl.rb
 - lib/electr/repl/ast_printer.rb
 - lib/electr/repl/ast_reader.rb
@@ -132,6 +133,7 @@ files:
 - spec/parser/pn_spec.rb
 - spec/parser/sya_spec.rb
 - spec/parser/tokenizer_spec.rb
+- spec/parser/value_spec.rb
 - spec/repl/ast_printer_spec.rb
 - spec/repl/ast_reader_spec.rb
 - spec/repl/evaluator_spec.rb
@@ -173,6 +175,7 @@ test_files:
 - spec/parser/pn_spec.rb
 - spec/parser/sya_spec.rb
 - spec/parser/tokenizer_spec.rb
+- spec/parser/value_spec.rb
 - spec/repl/ast_printer_spec.rb
 - spec/repl/ast_reader_spec.rb
 - spec/repl/evaluator_spec.rb