rails-previews 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db7a6eb488743fcae71fdc262d2850af0857667f7c79be35cf6d1e0b76bb1fa9
+  data.tar.gz: f564ba3310a7ebcb499bbf2d4a525482a15cf0075a6fef5b269e39575eb50ba3
+SHA512:
+  metadata.gz: 459d64b879b2687b93d91fcae395a49e5253b53a771d122606b304e2b0785e43f37c19f0efeebc6d7fcc71ddb04decc5182eefab9a14a8349a5e3d8755afa06f
+  data.tar.gz: beb3c8e1653e631c10603b234548fa1b8041940c638ec9c74992b04671bfd0c64ef8e36017f788647d5573cf1b908371dfd593d63d95e942c3a537399fecfdb3

data/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: Test & lint
+on: [push, pull_request]
+
+jobs:
+  tests:
+    name: Test
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: '20'
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+
+      - run: bundle install
+
+      - name: RSpec
+        run: bundle exec rspec
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+
+      - run: bundle install
+
+      - name: Run linter
+        run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,21 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/log/*.log
+/pkg/
+/tmp/
+/spec/reports/
+
+# WIP: generated by the Rails engine generator, but maybe don't need them all
+/test/dummy/db/*.sqlite3
+/test/dummy/db/*.sqlite3-*
+/test/dummy/log/*.log
+/test/dummy/storage/
+/test/dummy/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  rubocop-rails-omakase: rubocop.yml

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.3.4

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.10
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nicktbarone@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rails-previews.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,268 @@
+PATH
+  remote: .
+  specs:
+    rails-previews (0.1.0)
+      slim (~> 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activejob (= 6.1.4.7)
+      activerecord (= 6.1.4.7)
+      activestorage (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      actionview (= 6.1.4.7)
+      activejob (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4.7)
+      actionview (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activerecord (= 6.1.4.7)
+      activestorage (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4.7)
+      activesupport (= 6.1.4.7)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4.7)
+      activesupport (= 6.1.4.7)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4.7)
+      activesupport (= 6.1.4.7)
+    activerecord (6.1.4.7)
+      activemodel (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+    activestorage (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activejob (= 6.1.4.7)
+      activerecord (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
+    builder (3.3.0)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    date (3.3.4)
+    debug (1.9.2)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.5.1)
+    erubi (1.13.0)
+    execjs (2.9.1)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.14.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
+    minitest (5.25.1)
+    net-imap (0.4.16)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.0)
+      net-protocol
+    nio4r (2.7.3)
+    nokogiri (1.16.7-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-arm-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.5.0)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.2)
+      stringio
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rack (2.2.9)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (6.1.4.7)
+      actioncable (= 6.1.4.7)
+      actionmailbox (= 6.1.4.7)
+      actionmailer (= 6.1.4.7)
+      actionpack (= 6.1.4.7)
+      actiontext (= 6.1.4.7)
+      actionview (= 6.1.4.7)
+      activejob (= 6.1.4.7)
+      activemodel (= 6.1.4.7)
+      activerecord (= 6.1.4.7)
+      activestorage (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4.7)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rainbow (3.1.1)
+    rake (10.5.0)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    react_on_rails (14.0.5)
+      addressable
+      connection_pool
+      execjs (~> 2.5)
+      rails (>= 5.2)
+      rainbow (~> 3.0)
+    regexp_parser (2.9.2)
+    reline (0.5.10)
+      io-console (~> 0.5)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.66.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    rubocop-minitest (0.36.0)
+      rubocop (>= 1.61, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.26.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.52.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails-omakase (1.0.0)
+      rubocop
+      rubocop-minitest
+      rubocop-performance
+      rubocop-rails
+    ruby-progressbar (1.13.0)
+    slim (5.2.1)
+      temple (~> 0.10.0)
+      tilt (>= 2.1.0)
+    sprockets (4.2.1)
+      concurrent-ruby (~> 1.0)
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.5.2)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      sprockets (>= 3.0.0)
+    stringio (3.1.1)
+    temple (0.10.3)
+    thor (1.3.2)
+    tilt (2.4.0)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    view_component (3.14.0)
+      activesupport (>= 5.2.0, < 8.0)
+      concurrent-ruby (~> 1.0)
+      method_source (~> 1.0)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  aarch64-linux
+  arm-linux
+  arm64-darwin
+  x86-linux
+  x86_64-darwin
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.5)
+  debug (~> 1.6)
+  rails-previews!
+  rake (~> 10.0)
+  react_on_rails (~> 14.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.6)
+  rubocop-rails-omakase (~> 1.0)
+  view_component (~> 3.14)
+
+BUNDLED WITH
+   2.5.16

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Nicholas Barone
+
+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,115 @@
+# Rails::Previews
+
+A Rails engine to allow previews of many different kinds of Rails view pieces, specifically:
+
+- Partials
+- View Components
+- React-on-Rails React Components
+
+Cribbed from the internals of the preview engine for View Components, and built to work with the [rails-storybook](https://github.com/rangerscience/rails-storybook) gem.
+
+This gem is *extremely* barebones so far!
+
+## Installation
+
+```ruby
+gem 'rails-previews'
+```
+
+Then mount the engine where you want it:
+```ruby
+mount Rails::Previews::Engine => "/previews"
+```
+
+## Usage
+
+Previews should be defined in `spec/preview/*.rb` files (and inherit from the helper class), inside a `Previews` module. Each class function becomes an example, and under the hood, it's just passing the hash directly into the bog-standard Rail's controller `render` function, so basic usage is simple:
+
+```ruby
+module Previews
+  class Example < Rails::Previews::Preview
+    def example_1
+      { plain: "Hello, World!" }
+    end
+
+    def example_2
+      { partial: 'your_partial_name',  locals: {  foo: "bar" } }
+    end
+  end
+end
+```
+
+To cut down on boiler plate for partials, there's a utility function:
+
+```ruby
+module Previews
+  class Example < Rails::Previews::Preview
+    def example_2
+      render_partial 'your_partial_name', {  foo: "bar" }
+    end
+  end
+end
+```
+
+If you're using Github's View Components:
+
+```ruby
+module Previews
+  class Example < Rails::Previews::Preview
+    def example_3
+      MyViewComponent.new(name: "Foo")
+    end
+  end
+end
+```
+
+Lastly, if you're using Shakapacker's React On Rails, this gem provides a handy partial:
+```ruby
+module Previews
+  class Example < Rails::Previews::Preview
+    def example_4
+      {
+        partial: "previews/react_on_rails",
+        locals: {
+          pack: "application", # This being the name of your React component pack/bundle/thing
+          component_name: "MyReactComponent",
+          props: {foo: "bar"}
+        }
+      }
+    end
+  end
+end
+```
+
+Or, with a helper to eliminate boilerplate:
+```ruby
+module Previews
+  class Example < Rails::Previews::Preview
+    def example_4
+      render_react_on_rails "MyReactComponent", foo: "bar"
+    end
+  end
+end
+```
+(FYI: `pack` is an optional keyword argument, defaulting to `"application"`)
+
+Visit `http://localhost:3000/previews/` (or whever you mounted the engine) to see your examples!
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rangerscience/rails-previews. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rails::Previews project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rangerscience/rails-previews/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/assets/config/rails_previews_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/rails/previews .css

data/app/assets/stylesheets/rails/previews/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/rails/previews/previews_controller.rb

@@ -0,0 +1,27 @@
+
+require "rails/application_controller"
+
+class Rails::Previews::PreviewsController < ApplicationController
+  layout false
+
+  def index
+    @previews = Rails::Previews::Preview.all
+    render "previews/index", layout: false
+  end
+
+  def show
+    Rails::Previews::Preview.all # TODO: Autoloading instead (ideally)
+
+    klazz_name = Pathname.new(params[:path]).parent.to_s
+    klazz = "Previews::#{klazz_name.camelize}".constantize
+
+    example_name = Pathname.new(params[:path]).basename.to_s
+    example = klazz.new.send(example_name)
+
+    if example.is_a? Hash
+      render **example
+    else
+      render example
+    end
+  end
+end

data/app/helpers/rails/previews/application_helper.rb

@@ -0,0 +1,6 @@
+module Rails
+  module Previews
+    module ApplicationHelper
+    end
+  end
+end

data/app/jobs/rails/previews/application_job.rb

@@ -0,0 +1,6 @@
+module Rails
+  module Previews
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/rails/previews/application_mailer.rb

@@ -0,0 +1,8 @@
+module Rails
+  module Previews
+    class ApplicationMailer < ActionMailer::Base
+      default from: "from@example.com"
+      layout "mailer"
+    end
+  end
+end

data/app/models/rails/previews/application_record.rb

@@ -0,0 +1,7 @@
+module Rails
+  module Previews
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/views/previews/_react_on_rails.html.slim

@@ -0,0 +1,2 @@
+= javascript_pack_tag pack
+= react_component component_name, props: props, prerender: true

data/app/views/previews/index.html.slim

@@ -0,0 +1,5 @@
+- @previews.each do |preview|
+  h3= preview.preview_name.titleize
+  ul 
+    - preview.examples.each do |example|
+      li= link_to example, preview_path("#{preview.preview_name}/#{example}")

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails/previews"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails::Previews::Engine.routes.draw do
+  get "/", to: "previews#index" # TODO: `internal: true` ...?
+  get "/*path", to: "previews#show", as: :preview # TODO: `internal: true` ...?
+end

data/lib/rails/previews/engine.rb

@@ -0,0 +1,7 @@
+module Rails
+  module Previews
+    class Engine < ::Rails::Engine
+      isolate_namespace Rails::Previews
+    end
+  end
+end

data/lib/rails/previews/preview.rb

@@ -0,0 +1,46 @@
+module Rails::Previews
+  class Preview
+    def render_partial(name, locals = {})
+      { partial: name, locals: locals }
+    end
+
+    def render_react_on_rails(name, pack: "application", props: {})
+      raise "React on Rails is not installed - did you add the gem?" unless defined?(ReactOnRails)
+
+      {
+        partial: "previews/react_on_rails",
+        locals: {
+          pack: pack,
+          component_name: name,
+          props: props
+        }
+      }
+    end
+
+    class << self
+      # TODO: Use regular Rails autoloading
+      def all
+        load_previews!
+        descendants
+      end
+
+      def load_previews!
+        Array(preview_paths).each do |preview_path|
+          Dir["#{preview_path}/**/*.rb"].sort.each { |file| require_dependency file }
+        end
+      end
+
+      def preview_paths
+        [ "#{Rails.root}/spec/previews" ]
+      end
+
+      def preview_name
+        name.delete_prefix("Previews::").underscore
+      end
+
+      def examples
+        public_instance_methods(false).map(&:to_s).sort
+      end
+    end
+  end
+end

