showcase-rails 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3acbdb8f9aafaadded728f1f43bd2b834424a9ccd764605a093f3fa08019b9e7
-  data.tar.gz: 5fe6fde3e533bb60540ea1b47b69953de2d40234560f2b55cdb47bab43e9ed37
+  metadata.gz: 151c0562d98ae25ac207acf0921c0f299fb60ca37ca325b6f2ccc117e32ed09b
+  data.tar.gz: 5d532b1992e910ff03a4e4bde0ae41c1e32d83c3e58a17be68378d0e6b6380a1
 SHA512:
-  metadata.gz: fd7b71e810edb02e6f411f628ed80745944b36c920e7c86588b42544575fb8805a97e35bb30119b3d3a02ea9c127b8ced65d44a61808e5c30046e8ac90253719
-  data.tar.gz: a5ef78400af5a631f38c57a51bc2ea900007213d6fe018da459b7d104d8f36132d8c7a51f3c8a8d3a078b4d4f837110bf0ffaf777a5885b15ea8a18061965318
+  metadata.gz: 6c65a5683153a76fe6410ab0e4140b311100ea5843da37a056f3ae70f02a13565ee58e2f9624d07a8969f8676093a59eab30bdf69b6a2d9d06852b8ab9640d6a
+  data.tar.gz: 77d2f23c5f9a0871f14713d46637bb326d48b9caa8610cf50654f5da05092d062d3ba0dd03500678e0af1902573b6c79f8c12e8998cbcd6ae3aa313fbda5ec58

data/README.md

@@ -111,6 +111,18 @@ class ShowcaseTest < Showcase::PreviewsTest
 end
 ```
 
+## Linking to previews
+
+Call `showcase.link_to` with the URL path to the other Showcase:
+
+```erb
+<%= showcase.link_to "stimulus_controllers/welcome" %>
+<%= showcase.link_to "components/button", id: "extra-large" %> <%# Pass an id to link to a specific sample %>
+
+<%# You can also pass just an id: to target a sample on the current showcase %>
+<%= showcase.link_to id: "extra-large" %>
+```
+
 ## Full Rails engine support
 
 Any Rails engines in your app that ships previews in their `app/views/showcase/previews` directory will automatically be surfaced in your app. Here's an example from the [bullet_train-themes-light Rails engine](https://github.com/bullet-train-co/bullet_train-core/tree/main/bullet_train-themes-light/app/views/showcase/previews).

data/app/assets/builds/showcase.css

@@ -916,6 +916,10 @@ select {
   padding-top: 1.75rem;
 }
 
+.sc-font-mono {
+  font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;
+}
+
 .sc-text-2xl {
   font-size: 1.5rem;
   line-height: 2rem;
@@ -931,6 +935,11 @@ select {
   line-height: 1.5rem;
 }
 
+.sc-text-sm {
+  font-size: 0.875rem;
+  line-height: 1.25rem;
+}
+
 .sc-text-xl {
   font-size: 1.25rem;
   line-height: 1.75rem;

data/app/assets/javascripts/showcase.js

@@ -4,7 +4,7 @@ window.customElements.define("showcase-sample", class extends HTMLElement {
   }
 
   disconnectedCallback() {
-    this.events.forEach(this.removeEventListener)
+    this.events.forEach((name) => this.removeEventListener(name, this.emit))
   }
 
   emit(event) {

data/app/models/showcase/preview.rb

@@ -32,6 +32,22 @@ class Showcase::Preview
     @badges.concat badges
   end
 
+  # Allows linking out to other Showcases
+  #
+  #   <%= showcase.link_to "components/button", id: "extra-large" %>
+  #   # => <a href="components/button#extra-large"><showcase components/button#extra-large></a>
+  #
+  # Can link to other samples on the current showcase too:
+  #
+  #   # If we're within app/views/showcase/previews/components/_button.html.erb
+  #   <%= showcase.link_to id: "extra-large" %>
+  #   # => <a href="components/button#extra-large"><showcase components/button#extra-large></a>
+  def link_to(preview_id = id, id: nil)
+    @view_context.link_to @view_context.preview_path(preview_id, anchor: id), class: "sc-font-mono sc-text-sm" do
+      "<showcase #{[preview_id, id].compact.join("#").squish}>"
+    end
+  end
+
   # Adds a named sample to demonstrate with the Showcase can do.
   #
   # By default, sample takes a block that'll automatically have its source extracted, like this:

data/config/tailwind.config.js

@@ -4,7 +4,7 @@ module.exports = {
   prefix: 'sc-',
   content: [
     './public/*.html',
-    './app/helpers/**/*.rb',
+    './app/{models,helpers}/**/*.rb',
     './app/javascript/**/*.js',
     './app/views/**/*.{erb,haml,html,slim}'
   ],

data/lib/showcase/previews_test.rb

@@ -1,8 +1,9 @@
 class Showcase::PreviewsTest < ActionView::TestCase
+  extensions = [ Showcase::EngineController._helpers, Showcase::Engine.routes.url_helpers ]
+  setup { view.extend *extensions }
+
   def self.inherited(test_class)
     super
-
-    test_class.tests Showcase::EngineController._helpers
     test_class.prepare
   end
 

data/lib/showcase/version.rb

@@ -1,3 +1,3 @@
 module Showcase
-  VERSION = "0.3.0"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: showcase-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Daniel Pence
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-26 00:00:00.000000000 Z
+date: 2023-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails