web_components_rails 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4616f8671aeb678bfe6d123e1fd8ac02d855e472
+  data.tar.gz: 81c4c56577ef7b1cf492872597a69ae0384cfa19
+SHA512:
+  metadata.gz: cdec8bfd0dab8414ae902409ac78d13bb4bb0c13265092b11a3f4e5561fbcac97c0fdf2fa5bba46f0f9e908ffbd98c6498e9c5e94f76d904eaf2af13d4ce39f7
+  data.tar.gz: 673f4240b5efb0b23fa829022eb6b71a0893744c65c7f2c9ff81f220b7a7136d0d4839781fa57142e168a24751034ee5c823edffc9ee80a920b26773ba0a793c

data/README.md

@@ -0,0 +1,28 @@
+# web_components_rails
+Ruby gem for using web components in Rails applications.
+
+## Usage
+1. Include the gem in your Gemfile:
+```ruby
+gem 'web_components_rails'
+```
+2. Add an HTML file to your project (can be just HTML or a Polymer component):
+```html
+<!-- app/assets/javascripts/my_component.html -->
+<h1>Hello</h1>
+```
+3. Include a web component in one of your views:
+```erb
+<%= html_import_tag 'my_component' %>
+```
+
+## Building
+
+After adding new features or fixes, please update the version in version.rb, and then tag the repo appropriately:
+
+```
+git tag -a -m 'Added foo' 1.1.0
+git push --tags
+```
+
+To release the gem (internally), use `rake build`, and push the gem with stickler.

data/lib/web_components_rails/asset_tag_helper.rb

@@ -0,0 +1,33 @@
+module WebComponentsRails::AssetTagHelper
+  # Based on stylesheet_link_tag_with_print in Sprockets
+  def html_import_tag(*sources)
+    options = sources.extract_options!.stringify_keys
+    path_options = options.extract!('protocol').symbolize_keys
+    debug_mode = options['debug'] != false && request_debug_assets?
+
+    sources.map do |source|
+      check_errors_for(source, type: :html)
+      # In debug mode, include each html asset separately (if we can find the asset)
+      if debug_mode
+        asset = lookup_asset_for_path(source, type: :html)
+        asset.to_a.map do |a|
+          _html_import_tag(path_to_asset(a.logical_path, path_options.merge(debug: true)))
+        end
+      # In production mode, or when we can't find the asset, fall back to a single tag
+      else
+        _html_import_tag(source, path_options)
+      end
+    end.flatten.uniq.join("\n").html_safe
+  end
+
+
+  private
+
+  def _html_import_tag(source, path_options = {})
+    tag_options = {
+      rel: 'import',
+      href: path_to_asset(source, path_options.merge(extname: '.html', type: :html))
+    }
+    tag(:link, tag_options)
+  end
+end

data/lib/web_components_rails/haml_template.rb

@@ -0,0 +1,6 @@
+class WebComponentsRails::HamlTemplate < Tilt::HamlTemplate
+  def prepare
+    @options = @options.merge(format: :html5)
+    super
+  end
+end

data/lib/web_components_rails/html_import_processor.rb

