xls_function 0.1.0

data/lib/xls_function/parse_rules/common.rb

@@ -0,0 +1,34 @@
+module XlsFunction
+  module ParseRules
+    module Common
+      def self.included(klass)
+        klass.class_eval do
+          rule(:space) { match('\s').repeat(1) }
+          rule(:space?) { space.maybe }
+
+          rule(:comma) { str(',') >> space? }
+
+          rule(:negative_sign) { str('-') }
+          rule(:number) { (negative_sign.maybe >> match['0-9\.'].repeat(1)).as(:number) >> space? }
+
+          rule(:true_expr) { (match['Tt'] >> match['Rr'] >> match['Uu'] >> match['Ee']).as(:true_expr) }
+          rule(:false_expr) { (match['Ff'] >> match['Aa'] >> match['Ll'] >> match['Ss'] >> match['Ee']).as(:false_expr) }
+          rule(:boolean) { true_expr | false_expr }
+
+          rule(:string) { str('"') >> match('[^"]').repeat.as(:string) >> str('"') >> space? }
+          rule(:variant) { match['a-zA-Z_'].repeat(1).as(:variant) >> space? }
+
+          rule(:lparen) { str('(') >> space? }
+          rule(:rparen) { str(')') >> space? }
+
+          rule(:identifier) { match['a-zA-Z'].repeat(1) }
+
+          rule(:arglist) { expression >> (comma >> expression).repeat }
+          rule(:function_call) { identifier.as(:identifier) >> lparen >> arglist.maybe.as(:arglist) >> rparen >> space? }
+
+          rule(:single_expression) { function_call | number | boolean | string | variant }
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/parser.rb

@@ -0,0 +1,12 @@
+require 'xls_function/parse_rules/common'
+require 'xls_function/parse_rules/binary_operation'
+
+module XlsFunction
+  class Parser < Parslet::Parser
+    include ::XlsFunction::ParseRules::Common
+    include ::XlsFunction::ParseRules::BinaryOperation
+
+    rule(:expression) { binary_operation | single_expression }
+    root(:expression)
+  end
+end

data/lib/xls_function/transform.rb

@@ -0,0 +1,58 @@
+require 'xls_function/evaluators/evaluable'
+require 'xls_function/evaluators/arguments_definable'
+require 'xls_function/evaluators/error_detector'
+require 'xls_function/evaluators/class_dictionary'
+
+require 'xls_function/evaluators/string_evaluator'
+require 'xls_function/evaluators/variant_evaluator'
+require 'xls_function/evaluators/number_evaluator'
+require 'xls_function/evaluators/true_evaluator'
+require 'xls_function/evaluators/false_evaluator'
+require 'xls_function/evaluators/function_evaluator'
+require 'xls_function/evaluators/binary_operation_evaluator'
+
+require 'xls_function/transform_rules/string_transform'
+require 'xls_function/transform_rules/variant_transform'
+require 'xls_function/transform_rules/number_transform'
+require 'xls_function/transform_rules/boolean_transform'
+require 'xls_function/transform_rules/binary_operation_transform'
+require 'xls_function/transform_rules/function_call_transform'
+
+require 'xls_function/user_defined_function_factory'
+
+module XlsFunction
+  class Transform < Parslet::Transform
+    include ::XlsFunction::TransformRules::StringTransform
+    include ::XlsFunction::TransformRules::VariantTransform
+    include ::XlsFunction::TransformRules::NumberTransform
+    include ::XlsFunction::TransformRules::BooleanTransform
+    include ::XlsFunction::TransformRules::FunctionCallTransform
+    include ::XlsFunction::TransformRules::BinaryOperationTransform
+
+    def apply(obj, context = {})
+      context ||= {}
+      context[:variants] ||= {}
+      context[:caches] ||= {}
+      super(obj, context)
+    end
+
+    class NotImplementedFunctionError < XlsFunction::EvaluationError
+    end
+
+    class VariantUndefinedError < XlsFunction::EvaluationError
+    end
+
+    class << self
+      private
+
+      def add_function(key, block_or_source, description: nil)
+        raise 'add_function: missing key' if key.nil?
+
+        fn = XlsFunction::UserDefinedFunctionFactory.create(block_or_source)
+
+        fn.description(description)
+        XlsFunction.class_dictionary[key] = fn
+      end
+    end
+  end
+end

