view_component_storybook 0.5.0 → 0.10.0

data/lib/view_component/storybook/controls/control_config.rb

@@ -6,43 +6,43 @@ module ViewComponent
       class ControlConfig
         include ActiveModel::Validations
 
-        attr_reader :component, :param, :value, :name
+        validates :param, presence: true
 
-        validates :component, :param, presence: true
-        validates :param, inclusion: { in: ->(control_config) { control_config.component_params } }, unless: -> { component.nil? }
-
-        def initialize(component, param, value, name: nil)
-          @component = component
+        def initialize(param: nil, name: nil)
           @param = param
-          @value = value
-          @name = name || param.to_s.humanize.titlecase
+          @name = name
         end
 
-        def to_csf_params
-          validate!
-          {
-            args: { param => csf_value },
-            argTypes: { param => { control: csf_control_params, name: name } }
-          }
+        def name(new_name = nil)
+          if new_name.nil?
+            @name ||= param.to_s.humanize.titlecase
+          else
+            @name = new_name
+            self
+          end
         end
 
-        def value_from_param(param)
-          param
-        end
+        def param(new_param = nil)
+          return @param if new_param.nil?
 
-        def component_params
-          @component_params ||= component && component.instance_method(:initialize).parameters.map(&:last)
+          @param = new_param
+          self
         end
 
-        private
+        def prefix_param(prefix)
+          param("#{prefix}__#{@param}".to_sym)
+        end
 
-        # provide extension points for subclasses to vary the value
-        def csf_value
-          value
+        def to_csf_params
+          # :nocov:
+          raise NotImplementedError
+          # :nocov:
         end
 
-        def csf_control_params
-          { type: type }
+        def value_from_params(params)
+          # :nocov:
+          raise NotImplementedError
+          # :nocov:
         end
       end
     end

data/lib/view_component/storybook/controls/controls_helpers.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    module Controls
+      module ControlsHelpers
+        def text(default_value)
+          Controls::TextConfig.new(default_value)
+        end
+
+        def boolean(default_value)
+          Controls::BooleanConfig.new(default_value)
+        end
+
+        def number(default_value, min: nil, max: nil, step: nil)
+          Controls::NumberConfig.new(:number, default_value, min: min, max: max, step: step)
+        end
+
+        def range(default_value, min: nil, max: nil, step: nil)
+          Controls::NumberConfig.new(:range, default_value, min: min, max: max, step: step)
+        end
+
+        def color(default_value, preset_colors: nil)
+          Controls::ColorConfig.new(default_value, preset_colors: preset_colors)
+        end
+
+        def object(default_value)
+          Controls::ObjectConfig.new(default_value)
+        end
+
+        def select(options, default_value, labels: nil)
+          Controls::OptionsConfig.new(:select, options, default_value, labels: labels)
+        end
+
+        def multi_select(options, default_value, labels: nil)
+          Controls::MultiOptionsConfig.new(:'multi-select', options, default_value, labels: labels)
+        end
+
+        def radio(options, default_value, labels: nil)
+          Controls::OptionsConfig.new(:radio, options, default_value, labels: labels)
+        end
+
+        def inline_radio(options, default_value, labels: nil)
+          Controls::OptionsConfig.new(:'inline-radio', options, default_value, labels: labels)
+        end
+
+        def check(options, default_value, labels: nil)
+          Controls::MultiOptionsConfig.new(:check, options, default_value, labels: labels)
+        end
+
+        def inline_check(options, default_value)
+          Controls::MultiOptionsConfig.new(:'inline-check', options, default_value)
+        end
+
+        def array(default_value, separator = nil)
+          ActiveSupport::Deprecation.warn("`array` `separator` argument will be removed in v1.0.0.") if separator
+          Controls::ObjectConfig.new(default_value)
+        end
+
+        def date(default_value)
+          Controls::DateConfig.new(default_value)
+        end
+
+        def custom(*args, **kwargs, &block)
+          Controls::CustomConfig.new.with_value(*args, **kwargs, &block)
+        end
+
+        def klazz(value_class, *args, **kwargs)
+          Controls::CustomConfig.new.with_value(*args, **kwargs) do |*a, **kwa|
+            value_class.new(*a, **kwa)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/view_component/storybook/controls/custom_config.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    module Controls
+      class CustomConfig < ControlConfig
+        attr_reader :value_method_args
+
+        validate :validate_value_method_args
+
+        def with_value(*args, **kwargs, &block)
+          @value_method_args = MethodArgs::ControlMethodArgs.new(block, *args, **kwargs)
+          @value_method_args.with_param_prefix(param)
+          self
+        end
+
+        def param(new_param = nil)
+          value_method_args.with_param_prefix(new_param) unless new_param.nil?
+          super(new_param)
+        end
+
+        def to_csf_params
+          validate!
+          # TODO: Figure out if we can use 'category' with the args table
+          # export default {
+          #   argTypes: {
+          #     foo: {
+          #       table: { category: 'cat', subcategory: 'sub' }
+          #     }
+          #   }
+          # }
+          value_method_args.controls.reduce({}) do |csf_params, control|
+            csf_params.deep_merge(control.to_csf_params)
+          end
+        end
+
+        def value_from_params(params)
+          value_method_args.call(params)
+        end
+
+        private
+
+        def validate_value_method_args
+          return if value_method_args.valid?
+
+          value_method_args_errors = value_method_args.errors.full_messages.join(', ')
+          errors.add(:value_method_args, :invalid, errors: value_method_args_errors)
+        end
+      end
+    end
+  end
+end

