rails_external_assets 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a43f383d3275686a5dcc74f3624e73952e734ed3
-  data.tar.gz: bcc8fc89a901f04ed38afecac5a59e587a8b7a04
+  metadata.gz: 401fb50bb26e74bd9809f5ae1ae36b25b3bee376
+  data.tar.gz: 5358ed54efd266a62a4dab5c34d0d420e579b750
 SHA512:
-  metadata.gz: 43eac0d5fd15c6f9fba4e279f5f872da391c4a5dadf35b5091564e84e5a6cda7ac980b307a1c2d3eb1609431bb301fae286c0c1f435e7d1e571f4f2f14efde8e
-  data.tar.gz: 0689163f8c108e16c507ac21d85a932b16fd26bf8f748739ae88c3b1264c5866c95f8b10cea1b3964906a1552af0e6ac715240b96d9a4dcecf01de89d50b10df
+  metadata.gz: 5235105c1e0824f8d66d818869ef4a7d79089da4424c7b4cb0e983d837ce47f4d0d6bf69fd16f13c2aea19c4eb2652ead91a08685ffe4aae4cf77644ed546f28
+  data.tar.gz: 973a6cb4201c7d2889d637fbfc6ff850bbb4414e19f3f8b652e486c33f1270dbe309fe64422e372db7a4a20a0fa459249f0be5953825de47c2c80bd9d142899f

data/README.md

@@ -3,7 +3,7 @@
 
 # RailsExternalAssets
 
-RailsExternalAssets allows you to use the frontend build tool of your choice ([webpack](https://webpack.github.io/), [jspm](http://jspm.io/), [browserify](http://browserify.org/) etc) with Rails. Essentially you can build all (or some) of your frontend assets outside of Rails' asset pipeline, but still make use of them in Rails. The only requirement is that you provide an asset manifest file, which is a json file that maps your asset files to their final built files:
+RailsExternalAssets allows you to use the frontend build tool of your choice ([webpack](https://webpack.github.io/), [jspm](http://jspm.io/), [browserify](http://browserify.org/), etc) with Rails. Essentially you can build all (or some) of your frontend assets outside of Rails' asset pipeline, but still make use of them in Rails. The only requirement is that you provide an asset manifest file, which is a json file that maps your asset files to their final built files:
 
 ```json
 {
@@ -13,7 +13,7 @@ RailsExternalAssets allows you to use the frontend build tool of your choice ([w
 }
 ```
 
-This means you can manage your frontend assets however you like and RailsExternalAssets gives you [Rails](http://rubyonrails.org/) view helpers and [Sprockets](https://github.com/rails/sprockets) directives to incorporate these external assets into your Rails application.
+This means you can manage your frontend assets however you like and RailsExternalAssets gives you [Rails](http://rubyonrails.org/) view helpers and [Sprockets](https://github.com/rails/sprockets) directives to incorporate these external assets into your Rails application. In Rails environments, RailsExternalAssets also hooks into `assets:precompile` and `assets:clobber` Rake tasks.
 
 You can use RailsExternalAssets without using Ruby on Rails, but you will have to wire up the helper methods it provides into your application yourself.
 
@@ -39,6 +39,8 @@ Or install it yourself as:
 
 You can include your external assets in Rails with the provided view helpers or Sprockets directives.
 
+RailsExternalAssets will also hook into the `assets:precompile` Rake command and run the shell script defined by the `build_script` config. It will also hook into the `assets:clobber` Rake command and remove all the files in the directory specified by your `base_path` config (where your assets are built).
+
 ### View Helpers
 
 #### JavaScript
@@ -129,6 +131,14 @@ This is an array to configure the use of the `external_assets` Sprockets directi
 ]
 ```
 
+**build_script**
+
+This is the shell script that will be run prior to `assets:precompile` in Rails or with the `rake assets:build_external_assets` command. This should be the script that builds your assets (eg: `npm run build`).
+
+Note that in a Rails environment, `assets:clobber` will also remove all the files in your `base_path` directory (where your assets are built).
+
+> Defaults to `echo "You did not define a build script"`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -139,8 +149,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/jdlehman/rails_external_assets. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/rails_external_assets/configuration.rb

@@ -18,7 +18,8 @@ module RailsExternalAssets
   class Configuration
     attr_accessor :base_path,
                   :manifest_file,
-                  :sprockets_directives
+                  :sprockets_directives,
+                  :build_script
 
     def initialize
       # base path should be off Rails public/
@@ -28,6 +29,7 @@ module RailsExternalAssets
         { mime_type: 'application/javascript', comments: ['//', ['/*', '*/']] },
         { mime_type: 'application/css', comments: ['//', ['/*', '*/']] }
       ]
+      @build_script = 'echo "You did not define a build script"'
     end
   end
 end

data/lib/rails_external_assets/rails/railtie.rb

@@ -1,6 +1,10 @@
 module RailsExternalAssets
   module Rails
     class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load 'rails_external_assets/tasks/assets.rake'
+      end
+
       initializer 'rails_external_assets.initialize' do |app|
         ActionView::Base.send :include, ViewHelpers
 

data/lib/rails_external_assets/tasks/assets.rake

@@ -0,0 +1,20 @@
+# based on https://www.tomdooner.com/2014/06/29/webpack.html
+require 'rake'
+
+Rake::Task['assets:precompile'].enhance(['assets:compile_environment'])
+
+namespace :assets do
+  # set prerequisites for the assets:precompile task
+  task :compile_environment => :build_external_assets do
+    Rake::Task['assets:environment'].invoke
+  end
+
+  desc 'Build external assets'
+  task :build_external_assets do
+    sh "NODE_ENV=#{Rails.env} #{RailsExternalAssets.config.build_script}"
+  end
+
+  task :clobber do
+    rm_rf File.join('public', RailsExternalAssets.config.base_path)
+  end
+end

data/lib/rails_external_assets/version.rb

@@ -1,3 +1,3 @@
 module RailsExternalAssets
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_external_assets
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jonathan Lehman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-19 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,6 +79,7 @@ files:
 - lib/rails_external_assets/rails/view_helpers.rb
 - lib/rails_external_assets/sprockets.rb
 - lib/rails_external_assets/sprockets/directive_processor.rb
+- lib/rails_external_assets/tasks/assets.rake
 - lib/rails_external_assets/version.rb
 - rails_external_assets.gemspec
 homepage: http://github.com/jdlehman/rails_external_assets