data/lib/xls_function/transform_rules/binary_operation_transform.rb

@@ -0,0 +1,16 @@
+module XlsFunction
+  module TransformRules
+    module BinaryOperationTransform
+      def self.included(klass)
+        klass.class_eval do
+          rule(left: subtree(:left), operator: simple(:operator), right: subtree(:right)) do |context|
+            ope = ::XlsFunction::Evaluators::BinaryOperationEvaluator.from_dictionary(context[:operator].to_s)
+            raise ::XlsFunction::Transform::NotImplementedFunctionError, "not supported operator #{context[:operator]}" unless ope
+
+            ope.create(context[:left], context[:right], context)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/transform_rules/boolean_transform.rb

@@ -0,0 +1,12 @@
+module XlsFunction
+  module TransformRules
+    module BooleanTransform
+      def self.included(klass)
+        klass.class_eval do
+          rule(true_expr: simple(:value)) { |context| ::XlsFunction::Evaluators::TrueEvaluator.new(context[:value], context) }
+          rule(false_expr: simple(:value)) { |context| ::XlsFunction::Evaluators::FalseEvaluator.new(context[:value], context) }
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/transform_rules/function_call_transform.rb

@@ -0,0 +1,16 @@
+module XlsFunction
+  module TransformRules
+    module FunctionCallTransform
+      def self.included(klass)
+        klass.class_eval do
+          rule(identifier: simple(:identifier), arglist: subtree(:arglist)) do |context|
+            func = ::XlsFunction::Evaluators::FunctionEvaluator.from_dictionary(context[:identifier].to_s.downcase.to_sym)
+            raise ::XlsFunction::Transform::NotImplementedFunctionError, "unsupported function #{context[:identifier]}" unless func
+
+            func.create(context)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/transform_rules/number_transform.rb

@@ -0,0 +1,11 @@
+module XlsFunction
+  module TransformRules
+    module NumberTransform
+      def self.included(klass)
+        klass.class_eval do
+          rule(number: simple(:number)) { |context| ::XlsFunction::Evaluators::NumberEvaluator.new(context[:number], context) }
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/transform_rules/string_transform.rb

@@ -0,0 +1,17 @@
+module XlsFunction
+  module TransformRules
+    module StringTransform
+      def self.included(klass)
+        klass.class_eval do
+          # empty string pattern
+          rule(string: []) do
+            ::XlsFunction::Evaluators::StringEvaluator.new('', {})
+          end
+          rule(string: simple(:string)) do |context|
+            ::XlsFunction::Evaluators::StringEvaluator.new(context[:string], context)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/transform_rules/variant_transform.rb

@@ -0,0 +1,13 @@
+module XlsFunction
+  module TransformRules
+    module VariantTransform
+      def self.included(klass)
+        klass.class_eval do
+          rule(variant: simple(:name)) do |context|
+            ::XlsFunction::Evaluators::VariantEvaluator.new(context[:name], context)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/user_defined_function_factory.rb

