numrepr 1.0

data/lib/numrepr/percent.rb

@@ -0,0 +1,236 @@
+#
+#  numrepr/percent.rb  --  Percentage of monetary amount values
+#
+
+require "bigdecimal"
+require "numrepr/format"
+
+
+module NumRepr
+
+  class NoSolutionError < StandardError ; end
+
+
+  class Percent
+
+    attr_reader :rate
+
+    CENT = 100
+
+    class <<self
+
+      alias parse new
+
+      def zero ; new nil ; end
+
+      def as obj
+        case obj
+        when self then obj
+        else           new obj
+        end
+      end
+
+    end
+
+
+    def initialize rate = nil
+      @rate =
+        case rate
+        when String  then parse_str rate
+        when Percent then rate.rate
+        when nil     then 0.to_d
+        else              rate.to_d
+        end
+    end
+
+    private
+
+    def parse_str rate
+      BigDecimal rate =~ /%\s*\z/ ? $` : rate
+    rescue ArgumentError
+      raise ArgumentError, "Not a Percent value: \"#{rate}\"."
+    end
+
+    public
+
+    def to_percent ; self ; end
+
+    def eql? oth ; oth.class == self.class and @rate == oth.rate ; end
+
+    def hash ; @rate.hash ; end
+
+    def <=> oth
+      case oth
+        when Percent then @rate <=> oth.rate
+        when nil     then @rate.zero? ? 0 : 1
+        else              to_d <=> oth
+      end
+    end
+    include Comparable
+
+    def zero?    ; @rate.zero?             ; end
+    def nonzero? ; @rate.nonzero? and self ; end
+
+    def factor ; @rate / CENT ; end
+
+    class <<self
+      def diff succeding, base
+        succeding, base = succeding.to_d, base.to_d
+        f = (succeding - base) / base
+        new f * CENT
+      end
+    end
+
+    def of   amount ; amount * factor      ; end
+    def over amount ; amount + (of amount) ; end
+
+    def split g
+      n, s, r = (g / (factor + 1)), nil, nil
+      loop do
+        s = of n
+        c = n + s
+        if c < g then
+          n = n.succ
+          r = true
+        elsif c > g then
+          r and raise NoSolutionError, "#{g.inspect} cannot be built from #{inspect}."
+          n = n.pred
+        else
+          break
+        end
+      end
+      [ n, s]
+    rescue NoMethodError
+      raise ArgumentError, "Objects of class #{g.class} cannot be splitted into percentages."
+    end
+
+    # With plain rounding, some values will be rounded downwards, some
+    # upwards.
+    #
+    # 50.14 / 1.19  #=> 42.134453781512605 -> 42.13
+    # 42.13 * 1.19  #=> 50.1347 -> 50.13   # this one would be returned
+    # 42.14 * 1.19  #=> 50.1466 -> 50.15
+    #
+    # 50.07 / 1.19  #=> 42.075630252100844 -> 42.08
+    # 42.07 * 1.19  #=> 50.0633 -> 50.06
+    # 42.08 * 1.19  #=> 50.0752 -> 50.08   # this one would be returned
+    #
+    # This method will always return the larger value.
+    #
+    def split! g
+      split g
+    rescue NoSolutionError
+      _, s = split! g.pred
+      [ g - s, s]
+    end
+
+    def add! oth ; @rate = ((factor + 1) * ((self.class.as oth).factor + 1) - 1) * CENT ; self ; end
+    def sub! oth ; @rate = ((factor + 1) / ((self.class.as oth).factor + 1) - 1) * CENT ; self ; end
+    def add  oth ; dup.add! oth ; end
+    def sub  oth ; dup.sub! oth ; end
+    alias + add
+    alias - sub
+
+    def neg! ; @rate = -@rate ; self ; end
+    def neg  ; dup.neg! ; end
+    def +@ ; self ; end
+    def -@ ; neg  ; end
+
+    def sign ; @rate ; end
+    def positive? ; @rate.positive? ; end
+    def negative? ; @rate.negative? ; end
+    alias pos? positive?
+    alias neg? negative?
+
+    def * oth ; oth * to_d ; end
+
+    def coerce oth ; [ oth, to_d] ; end
+
+
+    def days! d, leap = nil ; @rate = (1+factor)**(Rational d, (ydays leap)) ; self ; end
+    def days  d, leap = nil ; dup.days! d, leap ; end
+
+    def days_lin! d, leap = nil ; @rate *= Rational d, (ydays leap) ; self ; end
+    def days_lin  d, leap = nil ; dup.days_lin! d, leap ; end
+
+    private
+
+    def ydays leap ; leap ? 366 : 365 ; end
+
+    public
+
+    def to_f ; @rate.to_f / CENT ; end
+    def to_r ; @rate.to_r / CENT ; end
+    def to_d ; @rate.to_d / CENT ; end
+
+    # :call-seq:
+    #   prc.raw     -> str
+    #
+    # Build a simple string representation without spaces, group characters,
+    # parentheses etc. that can be understood by the classes ::parse method.
+    #
+    #   c = Percent.parse "5%"
+    #   c.raw        #=>  "5%"
+    #
+    def raw
+      r = @rate.to_s "F"
+      r.slice! /0+\z/
+      r.slice! /\.\z/
+      r << "%"
+    end
+    alias to_s    raw
+    alias inspect raw
+
+    def make_digits
+      @rate.make_digits
+    end
+
+  end
+
+  class Parser
+
+    class <<self
+
+      def into_percent str
+        check_string str
+        ints, frac = decsplit str.dup
+        digs = remove_grps [ints, frac]
+        Percent.new digs
+      rescue ArgumentError, NoMethodError
+        raise ArgumentError, "Couldn't parse as percents: #{str}"
+      end
+
+    end
+
+  end
+
+  class Format
+
+    PERCENT   = false   # add percent symbol
+
+    class <<self
+
+      def from_percent p
+        i = from_d p.rate
+        i.do_percent
+        i
+      end
+
+    end
+
+    def do_percent
+      @chars << "%" if cls::PERCENT
+    end
+
+  end
+
+
+  def Percent p ; Percent.new p ; end
+
+end
+
+
+class NilClass ; def to_percent ; NumRepr::Percent.new self ; end ; end
+class Numeric  ; def to_percent ; NumRepr::Percent.new self ; end ; end
+class String   ; def to_percent ; NumRepr::Percent.new self ; end ; end
+

data/lib/numrepr/version.rb

@@ -0,0 +1,10 @@
+#
+#  numrepr/version.rb  --  Metadata
+#
+
+module NumRepr
+
+  NumRepr::VERSION = "1.0".freeze
+
+end
+

data/lib/numrepr.rb

@@ -0,0 +1,9 @@
+#
+#  numrepr.rb  --  Get them all
+#
+
+require "numrepr/version"
+require "numrepr/format"
+require "numrepr/money"
+require "numrepr/percent"
+

data/numrepr.gemspec

@@ -0,0 +1,36 @@
+#
+#  numrepr.gemspec  --  Money amounts as integer
+#
+
+lib = "lib"
+$:.unshift lib
+require "numrepr/version"
+
+Gem::Specification.new do |s|
+  s.name              = "numrepr"
+  s.version           = NumRepr::VERSION
+  s.summary           = "Convert numbers into and from string. Support for monetary amounts"
+  s.description       = <<~EOT
+    Format numbers, parse numbers.
+    Do calculations with monetary and percent values."
+  EOT
+  s.license           = "LicenseRef-BSD-2-Clause-and-DECENT_LANGUAGE"
+
+  s.authors           = [ "Bertram Scharpf"]
+  s.email             = "<software@bertram-scharpf.de>"
+  s.homepage          = "http://www.bertram-scharpf.de"
+
+  s.required_ruby_version = ">= 3.0"
+  s.requirements      = "Just Ruby"
+
+  s.require_paths     = %w(lib)
+  s.bindir            = "bin"
+
+  s.executables       = %w()
+  s.files             = Dir[ "lib/**/*.rb"] + Dir[ "bin/*"]
+  s.extra_rdoc_files  =  %w(LICENSE README.md)
+  s.extra_rdoc_files  += %w(numrepr.gemspec)
+  s.extra_rdoc_files  += Dir[ "examples/*"]
+
+end
+

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: numrepr
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Bertram Scharpf
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Format numbers, parse numbers.
+  Do calculations with monetary and percent values."
+email: "<software@bertram-scharpf.de>"
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+- numrepr.gemspec
+files:
+- LICENSE
+- README.md
+- lib/numrepr.rb
+- lib/numrepr/decimal.rb
+- lib/numrepr/format.rb
+- lib/numrepr/money.rb
+- lib/numrepr/percent.rb
+- lib/numrepr/version.rb
+- numrepr.gemspec
+homepage: http://www.bertram-scharpf.de
+licenses:
+- LicenseRef-BSD-2-Clause-and-DECENT_LANGUAGE
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Just Ruby
+rubygems_version: 3.7.1
+specification_version: 4
+summary: Convert numbers into and from string. Support for monetary amounts
+test_files: []