solidus_billing_address 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4cdf683fd2a9526cc2b6226f8d6dbc63fec934b8044d9dac03bf207aa9d4e5c
-  data.tar.gz: 78c2206ba00c3bd8aa87a856a7c5163adb94066b7dedf44e20240d95a693e2db
+  metadata.gz: 9db5d5ce2e10657108c8eeb69d3cbe26eb42a06ab3a7882a4a4f1670af98e6bd
+  data.tar.gz: 41d0f3ca2285afcd95677322b1a2383cac2465139edce0cac0db87d33b0d1cec
 SHA512:
-  metadata.gz: '098546ee0a9fa9fa3361fa2ec1d358258515c2dea96391cc9878a9c0e5cfde83fea1f89ed07090555b34bbcc836a484349ea23858ca287c42ac02498e860c21e'
-  data.tar.gz: c6cd06cd6172b1f986bfd0ba772a80cf4fcc1e08be6ccb08e16b8f19f385089b783e94687aa3779fe944fb2a09d891d8a007a1351961aa1eb062a800a1ecdd78
+  metadata.gz: c91a59a79b2f1a6ed0a95940b098c002b8c5fc0e3f8fabaf516ddab084438ac3cced793770cef922d2a6506d1198bd4981595775f3fe12ada995da97068f9eca
+  data.tar.gz: edad14d038f0278d003c742b2a94d99f4992f8e959aabd5172e96991ef740b7c10785fa8af99319ef5dcddfedf3b4e1768719ef86f6708729c43dcce900385ae

data/README.md

