solidus_support 0.4.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ceefe11ac7e48cfcba96aec57eff516d8d517c48f990098645d380f5c33ad6b9
-  data.tar.gz: 1ce25f4ff870f87f137ba021ee8db5db76bb6031ffb22e18f49cea21be3ac882
+  metadata.gz: 3d0b61a92f9ea8174330391a7bad3543dc0725f68e9fd380011391e580abab75
+  data.tar.gz: 269a38d161f392811ed2ec1c2a523b67a92557b7a9828c2c2639a2d504df06a6
 SHA512:
-  metadata.gz: 4b9b82cf9add77927ae9a2b2b087c886dae93d4577a9daf58274464b07ab5fa6e89725ec32a558f1dd79f75b507ff908287a8b9af9ec5b146611fd270a900446
-  data.tar.gz: 7e37c959b0790f36cdb89af526bf56b364b30356ed88c2888bce34c6b4984fc53631dec1c6acde601e64e0ba80a39a8dde84665cd64f7c30fa679542e4e87131
+  metadata.gz: 34ab8b557078b085cd966e3e45652ba7f20e4b26588f74a66f94da5f0dc7cd1824f68672d354656d346baa97bc1f8d3e37b469ab0871d5a247af1a7368b23bb2
+  data.tar.gz: 4401a91bdecea435d21f175ea4c1dd77b3f68006ed6221338435e6e1f8a27de6b0533dfdb88ec3ab6401554125d0de187fd38ff7a77a99fc59350292734eab4f

data/CHANGELOG.md

@@ -1,5 +1,73 @@
 # Changelog
 
