rails_drivers 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '03862c5a464a55793074ecb863ac4e7eb4530172923a5f0a8207d8051bf54f96'
-  data.tar.gz: ffc80ffc2db7d8f71f5598f388fa3cce4efc8399362aa841d3b21cc776508df3
+  metadata.gz: b0d06c45078456d085945c12374a78a6e8cd8c5ae83ad7abc7fd55cda175e8c4
+  data.tar.gz: 18d5755774da8c851c0a39a25bcfa061445ac1acc06a98e27b22acb896443ab2
 SHA512:
-  metadata.gz: 2a89e522b5a3fac4be2323be01f8d9e2085e2b54ceee263b1835b75bbae7df2397d68b57c690bcf11f7df1ca5efce2be9add211bcd7a247a8d96e3d3dc1bf7e0
-  data.tar.gz: df27e76af55099c0031644db8a156124ffa2b72d9ef67ef6a4427119f3c35497979814348bf86cf8ec4a20065834d6dc3839f27647f248eccee2cf2c16812fff
+  metadata.gz: '09235347fa19b0da2ea6f20bebdfc4f2048c51760df3889575d7d6cd376a658ccac01a1053b03feaa7f6f89a329ca60db323aa2eb365b62977e29bd05e20a20c'
+  data.tar.gz: cff5ba12b81d820189e145f8b15535ec8ab42942963cb31eb501c359f4f2561171326d1cf93adab12df6d1a540f2f2465f4cb18c304316049561237409005656

data/README.md

@@ -4,20 +4,20 @@
 
 Each driver is like a mini Rails app that has full access to the main app. A driver has its own `app`, `config`, `spec`, and `db` folder.
 
-Technically speaking, drivers are just a way to put code into a different folder, but there are some rules we like to follow in order to reduce application complexity:
+Technically speaking, drivers are just a fancy name for putting code into a different folder. The advantage of doing this is that it provides clear-cut separation of concerns. If we follow a couple of simple rules, we can actually test that separation:
 
 - Drivers should not touch other drivers
 - The main app should not touch drivers directly
 
 The "main app" refers to the files inside your `<project root>/app` directory.
 
-Thankfully, we can test that these rules are adhered to by removing drivers before running the test suite.
+If your test suite is good, you can test that these rules are adhered to by selectively adding and removing drivers before running your tests.
 
 ## Aren't these just engines?
 
 Very similar, yes. They use the same Rails facilities for adding new `app` paths, etc.
 
-But Drivers have one useful property: they can be freely added and removed from your project without breaking anything.
+But Drivers have less friction. They can be freely added and removed from your project without breaking anything. There's no need to mess around with gems, vendoring, or dummy apps.
 
 ## Usage
 
@@ -34,6 +34,21 @@ Just run `rails g driver my_new_driver_name`.
 The `driver` utility technically works with other generators and rake tasks, but is only guaranteed to work with migrations.
 The reason is that some generators assume a particular path, rather than using the Rails path methods.
 
+### Creating a rake task in a driver
+
+Every driver includes a `lib/tasks` directory where you can define rake tasks. Rake tasks defined in drivers are automatically loaded and namespaced.
+For example,
+
+```ruby
+# drivers/my_driver/lib/tasks/my_namespace.rake
+namespace :my_namespace do
+  task :task_name do
+  end
+end
+```
+
+Can be executed using `rake driver:my_driver:my_namespace:task_name`.
+
 ### Testing for coupling
 
 Since drivers are merged into your main application just like engines, there's nothing stopping them from accessing other drivers, and there's nothing stopping your main application from accessing drivers. In order to ensure those things don't happen, we have a handful of rake tasks:
@@ -54,6 +69,11 @@ rake driver:restore
 rake driver:isolate[admin]
 rspec --pattern '{spec,drivers/*/spec}/**{,/*/**}/*_spec.rb'
 rake driver:restore
+
+# Short-hand with 'driver' utility!
+bundle exec driver admin do rspec --pattern '{spec,drivers/*/spec}/**{,/*/**}/*_spec.rb'
+# (can run with no drivers as well)
+bundle exec nodriver do rspec --pattern '{spec,drivers/*/spec}/**{,/*/**}/*_spec.rb'
 ```
 
 This lets you to ensure that the store and admin function properly without each other. Note we're running all of the main app's specs twice. This is good because we also want to make sure the main app is not reaching into drivers.
@@ -72,23 +92,69 @@ And then execute:
 $ bundle install
 ```
 
-Add this line to your routes.rb
+Add this line to your routes.rb:
 
 ```ruby
 require 'rails_drivers/routes'
+
+# This can go before or after your application's route definitions
+RailsDrivers::Routes.load_driver_routes
 ```
 
