optics_view_components 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a06b9454efef278cd56ab9a178e0aa4567f01db54119ad83e7d972c5a2fa232f
-  data.tar.gz: 3f0d0d5559526ba23baa50e88a4c84c4a38870e602013db702f1588be94d67e3
+  metadata.gz: 4a96cbd214ce4d3eb339e032c1c04ccc3435751f2618e5b41f9175114fd8e7de
+  data.tar.gz: 5d7edae41972ec1d189827dcdb71bdf0859cd26c7164f2de992ba282fc37df95
 SHA512:
-  metadata.gz: 872cb462157bc5b9bcf7e610aafdb91eb2a125c042e7e9049ed38ced9f0750e54e6c8da305c8b568663bea3b3b56b72e0c8902df14758a8cfced1d3baefb8688
-  data.tar.gz: c66b0e6b482134588976015aaabdec6997c763b54460d28215b03cfb31524eda90c2825b4f4488559a84b40707f035191fa1f31450d4fbed449dbb2fad9f7f36
+  metadata.gz: 9dc9e7910cdd85f698f9080704e2b16f5b8bc38e78509ddca578d7c8a4b35f9df810b06a04d6f19fe51471a81baaad88f9518a45d2091956c074117b042eaf04
+  data.tar.gz: fa393926ee1c68a2e14a6795f8b01c8a815aa0f324227e55df5df030e03afda1414c0cced29f4f632e56327ab5478e3925ff3315fecb3de8bc273f706a3e6ecb

data/.rubocop.yml

@@ -1,3 +1,4 @@
 AllCops:
   NewCops: enable
+  SuggestExtensions: false
   TargetRubyVersion: 3.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    optics_view_components (0.1.0)
+    optics_view_components (0.1.1)
       view_component (> 2.0, < 4.0)
 
 GEM

data/README.md

@@ -14,7 +14,17 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+Add to `config/application.rb`:
+
+```
+require 'optics/view_components'
+require 'optics/view_components/engine'
+```
+
+Use in a view:
+```
+<%= render(Optics::Button::Component.new(label: 'Hello')) %>
+```
 
 ## Development
 

data/Rakefile

@@ -7,6 +7,8 @@ RSpec::Core::RakeTask.new(:spec)
 
 require 'rubocop/rake_task'
 
-RuboCop::RakeTask.new
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--fail-level', 'warning', '--display-only-fail-level-offenses']
+end
 
 task default: %i[spec rubocop]

data/app/components/optics/application_view_component.rb

@@ -1,112 +1,116 @@
 # frozen_string_literal: true
 
-class Optics::ApplicationViewComponent < ViewComponent::Base
-  class_attribute :optional_attributes, default: {}
-  class_attribute :required_attributes, default: {}
+module Optics
+  class ApplicationViewComponent < ViewComponent::Base
+    class_attribute :optional_attributes, default: {}
+    class_attribute :required_attributes, default: {}
 
-  class << self
-    # To allow DB queries, put this in the class definition:
-    # self.allow_db_queries = true
-    attr_accessor :allow_db_queries
-    alias allow_db_queries? allow_db_queries
+    class << self
+      # To allow DB queries, put this in the class definition:
+      # self.allow_db_queries = true
+      attr_accessor :allow_db_queries
+      alias allow_db_queries? allow_db_queries
 
-    def requires(parameter, default: nil)
-      required_attributes[parameter] = default
+      def requires(parameter, default: nil)
+        required_attributes[parameter] = default
 
-      attr_reader parameter
-    end
+        attr_reader parameter
+      end
 
-    def accepts(parameter, default: nil)
-      optional_attributes[parameter] = default
+      def accepts(parameter, default: nil)
+        optional_attributes[parameter] = default
 
-      attr_reader parameter
+        attr_reader parameter
+      end
+
+      def inherited(subclass)
+        subclass.optional_attributes = optional_attributes.dup
+        subclass.required_attributes = required_attributes.dup
+        super
+      end
     end
 
-    def inherited(subclass)
-      subclass.optional_attributes = optional_attributes.dup
-      subclass.required_attributes = required_attributes.dup
+    def initialize(**attributes)
       super
-    end
-  end
 
