faucet_pipeline_rails 0.2.0 → 1.0.0.rc0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa546fe3ef7bf6aac77523e1cc0303a5be5f42b8
-  data.tar.gz: aceb6e978667b31b021f0192bf268dbde9a04b60
+  metadata.gz: 869fc10676e02209e7ee30a2e6d023f924cbc560
+  data.tar.gz: c9db37a4d16c020c135afc738e0e651a7a3cb60b
 SHA512:
-  metadata.gz: 7850f94b90e1de832d9a110df0da6c2ffcd442b85e9f36b7add465c5b89521606a126b2b52a2f03de5a13bceee7a5d6bb5ed916353ca924d14ee32f5c3509c2a
-  data.tar.gz: f78c317c2a1325e7fc802d03c1a2c8f71a99389488f76a12db2fee0d7ae5b6ef3a26a4e0b33ddb18458a8119b3954f81167e0f0a611a556c3a89818261c96984
+  metadata.gz: 409d051793c04bbb82846a9aed6468c9e4e9be8f07aafa7d62e7a19352a1ad11fe7dbc1a9d642ede67e3d372bf46aad5ca53ff0cd17a053b01aa765fc1bc3c6f
+  data.tar.gz: b2a2a0bb416238b53c2b1c813dd9bea212e83ce14215dd1fa401f1259d4d3b343be932b8e597b6cdad413d8053e34fbdd8bc2a7678c544a24139cc90da3fde45

data/README.md

@@ -20,18 +20,12 @@ So let's say you have a JavaScript file called `application.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 files for each type of asset. In this
-case, it needs to generate a file called `javascript.json` in
-`public/assets/manifests` (to change this, see the Configuration section). The
-file should look like this:
-
-```json
-{
-  "application.js": "/assets/javascripts/application-03118e77692b637cfc0f55bb27fef087.js"
-}
-```
+`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:
+And that's it. This gem will take care of the rest. The resulting HTML will
+look like this:
 
 ```html
 <!-- ... -->
@@ -65,75 +59,78 @@ 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 
+`config/application.rb` from `require 'rails/all'` to:
+
+```ruby
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "action_cable/engine"
+# require "sprockets/railtie" # Disable sprockets
+require "rails/test_unit/railtie"
+```
+
+Make sure you customize this to your actual needs. The main takeaway here is
+to not require `"sprockets/railtie"` anymore.
+
+For fresh apps, you can just skip sprockets with:
+
+    rails new --skip-sprockets
+
 ## Configuration
 
 By default this gem assumes that your manifest files can be found in
-`public/assets/manifests`. This is a nice starting point for a `faucet.config.js`:
+`public/assets/manifest.json`. This is a nice starting point for a
+`faucet.config.js`:
 
 ```js
-let jsConfig = {
-  manifest: {
-    file: "public/assets/manifests/javascript.json",
-    baseURI: (bundlePath, baseName) => `/assets/javascripts/${baseName}`
-  },
-  bundles: [{
-    entryPoint: "./app/assets/javascripts/application.js",
-    target: "public/assets/javascripts/application.js",
-    externals: {}
-  }]
-};
+let jsConfig = [{
+  entryPoint: "./app/assets/javascripts/application.js",
+  target: "./public/assets/javascripts/application.js"
+}];
 
-let sassConfig = {
-  manifest: {
-    file: "public/assets/manifests/stylesheet.json",
-    baseURI: (bundlePath, baseName) => `/assets/stylesheets/${baseName}`
-  },
-  assets: [
-    "public/assets/manifests/static.json"
-  ],
-  prefixes: {
-    browsers: [ "last 2 versions" ]
-  },
-  bundles: [{
-    entryPoint: "app/assets/stylesheets/application.scss",
-    target: "public/assets/stylesheets/application.css"
-  }]
-};
+let sassConfig = [{
+  entryPoint: "./app/assets/stylesheets/application.scss",
+  target: "./public/assets/stylesheets/application.css"
+}];
 
-let staticConfig = {
-  manifest: {
-    file: "public/assets/manifests/static.json",
-    baseURI: (bundlePath, baseName) => `/assets/static/${baseName}`
-  },
-  bundles: [{
-    source: "app/assets/images",
-    target: "public/assets/static"
-  }]
-}
+let staticConfig = [{
+  source: "./app/assets/images",
+  target: "./public/assets/images"
+}];
 
 module.exports = {
   js: jsConfig,
   sass: sassConfig,
   static: staticConfig,
-  watchDirs: ["app/assets"]
+  watchDirs: ["app/assets"],
+  manifest: {
+    file: "./public/assets/manifest.json",
+    webRoot: "./public"
+  }
 };
 ```
 
 In this case, your `application.html.erb` would contain lines like these:
 
 ```erb
-<%= stylesheet_link_tag 'public/assets/stylesheets/application.css', media: 'all', 'data-turbolinks-track': 'reload' %>
-<%= javascript_include_tag 'public/assets/javascripts/application.js', 'data-turbolinks-track': 'reload' %>
+<%= stylesheet_link_tag 'public/assets/application.css', media: 'all', 'data-turbolinks-track': 'reload' %>
+<%= javascript_include_tag 'public/assets/application.js', 'data-turbolinks-track': 'reload' %>
 ```
 
