functio 0.1.0

data/features/function_list.feature

@@ -0,0 +1,35 @@
+Feature: Function list
+  In order to know what functions are available
+  As a User
+  I want to list my functions
+
+  Scenario: No functions available
+    Given I have no functions
+    When I successfully run `fn list`
+    Then the output should not contain anything
+
+  Scenario: One function created
+    Given I have the function:
+    | name    | definition                |
+    | product | multiplier * multiplicand |
+    When I run `fn list`
+    Then it should pass with:
+    """
+    product <multiplier> <multiplicand>
+    """
+
+  Scenario: More functions available
+    Given I have the functions:
+    | name       | definition                |
+    | sum        | augend + addend           |
+    | difference | minuend - subtrahend      |
+    | product    | multiplier * multiplicand |
+    | quotient   | dividend / divisor        |
+    When I run `fn list`
+    Then it should pass with:
+    """
+    sum <augend> <addend>
+    difference <minuend> <subtrahend>
+    product <multiplier> <multiplicand>
+    quotient <dividend> <divisor>
+    """

data/features/function_use.feature

@@ -0,0 +1,56 @@
+Feature: Function use
+  In order to do my recurrent calculations quickly
+  As a User
+  I want to use previously created functions
+
+  Scenario Outline: Successful use of an available function
+    Given I have the function:
+    | name | definition |
+    | add  | a + b      |
+    When I run `fn use add <a> <b>`
+    Then it should pass with:
+    """
+    <result>
+    """
+    Examples:
+    | a    | b   | result |
+    | 1    | 2   | 3      |
+    | -1   | 2   | 1      |
+    | 0    | 0   | 0      |
+    | 3    | -1  | 2      |
+    | 3    | 2.5 | 5.5    |
+    | 40.5 | 1.5 | 42     |
+
+  Scenario Outline: Wrong number of function arguments
+    Given I have the function:
+    | name | definition |
+    | add  | a + b      |
+    When I run `fn use add <args>`
+    Then it should fail with:
+    """
+    Error: no value provided for some parameters
+    """
+    Examples:
+    | args |
+    |      |
+    | 1    |
+
+  Scenario: Inexistent function
+    Given I have the function:
+    | name | definition |
+    | add  | a + b      |
+    When I run `fn use subtract 2 1`
+    Then it should fail with:
+    """
+    Error: function 'subtract' doesn't exist
+    """
+
+  Scenario: Runtime function calculation error
+    Given I have the function:
+    | name   | definition |
+    | divide | a / b      |
+    When I run `fn use divide 1 0`
+    Then it should fail with:
+    """
+    Error: division by zero
+    """

data/features/help_option.feature

@@ -0,0 +1,13 @@
+Feature: Help option
+  In order to learn how to use Functio
+  As a User
+  I want a help option that shows Functio usage
+
+  Scenario Outline: Run with help option
+    When I successfully run `<command>`
+    Then the output should contain "Functio commands"
+    Examples:
+    | command   |
+    | fn        |
+    | fn --help |
+    | fn help   |

data/features/step_definitions/steps.rb

@@ -0,0 +1,36 @@
+#--
+# 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/>.
+#++
+
+Given(/^I have no functions$/) do
+  FileUtils.remove_dir(data_dir, true)
+end
+
+Given(/^I have the functions?:$/) do |table|
+  FileUtils.remove_dir(data_dir, true)
+  table.symbolic_hashes.each do |function_args|
+    function_repo.add(Function.build(function_args))
+  end
+end
+
+Then(/^the following functions? should be available:$/) do |table|
+  functions = table.symbolic_hashes.map do |function_args|
+    Function.build(function_args)
+  end
+  assert_equal(functions, function_repo.all)
+end

data/features/support/env.rb

@@ -0,0 +1,41 @@
+#--
+# 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 'aruba/cucumber'
+require 'fileutils'
+require 'functio/function'
+
+include Functio
+
+# Configure Aruba to set $HOME environment variable to ./tmp/aruba
+Aruba.configure do |config|
+  config.home_directory = File.join(config.root_directory,
+                                    config.working_directory)
+end
+
+# ENV['HOME'] for Cucumber steps must be set too because Cucumber steps runs in
+# another process.
+Before do
+  @real_home = ENV['HOME']
+  ENV['HOME'] = Aruba.config.home_directory
+end
+
+After do
+  ENV['HOME'] = @real_home
+end

data/features/support/functio_world.rb

@@ -0,0 +1,45 @@
+#--
+# 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 'minitest/spec'
+require 'functio/function_repository'
+
+# Custom Cucumber World with Minitest assertions and Functio objects.
+class FunctioWorld
+  include Minitest::Assertions
+  include Functio
+
+  attr_accessor :assertions # :nodoc:
+
+  def initialize # :nodoc:
+    self.assertions = 0
+  end
+
+  def data_dir # :nodoc:
+    function_repo.storage.data_dir
+  end
+
+  def function_repo # :nodoc:
+    @function_repo ||= FunctionRepository.new
+  end
+end
+
+World do
+  FunctioWorld.new
+end

data/features/version_option.feature

