view_component_storybook 0.8.0 → 0.9.0

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

@@ -3,7 +3,7 @@
 module ViewComponent
   module Storybook
     module Controls
-      class NumberConfig < ControlConfig
+      class NumberConfig < SimpleControlConfig
         TYPES = %i[number range].freeze
 
         attr_reader :type, :min, :max, :step
@@ -11,27 +11,27 @@ module ViewComponent
         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,16 +3,22 @@
 module ViewComponent
   module Storybook
     module Controls
-      class ObjectConfig < ControlConfig
+      class ObjectConfig < SimpleControlConfig
         def type
           :object
         end
 
-        def value_from_param(param)
-          if param.is_a?(String)
-            JSON.parse(param).deep_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,7 +3,7 @@
 module ViewComponent
   module Storybook
     module Controls
-      class OptionsConfig < ControlConfig
+      class OptionsConfig < SimpleControlConfig
         class << self
           # support the options being a Hash or an Array. Storybook supports either.
           def inclusion_in(config)
@@ -22,20 +22,21 @@ module ViewComponent
 
         validates :type, :options, presence: true
         validates :type, inclusion: { in: TYPES }, unless: -> { type.nil? }
-        validates :value, inclusion: { in: method(:inclusion_in) }, unless: -> { options.nil? || value.nil? }
+        validates :default_value, inclusion: { in: method(:inclusion_in) }, unless: -> { options.nil? || default_value.nil? }
 
-        def initialize(type, component, param, options, default_value, name: nil)
-          super(component, param, default_value, name: name)
+        def initialize(type, options, default_value, param: nil, name: nil)
+          super(default_value, param: param, name: name)
           @type = type
           @options = options
           @symbol_value = default_value.is_a?(Symbol)
         end
 
-        def value_from_param(param)
-          if param.is_a?(String) && symbol_value
-            param.to_sym
+        def value_from_params(params)
+          params_value = super(params)
+          if params_value.is_a?(String) && symbol_value
+            params_value.to_sym
           else
-            super(param)
+            params_value
           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[param]
+        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

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

@@ -3,7 +3,7 @@
 module ViewComponent
   module Storybook
     module Controls
-      class TextConfig < ControlConfig
+      class TextConfig < SimpleControlConfig
         def type
           :text
         end

data/lib/view_component/storybook/dsl.rb

@@ -9,6 +9,7 @@ module ViewComponent
 
       autoload :StoryDsl
       autoload :ControlsDsl
+      autoload :LegacyControlsDsl
     end
   end
 end

data/lib/view_component/storybook/dsl/controls_dsl.rb

@@ -3,95 +3,65 @@
 module ViewComponent
   module Storybook
     module Dsl
-      class ControlsDsl
-        attr_reader :component, :controls
-
-        def initialize(component)
-          @component = component
-          @controls = []
-        end
-
-        def text(param, value, name: nil)
-          controls << Controls::TextConfig.new(component, param, value, name: name)
-        end
-
-        def boolean(param, value, name: nil)
-          controls << Controls::BooleanConfig.new(component, param, value, name: name)
+      module ControlsDsl
+        def text(default_value)
+          Controls::TextConfig.new(default_value)
         end
 
-        def number(param, value, name: nil, min: nil, max: nil, step: nil)
-          controls << Controls::NumberConfig.new(:number, component, param, value, name: name, min: min, max: max, step: step)
+        def boolean(default_value)
+          Controls::BooleanConfig.new(default_value)
         end
 
-        def range(param, value, name: nil, min: nil, max: nil, step: nil)
-          controls << Controls::NumberConfig.new(:range, component, param, value, name: name, min: min, max: max, step: step)
+        def number(default_value, min: nil, max: nil, step: nil)
+          Controls::NumberConfig.new(:number, default_value, min: min, max: max, step: step)
         end
 
-        def color(param, value, name: nil, preset_colors: nil)
-          controls << Controls::ColorConfig.new(component, param, value, name: name, preset_colors: preset_colors)
+        def range(default_value, min: nil, max: nil, step: nil)
+          Controls::NumberConfig.new(:range, default_value, min: min, max: max, step: step)
         end
 
-        def object(param, value, name: nil)
-          controls << Controls::ObjectConfig.new(component, param, value, name: name)
+        def color(default_value, preset_colors: nil)
+          Controls::ColorConfig.new(default_value, preset_colors: preset_colors)
         end
 
-        def select(param, options, value, name: nil)
-          controls << Controls::OptionsConfig.new(:select, component, param, options, value, name: name)
+        def object(default_value)
+          Controls::ObjectConfig.new(default_value)
         end
 
-        def multi_select(param, options, value, name: nil)
-          controls << Controls::OptionsConfig.new(:'multi-select', component, param, options, value, name: name)
+        def select(options, default_value)
+          Controls::OptionsConfig.new(:select, options, default_value)
         end
 
-        def radio(param, options, value, name: nil)
-          controls << Controls::OptionsConfig.new(:radio, component, param, options, value, name: name)
+        def multi_select(options, default_value)
+          Controls::OptionsConfig.new(:'multi-select', options, default_value)
         end
 
-        def inline_radio(param, options, value, name: nil)
-          controls << Controls::OptionsConfig.new(:'inline-radio', component, param, options, value, name: name)
+        def radio(options, default_value)
+          Controls::OptionsConfig.new(:radio, options, default_value)
         end
 
-        def check(param, options, value, name: nil)
-          controls << Controls::OptionsConfig.new(:check, component, param, options, value, name: name)
+        def inline_radio(options, default_value)
+          Controls::OptionsConfig.new(:'inline-radio', options, default_value)
         end
 