@@ -2,6 +2,8 @@
 
 [![Build Status](https://travis-ci.org/welaika/solidus_billing_address.svg?branch=master)](https://travis-ci.org/welaika/solidus_billing_address)
 
+Manage italian billing address requirements in Solidus! Mamma mia!
+
 This extension adds some new attributes to billing address form in `solidus_frontend`, like:
 
 * VAT number
@@ -40,10 +42,6 @@ bundle
 bundle exec rails g solidus_billing_address:install
 ```
 
-**NOTE**: if you have already some addresses in your database, then you should create a migration (or 
-a rake task) to fill in `address_type`. I didn't do this now because I'm using this extension on a new project.
-PR is welcome :)
-
 Testing
 -------
 
@@ -60,6 +58,12 @@ bundle
 DB=postgres bundle exec rake
 ```
 
+You can also test against a specific solidus branch with:
+
+```shell
+SOLIDUS_BRANCH=v2.9 DB=postgres bundle exec rake
+```
+
 When testing your application's integration with this extension you may use its factories.
 Simply add this require statement to your spec_helper:
 

data/app/assets/javascripts/spree/frontend/solidus_billing_address.js

@@ -4,9 +4,6 @@
 
 function toggleAddressFields(customerType) {
   if (customerType === 'business') {
-    $('#order_bill_address_attributes_personal_tax_code').prop('disabled', true);
-    $('#bpersonal_tax_code').hide();
-
     $('#order_bill_address_attributes_vat_number').prop('disabled', false);
     $('#bvat_number').show();
 
@@ -19,9 +16,6 @@ function toggleAddressFields(customerType) {
     $('#order_bill_address_attributes_company').prop('disabled', false);
     $('#bcompany').show();
   } else if (customerType === 'private') {
-    $('#order_bill_address_attributes_personal_tax_code').prop('disabled', false);
-    $('#bpersonal_tax_code').show();
-
     $('#order_bill_address_attributes_vat_number').prop('disabled', true);
     $('#bvat_number').hide();
 

data/app/assets/stylesheets/spree/backend/solidus_billing_address.css

@@ -2,3 +2,14 @@
 Placeholder manifest file.
 the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
 */
+label[for="order_bill_address_attributes_firstname"] {
+  margin-top: 0px;
+}
+
+label[for="order_ship_address_attributes_firstname"] {
+  margin-top: 27px;
+}
+
+label[for="user_ship_address_attributes_firstname"] {
+  margin-top: 72px;
+}

data/app/models/solidus_billing_address/address_decorator.rb

@@ -4,43 +4,37 @@ module SolidusBillingAddress
   module AddressDecorator
     BILLING_ONLY_ATTRS = %w[customer_type personal_tax_code vat_number billing_email einvoicing_code].freeze
 
-    def self.prepended(base) # rubocop:disable Metrics/AbcSize
-      base.extend(ClassMethods)
-      base.validates :last_name, presence: true
-      base.validates :vat_number, valvat: true, allow_blank: true
-      base.validates :billing_email, 'spree/email' => true, allow_blank: true
+    def self.prepended(base) # rubocop:disable Metrics/MethodLength
+      base.before_validation :normalize_vat_number
+      base.before_validation :normalize_personal_tax_code
+      base.before_validation :normalize_einvoicing_code
+      base.before_validation :normalize_billing_email
+
+      base.validates :last_name, presence: true # NOTE: solidus does not require its presence, but we do!
 
+      base.validates :vat_number, valvat: true, allow_blank: true
       base.validates :vat_number, presence: true, if: :vat_number_required?
-      base.validates :personal_tax_code, presence: true, if: :personal_tax_code_required?
 
-      base.scope :billing, -> { where(address_type: 'billing') }
-      base.scope :shipping, -> { where(address_type: 'shipping') }
-      base.scope :billing_private, -> { billing.where(customer_type: 'private') }
-      base.scope :billing_business, -> { billing.where(customer_type: 'business') }
-    end
+      base.validates :personal_tax_code, italian_personal_tax_code: { allow_vat_numbers: ->(a) { a.business_customer? } },
+                                         allow_blank: true,
+                                         if: :italian_personal_tax_code_format_required?
+      base.validates :personal_tax_code, presence: true, if: :personal_tax_code_required?
 
-    # NOTE: This method overrides the one in `Spree::Address` class.
-    #       When address type are the same, we match against all value attributes.
-    #       When we match different address types (billing vs shipping), we care only
-    #       about the base address fields (we remove the billing only attributes). This is
-    #       useful when we want to know that a package should be shipped to the same location
-    #       of a billing address.
-    def ==(other_address) # rubocop:disable Naming/BinaryOperatorParameterName
-      return false unless other_address&.respond_to?(:value_attributes)
+      base.validates :billing_email, 'spree/email' => true, allow_blank: true
+      base.validates :billing_email, presence: true, if: :billing_email_required?
 
-      if address_type == other_address.address_type
-        value_attributes == other_address.value_attributes
-      else
-        excluded_attributes = BILLING_ONLY_ATTRS + %w[address_type]
-        value_attributes.except(*excluded_attributes) ==
-          other_address.value_attributes.except(*excluded_attributes)
-      end
+      base.validates :einvoicing_code, italian_einvoicing_code: true,
+                                       allow_blank: true,
+                                       if: :italian_einvoicing_code_format_required?
+      base.validates :einvoicing_code, presence: true, if: :einvoicing_code_required?
     end
 
     def shipping?
       address_type == 'shipping'
     end
 
+    # NOTE: actually, a billing address can be also a shipping address because
+    # solidus does not duplicate the records, but it will be ok :)
     def billing?
       address_type == 'billing'
     end
@@ -60,20 +54,60 @@ module SolidusBillingAddress
     end
 
     def personal_tax_code_required?
-      billing? && private_customer?
-    end
-
-    module ClassMethods
-      def shipping_default_attributes
-        {
-          address_type: 'shipping',
-          customer_type: nil,
-          personal_tax_code: nil,
-          vat_number: nil,
-          billing_email: nil,
-          einvoicing_code: nil
-        }
-      end
+      billing?
+    end
+
+    def italian?
+      country_iso == 'IT'
+    end
+
+    def italian_business_customer?
+      italian? && business_customer?
+    end
+
+    def italian_business_customer_billing?
+      italian_business_customer? && billing?
+    end
+
+    def einvoicing_code_required?
+      italian_business_customer_billing? && billing_email.blank?
+    end
+
+    def billing_email_required?
+      italian_business_customer_billing? && einvoicing_code.blank?
+    end
+
+    def italian_personal_tax_code_format_required?
+      personal_tax_code_required? && italian?
+    end
+
+    def italian_einvoicing_code_format_required?
+      einvoicing_code_required? && italian?
+    end
+
+    def normalize_vat_number
+      return if vat_number.blank?
+
+      self.vat_number = vat_number.tr(' ', '').upcase
+      self.vat_number = "IT#{vat_number}" if italian? && vat_number.match?(/\A[0-9]{11}\z/)
+    end
+
+    def normalize_personal_tax_code
+      return if personal_tax_code.blank?
+
+      self.personal_tax_code = personal_tax_code.tr(' ', '').upcase
+    end
+
+    def normalize_einvoicing_code
+      return if einvoicing_code.blank?
+
+      self.einvoicing_code = einvoicing_code.tr(' ', '').upcase
+    end
+
+    def normalize_billing_email
+      return if billing_email.blank?
+
+      self.billing_email = billing_email.tr(' ', '').downcase
     end
 
     Spree::Address.prepend self

data/app/views/spree/address/_form.html.erb

@@ -19,6 +19,8 @@
         <% end %>
       </div>
     </div>
+  <% else %>
+    <%= form.hidden_field :customer_type, value: nil %>
   <% end %>
 
   <div class="field field-required" id=<%="#{address_id}firstname" %>>
@@ -58,6 +60,11 @@
       <%= form.label :einvoicing_code, t('activerecord.attributes.spree/address.einvoicing_code') %>
       <%= form.text_field :einvoicing_code, autocomplete: address_type + 'einvoicing_code' %>
     </div>
+  <% else %>
+      <%= form.hidden_field :personal_tax_code, value: nil %>
+      <%= form.hidden_field :vat_number, value: nil%>
+      <%= form.hidden_field :billing_email, value: nil %>
+      <%= form.hidden_field :einvoicing_code, value: nil %>
   <% end %>
 
   <div class="field field-required" id=<%="#{address_id}address1" %>>

data/app/views/spree/admin/shared/_address_form.html.erb

@@ -1,5 +1,7 @@
 <% s_or_b = type.chars.first %>
 
+<%= f.hidden_field :address_type, value: type %>
+
 <div id="<%= type %>" data-hook="address_fields">
   <% if type == 'billing' %>
     <div class="field <%= "#{type}-row" %>">
@@ -17,6 +19,8 @@
         <%= t('spree.customer_type.business') %>
       <% end %>
     </div>
+  <% else %>
+    <%= f.hidden_field :customer_type, value: nil %>
   <% end %>
 
   <div class="field <%= "#{type}-row" %>">
@@ -56,6 +60,11 @@
       <%= f.label :einvoicing_code %>
       <%= f.text_field :einvoicing_code, class: 'fullwidth' %>
     </div>
+  <% else %>
+      <%= f.hidden_field :personal_tax_code, value: nil %>
+      <%= f.hidden_field :vat_number, value: nil%>
+      <%= f.hidden_field :billing_email, value: nil %>
+      <%= f.hidden_field :einvoicing_code, value: nil %>
   <% end %>
 
   <div class="field <%= "#{type}-row" %>">

data/app/views/spree/shared/_address.html.erb

@@ -6,14 +6,12 @@
     </div>
   <% end %>
 
-  <% if address.billing? %>
-    <div class="invoice">
-      <%= address.personal_tax_code if address.personal_tax_code.present? %> 
-      <%= address.vat_number if address.vat_number.present? %>
-      <%= address.billing_email if address.billing_email.present? %>
-      <%= address.einvoicing_code if address.einvoicing_code.present? %>
-    </div>
-  <% end %>
+  <div class="invoice">
+    <%= address.personal_tax_code if address.personal_tax_code.present? %> 
+    <%= address.vat_number if address.vat_number.present? %>
+    <%= address.billing_email if address.billing_email.present? %>
+    <%= address.einvoicing_code if address.einvoicing_code.present? %>
+  </div>
 
   <div class="adr">
     <div class="street-address">

data/config/locales/en.yml

@@ -4,14 +4,28 @@
 en:
   spree:
     customer_type:
-      private: 'Private'
       business: 'Business'
+      private: 'Private'
 
   activerecord:
     attributes:
-      spree/address:
-        personal_tax_code: 'Personal tax code'
-        customer_type: 'Customer type'
-        vat_number: 'VAT number'
+      spree/address: &spree_address_attributes
         billing_email: 'Billing email'
+        customer_type: 'Customer type'
         einvoicing_code: 'E-Invoicing code'
+        personal_tax_code: 'Personal tax code'
+        vat_number: 'VAT number'
+      spree/order/bill_address:
+        <<: *spree_address_attributes
+      spree/order/ship_address:
+        <<: *spree_address_attributes
+    errors:
+      models:
+        spree/address:
+          attributes:
+            billing_email:
+              blank: 'cannot be blank'
+            einvoicing_code:
+              blank: 'cannot be blank'
+            personal_tax_code:
+              invalid: 'is invalid'

data/config/locales/it.yml

@@ -4,14 +4,28 @@
 it:
   spree:
     customer_type:
-      private: 'Privato'
       business: 'Business'
+      private: 'Privato'
 
   activerecord:
     attributes:
-      spree/address:
-        personal_tax_code: 'Codice fiscale'
-        customer_type: 'Tipo di cliente'
-        vat_number: 'Partita IVA'
+      spree/address: &spree_address_attributes
         billing_email: 'Email PEC'
+        customer_type: 'Tipo di cliente'
         einvoicing_code: 'Codice SDI (fatturazione elettr.)'
+        personal_tax_code: 'Codice fiscale'
+        vat_number: 'Partita IVA'
+      spree/order/bill_address:
+        <<: *spree_address_attributes
+      spree/order/ship_address:
+        <<: *spree_address_attributes
+    errors:
+      models:
+        spree/address:
+          attributes:
+            billing_email:
+              blank: 'o il codice SDI non possono essere lasciati entrambi in bianco'
+            einvoicing_code:
+              blank: 'o la PEC non possono essere lasciati entrambi in bianco'
+            personal_tax_code:
+              invalid: 'non è valido'

data/db/migrate/20190426140409_add_address_type_to_spree_addresses.rb

@@ -2,6 +2,6 @@
 
 class AddAddressTypeToSpreeAddresses < ActiveRecord::Migration[5.2]
   def change
-    add_column :spree_addresses, :address_type, :string, default: 'billing'
+    add_column :spree_addresses, :address_type, :string
   end
 end

data/lib/active_model/validations/italian_einvoicing_code_validator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ItalianEinvoicingCodeValidator < ActiveModel::EachValidator
+  FORMAT = Regexp.compile('\A[A-Z0-9]{7}\z')
+
+  def validate_each(record, attribute, value)
+    return if options[:allow_blank] && value.blank?
+
+    record.errors.add(attribute, :invalid) unless value.match(FORMAT)
+  end
+end

data/lib/active_model/validations/italian_personal_tax_code_validator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Thanks to https://github.com/freego/italian_job
+
+class ItalianPersonalTaxCodeValidator < ActiveModel::EachValidator
+  REGEX = Regexp.compile('\A[A-Z]{6}[0-9]{2}[A-Z][0-9]{2}[A-Z][0-9]{3}[A-Z]\z')
+  BUSINESS_REGEX = Regexp.compile('\A(?:IT)?[0-9]{11}\z')
+
+  DISPARI = [1, 0, 5, 7, 9, 13, 15, 17, 19, 21, 1, 0, 5, 7, 9, 13, 15, 17, 19, 21,
+             2, 4, 18, 20, 11, 3, 6, 8, 12, 14, 16, 10, 22, 25, 24, 23].freeze
+
+  def validate_each(record, attribute, value)
+    return if options[:allow_blank] && value.blank?
+    return if allow_vat_numbers?(record) && value.match(BUSINESS_REGEX)
+
+    record.errors.add(attribute, :invalid) unless control_code_valid?(value)
+  end
+
+  private
+
+  def allow_vat_numbers?(record)
+    return true if options[:allow_vat_numbers] == true
+    return true if options[:allow_vat_numbers].respond_to?(:call) && options[:allow_vat_numbers].call(record)
+
+    false
+  end
+
+  def control_code_valid?(value) # rubocop:disable Metrics/AbcSize
+    return false unless value.match(REGEX)
+
+    odds = []
+    evens = []
+    value[0..14].split('').each_with_index { |e, i| (i + 1).odd? ? odds << e : evens << e }
+    odd = odds.inject(0) { |sum, current_char| sum + DISPARI[(current_char.ord < 65 ? current_char.to_i : ((current_char.ord - 54) - 1))] }
+    even = evens.inject(0) { |sum, current_char| sum + (current_char.ord < 65 ? current_char.to_i : current_char.ord - 65) }
+    (((odd + even) % 26) + 65).chr == value[15].chr
+  end
+end

data/lib/solidus_billing_address/factories.rb

@@ -29,7 +29,8 @@ FactoryBot.modify do
     trait :business_customer do
       customer_type { 'business' }
       vat_number { 'IT10300060018' }
-      billing_email { 'foo@example.com' }
+      personal_tax_code { 'RSSMRA85H12D553D' }
+      billing_email { 'foo@pec.example.com' }
       einvoicing_code { 'SZLUBAI' }
     end
 

data/lib/solidus_billing_address/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusBillingAddress
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/solidus_billing_address.rb

@@ -4,3 +4,5 @@ require 'solidus_core'
 require 'solidus_billing_address/engine'
 require 'valvat/local'
 require 'active_model/validations/valvat_validator'
+require 'active_model/validations/italian_personal_tax_code_validator'
+require 'active_model/validations/italian_einvoicing_code_validator'

data/spec/dummy/config/credentials.yml.enc

@@ -1 +1 @@
-3Ayvb6OneQ2INTDNOCvsG9kkajR32uj/rWEzuH6Xni6zeIHngk316rVEmmGXxWN2gCFEKUSoxmYbzNrK5rbsUiLL6JBeEN3bAidRT+0ag5YvhhubLGtiIiAPezpBMHop3irktfS+7TCPd/ZwQH/SQg/b9DVVvqzFbNmTCnOctGbza2RYvgjdBBFyTxoGdZKC5ZOwclweLrBESYZw2l2dVu1mRoX3NOOp273xjdq/OlHAbhgH86FTG5YbXu6HpKP1T0rL9vY4jbMONvOV5Hiso431qLROCDkpwgkoqJ159SKVvJ09M5C82/xJ6jK3cUvOXbkhbxJS7RRSCveZeEin9/5rCE36+HtZPnO3G/WYbejaBJtsb11/nA5hfi+TeWDJvcsSw+CIue7ydhbvHzJLnU/gk+UvxCMrEUsU--xLTMuPTIClrZJ8W8--9xI9t377tqeYjSjX/l/uug==
+eQk9CWzeqaSh6sseDp4IDdExC7Gnrc14bUmBTKUHPhZySS0BHD7ojIuhk8plqp9b5d3Ooitxauh2issjMNUTwUR4yVAHuozSxv7xxGN5BVQV0sFpGbWjuIyNUKm4NWfCP2DfVPiPgp3TwGA0ANQl3F7leFHlJX1Nd8Hgz865WqCJhAGk1yXSozEpXHF9tNeXAZieCDZqzuOzugfKx0wMHWFZtY2izu/pZP4WnBUSg1S7EkG64qjwJKIIjbGQUTUt0e2EjDPV4wCxR5cH2MRNWJdEMb1R9PKabBXkJ3+TzSO+CK6vyf46ugPvPGzUfiEEn5ScKKK/l+wVaWizc/7O+dTYPimnOYrm8RFFSql0qoavNUQfyREnYev0M/CED0Tqso3gDK3dsNqHPPJ8iPKXG7UPrZSang4pf3JF--P+IQSMstVv3HJ61O--FpcYpfji2e2rW7l0S6QlnA==

data/spec/dummy/config/master.key

@@ -1 +1 @@
-0da04a5f6ce868affe254b572c8cd710
+7cb41ecf62f4a55fff7d019cdc2bb580

data/spec/dummy/db/migrate/20190920154671_add_address_type_to_spree_addresses.solidus_billing_address.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+# This migration comes from solidus_billing_address (originally 20190426140409)
+
+class AddAddressTypeToSpreeAddresses < ActiveRecord::Migration[5.2]
+  def change
+    add_column :spree_addresses, :address_type, :string
+  end
+end

data/spec/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2019_08_23_131047) do
+ActiveRecord::Schema.define(version: 2019_09_20_154671) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -69,7 +69,7 @@ ActiveRecord::Schema.define(version: 2019_08_23_131047) do
     t.string "vat_number"
     t.string "billing_email"
     t.string "einvoicing_code"
-    t.string "address_type", default: "billing"
+    t.string "address_type"
     t.index ["country_id"], name: "index_spree_addresses_on_country_id"
     t.index ["firstname"], name: "index_addresses_on_firstname"
     t.index ["lastname"], name: "index_addresses_on_lastname"