data/lib/view_component/storybook/controls/date_config.rb

@@ -3,32 +3,33 @@
 module ViewComponent
   module Storybook
     module Controls
-      class DateConfig < ControlConfig
-        validates :value, presence: true
-
-        def initialize(component, param, value, name: nil)
-          super(component, param, value, name: name)
+      class DateConfig < SimpleControlConfig
+        def initialize(default_value, param: nil, name: nil)
+          super(default_value, param: param, name: name)
         end
 
         def type
           :date
         end
 
-        def value_from_param(param)
-          if param.is_a?(String)
-            DateTime.iso8601(param)
+        def value_from_params(params)
+          params_value = super(params)
+          if params_value.is_a?(String)
+            DateTime.iso8601(params_value)
           else
-            super(param)
+            params_value
           end
         end
 
         private
 
         def csf_value
-          params_value = value
-          params_value = params_value.in_time_zone if params_value.is_a?(Date)
-          params_value = params_value.iso8601 if params_value.is_a?(Time)
-          params_value
+          case default_value
+          when Date
+            default_value.in_time_zone
+          when Time
+            default_value.iso8601
+          end
         end
       end
     end

data/lib/view_component/storybook/controls/multi_options_config.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    module Controls
+      class MultiOptionsConfig < BaseOptionsConfig
+        TYPES = %i[multi-select check inline-check].freeze
+
+        validates :type, inclusion: { in: TYPES }, unless: -> { type.nil? }
+        validate :validate_default_value, unless: -> { options.nil? || default_value.nil? }
+
+        def initialize(type, options, default_value, labels: nil, param: nil, name: nil)
+          super(type, options, Array.wrap(default_value), labels: labels, param: param, name: name)
+        end
+
+        def value_from_params(params)
+          params_value = super(params)
+
+          if params_value.is_a?(String)
+            params_value = params_value.split(',')
+            params_value = params_value.map(&:to_sym) if symbol_values
+          end
+          params_value
+        end
+
+        def to_csf_params
+          super.deep_merge(argTypes: { param => { options: options } })
+        end
+
+        private
+
+        def csf_control_params
+          labels.nil? ? super : super.merge(labels: labels)
+        end
+
+        def symbol_values
+          @symbol_values ||= default_value.first.is_a?(Symbol)
+        end
+
+        def validate_default_value
+          errors.add(:default_value, :inclusion) unless default_value.to_set <= options.to_set
+        end
+      end
+    end
+  end
+end

data/lib/view_component/storybook/controls/number_config.rb

@@ -3,32 +3,35 @@
 module ViewComponent
   module Storybook
     module Controls
-      class NumberConfig < ControlConfig
+      class NumberConfig < SimpleControlConfig
+        TYPES = %i[number range].freeze
+
         attr_reader :type, :min, :max, :step
 
-        validates :value, :type, presence: true
+        validates :type, presence: true
+        validates :type, inclusion: { in: TYPES }, unless: -> { type.nil? }
 
-        def initialize(type, component, param, value, min: nil, max: nil, step: nil, name: nil)
-          super(component, param, value, name: name)
+        def initialize(type, default_value, min: nil, max: nil, step: nil, param: nil, name: nil)
+          super(default_value, param: param, name: name)
           @type = type
           @min = min
           @max = max
           @step = step
         end
 
