formatted_attributes 0.1.0 → 0.2.0

data/lib/formatted_attributes.rb

@@ -1,5 +1,66 @@
-require "active_record"
-require "formatted_attributes/active_record"
-require "formatted_attributes/version"
+# frozen_string_literal: true
 
-ActiveRecord::Base.send :include, FormattedAttributes::ActiveRecord
+module FormattedAttributes
+  require "formatted_attributes/version"
+
+  def self.included(base)
+    base.instance_eval do
+      extend ClassMethods
+    end
+  end
+
+  module ClassMethods
+    def formatted(*args)
+      options = args.extract_options!
+      formatter = options[:with]
+
+      extension = Module.new do
+        args.each do |attr|
+          formatted_attr = :"@formatted_#{attr}"
+
+          # Overwrite attribute setter.
+          # This will clear the formatted attribute's cache.
+          #
+          # The reason we're using `prepend extension` is that ActiveRecord's
+          # attributes aren't defined upfront, so we can't retrieve a method
+          # reference with `instance_method(attr)` to use on this overwriting
+          # method, forcing us to call `super` instead. The downside of this
+          # approach is that each attribute will include a new module, but for
+          # most cases that won't be a problem.
+          define_method("#{attr}=") do |value|
+            instance_variable_set(formatted_attr, nil)
+            super(value)
+          end
+
+          # Create the formatted attribute reader.
+          # This method will read the raw value and convert it to the formatted
+          # value by calling `format_to_{formatter}`.
+          define_method("formatted_#{attr}") do
+            formatted_value = instance_variable_get(formatted_attr)
+
+            return formatted_value if formatted_value
+
+            instance_variable_set(
+              formatted_attr,
+              send(:"convert_with_#{formatter}", send(attr))
+            )
+          end
+
+          # Create the formatted attribute setter.
+          # This method will receive a formatted value and coerce it into the
+          # expected format by calling `format_from_{formatter}`.
+          define_method("formatted_#{attr}=") do |formatted_value|
+            send(
+              :"#{attr}=",
+              send(:"convert_from_#{formatter}", formatted_value)
+            )
+          end
+        end
+      end
+
+      prepend extension
+    end
+
+    alias formatted_attribute formatted
+  end
+end

metadata

@@ -1,144 +1,212 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: formatted_attributes
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Nando Vieira
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-
-date: 2010-11-06 00:00:00 -02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2022-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 0
-        version: 2.0.0
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: sqlite3-ruby
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-meta
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: actionpack
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  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
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: ruby-debug19
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-fnando
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-description: Sometimes you need to expose a helper method that will convert its value before saving it to the database. This gem will add `formatted_` suffix to the attributes you specify.
-email: 
-- fnando.vieira@gmail.com
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: sqlite3
+  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: Add methods that format attributes from/to helper methods.
+email:
+- me@fnando.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".github/CODEOWNERS"
+- ".github/FUNDING.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/dependabot.yml"
+- ".github/workflows/ruby-tests.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
-- README.rdoc
+- LICENSE.md
+- README.md
 - Rakefile
+- bin/console
+- bin/setup
 - formatted_attributes.gemspec
 - lib/formatted_attributes.rb
-- lib/formatted_attributes/active_record.rb
 - lib/formatted_attributes/version.rb
-- spec/formatted_attributes_spec.rb
-- spec/schema.rb
-- spec/spec_helper.rb
-has_rdoc: true
-homepage: http://rubygems.org/gems/formatted_attributes
-licenses: []
-
-post_install_message: 
+homepage: https://github.com/fnando/formatted_attributes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fnando/formatted_attributes
+  bug_tracker_uri: https://github.com/fnando/formatted_attributes/issues
+  source_code_uri: https://github.com/fnando/formatted_attributes/tree/v0.2.0
+  changelog_uri: https://github.com/fnando/formatted_attributes/tree/v0.2.0/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/formatted_attributes/tree/v0.2.0/README.md
+  license_uri: https://github.com/fnando/formatted_attributes/tree/v0.2.0/LICENSE.md
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.7
-signing_key: 
-specification_version: 3
-summary: Add formatted methods for ActiveRecord attributes
-test_files: 
-- spec/formatted_attributes_spec.rb
-- spec/schema.rb
-- spec/spec_helper.rb
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Add methods that format attributes from/to helper methods.
+test_files: []

data/Gemfile.lock

@@ -1,79 +0,0 @@
-PATH
-  remote: .
-  specs:
-    formatted_attributes (0.1.0)
-      activerecord
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    abstract (1.0.0)
-    actionpack (3.0.1)
-      activemodel (= 3.0.1)
-      activesupport (= 3.0.1)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.4.1)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.12)
-      rack-test (~> 0.5.4)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.1)
-      activesupport (= 3.0.1)
-      builder (~> 2.1.2)
-      i18n (~> 0.4.1)
-    activerecord (3.0.1)
-      activemodel (= 3.0.1)
-      activesupport (= 3.0.1)
-      arel (~> 1.0.0)
-      tzinfo (~> 0.3.23)
-    activesupport (3.0.1)
-    archive-tar-minitar (0.5.2)
-    arel (1.0.1)
-      activesupport (~> 3.0.0)
-    builder (2.1.2)
-    columnize (0.3.1)
-    diff-lcs (1.1.2)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    i18n (0.4.1)
-    linecache19 (0.5.11)
-      ruby_core_source (>= 0.1.4)
-    rack (1.2.1)
-    rack-mount (0.6.13)
-      rack (>= 1.0.0)
-    rack-test (0.5.6)
-      rack (>= 1.0)
-    rspec (2.0.1)
-      rspec-core (~> 2.0.1)
-      rspec-expectations (~> 2.0.1)
-      rspec-mocks (~> 2.0.1)
-    rspec-core (2.0.1)
-    rspec-expectations (2.0.1)
-      diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.1)
-      rspec-core (~> 2.0.1)
-      rspec-expectations (~> 2.0.1)
-    ruby-debug-base19 (0.11.24)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby_core_source (>= 0.1.4)
-    ruby-debug19 (0.11.6)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby-debug-base19 (>= 0.11.19)
-    ruby_core_source (0.1.4)
-      archive-tar-minitar (>= 0.5.2)
-    sqlite3-ruby (1.3.1)
-    tzinfo (0.3.23)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  actionpack
-  activerecord
-  formatted_attributes!
-  rspec (>= 2.0.0)
-  ruby-debug19
-  sqlite3-ruby

