showcase-rails 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38aa85b8e5c0a98ee2dbb45f0a184981de8a86371efbb2237e2a06f0d2f56eef
-  data.tar.gz: b4e44e25c0b76afcd33a2dc155cae5bdebe1a5a9ca3cd670d4cc2bae94d7f38b
+  metadata.gz: 24a9dbd46ccbe35d34075383efeb99bedb2825c56976b7b5ce2bb5fba294ffcc
+  data.tar.gz: 28dc05bf705b386845aa630a188d87295ba6069445583af781478e10052d5ae8
 SHA512:
-  metadata.gz: 995f0b2b6f765c93936adb968c501218fccc592befe12df06e0aa19b9b092a0ea385cab086763f0b855e3e86eb784edf8365143b49e69dbda934bd8ce608016d
-  data.tar.gz: 123c59c68801489dec09d40c144c64fbc09dc6c65925833cbeade7a4c8f479595b6d59274d3ab7e74cdd18495dd8276ef60fa714b3f87662c786d6c190d55c39
+  metadata.gz: e62b4977a6c7f8cb53fe74373e17de88870cf245ddcb449be791afb5cab22197a03aabe263aa543bde5d86bbd683e8914002ba133178825542abfe455bdbbda9
+  data.tar.gz: 77213dbf5e976b366ec64947b0e0a0efcf50eb8b0360a7d6698e72ea452512c5d8a37f91e838c9546a98c5b6f3d6b54cca4215bb8f301ad80e31029103de068c

data/README.md

@@ -29,11 +29,11 @@ Which will then render the following:
 
 ![](/readme/example.png?raw=true "Showcase showing a button component")
 
-## Automatic smokescreen testing
+## Automatic integration testing
 
-Run `bin/rails showcase:install:integration_test` to automatic testing installed in `test/integration/showcase_test.rb`.
+Showcase automatically runs integration tests for all your Showcases by rendering them and asserting they respond with `200 OK`. As long as `gem "showcase-rails"` is in the `:test` group you're set.
 
-This will render every Showcase you've defined and assert they respond with `200 OK`. You can add custom assertions by overriding `assert_showcase_preview`.
+If you want to tweak this, run `bin/rails showcase:install:integration_test` and open `test/integration/showcase_test.rb`. You can then add your own `setup` and `teardown` hooks, as well as override the provided `assert_showcase_preview` to add custom assertions.
 
 ## View examples
 
@@ -86,16 +86,9 @@ partials, make sure to include `"showcase"` in your list of assets.
 
 ## Installation
 
-Add this line to your application's Gemfile. If you're utilizing the
-[Showcase::IntegrationTest](lib/showcase/integration_test.rb) class, make sure
-that the `showcase-rails` gems is available to your test environment:
-
+Add this line to your application's Gemfile. To get the automatic integration testing make sure the `showcase-rails` gem is available to your test environment:
 
 ```ruby
-# nested in the default group
-gem "showcase-rails"
-
-# or nested in the :development and :test groups
 group :development, :test do
   gem "showcase-rails"
 end
@@ -108,7 +101,7 @@ $ bundle
 
 Or install it yourself as:
 ```bash
