sequel-money-fields 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a94918adeebbe13b0f3a81e9fd4a0a893489c3a4be15456db5b0a4fd30cf01aa
+  data.tar.gz: e354f31b9cac26e0d7c18cff39218e91eba9d028fc81f3a9c960c1f202d8924a
+SHA512:
+  metadata.gz: ec255f4145ff10166166c065bcfe2fda483390d782d4d1e10f085a5e54ebcb40592257d684b725e554d926a156636204df9502245967ff0f24acbbdd43e10580
+  data.tar.gz: 393660b834401798060793a215d5748eb7d462bf30ce9efc97d56471b29fa19befec32b3d3aefe0456ba54eab7576dae8f834d04310ed0029d55d506901785a4

data/README.md

@@ -0,0 +1,34 @@
+# Sequel::Money::Fields
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sequel/money/fields`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sequel_money_fields-money-fields'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sequel-money-fields
+
+## Usage
+
+TODO: Write usage instructions here
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lithictech/sequel-money-fields.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/sequel/plugins/money_fields.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+# frozen_string_literal: true
+
+require "money"
+require "monetize"
+
+require "sequel"
+require "sequel/model"
+
+# Plugin for adding money fields to a model.
+#
+# == Example
+#
+# Define a model with money values:
+#
+#   class ACME::Property < Sequel::Model(:properties)
+#
+#       plugin :money_fields, :rent
+#
+# And in the schema:
+#
+#   create_table( :properties ) do
+#       primary_key :id
+#       bigint :rent_cents, null: false
+#       text :rent_currency, null: false, default: 'USD'
+#   end
+#
+# And used as follows:
+#
+#   property = ACME::Property.new(rent: Monetize.parse('$5'))
+#   property.rent_cents # 500
+#   property.rent # Money object presenting 5 USD
+#
+# Each money field you declare requires two columns: an integer(ish) column that
+# will store the fractional amount called "#{field}_cents", and a text(ish)
+# column for storing the currency name called "#{field}_currency".
+#
+# The plugin generates methods for getting and setting each field. The setter
+# automatically parses the input using the 'monetize' gem into a Money object,
+# and the getter creates a new Money object from the two columns and returns it.
+#
+# If you don't give at least one column to the plugin declaration, the field
+# will be assumed to be called 'money'.
+#
+# See the docs for Money and Monetize for details on what you can do with the
+# Money objects these fields use.
+#
+
+module Sequel::Plugins::MoneyFields
+  VERSION = "0.1.0"
+
+  def self.configure(model, *args)
+    args << :money if args.empty?
+
+    args.flatten.each do |field|
+      reader = self.make_money_reader(field)
+      writer = self.make_money_writer(field)
+
+      model.send(:define_method, field.to_s, reader)
+      model.send(:define_method, "#{field}=", writer)
+    end
+  end
+
+  # Return a Proc that can serve as the method body for the Money amount
+  # reader for the given +field+.
+  def self.make_money_reader(field)
+    cents_column = "#{field}_cents".to_sym
+    currency_column = "#{field}_currency".to_sym
+
+    return lambda do
+      Money.new(self[cents_column], self[currency_column])
+    end
+  end
+
+  # Return a Proc that can serve as the method body for the Money amount
+  # writer for the given +field+.
+  def self.make_money_writer(field)
+    cents_column = "#{field}_cents".to_sym
+    currency_column = "#{field}_currency".to_sym
+
+    return lambda do |value|
+      if value.respond_to?(:cents) && value.respond_to?(:currency)
+        money = Money.new(value.cents, value.currency)
+      else
+        begin
+          cents = value[:cents] || value["cents"]
+          cur = value[:currency] || value["currency"]
+          money = Money.new(cents, cur)
+        rescue TypeError, NoMethodError
+          money = Monetize.parse!(value)
+        end
+      end
+      self[cents_column] = money.cents.to_i
+      self[currency_column] = money.currency
+    end
+  end
+
+  ### Creates readers and writers that allow assignment to the attributes of
+  ### the singleton of the declaring object that correspond to the specified
+  ### +symbols+.
+  def singleton_attr_accessor(*symbols)
+    symbols.each do |sym|
+      singleton_class.__send__(:attr_accessor, sym)
+    end
+  end
+end

data/spec/sequel/plugins/money_fields_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "money"
+require "monetize"
+require "sequel"
+require "sequel/model"
+
+require "sequel/plugins/money_fields"
+
+RSpec.describe Sequel::Plugins::MoneyFields, :db do
+  context "with no fields given" do
+    before do
+      @db = Sequel.mock
+      @c = Class.new(Sequel::Model(@db)) do
+        set_columns([:id, :money_cents, :money_currency])
+      end
+      @c.plugin :money_fields
+      @m = @c.new
+    end
+
+    # let(:model_object) { model_class.new }
+
+    it "uses :money as the high-level accessor" do
+      @m.money = "$1800"
+      expect(@m.money).to be_a(Money)
+      expect(@m.money_cents).to eq(180_000)
+      expect(@m.money_currency).to eq("USD")
+
+      @m.money = {cents: 200, currency: "CAD"}
+      expect(@m.money_cents).to eq(200)
+      expect(@m.money_currency).to eq("CAD")
+
+      @m.money = OpenStruct.new(cents: 300, currency: "GBP")
+      expect(@m.money_cents).to eq(300)
+      expect(@m.money_currency).to eq("GBP")
+
+      @m.money = {"cents" => 400, "currency" => "EUR"}
+      expect(@m.money_cents).to eq(400)
+      expect(@m.money_currency).to eq("EUR")
+    end
+  end
+
+  context "with fields set to 'rent' and 'deposit'" do
+    # let(:model_class) do
+    #   mc = create_model(:money_fields_test) do
+    #     primary_key :id
+    #     integer :rent_cents
+    #     text :rent_currency
+    #     integer :deposit_cents
+    #     text :deposit_currency
+    #   end
+    #   mc.plugin(:money_fields, :rent, :deposit)
+    #   mc
+    # end
+    #
+    # let(:model_object) { model_class.new }
+
+    before do
+      @db = Sequel.mock
+      @c = Class.new(Sequel::Model(@db)) do
+        set_columns([:id, :rent_cents, :rent_currency, :deposit_cents, :deposit_currency])
+      end
+      @c.plugin(:money_fields, :rent, :deposit)
+      @m = @c.new
+    end
+
+    it "provides high-level accessors for each column" do
+      @m.rent = 1250
+      expect(@m.rent).to be_a(Money)
+      expect(@m.rent.cents).to eq(125_000)
+      expect(@m.rent_cents).to eq(125_000)
+      expect(@m.rent_currency).to eq("USD")
+
+      @m.deposit = "CAD 82.50"
+      expect(@m.deposit).to be_a(Money)
+      expect(@m.deposit.cents).to eq(82_50)
+      expect(@m.deposit_cents).to eq(82_50)
+      expect(@m.deposit_currency).to eq("CAD")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rspec"
+require "sequel"
+require "sequel/plugins/money_fields"
+
+RSpec.configure do |config|
+  # config.full_backtrace = true
+
+  # RSpec::Support::ObjectFormatter.default_instance.max_formatted_output_length = 600
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+  config.default_formatter = "doc" if config.files_to_run.one?
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: sequel-money-fields
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lithic Tech
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: monetize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- hello@lithic.tech
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/sequel/plugins/money_fields.rb
+- spec/sequel/plugins/money_fields_spec.rb
+- spec/spec_helper.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Gem for adding money fields to a model
+test_files: []