+## [v0.7.0](https://github.com/solidusio/solidus_support/tree/v0.7.0) (2020-10-28)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.6.0...v0.7.0)
+
+**Closed issues:**
+
+- Could we get a new release? [\#49](https://github.com/solidusio/solidus_support/issues/49)
+
+**Merged pull requests:**
+
+- Use `Spree::Event. activate\_all\_subscribers` when available [\#53](https://github.com/solidusio/solidus_support/pull/53) ([spaghetticode](https://github.com/spaghetticode))
+- Support Rails 5.1.x [\#51](https://github.com/solidusio/solidus_support/pull/51) ([brchristian](https://github.com/brchristian))
+- Remove redundant `solidus\_core` dev dependency [\#50](https://github.com/solidusio/solidus_support/pull/50) ([brchristian](https://github.com/brchristian))
+
+## [v0.6.0](https://github.com/solidusio/solidus_support/tree/v0.6.0) (2020-07-24)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.5.1...v0.6.0)
+
+**Implemented enhancements:**
+
+- Autoload Solidus Event subscribers from extensions [\#45](https://github.com/solidusio/solidus_support/pull/45) ([spaghetticode](https://github.com/spaghetticode))
+
+**Fixed bugs:**
+
+- Load event subscribers only when Spree::Event is available [\#47](https://github.com/solidusio/solidus_support/pull/47) ([spaghetticode](https://github.com/spaghetticode))
+
+**Closed issues:**
+
+- Namespace Conflicts [\#48](https://github.com/solidusio/solidus_support/issues/48)
+
+**Merged pull requests:**
+
+- Stop using SolidusSupport.solidus\_gem\_version [\#46](https://github.com/solidusio/solidus_support/pull/46) ([elia](https://github.com/elia))
+- Add frontend/backend/api decorators to autoload path [\#44](https://github.com/solidusio/solidus_support/pull/44) ([kennyadsl](https://github.com/kennyadsl))
+
+## [v0.5.1](https://github.com/solidusio/solidus_support/tree/v0.5.1) (2020-04-15)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.5.0...v0.5.1)
+
+**Merged pull requests:**
+
+- Push decorators to autoload path using config.autoload\_paths [\#43](https://github.com/solidusio/solidus_support/pull/43) ([kennyadsl](https://github.com/kennyadsl))
+
+## [v0.5.0](https://github.com/solidusio/solidus_support/tree/v0.5.0) (2020-02-18)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.4.1...v0.5.0)
+
+**Merged pull requests:**
+
+- Load Solidus engine extension files automatically [\#42](https://github.com/solidusio/solidus_support/pull/42) ([aldesantis](https://github.com/aldesantis))
+- Deprecate SolidusSupport.solidus\_gem\_version [\#37](https://github.com/solidusio/solidus_support/pull/37) ([kennyadsl](https://github.com/kennyadsl))
+
+## [v0.4.1](https://github.com/solidusio/solidus_support/tree/v0.4.1) (2020-01-16)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.4.0...v0.4.1)
+
+**Closed issues:**
+
+- Should use require\_dependency instead of require/load [\#34](https://github.com/solidusio/solidus_support/issues/34)
+- Add a LICENSE [\#20](https://github.com/solidusio/solidus_support/issues/20)
+
+**Merged pull requests:**
+
+- Update solidus\_dev\_support [\#41](https://github.com/solidusio/solidus_support/pull/41) ([aldesantis](https://github.com/aldesantis))
+- Replace manual cache checks w/ require\_dependency [\#39](https://github.com/solidusio/solidus_support/pull/39) ([elia](https://github.com/elia))
+- Fixes isse when zeitwerk is not enabled [\#38](https://github.com/solidusio/solidus_support/pull/38) ([softr8](https://github.com/softr8))
+- Spring cleaning [\#33](https://github.com/solidusio/solidus_support/pull/33) ([aldesantis](https://github.com/aldesantis))
+
 ## [v0.4.0](https://github.com/solidusio/solidus_support/tree/v0.4.0) (2019-12-16)
 
 [Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.3.2...v0.4.0)

data/Gemfile

@@ -16,3 +16,15 @@ else
 end
 
 gemspec
+
+# There is an issue with Sprockets 4 not accepting a custom path for
+# the assets manifest, which doesn't play well with in-memory dummy
+# apps such as the one we use in this gem.
+
+# A fix was provided for sprockets-rails[1] but it was not accepted
+# yet.
+
+# [1]: rails/sprockets-rails#446
+#
+# Please do not remove this line until we have a solution.
+gem 'sprockets', '~> 3'

data/README.md

@@ -38,7 +38,7 @@ module SolidusExtensionName
   class Engine < Rails::Engine
     engine_name 'solidus_extension_name'
 
-    include SolidusSupport::EngineExtensions::Decorators
+    include SolidusSupport::EngineExtensions
 
     # ...
   end
@@ -57,6 +57,26 @@ end
 config.to_prepare(&method(:activate).to_proc)
 ```
 
+#### Loading files conditionally
+
+If you include `EngineExtensions` in your extension and structure your files according to the
+expected paths, they will be loaded automagically only when the relevant Solidus engines are
+available.
+
+Here's what an example structure may look like:
+
+- `lib/views/backend`: will only be added to the view paths when `solidus_backend` is available.
+- `lib/controllers/backend`: will only be added to the controller paths when `solidus_backend` is
+  available.
+- `lib/decorators/backend`: will only be added to the decorator paths when `solidus_backend` is
+  available.
+
+The same goes for `frontend` and `api`.
+
+We strongly recommend following this structure and making your extensions so that they're not
+dependent on anything other than `solidus_core`, only augmenting the functionality of the other
+engines when they are available.
+
 ## Development
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new

data/bin/console

@@ -3,6 +3,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
+require "rails/all"
 require "solidus_support"
 
 # You can add fixtures and/or initialization code here to make experimenting

data/lib/solidus_support.rb

@@ -8,25 +8,32 @@ require 'solidus_core'
 module SolidusSupport
   class << self
     def solidus_gem_version
-      if Spree.respond_to?(:solidus_gem_version)
-        Spree.solidus_gem_version
-      elsif Spree.respond_to?(:gem_version)
-        # 1.1 doesn't have solidus_gem_version
-        Gem::Version.new(Spree.solidus_version)
-      else
-        # 1.0 doesn't have gem_version
-        Gem::Specification.detect { |x| x.name == 'solidus_core' }.version
-      end
+      ActiveSupport::Deprecation.warn <<-WARN.squish, caller
+        SolidusSupport.solidus_gem_version is deprecated and will be removed
+        in solidus_support 1.0. Please use Spree.solidus_gem_version instead.
+      WARN
+
+      Spree.solidus_gem_version
     end
 
     def reset_spree_preferences_deprecated?
       first_version_without_reset = Gem::Requirement.new('>= 2.9')
-      first_version_without_reset.satisfied_by?(solidus_gem_version)
+      first_version_without_reset.satisfied_by?(Spree.solidus_gem_version)
+    end
+
+    def combined_first_and_last_name_in_address?
+      versions_before_preference = Gem::Requirement.new('< 2.10')
+      versions_after_preference = Gem::Requirement.new('>= 3.0.0.alpha')
+
+      return false if versions_before_preference.satisfied_by?(Spree.solidus_gem_version)
+      return true if versions_after_preference.satisfied_by?(Spree.solidus_gem_version)
+
+      Spree::Config.use_combined_first_and_last_name_in_address
     end
 
     def new_gateway_code?
       first_version_with_new_gateway_code = Gem::Requirement.new('>= 2.3')
-      first_version_with_new_gateway_code.satisfied_by?(solidus_gem_version)
+      first_version_with_new_gateway_code.satisfied_by?(Spree.solidus_gem_version)
     end
 
     def payment_source_parent_class

data/lib/solidus_support/engine_extensions.rb

@@ -1,3 +1,101 @@
 # frozen_string_literal: true
 
-require_relative 'engine_extensions/decorators'
+module SolidusSupport
+  module EngineExtensions
+    include ActiveSupport::Deprecation::DeprecatedConstantAccessor
+    deprecate_constant 'Decorators', 'SolidusSupport::EngineExtensions'
+
+    def self.included(engine)
+      engine.extend ClassMethods
+
+      engine.class_eval do
+        solidus_decorators_root.glob('*') do |decorators_folder|
+          config.autoload_paths += [decorators_folder]
+        end
+
+        config.to_prepare(&method(:activate))
+
+        enable_solidus_engine_support('backend') if SolidusSupport.backend_available?
+        enable_solidus_engine_support('frontend') if SolidusSupport.frontend_available?
+        enable_solidus_engine_support('api') if SolidusSupport.api_available?
+      end
+    end
+
+    module ClassMethods
+      def activate
+        load_solidus_decorators_from(solidus_decorators_root)
+        load_solidus_subscribers_from(solidus_subscribers_root)
+      end
+
+      # Loads Solidus event subscriber files.
+      #
+      # This allows to add event subscribers to extensions without explicitly subscribing them,
+      # similarly to what happens in Solidus core.
+      def load_solidus_subscribers_from(path)
+        if defined? Spree::Event
+          path.glob("**/*_subscriber.rb") do |subscriber_path|
+            require_dependency(subscriber_path)
+          end
+
+          if Spree::Event.respond_to?(:activate_all_subscribers)
+            Spree::Event.activate_all_subscribers
+          else
+            Spree::Event.subscribers.each(&:subscribe!)
+          end
+        end
+      end
+
+      # Loads decorator files.
+      #
+      # This is needed since they are never explicitly referenced in the application code and
+      # won't be loaded by default. We need them to be executed regardless in order to decorate
+      # existing classes.
+      def load_solidus_decorators_from(path)
+        path.glob('**/*.rb') do |decorator_path|
+          require_dependency(decorator_path)
+        end
+      end
+
+      private
+
+      # Returns the root for this engine's decorators.
+      #
+      # @return [Path]
+      def solidus_decorators_root
+        root.join('app/decorators')
+      end
+
+      # Returns the root for this engine's Solidus event subscribers.
+      #
+      # @return [Path]
+      def solidus_subscribers_root
+        root.join("app/subscribers")
+      end
+
+      # Enables support for a Solidus engine.
+      #
+      # This will tell Rails to:
+      #
+      #   * add +lib/controllers/[engine]+ to the controller paths;
+      #   * add +lib/views/[engine]+ to the view paths;
+      #   * load the decorators in +lib/decorators/[engine]+.
+      #
+      # @see #load_solidus_decorators_from
+      def enable_solidus_engine_support(engine)
+        paths['app/controllers'] << "lib/controllers/#{engine}"
+        paths['app/views'] << "lib/views/#{engine}"
+
+        path = root.join("lib/decorators/#{engine}")
+
+        config.autoload_paths += path.glob('*')
+
+        engine_context = self
+        config.to_prepare do
+          engine_context.instance_eval do
+            load_solidus_decorators_from(path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solidus_support/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusSupport
-  VERSION = '0.4.1'
+  VERSION = '0.8.0'
 end

data/solidus_support.gemspec

@@ -21,11 +21,11 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_development_dependency 'rails'
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec-rails'
   s.add_development_dependency 'rubocop'
   s.add_development_dependency 'rubocop-rspec'
-  s.add_development_dependency 'solidus_core'
   s.add_development_dependency 'solidus_dev_support'
 end

data/spec/solidus_support_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe SolidusSupport do
     let(:credit_card) { nil }
 
     before do
-      allow(described_class).to receive(:solidus_gem_version) do
+      allow(Spree).to receive(:solidus_gem_version) do
         Gem::Version.new(solidus_version)
       end
     end
@@ -42,4 +42,37 @@ RSpec.describe SolidusSupport do
     end
     # rubocop:enable RSpec/NestedGroups
   end
+
+  describe '.combined_first_and_last_name_in_address?' do
+    subject { described_class.combined_first_and_last_name_in_address? }
+
+    before do
+      allow(Spree).to receive(:solidus_gem_version) do
+        Gem::Version.new(solidus_version)
+      end
+    end
+
+    context 'when Solidus did not have the code to combine addresses fields' do
+      let(:solidus_version) { '2.9.3' }
+
+      it { is_expected.to be_falsey }
+    end
+
+    context 'when Solidus has preference to choose if combine addresses fields' do
+      let(:solidus_version) { '2.10.3' }
+      before do
+        allow(Spree::Config)
+          .to receive(:use_combined_first_and_last_name_in_address)
+          .and_return(true)
+      end
+
+      it { is_expected.to be_truthy }
+    end
+
+    context 'when Solidus only has code to combine addresses fields' do
+      let(:solidus_version) { '3.0.0' }
+
+      it { is_expected.to be_truthy }
+    end
+  end
 end

data/spec/support/dummy_app.rb

@@ -14,7 +14,6 @@ module DummyApp
   class Application < ::Rails::Application
     config.eager_load               = false
     config.paths['config/database'] = File.expand_path('dummy_app/database.yml', __dir__)
-    config.active_record.sqlite3.represent_boolean_as_integer = true
   end
 end
 

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: solidus_support
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.8.0
 platform: ruby
 authors:
 - John Hawthorn
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-16 00:00:00.000000000 Z
+date: 2021-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: solidus_core
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: john@stembolt.com
 executables: []
 extensions: []
@@ -129,10 +129,10 @@ files:
 - bin/setup
 - lib/solidus_support.rb
 - lib/solidus_support/engine_extensions.rb
-- lib/solidus_support/engine_extensions/decorators.rb
 - lib/solidus_support/migration.rb
 - lib/solidus_support/version.rb
 - solidus_support.gemspec
+- spec/examples.txt
 - spec/solidus_support_spec.rb
 - spec/spec_helper.rb
 - spec/support/dummy_app.rb
@@ -141,7 +141,7 @@ homepage: https://github.com/solidusio/solidus_support
 licenses:
 - BSD-3-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -156,12 +156,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Common runtime helpers for Solidus extensions.
 test_files:
 - spec/spec_helper.rb
+- spec/examples.txt
 - spec/solidus_support_spec.rb
 - spec/support/dummy_app.rb
 - spec/support/dummy_app/database.yml

data/lib/solidus_support/engine_extensions/decorators.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module SolidusSupport
-  module EngineExtensions
-    module Decorators
-      def self.included(engine)
-        engine.class_eval do
-          extend ClassMethods
-          config.to_prepare(&method(:activate).to_proc)
-        end
-      end
-
-      module ClassMethods
-        def activate
-          base_path = root.join('app/decorators')
-
-          if Rails.respond_to?(:autoloaders) && Rails.autoloaders.main
-            # Add decorators folder to the Rails autoloader. This
-            # allows Zeitwerk to resolve decorators paths correctly,
-            # when used.
-            Dir.glob(base_path.join('*')) do |decorators_folder|
-              Rails.autoloaders.main.push_dir(decorators_folder)
-            end
-          end
-
-          # Load decorator files. This is needed since they are
-          # never explicitely referenced in the application code
-          # and won't be loaded by default. We need them to be
-          # executed anyway to extend exisiting classes.
-          Dir.glob(base_path.join('**/*.rb')) do |decorator_path|
-            require_dependency(decorator_path)
-          end
-        end
-      end
-    end
-  end
-end