-  def initialize(**attributes)
-    initialize_instance_variables(required_attributes, attributes) do |key, _default|
-      raise ArgumentError, "Missing keyword: :#{key}"
-    end
+      initialize_instance_variables(required_attributes, attributes) do |key, _default|
+        raise ArgumentError, "Missing keyword: :#{key}"
+      end
 
-    initialize_instance_variables(optional_attributes, attributes) do |key, default|
-      instance_variable_set("@#{key}", default)
-    end
+      initialize_instance_variables(optional_attributes, attributes) do |key, default|
+        instance_variable_set("@#{key}", default)
+      end
 
-    @attributes = attributes.except(*optional_attributes.keys, *required_attributes.keys)
-  end
+      @attributes = attributes.except(*optional_attributes.keys, *required_attributes.keys)
+    end
 
-  def class_for(name)
-    "c--#{identifier}--#{name}"
-  end
+    def class_for(name)
+      "c--#{identifier}--#{name}"
+    end
 
-  def container_class
-    "c--#{identifier}"
-  end
+    def container_class
+      "c--#{identifier}"
+    end
 
-  def class_names_for(*args)
-    class_names(*args).map { |name| class_for(name) }.join(' ')
-  end
+    def class_names_for(*args)
+      class_names(*args).map { |name| class_for(name) }.join(' ')
+    end
 
-  # Inspired by https://github.com/primer/view_components/blob/v0.1.9/app/lib/primer/class_name_helper.rb#L9
-  def class_names(*args) # rubocop:disable Metrics/MethodLength
-    [].tap do |classes|
-      args.each do |class_name|
-        case class_name
-        when String
-          classes << class_name
-        when Hash
-          class_name.each do |key, val|
-            classes << key if val
+    # Inspired by https://github.com/primer/view_components/blob/v0.1.9/app/lib/primer/class_name_helper.rb#L9
+    def class_names(*args) # rubocop:disable Metrics/MethodLength
+      [].tap do |classes|
+        args.each do |class_name|
+          case class_name
+          when String
+            classes << class_name
+          when Hash
+            class_name.each do |key, val|
+              classes << key if val
+            end
           end
         end
-      end
 
-      classes.compact!
-      classes.uniq!
+        classes.compact!
+        classes.uniq!
+      end
     end
-  end
 
-  # Used by Stimulus. E.g. data-controller=identifier => data-controller='dynamic-form--field'
-  def identifier
-    @identifier ||= self.class.name.sub('::Component', '').underscore.gsub('_', '-').gsub('/', '--')
-  end
+    # Used by Stimulus. E.g. data-controller=identifier => data-controller='dynamic-form--field'
+    def identifier
+      @identifier ||= self.class.name.sub('::Component', '').underscore.gsub('_', '-').gsub('/', '--')
+    end
 
-  # Helper for Stimulus data attributes
-  def data_for(method:, target:)
-    data_method(method).merge(data_target(target))
-  end
+    # Helper for Stimulus data attributes
+    def data_for(method:, target:)
+      data_method(method).merge(data_target(target))
+    end
 
-  # Helper for Stimulus controller method
-  def data_method(method, event: 'click')
-    { action: "#{event}->#{identifier}##{method}" }
-  end
+    # Helper for Stimulus controller method
+    def data_method(method, event: 'click')
+      { action: "#{event}->#{identifier}##{method}" }
+    end
 
-  # Helper for Stimulus controller target
-  def data_target(target)
-    { "#{identifier}": { target: } }
-  end
+    # Helper for Stimulus controller target
+    def data_target(target)
+      { "#{identifier}": { target: } }
+    end
 
-  # Helper for Stimulus controller value
-  def data_values(values)
-    values.transform_keys do |key|
-      "#{identifier}-#{key}-value"
+    # Helper for Stimulus controller value
+    def data_values(values)
+      values.transform_keys do |key|
+        "#{identifier}-#{key}-value"
+      end
     end
-  end
 
-  private
+    private
 
-  def initialize_instance_variables(configured_attributes, attributes)
-    configured_attributes.each do |key, default|
-      if attributes.key?(key)
-        instance_variable_set("@#{key}", attributes[key])
-      else
-        yield(key, default)
+    def initialize_instance_variables(configured_attributes, attributes)
+      configured_attributes.each do |key, default|
+        if attributes.key?(key)
+          instance_variable_set("@#{key}", attributes[key])
+        else
+          yield(key, default)
+        end
       end
     end
   end

data/app/components/optics/application_view_component_preview.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
-class Optics::ApplicationViewComponentPreview < ViewComponent::Preview
-  include ApplicationHelper
+module Optics
+  class ApplicationViewComponentPreview < ViewComponent::Preview
+    include ApplicationHelper
+  end
 end

data/app/components/optics/button/component.rb

@@ -19,8 +19,10 @@ module Optics
 
       def call
         build_button do
-          leading_icon
-          label
+          capture do
+            concat leading_icon
+            concat label
+          end
         end
       end
 

data/app/components/optics/button/preview.rb

@@ -11,14 +11,14 @@ module Optics
       # @param variant select {{ ::Button::Component::STYLES }}
       # @param url text
       def default( # rubocop:disable Metrics/ParameterLists
-            border: true,
-            icon: false,
-            id: nil,
-            label: 'Default',
-            size: 'normal',
-            variant: 'default',
-            url: nil
-          )
+        border: true,
+        icon: false,
+        id: nil,
+        label: 'Default',
+        size: 'normal',
+        variant: 'default',
+        url: nil
+      )
         render(Button::Component.new(
                  border:,
                  icon:,
@@ -26,7 +26,7 @@ module Optics
                  label:,
                  size:,
                  variant:,
-                 url:,
+                 url:
                ))
       end
     end

data/app/components/optics/icon/preview.rb

@@ -1,31 +1,33 @@
 # frozen_string_literal: true
 
-module Icon
-  class Preview < ViewComponent::Preview
-    # @param emphasis select {{ ::Icon::Component::EMPHASES }}
-    # @param filled toggle
-    # @param name
-    # @param size select {{ ::Icon::Component::SIZES }}
-    # @param title
-    # @param weight select {{ ::Icon::Component::WEIGHTS }}
-    def default( # rubocop:disable Metrics/ParameterLists
-      emphasis: 'normal',
-      filled: false,
-      name: 'settings',
-      size: 'normal',
-      title: nil,
-      weight: 'normal'
-    )
-      render(
-        Icon::Component.new(
-          emphasis:,
-          filled:,
-          name:,
-          size:,
-          title:,
-          weight:
-        )
+module Optics
+  module Icon
+    class Preview < ViewComponent::Preview
+      # @param emphasis select {{ ::Icon::Component::EMPHASES }}
+      # @param filled toggle
+      # @param name
+      # @param size select {{ ::Icon::Component::SIZES }}
+      # @param title
+      # @param weight select {{ ::Icon::Component::WEIGHTS }}
+      def default( # rubocop:disable Metrics/ParameterLists
+        emphasis: 'normal',
+        filled: false,
+        name: 'settings',
+        size: 'normal',
+        title: nil,
+        weight: 'normal'
       )
+        render(
+          Icon::Component.new(
+            emphasis:,
+            filled:,
+            name:,
+            size:,
+            title:,
+            weight:
+          )
+        )
+      end
     end
   end
 end

data/demo/Gemfile

@@ -18,4 +18,3 @@ end
 group :development do
   gem 'web-console'
 end
-

data/demo/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    optics_view_components (0.1.0)
+    optics_view_components (0.1.1)
       view_component (> 2.0, < 4.0)
 
 GEM
@@ -89,9 +89,6 @@ GEM
       activesupport (>= 5.0)
     i18n (1.13.0)
       concurrent-ruby (~> 1.0)
-    importmap-rails (1.1.6)
-      actionpack (>= 6.0.0)
-      railties (>= 6.0.0)
     io-console (0.6.0)
     irb (1.6.4)
       reline (>= 0.3.0)
@@ -187,7 +184,6 @@ DEPENDENCIES
   bootsnap
   cssbundling-rails (~> 1.1)
   debug
-  importmap-rails
   optics_view_components!
   puma (~> 6.0)
   rails (~> 7.0.4, >= 7.0.4.3)

data/demo/app/controllers/home_controller.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
+
 class HomeController < ApplicationController
-  def index
-  end
+  def index; end
 end

data/lib/optics/view_components/version.rb

@@ -2,6 +2,6 @@
 
 module Optics
   module ViewComponents
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optics_view_components
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Reed Law