Port to Solidus

This is a WIP. It has not been tested interactively yet. This is purely
just replacing `spree` with `solidus` where needed and making the automated
tests pass.

I removed the `taxable_spec.rb` completely as it has changed so much the
test would need to be rewritten. Also the previous tests didn't actually
test the method it claimed it was testing. So for now just removing that
complication.

Gemfile

@@ -1,12 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'spree', github: 'spree/spree', branch: '3-2-stable'
-# Provides basic authentication functionality for testing parts of your engine
-gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'master'
-
-group :test do
-  gem 'rails-controller-testing'
-  gem 'byebug'
-end
-
 gemspec

README.md

@@ -1,7 +1,7 @@
-SpreeTaxjar
+SolidusTaxjar
 ===========
 
-Spree::Taxjar is a sales tax extension for Spree using [SmartCalcs by TaxJar](https://developers.taxjar.com/api/reference/).
+A sales tax extension for Solidus using [SmartCalcs by TaxJar](https://developers.taxjar.com/api/reference/).
 
 ## Prerequisites
 
@@ -16,10 +16,8 @@ Spree::Taxjar is a sales tax extension for Spree using [SmartCalcs by TaxJar](ht
 1. Add this extension to your Gemfile with this line:
 
   ```ruby
-  gem 'spree_taxjar', github: 'vinsol-spree-contrib/spree_taxjar', branch: <spree-version-compatible>
+  gem 'solidus_taxjar'
   ```
-
-  *The `branch` option is important:* it must match the version of Spree you're using. For example, use `3-1-stable` if you're using Spree `3-1-stable` or any `3.1.x` version.
 
 2. Install the gem using Bundler:
 
@@ -30,7 +28,7 @@ Spree::Taxjar is a sales tax extension for Spree using [SmartCalcs by TaxJar](ht
 3. Copy & run migrations
 
   ```ruby
-  bundle exec rails g spree_taxjar:install
+  bundle exec rails g soldius_taxjar:install
   ```
 
 4. Restart your server
@@ -92,4 +90,3 @@ For better handling of exceptions raised by TaxJar due to various validations ad
         flash[:error] = 'TaxJar::' + e.message
         redirect_to cart_path
       end
-

Rakefile

@@ -16,6 +16,6 @@ end
 
 desc 'Generates a dummy app for testing'
 task :test_app do
-  ENV['LIB_NAME'] = 'spree_taxjar'
+  ENV['LIB_NAME'] = 'solidus_taxjar'
   Rake::Task['extension:test_app'].invoke
 end

app/models/concerns/taxable.rb

@@ -3,6 +3,6 @@ module Taxable
 
   private
     def taxjar_applicable?(order)
-      Spree::TaxRate.match(order.tax_zone).any? { |rate| rate.calculator_type == "Spree::Calculator::TaxjarCalculator" }
+      Spree::TaxRate.for_address(order.tax_address).any? { |rate| rate.calculator_type == "Spree::Calculator::TaxjarCalculator" }
     end
 end

app/models/spree/calculator/taxjar_calculator.rb

@@ -2,7 +2,6 @@
 
 module Spree
   class Calculator::TaxjarCalculator < Calculator
-    include VatPriceCalculation
 
     CACHE_EXPIRATION_DURATION = 10.minutes
 
@@ -99,5 +98,10 @@ def cache_key(order, item, address)
           ['Spree::Shipment', order.id, item.id, address.state.id, address.zipcode, item.cost, :amount_to_collect]
         end
       end
+
+      # Imported from Spree::VatPriceCalculation
+      def round_to_two_places(amount)
+        BigDecimal.new(amount.to_s).round(2, BigDecimal::ROUND_HALF_UP)
+      end
   end
 end

app/models/spree/taxjar.rb

@@ -142,7 +142,7 @@ def return_items_params
             quantity: return_items.length,
             product_identifier: item.variant.sku,
             description: ActionView::Base.full_sanitizer.sanitize(item.variant.description).truncate(150),
-            unit_price: item.pre_tax_amount,
+            unit_price: item.total_excluding_vat,
             product_tax_code: item.variant.tax_category.try(:tax_code)
           }
         end
@@ -153,7 +153,7 @@ def refund_params
           transaction_id: @reimbursement.number,
           transaction_reference_id: @order.number,
           transaction_date: @order.completed_at.as_json,
-          amount: @reimbursement.return_items.sum(:pre_tax_amount),
+          amount: @reimbursement.return_items.sum('amount - included_tax_total'),
           shipping: 0,
           sales_tax: @reimbursement.return_items.sum(:additional_tax_total),
           line_items: return_items_params

app/views/spree/admin/taxjar_settings/edit.html.erb

@@ -1,4 +1,4 @@
-<%= render 'spree/admin/shared/sub_menu/configuration' %>
+<%= render 'spree/admin/shared/taxes_tabs' %>
 
 <% content_for :page_title do %>
   <%= Spree.t(:taxjar_settings) %>
@@ -12,17 +12,17 @@
           <% @preferences_api.each do |key| %>
               <div class="form-group">
                 <%= label_tag key %>
-                <%= preference_field_tag(key, Spree::Config[key], type: Spree::Config.preference_type(key)) %>
+                <%= render "spree/admin/shared/preference_fields/#{Spree::Config.preference_type(key)}", name: key, value: Spree::Config[key] %>
               </div>
           <% end %>
         </fieldset>
       </div>
     </div>
 
     <div class="form-buttons" data-hook="buttons">
-      <%= button Spree.t('actions.update'), 'refresh' %>
+      <%= button Spree.t('actions.update') %>
       <span class="or"><%= Spree.t(:or) %></span>
-      <%= button_link_to Spree.t('actions.cancel'), admin_orders_url, icon: 'delete' %>
+      <%= button_link_to Spree.t('actions.cancel'), admin_orders_url %>
     </div>
   </div>
 <% end %>

lib/generators/spree_taxjar/install/install_generator.rb → lib/generators/solidus_taxjar/install/install_generator.rb

@@ -1,4 +1,4 @@
-module SpreeTaxjar
+module SolidusTaxjar
   module Generators
     class InstallGenerator < Rails::Generators::Base
 
@@ -15,7 +15,7 @@ def add_stylesheets
       end
 
       def add_migrations
-        run 'bundle exec rake railties:install:migrations FROM=spree_taxjar'
+        run 'bundle exec rake railties:install:migrations FROM=solidus_taxjar'
       end
 
       def run_migrations

lib/solidus_taxjar.rb

@@ -0,0 +1 @@
+require_relative './spree_taxjar'

lib/spree_taxjar.rb

@@ -1,2 +1,2 @@
-require 'spree_core'
+require 'solidus_core'
 require 'spree_taxjar/engine'

solidus_taxjar.gemspec

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'solidus_taxjar'
+  s.version     = '3.2.0'
+  s.summary     = 'Solidus extension to calculate sales tax in states of USA'
+  s.description = 'Solidus extension for providing TaxJar services in USA'
+  s.required_ruby_version = '>= 2.1.0'
+
+  s.author    = ['Nimish Gupta', 'Tanmay Sinha', 'Eric Anderson']
+  s.email     = ['[email protected]', '[email protected]', '[email protected]']
+  s.license = 'BSD-3'
+
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency 'solidus'
+  s.add_dependency 'taxjar-ruby', '~> 1.5'
+
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'coffee-rails'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'factory_bot'
+  s.add_development_dependency 'ffaker'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'sass-rails'
+  s.add_development_dependency 'selenium-webdriver'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'shoulda-matchers'
+  s.add_development_dependency 'rspec-activemodel-mocks'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'byebug'
+end

spec/controllers/spree/admin/taxjar_settings_controller_spec.rb

@@ -1,13 +1,15 @@
 require 'spec_helper'
 
 describe Spree::Admin::TaxjarSettingsController, type: :controller do
+  render_views
 
   let(:user) { mock_model(Spree.user_class).as_null_object }
 
   before(:each) do
     allow(controller).to receive(:spree_current_user).and_return(user)
     allow(controller).to receive(:authorize!).and_return(true)
     allow(controller).to receive(:authorize_admin).and_return(true)
+    allow(user).to receive(:spree_roles).and_return []
   end
 
   describe "GET 'edit'" do
@@ -21,11 +23,13 @@ def send_request
     end
 
     it "assigns @preferences_api" do
-      expect(assigns[:preferences_api]).to eq([:taxjar_api_key, :taxjar_enabled, :taxjar_debug_enabled])
+      expect( response.body ).to match 'Taxjar api key'
+      expect( response.body ).to match 'Taxjar enabled'
+      expect( response.body ).to match 'Taxjar debug enabled'
     end
 
     it "renders edit template" do
-      expect(response).to render_template(:edit)
+      expect( response.body ).to match Spree.t(:taxjar_settings)
     end
 
   end

spec/models/spree/calculator/taxjar_calculator_spec.rb

@@ -6,12 +6,12 @@
   let!(:country) { create(:country) }
   let!(:state) { create(:state, country: country, abbr: "TX") }
   let!(:state_ca) { create(:state, country: country, abbr: "CA") }
-  let!(:zone) { create(:zone, name: "Country Zone", default_tax: true, zone_members: []) }
+  let!(:zone) { create(:zone, name: "Country Zone", zone_members: []) }
   let!(:ship_address) { create(:ship_address, city: "Adrian", zipcode: "79001", state: state) }
   let!(:ship_address_ca) { create(:ship_address, city: "Los Angeles", zipcode: "90002", state: state_ca) }
   let!(:tax_category) { create(:tax_category, tax_rates: []) }
   let!(:tax_category_exempt) { create(:tax_category, tax_rates: []) }
-  let!(:rate) { create(:tax_rate, tax_category: tax_category, amount: 0.05, included_in_price: included_in_price) }
+  let!(:rate) { create(:tax_rate, tax_categories: [tax_category], amount: 0.05, included_in_price: included_in_price) }
   let(:included_in_price) { false }
   let!(:calculator) { Spree::Calculator::TaxjarCalculator.new(calculable: rate) }
   let!(:order) { create(:order,ship_address_id: ship_address.id) }
@@ -30,10 +30,6 @@
     Spree::Config[:tax_using_ship_address] = true
   end
 
-  describe 'Constants' do
-    it { expect(Spree::Calculator::TaxjarCalculator.include?(Spree::VatPriceCalculation)).to be true }
-  end
-
   describe ".description" do
     it 'returns the description for the calculator' do
       expect(calculator.description).to eq(Spree.t(:taxjar_calculator_description))

spec/models/spree/taxjar_spec.rb

@@ -5,7 +5,7 @@
   let(:reimbursement) { create(:reimbursement) }
   let!(:country) { create(:country) }
   let!(:state) { create(:state, country: country, abbr: "TX") }
-  let!(:zone) { create(:zone, name: "Country Zone", default_tax: true, zone_members: []) }
+  let!(:zone) { create(:zone, name: "Country Zone", zone_members: []) }
   let!(:ship_address) { create(:ship_address, city: "Adrian", zipcode: "79001", state: state) }
   let!(:tax_category) { create(:tax_category, tax_rates: []) }
   let!(:order) { create(:order,ship_address_id: ship_address.id) }

spec/spec_helper.rb

@@ -38,7 +38,7 @@
 require 'spree_taxjar/factories'
 
 RSpec.configure do |config|
-  config.include FactoryGirl::Syntax::Methods
+  config.include FactoryBot::Syntax::Methods
 
   # Infer an example group's spec type from the file location.
   config.infer_spec_type_from_file_location!