bridgetown-view-component 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98cf1967e206477d3d79b8e951abc7523557fd8bb6b20c7f8938d5e35de6497e
+  data.tar.gz: 502ef348097c8ca6b2db755c4193a0aaa756fd6b46713436d8b2973ed905402e
+SHA512:
+  metadata.gz: 1f7388410c8bb94a61d4ddac9683e325952148357495fddc372ef9c2357df36ee79b4f8164a9ed4a96331602bc2c30c4f995fbd4722cae98631d122e81fe0ab2
+  data.tar.gz: c6ec5a0959364ab81292a84181a3a9860c933f1015da8779b24bb8a7996a7c52ff8881048121632e34afe9edb7441933c2012a698796960e8ab876f46f124ed2

data/.gitignore

@@ -0,0 +1,38 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+
+# Node
+node_modules
+.npm
+.node_repl_history
+
+# Yarn
+yarn-error.log
+yarn-debug.log*
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+spec/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Include:
+    - lib/**/*.rb
+
+  Exclude:
+    - .gitignore
+    - .rspec
+    - .rubocop.yml
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+
+    - script/**/*
+    - vendor/**/*

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# main
+
+* Use this file to keep track of plugin updates
+
+# 0.1.0 / 2020-05-01
+
+* First version

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present
+
+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,14 @@
+# ViewComponent for Bridgetown
+
+Bridgetown + ViewComponent = :heart:
+
+WIP — stay tuned!
+
+## Contributing
+
+1. Fork it (https://github.com/bridgetownrb/bridgetown-view-component/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bridgetown-view-component.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown-view-component/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown-view-component"
+  spec.version       = Bridgetown::ViewComponent::VERSION
+  spec.author        = "Bridgetown Team"
+  spec.email         = "maintainers@bridgetownrb.com"
+  spec.summary       = "Brings GitHub's ViewComponent library to Bridgetown"
+  spec.homepage      = "https://github.com/bridgetownrb/bridgetown-view-component"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features|frontend)/!) }
+  spec.test_files    = spec.files.grep(%r!^spec/!)
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.add_dependency "bridgetown", ">= 0.21.0.beta1", "< 2.0"
+  spec.add_dependency "view_component", ">= 2.20"
+  spec.add_dependency "actionview", "~> 6.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "nokogiri", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.2"
+end

data/components/bridgetown/view_component/sanity_check_component.erb

@@ -0,0 +1 @@
+Hello <%= @name %>! Welcome to Bridgetown + ViewComponent. 😃

data/components/bridgetown/view_component/sanity_check_component.rb

@@ -0,0 +1,11 @@
+module Bridgetown
+  module ViewComponent
+    class SanityCheckComponent < ::ViewComponent::Base
+      include Bridgetown::ViewComponent
+
+      def initialize(name:)
+        @name = name
+      end
+    end
+  end
+end

data/lib/bridgetown-view-component.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "bridgetown-core"
+require "action_view"
+require "view_component"
+
+# Create basic Rails namespace when in Bridgetown-only context
+unless defined?(Rails)
+  module Rails
+    module UrlHelpers; end
+
+    def self.version
+      ActionView.version.to_s
+    end
+
+    def self.application
+      @application ||= HashWithDotAccess::Hash.new({
+        routes: { url_helpers: UrlHelpers },
+      })
+    end
+
+    def self.env
+      @env ||= HashWithDotAccess::Hash.new({ production?: Bridgetown.env.production? })
+    end
+  end
+
+  unless Rails.version.to_f >= 6.1
+    require "view_component/render_monkey_patch"
+    ActionView::Base.prepend ViewComponent::RenderMonkeyPatch
+  end
+end
+
+# Load classes/modules
+
+module Bridgetown
+  module ViewComponent
+  end
+
+  autoload :ViewComponentHelpers,
+           "bridgetown-view-component/bridgetown/view_component_helpers"
+  autoload :ComponentValidation,
+           "bridgetown-view-component/bridgetown/component_validation"
+end
+
+# Set up the test components source manifest
+Bridgetown::PluginManager.new_source_manifest(
+  origin: Bridgetown::ViewComponent,
+  components: File.expand_path("../components", __dir__)
+)
+
+# Add a few methods to Bridgetown's Ruby template superclasses
+[Bridgetown::RubyTemplateView, Bridgetown::Component].each do |klass|
+  klass.class_eval do
+    def lookup_context
+      HashWithDotAccess::Hash.new(variants: [])
+    end
+
+    def view_renderer
+      nil
+    end
+
+    def view_flow
+      nil
+    end
+  end
+end

