middleman-web_components 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a58d83f4fb037c74fb3079d7fac1761d249673bd
+  data.tar.gz: f62e7acb2a74218738c95eec2409036132eeaf09
+SHA512:
+  metadata.gz: 018412b8ac647b0ecbb575ee6704a95e33b73a268c3a2439c271aa4fef0520ab2ffb748b54bd63aae13411f5c8038e7bbb58fb43f583a28948be1ed4e3e5d647
+  data.tar.gz: 4a51bcdeb91139523a9e58cfd43dcd244131c61e5aadab5451e937b6909d6a8adf4552e869e73189d0bfa30fe063df009e746646e6e212c197545f7d1cd9fd05

data/.gitignore

@@ -0,0 +1,5 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg

data/COPYING.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Gemfile

@@ -0,0 +1,18 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-web_components.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/README.markdown

@@ -0,0 +1,61 @@
+Middleman Web Components
+========================
+
+Middleman extension which provides a helper and executes vulcanize for Web Components.
+
+Usage
+-----
+
+This extension does two things: providing a helper to generate link to Web Components HTML files and vulcanizing Web Components HTML files on build.
+
+### `component_import_tag` helper ###
+
+    <%= component_import_tag :elements %>
+
+is expanded to
+
+    <link href="components/elements.vulcanized.html" rel="import" />
+
+Directory for Web Components(`components` here) is specified by `directory` option and suffix(`.vulcanized.html` here) is specified by `suffix` option as described later.
+
+### Vulcanize ###
+
+In build process, Middleman Web Components searches HTML files under the Web Components directory and vulcanize(inline external component HTMLs) them.
+
+To vulcanize, the command specified by `command` option is used.
+
+If you're not familiar with vulcanize, see [NPM module page][vulcanize] at first.
+
+Installation
+------------
+
+Add
+
+    gem 'middleman-web_components'
+
+to your `Gemfile` and run `bundle install`.
+
+Requirements
+------------
+
+* `vulcanize` command, provided by [vulcanize][] NPM module
+
+Configuration
+-------------
+
+    activate :web_components
+
+### Options ###
+
+    activate :web_components do |web_components|
+      web_components.suffix    = '.vulcanized.html' # Suffix appended to vulcanized files
+      web_components.directory = 'components'       # Directory for web components
+      web_components.command   = 'vulcanize'        # vulcanize command such as vulcanize, /usr/local/bin/valucanize or $(npm bin)/vulcanize
+    end
+
+License
+-------
+
+LGPL. See {file:COPYING.txt} for details.
+
+[vulcanize]: https://www.npmjs.com/package/vulcanize

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = "--color --tags ~@wip --strict"
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-web_components')

data/lib/middleman-web_components.rb

@@ -0,0 +1,33 @@
+require 'middleman-core'
+
+class Middleman::WebComponents < ::Middleman::Extension
+  option :suffix, '.vulcanized.html', 'Suffix appended to vulcanized files'
+  option :directory, 'components', 'Directory for web components'
+  option :command, 'vulcanize', 'vulcanize command such as vulcanize, /usr/local/bin/valucanize or $(npm bin)/vulcanize'
+
+  def manipulate_resource_list(resources)
+    resources.collect do |resource|
+      next resource if resource.ignored?
+      next resource unless resource.path.start_with? options.directory
+      content = `#{options.command} #{resource.source_file}`
+      resource = Middleman::Sitemap::StringResource.new(app.sitemap, resource.path, content)
+      resource.destination_path = Pathname(resource.path).sub_ext(options.suffix).to_path unless resource.ext == options.suffix
+      resource
+    end
+  end
+
+  helpers do
+    def component_import_tag(*sources)
+      extension = app.extensions.each.find {|(name, instance)| name == :web_components}[1]
+      options = {
+        rel: 'import'
+      }.update(sources.extract_options!.symbolize_keys)
+      sources.flatten.inject(ActiveSupport::SafeBuffer.new) do |all, source|
+        url = url_for(File.join(extension.options.directory, "#{source}.html"), relative: true)
+        all << tag(:link, {href: url}.update(options))
+      end
+    end
+  end
+end
+
+::Middleman::Extensions.register(:web_components, ::Middleman::WebComponents)

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-web_components'

data/middleman-web_components.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-web_components"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.license     = "LGPL"
+  s.authors     = ["KITAITI Makoto"]
+  s.email       = ["KitaitiMakoto@gmail.com"]
+  s.homepage    = "http://www.rubydoc.info/gems/middleman-web_components"
+  s.summary     = %q{Middleman extension for Web Components}
+  s.description = %q{Middleman extension which provides a helper and execute vulcanize for Web Components}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency("middleman-core", [">= 4.0.0"])
+  
+  # Additional dependencies
+  # s.add_runtime_dependency("gem-name", "gem-version")
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: middleman-web_components
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- KITAITI Makoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  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
+description: Middleman extension which provides a helper and execute vulcanize for
+  Web Components
+email:
+- KitaitiMakoto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- COPYING.txt
+- Gemfile
+- README.markdown
+- Rakefile
+- features/support/env.rb
+- lib/middleman-web_components.rb
+- lib/middleman_extension.rb
+- middleman-web_components.gemspec
+homepage: http://www.rubydoc.info/gems/middleman-web_components
+licenses:
+- LGPL
+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: Middleman extension for Web Components
+test_files: []
+has_rdoc: