showcase-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 19b68b6f97120e74cc61013cf64de0b095a08290e46f26183861c28c45574693
+  data.tar.gz: b6e9fdc2cc45b1ed6354b60fe67ff254ce03ad08441e1b43c1418e3d6b115404
+SHA512:
+  metadata.gz: 14fcf547ea4c0f3fb4f5f8c99947f41bfc2dbcbb8042ba13137a7347367ec2adb5da9dd60e8f8db62305e6ad0f2d2a26ad00afa6ff0abc8aaf0adf8213df00c2
+  data.tar.gz: 720b83d11a256def78cf22f1b87de100b5170b98e25d08c8c3d2531633accf6e352b12bbcfcb35a096394906612f707aa2d89029654e4b3af181507708dd84f4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Kasper Timm Hansen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Showcase
+
+Showcase lets you build previews for partials, components, view helpers and Stimulus controllers.
+
+Add a view template to `app/views/showcases` and it'll show up in Showcase's menu.
+
+Here's how to showcase a standard button component:
+
+```erb
+<%# app/views/showcases/components/button.html.erb %>
+<% showcase.description "This button component handles what we click on" %>
+
+<% showcase.sample "Basic" do %>
+  <%= render "component/button", content: "Button content", mode: :small %>
+<% end %>
+
+<% showcase.sample "Large" do %>
+  <%= render "component/button", content: "Button content", mode: :large %>
+<% end %>
+
+<% showcase.options do |o| %>
+  <% o.required :content, String, "The content to output as the button text" %>
+  <% o.optional :mode, default: :small, values: %i[ small medium large ], description: "We support three modes" %>
+<% end %>
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "showcase"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install showcase
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"