rails_drivers 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52e2b19b5bd5e3ef8921b6c64b08c03c9b1b4a568e70384ca1f855b9c140f783
-  data.tar.gz: 4429a66b2b8237e01a91447898b8a8a2a4efb88f5baa93382f594f0e48c7bcde
+  metadata.gz: 2b0f6e72ff1714747fe0c4a3b0d6868236099950af9d3261337d9a352a1d9e1b
+  data.tar.gz: 7f69a6821fefa1ac60c738df6523b5608c6d1575a80d9349f5bcb67d476feec5
 SHA512:
-  metadata.gz: c1fec26f52e667e09aa237d232dd709b6f4011b48a222762c48b54d5bf19a33145f71d9c6ac3c39d8022b30da32e94042ce25772ed66707af650f91d8aff4b6e
-  data.tar.gz: '08e1af9dde001c22c9ca03bde90c6c10c14975797d6aa0588f08e98dedce155ab9704e9f1ebdb0b7942eced1e8d1b0f67afec230bdbe2458c2e13a23cf0c6803'
+  metadata.gz: a17961dfac581a7be80f473e1dcd1c3c53fc5d855b2452548a3e99571dbe45a9c092da8a27b125de9d1c37dbc2b2d97bb55bf313c3f977a733a26e4415651f49
+  data.tar.gz: 45b591eee5e366b08b72d331c22593221c5e93163e89b25761c13652f919fcf99ace3b9637d246d53464c95f1031efb6eee9f4d746bc2ecec9706c0df90ee28c

data/README.md

@@ -61,23 +61,23 @@ end
 
 Can be executed using `rake driver:my_driver:my_namespace:task_name`.
 
-### Overrides
+### Extensions
 
-Sometimes you want to add a method to a core class, but that method will only be used by one driver. This can be achieved by adding files to your driver's `overrides` directory.
+Sometimes you want to add a method to a core class, but that method will only be used by one driver. This can be achieved by adding files to your driver's `extensions` directory.
 
 ```ruby
 # app/models/product.rb
 # (doesn't have to be a model - can be anything)
 class Product < ApplicationRecord
-  # When you include this, every driver's product_override.rb is loaded and
+  # When you include this, every driver's product_extension.rb is loaded and
   # included. Works correctly with autoloading during development.
-  include RailsDrivers::Overrides
+  include RailsDrivers::Extensions
 end
 
 
-# drivers/my_driver/overrides/product_override.rb
+# drivers/my_driver/extensions/product_extension.rb
 module MyDriver
-  module ProductOverride
+  module ProductExtension
     extend ActiveSupport::Concern
 
     def new_method
@@ -91,7 +91,7 @@ end
 Product.new.new_method
 ```
 
-For each Override, the accompanying class simply `includes` it, so any methods you define will be available throughout the whole app. To make sure your drivers don't change the core behavior of the app, see [Testing for coupling](#testing-for-coupling).
+For each Extension, the accompanying class simply `includes` it, so any methods you define will be available throughout the whole app. To make sure your drivers don't change the core behavior of the app, see [Testing for coupling](#testing-for-coupling).
 
 ### Testing for coupling
 

data/lib/generators/driver/USAGE

@@ -11,6 +11,6 @@ Example:
         drivers/new_feature/app/models/new_feature
         drivers/new_feature/app/views/new_feature
         drivers/new_feature/config
-        drivers/new_feature/overrides
+        drivers/new_feature/extensions
         drivers/new_feature/spec
         drivers/new_feature/lib

data/lib/generators/driver/driver_generator.rb

@@ -10,7 +10,7 @@ class DriverGenerator < Rails::Generators::NamedBase
     create_file "drivers/#{file_name}/spec/.keep", ''
     create_file "drivers/#{file_name}/db/migrate/.keep", ''
     create_file "drivers/#{file_name}/lib/tasks/.keep", ''
-    create_file "drivers/#{file_name}/overrides/.keep", ''
+    create_file "drivers/#{file_name}/extensions/.keep", ''
 
     template 'routes.rb.erb',      "drivers/#{file_name}/config/routes.rb"
     template 'initializer.rb.erb', "drivers/#{file_name}/config/initializers/#{file_name}_feature.rb"

data/lib/rails_drivers.rb

@@ -3,7 +3,7 @@
 require 'rails_drivers/version'
 require 'rails_drivers/setup'
 require 'rails_drivers/railtie'
-require 'rails_drivers/overrides'
+require 'rails_drivers/extensions'
 
 module RailsDrivers
   class << self

data/lib/rails_drivers/extensions.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RailsDrivers
+  module Extensions
+    extend ActiveSupport::Concern
+
+    # Including this module results in all available extension modules being
+    # included.
+    included do
+      cattr_reader :driver_extensions
+
+      possible_extensions = Dir.glob(
+        Rails.root.join(
+          'drivers', '*', 'extensions',
+          "#{name.underscore}_extension.rb"
+        )
+      )
+
+      @@driver_extensions = possible_extensions.map do |path|
+        require_dependency path
+        %r{drivers/(?<driver_name>[^/]+)/extensions} =~ path
+
+        extension = "#{driver_name.classify}::#{name}Extension".constantize
+        include extension
+        extension
+      end.freeze
+
+      singleton_class.prepend CheckForShadowedMethods
+    end
+
+    # This module is prepended to the singleton class of the including class
+    # to detect when an extension is attempting to re-define any methods.
+    module CheckForShadowedMethods
+      def method_added(method_name)
+        driver_extensions.each do |extension|
+          next unless extension.instance_methods.include?(method_name)
+
+          Rails.logger.warn "Driver extension method #{extension.name}##{method_name} "\
+            "is shadowed by #{name}##{method_name} and will likely not do anything."
+        end
+
+        super(method_name)
+      end
+    end
+  end
+end

data/lib/rails_drivers/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_drivers
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Nigel Baillie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2020-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -101,8 +101,8 @@ files:
 - lib/generators/driver/templates/module.rb.erb
 - lib/generators/driver/templates/routes.rb.erb
 - lib/rails_drivers.rb
+- lib/rails_drivers/extensions.rb
 - lib/rails_drivers/files.rb
-- lib/rails_drivers/overrides.rb
 - lib/rails_drivers/railtie.rb
 - lib/rails_drivers/routes.rb
 - lib/rails_drivers/setup.rb

data/lib/rails_drivers/overrides.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module RailsDrivers
-  module Overrides
-    extend ActiveSupport::Concern
-
-    # Including this module results in all available override modules being
-    # included.
-    included do
-      cattr_reader :driver_overrides
-
-      possible_overrides = Dir.glob(
-        Rails.root.join(
-          'drivers', '*', 'overrides',
-          "#{name.underscore}_override.rb"
-        )
-      )
-
-      @@driver_overrides = possible_overrides.map do |path|
-        require_dependency path
-        %r{drivers/(?<driver_name>[^/]+)/overrides} =~ path
-
-        override = "#{driver_name.classify}::#{name}Override".constantize
-        include override
-        override
-      end.freeze
-
-      singleton_class.prepend CheckForShadowedMethods
-    end
-
-    # This module is prepended to the singleton class of the including class
-    # to detect when an override is attempting to re-define any methods.
-    module CheckForShadowedMethods
-      def method_added(method_name)
-        driver_overrides.each do |override|
-          next unless override.instance_methods.include?(method_name)
-
-          Rails.logger.warn "Driver override method #{override.name}##{method_name} "\
-            "is shadowed by #{name}##{method_name} and will likely not do anything."
-        end
-
-        super(method_name)
-      end
-    end
-  end
-end