view_component_storybook 0.2.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 156bff92fe14404e71b45c20a0b989efaa70f0c1e01212c91f8db51a9b6399a4
-  data.tar.gz: fd5cc132d285d64bde3e742fcde2266cc4656ac67de921e54111d9d9ff0af93b
+  metadata.gz: 4e8c8a3875d64fe89649af8851324d2a07bd40868065abce8b57cf848cbeb5d3
+  data.tar.gz: 554f43665400373ba30b9bc6e307285843b67d3760e5957e0088fa2ba53b325e
 SHA512:
-  metadata.gz: 6dabe9bacc42870ad37ef82a8960ed926481a9e3b68bdf6e58c2f09ba89757ede25be1564c45efcdee99a814e5c69d0fda5d29a73573f67fb42587ea8a886a04
-  data.tar.gz: 78f94f84257b7b1ccebe85e38157bc37bc779c54cccee0909008d5e8d933f88934dabcb225fc9f2e45c4c108d2965cc0bdf2395e8b0b04d758c9afc18fb971d5
+  metadata.gz: 398124fee399213bea34acf3aef434877eb01d0c76d9d6f127f5d5493981ecf5ac1f0ddc94ad9850354f6ec3629f1a9e5ca6005b57208abd39d045026415abbd
+  data.tar.gz: 31a4a06293f40d19e575243a61cb61e1cff2bd7646da950c01de20f8edd73d1179970a7700064a8ee15cbcd3a73b2060f525bdbf427baeaddc9f9bd9ee6b7ebe

data/README.md

@@ -1,26 +1,26 @@
 # ViewComponent::Storybook
 
-The ViewComponent::Storybook gem provides Ruby api for writing stories describing [View Components](https://github.com/github/view_component) and allowing them to be previewed and tested in [Storybook](https://github.com/storybookjs/storybook/) 
+The ViewComponent::Storybook gem provides Ruby api for writing stories describing [View Components](https://github.com/github/view_component) and allowing them to be previewed and tested in [Storybook](https://github.com/storybookjs/storybook/)
 
 ## Features
 * A Ruby DSL for writing Stories describing View Components
-* A Rails controller backend for Storybook Server compatible with most Strobook Knobs Addon parameters
+* A Rails controller backend for Storybook Server compatible with Strobook Controls Addon parameters
 * Coming Soon: Rake tasks to watch View Components and Stories and trigger Storybook hot reloading
 
 ## Installation
 
-### Gem Installation 
+### Gem Installation
 
 1. Add the `view_component_storybook` gem, to your Gemfile: `gem 'view_component_storybook'`
 2. Run `bundle install`.
-3. Add `require "view_component_storybook/engine"` to `config/application.rb`
+3. Add `require "view_component/storybook/engine"` to `config/application.rb`
 4. Add `**/*.stories.json` to `.gitignore`
 
 ### Storybook Installation
 
-1. Add Storybook server as a dev dependedncy. The Storybook Knobs addon isn't needed but is strongly recommended
+1. Add Storybook server as a dev dependedncy. The Storybook Controls addon isn't needed but is strongly recommended
    ```sh
-   yarn add @storybook/server @storybook/addon-knobs --dev
+   yarn add @storybook/server @storybook/addon-controls --dev
    ```
 2. Add an NPM script to your package.json in order to start the storybook later in this guide
    ```json
@@ -29,29 +29,28 @@ The ViewComponent::Storybook gem provides Ruby api for writing stories describin
        "storybook": "start-storybook"
      }
    }
-   ```    
-3. Create the .storybook/main.js file to configure Storybook to find the json stories the gem creates. Also configure the knobs addon:
+   ```
+3. Create the .storybook/main.js file to configure Storybook to find the json stories the gem creates. Also configure the Controls addon:
    ```javascript
    module.exports = {
      stories: ['../test/components/**/*.stories.json'],
      addons: [
-       '@storybook/addon-knobs',
+       '@storybook/addon-controls',
      ],
    };
    ```
 4. Create the .storybook/preview.js file to configure Storybook with the Rails application url to call for the html content of the stories
    ```javascript
-   import { addParameters } from '@storybook/server';
 
-   addParameters({
+   export const parameters = {
      server: {
        url: `http://localhost:3000/rails/stories`,
      },
-   });
+   };
    ```
-   
 
-Note: `@storybook/server` will be part of the upcoming Storybook 6.0 release. Until that is released you'll need to use an [alpha release](https://github.com/storybookjs/storybook/releases/tag/v6.0.0-alpha.32)
+
+Note: `@storybook/server` will be part of the upcoming Storybook 6.0 release. Until that is released you'll need to use an [rc release](https://github.com/storybookjs/storybook/releases/tag/v6.0.0-rc.14)
 
 ## Usage
 
@@ -74,13 +73,13 @@ We can write a stories desecibing the `ButtonComponent`
 ```ruby
 class ButtonComponentStories < ViewComponent::Storybook::Stories
   story(:with_short_text) do
-    knobs do
+    controls do
       text(:button_text, 'OK')
     end
   end
 
   story(:with_long_text) do
-    knobs do
+    controls do
       text(:button_text, 'Push Me Please!')
     end
   end
@@ -121,7 +120,7 @@ Coming Soon
 
 #### Parameters
 #### Layout
-#### Knobs
+#### Controls
 
 
 ## Development

data/lib/view_component/storybook.rb

@@ -2,13 +2,12 @@
 
 require "active_model"
 require "active_support/dependencies/autoload"
-require "view_component/storybook/engine"
 
 module ViewComponent
   module Storybook
     extend ActiveSupport::Autoload
 
-    autoload :Knobs
+    autoload :Controls
     autoload :Stories
     autoload :StoryConfig
     autoload :Dsl

data/lib/view_component/storybook/{knobs.rb → controls.rb}

@@ -4,11 +4,13 @@ require "active_support/dependencies/autoload"
 
 module ViewComponent
   module Storybook
-    module Knobs
+    module Controls
       extend ActiveSupport::Autoload
 
-      autoload :KnobConfig
-      autoload :SimpleConfig
+      autoload :ControlConfig
+      autoload :TextConfig
+      autoload :BooleanConfig
+      autoload :ColorConfig
       autoload :NumberConfig
       autoload :OptionsConfig
       autoload :ArrayConfig

data/lib/view_component/storybook/{knobs → controls}/array_config.rb

@@ -2,21 +2,17 @@
 
 module ViewComponent
   module Storybook
-    module Knobs
-      class ArrayConfig < KnobConfig
+    module Controls
+      class ArrayConfig < ControlConfig
         attr_reader :separator
 
-        validates :value, :separator, presence: true
+        validates :separator, presence: true
 
-        def initialize(component, param, value, separator = ",", name: nil, group_id: nil)
-          super(component, param, value, name: name, group_id: group_id)
+        def initialize(component, param, value, separator = ",", name: nil)
+          super(component, param, value, name: name)
           @separator = separator
         end
 
-        def to_csf_params
-          super.merge(value: value, separator: separator)
-        end
-
         def type
           :array
         end
@@ -28,6 +24,12 @@ module ViewComponent
             super(param)
           end
         end
+
+        private
+
+        def csf_control_params
+          super.merge(separator: separator)
+        end
       end
     end
   end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    module Controls
+      class BooleanConfig < ControlConfig
+        BOOLEAN_VALUES = [true, false].freeze
+
+        validates :value, inclusion: { in: BOOLEAN_VALUES }, unless: -> { value.nil? }
+
+        def type
+          :boolean
+        end
+
+        def value_from_param(param)
+          if param.is_a?(String) && param.present?
+            case param
+            when "true"
+              true
+            when "false"
+              false
+            end
+          else
+            super(param)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    module Controls
+      class ColorConfig < ControlConfig
+        attr_reader :preset_colors
+
+        def initialize(component, param, value, name: nil, preset_colors: nil)
+          super(component, param, value, name: name)
+          @preset_colors = preset_colors
+        end
+
+        def type
+          :color
+        end
+
+        private
+
+        def csf_control_params
+          params = super
+          params.merge(presetColors: preset_colors).compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    module Controls
+      class ControlConfig
+        include ActiveModel::Validations
+
+        attr_reader :component, :param, :value, :name
+
+        validates :component, :param, presence: true
+        validates :param, inclusion: { in: ->(control_config) { control_config.component_param_names } }, if: :should_validate_params?
+
+        def initialize(component, param, value, name: nil)
+          @component = component
+          @param = param
+          @value = value
+          @name = name || param.to_s.humanize.titlecase
+        end
+
+        def to_csf_params
+          validate!
+          {
+            args: { param => csf_value },
+            argTypes: { param => { control: csf_control_params, name: name } }
+          }
+        end
+
+        def value_from_param(param)
+          param
+        end
+
+        def component_param_names
+          @component_param_names ||= component_params&.map(&:last)
+        end
+
+        private
+
+        # provide extension points for subclasses to vary the value
+        def csf_value
+          value
+        end
+
+        def csf_control_params
+          { type: type }
+        end
+
+        def component_accepts_kwargs?
+          component_params.map(&:first).include?(:keyrest)
+        end
+
+        def component_params
+          @component_params ||= component.instance_method(:initialize).parameters
+        end
+
+        def should_validate_params?
+          component.present? && !component_accepts_kwargs?
+        end
+      end
+    end
+  end
+end

data/lib/view_component/storybook/{knobs → controls}/date_config.rb

@@ -2,21 +2,10 @@
 
 module ViewComponent
   module Storybook
-    module Knobs
-      class DateConfig < KnobConfig
-        validates :value, presence: true
-
-        def initialize(component, param, value, name: nil, group_id: nil)
-          super(component, param, value, name: name, group_id: group_id)
-        end
-
-        def to_csf_params
-          csf_params = super
-          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)
-          csf_params[:value] = params_value
-          csf_params
+    module Controls
+      class DateConfig < ControlConfig
+        def initialize(component, param, value, name: nil)
+          super(component, param, value, name: name)
         end
 
         def type
@@ -30,6 +19,15 @@ module ViewComponent
             super(param)
           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
+        end
       end
     end
   end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    module Controls
+      class NumberConfig < ControlConfig
+        TYPES = %i[number range].freeze
+
+        attr_reader :type, :min, :max, :step
+
+        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)
+          @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
+          else
+            super(param)
+          end
+        end
+
+        private
+
+        def csf_control_params
+          params = super
+          params.merge(min: min, max: max, step: step).compact
+        end
+      end
+    end
+  end
+end

