functio 0.1.0

data/lib/functio/expression.rb

@@ -0,0 +1,61 @@
+#--
+# 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 'dentaku'
+require 'functio/errors'
+
+module Functio
+  # Represents a mathematical expression.
+  class Expression
+    # String representation of Expression instance.
+    attr_reader :expression
+
+    # The calculator instance used for expression evaluation.
+    attr_reader :calculator
+
+    # Constructs an Expression instance passing in an +expression+ String.
+    # Raises InvalidExpressionError if +expression+ is invalid. Raises
+    # DivisionByZeroError if +expression+ contains a division by zero.
+    def initialize(expression)
+      raise RuntimeError if expression.strip.empty?
+      @calculator = Dentaku::Calculator.new
+      calculator.evaluate(expression)
+      @expression = expression
+    rescue Dentaku::ParseError, RuntimeError
+      raise InvalidExpressionError, 'invalid expression'
+    rescue Dentaku::ZeroDivisionError
+      raise DivisionByZeroError
+    end
+
+    # Evaluates the expression passing in its +variables+ in a Hash which keys
+    # are the variables names and values the variables values. Raises
+    # DivisionByZeroError if a division by zero occurs. Returns +nil+ if no
+    # value is provided in +variables+ for some of the expression variables.
+    def evaluate(variables = {})
+      calculator.evaluate(expression, variables)
+    rescue Dentaku::ZeroDivisionError
+      raise DivisionByZeroError
+    end
+
+    # Returns the variables of the expression in an Array of Strings.
+    def variables
+      calculator.dependencies(expression)
+    end
+  end
+end

data/lib/functio/formatted_num.rb

@@ -0,0 +1,39 @@
+#--
+# 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
+  # Represents a number using a default format.
+  class FormattedNum
+    # Creates a FormattedNum instance from a +num_obj+.
+    def initialize(num_obj)
+      @num = num_obj
+    end
+
+    # Converts the FormattedNum to a String. The String is formatted using
+    # conventional floating point notation if the number is a float.
+    def to_s
+      case @num
+      when BigDecimal
+        @num.to_s('F')
+      else
+        @num.to_s
+      end
+    end
+  end
+end

data/lib/functio/functio_cli.rb

@@ -0,0 +1,111 @@
+#--
+# 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 'thor'
+require 'functio/errors'
+require 'functio/expression'
+require 'functio/formatted_num'
+require 'functio/function'
+require 'functio/function_repository'
+require 'functio/version'
+
+module Functio
+  # Functio command-line interface.
+  class FunctioCLI < Thor
+    package_name 'Functio'
+
+    map '--version' => :version
+
+    desc 'version', 'Show Functio version'
+    def version # :nodoc:
+      puts <<-EOS
+Functio #{Functio::VERSION}
+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.
+EOS
+    end
+
+    desc 'eval EXPRESSION', 'Evaluate EXPRESSION and return its result'
+    def eval(expr) # :nodoc:
+      result = Expression.new(expr).evaluate
+      abort "Error: expression can't have variables" unless result
+      puts FormattedNum.new(result)
+    rescue DivisionByZeroError
+      abort 'Error: division by zero'
+    rescue InvalidExpressionError
+      abort 'Error: invalid expression'
+    end
+
+    desc 'create NAME DEF',
+         'Create a function called NAME defined by DEF'
+    def create(name, definition) # :nodoc:
+      function = Function.build(name: name, definition: definition)
+    rescue DivisionByZeroError
+      abort "Invalid function: division by zero '#{definition}'"
+    rescue InvalidFunctionError => ex
+      abort "Invalid function: #{ex.message}"
+    else
+      abort "Error: a function '#{name}' already exists" unless
+        repository.add(function)
+    end
+
+    desc 'list', 'List all functions'
+    def list # :nodoc:
+      puts repository.all.map { |function| function_to_str(function) }
+    end
+
+    desc 'use FUNCTION [ARGS]', 'Use the function FUNCTION with ARGS'
+    def use(function_name, *args) # :nodoc:
+      function = repository.find(function_name)
+      abort "Error: function '#{function_name}' doesn't exist" unless function
+      begin
+        result = function.use(map_function_args(function.params, args))
+        abort 'Error: no value provided for some parameters' unless result
+        puts FormattedNum.new(result)
+      rescue DivisionByZeroError
+        abort 'Error: division by zero'
+      end
+    end
+
+    desc 'delete FUNCTION', 'Delete the function called FUNCTION'
+    def delete(function_name) # :nodoc:
+      if repository.delete(function_name)
+        puts "Deleted function '#{function_name}'"
+      else
+        abort "Error: function '#{function_name}' doesn't exist"
+      end
+    end
+
+    private
+
+    def repository
+      @repository ||= FunctionRepository.new
+    end
+
+    def function_to_str(function)
+      "#{function.name} <#{function.params.join('> <')}>"
+    end
+
+    def map_function_args(params, args)
+      args.map.with_index { |arg, i| [params[i], arg] }.to_h
+    end
+  end
+end

data/lib/functio/function.rb