@@ -0,0 +1,59 @@
+module XlsFunction
+  module UserDefinedFunctionFactory
+    class << self
+      def create(block_or_source)
+        if block_or_source.respond_to?(:call)
+          create_from_proc(block_or_source)
+        else
+          create_from_source(block_or_source.to_s)
+        end
+      end
+
+      private
+
+      def create_from_proc(block)
+        klass = Class.new(ProcFunction)
+
+        klass.define_singleton_method(:create) do |context|
+          klass.new(context, block)
+        end
+
+        klass
+      end
+
+      def create_from_source(source)
+        raise 'UserDefinedFunction: missing source' if source.nil?
+
+        fn = XlsFunction.evaluate(source)
+        raise 'UserDefinedFunction: use LAMBDA to add your function' unless fn < XlsFunction::Evaluators::Functions::Lambda::Function
+
+        fn
+      end
+    end
+
+    class ProcFunction < ::XlsFunction::Evaluators::FunctionEvaluator
+      attr_reader :custom_proc, :evaled_arglist
+
+      def initialize(context, custom_proc)
+        super(context)
+        @custom_proc = custom_proc
+      end
+
+      # @override
+      def eval_arglist
+        # There is no argument definition, so it evaluates as it is passed.
+        @evaled_arglist = arg_list.map do |arg|
+          value = evaluate_or_self(arg)
+          detect_error(value)
+          break if error?
+
+          value
+        end
+      end
+
+      def eval
+        custom_proc.call(*evaled_arglist)
+      end
+    end
+  end
+end

data/lib/xls_function/version.rb

@@ -0,0 +1,3 @@
+module XlsFunction
+  VERSION = '0.1.0'.freeze
+end

data/lib/xls_function.rb

@@ -0,0 +1,82 @@
+require 'xls_function/version'
+require 'parslet'
+require 'wareki'
+
+require 'bigdecimal'
+require 'bigdecimal/util'
+require 'date'
+require 'time'
+
+require 'xls_function/i18n'
+require 'xls_function/error'
+require 'xls_function/default_logger'
+require 'xls_function/class_dictionary'
+
+require 'xls_function/converter'
+
+require 'xls_function/extensions/hash_extension'
+require 'xls_function/extensions/array_extension'
+require 'xls_function/extensions/big_decimal_extension'
+require 'xls_function/extensions/date_extension'
+require 'xls_function/extensions/time_extension'
+
+require 'xls_function/format_string'
+require 'xls_function/parser'
+require 'xls_function/transform'
+
+module XlsFunction
+  class Error < StandardError; end
+
+  class << self
+    def evaluate(source, **context)
+      parsed = parser.parse(source.to_s.strip)
+      transformed = transform.apply(parsed, context)
+      transformed.evaluate
+    end
+
+    def parser
+      return @parser_factory.call if @parser_factory
+
+      XlsFunction::Parser.new
+    end
+
+    def use_parser_factory(&block)
+      @parser_factory = block
+    end
+
+    def transform
+      return @transform_factory.call if @transform_factory
+
+      XlsFunction::Transform.new
+    end
+
+    def use_transform_factory(&block)
+      @transform_factory = block
+    end
+
+    attr_accessor :verbose
+
+    def logger
+      @logger ||= XlsFunction::DefaultLogger.new
+    end
+
+    def logger=(obj)
+      raise 'Logger must respond_to :write' unless obj.respond_to?(:write)
+
+      @logger = obj
+    end
+
+    def locale=(value)
+      I18n.locale = value
+    end
+
+    def current_locale
+      I18n.locale
+    end
+
+    def functions
+      dictionaries = class_dictionary.reject { |_, v| v < XlsFunction::Evaluators::BinaryOperationEvaluator }
+      dictionaries.to_h { |identifier, klass| [identifier.to_s.upcase, klass.to_h] }
+    end
+  end
+end