-(Optional) Add these lines to your `spec/rails_helper.rb`
+### RSpec
+
+If you use RSpec with FactoryBot, add these lines to your `spec/rails_helper.rb` or `spec/spec_helper.rb`:
 
 ```ruby
 Dir[Rails.root.join("drivers/*/spec/support/*.rb")].each { |f| require f }
 
 RSpec.configure do |config|
+  FactoryBot.definition_file_paths += Dir['drivers/*/spec/factories']
+  FactoryBot.reload
+
   Dir[Rails.root.join('drivers/*/spec')].each { |x| config.project_source_dirs << x }
   Dir[Rails.root.join('drivers/*/lib')].each { |x| config.project_source_dirs << x }
   Dir[Rails.root.join('drivers/*/app')].each { |x| config.project_source_dirs << x }
 end
 ```
 
+### Webpacker
+
+If you use Webpacker, take a look at this snippet. You'll want to add the code between the comments:
+
+```javascript
+// config/webpack/environment.js
+const { environment } = require('@rails/webpacker')
+
+//// Begin driver code ////
+const { config } = require('@rails/webpacker')
+const { sync } = require('glob')
+const { basename, dirname, join, relative, resolve } = require('path')
+const extname = require('path-complete-extname')
+
+const getExtensionsGlob = () => {
+  const { extensions } = config
+  return extensions.length === 1 ? `**/*${extensions[0]}` : `**/*{${extensions.join(',')}}`
+}
+
+const addToEntryObject = (sourcePath) => {
+  const glob = getExtensionsGlob()
+  const rootPath = join(sourcePath, config.source_entry_path)
+  const paths = sync(join(rootPath, glob))
+  paths.forEach((path) => {
+    const namespace = relative(join(rootPath), dirname(path))
+    const name = join(namespace, basename(path, extname(path)))
+    environment.entry.set(name, resolve(path))
+  })
+}
+
+sync('drivers/*').forEach((driverPath) => {
+  addToEntryObject(join(driverPath, config.source_path));
+})
+//// End driver code ////
+
+module.exports = environment
+```
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/driver

@@ -1,15 +1,39 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-APP_PATH = File.expand_path('config/application')
-require_relative "#{Dir.pwd}/config/boot"
+require 'rails_drivers/files'
 
-REPLACE_DEFAULT_PATH_WITH_DRIVER = ARGV.shift
+selected_driver = ARGV.shift
 
-possible_drivers = Dir['drivers/*'].map { |d| d.split('/').last }
-unless possible_drivers.include?(REPLACE_DEFAULT_PATH_WITH_DRIVER)
-  puts "Unknown driver #{REPLACE_DEFAULT_PATH_WITH_DRIVER}. Must be one of [#{possible_drivers.join(', ')}]"
-  exit 1
-end
+if ARGV[0] == 'do'
+  #
+  # Run any command with only one driver present
+  #
+  ARGV.shift
+  at_exit { RailsDrivers::Files.restore }
+
+  if selected_driver == '_clear'
+    RailsDrivers::Files.clear
+  else
+    RailsDrivers::Files.isolate selected_driver
+  end
+
+  Process.wait Process.spawn(*ARGV)
+  exit Process.last_status.exitstatus
+else
+  #
+  # Run 'rails' command as if the driver was the rails app.
+  #
+  APP_PATH = File.expand_path('config/application')
+  REPLACE_DEFAULT_PATH_WITH_DRIVER = selected_driver
 
-require 'rails/commands'
+  require_relative "#{Dir.pwd}/config/boot"
+
+  possible_drivers = Dir['drivers/*'].map { |d| d.split('/').last }
+  unless possible_drivers.include?(REPLACE_DEFAULT_PATH_WITH_DRIVER)
+    puts "Unknown driver #{REPLACE_DEFAULT_PATH_WITH_DRIVER}. Must be one of [#{possible_drivers.join(', ')}]"
+    exit 1
+  end
+
+  require 'rails/commands'
+end

data/bin/nodriver

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rails_drivers/files'
+
+ARGV.shift if ARGV[0] == 'do'
+
+at_exit { RailsDrivers::Files.restore }
+RailsDrivers::Files.clear
+Process.wait Process.spawn(*ARGV)
+exit Process.last_status.exitstatus

data/lib/generators/driver/driver_generator.rb

@@ -9,7 +9,7 @@ class DriverGenerator < Rails::Generators::NamedBase
     create_file "drivers/#{file_name}/app/views/#{file_name}/.keep", ''
     create_file "drivers/#{file_name}/spec/.keep", ''
     create_file "drivers/#{file_name}/db/migrate/.keep", ''
-    create_file "drivers/#{file_name}/lib/.keep", ''
+    create_file "drivers/#{file_name}/lib/tasks/.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

@@ -5,11 +5,13 @@ require 'rails_drivers/setup'
 require 'rails_drivers/railtie'
 
 module RailsDrivers
-  def self.loaded
-    @loaded ||= []
-  end
+  class << self
+    def loaded
+      @loaded ||= []
+    end
 
-  def self.freeze!
-    @loaded = @loaded&.freeze
+    def freeze!
+      @loaded = @loaded&.freeze
+    end
   end
 end

