view_component-contrib 0.0.1 → 0.1.0

data/app/views/view_component_contrib/preview.html.erb

@@ -0,0 +1,7 @@
+<div class="<%= container_class %>">
+  <%- if component -%>
+    <%= render component %>
+  <%- else -%>
+  Failed to infer a component from the preview: <%= error %>
+  <%- end -%>
+</div>

data/lib/view_component-contrib.rb

@@ -1,4 +1,3 @@
 # frozen_string_literal: true
 
-require "view_component/contrib/version"
-require "view_component/contrib/railtie" if defined?(Rails::Railtie)
+require "view_component_contrib"

data/lib/view_component_contrib.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "ruby-next/language/setup"
+RubyNext::Language.setup_gem_load_path
+
+module ViewComponentContrib
+  APP_PATH = File.expand_path(File.join(__dir__, "../app"))
+
+  autoload :TranslationHelper, "view_component_contrib/translation_helper"
+  autoload :WrapperComponent, "view_component_contrib/wrapper_component"
+  autoload :WrappedHelper, "view_component_contrib/wrapped_helper"
+
+  autoload :Base, "view_component_contrib/base"
+  autoload :Preview, "view_component_contrib/preview"
+end
+
+require "view_component_contrib/version"

data/lib/view_component_contrib/base.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ViewComponentContrib
+  # Base view component class with many extensions already included
+  class Base < ViewComponent::Base
+    include TranslationHelper
+    include WrappedHelper
+  end
+end

data/lib/view_component_contrib/preview.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ViewComponentContrib
+  module Preview
+    autoload :Base, "view_component_contrib/preview/base"
+
+    autoload :Abstract, "view_component_contrib/preview/abstract"
+    autoload :DefaultTemplate, "view_component_contrib/preview/default_template"
+    autoload :Sidecarable, "view_component_contrib/preview/sidecarable"
+  end
+end

data/lib/view_component_contrib/preview/abstract.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ViewComponentContrib
+  module Preview
+    # Adds `abstract_class` accessor and exclude abstract
+    # preview classes from index
+    module Abstract
+      def self.extended(base)
+        base.singleton_class.prepend(ClassMethods)
+      end
+
+      module ClassMethods
+        attr_accessor :abstract_class
+        alias_method :abstract_class?, :abstract_class
+
+        def all
+          super.reject(&:abstract_class?)
+        end
+      end
+    end
+  end
+end

data/lib/view_component_contrib/preview/base.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module ViewComponentContrib
+  module Preview
+    # First, enable abstract classes (if not already extended)
+    unless ViewComponent::Preview.singleton_class.is_a?(ViewComponentContrib::Preview::Abstract)
+      ViewComponent::Preview.extend ViewComponentContrib::Preview::Abstract
+    end
+
+    # Base view component class with extensions already included
+    class Base < ViewComponent::Preview
+      self.abstract_class = true
+
+      include DefaultTemplate
+
+      DEFAULT_CONTAINER_CLASS = ""
+
+      class << self
+        # Support layout inheritance
+        def inherited(child)
+          child.layout(@layout) if defined?(@layout)
+          super
+        end
+
+        attr_writer :container_class
+
+        def container_class
+          return @container_class if defined?(@container_class)
+
+          @container_class =
+            if superclass.respond_to?(:container_class)
+              superclass.container_class
+            else
+              DEFAULT_CONTAINER_CLASS
+            end
+        end
+
+        def render_args(...)
+          super.tap do |res|
+            res[:locals] ||= {}
+            build_component_instance(res[:locals])
+            res[:locals][:container_class] ||= container_class
+          end
+        end
+
+        private
+
+        def build_component_instance(locals)
+          return locals unless locals[:component].nil?
+          locals[:component] = name.sub(/Preview$/, "Component").safe_constantize&.new
+        rescue => e
+          locals[:component] = nil
+          locals[:error] = e.message
+        end
+      end
+
+      # Shortcut for render_with_template(locals: ...)
+      def render_with(**locals)
+        render_with_template(locals: locals)
+      end
+
+      # Shortcut for render_with_template(locals: {component: ...})
+      def render_component(component)
+        render_with(component: component)
+      end
+    end
+  end
+end

data/lib/view_component_contrib/preview/default_template.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ViewComponentContrib
+  module Preview
+    module DefaultTemplate
+      DEFAULT_TEMPLATE = "view_component_contrib/preview"
+
+      def self.included(base)
+        base.singleton_class.prepend(ClassMethods)
+      end
+
+      module ClassMethods
+        attr_writer :default_preview_template
+
+        def default_preview_template
+          return @default_preview_template if defined?(@default_preview_template)
+
+          @default_preview_template =
+            if superclass.respond_to?(:default_preview_template)
+              superclass.default_preview_template
+            else
+              DEFAULT_TEMPLATE
+            end
+        end
+
+        def preview_example_template_path(...)
+          super
+        rescue ViewComponent::PreviewTemplateError
+          has_preview_template = preview_paths.find do |path|
+            Dir.glob(File.join(path, preview_name, "preview.html.*")).any?
+          end
+
+          has_preview_template ? File.join(preview_name, "preview") : DEFAULT_TEMPLATE
+        end
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:view_component) do
+  ViewComponent::Base.preview_paths << File.join(ViewComponentContrib::APP_PATH, "views")
+end

