test_redmine_vz 0.0.24

data/lib/redmine_crm/currency.rb

@@ -0,0 +1,439 @@
+require "json"
+require "redmine_crm/currency/loader"
+require "redmine_crm/currency/heuristics"
+require "redmine_crm/currency/formatting"
+
+module RedmineCrm
+  # Represents a specific currency unit.
+  #
+  # @see http://en.wikipedia.org/wiki/Currency
+  # @see http://iso4217.net/
+  class Currency
+    include Comparable
+    extend Enumerable
+    extend RedmineCrm::Currency::Loader
+    extend RedmineCrm::Currency::Heuristics
+    extend RedmineCrm::Currency::Formatting
+
+
+
+    # Thrown when a Currency has been registered without all the attributes
+    # which are required for the current action.
+    class MissingAttributeError < StandardError
+      def initialize(method, currency, attribute)
+        super(
+          "Can't call Currency.#{method} - currency '#{currency}' is missing "\
+          "the attribute '#{attribute}'"
+        )
+      end
+    end
+
+    # Thrown when an unknown currency is requested.
+    class UnknownCurrency < ArgumentError; end
+
+    class << self
+
+      # Lookup a currency with given +id+ an returns a +Currency+ instance on
+      # success, +nil+ otherwise.
+      #
+      # @param [String, Symbol, #to_s] id Used to look into +table+ and
+      # retrieve the applicable attributes.
+      #
+      # @return [Money::Currency]
+      #
+      # @example
+      #   Money::Currency.find(:eur) #=> #<Money::Currency id: eur ...>
+      #   Money::Currency.find(:foo) #=> nil
+      def find(id)
+        return nil if id == ""
+        id = id.to_s.downcase.to_sym
+        new(id)
+      rescue UnknownCurrency
+        nil
+      end
+
+      # Lookup a currency with given +num+ as an ISO 4217 numeric and returns an
+      # +Currency+ instance on success, +nil+ otherwise.
+      #
+      # @param [#to_s] num used to look into +table+ in +iso_numeric+ and find
+      # the right currency id.
+      #
+      # @return [Money::Currency]
+      #
+      # @example
+      #   Money::Currency.find_by_iso_numeric(978) #=> #<Money::Currency id: eur ...>
+      #   Money::Currency.find_by_iso_numeric('001') #=> nil
+      def find_by_iso_numeric(num)
+        num = num.to_s
+        id, _ = self.table.find{|key, currency| currency[:iso_numeric] == num}
+        new(id)
+      rescue UnknownCurrency
+        nil
+      end
+
+      # Wraps the object in a +Currency+ unless it's already a +Currency+
+      # object.
+      #
+      # @param [Object] object The object to attempt and wrap as a +Currency+
+      # object.
+      #
+      # @return [Money::Currency]
+      #
+      # @example
+      #   c1 = Money::Currency.new(:usd)
+      #   Money::Currency.wrap(nil)   #=> nil
+      #   Money::Currency.wrap(c1)    #=> #<Money::Currency id: usd ...>
+      #   Money::Currency.wrap("usd") #=> #<Money::Currency id: usd ...>
+      def wrap(object)
+        if object.nil?
+          nil
+        elsif object.is_a?(Currency)
+          object
+        else
+          Currency.new(object)
+        end
+      end
+
+      # List of known currencies.
+      #
+      # == monetary unit
+      # The standard unit of value of a currency, as the dollar in the United States or the peso in Mexico.
+      # http://www.answers.com/topic/monetary-unit
+      # == fractional monetary unit, subunit
+      # A monetary unit that is valued at a fraction (usually one hundredth) of the basic monetary unit
+      # http://www.answers.com/topic/fractional-monetary-unit-subunit
+      #
+      # See http://en.wikipedia.org/wiki/List_of_circulating_currencies and
+      # http://search.cpan.org/~tnguyen/Locale-Currency-Format-1.28/Format.pm
+      def table
+        @table ||= load_currencies
+      end
+
+      # List the currencies imported and registered
+      # @return [Array]
+      #
+      # @example
+      #   Money::Currency.iso_codes()
+      #   [#<Currency ..USD>, 'CAD', 'EUR']...
+      def all
+        table.keys.map do |curr|
+          c = Currency.new(curr)
+          if c.priority.nil?
+            raise MissingAttributeError.new(:all, c.id, :priority)
+          end
+          c
+        end.sort_by(&:priority)
+      end
+
+      # We need a string-based validator before creating an unbounded number of
+      # symbols.
+      # http://www.randomhacks.net/articles/2007/01/20/13-ways-of-looking-at-a-ruby-symbol#11
+      # https://github.com/RubyMoney/money/issues/132
+      #
+      # @return [Set]
+      def stringified_keys
+        @stringified_keys ||= stringify_keys
+      end
+
+      # Register a new currency
+      #
+      # @param curr [Hash] information about the currency
+      # @option priority [Numeric] a numerical value you can use to sort/group
+      #   the currency list
+      # @option iso_code [String] the international 3-letter code as defined
+      #   by the ISO 4217 standard
+      # @option iso_numeric [Integer] the international 3-digit code as
+      #   defined by the ISO 4217 standard
+      # @option name [String] the currency name
+      # @option symbol [String] the currency symbol (UTF-8 encoded)
+      # @option subunit [String] the name of the fractional monetary unit
+      # @option subunit_to_unit [Numeric] the proportion between the unit and
+      #   the subunit
+      # @option separator [String] character between the whole and fraction
+      #   amounts
+      # @option delimiter [String] character between each thousands place
+      def register(curr)
+        key = curr.fetch(:iso_code).downcase.to_sym
+        table if !@table
+        @table[key] = curr
+        @stringified_keys = stringify_keys
+      end
+
+
+      # Unregister a currency.
+      #
+      # @param [Object] curr A Hash with the key `:iso_code`, or the ISO code
+      #   as a String or Symbol.
+      #
+      # @return [Boolean] true if the currency previously existed, false
+      #   if it didn't.
+      def unregister(curr)
+        if curr.is_a?(Hash)
+          key = curr.fetch(:iso_code).to_s.downcase.to_sym
+        else
+          key = curr.to_s.downcase.to_sym
+        end
+        existed = @table.delete(key)
+        @stringified_keys = stringify_keys
+        existed ? true : false
+      end
+
+
+      def each
+        all.each { |c| yield(c) }
+      end
+
+      private
+
+      def stringify_keys
+        table.keys.each_with_object(Set.new) { |k, set| set.add(k.to_s.downcase) }
+      end
+    end
+
+    # @!attribute [r] id 
+    #   @return [Symbol] The symbol used to identify the currency, usually THE
+    #     lowercase +iso_code+ attribute.
+    # @!attribute [r] priority 
+    #   @return [Integer] A numerical value you can use to sort/group the
+    #     currency list.
+    # @!attribute [r] iso_code 
+    #   @return [String] The international 3-letter code as defined by the ISO
+    #     4217 standard.
+    # @!attribute [r] iso_numeric 
+    #   @return [String] The international 3-numeric code as defined by the ISO
+    #     4217 standard.
+    # @!attribute [r] name 
+    #   @return [String] The currency name.
+    # @!attribute [r] symbol 
+    #   @return [String] The currency symbol (UTF-8 encoded).
+    # @!attribute [r] disambiguate_symbol 
+    #   @return [String] Alternative currency used if symbol is ambiguous
+    # @!attribute [r] html_entity 
+    #   @return [String] The html entity for the currency symbol
+    # @!attribute [r] subunit 
+    #   @return [String] The name of the fractional monetary unit.
+    # @!attribute [r] subunit_to_unit 
+    #   @return [Integer] The proportion between the unit and the subunit
+    # @!attribute [r] decimal_mark 
+    #   @return [String] The decimal mark, or character used to separate the
+    #     whole unit from the subunit.
+    # @!attribute [r] The 
+    #   @return [String] character used to separate thousands grouping of the
+    #     whole unit.
+    # @!attribute [r] symbol_first 
+    #   @return [Boolean] Should the currency symbol precede the amount, or
+    #     should it come after?
+    # @!attribute [r] smallest_denomination 
+    #   @return [Integer] Smallest amount of cash possible (in the subunit of
+    #     this currency)
+
+    attr_reader :id, :priority, :iso_code, :iso_numeric, :name, :symbol,
+      :disambiguate_symbol, :html_entity, :subunit, :subunit_to_unit, :decimal_mark,
+      :thousands_separator, :symbol_first, :smallest_denomination
+
+    alias_method :separator, :decimal_mark
+    alias_method :delimiter, :thousands_separator
+    alias_method :eql?, :==
+
+    # Create a new +Currency+ object.
+    #
+    # @param [String, Symbol, #to_s] id Used to look into +table+ and retrieve
+    #  the applicable attributes.
+    #
+    # @return [Money::Currency]
+    #
+    # @example
+    #   Money::Currency.new(:usd) #=> #<Money::Currency id: usd ...>
+    def initialize(id)
+      id = id.to_s.downcase
+      unless self.class.stringified_keys.include?(id)
+        raise UnknownCurrency, "Unknown currency '#{id}'"
+      end
+      @id = id.to_sym
+      initialize_data!
+    end
+
+    # Compares +self+ with +other_currency+ against the value of +priority+
+    # attribute.
+    #
+    # @param [Money::Currency] other_currency The currency to compare to.
+    #
+    # @return [-1,0,1] -1 if less than, 0 is equal to, 1 if greater than
+    #
+    # @example
+    #   c1 = Money::Currency.new(:usd)
+    #   c2 = Money::Currency.new(:jpy)
+    #   c1 <=> c2 #=> 1
+    #   c2 <=> c1 #=> -1
+    #   c1 <=> c1 #=> 0
+    def <=>(other_currency)
+      # <=> returns nil when one of the values is nil
+      comparison = (self.priority <=> other_currency.priority || 0) rescue 0
+
+      if comparison == 0
+        self.id.to_s <=> other_currency.id.to_s
+      else
+        comparison
+      end
+    end
+
+    # Compares +self+ with +other_currency+ and returns +true+ if the are the
+    # same or if their +id+ attributes match.
+    #
+    # @param [Money::Currency] other_currency The currency to compare to.
+    #
+    # @return [Boolean]
+    #
+    # @example
+    #   c1 = Money::Currency.new(:usd)
+    #   c2 = Money::Currency.new(:jpy)
+    #   c1 == c1 #=> true
+    #   c1 == c2 #=> false
+    def ==(other_currency)
+      self.equal?(other_currency) || compare_ids(other_currency)
+    end
+
+    def compare_ids(other_currency)
+      other_currency_id = if other_currency.is_a?(Currency)
+                            other_currency.id.to_s.downcase
+                          else
+                            other_currency.to_s.downcase
+                          end
+      self.id.to_s.downcase == other_currency_id
+    end
+    
+    private :compare_ids
+
+    # Returns a Fixnum hash value based on the +id+ attribute in order to use
+    # functions like & (intersection), group_by, etc.
+    #
+    # @return [Fixnum]
+    #
+    # @example
+    #   Money::Currency.new(:usd).hash #=> 428936
+    def hash
+      id.hash
+    end
+
+    # Returns a human readable representation.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Money::Currency.new(:usd) #=> #<Currency id: usd ...>
+    def inspect
+      "#<#{self.class.name} id: #{id}, priority: #{priority}, symbol_first: #{symbol_first}, thousands_separator: #{thousands_separator}, html_entity: #{html_entity}, decimal_mark: #{decimal_mark}, name: #{name}, symbol: #{symbol}, subunit_to_unit: #{subunit_to_unit}, exponent: #{exponent}, iso_code: #{iso_code}, iso_numeric: #{iso_numeric}, subunit: #{subunit}, smallest_denomination: #{smallest_denomination}>"
+    end
+
+    # Returns a string representation corresponding to the upcase +id+
+    # attribute.
+    #
+    # --
+    # DEV: id.to_s.upcase corresponds to iso_code but don't use ISO_CODE for consistency.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Money::Currency.new(:usd).to_s #=> "USD"
+    #   Money::Currency.new(:eur).to_s #=> "EUR"
+    def to_s
+      id.to_s.upcase
+    end
+
+    # Returns a string representation corresponding to the upcase +id+
+    # attribute. Useful in cases where only implicit conversions are made.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Money::Currency.new(:usd).to_str #=> "USD"
+    #   Money::Currency.new(:eur).to_str #=> "EUR"
+    def to_str
+      id.to_s.upcase
+    end
+
+    # Returns a symbol representation corresponding to the upcase +id+
+    # attribute.
+    #
+    # @return [Symbol]
+    #
+    # @example
+    #   Money::Currency.new(:usd).to_sym #=> :USD
+    #   Money::Currency.new(:eur).to_sym #=> :EUR
+    def to_sym
+      id.to_s.upcase.to_sym
+    end
+
+    # Conversation to +self+.
+    #
+    # @return [self]
+    def to_currency
+      self
+    end
+
+    # Returns currency symbol or iso code for currencies with no symbol.
+    #
+    # @return [String]
+    def code
+      symbol || iso_code
+    end
+
+    def symbol_first?
+      !!@symbol_first
+    end
+
+    # Returns the number of digits after the decimal separator.
+    #
+    # @return [Float]
+    def exponent
+      Math.log10(@subunit_to_unit) if @subunit_to_unit
+    end
+
+    # Cache decimal places for subunit_to_unit values.  Common ones pre-cached.
+    def self.decimal_places_cache
+      @decimal_places_cache ||= {1 => 0, 10 => 1, 100 => 2, 1000 => 3}
+    end
+
+    # The number of decimal places needed.
+    #
+    # @return [Integer]
+    def decimal_places
+      cache[subunit_to_unit] ||= calculate_decimal_places(subunit_to_unit)
+    end
+
+    private
+      
+    def cache
+      self.class.decimal_places_cache
+    end
+
+    # If we need to figure out how many decimal places we need we
+    # use repeated integer division.
+    def calculate_decimal_places(num)
+      i = 1
+      while num >= 10
+        num /= 10
+        i += 1 if num >= 10
+      end
+      i
+    end
+
+    def initialize_data!
+      data = self.class.table[@id]
+      @alternate_symbols     = data[:alternate_symbols]
+      @decimal_mark          = data[:decimal_mark]
+      @disambiguate_symbol   = data[:disambiguate_symbol]
+      @html_entity           = data[:html_entity]
+      @iso_code              = data[:iso_code]
+      @iso_numeric           = data[:iso_numeric]
+      @name                  = data[:name]
+      @priority              = data[:priority]
+      @smallest_denomination = data[:smallest_denomination]
+      @subunit               = data[:subunit]
+      @subunit_to_unit       = data[:subunit_to_unit]
+      @symbol                = data[:symbol]
+      @symbol_first          = data[:symbol_first]
+      @thousands_separator   = data[:thousands_separator]
+    end
+  end
+end

