rails_external_asset_pipeline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 316fb38e35719f17288367d71ef42998d7672f25
+  data.tar.gz: 2562d4d3ef5d073463d87ccb6060ce79c3c03c14
+SHA512:
+  metadata.gz: 77601b11f160da63a9af5b4d5f29d81666a787bc74616486bd8d00d2a53fbbda33047d38f55dafce6838b0488b9de632d22cc1c03ada291b80b037938157a401
+  data.tar.gz: c01ebd79a52326fa588f20073a9e2407797d3d6a28aa6be20cac91f803c32e0456e679a2f098748f8b1089309f3ae0529a58e2610d905f38f2a726f2273e6eb2

data/README.md

@@ -0,0 +1,65 @@
+# Use Rails with an external asset pipeline [![Build Status](https://travis-ci.org/fejo-dk/rails_external_asset_pipeline.svg)](https://travis-ci.org/fejo-dk/rails_external_asset_pipeline)
+
+Instead of using the built-in asset pipeline of Rails, some people want to use external asset pipelines – written in Node.js for example. This gem enables the required integration with Rails.
+
+Why is an integration like that required? If your external asset pipeline modifies the names of the generated files depending on their content (for example 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 your external asset 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, your pipeline needs to generate manifest files for each type of asset. In this case, it needs to generate a file called `javascript.json` in `public/assets/manifests`. 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`
+* `font`
+
+You can find an example of using this gem in Rails 5 with an external Node.js pipeline [here](https://github.com/moonglum/rails-5-and-node-asset-pipeline).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_external_asset_pipeline'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install rails_external_asset_pipeline
+```
+
+## 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/fejo-dk/rails_external_asset_pipeline. 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/rails_external_asset_pipeline.rb

@@ -0,0 +1,5 @@
+require "rails_external_asset_pipeline/version"
+require "rails_external_asset_pipeline/railtie"
+
+module RailsExternalAssetPipeline
+end

data/lib/rails_external_asset_pipeline/compute_asset_path.rb

@@ -0,0 +1,16 @@
+require "rails_external_asset_pipeline/manifest"
+
+module RailsExternalAssetPipeline
+  module ComputeAssetPath
+    TYPES_WITH_MANIFEST = %i(stylesheet image javascript)
+
+    def compute_asset_path(source, options = {})
+      if TYPES_WITH_MANIFEST.include? options[:type]
+        manifest = Manifest.new(options[:type])
+        manifest.fetch(source)
+      else
+        source
+      end
+    end
+  end
+end

data/lib/rails_external_asset_pipeline/manifest.rb

@@ -0,0 +1,35 @@
+module RailsExternalAssetPipeline
+  class Manifest
+    def initialize(type)
+      @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 '#{asset_path}' is invalid JSON"
+    end
+
+    def unparsed_manifest
+      File.read(full_asset_path)
+    rescue Errno::ENOENT
+      raise "The manifest file '#{asset_path}' is missing"
+    end
+
+    def full_asset_path
+      File.join(Rails.root, asset_path)
+    end
+
+    def asset_path
+      File.join("public", "assets", "manifests", "#{@type}.json")
+    end
+  end
+end

data/lib/rails_external_asset_pipeline/railtie.rb

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

data/lib/rails_external_asset_pipeline/version.rb

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

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: rails_external_asset_pipeline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lucas Dohmen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.41.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.41.2
+description: Instead of using the build-inn asset pipeline of Rails, some people want
+  to use external asset pipelines – written in Node.js for example. This gem enables
+  the required integration with Rails.
+email:
+- lucas.dohmen@innoq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/rails_external_asset_pipeline.rb
+- lib/rails_external_asset_pipeline/compute_asset_path.rb
+- lib/rails_external_asset_pipeline/manifest.rb
+- lib/rails_external_asset_pipeline/railtie.rb
+- lib/rails_external_asset_pipeline/version.rb
+homepage: https://github.com/fejo-dk/rails_external_asset_pipeline
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Use Rails with an external asset pipeline
+test_files: []