liquid-component 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c85ed0049b8cbfd0481b1d36c1ab305ec215ab8e114a968bd734497d86a832b9
+  data.tar.gz: a2a208d862e263960319f0115a15b556e2c122d3d6b077cb9f43374eef3a97a6
+SHA512:
+  metadata.gz: 80edd204b2a60ff23829ac5be0e34518c3c20568fd1307f04dcc5e003615175335c746221eaa9b6ffc3b40fa34ac4711fbe5a3042c7801732b50944acba6fcc5
+  data.tar.gz: 8757d309373405dfba9bda254a234b65169d64dd54b0f1ae2af0b6d340344fb8d05e39096fd36b3932911cd80f6167251ae705ee89c3d37b67b56e7ed74e56c5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at
+[jared@whitefusion.io](mailto:jared@whitefusion.io). All complaints will
+be reviewed and investigated and will result in a response that is deemed
+necessary and appropriate to the circumstances. The project team is obligated
+to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq)

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in liquid-component.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    liquid-component (0.1.0)
+      activesupport (>= 5.0)
+      safe_yaml (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ansi (1.5.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.1)
+    minitest-profile (0.0.2)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (12.3.3)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  liquid-component!
+  minitest (~> 5.0)
+  minitest-profile (>= 0.0.2)
+  minitest-reporters (~> 1.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Jared White
+
+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,128 @@
+# Liquid Component
+
+Smart components for the Liquid template language. Use YAML front matter to specify component metadata (name, description) and variable types. Use
+component metadata for validation and reflection (perhaps to build visual preview stories).
+
+_Currently under active development._
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'liquid-component'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install liquid-component
+```
+
+## Usage
+
+Given a Liquid template string, all you need to do is call `LiquidComponent.parse`:
+
+```ruby
+component = LiquidComponent.parse(template)
+```
+
+The return value will be a `LiquidComponent::Component` object which provides two data structures:
+
+* `metadata`: the parsed front matter as a `LiquidComponent::Metadata` object.
+* `content`: the body of the Liquid template.
+
+Even if there's no front matter, a component will successfully instantiate, but all the metadata values will be nil. The component object also provides convenience methods to get to the metadata values, so `component.name` is the same as `component.metadata.name`.
+
+Here are the possible `LiquidComponent::Metadata` values, all optional:
+
+* `name`: the human-readable name of the component.
+* `description`: a description of what the component is for.
+* `variables`: an array of `LiquidComponent::Variable` variable definitions.
+* `additional`: any additional custom YAML front matter, if any.
+
+Here are the possible `LiquidComponent::Variable` values:
+
+* `name`: the variable identifier.
+* `type`: a symbol indicating a data type…string, boolean, array, etc.
+* `required`: `true` if the variable is required, `false` if it is optional.
+* `description`: an optional description of what the variable is for.
+
+## Spec in progress
+
+This is a quick attempt to document a possible spec for Liquid Components. It builds upon the brand new `render` tag functionality but adds block mode, Markdown formatting, and validation.
+
+### Example
+
+```liquid
+{% rendercontent "cards/widget", title: "I'm a Card", show_footer: false, theme: page.theme %}
+I'm the body of the card. I support **Markdown** _formatting!_
+{% endrendercontent %}
+```
+
+### Defining a Component
+
+```html
+---
+name: Widget Card
+description: Displays a card about a widget that you can open.
+variables:
+  title:
+    - string
+    - The title of the card displayed in a header along the top.
+  show_footer: [boolean, Display bottom footer.]
+  theme?: object # optional variable
+  content: markdown
+---
+
+<div class="widget card {{ theme | default: "default" }}">
+  <div class="card-title">{{ title }}</div>
+  <div class="card-body">{{ content }}</div>
+  {% if show_footer %}
+    <div class="card-footer"><button>Open the Widget</button></div>
+  {% endif %}
+</div>
+```
+
+### Variable Warnings (TODO)
+
+If a variable is supplied to a component in the wrong format, or if it's missing when it's required, then the component will emit a Liquid warning. By default it won't interrupt the overall rendering of Liquid templates (but that is configurable). The goal is simply to catch errors at development time, not frustrate the process of generating a working site.
+
+## TODO
+
+* Finish fleshing out variable types
+* Variable validation
+* Describe content processors (HTML, Markdown, JSON, YAML, etc.)
+* Investigate multiple "content areas" ([see github/view_component for inspiration](https://github.com/github/view_component/blob/master/README.md#content-areas))
+* How to handle sidecar assets for components (related JS and CSS files)
+  * _Interesting thought:_ what if each component rendered out as a Web Component (aka `<liquid-cards-widget>…</liquid-cards-widget>`) and then that could easily be hooked into for implementing CSS/JS frontend functionality? Maybe make that an optional `web_component: true` setting in the front matter.
+* Testing strategy
+* Component previews
+
+----
+
+## Testing
+
+Run `bundle exec rake` to run the test suite.
+
+## Development
+
+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/bridgetownrb/liquid-component.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Phaedra project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bridgetownrb/liquid-component/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+task :spec => :test
+task default: :test
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/test_*.rb"
+  test.verbose = true
+end

data/lib/liquid-component.rb

@@ -0,0 +1,37 @@
+require "liquid-component/version"
+
+require "safe_yaml/load"
+SafeYAML::OPTIONS[:suppress_warnings] = true
+
+require "liquid-component/component"
+require "liquid-component/metadata"
+require "liquid-component/variable"
+
+module LiquidComponent
+  FRONT_MATTER_REGEXP = %r!\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)!m.freeze
+
+  def self.parse(template)
+    template = template.to_s
+
+    yaml_data = {}
+    file_content = nil
+
+    if has_yaml_header?(template)
+      if template = template.match(FRONT_MATTER_REGEXP)
+        file_content = template.post_match
+        yaml_data = SafeYAML.load(template.captures[0])
+      end
+    else
+      file_content = template
+    end
+
+    Component.new(
+      metadata: Metadata.new(yaml_data),
+      content: file_content
+    )
+  end
+
+  def self.has_yaml_header?(template)
+    template.lines.first&.match? %r!\A---\s*\r?\n!
+  end
+end

data/lib/liquid-component/component.rb

@@ -0,0 +1,33 @@
+module LiquidComponent
+  class Component
+    attr_accessor :metadata, :content
+
+    def initialize(metadata:, content:)
+      self.metadata = metadata
+      self.content = content
+    end
+
+    def name
+      metadata.name
+    end
+
+    def description
+      metadata.description
+    end
+
+    def variables
+      metadata.variables
+    end
+
+    def additional_metadata
+      metadata.additional
+    end
+
+    def to_h
+      {
+        metadata: metadata.to_h,
+        content: content
+      }
+    end
+  end
+end

data/lib/liquid-component/metadata.rb

@@ -0,0 +1,31 @@
+require "active_support/core_ext/hash/indifferent_access"
+
+module LiquidComponent  
+  class Metadata
+    attr_accessor :name, :description, :variables, :additional
+
+    def initialize(metadata)
+      metadata = metadata.with_indifferent_access
+
+      self.name = metadata[:name]
+      self.description = metadata[:description]
+      self.variables = Variable.parse(metadata[:variables])
+
+      metadata.delete(:name)
+      metadata.delete(:description)
+      metadata.delete(:variables)
+
+      self.additional = metadata
+    end
+
+    def to_h
+      h = {}
+      h[:name] = name if name
+      h[:description] = description if description
+      h[:variables] = variables.map(&:to_h)
+      h[:additional] = additional
+
+      h
+    end
+  end
+end

data/lib/liquid-component/variable.rb

@@ -0,0 +1,42 @@
+module LiquidComponent  
+  class Variable
+    attr_accessor :name, :type, :required, :description
+
+    def self.parse(variables)
+      return [] if variables.nil?
+
+      variables.map do |variable_name, variable_metadata|
+        new(variable_name, variable_metadata)
+      end
+    end
+
+    def initialize(variable_name, variable_metadata)
+      self.required = true
+
+      self.name = if variable_name.end_with? "?"
+        self.required = false
+        variable_name.sub(/\?$/, "").to_sym
+      else
+        variable_name.to_sym
+      end
+
+      if variable_metadata.is_a?(Array)
+        self.type = variable_metadata[0].to_sym
+        self.description = variable_metadata[1]
+      else
+        self.type = variable_metadata.to_sym
+      end
+    end
+
+    def to_h
+      h = {
+        name: name,
+        type: type,
+        required: required
+      }
+      h[:description] = description if description
+
+      h
+    end
+  end
+end

data/lib/liquid-component/version.rb

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

data/liquid-component.gemspec

@@ -0,0 +1,29 @@
+require_relative "lib/liquid-component/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "liquid-component"
+  spec.version       = LiquidComponent::VERSION
+  spec.authors       = ["Jared White"]
+  spec.email         = ["jared@whitefusion.io"]
+
+  spec.summary       = %q{Load and parse Liquid Component templates with YAML front matter}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/bridgetownrb/liquid-component"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(script|test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", ">= 5.0"
+  spec.add_runtime_dependency "safe_yaml", "~> 1.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-profile", ">= 0.0.2"
+  spec.add_development_dependency "minitest-reporters", "~> 1.0"
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: liquid-component
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jared White
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: safe_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-profile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Load and parse Liquid Component templates with YAML front matter
+email:
+- jared@whitefusion.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/liquid-component.rb
+- lib/liquid-component/component.rb
+- lib/liquid-component/metadata.rb
+- lib/liquid-component/variable.rb
+- lib/liquid-component/version.rb
+- liquid-component.gemspec
+homepage: https://github.com/bridgetownrb/liquid-component
+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: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Load and parse Liquid Component templates with YAML front matter
+test_files: []