solidus_brazilian_adaptations 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54db548988b77722450cfb649c05d932f6f409a0a8649828b241bf844ad83b7a
-  data.tar.gz: d51a2a71f797caba7714e90cc94908c1d9d440858464d7f493327501ad79dbb3
+  metadata.gz: 004dffeaecbe2d9575ec31ae699aae9e3faffaf3b87da4c452e4d72da531b5a7
+  data.tar.gz: 578ec87ea251b6d6f3d4cce06ba432e8235e9a37f5e7050e66f2695073959da1
 SHA512:
-  metadata.gz: 49b156d068a22e8d9b7a987aba5679cdaa3e916050a83bac414f0a3ee56dfb06454e9815ab23b192ec8e5668146e472a123944ba9aeb8ddc67f440e8ece7fa2b
-  data.tar.gz: 54f6277b1cf922f82ae3ffa110e48e6a9af4e7a1731f2b11631ad90b863c21e89f35ebf963edb25a6c73098b34e0ae7ffcbccf735a16b972e6b0139d99acacd9
+  metadata.gz: 78007a55b7cd0df20a3e29af7fef6f0c75702ba73881e07b2a56e0394a7152ec6dd8238b98351c14bbdc8ce6f12d03f463620795ad3201fb5316f509afa69511
+  data.tar.gz: d4698a469fb2c16f642736302e42c34c28496597cd62eb3b754eee1305164a324700089270ef99193d836fd54518e5caa7c3cc6cb022c54e4248a62eb87c8d78

data/.gitignore

@@ -19,3 +19,4 @@ spec/examples.txt
 .rvmrc
 .ruby-version
 .ruby-gemset