data/lib/view_component/storybook/{knobs → controls}/object_config.rb

@@ -2,17 +2,15 @@
 
 module ViewComponent
   module Storybook
-    module Knobs
-      class ObjectConfig < KnobConfig
-        validates :value, presence: true
-
+    module Controls
+      class ObjectConfig < ControlConfig
         def type
           :object
         end
 
         def value_from_param(param)
           if param.is_a?(String)
-            JSON.parse(param).symbolize_keys
+            JSON.parse(param).deep_symbolize_keys
           else
             super(param)
           end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    module Controls
+      class OptionsConfig < ControlConfig
+        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
+            end
+          end
+        end
+
+        TYPES = %i[select multi-select radio inline-radio check inline-check].freeze
+
+        attr_reader :type, :options, :symbol_value
+
+        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? }
+
+        def initialize(type, component, param, options, default_value, name: nil)
+          super(component, param, default_value, 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
+          else
+            super(param)
+          end
+        end
+
+        private
+
+        def csf_control_params
+          super.merge(options: options)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    module Controls
+      class TextConfig < ControlConfig
+        def type
+          :text
+        end
+      end
+    end
+  end
+end

data/lib/view_component/storybook/dsl.rb

@@ -8,7 +8,7 @@ module ViewComponent
       extend ActiveSupport::Autoload
 
       autoload :StoryDsl
-      autoload :KnobsDsl
+      autoload :ControlsDsl
     end
   end
 end

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

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+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)
+        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)
+        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)
+        end
+
+        def color(param, value, name: nil, preset_colors: nil)
+          controls << Controls::ColorConfig.new(component, param, value, name: name, preset_colors: preset_colors)
+        end
+
+        def object(param, value, name: nil)
+          controls << Controls::ObjectConfig.new(component, param, value, name: name)
+        end
+
+        def select(param, options, value, name: nil)
+          controls << Controls::OptionsConfig.new(:select, component, param, options, value, name: name)
+        end
+
+        def multi_select(param, options, value, name: nil)
+          controls << Controls::OptionsConfig.new(:'multi-select', component, param, options, value, name: name)
+        end
+
+        def radio(param, options, value, name: nil)
+          controls << Controls::OptionsConfig.new(:radio, component, param, options, value, name: name)
+        end
+
+        def inline_radio(param, options, value, name: nil)
+          controls << Controls::OptionsConfig.new(:'inline-radio', component, param, options, value, name: name)
+        end
+
+        def check(param, options, value, name: nil)
+          controls << Controls::OptionsConfig.new(:check, component, param, options, value, name: name)
+        end
+
+        def inline_check(param, options, value, name: nil)
+          controls << Controls::OptionsConfig.new(:'inline-check', component, param, options, value, name: name)
+        end
+
+        def array(param, value, separator = ",", name: nil)
+          controls << Controls::ArrayConfig.new(component, param, value, separator, name: name)
+        end
+
+        def date(param, value, name: nil)
+          controls << Controls::DateConfig.new(component, param, value, 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

@@ -12,10 +12,10 @@ module ViewComponent
           @story_config.parameters = params
         end
 
-        def knobs(&block)
-          knobs_dsl = KnobsDsl.new(story_config.component)
-          knobs_dsl.instance_eval(&block)
-          @story_config.knobs = knobs_dsl.knobs
+        def controls(&block)
+          controls_dsl = ControlsDsl.new(story_config.component)
+          controls_dsl.instance_eval(&block)
+          @story_config.controls = controls_dsl.controls
         end
 
         def layout(layout)

data/lib/view_component/storybook/stories.rb

@@ -26,17 +26,14 @@ module ViewComponent
         end
 
         def to_csf_params
-          stories_csf = story_configs.map(&:to_csf_params)
-
           csf_params = { title: title }
-          csf_params[:addons] = ["knobs"] if stories_csf.any? { |csf| csf.key?(:knobs) }
           csf_params[:parameters] = parameters if parameters.present?
           csf_params[:stories] = story_configs.map(&:to_csf_params)
           csf_params
         end
 
         def write_csf_json
-          json_path = File.join(ViewComponent::Storybook.stories_path, "#{stories_name}.stories.json")
+          json_path = File.join(stories_path, "#{stories_name}.stories.json")
           File.open(json_path, "w") do |f|
             f.write(JSON.pretty_generate(to_csf_params))
           end
@@ -84,8 +81,6 @@ module ViewComponent
 
         def default_component
           name.chomp("Stories").constantize
-        rescue StandardError
-          nil
         end
 
         def load_stories
@@ -96,10 +91,6 @@ module ViewComponent
           Storybook.stories_path
         end
 
-        def show_stories
-          Storybook.show_stories
-        end
-
         def story_id(name)
           "#{stories_name}/#{name.to_s.parameterize}".underscore
         end

data/lib/view_component/storybook/story_config.rb

@@ -6,28 +6,30 @@ module ViewComponent
       include ActiveModel::Validations
 
       attr_reader :id, :name, :component
-      attr_accessor :knobs, :parameters, :layout, :content_block
+      attr_accessor :controls, :parameters, :layout, :content_block
 
       def initialize(id, name, component, layout)
         @id = id
         @name = name
         @component = component
         @layout = layout
-        @knobs = []
+        @controls = []
       end
 
       def to_csf_params
         csf_params = { name: name, parameters: { server: { id: id } } }
         csf_params.deep_merge!(parameters: parameters) if parameters.present?
-        csf_params[:knobs] = knobs.map(&:to_csf_params) if knobs.present?
+        controls.each do |control|
+          csf_params.deep_merge!(control.to_csf_params)
+        end
         csf_params
       end
 
       def values_from_params(params)
-        knobs.map do |knob|
-          value = knob.value_from_param(params[knob.param])
-          value = knob.value if value.nil? # nil only not falsey
-          [knob.param, value]
+        controls.map do |control|
+          value = control.value_from_param(params[control.param])
+          value = control.value if value.nil? # nil only not falsey
+          [control.param, value]
         end.to_h
       end
 

data/lib/view_component/storybook/version.rb

@@ -2,6 +2,6 @@
 
 module ViewComponent
   module Storybook
-    VERSION = "0.2.0"
+    VERSION = "0.8.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_storybook
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Jon Palmer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-25 00:00:00.000000000 Z
+date: 2021-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: view_component
@@ -100,42 +100,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.81'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.81'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.2
+        version: 2.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.2
+        version: 2.9.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.38'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.38'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Generate Storybook CSF JSON for rendering Rails View Components in Storybook
 email:
 - 328224+jonspalmer@users.noreply.github.com
@@ -162,18 +176,20 @@ files:
 - app/controllers/view_component/storybook/stories_controller.rb
 - app/views/view_component/storybook/stories/show.html.erb
 - lib/view_component/storybook.rb
+- lib/view_component/storybook/controls.rb
+- lib/view_component/storybook/controls/array_config.rb
+- lib/view_component/storybook/controls/boolean_config.rb
+- lib/view_component/storybook/controls/color_config.rb
+- lib/view_component/storybook/controls/control_config.rb
+- lib/view_component/storybook/controls/date_config.rb
+- lib/view_component/storybook/controls/number_config.rb
+- lib/view_component/storybook/controls/object_config.rb
+- lib/view_component/storybook/controls/options_config.rb
+- lib/view_component/storybook/controls/text_config.rb
 - lib/view_component/storybook/dsl.rb
-- lib/view_component/storybook/dsl/knobs_dsl.rb
+- lib/view_component/storybook/dsl/controls_dsl.rb
 - lib/view_component/storybook/dsl/story_dsl.rb
 - lib/view_component/storybook/engine.rb
-- lib/view_component/storybook/knobs.rb
-- lib/view_component/storybook/knobs/array_config.rb
-- lib/view_component/storybook/knobs/date_config.rb
-- lib/view_component/storybook/knobs/knob_config.rb
-- lib/view_component/storybook/knobs/number_config.rb
-- lib/view_component/storybook/knobs/object_config.rb
-- lib/view_component/storybook/knobs/options_config.rb
-- lib/view_component/storybook/knobs/simple_config.rb
 - lib/view_component/storybook/stories.rb
 - lib/view_component/storybook/story_config.rb
 - lib/view_component/storybook/tasks/write_stories_json.rake
@@ -193,7 +209,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

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

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module Storybook
-    module Dsl
-      class KnobsDsl
-        attr_reader :component, :knobs
-
-        def initialize(component)
-          @component = component
-          @knobs = []
-        end
-
-        def text(param, value, group_id: nil, name: nil)
-          knobs << Knobs::SimpleConfig.new(:text, component, param, value, group_id: group_id, name: name)
-        end
-
-        def boolean(param, value, group_id: nil, name: nil)
-          knobs << Knobs::SimpleConfig.new(:boolean, component, param, value, group_id: group_id, name: name)
-        end
-
-        def number(param, value, options = {}, group_id: nil, name: nil)
-          knobs << Knobs::NumberConfig.new(component, param, value, options, group_id: group_id, name: name)
-        end
-
-        def color(param, value, group_id: nil, name: nil)
-          knobs << Knobs::SimpleConfig.new(:color, component, param, value, group_id: group_id, name: name)
-        end
-
-        def object(param, value, group_id: nil, name: nil)
-          knobs << Knobs::ObjectConfig.new(component, param, value, group_id: group_id, name: name)
-        end
-
-        def select(param, options, value, group_id: nil, name: nil)
-          knobs << Knobs::OptionsConfig.new(:select, component, param, options, value, group_id: group_id, name: name)
-        end
-
-        def radios(param, options, value, group_id: nil, name: nil)
-          knobs << Knobs::OptionsConfig.new(:radios, component, param, options, value, group_id: group_id, name: name)
-        end
-
-        def array(param, value, separator = ",", group_id: nil, name: nil)
-          knobs << Knobs::ArrayConfig.new(component, param, value, separator, group_id: group_id, name: name)
-        end
-
-        def date(param, value, group_id: nil, name: nil)
-          knobs << Knobs::DateConfig.new(component, param, value, group_id: group_id, name: name)
-        end
-
-        def respond_to_missing?(_method)
-          true
-        end
-
-        def method_missing(method, *args)
-          value = args.first
-          knob_method = case value
-                        when Date
-                          :date
-                        when Array
-                          :array
-                        when Hash
-                          :object
-                        when Numeric
-                          :number
-                        when TrueClass, FalseClass
-                          :boolean
-                        when String
-                          :text
-                        end
-          if knob_method
-            send(knob_method, method, *args)
-          else
-            super
-          end
-        end
-
-        Knobs = ViewComponent::Storybook::Knobs
-      end
-    end
-  end
-end

data/lib/view_component/storybook/knobs/knob_config.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module Storybook
-    module Knobs
-      class KnobConfig
-        include ActiveModel::Validations
-
-        attr_reader :component, :param, :value, :name, :group_id
-
-        validates :component, :param, presence: true
-        validates :param, inclusion: { in: ->(knob_config) { knob_config.component_params } }, unless: -> { component.nil? }
-
-        def initialize(component, param, value, name: nil, group_id: nil)
-          @component = component
-          @param = param
-          @value = value
-          @name = name || param.to_s.humanize.titlecase
-          @group_id = group_id
-        end
-
-        def to_csf_params
-          validate!
-          params = { type: type, param: param, name: name, value: value }
-          params[:group_id] = group_id if group_id
-          params
-        end
-
-        def value_from_param(param)
-          param
-        end
-
-        def component_params
-          @component_params ||= component && component.instance_method(:initialize).parameters.map(&:last)
-        end
-      end
-    end
-  end
-end

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

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module Storybook
-    module Knobs
-      class NumberConfig < KnobConfig
-        attr_reader :options
-
-        validates :value, presence: true
-
-        def initialize(component, param, value, options = {}, name: nil, group_id: nil)
-          super(component, param, value, name: name, group_id: group_id)
-          @options = options
-        end
-
-        def type
-          :number
-        end
-
-        def to_csf_params
-          params = super
-          params[:options] = options unless options.empty?
-          params
-        end
-
-        def value_from_param(param)
-          if param.is_a?(String) && param.present?
-            (param.to_f % 1) > 0 ? param.to_f : param.to_i
-          else
-            super(param)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module Storybook
-    module Knobs
-      class OptionsConfig < KnobConfig
-        TYPES = %i[select radios].freeze
-
-        attr_reader :type, :options
-
-        validates :value, :type, :options, presence: true
-        validates :type, inclusion: { in: TYPES }, unless: -> { type.nil? }
-        validates :value, inclusion: { in: ->(config) { config.options.values } }, unless: -> { options.nil? || value.nil? }
-
-        def initialize(type, component, param, options, default_value, name: nil, group_id: nil)
-          super(component, param, default_value, name: name, group_id: group_id)
-          @type = type
-          @options = options
-        end
-
-        def to_csf_params
-          super.merge(options: options)
-        end
-      end
-    end
-  end
-end

data/lib/view_component/storybook/knobs/simple_config.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module Storybook
-    module Knobs
-      class SimpleConfig < KnobConfig
-        TYPES = %i[text boolean color].freeze
-        BOOLEAN_VALUES = [true, false].freeze
-
-        attr_reader :type
-
-        validates :value, presence: true, unless: -> { type == :boolean }
-        validates :value, inclusion: { in: BOOLEAN_VALUES }, if: -> { type == :boolean }
-
-        validates :type, presence: true
-        validates :type, inclusion: { in: TYPES }, unless: -> { type.nil? }
-
-        def initialize(type, component, param, value, name: nil, group_id: nil)
-          super(component, param, value, name: name, group_id: group_id)
-          @type = type
-        end
-
-        def value_from_param(param)
-          if type == :boolean && param.is_a?(String) && param.present?
-            case param
-            when "true"
-              true
-            when "false"
-              false
-            end
-          else
-            super(param)
-          end
-        end
-      end
-    end
-  end
-end