simple_form-bank_account_number 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2188cdec0054eac3d21d6f8a3140a0f9583dc13f
+  data.tar.gz: fbfcc9ff25ecda050792cf5e484b14fd2cda5738
+SHA512:
+  metadata.gz: e3eb8e1be8822635d0b19754ff813e5e3dd00d3344d389d460dfa8ede534b76b57ff82cf0977e5f79741c45d19cdc7dc30b444f753a798082746266cb19873d6
+  data.tar.gz: 088c58a15718874b6f7c72c22d5348e21ab6557a62d25cd867dd6403c4d07ac8a9120e9483f76d1405b04aab76e05175fb3561be9d91f5d2d4d89e3cc38b6c04

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+notifications:
+  email:
+    on_success: always
+    on_failure: always

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_form-bank_account_number.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bucky Box Limited
+
+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/README.md

@@ -0,0 +1,19 @@
+# SimpleForm::BankAccountNumber
+
+A [SimpleForm](https://github.com/plataformatec/simple_form) input field for bank account numbers.
+
+## Usage
+
+Just create a new input field with `:bank_account_number` as its type.
+Note that you need to explicitly set the `country` and `value` options, like this:
+
+`f.input_field :account_number, as: :bank_account_number, country: user.country, value: user.account_number`
+
+- the country is the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) representation
+- the value can't be inferred automatically unfortunately so you have to set it explicitly
+
+Also note that you'll get multiple values for each number part upon form submission.
+You probably want to concatenate them into one single number for your backend with something along these lines:
+
+`params[:bank_deposit][:account_number] = params[:bank_deposit][:account_number].join`
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts = "-w"
+end
+
+task :default => :spec

data/lib/simple_form/bank_account_number.rb

@@ -0,0 +1,68 @@
+require "simple_form"
+require "simple_form/bank_account_number/countries"
+require "simple_form/bank_account_number/version"
+
+module SimpleForm
+  module Inputs
+    class BankAccountNumberInput < NumericInput
+      def self.formatted_bank_account_number(full_number, country)
+        full_number = full_number.dup
+
+        fields = number_format(country).map do |part|
+          length = part[:format].source.scan(/\b\d}/).map(&:to_i).max
+          full_number.slice!(0, length || full_number.length)
+        end
+
+        unless full_number.empty?
+          raise ArgumentError, "format does not match (#{full_number.length} extra digits)"
+        end
+
+        fields.join("-")
+      end
+
+      # requires to set :country and :value
+      def input
+        country = options.delete(:country) || raise(ArgumentError, "You must set the :country key.")
+        full_number = options.fetch(:value) || ""
+        parts = self.class.formatted_bank_account_number(full_number, country).split("-").reverse
+
+        fields = self.class.number_format(country).map do |part|
+          input_html_options[:required] = "required"
+          input_html_options[:autocomplete] = "off"
+          input_html_options[:name] = "#{lookup_model_names.join("_")}[#{reflection_or_attribute_name}][]"
+          input_html_options[:pattern] = "^#{part[:format].source}$"
+          input_html_options[:title] = part[:label]
+          input_html_options[:style] = "width: auto; display: inline; margin-right: .2em"
+          input_html_options.delete(:country) # don't include it in the markup
+
+          # Twitter Bootstrap tooltips
+          input_html_options["data-toggle"] = "tooltip"
+          input_html_options["data-original-title"] = part[:label]
+          input_html_options["data-placement"] = "bottom"
+
+          if length = part[:format].source.scan(/\b\d}/).map(&:to_i).max
+            input_html_options[:size] = length
+            input_html_options[:maxlength] = length
+          else
+            input_html_options[:size] = nil
+            input_html_options[:maxlength] = nil
+          end
+
+          input_html_options[:value] = parts.pop
+
+          super
+        end
+
+        fields.join
+      end
+
+    private
+
+      def self.number_format(country)
+        SimpleForm::BankAccountNumber::COUNTRIES[country.upcase] ||
+          SimpleForm::BankAccountNumber::DEFAULT_FORMAT
+      end
+    end
+  end
+end
+