@@ -0,0 +1,104 @@
+#--
+# 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/errors'
+require 'functio/expression'
+
+module Functio
+  # Represents a function.
+  class Function
+    # Maximum size of the function name.
+    MAX_NAME_SIZE = 20
+
+    # Pattern for valid function name format.
+    NAME_PATTERN = /\A[a-zA-Z][a-zA-Z0-9]*\z/
+
+    # Function name.
+    attr_reader :name
+
+    # Expression instance used for Function definition.
+    attr_reader :expression
+
+    # Builds a new Function instance by Function +attributes+. +attributes+ is a
+    # Hash containing +:name+ and +:definition+. Raises InvalidFunctionError if
+    # some of the +attributes+ are invalid. Raises DivisionByZeroError if
+    # +:definition+ contains a division by zero.
+    def self.build(attributes)
+      expression = Expression.new(attributes[:definition])
+      new(name: attributes[:name], expression: expression)
+    rescue InvalidExpressionError
+      raise InvalidFunctionError, 'definition must be a valid expression'
+    end
+
+    # Constructs a Function instance. The parameter +args+ is a Hash containing
+    # the function +:name+ and an +:expression+ instance.
+    def initialize(args)
+      @name = validate_name(args[:name])
+      @expression = args[:expression]
+    end
+
+    # Function definition.
+    def definition
+      expression.expression
+    end
+
+    # Function attributes.
+    def attributes
+      { name: name, definition: definition }
+    end
+
+    # Returns the function input parameters in an Array of Strings.
+    def params
+      expression.variables
+    end
+
+    # Uses function with +args+ Hash. The keys of +args+ Hash are the input
+    # parameters and the values are the input arguments.
+    def use(args = {})
+      expression.evaluate(args)
+    end
+
+    # Compares equality between Function instances. Returns +true+ if
+    # Function#attributes of this instance is equal to Function#attributes of
+    # +other+.
+    def ==(other)
+      attributes == other.attributes
+    end
+
+    private
+
+    def validate_name(name)
+      raise InvalidFunctionError,
+            "name size can't be greater than #{MAX_NAME_SIZE} characters" unless
+        valid_name_size?(name)
+      raise InvalidFunctionError,
+            'name must be alphanumeric and begin with a letter' unless
+        valid_name_format?(name)
+      name
+    end
+
+    def valid_name_size?(name)
+      name.size <= MAX_NAME_SIZE
+    end
+
+    def valid_name_format?(name)
+      name =~ NAME_PATTERN
+    end
+  end
+end

data/lib/functio/function_repository.rb

@@ -0,0 +1,73 @@
+#--
+# 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/data_storage'
+require 'functio/function'
+
+module Functio
+  # Repository for function management.
+  class FunctionRepository
+    # Symbol with the name of the attribute that identifies a function instance.
+    attr_reader :id_attr
+
+    # Storage instance used for function persistence.
+    attr_reader :storage
+
+    # Class of the function instances this repository manages.
+    attr_reader :function_class
+
+    # Constructs a FunctionRepository instance passing in a +configs+ Hash. The
+    # +configs+ Hash can contain a +:storage+ instance, defaults to a
+    # DataStorage instance; a +:function_class+, defaults to Function; and an
+    # +:id_attr+ Symbol with a name of the attribute that identifies the
+    # function instances, defaults to +:name+.
+    def initialize(configs = {})
+      @storage = configs.fetch(:storage, DataStorage.new)
+      @function_class = configs.fetch(:function_class, Function)
+      @id_attr = configs.fetch(:id_attr, :name)
+    end
+
+    # Adds a +function+ instance to repository and returns +true+. It doesn't
+    # add the function and returns +false+ if its +id_attr+ already exists in
+    # the repository.
+    def add(function)
+      return false if find(function.attributes[id_attr])
+      storage.store(function.attributes)
+      true
+    end
+
+    # Retrieves all function instances in the repository.
+    def all
+      storage.all.map { |record| function_class.build(record) }
+    end
+
+    # Finds a function instance by its +id+ attribute. Returns +nil+ otherwise.
+    def find(id)
+      found = storage.find(id_attr => id)
+      function_class.build(found) if found
+    end
+
+    # Deletes a function instance from the repository by its +id+ attribute.
+    # Returns +true+ if the function instance is deleted successfully. Returns
+    # +false+ otherwise.
+    def delete(id)
+      storage.delete(id_attr => id)
+    end
+  end
+end

data/lib/functio/version.rb

@@ -0,0 +1,23 @@
+#--
+# 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
+  # Functio version
+  VERSION = '0.1.0'.freeze
+end

data/test/doubles/expression_double.rb

@@ -0,0 +1,33 @@
+#--
+# 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/>.
+#++
+
+class ExpressionDouble # :nodoc:
+  attr_reader :expression
+  attr_reader :variables
+
+  def initialize(results = {})
+    @expression = results[:expression]
+    @variables = results[:variables]
+    @evaluate = results[:evaluate]
+  end
+
+  def evaluate(_args = {})
+    @evaluate.call
+  end
+end