data/README.rdoc

@@ -1,65 +0,0 @@
-= Formatted Attributes
-
-Sometimes you want to use a proxy attribute that will be formatted while displaying its value or receiving data from user.
-
-== Install
-
-  gem install formatted_attributes
-
-== Usage
-
-A formatted attribute will require two methods: <tt>format_to_#{formatter}</tt> and <tt>format_from_#{formatter}</tt>. The <tt>format_to_*</tt> method will convert the formatted value to the original value and the <tt>format_from_*</tt> method will do the other way around, converting the original value to the formatted version.
-
-See an example on how to format prices from strings like <tt>1,23</tt> to cents like <tt>123</tt> and vice-versa.
-
-  class Product < ActiveRecord::Base
-    include ActionView::Helpers::NumberHelper
-
-    formatted :price, :with => :cents
-
-    private
-    def format_to_cents(amount)
-      _, operator, number, precision = *number.to_s.match(/^([+-])?(\d+)(?:[,.](\d+))?$/)
-      (BigDecimal("#{operator}#{number}.#{precision.to_i}") * 100).to_i
-    end
-
-    def format_from_cents(amount)
-      number = BigDecimal(number.to_s) / 100
-      number_to_currency(number, :unit => "", :separator => ",", :delimiter => "")
-    end
-  end
-
-  product = Product.new(:formatted_price => "1,23")
-  product.price
-  #=> 123
-
-  product.price = 456
-  product.formatted_price
-  #=> "4,56"
-
-== Maintainer
-
-* Nando Vieira (http://nandovieira.com.br)
-
-== License
-
-(The MIT License)
-
-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/lib/formatted_attributes/active_record.rb

@@ -1,39 +0,0 @@
-module FormattedAttributes
-  module ActiveRecord
-    def self.included(base)
-      base.instance_eval do
-        include InstanceMethods
-        extend ClassMethods
-      end
-    end
-
-    module ClassMethods
-      def formatted(*args)
-        options = args.extract_options!
-
-        args.each do |attr|
-          accessible_attributes << "formatted_#{attr}"
-
-          class_eval <<-RUBY
-            def #{attr}=(value)
-              @formatted_#{attr} = nil
-              write_attribute :#{attr}, value
-            end
-
-            def formatted_#{attr}
-              @formatted_#{attr} ||= format_from_#{options[:with]}(send(:#{attr}))
-            end
-
-            def formatted_#{attr}=(value)
-              self.send :#{attr}=, format_to_#{options[:with]}(value)
-              @formatted_#{attr} = value
-            end
-          RUBY
-        end
-      end
-    end
-
-    module InstanceMethods
-    end
-  end
-end

data/spec/formatted_attributes_spec.rb

@@ -1,44 +0,0 @@
-require "spec_helper"
-
-describe FormattedAttributes do
-  subject { Product.new }
-
-  context "formatted methods" do
-    it "should add getters" do
-      subject.should respond_to(:formatted_price)
-      subject.should respond_to(:formatted_shipping)
-    end
-
-    it "should add setters" do
-      subject.should respond_to(:formatted_price=)
-      subject.should respond_to(:formatted_shipping=)
-    end
-
-    it "should set initial value" do
-      subject.price = 12300
-      subject.formatted_price.should == "123,00"
-    end
-
-    it "should update formatted price" do
-      subject.price = 12300
-      subject.formatted_price.should == "123,00"
-
-      subject.price = 45600
-      subject.formatted_price.should == "456,00"
-    end
-
-    it "should set formatted value" do
-      subject.price = 12300
-      subject.formatted_price = "456,78"
-      subject.formatted_price.should == "456,78"
-      subject.price.should == 45678
-
-      subject.shipping = 67800
-      subject.formatted_shipping = "345,67"
-      subject.formatted_shipping.should == "345,67"
-      subject.shipping.should == 34567
-
-      subject.should be_valid
-    end
-  end
-end

data/spec/schema.rb

@@ -1,5 +0,0 @@
-ActiveRecord::Schema.define(:version => 0) do
-  create_table :products do |t|
-    t.integer :price, :shipping, :default => 0, :null => false
-  end
-end

data/spec/spec_helper.rb

@@ -1,25 +0,0 @@
-require "formatted_attributes"
-require "active_support/all"
-require "action_view/helpers/number_helper"
-
-ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
-
-load File.dirname(__FILE__) + "/schema.rb"
-
-class Product < ActiveRecord::Base
-  include ActionView::Helpers::NumberHelper
-  formatted :price, :shipping, :with => :cents
-
-  validates_numericality_of :price, :shipping, :only_integer => true
-
-  private
-  def format_to_cents(number)
-    _, operator, number, precision = *number.to_s.match(/^([+-])?(\d+)(?:[,.](\d+))?$/)
-    (BigDecimal("#{operator}#{number}.#{precision.to_i}") * 100).to_i
-  end
-
-  def format_from_cents(number)
-    number = BigDecimal(number.to_s) / 100
-    number_to_currency(number, :unit => "", :separator => ",", :delimiter => "")
-  end
-end