faucet_pipeline_rails 1.0.0.rc0 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 869fc10676e02209e7ee30a2e6d023f924cbc560
-  data.tar.gz: c9db37a4d16c020c135afc738e0e651a7a3cb60b
+  metadata.gz: 82f6b20abd70b0ea93f17dae2277531b6dda7b6c
+  data.tar.gz: 4036e53601582fc1f6eb435ebba0943f08d4c55b
 SHA512:
-  metadata.gz: 409d051793c04bbb82846a9aed6468c9e4e9be8f07aafa7d62e7a19352a1ad11fe7dbc1a9d642ede67e3d372bf46aad5ca53ff0cd17a053b01aa765fc1bc3c6f
-  data.tar.gz: b2a2a0bb416238b53c2b1c813dd9bea212e83ce14215dd1fa401f1259d4d3b343be932b8e597b6cdad413d8053e34fbdd8bc2a7678c544a24139cc90da3fde45
+  metadata.gz: 619f4e6bb2956cfb3cb5665cc03a4bc00380ebea0b2d1bb55ba470d18c45ff7257acfa62d477c9dbabe67eac7c6279a9d26cecea72068c84631875f125d5764f
+  data.tar.gz: 59baa88114aca729e561adb917b7dbdd74f11b1af5678add07363ea6ff0db8676c7b75ec66339c9bbccbf352d061068c0d11be2901dd69d9a6e4139c009425b3

data/README.md

@@ -18,11 +18,10 @@ So let's say you have a JavaScript file called `application.js` (for example in
 `app/assets/javascripts`) and `faucet-pipeline` generates a file called
 `application-03118e77692b637cfc0f55bb27fef087.js` (for example in
 `public/assets/javascripts`) from that file. When you use `stylesheet_link_tag
-'public/assets/javascripts/application.js'`, you expect that the resulting HTML
-points to the file containing the hash in its filename. To do that,
-`faucet-pipeline` generates a manifest file. In the case of using it with this
-Gem, it needs to save it as `public/assets/manifest.json` (to change this, see
-the Configuration section)
+'application.css'`, you expect that the resulting HTML points to the file
+containing the hash in its filename. To do that, `faucet-pipeline` generates a
+manifest file. In the case of using it with this Gem, it needs to save it as
+`public/assets/manifest.json` (to change this, see the Configuration section)
 
 And that's it. This gem will take care of the rest. The resulting HTML will
 look like this:
@@ -53,14 +52,8 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-
-```
-$ gem install faucet_pipeline_rails
-```
-
 After this, you can ditch sprockets (aka the classic Rails asset pipeline)
-for good. If you're on an existing Rails app, change the top of your 
+for good. If you're on an existing Rails app, change the top of your
 `config/application.rb` from `require 'rails/all'` to:
 
 ```ruby
@@ -83,54 +76,57 @@ For fresh apps, you can just skip sprockets with:
 
     rails new --skip-sprockets
 
