electr 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 129c7c8560ec169ade1a934c574de8a045e3dbc0
+  data.tar.gz: c04ece5fd979bad30c69e5d67b64899b841ac72e
+SHA512:
+  metadata.gz: faee90b0d4a72a8bf8c74c9530c697062e7edde33c6c96b0135d56aa93bda5573e1d78647279b7104622300bab369900f1ffd5d2d2be0b30915af20bc5430b6e
+  data.tar.gz: c04497b5911bb940656a495eaab0232be5394b456baf27c4f1a209a3aa2e86f27630e986b59b2499ba3c417a0bf557305c1f04fbe698a1795f6dc3a6e23fd23f

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+TODO

data/.rspec

@@ -0,0 +1,2 @@
+--order=random
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+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.2] - 2015-09-04
+### Added
+- Basic Read-Eval-Print-Loop as a proof of concept. It recognizes some
+  units but not all
+- Options -v (version), -h (help), --ast (display the AST instead of the
+  result) and -e (compute this expression and quit, do not run
+  interactively)
+- Grammar of Electr (in `grammar.md`)
+- Beginning of documentation for developers
+- Precedence table
+- This change log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in electr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 lkdjiin
+
+MIT License
+
+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:
+
+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.

data/README.md

@@ -0,0 +1,196 @@
+Electr
+======
+
+Interactive language for electronic formulas.
+
+## Rationale
+
+- I have not found an open source language or calculator at the command line,
+specialized in electronic formulas
+- I'm always confused with milli, micro, pico, nano, etc
+- I prefer to type 100k rather than 100000, or 100M rather than 100000000
+- If, for any reason, I want to write 100000000, then I should be able to write
+100_000_000 or 100,000,000
+
+I don't want a big monster but a tiny specialized language.
+
+## What do you think?
+
+I started to write this tiny language. First, a quick prototype in Ruby, as a
+proof of concept. And then, maybe, a more portable version in C.
+
+Tell me what you think on [twitter](https://twitter.com/lkdjiin) or better,
+open an issue here on Github. In any cases feel free to start a discussion.
+
+The current version is an early one:
+
+1. Don't expect too much
+2. Expect a lot of bugs
+3. Please be kind enough to report any bugs here in Github
+
+## Installation
+
+Install it with:
+
+    $ gem install electr
+
+## Examples of what Electr can do right now
+
+### Start Electr
+
+Just type `electr`:
+
+    $ electr
+
+And you'll see the prompt waiting for you:
+
+    E>
+
+To compute an expression without entering the interactive mode, use the `-e`
+switch:
+
+    $ electr -e "3V / 25mA"
+    120
+
+To display the AST instead of doing the computation, use the `--ast` switch
+(*this is intended only for the developers*):
+
+    $ electr --ast -e "3V / 25mA"
+    ast
+      root
+        operator (/)
+          value ::= 3V
+          value ::= 25mA
+
+### Resistors in serie
+
+Start simple to illustrate the addition. We have a 10,000 Ohm resistor (10k) and
+a 200 Ohm resistor (200R):
+
+    E> 10k + 200R
+    10200
+
+*Should it be `K`, `k`, `kΩ` or the three is still open to debate.*
+
+### Ohm's law
+
+Divide Volts (V) by milliamps (mA) to get some Ohms:
+
+    E> 3V / 25mA
+    120
+
+There is no symbol for the multiplication. Simply put values side by side:
+
+    E> 1mA 3k
+    3
+
+### Frequency of an oscillator
+
+A little bit more complex is the computation of a frequency for an oscillator.
+We've got two constants (`2` and `pi`), a value in micro Farad (`0.5uF`) and
+a square root (`sqrt`) of the product of two resistors (`11k 22k`). The result
+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
+
+### What is missing?
+
+Electr is at a very early stage and it miss a lot of (basic) things!
+You can expect that the following features will be implemented in the
+next couple of days/weeks:
+
+[ ] Negative numbers
+[ ] `*` for the multiplication if one want to
+[ ] √ for an alternative to square root
+[ ] Floating point number without a leading zero (ie `.678`)
+[ ] More buitin 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
+[ ] 10_000 or 10,000 will be the same as 10000
+[ ] All units and prefix used in electronic
+
+## What's next?
+
+Maybe Electr could infer the resulting unit:
+
+    E> 10k + 200R
+    10.2kΩ
+    E> 3V / 25mA
+    120Ω
+    E> 3V / 1mA
+    3kΩ
+
+One are less prone to typing errors (less parenthesis) if one enter a complex
+expression on two lines:
+
+    E> 1 /
+    E> 2 pi 0.5uF sq(11K 22K)
+    20.46Hz
+
+### Beyond the calculator
+
+Electr could be more **interactive**. In the following session we've got a
+resistor R1 and two capacitors C1 and C2. Once the formula is entered, Electr
+ask us for the components values, then gives us the result.
+
+    E> 1/
+    E> 2 pi R1 sq(C1 C2)
+    R1=?> 33K
+    C1=?> 1000pF
+    C2=?> 470pF
+    7.04kHz
+
+Or acts like a tiny programming language.
+
+    E> R1 = 33k
+    E> C1 = 1000pF
+    E> C2 = 470pF
+    E> 1 / (2 pi R1 sq(C1 C2))
+    7.04kHz
+
+Why not having custom functions?
+
+    E> func = { 1 / (2 pi R1 sq(C1 C2)) }
+    E> func(R1=33k, C1=1000pF, C2=470pF)
+    7.04kHz
+
+*The above syntax is just one possibility amongst a lot of others.*
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/electr/fork )
+2. **PLEASE Create your feature branch** (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Alternatives
+
+Some people point me to two existing softwares:
+
+- [Frink](https://futureboy.us/frinkdocs/)
+- [GNU Units](https://en.wikipedia.org/wiki/GNU_Units)
+
+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 ;)

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/bin/electr

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require 'electr'
+
+opt = Electr::Option.new
+
+if opt[:expression]
+  if opt[:ast]
+    compiler = Electr::Compiler.new
+    ast = compiler.compile_to_ast(opt[:expression])
+    ast.display
+  else
+    # FIXME Should be under lib/ to be tested and there is a lot of
+    # common code with Repl.
+    compiler = Electr::Compiler.new
+    temp = compiler.compile_to_pn(opt[:expression])
+    evaluator = Electr::Evaluator.new
+    temp = evaluator.evaluate_pn(temp)
+    if temp == temp.truncate
+      puts temp.truncate
+    else
+      puts temp.round(10)
+    end
+  end
+else
+  Electr::Repl.new(opt).run
+end

data/electr.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'electr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "electr"
+  spec.version       = Electr::VERSION
+  spec.authors       = ["lkdjiin"]
+  spec.email         = ["xavier.nayrac@gmail.com"]
+  spec.summary       = %q{Interactive language for electronic formulas}
+  spec.homepage      = "https://github.com/lkdjiin/electr"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.2"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/electr.rb

@@ -0,0 +1,20 @@
+require "optparse"
+
+require "electr/version"
+require "electr/exceptions"
+require "electr/parser"
+require "electr/compiler"
+require "electr/ast"
+require "electr/rules"
+require "electr/evaluator"
+require "electr/repl"
+require "electr/option"
+
+module Electr
+
+  # f - function
+  SYMBOL_TABLE = {
+    'sqrt' => 'f',
+  }
+
+end

data/lib/electr/ast.rb

@@ -0,0 +1,9 @@
+require "electr/ast/ast"
+require "electr/ast/root_ast"
+require "electr/ast/numeric_ast"
+require "electr/ast/constant_ast"
+require "electr/ast/value_ast"
+require "electr/ast/operator_ast"
+require "electr/ast/func_ast"
+require "electr/ast/func_name_ast"
+require "electr/ast/func_args_ast"

data/lib/electr/ast/ast.rb

@@ -0,0 +1,62 @@
+module Electr
+
+  class AST
+
+    def initialize(name)
+      if name
+        @name = name
+      else
+        @name = self.class.name.split('::').last
+      end
+      @children = []
+      @value = nil
+    end
+
+    # Public: Add a child node to the end of the children's list.
+    #
+    # child - An AST node to add to the list of children.
+    #
+    # Returns self.
+    def add_child child
+      @children << child
+      self
+    end
+
+    # Public: Returns True if this node is a leaf.
+    def leaf?
+      @children.empty?
+    end
+
+    def size
+      @children.size
+    end
+
+    def display(indent = 0)
+      print " " * indent + @name
+      if leaf?
+        print " ::= #@value"
+      else
+        print " (#@value)" if @value
+      end
+      puts
+      @children.each {|child| child.display(indent + 2) }
+    end
+
+    def to_pn
+      [* Pn.new(@value, @name)] + @children.map {|child| child.to_pn }.flatten
+    end
+
+  end
+
+  # TODO Pn is not a good name!
+  class Pn
+
+    def initialize(value, name)
+      @value = value
+      @name = name
+    end
+
+    attr_reader :value, :name
+  end
+
+end

data/lib/electr/ast/constant_ast.rb

@@ -0,0 +1,14 @@
+module Electr
+
+  class ConstantAST < AST
+
+    def initialize(value)
+      super("constant")
+      @value = value
+    end
+
+  end
+end
+
+
+