@@ -0,0 +1,136 @@
+require 'securerandom'
+
+# Processes web component HTML files that contains imports
+# See also:
+#   https://github.com/rails/sprockets/blob/master/UPGRADING.md
+#   https://github.com/rails/sprockets/blob/3.x/lib/sprockets/directive_processor.rb
+class WebComponentsRails::HTMLImportProcessor
+
+  VERSION = '7'
+
+  def self.instance
+    @instance ||= new
+  end
+
+  def self.call(input)
+    instance.call(input)
+  end
+
+  def self.cache_key
+    instance.cache_key
+  end
+
+  attr_reader :cache_key
+
+  def initialize(options = {})
+    @cache_key = [self.class.name, VERSION, options].freeze
+  end
+
+  def call(input)
+    @context = input[:environment].context_class.new(input)
+    @data = input[:data]
+    @filename = input[:filename]
+    @dirname = File.dirname(@filename)
+
+    @data, paths = process_imports(@data, @dirname)
+    paths.each do |path|
+      @context.require_asset(path)
+    end
+
+    @context.metadata.merge(data: @data)
+  end
+
+
+  protected
+
+    def process_imports(html, base_dir)
+      doc = Nokogiri::HTML5.fragment(html)
+
+      # Process HTML and CSS imports
+      dependencies = doc.css('link').map do |link|
+        href = link.attributes['href'].value
+        path = href_to_asset_path(href, base_dir)
+        rel = link.attributes['rel'].value
+        type_attr = link.attributes['type']
+        # The rel determines what type it is by default, but an explicit type will always supercede this
+        if type_attr
+          type = type_attr.value.downcase
+        elsif rel == 'import'
+          type = 'html'
+        elsif rel == 'stylesheet'
+          type = 'css'
+        # Unknown link type; ignore
+        else
+          type = nil
+        end
+
+        case type
+          # HTML needs to be required as an external dependency, with the import removed
+          when 'html', 'text/html'
+            link.remove
+            href_to_asset_path(href, base_dir)
+          # CSS needs to be inlined
+          when 'css', 'text/css'
+            asset = ::Rails.application.assets.find_asset(path, accept: 'text/css')
+            # Replace it inline with a style node containing the referenced CSS
+            style = Nokogiri::XML::Element.new('style', doc)
+            style.inner_html = asset.source
+            link.replace(style)
+            nil
+          # Ignore unknown types
+          else
+            nil
+        end
+      end.compact
+
+      # Script/JS imports should just have their src rewritten to work with sprockets
+      # (because they could repeat a lot, and we can't mark non-HTML files as dependencies)
+      doc.css('script[src]').map do |script|
+        puts "SCRIPT"
+        src = script.attributes['src'].value
+        if src.present?
+          # Some references may try to be relative to the bower_components root,
+          # which is already in the asset pipeline search path; fix those
+          # (eg. from 'web_components/lib-a/foo.html', <script src='../lib-b/bar.js'> -> 'lib-b/bar.js')
+          src = src.sub(/^..\//, '')
+          new_script = Nokogiri::XML::Element.new('script', doc)
+          new_script['src'] = @context.asset_path(src)
+          script.replace(new_script)
+        end
+      end
+
+      # Nokogiri/Nokogumbo are hard-coded to URI-escape certain attributes (src, href, action, and a[name]),
+      # so we have to put in placeholders, and fix the values in the HTML string output afterwards
+      # This doesn't work so well with framework-specific syntax (eg. <foo src="{{bar}}">)
+      placeholder_mapping = {}
+      %w(src href action).each do |name|
+        doc.css("[#{name}]").each do |node|
+          # The placeholders are just random strings
+          placeholder = SecureRandom.hex(40)
+          attr = node.attributes[name]
+          placeholder_mapping[placeholder] = attr.value
+          attr.value = placeholder
+        end
+      end
+      new_html = doc.to_html
+      placeholder_mapping.each do |placeholder, value|
+        new_html.sub!(placeholder, value)
+      end
+
+      [new_html, dependencies]
+    end
+
+    def href_to_asset_path(href, base_dir)
+      abs_path = File.expand_path(File.join(base_dir, href))
+      # If it is relative to the current dir, we should be able to find it easily
+      if File.exist?(abs_path)
+        abs_path
+      # Otherwise, just return it as a relative path, and hope sprockets can find it in an asset dir
+      else
+        # Sometimes we prefix with /assets/ to make the HTML work in the browser without asset-pipeline.
+        # We don't need this when using require with sprockets.
+        href.sub(%r{^/assets/}, '')
+      end
+    end
+
+end

data/lib/web_components_rails/railtie.rb

@@ -0,0 +1,25 @@
+require 'haml'
+class WebComponentsRails::Railtie < Rails::Railtie
+  # Register our asset tag helpers
+  initializer 'web_components.asset_tag_helper' do
+    ActionView::Base.module_eval do
+      include WebComponentsRails::AssetTagHelper
+    end
+    # Certain run modes in Rails (like rails g migration), won't have assets loaded
+    if Rails.application.assets.present?
+      Rails.application.assets.context_class.class_eval do
+        include WebComponentsRails::AssetTagHelper
+      end
+    end
+  end
+
+  # Allows HAML templates to be used with asset pipeline
+  initializer 'web_components.sprockets', after: 'sprockets.environment', group: :all do |app|
+    app.assets.register_mime_type 'text/html', extensions: ['.html', '.haml']
+    app.assets.register_preprocessor 'text/html', Sprockets::DirectiveProcessor
+    app.assets.register_preprocessor 'text/html', WebComponentsRails::HTMLImportProcessor
+    app.assets.register_engine '.haml', WebComponentsRails::HamlTemplate
+    app.assets.register_bundle_processor 'text/html', ::Sprockets::Bundle
+  end
+end
+

data/lib/web_components_rails/version.rb

@@ -0,0 +1,3 @@
+module WebComponentsRails
+  VERSION = '1.1.0'
+end

data/lib/web_components_rails.rb

@@ -0,0 +1,10 @@
+require 'nokogumbo'
+
+module WebComponentsRails
+end
+
+require 'web_components_rails/asset_tag_helper'
+require 'web_components_rails/haml_template'
+require 'web_components_rails/html_import_processor'
+require 'web_components_rails/railtie'
+require 'web_components_rails/version'

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: web_components_rails
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Jon Botelho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogumbo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Web components utils for rails
+email:
+- jon@jbotelho.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/web_components_rails.rb
+- lib/web_components_rails/asset_tag_helper.rb
+- lib/web_components_rails/haml_template.rb
+- lib/web_components_rails/html_import_processor.rb
+- lib/web_components_rails/railtie.rb
+- lib/web_components_rails/version.rb
+homepage: 
+licenses: []
+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: Web components utils for rails
+test_files: []