+You also need to install `faucet-pipeline`.
+[Here are the instructions](http://www.faucet-pipeline.org)
+
 ## Configuration
 
-By default this gem assumes that your manifest files can be found in
-`public/assets/manifest.json`. This is a nice starting point for a
-`faucet.config.js`:
+This is a nice starting point for a `faucet.config.js`:
 
 ```js
-let jsConfig = [{
-  entryPoint: "./app/assets/javascripts/application.js",
-  target: "./public/assets/javascripts/application.js"
-}];
-
-let sassConfig = [{
-  entryPoint: "./app/assets/stylesheets/application.scss",
-  target: "./public/assets/stylesheets/application.css"
-}];
-
-let staticConfig = [{
-  source: "./app/assets/images",
-  target: "./public/assets/images"
-}];
-
 module.exports = {
-  js: jsConfig,
-  sass: sassConfig,
-  static: staticConfig,
-  watchDirs: ["app/assets"],
+  js: [{
+    source: "./app/assets/javascripts/application.js",
+    target: "./public/assets/javascripts/application.js"
+  }],
+  sass: [{
+    source: "./app/assets/stylesheets/application.scss",
+    target: "./public/assets/stylesheets/application.css"
+  }],
+  static: [{
+    source: "./app/assets/images",
+    target: "./public/assets/images"
+  }],
   manifest: {
     file: "./public/assets/manifest.json",
+    key: "short",
     webRoot: "./public"
-  }
+  },
+  watchDirs: ["./app/assets"]
 };
 ```
 
 In this case, your `application.html.erb` would contain lines like these:
 
 ```erb
-<%= stylesheet_link_tag 'public/assets/application.css', media: 'all', 'data-turbolinks-track': 'reload' %>
-<%= javascript_include_tag 'public/assets/application.js', 'data-turbolinks-track': 'reload' %>
+<%= stylesheet_link_tag 'application.css', media: 'all', 'data-turbolinks-track': 'reload' %>
+<%= javascript_include_tag 'application.js', 'data-turbolinks-track': 'reload' %>
 ```
 
-You can change the path to the manifest file with the following configuration:
+By default this gem assumes that your manifest files can be found in
+`public/assets/manifest.json`. You can change the path to the manifest
+file with the following configuration:
 
 ```ruby
-config.x.faucet_pipeline.manifest_path = File.join("my", "own", "manifests", "path.json")
+config.faucet_pipeline.manifest_path = Rails.root.join("manifest.json")
 ```
 
-The `manifest_path` is relative to your Rails Root.
+Note that `manifest_path` is an absolute path.
+
+This gem also provides a Rake task `assets:precompile` that runs faucet with the
+`--compact --fingerprint` options. It can therefore be used as a drop-in replacement
+for the task provided by the Rails asset pipeline. It only works if you install
+your NPM dependencies to the default location (your app's `node_modules` folder).
 
 ## Development
 

data/lib/faucet_pipeline_rails/manifest.rb

@@ -5,32 +5,32 @@ module FaucetPipelineRails
     include Singleton
 
     def fetch(asset_name)
-      parsed_manifest.fetch(asset_name)
+      manifest.fetch(asset_name)
     rescue KeyError
       raise "The asset '#{asset_name}' was not in the manifest"
     end
 
     private
 
+    def manifest
+      return parsed_manifest unless Rails.env.production?
+      @manifest ||= parsed_manifest
+    end
+
     def parsed_manifest
       JSON.parse(unparsed_manifest)
     rescue JSON::ParserError
-      raise "The manifest file '#{relative_manifest_path}' is invalid JSON"
+      raise "The manifest file '#{manifest_path}' is invalid JSON"
     end
 
     def unparsed_manifest
       File.read(manifest_path)
     rescue Errno::ENOENT
-      raise "The manifest file '#{relative_manifest_path}' is missing"
+      raise "The manifest file '#{manifest_path}' is missing"
     end
 
     def manifest_path
-      File.join(Rails.root, relative_manifest_path)
-    end
-
-    def relative_manifest_path
-      Rails.configuration.x.faucet_pipeline.manifest_path ||
-        File.join("public", "assets", "manifest.json")
+      Rails.configuration.faucet_pipeline.manifest_path
     end
   end
 end

data/lib/faucet_pipeline_rails/railtie.rb

@@ -8,5 +8,19 @@ module FaucetPipelineRails
         Manifest.instance.fetch(source)
       end
     end
+
+    initializer "faucet_pipeline.configure_manifest_path" do |app|
+      config.faucet_pipeline = ActiveSupport::OrderedOptions.new
+      config.faucet_pipeline.manifest_path = app.root.join("public", "assets", "manifest.json")
+    end
+
+    rake_tasks do
+      namespace :assets do
+        desc "Compile assets via faucet-pipeline"
+        task :precompile do
+          sh "./node_modules/.bin/faucet --compact --fingerprint"
+        end
+      end
+    end
   end
 end

data/lib/faucet_pipeline_rails/version.rb

@@ -1,3 +1,3 @@
 module FaucetPipelineRails
-  VERSION = "1.0.0.rc0"
+  VERSION = "1.0.0.rc1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faucet_pipeline_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc0
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Lucas Dohmen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 2018-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Use Rails with faucet-pipeline