data/lib/redmine_crm/currency/formatting.rb

@@ -0,0 +1,227 @@
+# encoding: UTF-8
+module RedmineCrm
+  class Currency
+    module Formatting
+      def self.included(base)
+        [
+          [:thousands_separator, :delimiter, ","],
+          [:decimal_mark, :separator, "."]
+        ].each do |method, name, character|
+          define_i18n_method(method, name, character)
+        end
+      end
+
+      def self.define_i18n_method(method, name, character)
+        define_method(method) do
+          if self.class.use_i18n
+            begin
+              I18n.t name, :scope => "number.currency.format", :raise => true
+            rescue I18n::MissingTranslationData
+              I18n.t name, :scope =>"number.format", :default => (currency.send(method) || character)
+            end
+          else
+            currency.send(method) || character
+          end
+        end
+        alias_method name, method
+      end
+
+
+      def format(value, currency, *rules)
+        # support for old format parameters
+        rules = normalize_formatting_rules(rules)
+        if currency
+          rules = self.localize_formatting_rules(rules, currency)
+          rules = self.translate_formatting_rules(rules, currency.code) if rules[:translate]
+          rules[:decimal_mark] = currency.decimal_mark if rules[:decimal_mark].nil?
+          rules[:decimal_places] = currency.decimal_places
+          rules[:subunit_to_unit] = currency.subunit_to_unit
+          rules[:thousands_separator] = currency.thousands_separator if rules[:thousands_separator].nil?
+        end
+        rules = Currency.default_formatting_rules.merge(rules){|key, v1, v2| v2.nil? ? v1 : v2}
+
+        # if fractional == 0
+        if rules[:display_free].respond_to?(:to_str)
+          return rules[:display_free]
+        elsif rules[:display_free]
+          return "free"
+        end
+        # end
+
+        symbol_value = currency.try(:symbol) || ""
+
+        formatted = value.abs.to_s
+
+        # if rules[:rounded_infinite_precision]
+        if currency
+          formatted.gsub!(/#{rules[:decimal_mark]}/, '.') unless '.' == rules[:decimal_mark]
+          formatted = ((BigDecimal(formatted) * currency.subunit_to_unit).round / BigDecimal(currency.subunit_to_unit.to_s)).to_s("F")
+          formatted.gsub!(/\..*/) do |decimal_part|
+            decimal_part << '0' while decimal_part.length < (currency.decimal_places + 1)
+            decimal_part
+          end
+          formatted.gsub!(/\./, rules[:decimal_mark]) unless '.' == rules[:decimal_mark]
+        end
+
+        sign = value < 0 ? '-' : ''
+
+        if rules[:no_cents] || (rules[:no_cents_if_whole] && cents % currency.subunit_to_unit == 0)
+          formatted = "#{formatted.to_i}"
+        end
+
+        # thousands_separator_value = currency.thousands_separator
+        # Determine thousands_separator
+        if rules.has_key?(:thousands_separator)
+          thousands_separator_value = rules[:thousands_separator] || ''
+        end
+        decimal_mark = rules[:decimal_mark]
+        # Apply thousands_separator
+        formatted.gsub!(regexp_format(formatted, rules, decimal_mark, symbol_value),
+                        "\\1#{thousands_separator_value}")
+
+        symbol_position = symbol_position_from(rules, currency) if currency
+
+        if rules[:sign_positive] == true && (value >= 0)
+          sign = '+'
+        end
+
+        if rules[:sign_before_symbol] == true
+          sign_before = sign
+          sign = ''
+        end
+
+        if symbol_value && !symbol_value.empty?
+          symbol_value = "<span class=\"currency_symbol\">#{symbol_value}</span>" if rules[:html_wrap_symbol]
+          formatted = if symbol_position == :before
+            symbol_space = rules[:symbol_before_without_space] === false ? " " : ""
+            "#{sign_before}#{symbol_value}#{symbol_space}#{sign}#{formatted}"
+          else
+            symbol_space = rules[:symbol_after_without_space] ? "" : " "
+            "#{sign_before}#{sign}#{formatted}#{symbol_space}#{symbol_value}"
+          end
+        else
+          formatted="#{sign_before}#{sign}#{formatted}"
+        end
+
+        # apply_decimal_mark_from_rules(formatted, rules)
+
+        if rules[:with_currency]
+          formatted << " "
+          formatted << '<span class="currency">' if rules[:html]
+          formatted << currency.to_s
+          formatted << '</span>' if rules[:html]
+        end
+        formatted
+      end
+
+      def default_formatting_rules
+        {
+          :decimal_mark =>".",
+          :thousands_separator => ",",
+          :subunit_to_unit => 100
+        }
+      end
+
+      def regexp_format(formatted, rules, decimal_mark, symbol_value)
+        regexp_decimal = Regexp.escape(decimal_mark)
+        if rules[:south_asian_number_formatting]
+          /(\d+?)(?=(\d\d)+(\d)(?:\.))/
+        else
+          # Symbols may contain decimal marks (E.g "դր.")
+          if formatted.sub(symbol_value.to_s, "") =~ /#{regexp_decimal}/
+            /(\d)(?=(?:\d{3})+(?:#{regexp_decimal}))/
+          else
+            /(\d)(?=(?:\d{3})+(?:[^\d]{1}|$))/
+          end
+        end
+      end
+
+      def translate_formatting_rules(rules, iso_code)
+        begin
+          rules[:symbol] = I18n.t iso_code, :scope => "number.currency.symbol", :raise => true
+        rescue I18n::MissingTranslationData
+          # Do nothing
+        end
+        rules
+      end
+
+      def localize_formatting_rules(rules, currency)
+        if currency.iso_code == "JPY" && I18n.locale == :ja
+          rules[:symbol] = "円" unless rules[:symbol] == false
+          rules[:symbol_position] = :after
+          rules[:symbol_after_without_space] = true
+        elsif currency.iso_code == "CHF"
+          rules[:symbol_before_without_space] = false
+        end
+        rules
+      end
+
+      def symbol_value_from(rules)
+        if rules.has_key?(:symbol)
+          if rules[:symbol] === true
+            symbol
+          elsif rules[:symbol]
+            rules[:symbol]
+          else
+            ""
+          end
+        elsif rules[:html]
+          currency.html_entity == '' ? currency.symbol : currency.html_entity
+        elsif rules[:disambiguate] and currency.disambiguate_symbol
+          currency.disambiguate_symbol
+        else
+          symbol
+        end
+      end
+
+      def symbol_position_from(rules, currency)
+        if rules.has_key?(:symbol_position)
+          if [:before, :after].include?(rules[:symbol_position])
+            return rules[:symbol_position]
+          else
+            raise ArgumentError, ":symbol_position must be ':before' or ':after'"
+          end
+        elsif currency.symbol_first?
+          :before
+        else
+          :after
+        end
+      end
+
+      private
+
+      # Cleans up formatting rules.
+      #
+      # @param [Hash] rules
+      #
+      # @return [Hash]
+      def normalize_formatting_rules(rules)
+        if rules.size == 0
+          rules = {}
+        elsif rules.size == 1
+          rules = rules.pop
+          rules = { rules => true } if rules.is_a?(Symbol)
+        end
+        rules[:decimal_mark] = rules[:separator] || rules[:decimal_mark]
+        rules[:thousands_separator] = rules[:delimiter] || rules[:thousands_separator]
+        rules
+      end
+
+      # Applies decimal mark from rules to formatted
+      #
+      # @param [String] formatted
+      # @param [Hash]   rules
+      def apply_decimal_mark_from_rules(formatted, rules)
+        if rules.has_key?(:decimal_mark) && rules[:decimal_mark]
+          # && rules[:decimal_mark] != decimal_mark
+
+          regexp_decimal = Regexp.escape(rules[:decimal_mark])
+          formatted.sub!(/(.*)(#{regexp_decimal})(.*)\Z/,
+                         "\\1#{rules[:decimal_mark]}\\3")
+        end
+      end
+
+    end
+
+  end
+end