showcase-rails 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 616178a6d44d9d2a3da1d3e501d65fcd15375b89d87c1ec25dff13f58dba3f4a
-  data.tar.gz: 9f2c3e39bda86712762003630c92796967f5b30f6d87102c72cb69fbd905580d
+  metadata.gz: 3acbdb8f9aafaadded728f1f43bd2b834424a9ccd764605a093f3fa08019b9e7
+  data.tar.gz: 5fe6fde3e533bb60540ea1b47b69953de2d40234560f2b55cdb47bab43e9ed37
 SHA512:
-  metadata.gz: 0c47ba2bdb23a3173b3c4460387423338b02096b2b3fdd9cba9114f2bc429d39bae6c4a7c010991c7659294e6ab9508c663112701cca3450a4005e84a3282ee1
-  data.tar.gz: 575cb0f98daab6bfe9353d2faf3e5356756f7a67e8158ac16fd59bf5479ad50d2b4260a106b72c0bf27136531f01058200c9bbdf62114b7e84fe8b1e9ae20c51
+  metadata.gz: fd7b71e810edb02e6f411f628ed80745944b36c920e7c86588b42544575fb8805a97e35bb30119b3d3a02ea9c127b8ced65d44a61808e5c30046e8ac90253719
+  data.tar.gz: a5ef78400af5a631f38c57a51bc2ea900007213d6fe018da459b7d104d8f36132d8c7a51f3c8a8d3a078b4d4f837110bf0ffaf777a5885b15ea8a18061965318

data/README.md

@@ -99,9 +99,10 @@ class ShowcaseTest < Showcase::PreviewsTest
     assert_text "This is a combobox, for sure."
   end
 
-  test showcase: "button", id: "basic" do
-    # This test block runs within the #button container element's #basic sample.
-    assert_button class: ["text-xs"]
+  test showcase: "button" do
+    assert_selector id: "basic" do
+      assert_button class: ["text-xs"]
+    end
   end
 
   test "some non-Showcase test" do

data/app/assets/builds/showcase.css

@@ -727,6 +727,10 @@ select {
   height: 100%;
 }
 
+.sc-max-h-48 {
+  max-height: 12rem;
+}
+
 .sc-min-h-screen {
   min-height: 100vh;
 }
@@ -796,6 +800,10 @@ select {
   margin-bottom: calc(2rem * var(--tw-space-y-reverse));
 }
 
+.sc-overflow-clip {
+  overflow: clip;
+}
+
 .sc-overflow-scroll {
   overflow: scroll;
 }
@@ -827,27 +835,14 @@ select {
   border-bottom-left-radius: 0.375rem;
 }
 
-.sc-rounded-t-md {
-  border-top-left-radius: 0.375rem;
-  border-top-right-radius: 0.375rem;
-}
-
 .sc-border {
   border-width: 1px;
 }
 
-.sc-border-0 {
-  border-width: 0px;
-}
-
 .sc-border-2 {
   border-width: 2px;
 }
 
-.sc-border-b {
-  border-bottom-width: 1px;
-}
-
 .sc-border-r {
   border-right-width: 1px;
 }
@@ -970,8 +965,8 @@ select {
   line-height: 1.375;
 }
 
