xls_function 0.1.0

data/lib/xls_function/evaluators/functions/left.rb

@@ -0,0 +1,16 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Left < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :left
+
+        define_arg :source
+        define_arg :length
+
+        def eval
+          source[0, length]
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/len.rb

@@ -0,0 +1,15 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Len < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :len
+
+        define_arg :source
+
+        def eval
+          source.length
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/let.rb

@@ -0,0 +1,24 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Let < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :let
+
+        def eval_arglist
+          # Skip common argument evaluation and assignment
+        end
+
+        def eval
+          # last arg is calculation
+          calculation = arg_list.pop
+          # set evaluated result to variant context
+          arg_list.each_slice(2) do |variant, expr|
+            variant_context[variant.name] = expr&.evaluate(context)
+          end
+
+          calculation.evaluate(context)
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/lower.rb

@@ -0,0 +1,15 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Lower < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :lower
+
+        define_arg :source
+
+        def eval
+          source.downcase
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/mid.rb

@@ -0,0 +1,23 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Mid < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :mid
+
+        define_arg :source
+        define_arg :start
+        define_arg :length
+
+        def eval
+          source[safe_start, length]
+        end
+
+        def safe_start
+          return 0 unless start.positive?
+
+          start - 1
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/minute.rb

@@ -0,0 +1,15 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Minute < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :minute
+
+        define_arg :time_value, type: :time
+
+        def eval
+          time_value.min
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/month.rb

@@ -0,0 +1,15 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Month < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :month
+
+        define_arg :date_value, type: :date
+
+        def eval
+          date_value.month
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/not.rb

@@ -0,0 +1,15 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Not < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :not
+
+        define_arg :logical
+
+        def eval
+          !logical
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/now.rb

@@ -0,0 +1,19 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Now < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :now
+
+        using ::XlsFunction::Extensions::TimeExtension
+
+        def eval
+          now.to_serial
+        end
+
+        def now
+          Time.now
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/or.rb

@@ -0,0 +1,21 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Or < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :or
+
+        def eval_arglist
+          # Skip common argument evaluation and assignment for short-circuit
+        end
+
+        def eval
+          arg_list.each do |arg|
+            return true if arg.evaluate(context)
+          end
+
+          false
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/power.rb

@@ -0,0 +1,16 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class POWER < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :power
+
+        define_arg :number, type: :number
+        define_arg :power, type: :number
+
+        def eval
+          number**power
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/proper.rb

@@ -0,0 +1,17 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Proper < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :proper
+
+        define_arg :source
+
+        def eval
+          source.split(/([[:digit:][:blank:][:punct:]]+)/)
+                .map(&:capitalize)
+                .join
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/replace.rb

@@ -0,0 +1,19 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Replace < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :replace
+
+        define_arg :source
+        define_arg :start_index
+        define_arg :length
+        define_arg :replace_string
+
+        def eval
+          source[start_index - 1, length] = replace_string
+          source
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/rept.rb

@@ -0,0 +1,25 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Rept < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :rept
+
+        define_arg :source
+        define_arg :number_times, type: :number
+
+        def eval
+          number_times_i = number_times.to_i
+          return ::XlsFunction::ErrorValue.value!(number_times_is_negative) if number_times_i.negative?
+          return '' if number_times_i.zero?
+
+          source * number_times_i
+        end
+
+        def number_times_is_negative
+          message = error_message(:number_is_negative, label: 'number_times', number: number_times)
+          class_info(message)
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/right.rb

@@ -0,0 +1,16 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Right < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :right
+
+        define_arg :source
+        define_arg :length
+
+        def eval
+          source[-length..-1]
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/round.rb

@@ -0,0 +1,16 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Round < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :round
+
+        define_arg :number, type: :number
+        define_arg :num_digits, type: :number
+
+        def eval
+          number.round(num_digits.to_i).to_d
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/round_down.rb

@@ -0,0 +1,16 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class RoundDown < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :rounddown
+
+        define_arg :number, type: :number
+        define_arg :num_digits, type: :number
+
+        def eval
+          number.truncate(num_digits.to_i).to_d
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/round_up.rb

@@ -0,0 +1,16 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class RoundUp < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :roundup
+
+        define_arg :number, type: :number
+        define_arg :num_digits, type: :number
+
+        def eval
+          number.round(num_digits.to_i, BigDecimal::ROUND_UP).to_d
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/second.rb

@@ -0,0 +1,15 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Second < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :second
+
+        define_arg :time_value, type: :time
+
+        def eval
+          time_value.sec
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/sqrt.rb

@@ -0,0 +1,17 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Sqrt < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :sqrt
+
+        define_arg :number, type: :number
+
+        def eval
+          return ErrorValue.num!(error_message(:number_is_negative, label: 'number', number: number)) if number.negative?
+
+          Math.sqrt(number).to_d
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/substitute.rb

