solidus_support 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ceefe11ac7e48cfcba96aec57eff516d8d517c48f990098645d380f5c33ad6b9
-  data.tar.gz: 1ce25f4ff870f87f137ba021ee8db5db76bb6031ffb22e18f49cea21be3ac882
+  metadata.gz: e720d17f4c4d0b8dfb852da8ea260bbaa7c069b83b07e102b96633bb65ed9e18
+  data.tar.gz: 66726d7f7d4ef6acecb63024eb7ac54888efaddb597f997c9cbda545642a4101
 SHA512:
-  metadata.gz: 4b9b82cf9add77927ae9a2b2b087c886dae93d4577a9daf58274464b07ab5fa6e89725ec32a558f1dd79f75b507ff908287a8b9af9ec5b146611fd270a900446
-  data.tar.gz: 7e37c959b0790f36cdb89af526bf56b364b30356ed88c2888bce34c6b4984fc53631dec1c6acde601e64e0ba80a39a8dde84665cd64f7c30fa679542e4e87131
+  metadata.gz: 1b3061f16c942f99c9f6689f03e89875a1e88ff2c0761a5ad10020b7f9c80c2971a70590eeb0eca458929e86c3617ef56e2ade8a0f5f8a01e60e8c285704faa6
+  data.tar.gz: f22c1b1daa5f11853f1d2625750927349d3e8a2b36ed4eba3a4aea62276be3e9375b4ab19d1b8132644893038a2dc04ac065342dbb28e1146b974870c3ffeb1c

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [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/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/lib/solidus_support.rb

@@ -8,15 +8,12 @@ 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?

data/lib/solidus_support/engine_extensions.rb

@@ -1,3 +1,76 @@
 # 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
+        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
+        if Rails.respond_to?(:autoloaders) && Rails.autoloaders.main
+          # Add decorators folder to the Rails autoloader. This tells Zeitwerk to treat paths
+          # such as app/decorators/controllers as roots.
+          solidus_decorators_root.glob('*') do |decorators_folder|
+            Rails.autoloaders.main.push_dir(decorators_folder)
+          end
+        end
+
+        load_solidus_decorators_from(solidus_decorators_root)
+      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
+
+      # 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}"
+
+        engine_context = self
+        config.to_prepare do
+          engine_context.instance_eval do
+            path = root.join("lib/decorators/#{engine}")
+            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.5.0'
 end

data/solidus_support.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency 'activesupport', ['>= 5.2', '< 7.0.x']
+
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec-rails'

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: solidus_support
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - John Hawthorn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-16 00:00:00.000000000 Z
+date: 2020-02-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.x
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -129,10 +149,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
@@ -156,12 +176,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 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