data/lib/bridgetown-view-component/bridgetown/component_validation.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module ComponentValidation
+    def self.included(klass)
+      klass.attr_reader :frontmatter
+    end
+
+    def frontmatter=(yaml_data)
+      @frontmatter = yaml_data.with_dot_access
+
+      frontmatter.validate&.each do |variable, type|
+        unless send(variable).is_a?(Kernel.const_get(type))
+          raise "Validation error while rendering #{self.class}: " \
+                "`#{variable}' is not of type `#{type}'"
+        end
+      end
+    end
+  end
+end

data/lib/bridgetown-view-component/bridgetown/view_component.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module ViewComponentARCHIVED
+    # NOTE: Currently not in use...might need to revisit when dual Rails/Bridgetown
+    # installs are present
+    def self.setup_hooks
+      Bridgetown::Hooks.register :site, :pre_render, reloadable: false do
+        ::ViewComponent::CompileCache.cache.each do |component_class|
+          component_class.undef_method(:call)
+        end
+        ::ViewComponent::CompileCache.cache.clear
+      end
+
+      Bridgetown::Hooks.register :site, :post_render, reloadable: false do |_post|
+        ::ViewComponent::CompileCache.cache.each do |component_class|
+          component_class.undef_method(:call)
+        end
+        ::ViewComponent::CompileCache.cache.clear
+      end
+    end
+
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      def content_format(type)
+        @content_format = type
+      end
+
+      def format_for_content
+        @content_format ||= :default
+      end
+    end
+
+    def content
+      if self.class.format_for_content == :markdown && view_context.respond_to?(:markdownify)
+        view_context.markdownify(@content).html_safe
+      else
+        super
+      end
+    end
+
+    def render_in(view_context, &block)
+      if view_context.class.name&.start_with? "Bridgetown"
+        singleton_class.include ViewComponentHelpers
+      end
+
+      super
+    end
+  end
+end

data/lib/bridgetown-view-component/bridgetown/view_component_helpers.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module ViewComponentHelpers
+    extend Forwardable
+
+    def_delegators :@view_context, :liquid_render, :partial
+
+    attr_reader :site # will be nil unless you explicitly set a `@site` ivar
+
+    def self.helper_allow_list
+      @helper_allow_list ||= %i(capture render t with_output_buffer)
+    end
+
+    def self.allow_rails_helpers(*helpers)
+      helper_allow_list.concat(helpers)
+    end
+
+    def self.included(klass)
+      helper_consts = ActionView::Helpers.constants.select do |c|
+        ActionView::Helpers.const_get(c).is_a?(Module)
+      end
+      helper_consts.map { |c| ActionView::Helpers.const_get(c) }.each do |mod|
+        (mod.public_instance_methods - Object.public_instance_methods).each do |method_name|
+          klass.undef_method(method_name) unless helper_allow_list.include?(method_name)
+        rescue NameError
+          nil
+        end
+      end
+    end
+
+    def render(item, options = {}, &block)
+      if item.respond_to?(:render_in)
+        result = ""
+        capture do # this ensures no leaky interactions between BT<=>VC blocks
+          result = item.render_in(self, &block)
+        end
+        result&.html_safe
+      else
+        view_context.partial(item, options, &block)&.html_safe
+      end
+    end
+
+    def helpers
+      @helpers ||= Bridgetown::RubyTemplateView::Helpers.new(self, @view_context.site)
+    end
+
+    def method_missing(method, *args, &block)
+      if helpers.respond_to?(method.to_sym)
+        helpers.send method.to_sym, *args, &block
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      helpers.respond_to?(method.to_sym, include_private) || super
+    end
+  end
+end

data/lib/bridgetown-view-component/components.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require File.join(
+  File.expand_path("../../", __dir__),
+  "components",
+  "bridgetown",
+  "view_component",
+  "sanity_check_component"
+)

data/lib/bridgetown-view-component/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module ViewComponent
+    VERSION = "0.6.0"
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown-view-component
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Bridgetown Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.0.beta1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.0.beta1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.20'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  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: 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: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: 
+email: maintainers@bridgetownrb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bridgetown-view-component.gemspec
+- components/bridgetown/view_component/sanity_check_component.erb
+- components/bridgetown/view_component/sanity_check_component.rb
+- lib/bridgetown-view-component.rb
+- lib/bridgetown-view-component/bridgetown/component_validation.rb
+- lib/bridgetown-view-component/bridgetown/view_component.rb
+- lib/bridgetown-view-component/bridgetown/view_component_helpers.rb
+- lib/bridgetown-view-component/components.rb
+- lib/bridgetown-view-component/version.rb
+homepage: https://github.com/bridgetownrb/bridgetown-view-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: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Brings GitHub's ViewComponent library to Bridgetown
+test_files: []