-$ gem install showcase
+$ gem install showcase-rails
 ```
 
 ## Contributing

data/app/assets/builds/showcase.css

@@ -1,5 +1,5 @@
 /*
-! tailwindcss v3.2.4 | MIT License | https://tailwindcss.com
+! tailwindcss v3.2.6 | MIT License | https://tailwindcss.com
 */
 
 /*
@@ -691,6 +691,10 @@ select {
   grid-column: span 9 / span 9;
 }
 
+.sc-m-2 {
+  margin: 0.5rem;
+}
+
 .sc-mb-2 {
   margin-bottom: 0.5rem;
 }
@@ -699,6 +703,10 @@ select {
   margin-bottom: 1rem;
 }
 
+.sc-mt-1 {
+  margin-top: 0.25rem;
+}
+
 .sc-inline-block {
   display: inline-block;
 }
@@ -765,10 +773,13 @@ select {
   align-items: center;
 }
 
-.sc-space-y-8 > :not([hidden]) ~ :not([hidden]) {
-  --tw-space-y-reverse: 0;
-  margin-top: calc(2rem * calc(1 - var(--tw-space-y-reverse)));
-  margin-bottom: calc(2rem * var(--tw-space-y-reverse));
+.sc-justify-between {
+  justify-content: space-between;
+}
+
+.sc-gap-x-2 {
+  -moz-column-gap: 0.5rem;
+       column-gap: 0.5rem;
 }
 
 .sc-space-x-2 > :not([hidden]) ~ :not([hidden]) {
@@ -783,6 +794,12 @@ select {
   margin-bottom: calc(1rem * var(--tw-space-y-reverse));
 }
 
+.sc-space-y-8 > :not([hidden]) ~ :not([hidden]) {
+  --tw-space-y-reverse: 0;
+  margin-top: calc(2rem * calc(1 - var(--tw-space-y-reverse)));
+  margin-bottom: calc(2rem * var(--tw-space-y-reverse));
+}
+
 .sc-overflow-scroll {
   overflow: scroll;
 }
@@ -801,6 +818,10 @@ select {
   white-space: nowrap;
 }
 
+.sc-rounded-full {
+  border-radius: 9999px;
+}
+
 .sc-rounded-md {
   border-radius: 0.375rem;
 }
@@ -813,16 +834,20 @@ select {
   border-width: 0px;
 }
 
-.sc-border-t {
-  border-top-width: 1px;
+.sc-border-2 {
+  border-width: 2px;
+}
+
+.sc-border-b {
+  border-bottom-width: 1px;
 }
 
 .sc-border-r {
   border-right-width: 1px;
 }
 
-.sc-border-b {
-  border-bottom-width: 1px;
+.sc-border-t {
+  border-top-width: 1px;
 }
 
 .sc-border-gray-200 {
@@ -830,26 +855,36 @@ select {
   border-color: rgb(229 231 235 / var(--tw-border-opacity));
 }
 
-.sc-bg-slate-50 {
+.sc-border-indigo-300 {
+  --tw-border-opacity: 1;
+  border-color: rgb(165 180 252 / var(--tw-border-opacity));
+}
+
+.sc-bg-indigo-50 {
   --tw-bg-opacity: 1;
-  background-color: rgb(248 250 252 / var(--tw-bg-opacity));
+  background-color: rgb(238 242 255 / var(--tw-bg-opacity));
 }
 
 .sc-bg-slate-100\/50 {
   background-color: rgb(241 245 249 / 0.5);
 }
 
-.sc-bg-indigo-50 {
+.sc-bg-slate-50 {
   --tw-bg-opacity: 1;
-  background-color: rgb(238 242 255 / var(--tw-bg-opacity));
+  background-color: rgb(248 250 252 / var(--tw-bg-opacity));
+}
+
+.sc-p-12 {
+  padding: 3rem;
 }
 
 .sc-p-4 {
   padding: 1rem;
 }
 
-.sc-p-12 {
-  padding: 3rem;
+.sc-px-2 {
+  padding-left: 0.5rem;
+  padding-right: 0.5rem;
 }
 
 .sc-px-4 {
@@ -857,6 +892,11 @@ select {
   padding-right: 1rem;
 }
 
+.sc-px-8 {
+  padding-left: 2rem;
+  padding-right: 2rem;
+}
+
 .sc-py-2 {
   padding-top: 0.5rem;
   padding-bottom: 0.5rem;
@@ -867,11 +907,6 @@ select {
   padding-bottom: 1.25rem;
 }
 
-.sc-px-8 {
-  padding-left: 2rem;
-  padding-right: 2rem;
-}
-
 .sc-pl-4 {
   padding-left: 1rem;
 }
@@ -880,9 +915,9 @@ select {
   padding-top: 1.75rem;
 }
 
-.sc-text-xl {
-  font-size: 1.25rem;
-  line-height: 1.75rem;
+.sc-text-2xl {
+  font-size: 1.5rem;
+  line-height: 2rem;
 }
 
 .sc-text-3xl {
@@ -895,17 +930,14 @@ select {
   line-height: 1.5rem;
 }
 
-.sc-text-2xl {
-  font-size: 1.5rem;
-  line-height: 2rem;
-}
-
-.sc-font-semibold {
-  font-weight: 600;
+.sc-text-xl {
+  font-size: 1.25rem;
+  line-height: 1.75rem;
 }
 
-.sc-font-normal {
-  font-weight: 400;
+.sc-text-xs {
+  font-size: 0.75rem;
+  line-height: 1rem;
 }
 
 .sc-font-black {
@@ -916,6 +948,14 @@ select {
   font-weight: 500;
 }
 
+.sc-font-normal {
+  font-weight: 400;
+}
+
+.sc-font-semibold {
+  font-weight: 600;
+}
+
 .sc-italic {
   font-style: italic;
 }
@@ -929,6 +969,11 @@ select {
   color: rgb(0 0 0 / var(--tw-text-opacity));
 }
 
+.sc-text-slate-500 {
+  --tw-text-opacity: 1;
+  color: rgb(100 116 139 / var(--tw-text-opacity));
+}
+
 .hover\:sc-select-all:hover {
   -webkit-user-select: all;
      -moz-user-select: all;
@@ -948,11 +993,11 @@ select {
 }
 
 @media (min-width: 1280px) {
-  .xl\:sc-col-span-2 {
-    grid-column: span 2 / span 2;
-  }
-
   .xl\:sc-col-span-10 {
     grid-column: span 10 / span 10;
   }
+
+  .xl\:sc-col-span-2 {
+    grid-column: span 2 / span 2;
+  }
 }

data/app/models/showcase/path.rb

@@ -41,8 +41,13 @@ class Showcase::Path
 
     private
 
-    def find(id)   = children.find { _1.id == id }
-    def insert(id) = self.class.new(id).tap { self << _1 }
+    def find(id)
+      children.find { _1.id == id }
+    end
+
+    def insert(id)
+      self.class.new(id).tap { self << _1 }
+    end
   end
 
   def self.tree

data/app/models/showcase/sample.rb

@@ -1,6 +1,6 @@
 class Showcase::Sample
   attr_reader :name, :id, :events, :details
-  attr_reader :source
+  attr_reader :source, :instrumented
 
   def initialize(view_context, name, description: nil, id: name.parameterize, events: nil, **details)
     @view_context = view_context
@@ -24,7 +24,13 @@ class Showcase::Sample
   end
 
   def preview(&block)
-    block_given? ? @preview = @view_context.capture(&block) : @preview
+    return @preview unless block_given?
+
+    # 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)
+    end
   end
 
   def extract(&block)

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

@@ -4,7 +4,9 @@
       <div class="sc-flex sc-items-center sc-space-x-2 sc-mb-2">
         <h2 class="sc-font-semibold sc-text-3xl"><%= preview.title %></h2>
 
-        <%# TODO: Insert default badge support here. %>
+        <% preview.badges.each do |badge| %>
+          <span class="sc-border-2 sc-border-indigo-300 sc-rounded-full sc-px-2 sc-mt-1"><%= badge.to_s.titleize %></span>
+        <% end %>
       </div>
     <% end %>
 

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

@@ -1,7 +1,16 @@
 <section class="sc-mb-4 sc-border sc-border-gray-200 sc-rounded-md" aria-labelledby="showcase_<%= sample.id %>_title">
   <showcase-sample id="<%= sample.id %>" events="<%= sample.events %>">
     <header class="sc-bg-slate-100/50">
-      <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>
+      <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>
+
+        <% if event = sample.instrumented %>
+          <div class="sc-text-xs sc-grid sc-gap-x-2 sc-m-2 sc-italic sc-text-slate-500">
+            <span><%= event.duration.round(1) %>ms</span>
+            <span><%= event.allocations %> allocs</span>
+          </div>
+        <% end %>
+      </div>
 
       <% if sample.description %>
         <p class="sc-px-4 sc-py-2 sc-text-base"><%= sample.description %></p>

data/lib/showcase/engine.rb

@@ -2,8 +2,12 @@ module Showcase
   class Engine < ::Rails::Engine
     isolate_namespace Showcase
 
-    initializer "showcase.assets" do |app|
-      app.config.assets.precompile += %w[showcase_manifest]
+    initializer "showcase.assets" do
+      config.assets.precompile += %w[showcase_manifest]
+    end
+
+    initializer "showcase.integration_test.autorun" do
+      Showcase::IntegrationTest.autorun if Rails.env.test?
     end
   end
 end

data/lib/showcase/integration_test.rb

@@ -1,10 +1,17 @@
 class Showcase::IntegrationTest < ActionDispatch::IntegrationTest
   def self.inherited(test_class)
     super
+    test_class.prepare
+  end
+
+  def self.autorun
+    at_exit { prepare unless subclasses.any? }
+  end
 
+  def self.prepare
     tree = Showcase::Path.tree
     tree.flat_map(&:ordered_paths).each do |path|
-      test_class.test "Showcase: GET showcase/previews/#{path.id} renders successfully" do
+      test "Showcase: GET showcase/previews/#{path.id} renders successfully" do
         get showcase.preview_path(path.id)
 
         assert_response :ok
@@ -12,7 +19,7 @@ class Showcase::IntegrationTest < ActionDispatch::IntegrationTest
       end
     end
 
-    test_class.test "Showcase: isn't empty" do
+    test "Showcase: isn't empty" do
       assert_not_empty tree, "Showcase couldn't find any samples to generate tests for"
     end
   end

data/lib/showcase/version.rb

@@ -1,3 +1,3 @@
 module Showcase
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

data/lib/showcase.rb

@@ -1,9 +1,9 @@
-require "zeitwerk"
-loader = Zeitwerk::Loader.for_gem
-loader.ignore("#{__dir__}/showcase-rails.rb")
-loader.setup
+require_relative "showcase/version"
 
 module Showcase
+  autoload :IntegrationTest, "showcase/integration_test"
+  autoload :RouteHelper,     "showcase/route_helper"
+
   singleton_class.attr_accessor :sample_renderer
   @sample_renderer = ->(lines) { tag.pre lines.join.strip_heredoc }
 

data/lib/tasks/showcase_tasks.rake

@@ -2,9 +2,9 @@ namespace :showcase do
   namespace :install do
     INTEGRATION_TEST_PATH = "test/integration/showcase_test.rb"
 
-    desc "Install Showcase smokescreen testing in #{INTEGRATION_TEST_PATH}"
-    task :smokescreen_test do
-      mkdir_p INTEGRATION_TEST_PATH
+    desc "Install Showcase integration testing in #{INTEGRATION_TEST_PATH}"
+    task :integration_test do
+      mkdir_p File.dirname(INTEGRATION_TEST_PATH)
       File.write INTEGRATION_TEST_PATH, <<~RUBY
         require "test_helper"
 
@@ -16,15 +16,4 @@ namespace :showcase do
       RUBY
     end
   end
-
-#   desc "Pass a directory relative to app/views to copy over"
-#   task :copy do |t, directory|
-#     prefix = "app/views/#{directory}"
-#
-#     Dir.glob(File.join(Dir.pwd, prefix, "**/*.*")).each do |filename|
-#       new_filename = filename.sub(directory, Showcase.templates_path).sub(/\/_/, "/")
-#       mkdir_p File.dirname(new_filename)
-#       copy_file filename, new_filename
-#     end
-#   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: showcase-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Daniel Pence
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-06 00:00:00.000000000 Z
+date: 2023-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,7 +53,6 @@ files:
 - app/assets/config/showcase_manifest.js
 - app/assets/javascripts/showcase.js
 - app/controllers/showcase/engine_controller.rb
-- app/controllers/showcase/pages_controller.rb
 - app/controllers/showcase/previews_controller.rb
 - app/models/showcase/options.rb
 - app/models/showcase/path.rb

data/app/controllers/showcase/pages_controller.rb

@@ -1,5 +0,0 @@
-class Showcase::PagesController < Showcase::EngineController
-  def show
-    @page = Showcase::Path.new(params[:id]).page_for view_context
-  end
-end