showcase-rails 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a546309faa4499b63781df854aa283c3d3a382f91f0c9be8e00a37a5dcbd0b04
-  data.tar.gz: 1a7b269de49a2015c7ad9bc037de1e68aed4b33217771322f8345e859bdc5bc0
+  metadata.gz: '081d707dee9578e786c17cb621826f685bf2a4f9eab5221037b2394ac3b6805b'
+  data.tar.gz: 46fad2bf9b84aba2bf22bf0a627eb225ee904cd67da55cda4c0690b34d8d5a07
 SHA512:
-  metadata.gz: 2779fe6f14b9a07db6a161dc4915a90aa2c1419f19dede0822d8009730b06a3b3006ec0eabcf8d008000d48a4997bdd4342b49dd59b35d4dfb205b520493ffcd
-  data.tar.gz: f1bd8f9effd8ee3af53ab9bddf3456c3bff072e4cfb75d4e6b110a0925f35d996b2dce12f6adeb9e236ae5d5aa8f93eb3c93900b2d53f17c0930b44117b5e043
+  metadata.gz: 480d2d5a3c891703603caec5131d3990e19d31c97e815c622d8c6152ec2c1519a430e55416fc63caab1d7f136dd0fe96bf9e45a39bbf854e39134339822f6157
+  data.tar.gz: d35a92bd276b05225cdb827a9d3ec832665e1b0978b2ec02294ecc3d0810fee926fbb5f58d989612177ebe879d833ea8a476057efa04ca845d5e3e2b1808694a

data/README.md

@@ -29,7 +29,32 @@ Which will then render the following:
 
 ![](/readme/example.png?raw=true "Showcase showing a button component")
 
-## Automatic smokescreen testing
+## Using options contexts
+
+Showcase also supports custom options contexts. They're useful for cases where the options have a very specific format and it would be nice to keep them standardized.
+
+By default, Showcase ships Nice Partials and Stimulus contexts out of the box. Here's a sample of the Stimulus one:
+
+```erb
+<% showcase.options.stimulus controller: :welcome do |o| %>
+  <% o.optional.targets :greeter, "If the id of the target element must be printed" %>
+<% end %>
+```
+
+In case Showcase didn't ship with a Stimulus context, here's how you could add it:
+
+```ruby
+# config/initializers/showcase.rb
+if defined?(Showcase)
+  Showcase.options.define :stimulus do
+    def targets(name, ...)
+      option(%(data-#{@controller}-target="#{name}"), ...)
+    end
+  end
+end
+```
+
+## Automatic integration testing
 
 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.
 

data/app/assets/builds/showcase.css

@@ -1,5 +1,5 @@
 /*
-! tailwindcss v3.2.4 | MIT License | https://tailwindcss.com
+! tailwindcss v3.2.7 | 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

@@ -1,19 +1,16 @@
 class Showcase::Path
-  class Tree < Struct.new(:id, :children)
+  class Tree < Struct.new(:id, :children, :root)
     def initialize(id, children = [])
-      super
+      super(id, children, false)
     end
+    alias_method :root?, :root
     delegate :<<, to: :children
 
     cached_partial_path = "showcase/engine/path/tree"
     define_method(:to_partial_path) { cached_partial_path }
 
     def name
-      root? ? "Previews" : id
-    end
-
-    def root?
-      id == "."
+      id == "." ? "Previews" : id
     end
 
     def ordered_children
@@ -24,15 +21,10 @@ class Showcase::Path
       children.flat_map { _1.is_a?(Tree) ? _1.ordered_paths : _1 }
     end
 
-    def self.index(...)
-      new(:discardable_root).tap { _1.index(...) }.ordered_children
-    end
-
-    def index(paths)
-      paths.each do |path|
-        ids = yield path
-        ids.inject(self, :edge_for) << path
-      end
+    def self.index(paths)
+      paths.each_with_object new(:discardable_root) do |path, root|
+        yield(path).reduce(root, :edge_for) << path
+      end.children.sort_by(&:id).each { _1.root = true }
     end
 
     def edge_for(id)

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/layouts/showcase.html.erb

@@ -4,8 +4,8 @@
     <title>Showcase</title>
     <meta name="viewport" content="width=device-width,initial-scale=1">
 
-    <%= render "stylesheets" %>
-    <%= render "javascripts" %>
+    <%= render "showcase/engine/stylesheets" %>
+    <%= render "showcase/engine/javascripts" %>
   </head>
 
   <body>

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/options.rb

@@ -0,0 +1,89 @@
+require "active_support/option_merger"
+
+class Showcase::Options
+  include Enumerable
+
+  def initialize(view_context)
+    @view_context = view_context
+    @options = []
+    @order = [:name, :required, :type, :default, :description]
+  end
+  delegate :empty?, to: :@options
+
+  #   Showcase.options.define :stimulus do
+  #     def value(name, ...)
+  #       option("data-#{@controller}-#{name}-value", ...)
+  #     end
+  #   end
+  singleton_class.attr_reader :contexts
+  @contexts = Hash.new { |h,k| h[k] = Class.new Context }
+
+  def self.define(key, &block)
+    contexts[key].class_eval(&block) # Lets users reopen an already defined context class.
+  end
+
+  #   showcase.options.stimulus controller: :welcome do |o|
+  #     o.value :greeting, default: "Hello"
+  #   end
+  def context(key, **options, &block)
+    context = self.class.contexts.fetch(key)
+    context.new(@view_context, @options, **options).tap { yield _1 if block_given? }
+  end
+
+  def required(*arguments, **keywords, &block)
+    if arguments.none?
+      ActiveSupport::OptionMerger.new(self, required: true)
+    else
+      option(*arguments, **keywords, required: true, &block)
+    end
+  end
+
+  def optional(*arguments, **keywords, &block)
+    if arguments.none?
+      ActiveSupport::OptionMerger.new(self, required: false)
+    else
+      option(*arguments, **keywords, required: false, &block)
+    end
+  end
+
+  DEFAULT_OMITTED = Object.new
+
+  def option(name, description = nil, required: false, type: nil, default: DEFAULT_OMITTED, **options, &block)
+    description ||= @view_context.capture(&block).remove(/^\s+/).html_safe if block
+
+    type ||= type_from_default(default)
+    default = default == DEFAULT_OMITTED ? nil : default.inspect
+
+    @options << options.with_defaults(name: name, default: default, type: type, description: description, required: required)
+  end
+
+  def headers
+    @headers ||= @order | @options.flat_map(&:keys).uniq.sort
+  end
+
+  def each(&block)
+    @options.each do |option|
+      yield headers.index_with { option[_1] }
+    end
+  end
+
+  private
+
+  class Context < Showcase::Options
+    def initialize(view_context, options, **kwargs)
+      super(view_context)
+      @options = options
+      kwargs.each { instance_variable_set(:"@#{_1}", _2) }
+    end
+  end
+
+  def type_from_default(default)
+    case default
+    when DEFAULT_OMITTED then String
+    when true, false then "Boolean"
+    when nil then "nil"
+    else
+      default.class
+    end
+  end
+end

data/lib/showcase/version.rb

@@ -1,3 +1,3 @@
 module Showcase
-  VERSION = "0.2.1"
+  VERSION = "0.2.3"
 end

data/lib/showcase.rb

@@ -3,6 +3,7 @@ require_relative "showcase/version"
 module Showcase
   autoload :IntegrationTest, "showcase/integration_test"
   autoload :RouteHelper,     "showcase/route_helper"
+  autoload :Options,         "showcase/options"
 
   singleton_class.attr_accessor :sample_renderer
   @sample_renderer = ->(lines) { tag.pre lines.join.strip_heredoc }
@@ -15,6 +16,38 @@ module Showcase
       Dir.glob("**/*.*", base: File.join(root, previews_path))
     end.uniq
   end
+
+  def self.options
+    Options
+  end
+
+  options.define :stimulus do
+    def targets(name, ...)
+      option(%(data-#{@controller}-target="#{name}"), ...)
+    end
+
+    def values(name, ...)
+      option("data-#{@controller}-#{name}-value", ...)
+    end
+
+    def classes(name, ...)
+      option("data-#{@controller}-#{name}-class", ...)
+    end
+
+    def outlet(name, ...)
+      option("data-#{@controller}-#{name}-outlet", ...)
+    end
+
+    def action(name, ...)
+      option(%(data-action="#{name}"), ...)
+    end
+  end
+
+  options.define :nice_partials do
+    def content_block(*arguments, **options, &block)
+      option(*arguments, **options, type: "Content Block", &block)
+    end
+  end
 end
 
 require "showcase/engine" if defined?(Rails::Engine)

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.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Daniel Pence
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-07 00:00:00.000000000 Z
+date: 2023-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,9 +53,7 @@ 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
 - app/models/showcase/preview.rb
 - app/models/showcase/sample.rb
@@ -76,6 +74,7 @@ files:
 - lib/showcase.rb
 - lib/showcase/engine.rb
 - lib/showcase/integration_test.rb
+- lib/showcase/options.rb
 - lib/showcase/route_helper.rb
 - lib/showcase/version.rb
 - lib/tasks/showcase_tasks.rake
@@ -101,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Showcase helps you show off and document your partials, components, view

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

data/app/models/showcase/options.rb

@@ -1,51 +0,0 @@
-class Showcase::Options
-  include Enumerable
-
-  def initialize(view_context)
-    @view_context = view_context
-    @options = []
-    @order = [:name, :required, :type, :default, :description]
-  end
-  delegate :empty?, to: :@options
-
-  def required(*arguments, **keywords, &block)
-    option(*arguments, **keywords, required: true, &block)
-  end
-
-  def optional(*arguments, **keywords, &block)
-    option(*arguments, **keywords, required: false, &block)
-  end
-
-  DEFAULT_OMITTED = Object.new
-
-  def option(name, description = nil, required: false, type: nil, default: DEFAULT_OMITTED, **options, &block)
-    description ||= @view_context.capture(&block).remove(/^\s+/).html_safe if block
-
-    type ||= type_from_default(default)
-    default = default == DEFAULT_OMITTED ? nil : default.inspect
-
-    @options << options.with_defaults(name: name, default: default, type: type, description: description, required: required)
-  end
-
-  def headers
-    @headers ||= @order | @options.flat_map(&:keys).uniq.sort
-  end
-
-  def each(&block)
-    @options.each do |option|
-      yield headers.index_with { option[_1] }
-    end
-  end
-
-  private
-
-  def type_from_default(default)
-    case default
-    when DEFAULT_OMITTED then String
-    when true, false then "Boolean"
-    when nil then "nil"
-    else
-      default.class
-    end
-  end
-end