kit_liquid_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d49fc48c859e950e495e30e7c045e011760b8b3afe4c9ec2332cbc785edc22a5
+  data.tar.gz: a36b9cfb640ffc0ac0d3a80479fc67159d5cce384411d766446150be66d56934
+SHA512:
+  metadata.gz: bd8ec87e59b3ccd97527a6be9334ddf7c12c4fde02a65a19de77dcbf3f523b230ec5b2dd32602acc0e9aae7f3bbc52ca53201d7e38a5f63399fff0d5931fc2af
+  data.tar.gz: ab62af6a97fe1490e3fbd36b0c37213098f4171e2cb77eed1a41027de87fbfd139189f6d9b15c8477cf860b91a76215dff80b77f921c543ba6395bbfefd98a1a

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{ repo }.git" }
+
+gemspec

data/MIT_LICENSE.md

@@ -0,0 +1,9 @@
+# License
+
+- [MIT license](http://www.opensource.org/licenses/mit-license.php)
+- **Copyright (c) 2021 Nathan Appere**
+- https://github.com/rubykit/liquid_rails
+- https://github.com/rubykit/liquid_rails/blob/master/MIT_LICENSE.md
+
+The license itself:
+- https://github.com/rubykit/liquid_rails/blob/master/MIT_LICENSE.txt

data/MIT_LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2021 Nathan Appere, https://github.com/rubykit/liquid_rails
+
+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,36 @@
+[LiquidRails]: https://github.com/rubykit/liquid_rails
+[Liquid]: https://shopify.github.io/liquid/
+[ViewComponent]: https://github.com/github/view_component
+[Ruby on Rails]: https://rubyonrails.org/
+
+# LiquidRails
+
+[LiquidRails] allows you to render [Liquid] templates in [Ruby on Rails] views & [ViewComponent]s.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test, :development do
+  gem 'kit_liquid_rails'
+end
+```
+
+Or, for a Ruby library, add this to your gemspec:
+
+```ruby
+spec.add_dependency 'kit_liquid_rails'
+```
+
+And then run:
+
+```bash
+$ bundle install
+```
+
+## Copyright & License
+
+Copyright (c) 2021, Nathan Appere.
+
+[LiquidRails] is licensed under [MIT License](MIT_LICENSE.md).

data/kit_liquid_rails.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/kit_liquid_rails/version'
+
+version = KitLiquidRails::VERSION
+
+Gem::Specification.new do |s|
+  s.name        = 'kit_liquid_rails'
+  s.version     = version
+  s.summary     = 'Add support for Liquid templates in Ruby on Rails.'
+  s.description = 'Allows you to use .liquid templates in your views & ViewComponents.'
+  s.license     = 'MIT'
+  s.author      = 'Nathan Appere'
+  s.email       = 'nathan@rubykit.org'
+  s.homepage    = 'https://github.com/rubykit/liquid_rails'
+
+  s.metadata = {
+    'source_code_uri' => "https://github.com/rubykit/liquid_rails/tree/v#{ version }"
+  }
+
+  s.add_dependency 'liquid',         '~> 5.0'
+  s.add_dependency 'railties',       '~> 6.0'
+  s.add_dependency 'view_component', '~> 2.40'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rails', '~> 6.0'
+  s.add_development_dependency 'rake'
+
+  s.files        = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+end

data/lib/kit_liquid_rails/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+class KitLiquidRails::Railtie < ::Rails::Railtie
+
+  initializer "kit_liquid_rails.register_template_handler" do
+    ActiveSupport.on_load(:action_view) do
+      ActionView::Template.register_template_handler :liquid, KitLiquidRails::TemplateHandler
+    end
+  end
+
+end

data/lib/kit_liquid_rails/template_handler.rb

@@ -0,0 +1,33 @@
+class KitLiquidRails::TemplateHandler
+
+  attr_reader :context
+
+  # Note: local_assigns is not available in ViewComponents
+  def self.call(template, source)
+    source ||= template.source
+    "::KitLiquidRails::TemplateHandler.new(self).render(#{ source.inspect }, (defined?(local_assigns) ? local_assigns : nil))"
+  end
+
+  def initialize(context)
+    @context = context
+  end
+
+  def render(source, local_assigns = nil)
+    local_assigns ||= {}
+
+    # Use `liquid_assigns` method on the `ViewComponent` to determine what to forward to Liquid.
+    if context.is_a?(::ViewComponent::Base) && context.respond_to?(:liquid_assigns)
+      local_assigns = context.liquid_assigns
+    end
+
+    local_assigns = local_assigns&.deep_stringify_keys
+
+    liquid = Liquid::Template.parse(source)
+    liquid.render(local_assigns).html_safe
+  end
+
+  def compilable?
+    false
+  end
+
+end

data/lib/kit_liquid_rails/version.rb

@@ -0,0 +1,5 @@
+module KitLiquidRails
+
+  VERSION = '0.1.0'
+
+end

data/lib/kit_liquid_rails.rb

@@ -0,0 +1,6 @@
+module KitLiquidRails # rubocop:disable Style/Documentation
+end
+
+require 'kit_liquid_rails/version'
+require 'kit_liquid_rails/template_handler'
+require 'kit_liquid_rails/railtie'

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: kit_liquid_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathan Appere
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  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: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.40'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.40'
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Allows you to use .liquid templates in your views & ViewComponents.
+email: nathan@rubykit.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT_LICENSE.md
+- MIT_LICENSE.txt
+- README.md
+- kit_liquid_rails.gemspec
+- lib/kit_liquid_rails.rb
+- lib/kit_liquid_rails/railtie.rb
+- lib/kit_liquid_rails/template_handler.rb
+- lib/kit_liquid_rails/version.rb
+homepage: https://github.com/rubykit/liquid_rails
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/rubykit/liquid_rails/tree/v0.1.0
+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.2.3
+signing_key:
+specification_version: 4
+summary: Add support for Liquid templates in Ruby on Rails.
+test_files: []