rails_drivers 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '03862c5a464a55793074ecb863ac4e7eb4530172923a5f0a8207d8051bf54f96'
-  data.tar.gz: ffc80ffc2db7d8f71f5598f388fa3cce4efc8399362aa841d3b21cc776508df3
+  metadata.gz: 575d8e9162b65431801bf6d419fe5fca254d65fdd3a840877ea1a0c186bd90bd
+  data.tar.gz: 06e51508f802ee83223d9b9a0bea05f91f93d0813cf1aba6503f29d63cb9d631
 SHA512:
-  metadata.gz: 2a89e522b5a3fac4be2323be01f8d9e2085e2b54ceee263b1835b75bbae7df2397d68b57c690bcf11f7df1ca5efce2be9add211bcd7a247a8d96e3d3dc1bf7e0
-  data.tar.gz: df27e76af55099c0031644db8a156124ffa2b72d9ef67ef6a4427119f3c35497979814348bf86cf8ec4a20065834d6dc3839f27647f248eccee2cf2c16812fff
+  metadata.gz: 65a00d958eaf2d888c565149f840ac43f0048587b332c433c33734e38652bb31d5a90c6d3bb439eaca6c5e3c1b7b2fa7d9703f97a45dad40b059a3f3e05e298f
+  data.tar.gz: b5a03060c043e906ea25955a23513a6939a532fecb560c81cb3bc9075d708195d9bf60135e620a268ca025ec81a9ea90b17c0f0baf957761b091b330ef763a73

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
 
@@ -72,13 +72,15 @@ And then execute:
 $ bundle install
 ```
 
-Add this line to your routes.rb
+Add this line to your routes.rb:
 
 ```ruby
 require 'rails_drivers/routes'
 ```
 
-(Optional) Add these lines to your `spec/rails_helper.rb`
+### RSpec
+
+If you use RSpec, 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 }
@@ -90,5 +92,43 @@ RSpec.configure do |config|
 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/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.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_drivers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nigel Baillie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2019-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,20 @@ 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: