view_component_liquid 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36d1743b812fccdf8ce58e060cf49ca7b90a9077abb1a47a929a6f7efd42abfc
+  data.tar.gz: 8ae09e75a0acd4020d93066550c6c7303f1a04dd1fa47c10c2f773febd347a81
+SHA512:
+  metadata.gz: 7304d6fe765bf3f3007183bfd1a3c41288c02f60cc449c0e8674b3951f64b95b686ce9837bf129fe815111971de7bb2a8eacd181d932afa72d0d65c853f9be85
+  data.tar.gz: c90a0073cd11cf9e8ef48e0164fd7f00e39ce4a7698cd41aef6c493712842e17bd0d5d2e970a6915425c6ad34ea3f7c27ba16362cf7140a90aaf5f057cce51e1

data/.gitignore

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

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 view-component-liquid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+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,91 @@
+# ViewComponentLiquid
+
+Use Liquid templates and components from within GitHub's [ViewComponent](https://github.com/github/view_component) and your Rails application.
+
+
+TODO: Update docs below
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'view_component_liquid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install view_component_liquid
+
+
+Next, add this line below where you require `view_component` in `config/application.rb`:
+
+```ruby
+require "view_component_liquid/engine"
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Bridgetown Filters
+
+    $ bundle add bridgetown-core
+
+Then create the file `config/initializers/bridgetown.rb`
+
+```ruby
+require "bridgetown-core/filters"
+Liquid::Template.register_filter Bridgetown::Filters
+```
+
+## Loading shared components from a Bridgetown site
+
+Example:
+
+```ruby
+# config/initializers/bridgetown.rb
+
+# Set the path to your Bridgetown folder relative to the Rails root
+bridgetown_path = Rails.root.parent.join("bridgetown-site-repo")
+
+# Load in Liquid components and any shared Bridgetown builders
+components_path = bridgetown_path.join("src", "_components")
+plugins_path = bridgetown_path.join("plugins", "shared_rails")  
+ActiveSupport::Dependencies.autoload_paths << components_path
+ActiveSupport::Dependencies.autoload_paths << plugins_path
+
+# Instantiate any shared builders
+ActiveSupport.on_load(:action_controller) do
+  class SiteBuilder < Bridgetown::Builder; end
+
+  # Pass along a "fake" site object. If you'd to include config to pass to
+  # your builder, you can do t
+  TagsBuilder.new(
+    "TagsBuilder",
+    OpenStruct.new(config: {
+      rails: "included config!"
+    }.with_indifferent_access)
+  )
+end
+```
+
+## 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/view_component_liquid/view_component_liquid.
+
+## 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 View::Component::Liquid project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bridgetownrb/view_component_liquid/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/view_component_liquid.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "action_view"
+require "active_support/dependencies/autoload"
+require "active_support/concern"
+require "liquid"
+require "liquid-render-tag"
+require "liquid-component"
+
+module ViewComponentLiquid
+  extend ActiveSupport::Autoload
+
+  autoload :TemplateHandler
+  autoload :FileSystem
+end
+
+# Mixin to let ViewComponent work with Liquid
+module ViewComponent
+  module Liquify
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :liquid_keys
+    end  
+    
+    class_methods do
+      def liquid_accessor(*varnames)
+        self.liquid_keys ||= Set.new
+        varnames.each do |varname|
+          self.liquid_keys << varname
+          attr_accessor varname
+        end
+      end
+      
+      private
+  
+      # Look for both compname.liquid and compname_component.liquid
+      def matching_views_in_source_location
+        location_without_extension = source_location.chomp(File.extname(source_location)).split("/").tap do |pathname|
+          pathname.last.delete_suffix! "_component"
+        end.join("/")
+        Dir["#{location_without_extension}.liquid", "#{location_without_extension}_component.liquid"]
+      end
+    end
+    
+    def local_assigns
+      {}.yield_self do |assigns|
+        self.class.liquid_keys.each do |key|
+          assigns[key] = send(key)
+        end
+        assigns
+      end
+    end
+  end
+end
+

data/lib/view_component_liquid/engine.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails"
+require "view_component_liquid"
+
+module ViewComponentLiquid
+  class Engine < Rails::Engine
+    initializer "view_component_liquid.add_liquid_template_handler" do
+      ActiveSupport.on_load(:action_view) do
+        ActionView::Template.register_template_handler(:liquid, ViewComponentLiquid::TemplateHandler)
+      end
+    end
+  end
+end
+

data/lib/view_component_liquid/file_system.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# Provide Liquid views/partials/components to the template handler and render tag
+module ViewComponentLiquid
+  class FileSystem
+    def initialize(view)
+      @view = view
+    end
+
+    def read_template_file(template_path)
+      controller_path = view.controller_path
+
+      template_name = File.basename(template_path)
+      template_folders = unless template_path.include?("/")
+                           [
+                             "",
+                             controller_path,
+                             "application",
+                             "shared"
+                           ]
+                         else
+                          [File.dirname(template_path)]
+                         end
+
+      # Search Rails' configured view paths first
+      result = view.view_paths.find_all(
+        template_name,
+        template_folders,
+        true,
+        lookup_details
+      )
+
+      if result.present?
+        LiquidComponent.parse(result.first.source).content
+      else
+        # Time to look through autoload paths for component folders
+        components_folders = Zeitwerk::Loader.all_dirs.select {|item| item.ends_with?("_components")}
+
+        template = nil
+
+        components_folders.each do |components_folder|
+          tmpl = components_folder + "/#{template_path}.liquid"
+          if File.exist?(tmpl)
+            template = LiquidComponent.parse(File.read(tmpl)).content
+            break
+          end
+        end
+
+        template.presence || raise(ActionView::MissingTemplate.new(template_folders + components_folders, template_name, template_folders, false, "liquid views"))
+      end
+    end
+
+    private
+
+    attr_reader :view
+
+    def lookup_details
+      {
+        locale:   [view.locale, :en],
+        formats:  view.formats,
+        variants: [],
+        handlers: [:liquid],
+        versions: []
+      }
+    end
+  end
+end

data/lib/view_component_liquid/template_handler.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Hook into ActiveView's template handling system
+module ViewComponentLiquid
+  class TemplateHandler
+    class << self
+      def call(template, source)
+        "ViewComponentLiquid::TemplateHandler.new(self).render(#{source.inspect}, local_assigns)"
+      end
+    end
+
+    def initialize(view)
+      @view = view
+      @controller = @view.controller
+    end
+
+    def render(template, local_assigns={})
+      component = LiquidComponent.parse(template)
+      template = component.content
+
+      assigns = local_assigns.stringify_keys
+      assigns["component"] = component.to_h.deep_stringify_keys
+      assigns["controller"] = {
+        "controller_name" => @controller.controller_name,
+        "action_name" => @controller.action_name
+      }
+      if @view.respond_to?(:assigns)
+        assigns["controller"].merge! @view.assigns.to_h
+        @view.instance_variable_set(:@liquid_page, component)
+      end
+
+      p "ASSIGNS", assigns
+
+      liquid = Liquid::Template.parse(template)
+      liquid.send(render_method, assigns, filters: filters, registers: registers).html_safe
+    end
+
+    def filters
+      if @view.respond_to?(:liquid_filters, true)
+        @view.send(:liquid_filters)
+      end
+    end
+
+    def registers
+      {
+        view: @view,
+        file_system: ViewComponentLiquid::FileSystem.new(@view)
+      }
+    end
+
+    def compilable?
+      false
+    end
+
+    def render_method
+      (Rails.env.development? || Rails.env.test?) ? :render! : :render
+    end
+    
+    ActiveSupport.run_load_hooks(:view_component_liquid, self)
+  end
+end
+

data/lib/view_component_liquid/version.rb

@@ -0,0 +1,4 @@
+module ViewComponentLiquid
+  VERSION = "1.0.0"
+end
+

data/view_component_liquid.gemspec

@@ -0,0 +1,28 @@
+require_relative "lib/view_component_liquid/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "view_component_liquid"
+  spec.version       = ViewComponentLiquid::VERSION
+  spec.authors       = ["Jared White"]
+  spec.email         = ["jared@whitefusion.io"]
+
+  spec.summary       = %q{Use Liquid templates and components from within ViewComponent}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/bridgetownrb/view_component_liquid"
+  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{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "liquid",            "~> 4.0"
+  spec.add_runtime_dependency "liquid-render-tag", "~> 0.2"
+  spec.add_runtime_dependency "liquid-component",  ">= 0.1"
+  spec.add_runtime_dependency "activesupport",     [">= 5.0.0", "< 7.0"]
+  
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 12.0"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: view_component_liquid
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jared White
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: liquid-render-tag
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: liquid-component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.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'
+description: Use Liquid templates and components from within ViewComponent
+email:
+- jared@whitefusion.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/view_component_liquid.rb
+- lib/view_component_liquid/engine.rb
+- lib/view_component_liquid/file_system.rb
+- lib/view_component_liquid/template_handler.rb
+- lib/view_component_liquid/version.rb
+- view_component_liquid.gemspec
+homepage: https://github.com/bridgetownrb/view_component_liquid
+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.6
+signing_key: 
+specification_version: 4
+summary: Use Liquid templates and components from within ViewComponent
+test_files: []