V1 api (#151)

Add v1 API as discussed in #150
jonspalmer · Jan 7, 2023 · 2781fb4 · 2781fb4
1 parent 7793928
commit 2781fb4
Show file tree

Hide file tree

Showing 101 changed files with 1,498 additions and 3,570 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -25,7 +25,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rails_version: [6.0.6, 6.1.7, 7.0.4, main]
+        rails_version: [6.0.6, 6.1.7, 7.0.4]
         ruby_version: [2.6.10, 2.7.7, 3.0.5, 3.1.3]
         exclude:
           - rails_version: 6.0.6
@@ -36,8 +36,8 @@ jobs:
             ruby_version: 2.5.9
           - rails_version: 7.0.4
             ruby_version: 2.6.10
-          - rails_version: main
-            ruby_version: 2.6.10
+          # - rails_version: main
+          #   ruby_version: 2.6.10
     steps:
     - uses: actions/checkout@master
     - name: Setup Ruby

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    view_component_storybook (0.12.1)
+    view_component-storybook (1.0.0)
       view_component (>= 2.54)
+      yard (~> 0.9.25)
 
 GEM
   remote: https://rubygems.org/
@@ -185,7 +186,7 @@ GEM
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
     rspec-support (3.12.0)
-    rubocop (1.40.0)
+    rubocop (1.41.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
@@ -232,11 +233,14 @@ GEM
       activesupport (>= 5.2.0, < 8.0)
       concurrent-ruby (~> 1.0)
       method_source (~> 1.0)
+    webrick (1.7.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
     zeitwerk (2.6.6)
 
 PLATFORMS
@@ -257,7 +261,7 @@ DEPENDENCIES
   simplecov (~> 0.21.2)
   simplecov-console (~> 0.9)
   sprockets-rails (~> 3.4.2)
-  view_component_storybook!
+  view_component-storybook!
 
 BUNDLED WITH
    2.3.26
diff --git a/app/controllers/view_component/storybook/stories_controller.rb b/app/controllers/view_component/storybook/stories_controller.rb
diff --git a/app/views/view_component/storybook/stories/show.html.erb b/app/views/view_component/storybook/stories/show.html.erb
diff --git a/config/locales/en.yml b/config/locales/en.yml
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -44,7 +44,7 @@ Last 0.x release
   * Klazz Control
 * Deprecated Controls DSL
 * Add support for Object Controls with array values
-* Remove ArrayConfig - array aliases ObjectConfig
+* Remove ArrayConfig - array aliases Object
 * Updated Options Control to match Storybook 6.2 syntax
   * `options` as array
   * add `labels` option
@@ -64,6 +64,6 @@ Last 0.x release
 
 ## 0.7.0
 
-* Add inclusion validation to NumberConfig type
-* Support ObjectConfigs with nested values
+* Add inclusion validation to Number type
+* Support Objects with nested values
 * Support nil control values
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -14,7 +14,7 @@ FOr local development this is typically:
 // .storybook/preview.js
 export const parameters = {
   server: {
-    url: `http://localhost:3000/rails/stories`,
+    url: `http://localhost:3000/rails/view_components`,
   },
 };
 ```
@@ -27,20 +27,22 @@ Story classes live in `test/components/stories`, which can be configured using t
 
 ```ruby
 # config/application.rb
-config.view_component_storybook.stories_path = Rails.root.join("spec/components/stories")
+config.view_component_storybook.stories_paths << Rails.root.join("spec/components/stories")
 ```
 
 ## Stories Route
 
-Stories are served from <http://localhost:3000/rails/stories> by default. To use a different endpoint, set the `stories_route` option:
+Stories are served from the same route as ViewComponent previews <http://localhost:3000/rails/view_components> by default. To use a different endpoint, set the ViewComponent `previews_route` option:
 
 ```ruby
 # config/application.rb
-config.view_component_storybook.stories_route = "/stories"
+config.view_component.preview_route = "/stories"
 ```
 
 This example will make the previews available from <http://localhost:3000/stories>.
 
+For more details see the [ViewCompontent `preview_route` documentation](https://viewcomponent.org/api.html#preview_route--string)
+
 ## Stories Title Generation
 
 You may wish to customize how the title of stories are generated, this can be done by setting a custom `stories_title_generator` lambda function:

diff --git a/docs/guide/constructor.md b/docs/guide/constructor.md