-        def inline_check(param, options, value, name: nil)
-          controls << Controls::OptionsConfig.new(:'inline-check', component, param, options, value, name: name)
+        def check(options, default_value)
+          Controls::OptionsConfig.new(:check, options, default_value)
         end
 
-        def array(param, value, separator = ",", name: nil)
-          controls << Controls::ArrayConfig.new(component, param, value, separator, name: name)
+        def inline_check(options, default_value)
+          Controls::OptionsConfig.new(:'inline-check', options, default_value)
         end
 
-        def date(param, value, name: nil)
-          controls << Controls::DateConfig.new(component, param, value, name: name)
+        def array(default_value, separator = ",")
+          Controls::ArrayConfig.new(default_value, separator)
         end
 
-        def respond_to_missing?(_method, *)
-          true
+        def date(default_value)
+          Controls::DateConfig.new(default_value)
         end
 
-        def method_missing(method, *args)
-          value = args.first
-          control_method = case value
-                           when Date
-                             :date
-                           when Array
-                             :array
-                           when Hash
-                             :object
-                           when Numeric
-                             :number
-                           when TrueClass, FalseClass
-                             :boolean
-                           when String
-                             :text
-                           end
-          if control_method
-            send(control_method, method, *args)
-          else
-            super
-          end
+        def custom(*args, **kwargs, &block)
+          Controls::CustomConfig.new.with_value(*args, **kwargs, &block)
         end
 
         Controls = ViewComponent::Storybook::Controls

data/lib/view_component/storybook/dsl/legacy_controls_dsl.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    module Dsl
+      class LegacyControlsDsl
+        def controls
+          @controls ||= []
+        end
+
+        def text(param, value, name: nil)
+          controls << Controls::TextConfig.new(value, param: param, name: name)
+        end
+
+        def boolean(param, value, name: nil)
+          controls << Controls::BooleanConfig.new(value, param: param, name: name)
+        end
+
+        def number(param, value, name: nil, min: nil, max: nil, step: nil)
+          controls << Controls::NumberConfig.new(:number, value, param: param, name: name, min: min, max: max, step: step)
+        end
+
+        def range(param, value, name: nil, min: nil, max: nil, step: nil)
+          controls << Controls::NumberConfig.new(:range, value, param: param, name: name, min: min, max: max, step: step)
+        end
+
+        def color(param, value, name: nil, preset_colors: nil)
+          controls << Controls::ColorConfig.new(value, param: param, name: name, preset_colors: preset_colors)
+        end
+
+        def object(param, value, name: nil)
+          controls << Controls::ObjectConfig.new(value, param: param, name: name)
+        end
+
+        def select(param, options, value, name: nil)
+          controls << Controls::OptionsConfig.new(:select, options, value, param: param, name: name)
+        end
+
+        def multi_select(param, options, value, name: nil)
+          controls << Controls::OptionsConfig.new(:'multi-select', options, value, param: param, name: name)
+        end
+
+        def radio(param, options, value, name: nil)
+          controls << Controls::OptionsConfig.new(:radio, options, value, param: param, name: name)
+        end
+
+        def inline_radio(param, options, value, name: nil)
+          controls << Controls::OptionsConfig.new(:'inline-radio', options, value, param: param, name: name)
+        end
+
+        def check(param, options, value, name: nil)
+          controls << Controls::OptionsConfig.new(:check, options, value, param: param, name: name)
+        end
+
+        def inline_check(param, options, value, name: nil)
+          controls << Controls::OptionsConfig.new(:'inline-check', options, value, param: param, name: name)
+        end
+
+        def array(param, value, separator = ",", name: nil)
+          controls << Controls::ArrayConfig.new(value, separator, param: param, name: name)
+        end
+
+        def date(param, value, name: nil)
+          controls << Controls::DateConfig.new(value, param: param, name: name)
+        end
+
+        def respond_to_missing?(_method, *)
+          true
+        end
+
+        def method_missing(method, *args)
+          value = args.first
+          control_method = case value
+                           when Date
+                             :date
+                           when Array
+                             :array
+                           when Hash
+                             :object
+                           when Numeric
+                             :number
+                           when TrueClass, FalseClass
+                             :boolean
+                           when String
+                             :text
+                           end
+          if control_method
+            send(control_method, method, *args)
+          else
+            super
+          end
+        end
+
+        Controls = ViewComponent::Storybook::Controls
+      end
+    end
+  end
+end

data/lib/view_component/storybook/dsl/story_dsl.rb

@@ -4,28 +4,40 @@ module ViewComponent
   module Storybook
     module Dsl
       class StoryDsl
+        include ControlsDsl
+
         def self.evaluate!(story_config, &block)
           new(story_config).instance_eval(&block)
         end
 
         def parameters(**params)
-          @story_config.parameters = params
+          story_config.parameters = params
         end
 
         def controls(&block)
-          controls_dsl = ControlsDsl.new(story_config.component)
+          ActiveSupport::Deprecation.warn("`controls` will be removed in v1.0.0. Use `#constructor` instead.")
+          controls_dsl = LegacyControlsDsl.new
           controls_dsl.instance_eval(&block)
-          @story_config.controls = controls_dsl.controls
+
+          controls_hash = controls_dsl.controls.index_by(&:param)
+          story_config.constructor_args(**controls_hash)
         end
 
         def layout(layout)
-          @story_config.layout = layout
+          story_config.layout = layout
         end
 
         def content(&block)
-          @story_config.content_block = block
+          story_config.content_block = block
         end
 
+        def constructor(*args, **kwargs, &block)
+          story_config.constructor_args(*args, **kwargs)
+          story_config.content_block = block
+        end
+
+        delegate :component, to: :story_config
+
         private
 
         attr_reader :story_config