-You can change the path to the manifest fiels that with the following
-configuration:
+You can change the path to the manifest file with the following configuration:
 
 ```ruby
-config.x.faucet_pipeline.manifests_path = File.join("my", "own", "manifests", "path")
+config.x.faucet_pipeline.manifest_path = File.join("my", "own", "manifests", "path.json")
 ```
 
-The `manifests_path` is relative to your Rails Root.
+The `manifest_path` is relative to your Rails Root.
 
 ## Development
 

data/lib/faucet_pipeline_rails/manifest.rb

@@ -1,9 +1,8 @@
+require "singleton"
+
 module FaucetPipelineRails
   class Manifest
-    def initialize(manifests_path, type)
-      @manifests_path = manifests_path
-      @type = type
-    end
+    include Singleton
 
     def fetch(asset_name)
       parsed_manifest.fetch(asset_name)
@@ -16,21 +15,22 @@ module FaucetPipelineRails
     def parsed_manifest
       JSON.parse(unparsed_manifest)
     rescue JSON::ParserError
-      raise "The manifest file '#{manifest_path}' is invalid JSON"
+      raise "The manifest file '#{relative_manifest_path}' is invalid JSON"
     end
 
     def unparsed_manifest
-      File.read(full_manifest_path)
+      File.read(manifest_path)
     rescue Errno::ENOENT
-      raise "The manifest file '#{manifest_path}' is missing"
+      raise "The manifest file '#{relative_manifest_path}' is missing"
     end
 
-    def full_manifest_path
-      File.join(Rails.root, manifest_path)
+    def manifest_path
+      File.join(Rails.root, relative_manifest_path)
     end
 
-    def manifest_path
-      File.join(@manifests_path, "#{@type}.json")
+    def relative_manifest_path
+      Rails.configuration.x.faucet_pipeline.manifest_path ||
+        File.join("public", "assets", "manifest.json")
     end
   end
 end

data/lib/faucet_pipeline_rails/railtie.rb

@@ -1,9 +1,12 @@
-require "faucet_pipeline_rails/compute_asset_path"
+require "faucet_pipeline_rails/manifest"
 
 module FaucetPipelineRails
   class Railtie < Rails::Railtie
     ActiveSupport.on_load(:action_view) do
-      include FaucetPipelineRails::ComputeAssetPath
+      # Overwrite `compute_asset_path` with our own implementation
+      define_method(:compute_asset_path) do |source, _|
+        Manifest.instance.fetch(source)
+      end
     end
   end
 end

data/lib/faucet_pipeline_rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faucet_pipeline_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0.rc0
 platform: ruby
 authors:
 - Lucas Dohmen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-06 00:00:00.000000000 Z
+date: 2018-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -63,7 +63,6 @@ files:
 - README.md
 - Rakefile
 - lib/faucet_pipeline_rails.rb
-- lib/faucet_pipeline_rails/compute_asset_path.rb
 - lib/faucet_pipeline_rails/manifest.rb
 - lib/faucet_pipeline_rails/railtie.rb
 - lib/faucet_pipeline_rails/version.rb
@@ -82,9 +81,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.13

data/lib/faucet_pipeline_rails/compute_asset_path.rb

@@ -1,25 +0,0 @@
-require "faucet_pipeline_rails/manifest"
-
-module FaucetPipelineRails
-  module ComputeAssetPath
-    MANIFEST_FOR_TYPE = {
-      image: "static",
-      stylesheet: "stylesheet",
-      javascript: "javascript"
-    }
-
-    def compute_asset_path(source, options = {})
-      if MANIFEST_FOR_TYPE.has_key? options[:type]
-        manifest = Manifest.new(manifests_path, MANIFEST_FOR_TYPE[options[:type]])
-        manifest.fetch(source)
-      else
-        source
-      end
-    end
-
-    def manifests_path
-      Rails.configuration.x.faucet_pipeline.manifests_path ||
-        File.join("public", "assets", "manifests")
-    end
-  end
-end