functio 0.1.0

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'rake', '~> 11.1', '>= 11.1.1'
+  gem 'rdoc', '~> 4.1'
+  gem 'rubocop', '~> 0.38.0'
+end
+
+group :test do
+  gem 'cucumber', '~> 2.3'
+  gem 'aruba', '~> 0.14'
+  gem 'minitest', '~> 5.8', '>= 5.8.4'
+  gem 'papers', '~> 2.3'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    functio (0.1.0)
+      dentaku (~> 2.0, >= 2.0.7)
+      thor (~> 0.19)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.14.1)
+      childprocess (~> 0.5.6)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9.10)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
+    ast (2.2.0)
+    builder (3.2.2)
+    childprocess (0.5.9)
+      ffi (~> 1.0, >= 1.0.11)
+    contracts (0.14.0)
+    cucumber (2.3.3)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.4.0)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 3.2.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.4.0)
+      gherkin (~> 3.2.0)
+    cucumber-wire (0.0.1)
+    dentaku (2.0.8)
+    diff-lcs (1.2.5)
+    ffi (1.9.10)
+    gherkin (3.2.0)
+    json (1.8.3)
+    minitest (5.9.0)
+    multi_json (1.12.1)
+    multi_test (0.1.2)
+    papers (2.3.0)
+    parser (2.3.1.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rake (11.1.2)
+    rdoc (4.2.2)
+      json (~> 1.4)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.38.0)
+      parser (>= 2.3.0.6, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    thor (0.19.1)
+    unicode-display_width (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (~> 0.14)
+  bundler (~> 1.11)
+  cucumber (~> 2.3)
+  functio!
+  minitest (~> 5.8, >= 5.8.4)
+  papers (~> 2.3)
+  rake (~> 11.1, >= 11.1.1)
+  rdoc (~> 4.1)
+  rubocop (~> 0.38.0)
+
+BUNDLED WITH
+   1.12.4

data/README.md

@@ -0,0 +1,109 @@
+# Functio - Turn your recurrent calculations into functions
+
+Functio is a calculator that allows you to create and manage functions for your
+recurrent calculations.
+
+## Installation
+
+Functio is written in [Ruby](https://www.ruby-lang.org/) and is packaged with
+[RubyGems](https://rubygems.org/). You need Ruby version 2.1.9 or later
+installed in your system. The recommended way is using [RVM](http://rvm.io/) to
+install and manage Ruby versions.
+
+With Ruby installed, run the following command:
+
+    $ gem install functio
+
+## Usage
+
+Functio provides a set of commands for function management and calculation. Run
+`fn help` or just `fn` to get the list of all Functio commands:
+
+    $ fn help
+
+The following example helps you to get started.
+
+### Example
+
+Suppose you want to know the balance of your savings account for a given period
+in the future. Given that your savings account pays a fixed interest rate per
+month, you can calculate the balance using the compound interest formula:
+
+    principal * (1 + interest) ^ period
+
+    where:
+      principal is the principal sum
+      interest is the interest rate
+      period is the length of time
+
+This formula is also useful to simulate your other investments. You can use
+Functio to remember this formula for you. First, create a function using the
+compound interest formula:
+
+    $ fn create compInterest 'principal * (1 + interest) ^ period'
+
+The command `create` creates a new function receiving the new function name and
+its definition. In the example above, `compInterest` is the function name and
+`'principal * (1 + interest) ^ period'` is the function definition which is the
+formula for compound interest.
+
+The new `compInterest` function is now available for use. You can see your
+created functions with the command `list`:
+
+    $ fn list
+    > compInterest <principal> <interest> <period>
+
+It also shows the function parameters. In the example above, `<principal>`,
+`<interest>`, and `<period>` are the `compInterest` parameters. Finally, to use
+your new awesome function run the `use` command:
+
+    $ fn use compInterest 2500 0.02 6
+    > 2815.40604816
+
+The command `use` receives the function name and the function parameters in the
+order shown by the `list` command. In the example above, `2500` is the
+`principal`, `0.02` is the `interest`, and `6` is the `period`. You calculated
+the balance of your savings account after 6 months for the amount of 2500 with a
+monthly interest rate of 2%.
+
+If you don't want to use the `compInterest` function anymore and want to delete
+it, run the `delete` command:
+
+    $ fn delete compInterest
+    > Deleted function 'compInterest'
+
+### Quick calculations
+
+Functio also provides the command `eval` for expression evaluation. It can be
+used as a calculator:
+
+    $ fn eval '(80 * 2 + (3 + 1) * 2) / 4'
+    > 42
+
+## Built-in operators and functions
+
+Currently, Functio uses [Dentaku](https://github.com/rubysolo/dentaku) Ruby gem
+for mathematical and logical evaluation and parsing, so Functio's built-in
+operators and functions available are the same provided by Dentaku. See the
+[Dentaku's built-in operators and
+functions](https://github.com/rubysolo/dentaku#built-in-operators-and-functions)
+list.
+
+## Contributing
+
+Bug reports and merge requests are welcome on GitLab at
+https://gitlab.com/functio/functio.
+
+## Functio License
+
+Copyright (C) 2016  Cassiano Rocha Kuplich
+
+Functio is free software: you can redistribute it and/or modify  
+it under the terms of the GNU General Public License as published by  
+the Free Software Foundation, either version 3 of the License, or  
+(at your option) any later version.
+
+Functio is distributed in the hope that it will be useful,  
+but WITHOUT ANY WARRANTY; without even the implied warranty of  
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the  
+[GNU General Public License](COPYING) for more details.

data/Rakefile

@@ -0,0 +1,47 @@
+#--
+# Copyright (C) 2016  Cassiano Rocha Kuplich
+#
+# This file is part of Functio.
+#
+# Functio is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Functio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Functio.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require 'rake/clean'
+require 'rake/testtask'
+
+CLOBBER << 'config/' << 'doc/' << 'tmp/'
+
+desc 'Run acceptance tests'
+task :features do
+  sh 'cucumber'
+end
+
+Rake::TestTask.new(tests: :licenses) do |t|
+  t.description = 'Run unit tests'
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test_*.rb']
+  t.verbose = false
+  t.warning = false
+end
+
+task :licenses do
+  sh 'rm -rf config/'
+  sh 'papers --generate'
+end
+
+desc 'Run all tests'
+task all: [:tests, :features]
+
+desc "Run 'all' task"
+task default: :all

data/bin/fn

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+#--
+# Copyright (C) 2016  Cassiano Rocha Kuplich
+#
+# This file is part of Functio.
+#
+# Functio is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Functio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Functio.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require 'functio'
+
+begin
+  Functio::FunctioCLI.start(ARGV)
+rescue => ex
+  abort ex.message
+end

data/features/expression_evaluation.feature

@@ -0,0 +1,58 @@
+Feature: Expression evaluation
+  In order to know the result of a calculation
+  As a User
+  I want to write a math expression and get its result
+
+  Scenario Outline: Valid math expressions
+    When I run `fn eval '<expression>'`
+    Then it should pass with "<result>"
+    Examples:
+    | expression | result |
+    | 1 + 1      | 2      |
+    | 1 + 2 * 3  | 7      |
+
+  Scenario Outline: Default result format
+    When I run `fn eval '<expression>'`
+    Then it should pass with exactly:
+    """
+    <result>
+    """
+    Examples:
+    | expression            | result               |
+    | 123                   | 123                  |
+    | 12345678901234567890  | 12345678901234567890 |
+    | 3.14                  | 3.14                 |
+    | 123456.78901234567890 | 123456.7890123456789 |
+
+  Scenario Outline: Invalid math expressions
+    When I run `fn eval '<expression>'`
+    Then it should fail with:
+    """
+    Error: invalid expression
+    """
+    Examples:
+    | expression |
+    | (1 + 2     |
+    | 2 * 3)     |
+    | 2 $ 3      |
+    | 2 *        |
+    | 1 2 3      |
+
+  Scenario: Expression with variable
+    When I run `fn eval 'var + 3'`
+    Then it should fail with:
+    """
+    Error: expression can't have variables
+    """
+
+  Scenario Outline: Division by zero
+    When I run `fn eval '<expression>'`
+    Then it should fail with:
+    """
+    Error: division by zero
+    """
+    Examples:
+    | expression  |
+    | 1 / 0       |
+    | 2 / (1 - 1) |
+    | 3 * 2 / 0   |

data/features/function_creation.feature

@@ -0,0 +1,74 @@
+Feature: Function creation
+  In order to do recurrent calculations
+  As a User
+  I want to create custom functions
+
+  Scenario: Valid function creation
+    Given I have no functions
+    When I successfully run `fn create fahr2celsius '(f - 32) * 5 / 9'`
+    Then the output should not contain anything
+    And the following function should be available:
+    | name         | definition       |
+    | fahr2celsius | (f - 32) * 5 / 9 |
+
+  Scenario: Function with the same name of another function
+    Given I have the function:
+    | name | definition |
+    | add  | a + b      |
+    When I run `fn create add 'x + y'`
+    Then it should fail with:
+    """
+    Error: a function 'add' already exists
+    """
+
+  Scenario Outline: Invalid function name
+    Given I have no functions
+    When I run `fn create '<name>' 'x + 1'`
+    Then it should fail with:
+    """
+    Invalid function: name must be alphanumeric and begin with a letter
+    """
+    Examples:
+    | name       |
+    | 1plus      |
+    | x plus one |
+    | x+one      |
+    | plusone!   |
+
+  Scenario: Function name is too long
+    Given I have no functions
+    When I run `fn create abcdefghijklmnopqrstu 'a + b'`
+    Then it should fail with:
+    """
+    Invalid function: name size can't be greater than 20 characters
+    """
+
+  Scenario Outline: Invalid function definition
+    Given I have no functions
+    When I run `fn create myfunction <definition>`
+    Then it should fail with:
+    """
+    Invalid function: definition must be a valid expression
+    """
+    Examples:
+    | definition  |
+    | '1 +'       |
+    | '(a + b'    |
+    | 'a * b)'    |
+    | '# &'       |
+    | '* x'       |
+    | ''          |
+    | ' '         |
+    | '  '        |
+
+  Scenario Outline: Definition with division by zero
+    Given I have no functions
+    When I run `fn create myfunction '<definition>'`
+    Then it should fail with:
+    """
+    Invalid function: division by zero '<definition>'
+    """
+    Examples:
+    | definition  |
+    | a / 0       |
+    | a / (2 - 2) |

data/features/function_deletion.feature

@@ -0,0 +1,37 @@
+Feature: Function deletion
+  In order to remove an unnecessary function
+  As a User
+  I want to delete a function
+
+  Scenario: Available function
+    Given I have the functions:
+    | name     | definition |
+    | add      | a + b      |
+    | multiply | a * b      |
+    When I run `fn delete add`
+    Then it should pass with:
+    """
+    Deleted function 'add'
+    """
+    And the following function should be available:
+    | name     | definition |
+    | multiply | a * b      |
+
+  Scenario: No functions available
+    Given I have no functions
+    When I run `fn delete add`
+    Then it should fail with:
+    """
+    Error: function 'add' doesn't exist
+    """
+
+  Scenario: Function doesn't exist
+    Given I have the functions:
+    | name     | definition |
+    | add      | a + b      |
+    | multiply | a * b      |
+    When I run `fn delete subtract`
+    Then it should fail with:
+    """
+    Error: function 'subtract' doesn't exist
+    """