rails_external_assets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a43f383d3275686a5dcc74f3624e73952e734ed3
+  data.tar.gz: bcc8fc89a901f04ed38afecac5a59e587a8b7a04
+SHA512:
+  metadata.gz: 43eac0d5fd15c6f9fba4e279f5f872da391c4a5dadf35b5091564e84e5a6cda7ac980b307a1c2d3eb1609431bb301fae286c0c1f435e7d1e571f4f2f14efde8e
+  data.tar.gz: 0689163f8c108e16c507ac21d85a932b16fd26bf8f748739ae88c3b1264c5866c95f8b10cea1b3964906a1552af0e6ac715240b96d9a4dcecf01de89d50b10df

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jonathan.lehman91@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_external_assets.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jonathan Lehman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,146 @@
+[![Gem Version](https://badge.fury.io/rb/rails_external_assets.png)](http://badge.fury.io/rb/rails_external_assets)
+[![Build Status](https://secure.travis-ci.org/jdlehman/rails_external_assets.svg?branch=master)](http://travis-ci.org/jdlehman/rails_external_assets)
+
+# 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:
+
+```json
+{
+  "js/module.js": "builds/js/module-12312abc.js",
+  "js/react-component.jsx": "builds/components/react-component-ab123x.js",
+  "css/styling.sass": "builds/styles/styling-129xha.css"
+}
+```
+
+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.
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_external_assets'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_external_assets
+
+## Usage
+
+## With Rails
+
+You can include your external assets in Rails with the provided view helpers or Sprockets directives.
+
+### View Helpers
+
+#### JavaScript
+
+You can include a JavaScript file with `external_asset_js`. Note that the name of the file MUST include the file extension and the file name is the key in the asset manifest JSON file.
+
+```erb
+<%= external_asset_js 'myFile.js' %>
+```
+
+#### CSS
+
+You can include a CSS file with `external_asset_css`. Note that the name of the file MUST include the file extension and the file name is the key in the asset manifest JSON file.
+
+```erb
+<%= external_asset_css 'myFile.sass' %>
+```
+
+#### Image
+
+You can include a Image file with `external_asset_img`. Note that the name of the file MUST include the file extension and the file name is the key in the asset manifest JSON file.
+
+```erb
+<%= external_asset_img 'myFile.jpg' %>
+```
+
+### Sprockets Directives
+
+By default, you can use the `external_require` directive in JavaScript and CSS manifest files, but you can add more (Sass, SCSS, CoffeeScript, etc) by setting the configuration (check out the configuration docks for `sprockets_directives`).
+
+In any file type you configure the Sprockets directive to be available in you, can use the `external_require` directive to include an external asset in the Sprockets manifest. Note that you MUST specify the file extension when using `external_require`.
+
+An example `application.js` Sprockets manifest file:
+
+```js
+//= require normalAsset
+//= require more/anotherAsset.js
+//= external_require externals/firstAsset.js
+//= external_require externals/anotherAsset.js
+```
+
+This will include the first two JS assets, `normalAsset` and `anotherAsset` from Rails' asset pipeline, and the last two JS assets, `firstAsset` and `anotherAsset` from your external assets. The external assets are resolved by looking up these files in the asset manifest JSON file provided.
+
+## With Plain Ruby
+
+RailsExternalAssets::AssetFinder provides two methods for your disposal.
+
+`asset_path` takes a path to an external asset file, and returns the corresponding built asset path by looking up the key in the asset manifest JSON file.
+
+`exeternal_asset` takes a path and returns the built asset path (the result of `asset_path`) and joins it with the base path. If a block is provided, the external asset path is passed to the block and the resulting value is returned.
+
+## Configuration
+
+Configuration settings can be modified within the `RailsExternalAssets.configure` block. Or set directly off of `RailsExternalAssets.config`
+
+```ruby
+RailsExternalAssets.configure do |config|
+  config.base_path = '/assets/'
+  config.manifest_file = 'public/assets/asset-manifest.json'
+end
+
+RailsExternalAssets.config.base_path = '/webpack-assets/'
+```
+
+### Options
+
+**base_path**
+
+This is the file location off of Rails' `public/` folder that the external assets are built to.
+
+> Defaults to `/external-assets/`
+
+**manifest_file**
+
+This is the file location of the asset manifest JSON file. The keys are the file paths pre-build, and the values are the file paths post-build.
+
+> Defaults to `public/external-assets/manfest.json`
+
+**sprockets_directives**
+
+This is an array to configure the use of the `external_assets` Sprockets directive that is provided by RailsExternalAssets. Each item is a hash with keys for `mime_type` and the `comments` supported by the directive. Check out the [Sprockets documentation](https://github.com/rails/sprockets/blob/master/guides/extending_sprockets.md#adding-directives-to-your-extension) for more information.
+
+> Defaults to:
+```ruby
+[
+  { mime_type: 'application/javascript', comments: ['//', ['/*', '*/']] },
+  { mime_type: 'application/css', comments: ['//', ['/*', '*/']] }
+]
+```
+
+## 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.
+
+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/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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_external_assets"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rails_external_assets/asset_finder.rb

@@ -0,0 +1,30 @@
+require 'json'
+
+module RailsExternalAssets
+  module AssetFinder
+    def external_asset(path)
+      external_path = File.join(RailsExternalAssets.config.base_path, asset_path(path))
+      block_given? ? yield(external_path) : external_path
+    end
+
+    def asset_path(path)
+      manifest_file = RailsExternalAssets.config.manifest_file
+      throw_invalid_manifest(manifest_file) unless File.file? manifest_file
+      asset_manifest = JSON.parse(File.read manifest_file)
+      new_path = asset_manifest[path]
+      throw_unknown_path(path, manifest_file) unless new_path
+      new_path
+    end
+
+
+    private
+
+    def throw_unknown_path(path, manifest_file)
+        raise Errors::UnknownAssetManifestKey.new("No corresponding file found for \"#{path}\" in \"#{manifest_file}\".")
+    end
+
+    def throw_invalid_manifest(manifest_file)
+        raise Errors::InvalidManifestFile.new("Manifest file, \"#{manifest_file}\", was not found.")
+    end
+  end
+end

data/lib/rails_external_assets/configuration.rb

@@ -0,0 +1,33 @@
+module RailsExternalAssets
+  class << self
+    attr_accessor :config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.reset
+    @config = Configuration.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+
+  class Configuration
+    attr_accessor :base_path,
+                  :manifest_file,
+                  :sprockets_directives
+
+    def initialize
+      # base path should be off Rails public/
+      @base_path = '/external-assets/'
+      @manifest_file = 'public/external-assets/manifest.json'
+      @sprockets_directives = [
+        { mime_type: 'application/javascript', comments: ['//', ['/*', '*/']] },
+        { mime_type: 'application/css', comments: ['//', ['/*', '*/']] }
+      ]
+    end
+  end
+end

data/lib/rails_external_assets/errors.rb

@@ -0,0 +1,12 @@
+module RailsExternalAssets
+  class Error < StandardError
+  end
+
+  module Errors
+    # Will be thrown when file key does not exist in asset manifest
+    class UnknownAssetManifestKey < RailsExternalAssets::Error; end
+
+    # will be thrown when manifest file is not found
+    class InvalidManifestFile < RailsExternalAssets::Error; end
+  end
+end

data/lib/rails_external_assets/rails/railtie.rb

@@ -0,0 +1,22 @@
+module RailsExternalAssets
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer 'rails_external_assets.initialize' do |app|
+        ActionView::Base.send :include, ViewHelpers
+
+        if app.config.respond_to?(:assets)
+          app.config.assets.configure do |env|
+            env.prepend_path(File.join('public', RailsExternalAssets.config.base_path))
+            RailsExternalAssets.config.sprockets_directives.each do |directive|
+              env.register_preprocessor directive[:mime_type], RailsExternalAssets::Sprockets::DirectiveProcessor.new(comments: directive[:comments])
+            end
+          end
+        else
+          RailsExternalAssets.config.sprockets_directives.each do |directive|
+            app.assets.register_preprocessor directive[:mime_type], RailsExternalAssets::Sprockets::DirectiveProcessor.new(comments: directive[:comments])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_external_assets/rails/view_helpers.rb

@@ -0,0 +1,19 @@
+module RailsExternalAssets
+  module Rails
+    module ViewHelpers
+      include RailsExternalAssets::AssetFinder
+
+      def external_asset_js(path)
+        external_asset(path) { |p| javascript_include_tag p }
+      end
+
+      def external_asset_css(path)
+        external_asset(path) { |p| stylesheet_link_tag p }
+      end
+
+      def external_asset_img(path)
+        external_asset(path) { |p| image_tag p }
+      end
+    end
+  end
+end

data/lib/rails_external_assets/rails.rb

@@ -0,0 +1,7 @@
+require 'rails_external_assets/rails/view_helpers'
+require 'rails_external_assets/rails/railtie'
+
+module RailsExternalAssets
+  module Rails
+  end
+end

data/lib/rails_external_assets/sprockets/directive_processor.rb

@@ -0,0 +1,12 @@
+module RailsExternalAssets
+  module Sprockets
+    class DirectiveProcessor < ::Sprockets::DirectiveProcessor
+      include RailsExternalAssets::AssetFinder
+
+       def process_external_require_directive(path)
+         new_path = asset_path(path)
+         process_require_directive new_path
+       end
+    end
+  end
+end

data/lib/rails_external_assets/sprockets.rb

@@ -0,0 +1,6 @@
+require 'rails_external_assets/sprockets/directive_processor'
+
+module RailsExternalAssets
+  module Sprockets
+  end
+end

data/lib/rails_external_assets/version.rb

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

data/lib/rails_external_assets.rb

@@ -0,0 +1,10 @@
+require "rails_external_assets/version"
+require 'rails_external_assets/errors'
+require 'rails_external_assets/configuration'
+require 'rails_external_assets/asset_finder'
+
+module RailsExternalAssets
+end
+
+require 'rails_external_assets/sprockets' if defined?(Sprockets)
+require 'rails_external_assets/rails' if defined?(Rails)

data/rails_external_assets.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_external_assets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_external_assets"
+  spec.version       = RailsExternalAssets::VERSION
+  spec.authors       = ["Jonathan Lehman"]
+  spec.email         = ["jonathan.lehman91@gmail.com"]
+
+  spec.summary       = %q{Use external assets, those built outside of Sprockets' asset pipeline, in Rails. This allows you to build frontend assets using any build tools, but still provide these assets to a Rails application.}
+  spec.description   = %q{Use external assets, frontend assets built with another build tool outside of Sprockets' asset pipeline, in Rails.}
+  spec.homepage      = "http://github.com/jdlehman/rails_external_assets"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: rails_external_assets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Lehman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Use external assets, frontend assets built with another build tool outside
+  of Sprockets' asset pipeline, in Rails.
+email:
+- jonathan.lehman91@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_external_assets.rb
+- lib/rails_external_assets/asset_finder.rb
+- lib/rails_external_assets/configuration.rb
+- lib/rails_external_assets/errors.rb
+- lib/rails_external_assets/rails.rb
+- lib/rails_external_assets/rails/railtie.rb
+- 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/version.rb
+- rails_external_assets.gemspec
+homepage: http://github.com/jdlehman/rails_external_assets
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Use external assets, those built outside of Sprockets' asset pipeline, in
+  Rails. This allows you to build frontend assets using any build tools, but still
+  provide these assets to a Rails application.
+test_files: []