minting-rails 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 281304a9f89250f78bee993b5b4eaec8e675a4f5f8487a91a16a71c52df1ef04
+  data.tar.gz: 861df162c0953c9ba0893778b3805da34fe42ec98485498531eaa48b5cf16be2
+SHA512:
+  metadata.gz: 1fd2c46e7fa9e8d0a8ea579fe2880af82676518d624b04276f04adaea77826c9c04dd281a4508463a158d823561f6d2502677d217d2526a3873ef6cb0ea05e97
+  data.tar.gz: 9186adb993e282d4dc39008d6bb0b32013cdf1c4d267197e920478e7f89b4a21d56b709eca59bd67f28da28e4c39e23c83552ccddf9807a632500d2b33465458

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Gilson Ferraz
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Mint::Rails
+
+Add Money attributes to your Rails application.
+
+## Usage
+
+Currently in development. Please wait for 1.0 release.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "minting-rails"
+```
+
+And then execute:
+
+```bash
+  bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install minting-rails
+```
+
+After intalling generate Minting configuration initializer:
+
+```sh
+rails g mint:initializer
+```
+
+## To do
+
+- API Documentation
+- Internationalization
+- Publish 1.0 Beta
+
+## Contributing
+
+Contribution directions go here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task default: :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.ruby_opts << '-rtest_helper.rb'
+end

data/lib/generators/minting/initializer_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Mint
+  module Generators
+    class InitializerGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+
+      desc 'Creates Minting initializer.'
+
+      def copy_initializer
+        copy_file 'minting.rb', 'config/initializers/minting.rb'
+      end
+    end
+  end
+end

data/lib/generators/templates/minting.rb

@@ -0,0 +1,44 @@
+# encoding : utf-8
+# frozen_string_literal: true
+
+Mint.configure do |config|
+  # Register additional currencies
+  #
+  # Example:
+  #   config.added_currencies = [
+  #   Mint.register_currency 'CRC', subunit: 2, symbol: '₡'
+  #   Mint.register_currency 'NGN', subunit: 3, synbol: '₦'
+  # ]
+  config.added_currencies = [
+    Mint.register_currency('CRC', subunit: 2, symbol: '₡'),
+    Mint.register_currency('NGN', subunit: 3, symbol: '₦')
+  ]
+
+  # Enable currencies
+  # Only these currencies amounts can be created
+  # Examples:
+  # 1. All registered currencies are enabled (default)
+  #    config.enabled_currencies = :all
+  # 2. Some registered currencies are enabled
+  #    config.enabled_currencies = %w[BRL CRC NGN USD]
+
+  # To set the default currency
+  #
+  # It must be a registered currency
+  # config.default_currency = 'USD'
+
+  # Specify a rounding mode
+  # Any one of:
+  #
+  # BigDecimal::ROUND_UP,
+  # BigDecimal::ROUND_DOWN,
+  # BigDecimal::ROUND_HALF_UP,
+  # BigDecimal::ROUND_HALF_DOWN,
+  # BigDecimal::ROUND_HALF_EVEN,
+  # BigDecimal::ROUND_CEILING,
+  # BigDecimal::ROUND_FLOOR
+  #
+  # BigDecimal::ROUND_HALF_EVEN is default
+  #
+  # config.rounding_mode = BigDecimal::ROUND_HALF_UP
+end

data/lib/minting/money_attribute/configuration.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Mint
+  include ActiveSupport::Configurable
+
+  def self.assert_valid_currency!(currency)
+    if currency.is_a? Mint::Currency
+      code = currency.code
+    else
+      code = currency.to_s
+      currency = Mint.currency(code)
+    end
+    return currency if valid_currency_codes.include?(code)
+
+    raise ArgumentError,
+          "Invalid currency '#{code}'. Please select a registered currency: #{valid_currency_codes}"
+  end
+
+  def self.default_currency
+    @default_currency ||= Mint.assert_valid_currency!(config.default_currency)
+  end
+
+  def self.valid_currency_codes
+    @valid_currency_codes ||= if config.enabled_currencies == :all
+                                Mint.currencies
+                              else
+                                config.enabled_currencies.to_set
+                              end
+  end
+end

data/lib/minting/money_attribute/core_ext.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# :nodoc
+class Numeric
+  def to_money(currency)
+    Mint.money(self, currency)
+  end
+
+  def dollars
+    Mint.money(self, 'USD')
+  end
+
+  def euros
+    Mint.money(self, 'EUR')
+  end
+
+  alias dollar dollars
+  alias euro euros
+  alias mint to_money
+end
+
+# :nodoc
+class String
+  def to_money(currency)
+    Mint.money(to_r, currency)
+  end
+
+  alias mint to_money
+end

data/lib/minting/money_attribute/money_attribute.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Mint
+  # MoneyAttribute
+  module MoneyAttribute
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Money attribute
+      def money_attribute(name, currency: Mint.default_currency, mapping: nil)
+        currency = Mint.assert_valid_currency!(currency)
+        parser = proc { |amount, code = currency| MoneyAttribute.parse(amount, code) }
+        if attribute_names.include? name.to_s
+          attribute(name, :mint_money, currency:)
+          normalizes(name, with: parser)
+        else
+          aggregated = find_money_attributes(name, mapping:)
+          options = {
+            allow_nil: true, class_name: 'Mint::Money',
+            constructor: parser, converter: parser,
+            mapping: { aggregated[:amount] => :to_i, aggregated[:currency] => :currency_code }
+          }
+          composed_of(name, options)
+        end
+      end
+
+      def find_money_attributes(name, mapping:)
+        composite = if mapping.present?
+                      { amount: mapping.key(:amount).to_s, currency: mapping.key(:currency).to_s }
+                    else
+                      { amount: "#{name}_amount", currency: "#{name}_currency" }
+                    end
+        if (composite.values & attribute_names).size != 2
+          raise ArgumentError, "Could not find attributes to map to #{name} money attribute"
+        end
+
+        composite
+      end
+    end
+
+    def self.parse(amount, currency)
+      case amount
+      when NilClass
+        nil
+      when Mint::Money
+        amount
+      when Numeric
+        Mint.money(amount, currency)
+      else
+        if amount.respond_to? :to_money
+          amount.to_money(currency)
+        else
+          Mint.money(amount.to_s.split[0].to_r, currency)
+        end
+      end
+      # puts "parse(#{amount}, #{currency.inspect}) => #{money.inspect}"
+    end
+  end
+end

data/lib/minting/money_attribute/money_type.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Mint
+  # MintMoneyType
+  class MintMoneyType < ActiveRecord::Type::Value
+    def initialize(currency:)
+      @currency = Mint.currency currency
+      super()
+    end
+
+    def assert_valid_value(value)
+      case value
+      when Numeric, String
+        return
+      when Mint::Money
+        return if value.currency == @currency
+
+        message = "'#{value.inspect}' has different currency. Only #{@currency.code} allowed."
+      else
+        message = "'#{value}' is not a valid type for the attribute."
+      end
+      raise ArgumentError, message
+    end
+
+    def deserialize(value)
+      value && Mint.money(value, @currency)
+    end
+
+    def serialize(value)
+      value.to_d
+    end
+
+    def self.type
+      :mint_type
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Base.include Mint::MoneyAttribute
+  ActiveRecord::Type.register(:mint_money, Mint::MintMoneyType)
+end

data/lib/minting/money_attribute/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Mint
+  module MoneyAttribute
+    VERSION = '0.2.0'
+  end
+end

data/lib/minting/rails.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'minting/money_attribute/core_ext'
+require 'minting/money_attribute/configuration'
+require 'minting/money_attribute/money_attribute'
+require 'minting/money_attribute/money_type'
+require 'minting/money_attribute/version'
+require 'minting/railties'

data/lib/minting/railties.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Mint
+  class Railtie < ::Rails::Railtie
+    generators do
+      require 'generators/minting/initializer_generator'
+    end
+  end
+end

data/lib/tasks/minting/rails_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :minting_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: minting-rails
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Gilson Ferraz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.2
+description: ''
+email:
+- gilson@cesar.etc.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/minting/initializer_generator.rb
+- lib/generators/templates/minting.rb
+- lib/minting/money_attribute/configuration.rb
+- lib/minting/money_attribute/core_ext.rb
+- lib/minting/money_attribute/money_attribute.rb
+- lib/minting/money_attribute/money_type.rb
+- lib/minting/money_attribute/version.rb
+- lib/minting/rails.rb
+- lib/minting/railties.rb
+- lib/tasks/minting/rails_tasks.rake
+homepage: https://github.com/gferraz/minting-rails
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/gferraz/minting-rails
+  source_code_uri: https://github.com/gferraz/minting-rails
+  changelog_uri: https://github.com/gferraz/minting-rails/releases
+  bug_tracker_uri: https://github.com/gferraz/minting-rails/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.10
+signing_key:
+specification_version: 4
+summary: Money attributes to ActiveRecord
+test_files: []