-.sc-text-inherit {
-  color: inherit;
+.\!sc-text-inherit {
+  color: inherit !important;
 }
 
 .sc-text-slate-500 {
@@ -979,8 +974,8 @@ select {
   color: rgb(100 116 139 / var(--tw-text-opacity));
 }
 
-.sc-no-underline {
-  text-decoration-line: none;
+.\!sc-no-underline {
+  text-decoration-line: none !important;
 }
 
 .hover\:sc-select-all:hover {
@@ -994,6 +989,10 @@ select {
   background-color: rgb(238 242 255 / var(--tw-bg-opacity));
 }
 
+.hover\:sc-underline:hover {
+  text-decoration-line: underline;
+}
+
 @media (prefers-color-scheme: dark) {
   .dark\:sc-bg-neutral-700\/50 {
     background-color: rgb(64 64 64 / 0.5);

data/app/assets/builds/showcase.highlights.css

@@ -110,3 +110,118 @@
   color: #24292f;
   font-weight: bold;
 }
+
+@media (prefers-color-scheme: dark) {
+  .sc-highlight table td { padding: 5px; }
+  .sc-highlight table pre { margin: 0; }
+  .sc-highlight, .sc-highlight .w {
+    color: #c9d1d9;
+    background-color: #161b22;
+  }
+  .sc-highlight .k, .sc-highlight .kd, .sc-highlight .kn, .sc-highlight .kp, .sc-highlight .kr, .sc-highlight .kt, .sc-highlight .kv {
+    color: #ff7b72;
+  }
+  .sc-highlight .gr {
+    color: #f0f6fc;
+  }
+  .sc-highlight .gd {
+    color: #ffdcd7;
+    background-color: #67060c;
+  }
+  .sc-highlight .nb {
+    color: #ffa657;
+  }
+  .sc-highlight .nc {
+    color: #ffa657;
+  }
+  .sc-highlight .no {
+    color: #ffa657;
+  }
+  .sc-highlight .nn {
+    color: #ffa657;
+  }
+  .sc-highlight .sr {
+    color: #7ee787;
+  }
+  .sc-highlight .na {
+    color: #7ee787;
+  }
+  .sc-highlight .nt {
+    color: #7ee787;
+  }
+  .sc-highlight .gi {
+    color: #aff5b4;
+    background-color: #033a16;
+  }
+  .sc-highlight .kc {
+    color: #79c0ff;
+  }
+  .sc-highlight .l, .sc-highlight .ld, .sc-highlight .m, .sc-highlight .mb, .sc-highlight .mf, .sc-highlight .mh, .sc-highlight .mi, .sc-highlight .il, .sc-highlight .mo, .sc-highlight .mx {
+    color: #79c0ff;
+  }
+  .sc-highlight .sb {
+    color: #79c0ff;
+  }
+  .sc-highlight .bp {
+    color: #79c0ff;
+  }
+  .sc-highlight .ne {
+    color: #79c0ff;
+  }
+  .sc-highlight .nl {
+    color: #79c0ff;
+  }
+  .sc-highlight .py {
+    color: #79c0ff;
+  }
+  .sc-highlight .nv, .sc-highlight .vc, .sc-highlight .vg, .sc-highlight .vi, .sc-highlight .vm {
+    color: #79c0ff;
+  }
+  .sc-highlight .o, .sc-highlight .ow {
+    color: #79c0ff;
+  }
+  .sc-highlight .gh {
+    color: #1f6feb;
+    font-weight: bold;
+  }
+  .sc-highlight .gu {
+    color: #1f6feb;
+    font-weight: bold;
+  }
+  .sc-highlight .s, .sc-highlight .sa, .sc-highlight .sc, .sc-highlight .dl, .sc-highlight .sd, .sc-highlight .s2, .sc-highlight .se, .sc-highlight .sh, .sc-highlight .sx, .sc-highlight .s1, .sc-highlight .ss {
+    color: #a5d6ff;
+  }
+  .sc-highlight .nd {
+    color: #d2a8ff;
+  }
+  .sc-highlight .nf, .sc-highlight .fm {
+    color: #d2a8ff;
+  }
+  .sc-highlight .err {
+    color: #f0f6fc;
+    background-color: #8e1519;
+  }
+  .sc-highlight .c, .sc-highlight .ch, .sc-highlight .cd, .sc-highlight .cm, .sc-highlight .cp, .sc-highlight .cpf, .sc-highlight .c1, .sc-highlight .cs {
+    color: #8b949e;
+  }
+  .sc-highlight .gl {
+    color: #8b949e;
+  }
+  .sc-highlight .gt {
+    color: #8b949e;
+  }
+  .sc-highlight .ni {
+    color: #c9d1d9;
+  }
+  .sc-highlight .si {
+    color: #c9d1d9;
+  }
+  .sc-highlight .ge {
+    color: #c9d1d9;
+    font-style: italic;
+  }
+  .sc-highlight .gs {
+    color: #c9d1d9;
+    font-weight: bold;
+  }
+}

data/app/models/showcase/preview.rb

@@ -66,7 +66,7 @@ class Showcase::Preview
   #   - the `sample.events` what JavaScript `events` to listen for on the element
   #   - any other custom options are available in `sample.details`.
   def sample(name, **options, &block)
-    @samples << Showcase::Sample.new(@view_context, name, **options).tap { _1.collect(&block) }
+    @samples << Showcase::Sample.new(@view_context, name, **options).tap { _1.evaluate(&block) }
   end
 
   # Yields an Options object to help define the configuration table for a Preview.
@@ -88,7 +88,7 @@ class Showcase::Preview
   end
 
   def render_associated_partial
-    @view_context.render "#{Showcase.previews_path}/#{id}", showcase: self
+    @view_context.render "showcase/previews/#{id}", showcase: self
     nil
   end
 end

data/app/models/showcase/sample.rb

@@ -1,6 +1,6 @@
 class Showcase::Sample
   attr_reader :name, :id, :events, :details
-  attr_reader :source, :instrumented
+  attr_reader :rendered, :source, :instrumented
 
   def initialize(view_context, name, description: nil, id: name.parameterize, syntax: :erb, events: nil, **details)
     @view_context = view_context
@@ -14,36 +14,39 @@ class Showcase::Sample
     @description
   end
 
-  def collect(&block)
+  def evaluate(&block)
     if block.arity.zero?
-      preview(&block)
-      extract(&block)
+      consume(&block)
     else
       @view_context.capture(self, &block)
     end
   end
 
-  def preview(&block)
-    return @preview unless block_given?
+  def consume(&block)
+    render(&block)
+    extract_source(&block)
+  end
 
+  def render(&block)
     # TODO: Remove `is_a?` check when Rails 6.1 support is dropped.
     assigns = proc { @instrumented = _1 if _1.is_a?(ActiveSupport::Notifications::Event) }
     ActiveSupport::Notifications.subscribed(assigns, "render_partial.action_view") do
-      @preview = @view_context.capture(&block)
+      @rendered = @view_context.capture(&block)
     end
   end
 
-  def extract(&block)
+  def extract_source(&block)
     source = extract_source_block_via_matched_indentation_from(*block.source_location)
     @source = @view_context.instance_exec(source, @syntax, &Showcase.sample_renderer)
   end
 
   private
 
-  def extract_source_block_via_matched_indentation_from(file, starting_index)
-    first_line, *lines = File.readlines(file).from(starting_index - 1)
+  def extract_source_block_via_matched_indentation_from(file, source_location_index)
+    # `Array`s are zero-indexed, but `source_location` indexes are not, hence `pred`.
+    starting_line, *lines = File.readlines(file).slice(source_location_index.pred..)
 
-    indentation = first_line.match(/^\s+(?=\b)/).to_s
+    indentation = starting_line.match(/^\s+/).to_s
     matcher = /^#{indentation}\S/
 
     index = lines.index { _1.match?(matcher) }

data/app/views/showcase/engine/_root.html.erb

@@ -1,7 +1,9 @@
 <main class="sc-flex sc-flex-wrap dark:sc-bg-neutral-900 dark:sc-text-white" aria-labelledby="showcase_main_title">
   <section class="sc-grid sc-grid-cols-12 sc-w-full">
     <nav class="sc-col-span-3 xl:sc-col-span-2 sc-py-5 sc-h-full sc-border-r">
-      <h1 id="showcase_main_title" class="sc-font-black sc-text-2xl sc-py-2 sc-pl-4 sc-cursor-pointer"><%= link_to "Showcase", root_url %></h1>
+      <h1 id="showcase_main_title" class="sc-font-black sc-text-2xl sc-py-2 sc-pl-4 sc-cursor-pointer">
+        <%= link_to "Showcase", root_url, class: "!sc-text-inherit hover:sc-underline" %>
+      </h1>
 
       <%= render Showcase::Path.tree %>
     </nav>

data/app/views/showcase/engine/_sample.html.erb

@@ -1,8 +1,10 @@
-<section class="sc-mb-4 sc-border sc-border-gray-200 sc-rounded-md" aria-labelledby="showcase_<%= sample.id %>_title">
+<section class="sc-mb-4 sc-border sc-border-gray-200 sc-rounded-md sc-overflow-clip" aria-labelledby="showcase_<%= sample.id %>_title">
   <showcase-sample id="<%= sample.id %>" events="<%= sample.events %>">
-    <header class="sc-bg-slate-100/50 dark:sc-bg-neutral-700/50 sc-rounded-t-md">
+    <header class="sc-bg-slate-100/50 dark:sc-bg-neutral-700/50">
       <div class="sc-flex sc-justify-between">
-        <h3 id="showcase_<%= sample.id %>_title" class="sc-px-4 sc-py-2 sc-font-medium sc-text-base md:sc-text-lg sc-leading-snug sc-truncate"><%= link_to sample.name, "##{sample.id}" %></h3>
+        <h3 id="showcase_<%= sample.id %>_title" class="sc-px-4 sc-py-2 sc-font-medium sc-text-base md:sc-text-lg sc-leading-snug sc-truncate">
+          <%= link_to sample.name, "##{sample.id}", class: "!sc-text-inherit" %>
+        </h3>
 
         <% if event = sample.instrumented %>
           <div class="sc-text-xs sc-grid sc-gap-x-2 sc-m-2 sc-italic sc-text-slate-500 dark:sc-text-inherit">
@@ -17,9 +19,9 @@
       <% end %>
     </header>
 
-    <% if sample.preview %>
-      <section class="sc-px-4 sc-py-2 sc-border sc-border-gray-200 sc-border-0 sc-border-b">
-        <%= sample.preview %>
+    <% if sample.rendered %>
+      <section class="sc-px-4 sc-py-2">
+        <%= sample.rendered %>
       </section>
     <% end %>
 
@@ -37,7 +39,7 @@
       <section class="sc-px-4 sc-py-2 sc-font-small sc-bg-slate-50 dark:sc-bg-neutral-800 sc-rounded-b-md" aria-labelledby="showcase_<%= sample.id %>_javascript_events_title">
         <h4 id="showcase_<%= sample.id %>_javascript_events_title" class="sc-mb-2 sc-font-medium sc-text-base">JavaScript Events</h4>
 
-        <div class="sc-overflow-scroll sc-max-h-50">
+        <div class="sc-overflow-scroll sc-max-h-48">
           <pre data-showcase-sample-target="relay"></pre>
         </div>
       </section>

data/app/views/showcase/engine/path/_path.html.erb

@@ -1,3 +1,3 @@
 <article class="hover:sc-bg-indigo-50 dark:hover:sc-bg-neutral-700/50 <%= "sc-bg-indigo-50 dark:sc-bg-neutral-700/50" if path.id == params[:id] %>">
-  <%= link_to path.basename.titleize, preview_path(path.id), class: "sc-inline-block sc-py-2 sc-px-8 sc-w-full sc-text-inherit sc-no-underline" %>
+  <%= link_to path.basename.titleize, preview_path(path.id), class: "sc-inline-block sc-py-2 sc-px-8 sc-w-full !sc-text-inherit !sc-no-underline" %>
 </article>

data/lib/showcase/previews_test.rb

@@ -1,12 +1,12 @@
 class Showcase::PreviewsTest < ActionView::TestCase
   def self.inherited(test_class)
     super
+
+    test_class.tests Showcase::EngineController._helpers
     test_class.prepare
   end
 
   def self.prepare
-    tests Showcase::EngineController._helpers
-
     tree = Showcase::Path.tree
     tree.flat_map(&:ordered_paths).each do |path|
       test "Showcase: automatically renders showcase/previews/#{path.id}" do
@@ -20,17 +20,16 @@ class Showcase::PreviewsTest < ActionView::TestCase
     end
   end
 
-  def self.test(name = nil, showcase: nil, id: nil, &block)
-    case
-    when name then super(name, &block)
-    when id && showcase.nil? then raise ArgumentError, "can't test a sample without a showcase"
+  def self.test(name = nil, showcase: nil, &block)
+    if name
+      super(name, &block)
     else
-      super "Showcase: showcase/previews/#{showcase} #{"sample #{id}" if id}".squish do
+      super "Showcase: showcase/previews/#{showcase}" do
         path = Showcase::Path.new(showcase)
         render "showcase/engine/preview", preview: path.preview_for(view)
 
         assert_showcase_preview(path.id)
-        assert_element(id: id || path.id) { instance_eval(&block) }
+        instance_eval(&block)
       end
     end
   end

data/lib/showcase/route_helper.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module Showcase::RouteHelper
   def method_missing(name, ...)
-    case name
-    when /_path\Z/, /_url\Z/ then main_app.public_send(name, ...)
-    else                          super
+    if name.end_with?("_path", "_url")
+      main_app.public_send(name, ...)
+    else
+      super
     end
   end
 end

data/lib/showcase/version.rb

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

data/lib/showcase.rb

@@ -24,12 +24,9 @@ module Showcase
     end
   end
 
-  singleton_class.attr_reader :previews_path
-  @previews_path = "showcase/previews"
-
   def self.previews
     Showcase::EngineController.view_paths.map(&:path).flat_map do |root|
-      Dir.glob("**/*.*", base: File.join(root, previews_path))
+      Dir.glob("**/*.*", base: File.join(root, "showcase/previews"))
     end.uniq
   end
 

metadata

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