-        def value_from_param(param)
-          if param.is_a?(String) && param.present?
-            (param.to_f % 1) > 0 ? param.to_f : param.to_i
+        def value_from_params(params)
+          params_value = super(params)
+          if params_value.is_a?(String) && params_value.present?
+            (params_value.to_f % 1) > 0 ? params_value.to_f : params_value.to_i
           else
-            super(param)
+            params_value
           end
         end
 
         private
 
         def csf_control_params
-          params = super
-          params.merge(min: min, max: max, step: step).compact
+          super.merge(min: min, max: max, step: step).compact
         end
       end
     end

data/lib/view_component/storybook/controls/object_config.rb

@@ -3,18 +3,22 @@
 module ViewComponent
   module Storybook
     module Controls
-      class ObjectConfig < ControlConfig
-        validates :value, presence: true
-
+      class ObjectConfig < SimpleControlConfig
         def type
           :object
         end
 
-        def value_from_param(param)
-          if param.is_a?(String)
-            JSON.parse(param).symbolize_keys
+        def value_from_params(params)
+          params_value = super(params)
+          if params_value.is_a?(String)
+            parsed_json = JSON.parse(params_value)
+            if parsed_json.is_a?(Array)
+              parsed_json.map(&:deep_symbolize_keys)
+            else
+              parsed_json.deep_symbolize_keys
+            end
           else
-            super(param)
+            params_value
           end
         end
       end

data/lib/view_component/storybook/controls/options_config.rb

@@ -3,40 +3,33 @@
 module ViewComponent
   module Storybook
     module Controls
-      class OptionsConfig < ControlConfig
+      class OptionsConfig < BaseOptionsConfig
+        TYPES = %i[select radio inline-radio].freeze
 
-        class << self
-          # support the options being a Hash or an Array. Storybook supports either.
-          def inclusion_in(config)
-            case config.options
-            when Hash
-              config.options.values
-            when Array
-              config.options
-            else
-              []
-            end
+        validates :type, inclusion: { in: TYPES }, unless: -> { type.nil? }
+        validates :default_value, inclusion: { in: ->(config) { config.options } }, unless: -> { options.nil? || default_value.nil? }
+
+        def value_from_params(params)
+          params_value = super(params)
+          if params_value.is_a?(String) && symbol_value
+            params_value.to_sym
+          else
+            params_value
           end
         end
 
-        TYPES = %i[select multi-select radio inline-radio check inline-check].freeze
-
-        attr_reader :type, :options
-
-        validates :value, :type, :options, presence: true
-        validates :type, inclusion: { in: TYPES }, unless: -> { type.nil? }
-        validates :value, inclusion: { in: method(:inclusion_in) }, unless: -> { options.nil? || value.nil? }
-
-        def initialize(type, component, param, options, default_value, name: nil)
-          super(component, param, default_value, name: name)
-          @type = type
-          @options = options
+        def to_csf_params
+          super.deep_merge(argTypes: { param => { options: options } })
         end
 
         private
 
         def csf_control_params
-          super.merge(options: options)
+          labels.nil? ? super : super.merge(labels: labels)
+        end
+
+        def symbol_value
+          @symbol_value ||= default_value.is_a?(Symbol)
         end
       end
     end

data/lib/view_component/storybook/controls/simple_control_config.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    module Controls
+      ##
+      # A simple Control Config maps to one Storybook Control
+      # It has a value and pulls its value from params by key
+      class SimpleControlConfig < ControlConfig
+        attr_reader :default_value
+
+        def initialize(default_value, param: nil, name: nil)
+          super(param: param, name: name)
+          @default_value = default_value
+        end
+
+        def to_csf_params
+          validate!
+          {
+            args: { param => csf_value },
+            argTypes: { param => { control: csf_control_params, name: name } }
+          }
+        end
+
+        def value_from_params(params)
+          params.key?(param) ? params[param] : default_value
+        end
+
+        private
+
+        # provide extension points for subclasses to vary the value
+        def type
+          # :nocov:
+          raise NotImplementedError
+          # :nocov:
+        end
+
+        def csf_value
+          default_value
+        end
+
+        def csf_control_params
+          { type: type }
+        end
+      end
+    end
+  end
+end