data/lib/rails/previews/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module Previews
+    VERSION = "0.1.0"
+  end
+end

data/lib/rails/previews.rb

@@ -0,0 +1,10 @@
+require "rails/previews/version"
+require "rails/previews/engine"
+require "rails/previews/preview"
+
+module Rails
+  module Previews
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/rails-previews.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails/previews/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-previews"
+  spec.version       = Rails::Previews::VERSION
+  spec.authors       = [ "Nicholas Barone" ]
+  spec.email         = [ "nicktbarone@gmail.com" ]
+
+  spec.summary       = %q(A rails engine for previewing views in many forms)
+  spec.description   = %q(
+    Rails Previews is a Rails engine that allows you to preview the pieces that make up your views,
+    specifically: partials, view components, and react-on-rails components
+  )
+  spec.homepage      = "http://github.com/rangerscience/rails-previews"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = [ "lib" ]
+
+  spec.add_development_dependency "bundler", "~> 2.5"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "debug", "~> 1.6"
+  spec.add_development_dependency "rubocop", "~> 1.6"
+  spec.add_development_dependency "rubocop-rails-omakase", "~> 1.0"
+  spec.add_development_dependency "view_component", "~> 3.14"
+  spec.add_development_dependency "react_on_rails", "~> 14.0"
+
+  spec.add_dependency "slim", "~> 5.2"
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: rails-previews
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicholas Barone
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails-omakase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+- !ruby/object:Gem::Dependency
+  name: react_on_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description: "\n    Rails Previews is a Rails engine that allows you to preview the
+  pieces that make up your views,\n    specifically: partials, view components, and
+  react-on-rails components\n  "
+email:
+- nicktbarone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/config/rails_previews_manifest.js
+- app/assets/images/rails/previews/.keep
+- app/assets/stylesheets/rails/previews/application.css
+- app/controllers/concerns/.keep
+- app/controllers/rails/previews/previews_controller.rb
+- app/helpers/rails/previews/application_helper.rb
+- app/jobs/rails/previews/application_job.rb
+- app/mailers/rails/previews/application_mailer.rb
+- app/models/concerns/.keep
+- app/models/rails/previews/application_record.rb
+- app/views/previews/_react_on_rails.html.slim
+- app/views/previews/index.html.slim
+- bin/console
+- bin/setup
+- config/routes.rb
+- lib/rails/previews.rb
+- lib/rails/previews/engine.rb
+- lib/rails/previews/preview.rb
+- lib/rails/previews/version.rb
+- rails-previews.gemspec
+homepage: http://github.com/rangerscience/rails-previews
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: A rails engine for previewing views in many forms
+test_files: []