data/lib/view_component_contrib/preview/sidecarable.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ViewComponentContrib
+  module Preview
+    module Sidecarable
+      PREVIEW_GLOB = "**/preview.rb"
+
+      def self.extended(base)
+        base.singleton_class.prepend(ClassMethods)
+      end
+
+      module ClassMethods
+        def load_previews
+          Array(preview_paths).each do |preview_path|
+            Dir["#{preview_path}/#{PREVIEW_GLOB}"].sort.each { |file| require_dependency file }
+          end
+        end
+
+        def preview_name
+          name.chomp("::Preview").underscore
+        end
+      end
+    end
+  end
+end

data/lib/view_component_contrib/translation_helper.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ViewComponentContrib
+  module TranslationHelper
+    DEFAULT_NAMESPACE = "view_components"
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      attr_writer :i18n_namespace
+
+      def i18n_namespace
+        return @i18n_namespace if defined?(@i18n_namespace)
+
+        @i18n_namespace =
+          if superclass.respond_to?(:i18n_namespace)
+            superclass.i18n_namespace
+          else
+            DEFAULT_NAMESPACE
+          end
+      end
+
+      def i18n_scope
+        return @i18n_scope if defined?(@i18n_scope)
+
+        @i18n_scope = name.sub("::Component", "").underscore.split("/")
+      end
+
+      def i18n_scope=(val)
+        raise ArgumentError, "Must be array" unless val.is_a?(Array)
+
+        @i18n_scope = val.dup.freeze
+      end
+
+      def virtual_path
+        @contrib_virtual_path ||= [
+          i18n_namespace,
+          *i18n_scope
+        ].join(".")
+      end
+    end
+  end
+end

data/lib/view_component_contrib/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ViewComponentContrib # :nodoc:all
+  VERSION = "0.1.0"
+end

data/lib/view_component_contrib/wrapped_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ViewComponentContrib
+  # Adds `#wrapped` method to automatically wrap self into a WrapperComponent
+  module WrappedHelper
+    def wrapped
+      WrapperComponent.new(self)
+    end
+  end
+end

data/lib/view_component_contrib/wrapper_component.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ViewComponentContrib
+  # WrapperComponent allwows to wrap any component with a custom HTML code.
+  # The whole wrapper is only rendered when the child component.render? returns true.
+  # Thus, wrapper could be used to conditionally render the outer html for components without
+  # conditionals in templates.
+  class WrapperComponent < ViewComponent::Base
+    class DoubleRenderError < StandardError
+      def initialize(component)
+        super("A child component could only be rendered once within a wrapper: #{component}")
+      end
+    end
+
+    attr_reader :component_instance
+
+    delegate :render?, to: :component_instance
+
+    def initialize(component)
+      @component_instance = component
+    end
+
+    # Simply return the contents of the block passed to #render_component.
+    # (Alias couldn't be used here 'cause ViewComponent check for the method presence when
+    # choosing between #call and a template.)
+    def call
+      content
+    end
+
+    # Returns rendered child component
+    # The name component is chosen for convienent usage in templates,
+    # so we can simply call `= wrapper.component` in the place where we're going
+    # to put the component
+    def component
+      raise DoubleRenderError, component_instance if @rendered
+
+      @rendered = component_instance.render_in(view_context).html_safe
+    end
+  end
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: view_component-contrib
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2021-04-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-next-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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: combustion
   requirement: !ruby/object:Gem::Requirement
@@ -39,33 +81,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  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-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
 description: A collection of extensions and developer tools for ViewComponent
 email:
 - dementiev.vm@gmail.com
@@ -76,9 +146,30 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- app/templates/install/application_view_component.rb
+- app/templates/install/application_view_component_preview.rb
+- app/templates/install/builder.rb
+- app/templates/install/class_for.rb
+- app/templates/install/generator.rb
+- app/templates/install/identifier.rb
+- app/templates/install/index.js
+- app/templates/install/index.stimulus.js
+- app/templates/install/initializer.rb
+- app/templates/install/postcss-modules.js
+- app/templates/install/template.rb
+- app/views/view_component_contrib/preview.html.erb
 - lib/view_component-contrib.rb
-- lib/view_component/contrib/railtie.rb
-- lib/view_component/contrib/version.rb
+- lib/view_component_contrib.rb
+- lib/view_component_contrib/base.rb
+- lib/view_component_contrib/preview.rb
+- lib/view_component_contrib/preview/abstract.rb
+- lib/view_component_contrib/preview/base.rb
+- lib/view_component_contrib/preview/default_template.rb
+- lib/view_component_contrib/preview/sidecarable.rb
+- lib/view_component_contrib/translation_helper.rb
+- lib/view_component_contrib/version.rb
+- lib/view_component_contrib/wrapped_helper.rb
+- lib/view_component_contrib/wrapper_component.rb
 homepage: http://github.com/palkan/view_component-contrib
 licenses:
 - MIT