@@ -0,0 +1,19 @@
+Feature: Version option
+  In order to know the current version of Functio
+  As a User
+  I want an option to show current Functio version
+
+  Scenario Outline: Run with version option
+    When I successfully run `<command>`
+    Then the output should match:
+    """
+    Functio \d+\.\d+\.\d+
+    Copyright \(C\) 2016 Cassiano Rocha Kuplich
+    License GPLv3\+: GNU GPL version 3 or later \<http://gnu.org/licenses/gpl\.html\>\.
+    This is free software: you are free to change and redistribute it\.
+    There is NO WARRANTY, to the extent permitted by law\.
+    """
+    Examples:
+    | command      |
+    | fn --version |
+    | fn version   |

data/functio.gemspec

@@ -0,0 +1,43 @@
+#--
+# 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_relative 'lib/functio/version'
+
+Gem::Specification.new do |s|
+  s.name = 'functio'
+  s.version = Functio::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 2.1.9'
+  s.summary = 'Turn your recurrent calculations into functions'
+  s.description = <<-EOS
+Functio is a calculator that allows you to create and manage functions for your
+recurrent calculations.
+EOS
+  s.author = 'Cassiano Kuplich'
+  s.email = 'crkuplich@openmailbox.org'
+  s.homepage = 'https://gitlab.com/functio/functio'
+  s.license = 'GPL-3.0+'
+
+  s.files = `git ls-files -z`.split("\0")
+  s.executables << 'fn'
+
+  s.add_runtime_dependency 'dentaku', '~> 2.0', '>= 2.0.7'
+  s.add_runtime_dependency 'thor', '~> 0.19'
+  s.add_development_dependency 'bundler', '~> 1.11'
+end

data/lib/functio.rb

@@ -0,0 +1,24 @@
+#--
+# 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/>.
+#++
+# Functio is a calculator that allows you to create and manage functions for
+# your recurrent calculations.
+module Functio
+end
+
+require 'functio/functio_cli'

data/lib/functio/data_storage.rb

@@ -0,0 +1,90 @@
+#--
+# 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 'csv'
+require 'fileutils'
+
+module Functio
+  # Manages data storage. DataStorage handles each record data as a Hash, so it
+  # expects Hashes when stores data and returns Hashes when retrieves data.
+  class DataStorage
+    # Directory path of data file.
+    attr_reader :data_dir
+
+    # Path of data file.
+    attr_reader :data_file
+
+    def initialize # :nodoc:
+      @data_dir = File.join(ENV['HOME'], '.functio')
+      @data_file = File.join(data_dir, 'functions.csv')
+    end
+
+    # Stores a +record+ Hash. The keys of +record+ Hash are the field names and
+    # the values are the field values.
+    def store(record)
+      FileUtils.mkdir_p(data_dir)
+      CSV.open(data_file, 'a') do |csv|
+        csv.seek(0, IO::SEEK_END)
+        csv << record.keys if csv.pos == 0
+        csv << record.values
+      end
+    end
+
+    # Finds a record that matches exactly the +fields+ Hash passed. The keys of
+    # +fields+ Hash are the field names and the values are the field values to
+    # match exactly with the record searched for.
+    def find(fields)
+      found = table.find { |row| row_matches?(row, fields) }
+      found.to_h if found
+    end
+
+    # Returns all stored records as an Array of Hashes. Each Hash is a record.
+    def all
+      table.map(&:to_h)
+    end
+
+    # Deletes a record that matches exactly the +fields+ passed in. See
+    # DataStorage#find for +fields+ Hash description. Returns +true+ if the
+    # record matching +fields+ is deleted successfully or +false+ otherwise.
+    def delete(fields)
+      tbl = table
+      row_idx = tbl.find_index { |row| row_matches?(row, fields) }
+      return false unless row_idx
+      tbl.delete(row_idx)
+      if tbl.empty?
+        FileUtils.remove_dir(data_dir, true)
+      else
+        File.open(data_file, 'w') { |f| f.write(tbl.to_csv) }
+      end
+      true
+    end
+
+    private
+
+    def table
+      CSV.table(data_file)
+    rescue SystemCallError
+      CSV::Table.new([])
+    end
+
+    def row_matches?(row, fields)
+      row.fields(*fields.keys) == fields.values
+    end
+  end
+end

data/lib/functio/errors.rb

@@ -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/>.
+#++
+
+module Functio
+  # Base exception class for Functio errors.
+  class FunctioError < StandardError
+    # Original exception.
+    attr_reader :original
+
+    # Constructs a new FunctioError instance passing in a +message+ and
+    # optionally the +original+ exception which caused this.
+    def initialize(message = nil, original = $ERROR_INFO)
+      super(message)
+      @original = original
+    end
+  end
+
+  # Indicates that a function is invalid.
+  class InvalidFunctionError < FunctioError; end
+
+  # Indicates that an expression is invalid.
+  class InvalidExpressionError < FunctioError; end
+
+  # Indicates a division by zero.
+  class DivisionByZeroError < FunctioError
+    # Constructs a DivisionByZeroError instance passing in a +message+.
+    def initialize(message = 'division by zero')
+      super(message)
+    end
+  end
+end