data/xls_function.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/xls_function/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'xls_function'
+  spec.version       = XlsFunction::VERSION
+  spec.authors       = ['Nakakuki Shingo']
+  spec.email         = ['nakakuki.shingo@moneyforward.co.jp']
+
+  spec.summary       = 'Excel-like Functions Evaluator'
+  spec.description   = 'Excel-like Functions Evaluator'
+  spec.homepage      = 'https://github.com/moneyforward/xls_function'
+  spec.license       = 'Apache-2.0'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/moneyforward/xls_function'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'i18n', '>= 1.10.0'
+  spec.add_dependency 'parslet', '>= 2.0.0'
+  spec.add_dependency 'wareki', '>= 1.1.0'
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: xls_function
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nakakuki Shingo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: wareki
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: Excel-like Functions Evaluator
+email:
+- nakakuki.shingo@moneyforward.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/publish_gem.yml"
+- ".github/workflows/rspec.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xls_function.rb
+- lib/xls_function/class_dictionary.rb
+- lib/xls_function/converter.rb
+- lib/xls_function/converters/date_converter.rb
+- lib/xls_function/converters/date_serial_converter.rb
+- lib/xls_function/converters/number_converter.rb
+- lib/xls_function/converters/time_converter.rb
+- lib/xls_function/converters/time_serial_converter.rb
+- lib/xls_function/default_logger.rb
+- lib/xls_function/error.rb
+- lib/xls_function/evaluators/arguments_definable.rb
+- lib/xls_function/evaluators/binary_operation_evaluator.rb
+- lib/xls_function/evaluators/binary_operations/add.rb
+- lib/xls_function/evaluators/binary_operations/concat.rb
+- lib/xls_function/evaluators/binary_operations/divide.rb
+- lib/xls_function/evaluators/binary_operations/equal.rb
+- lib/xls_function/evaluators/binary_operations/greater_than.rb
+- lib/xls_function/evaluators/binary_operations/greater_than_or_equal_to.rb
+- lib/xls_function/evaluators/binary_operations/less_than.rb
+- lib/xls_function/evaluators/binary_operations/less_than_or_equal_to.rb
+- lib/xls_function/evaluators/binary_operations/multiple.rb
+- lib/xls_function/evaluators/binary_operations/not_equal.rb
+- lib/xls_function/evaluators/binary_operations/power.rb
+- lib/xls_function/evaluators/binary_operations/subtract.rb
+- lib/xls_function/evaluators/class_dictionary.rb
+- lib/xls_function/evaluators/error_detector.rb
+- lib/xls_function/evaluators/evaluable.rb
+- lib/xls_function/evaluators/false_evaluator.rb
+- lib/xls_function/evaluators/function_evaluator.rb
+- lib/xls_function/evaluators/functions/and.rb
+- lib/xls_function/evaluators/functions/asc.rb
+- lib/xls_function/evaluators/functions/char.rb
+- lib/xls_function/evaluators/functions/clean.rb
+- lib/xls_function/evaluators/functions/code.rb
+- lib/xls_function/evaluators/functions/concat.rb
+- lib/xls_function/evaluators/functions/date.rb
+- lib/xls_function/evaluators/functions/date_value.rb
+- lib/xls_function/evaluators/functions/day.rb
+- lib/xls_function/evaluators/functions/dbcs.rb
+- lib/xls_function/evaluators/functions/e_date.rb
+- lib/xls_function/evaluators/functions/e_o_month.rb
+- lib/xls_function/evaluators/functions/exact.rb
+- lib/xls_function/evaluators/functions/find.rb
+- lib/xls_function/evaluators/functions/fixed.rb
+- lib/xls_function/evaluators/functions/hour.rb
+- lib/xls_function/evaluators/functions/if.rb
+- lib/xls_function/evaluators/functions/ifs.rb
+- lib/xls_function/evaluators/functions/int.rb
+- lib/xls_function/evaluators/functions/iserror.rb
+- lib/xls_function/evaluators/functions/isnumber.rb
+- lib/xls_function/evaluators/functions/lambda.rb
+- lib/xls_function/evaluators/functions/left.rb
+- lib/xls_function/evaluators/functions/len.rb
+- lib/xls_function/evaluators/functions/let.rb
+- lib/xls_function/evaluators/functions/lower.rb
+- lib/xls_function/evaluators/functions/mid.rb
+- lib/xls_function/evaluators/functions/minute.rb
+- lib/xls_function/evaluators/functions/month.rb
+- lib/xls_function/evaluators/functions/not.rb
+- lib/xls_function/evaluators/functions/now.rb
+- lib/xls_function/evaluators/functions/or.rb
+- lib/xls_function/evaluators/functions/power.rb
+- lib/xls_function/evaluators/functions/proper.rb
+- lib/xls_function/evaluators/functions/replace.rb
+- lib/xls_function/evaluators/functions/rept.rb
+- lib/xls_function/evaluators/functions/right.rb
+- lib/xls_function/evaluators/functions/round.rb
+- lib/xls_function/evaluators/functions/round_down.rb
+- lib/xls_function/evaluators/functions/round_up.rb
+- lib/xls_function/evaluators/functions/second.rb
+- lib/xls_function/evaluators/functions/sqrt.rb
+- lib/xls_function/evaluators/functions/substitute.rb
+- lib/xls_function/evaluators/functions/text.rb
+- lib/xls_function/evaluators/functions/time.rb
+- lib/xls_function/evaluators/functions/timevalue.rb
+- lib/xls_function/evaluators/functions/today.rb
+- lib/xls_function/evaluators/functions/trim.rb
+- lib/xls_function/evaluators/functions/trunc.rb
+- lib/xls_function/evaluators/functions/unichar.rb
+- lib/xls_function/evaluators/functions/unicode.rb
+- lib/xls_function/evaluators/functions/upper.rb
+- lib/xls_function/evaluators/functions/value.rb
+- lib/xls_function/evaluators/functions/year.rb
+- lib/xls_function/evaluators/number_evaluator.rb
+- lib/xls_function/evaluators/string_evaluator.rb
+- lib/xls_function/evaluators/true_evaluator.rb
+- lib/xls_function/evaluators/variant_evaluator.rb
+- lib/xls_function/extensions/array_extension.rb
+- lib/xls_function/extensions/big_decimal_extension.rb
+- lib/xls_function/extensions/date_extension.rb
+- lib/xls_function/extensions/hash_extension.rb
+- lib/xls_function/extensions/time_extension.rb
+- lib/xls_function/format_string.rb
+- lib/xls_function/format_string/evaluators/elapsed_time_evaluator.rb
+- lib/xls_function/format_string/evaluators/number_evaluator.rb
+- lib/xls_function/format_string/evaluators/time_evaluator.rb
+- lib/xls_function/format_string/parse_rules/dates.rb
+- lib/xls_function/format_string/parse_rules/numbers.rb
+- lib/xls_function/format_string/parse_rules/texts.rb
+- lib/xls_function/format_string/parse_rules/times.rb
+- lib/xls_function/format_string/parser.rb
+- lib/xls_function/format_string/transform.rb
+- lib/xls_function/format_string/transform_rules/dates.rb
+- lib/xls_function/format_string/transform_rules/numbers.rb
+- lib/xls_function/format_string/transform_rules/texts.rb
+- lib/xls_function/format_string/transform_rules/times.rb
+- lib/xls_function/i18n.rb
+- lib/xls_function/locales/en.yml
+- lib/xls_function/locales/ja.yml
+- lib/xls_function/parse_rules/binary_operation.rb
+- lib/xls_function/parse_rules/common.rb
+- lib/xls_function/parser.rb
+- lib/xls_function/transform.rb
+- lib/xls_function/transform_rules/binary_operation_transform.rb
+- lib/xls_function/transform_rules/boolean_transform.rb
+- lib/xls_function/transform_rules/function_call_transform.rb
+- lib/xls_function/transform_rules/number_transform.rb
+- lib/xls_function/transform_rules/string_transform.rb
+- lib/xls_function/transform_rules/variant_transform.rb
+- lib/xls_function/user_defined_function_factory.rb
+- lib/xls_function/version.rb
+- xls_function.gemspec
+homepage: https://github.com/moneyforward/xls_function
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/moneyforward/xls_function
+  source_code_uri: https://github.com/moneyforward/xls_function
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Excel-like Functions Evaluator
+test_files: []