faucet_pipeline_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97fec74f079066619428bd49d015d7dc04e57e25
+  data.tar.gz: 646f3f335aad7fa900059c818801e31877e68874
+SHA512:
+  metadata.gz: 7e3b46db5330ea021dfded2c0803232ce05ff4bb6c34dcd6ec156fc79a347aa68e98481ee6ad217ab306507b5da2ef2ee1e04606610f80286d1f4f18ffdbaa9f
+  data.tar.gz: c0494053c41fc8d4d4799ed93f37eb78f446d857f4c8a37e909db3c18c656f4a9fdab6f17161d9f59e84a6b5e117df5fba4681fed67ddec3a354c0b5a1e49ad0

data/README.md

@@ -0,0 +1,150 @@
+# Use Rails with faucet-pipeline [![Build Status](https://travis-ci.org/faucet-pipeline/faucet_pipeline_rails.svg)](https://travis-ci.org/faucet-pipeline/faucet_pipeline_rails)
+
+Instead of using the built-in asset pipeline of Rails, use
+[`faucet-pipeline`](https://github.com/faucet-pipeline/faucet-pipeline). This
+gem enables the required integration with Rails.
+
+Why is an integration like that required? `faucet-pipeline` modifies the names
+of the generated files depending on their content (by adding a hash of the file
+to the name), Rails will not be able to find the files on its own. You still
+want to be able to use the helpers you are used to like `stylesheet_link_tag`
+or `image_tag`, and they should put out the correct URL for the desired asset.
+This technique is referred to as *cache busting*.
+
+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
+'application'`, 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"
+}
+```
+
+And that's it. This gem will take care of the rest. The resulting HTML will look like this:
+
+```html
+<!-- ... -->
+<script src="/assets/javascripts/application-03118e77692b637cfc0f55bb27fef087.js" data-turbolinks-track="reload"></script>
+<!-- ... -->
+```
+
+The types supported by this gem are:
+
+* `stylesheet`
+* `javascript`
+* `image`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faucet_pipeline_rails'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install faucet_pipeline_rails
+```
+
+## 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`:
+
+```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 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 staticConfig = {
+  manifest: {
+    file: "public/assets/manifests/static.json",
+    baseURI: (bundlePath, baseName) => `/assets/static/${baseName}`
+  },
+  bundles: [{
+    source: "app/assets/images",
+    target: "public/assets/static"
+  }]
+}
+
+module.exports = {
+  js: jsConfig,
+  sass: sassConfig,
+  static: staticConfig,
+  watchDirs: ["app/assets"]
+};
+```
+
+You can change the path to the manifest fiels that with the following
+configuration:
+
+```ruby
+config.x.faucet_pipeline.manifests_path = File.join("my", "own", "manifests", "path")
+```
+
+The `manifests_path` is relative to your Rails Root.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can
+also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/faucet-pipeline/faucet_pipeline_rails. 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/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+RuboCop::RakeTask.new
+
+task default: [:test]

data/lib/faucet_pipeline_rails/compute_asset_path.rb

@@ -0,0 +1,25 @@
+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

data/lib/faucet_pipeline_rails/manifest.rb

@@ -0,0 +1,36 @@
+module FaucetPipelineRails
+  class Manifest
+    def initialize(manifests_path, type)
+      @manifests_path = manifests_path
+      @type = type
+    end
+
+    def fetch(asset_name)
+      parsed_manifest.fetch(asset_name)
+    rescue KeyError
+      raise "The asset '#{asset_name}' of type '#{@type}' was not in the manifest"
+    end
+
+    private
+
+    def parsed_manifest
+      JSON.parse(unparsed_manifest)
+    rescue JSON::ParserError
+      raise "The manifest file '#{manifest_path}' is invalid JSON"
+    end
+
+    def unparsed_manifest
+      File.read(full_manifest_path)
+    rescue Errno::ENOENT
+      raise "The manifest file '#{manifest_path}' is missing"
+    end
+
+    def full_manifest_path
+      File.join(Rails.root, manifest_path)
+    end
+
+    def manifest_path
+      File.join(@manifests_path, "#{@type}.json")
+    end
+  end
+end

data/lib/faucet_pipeline_rails/railtie.rb

@@ -0,0 +1,9 @@
+require "faucet_pipeline_rails/compute_asset_path"
+
+module FaucetPipelineRails
+  class Railtie < Rails::Railtie
+    ActiveSupport.on_load(:action_view) do
+      include FaucetPipelineRails::ComputeAssetPath
+    end
+  end
+end

data/lib/faucet_pipeline_rails/version.rb

@@ -0,0 +1,3 @@
+module FaucetPipelineRails
+  VERSION = "0.1.0"
+end

data/lib/faucet_pipeline_rails.rb

@@ -0,0 +1,5 @@
+require "faucet_pipeline_rails/version"
+require "faucet_pipeline_rails/railtie"
+
+module FaucetPipelineRails
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: faucet_pipeline_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lucas Dohmen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.10
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.2.1
+description: Instead of using the build-in asset pipeline of Rails, use faucet-pipeline.
+  This gem enables the required integration with Rails.
+email:
+- lucas.dohmen@innoq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+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
+homepage: https://github.com/faucet-pipeline/faucet_pipeline_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Use Rails with faucet-pipeline
+test_files: []