@@ -0,0 +1,44 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Substitute < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :substitute
+
+        define_arg :source
+        define_arg :search_for
+        define_arg :replace_with
+        define_arg :instance_num, default: 0
+
+        def eval
+          instance_num_i = instance_num.to_i
+          return ::XlsFunction::ErrorValue.value!(instance_num_is_negative(instance_num_i)) if instance_num_i.negative?
+
+          if replace_all?(instance_num_i)
+            replace_all(source, search_for, replace_with)
+          else
+            replace(source, search_for, replace_with, instance_num_i)
+          end
+        end
+
+        private
+
+        def replace_all?(instance_num_i)
+          instance_num_i.zero?
+        end
+
+        def replace_all(source, search_for, replace_with)
+          source.gsub(search_for, replace_with)
+        end
+
+        def replace(source, search_for, replace_with, instance_num_i)
+          source.gsub(search_for).with_index(1) { |s, i| i == instance_num_i ? replace_with : s }
+        end
+
+        def instance_num_is_negative(instance_num_i)
+          message = error_message(:number_is_negative, label: 'instance_num', number: instance_num_i)
+          class_info(message)
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/text.rb

@@ -0,0 +1,17 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Text < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :text
+
+        define_arg :value
+        define_arg :format_text
+
+        def eval
+          converter = ::XlsFunction::FormatString.evaluate_converter(format_text, context)
+          converter.call(value)
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/time.rb

@@ -0,0 +1,54 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class TimeFn < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :time
+
+        define_arg :hour, default: 0, type: :number
+        define_arg :minute, default: 0, type: :number
+        define_arg :second, default: 0, type: :number
+
+        ARG_LIMIT = 32_767
+
+        using ::XlsFunction::Extensions::TimeExtension
+
+        def eval
+          return ::XlsFunction::ErrorValue.num!(out_of_range) unless validate_args
+
+          adjusted = ::XlsFunction::Converters::TimeConverter.adjust_elapsed_time(hour_i, minute_i, second_i)
+          time = Time.new(Time.now.year, nil, nil, adjusted[:hour], adjusted[:minute], adjusted[:second])
+
+          time.to_serial(except_date: true)
+        end
+
+        def validate_args
+          return false if hour_i > ARG_LIMIT || minute_i > ARG_LIMIT || second_i > ARG_LIMIT
+
+          # raise error when negative converted to seconds
+          hour_sec = hour_i * 60 * 60
+          minute_sec = minute_i * 60
+          return false if (hour_sec + minute_sec + second_i).negative?
+
+          true
+        end
+
+        def hour_i
+          @hour_i ||= hour.to_i
+        end
+
+        def minute_i
+          @minute_i ||= minute.to_i
+        end
+
+        def second_i
+          @second_i ||= second.to_i
+        end
+
+        def out_of_range
+          message = error_message(:out_of_range, value: "#{hour}, #{minute}, #{second}")
+          class_info(message)
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/timevalue.rb

@@ -0,0 +1,17 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Timevalue < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :timevalue
+
+        define_arg :time_value, type: :time
+
+        using ::XlsFunction::Extensions::TimeExtension
+
+        def eval
+          time_value.to_serial(except_date: true)
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/today.rb

@@ -0,0 +1,19 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Today < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :today
+
+        using ::XlsFunction::Extensions::DateExtension
+
+        def eval
+          today.to_serial
+        end
+
+        def today
+          Date.today
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/trim.rb

@@ -0,0 +1,16 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Trim < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :trim
+
+        define_arg :source
+
+        def eval
+          trimed = source.to_s.gsub(/(^[\s　]+)|([\s　]+$)/, '')
+          trimed.gsub(/[\s　]+/) { |spaces| spaces[0] }
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/trunc.rb

@@ -0,0 +1,16 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Trunc < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :trunc
+
+        define_arg :number, type: :number
+        define_arg :num_digits, type: :number, default: 0
+
+        def eval
+          number.truncate(num_digits.to_i).to_d
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/unichar.rb

@@ -0,0 +1,19 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Unichar < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :unichar
+
+        define_arg :number
+
+        def eval
+          return '' unless number.respond_to?(:to_i)
+
+          number.to_i.chr(Encoding::UTF_8)
+        rescue RangeError => e
+          e.message
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/unicode.rb

@@ -0,0 +1,18 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Unicode < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :unicode
+
+        define_arg :source
+
+        def eval
+          s = source.to_s
+          return if s.empty?
+
+          s.encode(Encoding::UTF_8).ord
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/upper.rb

@@ -0,0 +1,15 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Upper < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :upper
+
+        define_arg :source
+
+        def eval
+          source.upcase
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/value.rb

@@ -0,0 +1,26 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Value < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :value
+
+        define_arg :source
+
+        def eval
+          # Delete comma because ruby converts '1,000' to 1.
+          return BigDecimal(source.delete(',')) if source.is_a?(String)
+          return source.to_d if source.respond_to?(:to_d)
+
+          ::XlsFunction::ErrorValue.value!(cannot_convert)
+        rescue TypeError, ArgumentError
+          ::XlsFunction::ErrorValue.value!(cannot_convert)
+        end
+
+        def cannot_convert
+          message = error_message(:cannot_convert_to_number, source: source)
+          class_info(message)
+        end
+      end
+    end
+  end
+end

data/lib/xls_function/evaluators/functions/year.rb

@@ -0,0 +1,15 @@
+module XlsFunction
+  module Evaluators
+    module Functions
+      class Year < ::XlsFunction::Evaluators::FunctionEvaluator
+        function_as :year
+
+        define_arg :date_value, type: :date
+
+        def eval
+          date_value.year
+        end
+      end
+    end
+  end
+end