data/lib/rails_drivers/files.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RailsDrivers
+  module Files
+    class Error < StandardError
+    end
+
+    module_function
+
+    def isolate(driver)
+      raise Error, 'No driver specified' if driver.nil? || driver == ''
+      raise Error, "Driver #{driver.inspect} not found" unless File.exist?("drivers/#{driver}")
+
+      FileUtils.mkdir_p 'tmp/drivers'
+      Dir['drivers/*'].each do |driver_path|
+        next if driver_path.include?("/#{driver}")
+
+        FileUtils.mv driver_path, "tmp/#{driver_path}"
+      end
+    end
+
+    def clear
+      FileUtils.mkdir_p 'tmp/drivers'
+      Dir['drivers/*'].each do |driver_path|
+        FileUtils.mv driver_path, "tmp/#{driver_path}"
+      end
+    end
+
+    def restore
+      Dir['tmp/drivers/*'].each do |tmp_driver_path|
+        driver = tmp_driver_path.split('/').last
+        FileUtils.mv tmp_driver_path, "drivers/#{driver}"
+      end
+    end
+  end
+end

data/lib/rails_drivers/railtie.rb

@@ -6,6 +6,17 @@ module RailsDrivers
 
     rake_tasks do
       load File.expand_path("#{__dir__}/../tasks/rails_drivers_tasks.rake")
+
+      # load drivers rake tasks
+      Dir['drivers/*/lib/tasks/**/*.rake'].each do |driver_rake_file|
+        %r{^drivers/(?<driver_name>\w+)/} =~ driver_rake_file
+
+        namespace(:driver) do
+          namespace(driver_name) do
+            load driver_rake_file
+          end
+        end
+      end
     end
 
     config.before_configuration { setup_paths }

data/lib/rails_drivers/routes.rb

@@ -11,6 +11,3 @@ module RailsDrivers
     end
   end
 end
-
-# This is meant to be executed as soon as the file is required
-RailsDrivers::Routes.load_driver_routes

data/lib/rails_drivers/setup.rb

@@ -4,6 +4,7 @@ module RailsDrivers
   module Setup
     DRIVER_PATHS = %w[
       app
+      app/assets
       app/models
       app/views
       app/controllers

data/lib/rails_drivers/version.rb

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

data/lib/tasks/rails_drivers_tasks.rake

@@ -1,46 +1,23 @@
 # frozen_string_literal: true
 
 namespace :driver do
-  DriverError = Class.new(StandardError)
-
   desc 'Removes every driver but the one specified. Can be undone with driver:restore.'
   task :isolate, [:driver] do |_t, args|
-    include FileUtils
-
-    raise DriverError, 'No driver specified' if args.driver.blank?
-    raise DriverError, 'Driver not found' unless File.exist?("drivers/#{args.driver}")
-
-    mkdir_p 'tmp/drivers'
-    Dir['drivers/*'].each do |driver_path|
-      next if driver_path.include?("/#{args.driver}")
-
-      mv driver_path, "tmp/#{driver_path}"
-      puts "Moved #{driver_path} to tmp/drivers/"
-    end
-
-  rescue DriverError => e
+    require 'rails_drivers/files'
+    RailsDrivers::Files.isolate(args.driver)
+  rescue RailsDrivers::Files::Error => e
     puts e.message
   end
 
   desc 'Removes all drivers. Can be undone with driver:restore.'
   task :clear do
-    include FileUtils
-
-    mkdir_p 'tmp/drivers'
-    Dir['drivers/*'].each do |driver_path|
-      mv driver_path, "tmp/#{driver_path}"
-      puts "Moved #{driver_path} to tmp/drivers/"
-    end
+    require 'rails_drivers/files'
+    RailsDrivers::Files.clear
   end
 
   desc 'Undoes the effects of driver:isolate and driver:clear.'
   task :restore do
-    include FileUtils
-
-    Dir['tmp/drivers/*'].each do |tmp_driver_path|
-      driver = tmp_driver_path.split('/').last
-      mv tmp_driver_path, "drivers/#{driver}"
-      puts "Moved #{tmp_driver_path} to drivers/"
-    end
+    require 'rails_drivers/files'
+    RailsDrivers::Files.restore
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_drivers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Nigel Baillie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2020-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -52,12 +66,27 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webpacker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 description: Like Rails Engines, but without the friction. Your Rails app can't access
   them, and they can't access each other.
 email:
 - nbaillie@degica.com
 executables:
 - driver
+- nodriver
 extensions: []
 extra_rdoc_files: []
 files:
@@ -65,12 +94,14 @@ files:
 - README.md
 - Rakefile
 - bin/driver
+- bin/nodriver
 - lib/generators/driver/USAGE
 - lib/generators/driver/driver_generator.rb
 - lib/generators/driver/templates/initializer.rb.erb
 - lib/generators/driver/templates/module.rb.erb
 - lib/generators/driver/templates/routes.rb.erb
 - lib/rails_drivers.rb
+- lib/rails_drivers/files.rb
 - lib/rails_drivers/railtie.rb
 - lib/rails_drivers/routes.rb
 - lib/rails_drivers/setup.rb
@@ -95,7 +126,7 @@ 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: De-coupled separation of concerns for Rails