+release.sh

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [v1.0.1.-t.1](https://github.com/ulysses-bull/solidus_brazilian_adaptations/tree/v1.0.1.-t.1) (2023-09-19)
+
+[Full Changelog](https://github.com/ulysses-bull/solidus_brazilian_adaptations/compare/e7afb9471571e91ab0d272436491ae190113f54d...v1.0.1.-t.1)
+
 
 
 \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -3,7 +3,7 @@
 [![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_brazilian_adaptations.svg?style=shield)](https://circleci.com/gh/solidusio-contrib/solidus_brazilian_adaptations)
 [![codecov](https://codecov.io/gh/solidusio-contrib/solidus_brazilian_adaptations/branch/master/graph/badge.svg)](https://codecov.io/gh/solidusio-contrib/solidus_brazilian_adaptations)
 
-<!-- Explain what your extension does. -->
+Essa gem tem como objetivo adaptar os modelos do Solidus para se adequar aos padrões brasileiros, tais como a criação dos atributos CPF/CNPJ (tax_id) em Spree::Order, e número (number) do imóvel e bairro (district) em Spree::Address.
 
 ## Installation
 
@@ -21,36 +21,249 @@ bin/rails generate solidus_brazilian_adaptations:install
 
 ## Usage
 
-No starter frontend, editar a partial `app/views/checkouts/_checkout_step.html.erb` adicionando um input para preencher o CPF/CNPJ:
+### Configurações
+A partir do initializer da gem é possivel configurar se será permitido efetuar compras utilizando CNPJ. Por padrão é essa opção é `true`.
+
+### Storefront
+Essa gem utiliza o starter frontend como base, então os exemplos serão feitos a partir de suas views.
+
+Para adicionar os campos de CPF/CNPJ, número e bairro é possivel editar o form da etapa de endereço. Porém a edição é feita em duas partials diferentes:
+
+Na partial `app/views/checkouts/_checkout_step.html.erb` o seguinte HTML referente ao **CPF/CNPJ** pode ser inserido logo abaixo ao input de e-mail:
 ```erb
-<% label = SolidusBrazilianAdaptations.config.allow_cnpj ? "CPF/CPNJ" : "CPF" %>
+
 <%= form_for order, url: update_checkout_path(order.state), html: { id: "checkout_form_#{order.state}" } do |form| %>
   <% if order.state == "address" || !order.email? %>
     <div class="text-input">
       <%= form.label :email, 'E-Mail:' %>
       <%= form.email_field :email, required: true, placeholder: 'name@example.com' %>
     </div>
+
+    <!-- Adicionar -->
+    <% label = SolidusBrazilianAdaptations.config.allow_cnpj ? "CPF/CPNJ" : "CPF" %>
     <div class="text-input" style="margin-top: 4px;">
       <%= form.label :tax_id, "#{label}:" %>
       <%= form.text_field :tax_id, required: true, placeholder: label %>
     </div>
+    <!-- ********* -->
+
   <% end %>
 
   <%= render "checkouts/steps/#{order.state}_step", form: form, differentiator: @differentiator %>
 <% end %>
 ```
 
-E editar `app/views/checkouts/steps/address_step/_address_inputs.html.erb` adicionando dois novos campos para o número e bairro:
+E na partial `app/views/checkouts/steps/address_step/_address_inputs.html.erb` adicionar o seguinte código referente ao **número** e **bairro**, podendo ser alterada a ordem dos campos:
 ```erb
-<div class="text-input">
-  <%= form.label :number, "Número:" %>
-  <%= form.text_field :number, required: true %>
-</div>
+  <!-- Adicionar -->
+  <div class="text-input">
+    <%= form.label :number, "Número:" %>
+    <%= form.text_field :number, required: true %>
+  </div>
+  <!-- ********* -->
+
+  <div class="text-input">
+    <%= form.label :address2, "#{I18n.t("spree.street_address_2")}:" %>
+    <%= form.text_field :address2, autocomplete: "#{address_type} address-line2" %>
+  </div>
+
+  <!-- Adicionar -->
+  <div class="text-input">
+    <%= form.label :district, "Bairro:" %>
+    <%= form.text_field :district, required: true %>
+  </div>
+  <!-- ********* -->
+
+  <div class="text-input">
+    <%= form.label :city, "#{I18n.t("spree.city")}:" %>
+    <%= form.text_field :city, required: true, autocomplete: "#{address_type} address-level2" %>
+  </div>
+```
+
+### Admin
+
+Para visualizar os campos de **CPF/CNPJ**, **número** e **bairro** no painel do Admin na aba `Order/Order_Number/Customer Details` é necessário criar as seguintes views em seu projeto:
+
+Essas novas views irão sobrescrever as padrões, localizadas na gem `solidus_backend`. Portanto, você deve ficar atento às atualizações do Solidus, pois ao sobrescrever as views as atualizações não serão aplicadas.
+
+`app/views/spree/admin/orders/customer_details/_form.html.erb`
+```erb
+<fieldset data-hook="admin_customer_detail_form_fields" class="no-border-top">
+
+  <fieldset class="index no-border-bottom" data-hook="customer_guest">
+    <legend align="center"><%= t('spree.account') %></legend>
+
+    <div data-hook="customer_fields" class="row">
+      <div class="col-9">
+        <div class="field">
+          <%= f.label :email %>
+          <%= f.email_field :email, required: true, class: 'fullwidth' %>
+        </div>
+
+        <!-- Adicionado -->
+        <div class="field">
+          <%= f.label :tax_id, "CPF/CNPJ" %>
+          <%= f.text_field :tax_id, required: true, class: 'fullwidth' %>
+        </div>
+        <!-- ********* -->
+      </div>
+      <div class="col-3">
+        <div class="field">
+          <%= label_tag nil, t('spree.guest_checkout') %>
+          <ul>
+            <% if @order.completed? %>
+              <li>
+                <%= @order.user.nil? ? t('spree.say_yes') : t('spree.say_no') %>
+              </li>
+            <% else %>
+              <% guest = @order.user.nil? %>
+              <li>
+                <label>
+                  <%= radio_button_tag :guest_checkout, true, guest %>
+                  <%= t('spree.say_yes') %>
+                </label>
+              </li>
+              <li>
+                <label>
+                  <%= radio_button_tag :guest_checkout, false, !guest, disabled: @order.cart? %>
+                  <%= t('spree.say_no') %>
+                </label>
+              </li>
+              <%= hidden_field_tag :user_id, @order.user_id %>
+            <% end %>
+          </ul>
+        </div>
+      </div>
+    </div>
+  </fieldset>
+
+  <div class="row">
+    <% if Spree::Config[:order_bill_address_used] %>
+      <div class="col-6" data-hook="bill_address_wrapper">
+        <fieldset class="no-border-bottom">
+          <legend align="center"><%= t('spree.billing_address') %></legend>
+          <div class="js-billing-address">
+            <%= f.fields_for :bill_address do |ba_form| %>
+              <%= render partial: 'spree/admin/shared/address_form', locals: { f: ba_form, type: "billing" } %>
+            <% end %>
+          </div>
+        </fieldset>
+      </div>
+    <% end %>
 
-<div class="text-input">
-  <%= form.label :district, "Bairro:" %>
-  <%= form.text_field :district, required: true %>
+    <div class="col-6" data-hook="ship_address_wrapper">
+      <fieldset class="no-border-bottom">
+        <legend align="center"><%= t('spree.shipping_address') %></legend>
+        <% if Spree::Config[:order_bill_address_used] %>
+          <div class="field">
+            <span data-hook="use_billing">
+              <label>
+                <%= check_box_tag 'order[use_billing]', '1', (@order.ship_address.new_record? && @order.bill_address == @order.ship_address) %>
+                <%= t('spree.use_billing_address') %>
+              </label>
+            </span>
+          </div>
+        <% end %>
+
+        <div class="js-shipping-address">
+          <%= f.fields_for :ship_address do |ba_form| %>
+            <%= render partial: 'spree/admin/shared/address_form', locals: { f: ba_form, type: "shipping" } %>
+          <% end %>
+        </div>
+      </fieldset>
+    </div>
+  </div>
+
+  <div class="clear"></div>
+
+  <div class="form-buttons filter-actions actions" data-hook="buttons">
+    <%= button_tag t('spree.actions.update'), class: 'btn btn-primary' %>
+  </div>
+</fieldset>
+```
+`app/views/spree/admin/shared/_address_form.html.erb`
+```erb
+<% s_or_b = type.chars.first %>
+
+<div id="<%= type %>" data-hook="address_fields">
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :name %>
+    <%= f.text_field :name, class: 'fullwidth' %>
+  </div>
+
+  <% if Spree::Config[:company] %>
+    <div class="field <%= "#{type}-row" %>">
+      <%= f.label :company %>
+      <%= f.text_field :company, class: 'fullwidth' %>
+    </div>
+  <% end %>
+
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :address1 %>
+    <%= f.text_field :address1, class: 'fullwidth' %>
+  </div>
+
+  <!-- Adicionado -->
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :number, "Número" %>
+    <%= f.text_field :number, class: 'fullwidth' %>
+  </div>
+  <!-- ********** -->
+
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :address2 %>
+    <%= f.text_field :address2, class: 'fullwidth' %>
+  </div>
+
+  <!-- Adicionado -->
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :district, "Bairro" %>
+    <%= f.text_field :district, class: 'fullwidth' %>
+  </div>
+  <!-- ********** -->
+
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :city %>
+    <%= f.text_field :city, class: 'fullwidth' %>
+  </div>
+
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :zipcode %>
+    <%= f.text_field :zipcode, class: 'fullwidth' %>
+  </div>
+
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :country_id, Spree::Country.model_name.human %>
+    <span id="<%= s_or_b %>country">
+      <%= f.collection_select :country_id, available_countries, :id, :name, {}, {class: 'custom-select fullwidth js-country_id'} %>
+    </span>
+  </div>
+
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :state_id, Spree::State.model_name.human %>
+    <span id="<%= s_or_b %>state">
+      <%= f.hidden_field :state_name, value: nil %>
+      <% states = f.object.country.try(:states).nil? ? [] : f.object.country.states %>
+      <%= f.text_field :state_name,
+            style: "display: #{states.empty? ? 'block' : 'none' };",
+            disabled: !states.empty?, class: 'fullwidth state_name js-state_name' %>
+      <%= f.hidden_field :state_id, value: nil %>
+      <%= f.collection_select :state_id,
+            states.sort,
+            :id, :name,
+            { include_blank: true },
+            { class: 'custom-select fullwidth js-state_id',
+              style: "display: #{states.empty? ? 'none' : 'block' };",
+              disabled: states.empty? } %>
+    </span>
+  </div>
+
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :phone %>
+    <%= f.phone_field :phone, class: 'fullwidth' %>
+  </div>
 </div>
+
 ```
 
 ## Development

data/db/migrate/20230911133000_add_tax_id_to_spree_orders.rb

@@ -1,5 +1,5 @@
 class AddTaxIdToSpreeOrders < ActiveRecord::Migration[7.0]
   def change
-    add_column :spree_orders, :tax_id, :string, default: ""
+    add_column :spree_orders, :tax_id, :string, default: "", if_not_exists: true
   end
 end

data/db/migrate/20230911133157_add_number_district_to_addresses.rb

@@ -1,6 +1,6 @@
 class AddNumberDistrictToAddresses < ActiveRecord::Migration[7.0]
   def change
-    add_column :spree_addresses, :number, :string
-    add_column :spree_addresses, :district, :string
+    add_column :spree_addresses, :number, :string, if_not_exists: true
+    add_column :spree_addresses, :district, :string, if_not_exists: true
   end
 end

data/lib/solidus_brazilian_adaptations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusBrazilianAdaptations
-  VERSION = '1.0.0'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_brazilian_adaptations
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - ulysses-bull
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-12 00:00:00.000000000 Z
+date: 2023-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solidus_core