jekyll-spark 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d60f94810b528cfb81018431cd3941ed98b1b51
+  data.tar.gz: 9de4a7a1445a75c3d2a0285ec8152fbf00f89447
+SHA512:
+  metadata.gz: 8f7902691f69dc4ef7e5ad0f67d6b78cf9a49bec8c367060869ced4d5e1ffd1f89f54b8f254fc86b910c947deb43c6558b69114270f878ae395dda2ea4c615ed
+  data.tar.gz: 0fa592bcae5d14df58eb2c35df856c8b214fafdfedf9aaef2d277d1bacd7f116b0626b4d9e00bc75e244853b1bed3e66d80febf599d88f4257d0d777fd278aae

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.7
+
+install:
+  - bundle install
+
+script:
+  - bundle exec rake test

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Help Scout
+
+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,40 @@
+# Spark ✨ [![Build Status](https://travis-ci.org/helpscout/jekyll-spark.svg?branch=master)](https://travis-ci.org/helpscout/jekyll-spark) [![Gem Version](https://badge.fury.io/rb/jekyll-spark.svg)](https://badge.fury.io/rb/jekyll-spark)
+
+A Jekyll library for building fast component-based UI.
+
+This library was heavily inspired by view/component creation from modern Javascript libraries like [React](https://facebook.github.io/react/) and [Vue](https://vuejs.org/).
+
+**Table of Contents**
+
+- [Install](#install)
+- [Documentation](#documenation)
+- [Examples](#examples)
+
+## Install
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-spark'
+```
+
+And then execute:
+```
+bundle
+```
+
+Or install it yourself as:
+```
+gem install jekyll-spark
+```
+
+
+
+## Documentation
+
+**[View the docs](https://github.com/helpscout/jekyll-spark/blob/master/docs/introduction.md)** to get started with Jekyll Components!
+
+
+## Examples
+
+**[View the starter](https://github.com/helpscout/jekyll-spark/tree/master/examples)** Component view files.

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rubygems'
+require 'rake'
+require 'rdoc'
+require 'date'
+require 'yaml'
+require 'rake/testtask'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
+require 'jekyll/version'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/docs/creating-a-component.md

@@ -0,0 +1,164 @@
+# Creating a component
+
+Let's create our first component under `_plugins/tags`.
+
+We'll call it `napolean.rb`! Below is the [starting template](https://github.com/helpscout/jekyll-spark/tree/master/examples) of any Jekyll Component:
+
+```ruby
+require "jekyll-spark"
+
+module Jekyll
+  # Create your component class
+  class NapoleanComponent < ComponentTag
+    def template(context)
+      render = %Q[
+        # Put markup here!
+      ]
+    end
+  end
+end
+
+# Register your component with Liquid
+Liquid::Template.register_tag(
+  "Napolean", # Namespace your component
+  Jekyll::NapoleanComponent, # Pass your newly created component class
+)
+```
+
+### Rendering markup
+
+Let's make this component render this GIF:
+
+![Happy hands](https://media.giphy.com/media/9QbDWTcnq4wmc/giphy.gif)
+
+
+```ruby
+require "jekyll-spark"
+
+module Jekyll
+  class NapoleanComponent < ComponentTag
+    def template(context)
+      render = %Q[
+        <div class="napolean">
+          <img src="https://media.giphy.com/media/9QbDWTcnq4wmc/giphy.gif">
+        </div>
+      ]
+    end
+  end
+end
+
+Liquid::Template.register_tag(
+  "Napolean",
+  Jekyll::NapoleanComponent,
+)
+```
+
+To use our tag component, all we have to do is use `{% Napolean %}` in our Jekyll `.html` or `.md` file:
+
+```html
+Check out this component!
+{% Napolean %}
+```
+
+That's it!
+
+
+### Adding props
+
+"Props" are data that we can pass to our component.
+
+For our example, let's provide the ability to adjust the width of our image as well as provide a caption:
+
+```html
+{% Napolean
+  width: "300"
+  caption: "Way to eat all the friggen chips Kip!"
+%}
+```
+
+You can totally write everything in a single line (below). However, we recommend the above approach as it makes it much easier to add/remove/edit props.
+
+```html
+{% Napolean width: "300" caption: "Way to eat all the friggen chips Kip!" %}
+```
+
+In order to use our new `width` and `caption` props, we have to update our `template` method in our Napolean component. Prop data being passed to our component will be available in a `@prop` instance variable in our `.rb` file:
+
+```ruby
+require "jekyll-spark"
+
+module Jekyll
+  class NapoleanComponent < ComponentTag
+    def template(context)
+      # Declare props as variables
+      # Not necessary, but highly recommended
+      caption = @props["caption"]
+      width = @props["width"]
+
+      render = %Q[
+        <div class="napolean">
+          <img src="https://media.giphy.com/media/9QbDWTcnq4wmc/giphy.gif" width="#{width}">
+          #{caption}
+        </div>
+      ]
+    end
+  end
+end
+
+Liquid::Template.register_tag(
+  "Napolean",
+  Jekyll::NapoleanComponent,
+)
+```
+
+The resulting compiled markup will be:
+
+```html
+<div class="napolean">
+  <img src="https://media.giphy.com/media/9QbDWTcnq4wmc/giphy.gif" width="300">
+  Way to eat all the friggen chips Kip!
+</div>
+```
+
+
+### Syntax
+
+Below is a comparison between some syntax differences between Jekyll Components (Ruby) and React (ES6 Javascript):
+
+| Ruby | Javascript (React) | Description |
+| --- | --- | --- |
+| `@props["key"]` | `this.props.key` | Component prop data. |
+| `render =` | `render() { return ... } ` | Outputting the component's markup. |
+| `%Q[ ... ]` | `` `...` `` | String interpolation wrapper. |
+| `#{var}` | `${var} ` | String interpolated variable. |
+
+
+
+## Creating a block component
+
+Let's say we want to update our component to be a block instead. It'll make it more intuitive to add caption. Maybe something like:
+
+```html
+{% Napolean width: "300" %}
+  This tastes like the cow got into an onion patch.
+{% endNapolean %}
+```
+
+It's pretty easy! The only thing we need to change in our `napolean.rb` file is the Class our component inherits from.
+
+Before:
+```ruby
+class NapoleanComponent < ComponentTag
+```
+
+After:
+```ruby
+class NapoleanComponent < ComponentBlock
+```
+
+
+### That's it!
+
+You've got the basics to create some awesome components in Jekyll.
+
+![Yesssssssssssssssss](https://media.giphy.com/media/uTuLngvL9p0Xe/giphy.gif)

data/docs/introduction.md

@@ -0,0 +1,45 @@
+# Introduction
+
+Components are `.rb` files that are added to your Jekyll project's default `_plugins/` directory:
+
+```shell
+my-jekyll/
+└── _plugins/
+    └── *Add components here*
+```
+
+There are two types are Components:
+
+**Tags**
+
+These components are created using Liquid [Tags](http://www.rubydoc.info/github/Shopify/liquid/Liquid/Tag), and they do not contain content when used.
+
+Example:
+```html
+{% Napolean id: "skillz" class: "nunchucks bow staff computer-hacking" %}
+```
+
+**Blocks**
+
+These components are created using Liquid [Blocks](http://www.rubydoc.info/github/Shopify/liquid/Liquid/Block), and they **do** contain content when used.
+
+Example:
+```html
+{% Napolean class: "chapstick" %}
+  But my lips hurt real bad!
+{% endNapolean %}
+```
+
+Because of these types, we recommend you organize your components in your `_plugins/` directory into `tags` and `blocks` directories:
+
+```shell
+my-jekyll/
+└── _plugins/
+    ├── blocks/
+    └── tags/
+```
+
+
+### Up next
+
+Learn how to [create a component](creating-a-component.md).

data/examples/block_component.rb

@@ -0,0 +1,22 @@
+require "jekyll-spark"
+
+module Jekyll
+  class ExampleBlockComponent < ComponentBlock
+    def template(context)
+      # Declare props as variables here
+      content = @props["content"]
+
+      # Output rendered markup
+      render = %Q[
+        <div class="component">
+          #{content}
+        </div>
+      ]
+    end
+  end
+end
+
+Liquid::Template.register_tag(
+  "ExampleBlock",
+  Jekyll::ExampleBlockComponent,
+)

data/examples/tag_component.rb

@@ -0,0 +1,21 @@
+require "jekyll-spark"
+
+module Jekyll
+  class ExampleTagComponent < ComponentTag
+    def template(context)
+      # Declare props as variables here
+
+      # Output rendered markup
+      render = %Q[
+        <div class="component">
+          Example
+        </div>
+      ]
+    end
+  end
+end
+
+Liquid::Template.register_tag(
+  "ExampleTag",
+  Jekyll::ExampleTagComponent,
+)

data/jekyll-spark.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/spark/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-spark"
+  spec.version       = Jekyll::Spark::VERSION
+  spec.authors       = ["ItsJonQ"]
+  spec.email         = ["itsjonq@gmail.com"]
+
+  spec.summary       = "A Jekyll library for building component-based UI"
+  spec.homepage      = "https://github.com/helpscout/jekyll-spark"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("jekyll", ">= 3.1.2")
+  spec.add_runtime_dependency("htmlcompressor", "~> 0.3.1")
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "minitest-profile"
+  spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "nokogiri", "~> 1.7.1"
+  spec.add_development_dependency "rspec-mocks"
+  spec.add_development_dependency "shoulda"
+  spec.add_development_dependency "kramdown"
+end

data/lib/jekyll-spark.rb

@@ -0,0 +1 @@
+require "jekyll/spark"

data/lib/jekyll/spark.rb

@@ -0,0 +1,4 @@
+require "jekyll"
+require "jekyll/spark/version"
+require "jekyll/spark/block"
+require "jekyll/spark/tag"

data/lib/jekyll/spark/base.rb

@@ -0,0 +1,123 @@
+require "htmlcompressor"
+require "jekyll"
+require "liquid"
+
+module Jekyll
+  module ComponentBase
+    include Liquid::StandardFilters
+
+    @@compressor = HtmlCompressor::Compressor.new({
+      :remove_comments => true
+    }).freeze
+
+    def initialize(tag_name, markup, tokens)
+      super
+
+      @attributes = {}
+      @context = false
+      @context_name = self.name.to_s.gsub("::", "_").downcase
+      @content = ''
+      @default_selector_attr = []
+      @props = Hash.new
+      @site = false
+
+      if markup =~ /(#{Liquid::QuotedFragment}+)?/
+        # Parse parameters
+        # Source: https://gist.github.com/jgatjens/8925165
+        markup.scan(Liquid::TagAttributes) do |key, value|
+          @attributes[key] = Liquid::Expression.parse(value)
+        end
+      else
+        raise SyntaxError.new(options[:locale].t("errors.syntax.include".freeze))
+      end
+    end
+
+    # blank?
+    # Description: Override's Liquid's default blank checker. This allows
+    # for templates to be used without passing inner content.
+    def blank?
+      false
+    end
+
+    def selector_default_props(attr = @default_selector_attr)
+      template = ""
+      attr.each { |prop|
+        if @props.key?(prop)
+          template += "#{prop}='#{@props[prop]}' "
+        end
+      }
+
+      return template
+    end
+
+    def selector_data_props(attr = @attributes)
+      template = ""
+      attr.keys.each { |key|
+        if key.include? "data"
+          template += "#{key.gsub("_", "-")}='#{@props[key]}' "
+        end
+      }
+
+      return template
+    end
+
+    def selector_props(attr = @default_selector_attr)
+      template = ""
+      template += selector_data_props
+      template += selector_default_props(attr)
+
+      return template
+    end
+
+    def set_props(props = Hash.new)
+      @context[@context_name] = @props = @props.merge(props)
+    end
+
+    def serialize_data
+      data = Hash.new
+      @attributes["content"] = @content
+      if @attributes.length
+        @attributes.each do |key, value|
+          val = @context.evaluate(value)
+          data[key] = val
+        end
+      end
+
+      return set_props(data)
+    end
+
+    def unindent(content)
+      # Remove initial whitespace
+      content.gsub!(/\A^\s*\n/, "")
+      # Remove indentations
+      if content =~ %r!^\s*!m
+        indentation = Regexp.last_match(0).length
+        content.gsub!(/^\ {#{indentation}}/, "")
+      end
+
+      return content
+    end
+
+    def render(context)
+      @context = context
+      @site = @context.registers[:site]
+      @content = super
+      serialize_data
+      output = template(context)
+
+      if (output.instance_of?(String))
+        output = Liquid::Template.parse(output).render()
+        output = @@compressor.compress(unindent(output))
+      else
+        output = ""
+      end
+
+      return output
+    end
+
+    def template(context = @context)
+      return context
+    end
+
+  end
+end

data/lib/jekyll/spark/block.rb

@@ -0,0 +1,8 @@
+require "jekyll"
+require_relative "./base"
+
+module Jekyll
+  class ComponentBlock < Liquid::Block
+    include Jekyll::ComponentBase
+  end
+end

data/lib/jekyll/spark/tag.rb

@@ -0,0 +1,8 @@
+require "jekyll"
+require_relative "./base"
+
+module Jekyll
+  class ComponentTag < Liquid::Tag
+    include Jekyll::ComponentBase
+  end
+end

data/lib/jekyll/spark/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Spark
+    VERSION = "0.3.0"
+  end
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-spark
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- ItsJonQ
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: htmlcompressor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-profile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- itsjonq@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- docs/creating-a-component.md
+- docs/introduction.md
+- examples/block_component.rb
+- examples/tag_component.rb
+- jekyll-spark.gemspec
+- lib/jekyll-spark.rb
+- lib/jekyll/spark.rb
+- lib/jekyll/spark/base.rb
+- lib/jekyll/spark/block.rb
+- lib/jekyll/spark/tag.rb
+- lib/jekyll/spark/version.rb
+homepage: https://github.com/helpscout/jekyll-spark
+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.2
+signing_key: 
+specification_version: 4
+summary: A Jekyll library for building component-based UI
+test_files: []