data/lib/simple_form/bank_account_number/countries.rb

@@ -0,0 +1,29 @@
+module SimpleForm
+  module BankAccountNumber
+    COUNTRIES = {
+      "AU" => [
+        { label: "6 digit BSB number", format: /\d{6}/ },
+        { label: "6 to 9 digit account number", format: /\d{6,9}/ },
+      ],
+      "CA" => [
+        { label: "8 or 9 digit transit number", format: /\d{8,9}/ },
+        { label: "7 to 12 digit account number", format: /\d{7,12}/ },
+      ],
+      "GB" => [
+        { label: "6 digit sort code", format: /\d{6}/ },
+        { label: "7 to 10 digit account number", format: /\d{7,10}/ },
+      ],
+      "NZ" => [
+        { label: "2 digit bank number", format: /\d{2}/ },
+        { label: "4 digit branch number", format: /\d{4}/ },
+        { label: "7 digit account number", format: /\d{7}/ },
+        { label: "2 or 3 digit suffix", format: /\d{2,3}/ },
+      ],
+    }
+
+    DEFAULT_FORMAT = [
+      { label: "account number", format: /[A-Z0-9]+/ }
+    ]
+  end
+end
+

data/lib/simple_form/bank_account_number/version.rb

@@ -0,0 +1,5 @@
+module SimpleForm
+  module BankAccountNumber
+    VERSION = "1.0.0"
+  end
+end

data/simple_form-bank_account_number.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_form/bank_account_number/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_form-bank_account_number"
+  spec.version       = SimpleForm::BankAccountNumber::VERSION
+  spec.authors       = ["Cédric Félizard"]
+  spec.email         = ["cedric@felizard.fr"]
+  spec.description   = %q{A SimpleForm input field for bank account numbers}
+  spec.summary       = %q{Bank account number field for SimpleForm}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency             "simple_form", "~> 2.1.0"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/simple_form/bank_account_number_spec.rb

@@ -0,0 +1,62 @@
+require "simple_form/bank_account_number"
+
+class CustomFormBuilder < SimpleForm::FormBuilder
+  class << self
+    def object
+      "custom_object"
+    end
+
+    def lookup_model_names
+      %w(model_name)
+    end
+
+    def text_field(*)
+    end
+  end
+end
+
+module SimpleForm::Inputs
+  describe BankAccountNumberInput do
+    describe ".formatted_bank_account_number" do
+      def assert country, number, formatted_number
+        expect(BankAccountNumberInput.formatted_bank_account_number(number, country)).to eq formatted_number
+      end
+
+      specify do
+        assert "AU", "484795453513423", "484795-453513423"
+        assert "GB", "40142431565517", "401424-31565517"
+        assert "NZ", "041587005000000", "04-1587-0050000-00"
+        assert "XX", "1234", "1234"
+      end
+
+      it "preserves the given number" do
+        number = "484795453513423"
+        BankAccountNumberInput.formatted_bank_account_number(number, "AU")
+
+        expect(number).to eq "484795453513423"
+      end
+    end
+
+    describe "#input" do
+      let(:options) do
+        {
+          country: "NZ",
+          value: "041587005000000",
+        }
+      end
+
+      it "generates the input field successfully" do
+        input = BankAccountNumberInput.new(
+          CustomFormBuilder, # builder class
+          "test_attribute", # attribute_name
+          "test_column", # column
+          "bank_account_number", # input_type
+          options
+        )
+
+        expect { input.input }.not_to raise_error
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: simple_form-bank_account_number
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cédric Félizard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simple_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: A SimpleForm input field for bank account numbers
+email:
+- cedric@felizard.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_form/bank_account_number.rb
+- lib/simple_form/bank_account_number/countries.rb
+- lib/simple_form/bank_account_number/version.rb
+- simple_form-bank_account_number.gemspec
+- spec/simple_form/bank_account_number_spec.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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Bank account number field for SimpleForm
+test_files:
+- spec/simple_form/bank_account_number_spec.rb