silian-rail 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c111b502a1503228a57b19b429945ee20094d057
+  data.tar.gz: f3306d95bc03b98ad44b21d18bb87d0984ef62fc
+SHA512:
+  metadata.gz: d1c1f820f779d2ed91910bd66bc1cf18b02b0009a306f49aed74bae3876ddf316e6754d36287f593ae1e5bddad8ac2c8c0d26d26bf0648a4ba11863c5c646a83
+  data.tar.gz: 9af698941183a93b38738ef9a108e93b53844bf5e8899728e140dd7b6fc2a488a7287d6f6a4a4ee44e8852a81e0f56bb1dfe54fb0c81452409c89bf2a16fffb0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Brandon Robins
+
+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,41 @@
+# SilianRail
+
+SilianRail extends [Sprockets](https://github.com/rails/sprockets) to allow you to import [Web Components](http://webcomponents.org/) into the [Rails Asset Pipeline](http://guides.rubyonrails.org/asset_pipeline.html).
+
+## Installation
+
+Add the following line to your Rails application's Gemfile:
+
+    gem 'silian-rail'
+
+Run the bundle command:
+
+    $ bundle
+
+And generate a manifest file by running:
+
+    $ rails generate silian_rail:install
+
+The generator will create a components folder and manifest file at `app/assets/components/application.html`.
+
+Finally, insert the following tag into your application layout:
+
+    <%= html_include_tag 'application' %>
+
+## Usage
+
+Use the Sprockets [`require`](https://github.com/rails/sprockets#the-require-directive) Directive within the components manifest file to pull in a web component and its dependencies.
+
+When referencing a web component (i.e. the Polymer [paper-card](https://elements.polymer-project.org/elements/paper-card) component) you must reference the actual HTML file like so:
+
+      *= require paper-card/paper-card
+
+The require directive will search your assets paths (`app/assets`, `lib/assets`, and `vendor/assets` by default) for the directory and file. Once the directory/file is found, the component, along with any dependencies defined within, is pulled into the asset pipeline.
+
+## Contributing
+
+1. Fork it ( http://github.com/eanlain/silian-rail/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/generators/silian_rail/install_generator.rb

@@ -0,0 +1,13 @@
+module SilianRail
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc 'Copies a HTML manifest to app/assets/components/application.html'
+
+      def copy_component_manifest
+        copy_file 'component_manifest.html', 'app/assets/components/application.html'
+      end
+    end
+  end
+end

data/lib/generators/silian_rail/templates/component_manifest.html

@@ -0,0 +1,11 @@
+<!--
+ * This is a manifest file that'll be compiled into application.html, which will include all the files
+ * listed below and their dependencies.
+ *
+ * Any html files within this directory, lib/assets/*, or vendor/assets/*
+ * can be referenced here using a relative path.
+ *
+ * require web_component_directory/web_component_name
+ *
+ *
+-->

data/lib/silian-rail.rb

@@ -0,0 +1,3 @@
+require 'silian-rail/asset_helpers'
+require 'silian-rail/railtie'
+require 'silian-rail/version'

data/lib/silian-rail/asset_helpers.rb

@@ -0,0 +1,54 @@
+module ActionView
+  module Helpers
+    module AssetTagHelper
+      def html_include_tag(*sources)
+        options = sources.extract_options!.stringify_keys
+        integrity = compute_integrity?(options)
+
+        if options['debug'] != false && request_debug_assets?
+          sources.map { |source|
+            if asset = lookup_debug_asset(source, type: :html)
+              if asset.respond_to?(:to_a)
+                asset.to_a.map do |a|
+                  construct_html_include_tag(path_to_html(a.logical_path, debug: true), options)
+                end
+              else
+                construct_html_include_tag(path_to_html(asset.logical_path, debug: true), options)
+              end
+            else
+              construct_html_include_tag(source, options)
+            end
+          }.flatten.uniq.join("\n").html_safe
+        else
+          sources.map { |source|
+            options = options.merge('integrity' => asset_integrity(source, type: :html)) if integrity
+            construct_html_include_tag source, options
+          }.join('\n').html_safe
+        end
+      end
+
+      def construct_html_include_tag(*sources)
+        options = sources.extract_options!.stringify_keys
+        path_options = options.extract!('protocol', 'extname', 'host').symbolize_keys
+        sources.uniq.map { |source|
+          tag_options = {
+            'rel' => 'import',
+            'href' => path_to_html(source, path_options)
+          }.merge!(options)
+          tag(:link, tag_options)
+        }.join("\n").html_safe
+      end
+    end
+
+    module AssetUrlHelper
+      ASSET_EXTENSIONS.merge!({ html: '.html' })
+      ASSET_PUBLIC_DIRECTORIES.merge!({ html: '/components' })
+
+      # Computes the path to a HTML asset in the public components directory.
+      def html_path(source, options = {})
+        path_to_asset(source, {type: :html}.merge!(options))
+      end
+      alias_method :path_to_html, :html_path # aliased to avoid conflicts with a html_path named route
+    end
+  end
+end

data/lib/silian-rail/post_processor.rb

@@ -0,0 +1,40 @@
+module SilianRail
+  class PostProcessor
+    COMMENT_PATTERN = Regexp.new("<!---->|<!--[^\\[].*?-->", Regexp::MULTILINE | Regexp::IGNORECASE)
+
+    def initialize(context)
+      @context = context
+      @current_directory = File.dirname(context.pathname)
+      @import_assets = []
+
+      @remove_link_imports = Loofah::Scrubber.new do |node|
+        if (node.name == 'link') && (node['rel'] == 'import')
+          @import_assets.push get_asset_abs_path(node['href'])
+
+          node.remove
+        end
+      end
+    end
+
+    def call(data)
+      data = scrub_link_imports(data)
+      require_import_assets
+
+      data.to_s.gsub(COMMENT_PATTERN, '')
+    end
+
+    private
+
+    def get_asset_abs_path(relative_path)
+      File.absolute_path(relative_path, @current_directory)
+    end
+
+    def require_import_assets
+      @import_assets.each { |asset| @context.require_asset(asset) }
+    end
+
+    def scrub_link_imports(data)
+      Loofah.scrub_fragment(data, @remove_link_imports)
+    end
+  end
+end

data/lib/silian-rail/railtie.rb

@@ -0,0 +1,21 @@
+module SilianRail
+  class Railtie < ::Rails::Railtie
+
+    config.assets.configure do |env|
+      require 'sprockets/directive_processor'
+      env.register_preprocessor 'text/html', Sprockets::DirectiveProcessor.new(
+        comments: [['<!--', '-->']]
+      )
+
+      require 'silian-rail/post_processor'
+      env.register_postprocessor 'text/html', :web_components do |context, data|
+        SilianRail::PostProcessor.new(context).call(data)
+      end
+
+      require 'sprockets/bundle'
+      env.register_bundle_processor 'text/html', Sprockets::Bundle
+
+      env.logger = Rails.logger
+    end
+  end
+end

data/lib/silian-rail/version.rb

@@ -0,0 +1,3 @@
+module SilianRail
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: silian-rail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brandon Robins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-24 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: loofah
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email: brandon.robins@onebnottwo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/generators/silian_rail/install_generator.rb
+- lib/generators/silian_rail/templates/component_manifest.html
+- lib/silian-rail.rb
+- lib/silian-rail/asset_helpers.rb
+- lib/silian-rail/post_processor.rb
+- lib/silian-rail/railtie.rb
+- lib/silian-rail/version.rb
+homepage: http://www.github.com/eanlain/silian-rail
+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 Web Components with the Rails Asset Pipeline
+test_files: []