engine_pack 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4188c100677625caaf64e48b753063ac5658b9cde4847a7385114a6d7ead765
-  data.tar.gz: d9a820070be235e792cd184826c12aa3e1c60881910a886314e37a40d519fdd5
+  metadata.gz: 55cf65d9502f706e9b94fac87dc958775805d62e57514434493e28981940cd25
+  data.tar.gz: a4925f67e6109284050bdc87777ec074051ce4b93f59f10461fbfc645a4f6b00
 SHA512:
-  metadata.gz: 88ca00a0347b67233940da099871b8df3735779165c9221b74a8e1d0c77fbb9d0522fe084059d5151e53c3089b074cc6e453e6ff54f8cfb1c2cf74f3c6ec5973
-  data.tar.gz: 94179b0bdc6e69dbbcc93443b65355061c5b2283ee6a27200fe8e9467a1961c6a5973e1e5ce3ae5946f055c16b63c54c1f8e763365242c456036e4b789958f67
+  metadata.gz: d567eb2e14598458d11a8c788e905803ba7d39800acc4807ffb6683243201ede18a6fc67fca6ed3718911b27ca2a9dd13331034741c9b6479876f8e57c3acd93
+  data.tar.gz: 382366d354be4cadc32b937818fcd286a3ab36977ab96cfecb8c0ed5f5967b60e40aafb166b6ce7757e00efec1f5b403eea700b8a2ff861be18829b592d3ca9e

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.5.8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    engine_pack (0.1.0)
+    engine_pack (0.2.0)
       dry-configurable (~> 0.12, >= 0.12.0)
       railties (>= 6.0.0)
 

data/README.md

@@ -14,13 +14,47 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+Finally, run the generator:
 
-    $ gem install engine_pack
+    $ rails generate engine_pack:install
 
 ## Usage
 
-TODO: Write usage instructions here
+It works by hooking into the JavaScript package managers preinstall hook via a Rake task. The Rake task copies the `files` specified in the `package.json` to a temporary directory and then install that directory as a local package.
+
+### Configuration
+
+```ruby
+require 'engine_pack'
+
+EnginePack.configure do |config|
+  config.package_manager = :npm
+  config.engines = %w[
+      engine1
+      engine2
+  ]
+end
+
+```
+
+#### Configuration Options
+
+Option/Method | Description
+--- | ---
+`package_manager` | The package manager you are using with your application. Currently supports `:npm` and `:yarn`. (default: `:npm`)
+`engine` | An array of the names of the gems/engines to include.
+
+### Preinstall Hook
+
+You'll need to add the `preinstall` script to your applications `package.json` in the `scripts` property.
+
+```json
+{
+  "scripts": {
+    "preinstall": "bundle exec rails engine_pack:preinstall"
+  }
+}
+```
 
 ## Development
 

data/lib/engine_pack/version.rb

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

data/lib/generators/engine_pack/install_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+
+module EnginePack
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+
+      desc 'Generates configuration for EnginePack.'
+
+      class_option :package_manager,
+                   desc: 'Specify the JavaScript package manager to configure. (yarn, npm)',
+                   type: :string,
+                   default: 'npm'
+
+      def copy_initializer
+        template 'initializer.rb', 'config/initializers/engine_pack.rb'
+      end
+
+      def show_post_install
+        readme 'POST_INSTAll'
+      end
+    end
+  end
+end

data/lib/generators/templates/POST_INSTALL

@@ -0,0 +1,8 @@
+
+===============================================================================
+
+Add the following to your package.json scripts:
+
+  "preinstall": "bundle exec rails engine_pack:preinstall"
+
+===============================================================================

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,6 @@
+require 'engine_pack'
+
+EnginePack.configure do |config|
+  config.package_manager = :<%= options[:package_manager] %>
+  config.engines = %w[]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: engine_pack
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Aaric Pittman
@@ -110,6 +110,7 @@ files:
 - ".devcontainer/devcontainer.json"
 - ".gitignore"
 - ".rspec"
+- ".tool-versions"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -135,6 +136,9 @@ files:
 - lib/engine_pack/railtie.rb
 - lib/engine_pack/tasks/preinstall.rake
 - lib/engine_pack/version.rb
+- lib/generators/engine_pack/install_generator.rb
+- lib/generators/templates/POST_INSTALL
+- lib/generators/templates/initializer.rb
 homepage: https://github.com/aaricpittman/engine-pack
 licenses:
 - MIT