solidus_address_book 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e29b309ed59a46f6c4d92836e0ea7e0bef0d02d0e05f6898a5732d5c91222b83
+  data.tar.gz: 3ec20b3bb838b872b00c18c84a4136ca30c0bb5e72974a942d1f2e099b3bf57e
+SHA512:
+  metadata.gz: fba1a134b5a2f637cec525ac4704df909ac1998ba302c5c7746684eef59cf8c904c45ffeed5c93c66054fa46594f61956a52e1526b4c9a5db4f0437780201d92
+  data.tar.gz: 2eed12772aa1d22393c2b4ebb9d023e679f49c8b29472c84387ee59d79915fda6570155544b5d3d2463d8e4298315b45e6c95c84c54cc7996a79e774ff34e219

data/LICENSE

@@ -0,0 +1,23 @@
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, 
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, 
+      this list of conditions and the following disclaimer in the documentation 
+      and/or other materials provided with the distribution.
+    * Neither the name of the Rails Dog LLC nor the names of its 
+      contributors may be used to endorse or promote products derived from this 
+      software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,49 @@
+# SolidusAddressBook
+
+[![Build Status](https://travis-ci.org/jtapia/solidus_address_book.svg?branch=master)](https://travis-ci.org/jtapia/solidus_address_book)
+
+This extension allows registered users to have multiple shipping & billing addresses and select each of them on checkout.
+
+This extension is a solidus version of [spree_address_book extension](https://github.com/spree-contrib/spree_address_book)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'solidus_address_book', github: 'jtapia/solidus_address_book'
+```
+
+Then run the following:
+
+```console
+$ bundle install
+$ bundle exec rails g solidus_address_book:install
+```
+
+## Preview
+
+![account-index](https://user-images.githubusercontent.com/957520/59891993-f2d90180-939c-11e9-8812-1e4aea887734.png)
+![checkout user addresses](https://user-images.githubusercontent.com/957520/59891953-d76df680-939c-11e9-8395-6ff728aff51a.png)
+![edit address form](https://user-images.githubusercontent.com/957520/59891955-d8068d00-939c-11e9-9b90-1cdf70d75dbe.png)
+![new address form](https://user-images.githubusercontent.com/957520/59891956-d8068d00-939c-11e9-8e6a-ae079f7afa1a.png)
+![checkout address options](https://user-images.githubusercontent.com/957520/59892001-fbc9d300-939c-11e9-8571-d18a32a06868.png)
+![checkout address options](https://user-images.githubusercontent.com/957520/59892002-fbc9d300-939c-11e9-8873-b898743b329a.png)
+![checkout address options](https://user-images.githubusercontent.com/957520/59892003-fbc9d300-939c-11e9-9101-277b460c3375.png)
+![checkout address options](https://user-images.githubusercontent.com/957520/59892004-fbc9d300-939c-11e9-88b3-f5a1efecdad0.png)
+
+## Testing
+
+Run the following to automatically build a dummy app and run the tests:
+
+```console
+$ bundle exec rake
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jtapia/solidus_address_book.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_address_book'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/frontend/solidus_address_book.js.erb

@@ -0,0 +1,59 @@
+//= require spree/frontend
+//= require spree/frontend/solidus_auth
+
+(function($) {
+  $(document).ready(function(){
+    if ($('.select_address').length > 0) {
+      $('input#order_use_billing').unbind('change');
+
+      hide_address_form('billing');
+      hide_address_form('shipping');
+
+      if ($('input#order_use_billing').is(':checked')) {
+        $('#shipping .select_address').hide();
+      }
+
+      $('input#order_use_billing').click(function() {
+        if ($(this).is(':checked')) {
+          $('#shipping .select_address').hide();
+          hide_address_form('shipping');
+        } else {
+          $('#shipping .select_address').show();
+          if ($("input[name='order[ship_address_id]']:checked").val() == '0') {
+            show_address_form('shipping');
+          } else {
+            hide_address_form('shipping');
+          }
+        }
+      });
+
+      $("input[name='order[bill_address_id]']:radio").change(function(){
+        if ($("input[name='order[bill_address_id]']:checked").val() == '0') {
+          show_address_form('billing');
+        } else {
+          hide_address_form('billing');
+        }
+      });
+
+      $("input[name='order[ship_address_id]']:radio").change(function(){
+        if ($("input[name='order[ship_address_id]']:checked").val() == '0') {
+          show_address_form('shipping');
+        } else {
+          hide_address_form('shipping');
+        }
+      });
+    }
+  });
+
+  function hide_address_form(address_type){
+    $('#' + address_type + ' .inner').hide();
+    $('#' + address_type + ' .inner input').prop('disabled', true).prop('value', '');
+    $('#' + address_type + ' .inner select').prop('disabled', true).prop('value', '');
+  }
+
+  function show_address_form(address_type){
+    $('#' + address_type + ' .inner').show();
+    $('#' + address_type + ' .inner input').prop('disabled', false).prop('value', '');
+    $('#' + address_type + ' .inner select').prop('disabled', false).prop('value', '');
+  }
+})(jQuery);

data/app/assets/stylesheets/spree/frontend/solidus_address_book.scss

@@ -0,0 +1,92 @@
+p[data-hook='use_billing'] {
+  bottom: 30px;
+  position: relative;
+  margin-bottom: 0;
+  margin-top: 0;
+
+  input[type=checkbox] {
+    display: inline-block;
+  }
+}
+
+.new_address {
+  input[type=text],
+  input[type=tel],
+  select {
+    width: 100%;
+  }
+
+  input[type=checkbox] {
+    display: inline-block;
+    margin-right: 3px;
+  }
+}
+
+.edit_address {
+  input[type=text],
+  input[type=tel],
+  select {
+    width: 100%;
+  }
+}
+
+div#checkout #checkout_form_address {
+  #billing, #shipping {
+    input[type=checkbox] {
+      display: inline-block;
+      margin-right: 3px;
+    }
+
+    .select_address {
+      ul {
+        list-style-type: none;
+        margin: 10px 0;
+        padding: 0;
+        overflow: hidden;
+        width: 100%;
+
+        li {
+          float: left;
+          height: auto;
+          margin-bottom: 10px;
+          width: 25%;
+
+          label {
+            display: block;
+            float: none;
+          }
+
+          .address-label {
+            font-size: 1em;
+            font-weight: bold;
+            margin-left: 3px;
+          }
+
+          .address-text {
+            display: block;
+            margin-top: 10px;
+          }
+
+          .edit-address {
+            display: block;
+            margin-top: 5px;
+          }
+        }
+
+        input[type=radio] {
+          margin: 0px 2px;
+          width: auto;
+        }
+      }
+    }
+  }
+}
+
+.account-my-addresses {
+  table[data-hook='account_my_addresses_table'] {
+    margin-bottom: 10px;
+    width: 100%;
+  }
+}
+
+.hidden { display: none; }

data/app/controllers/spree/addresses_controller.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Spree
+  class AddressesController < Spree::StoreController
+    helper Spree::AddressesHelper
+    rescue_from ActiveRecord::RecordNotFound, with: :render_404
+    load_and_authorize_resource class: Spree::Address
+
+    before_action :load_address, only: [:update, :destroy]
+    before_action :set_return_path, only: :edit
+
+    def new
+      @address = Spree::Address.default
+    end
+
+    def create
+      @address = try_spree_current_user.addresses.build(address_params)
+
+      if @address.save
+        flash[:notice] = t('spree.successfully_created')
+        redirect_to account_path
+      else
+        flash[:error] = @address.errors.full_messages.join(', ')
+        render action: 'new'
+      end
+    end
+
+    def update
+      @address.editable? ? update_address : clone_address
+    end
+
+    def destroy
+      if @address.destroy
+        flash[:notice] = t('spree.successfully_removed')
+        redirect_to request.env['HTTP_REFERER'] || account_path
+      else
+        flash[:error] = t('spree.unsuccessfully_removed')
+        redirect_to :back
+      end
+    end
+
+    private
+
+    def address_params
+      params.require(:address).permit(:label, :address, :firstname, :lastname,
+                                      :address1, :address2, :city, :state_id, :zipcode,
+                                      :country_id, :phone, :user_id)
+    end
+
+    def load_address
+      @address ||= Spree::Address.find(id: params[:id])
+    end
+
+    def set_return_path
+      session['spree_user_return_to'] = request.env['HTTP_REFERER']
+    end
+
+    def update_address
+      if @address.update_attributes(address_params)
+        flash[:notice] = t('spree.successfully_updated')
+        redirect_back_or_default(account_path)
+      else
+        render action: 'edit'
+      end
+    end
+
+    def clone_address
+      address = @address
+      new_address = Spree::Address.new(address.attributes.except('id',
+                                                                 'created_at',
+                                                                 'updated_at',
+                                                                 'deleted_at'))
+      new_address.assign_attributes(address_params)
+      address.destroy
+
+      if @address = new_address.save
+        flash[:notice] = t('spree.successfully_updated')
+        redirect_back_or_default(account_path)
+      else
+        render action: 'edit'
+      end
+    end
+  end
+end

data/app/controllers/spree/checkout_controller_decorator.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module CheckoutControllerDecorator
+  extend ActiveSupport::Concern
+
+  included do
+    prepend(InstanceMethods)
+    helper Spree::AddressesHelper
+
+    after_action :normalize_addresses, only: :update
+    before_action :set_addresses, only: :update
+    before_action :user_addresses, only: :edit, if: -> { params[:state] == 'address' }
+  end
+
+  module InstanceMethods
+    protected
+
+    def set_addresses
+      return unless params[:order] && params[:state] == "address"
+
+      if params[:order][:ship_address_id].to_i > 0
+        params[:order].delete(:ship_address_attributes)
+
+        Spree::Address.find(params[:order][:ship_address_id]).user_id != try_spree_current_user.id && raise("Frontend address forging")
+      else
+        params[:order].delete(:ship_address_id)
+      end
+
+      if params[:order][:bill_address_id].to_i > 0
+        params[:order].delete(:bill_address_attributes)
+
+        Spree::Address.find(params[:order][:bill_address_id]).user_id != try_spree_current_user.id && raise("Frontend address forging")
+      else
+        params[:order].delete(:bill_address_id)
+      end
+    end
+
+    def normalize_addresses
+      return unless params[:state] == 'address' && @order.bill_address_id && @order.ship_address_id
+
+      # ensure that there is no validation errors and addresses were saved
+      return unless @order.bill_address && @order.ship_address
+
+      bill_address = @order.bill_address
+      ship_address = @order.ship_address
+
+      if @order.bill_address_id != @order.ship_address_id && bill_address.same_as?(ship_address)
+        @order.update_attribute(:bill_address_id, ship_address.id)
+        bill_address.destroy
+      elsif params[:save_user_address]
+        bill_address.update_attribute(:user_id, try_spree_current_user&.id)
+      end
+
+      ship_address.update_attribute(:user_id, try_spree_current_user&.id) if params[:save_user_address]
+    end
+
+    private
+
+    def user_addresses
+      @user_addresses ||= try_spree_current_user&.addresses
+    end
+  end
+end
+
+Spree::CheckoutController.include(CheckoutControllerDecorator)

data/app/helpers/spree/addresses_helper.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Spree
+  module AddressesHelper
+    def address_field(form, method, address_id = 'b', &handler)
+      content_tag :p, id: [address_id, method].join, class: 'form-group' do
+        if handler
+          handler.call
+        else
+          is_required = Spree::Address.required_fields.include?(method)
+          separator = is_required ? '<span class="required">*</span><br />' : '<br />'
+          form.label(method) +
+            separator.html_safe +
+            form.text_field(method, class: [is_required ? 'required' : nil, 'form-control'].compact)
+        end
+      end
+    end
+
+    def address_state(form, country, address_id = 'b')
+      country ||= Spree::Country.find(Spree::Config[:default_country_id])
+      have_states = !country.states.empty?
+      state_elements = [
+        form.collection_select(:state_id,
+                               country.states.order(:name),
+                               :id, :name,
+                               { include_blank: true },
+                               { class: have_states ? 'required form-control' : 'hidden',
+                               disabled: !have_states }) +
+          form.text_field(:state_name,
+                          class: !have_states ? 'required' : 'hidden',
+                          disabled: have_states)
+      ].join.gsub('"', "'").gsub("\n", "")
+
+      form.label(:state, t(:state)) + '<span class="req">*</span><br />'.html_safe +
+        content_tag(:noscript, form.text_field(:state_name, class: 'required')) +
+        javascript_tag("document.write(\"#{state_elements.html_safe}\");")
+    end
+  end
+end