rbexy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f380f26df4a04d8cc73a9a65b5abaad571a32670013eabb3465eaa7f08ab1de4
+  data.tar.gz: e729b87a8e1ec2918dce115b240bfbea991a11203d73f003a42cccb972544c93
+SHA512:
+  metadata.gz: 795cead4247e37aed6d803f430318e8cb5f080ee431fc0f2f6820684b211a0a45d58ea9205b2cbd3c9e94dcf2021fe972596bd48109276334a2b32661813c9ef
+  data.tar.gz: 6ec46d0e829a2d2fb387b45c372cdd2fa5dcb9f04d5e872c8dea637ee9867af964d76eabd1f2b3f83b437db3c4da823359dba0a24bb149d0fae0f3bdfcc15204

data/.gitignore

@@ -0,0 +1 @@
+spec/dummy/log/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+ - 2.7

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 TODO: Write your email address. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby:2.7.1
+RUN apt-get update -qq
+
+WORKDIR /app
+
+COPY . .
+RUN bundle install

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rbexy.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,213 @@
+PATH
+  remote: .
+  specs:
+    rbexy (0.1.0)
+      actionview (>= 5.0, < 7.0)
+      activesupport (>= 5.0, < 7.0)
+      railties (>= 5.0, < 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      activejob (= 6.0.3.3)
+      activerecord (= 6.0.3.3)
+      activestorage (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      actionview (= 6.0.3.3)
+      activejob (= 6.0.3.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.3.3)
+      actionview (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      activerecord (= 6.0.3.3)
+      activestorage (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.3)
+      activesupport (= 6.0.3.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.3)
+      activesupport (= 6.0.3.3)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.3)
+      activesupport (= 6.0.3.3)
+    activerecord (6.0.3.3)
+      activemodel (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+    activestorage (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      activejob (= 6.0.3.3)
+      activerecord (= 6.0.3.3)
+      marcel (~> 0.3.1)
+    activesupport (6.0.3.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.9.0)
+    ffi (1.13.1)
+    formatador (0.2.5)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    loofah (2.7.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    lumberjack (1.2.8)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    nenv (0.3.0)
+    nio4r (2.5.4)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.3.3)
+      actioncable (= 6.0.3.3)
+      actionmailbox (= 6.0.3.3)
+      actionmailer (= 6.0.3.3)
+      actionpack (= 6.0.3.3)
+      actiontext (= 6.0.3.3)
+      actionview (= 6.0.3.3)
+      activejob (= 6.0.3.3)
+      activemodel (= 6.0.3.3)
+      activerecord (= 6.0.3.3)
+      activestorage (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      bundler (>= 1.3.0)
+      railties (= 6.0.3.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (12.3.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-html-matchers (0.9.3)
+      nokogiri (~> 1)
+      rspec (>= 3.0.0.a, < 4)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (4.0.1)
+      actionpack (>= 4.2)
+      activesupport (>= 4.2)
+      railties (>= 4.2)
+      rspec-core (~> 3.9)
+      rspec-expectations (~> 3.9)
+      rspec-mocks (~> 3.9)
+      rspec-support (~> 3.9)
+    rspec-support (3.9.3)
+    shellany (0.0.1)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard-rspec (~> 4.7, >= 4.7.3)
+  pry-byebug
+  rails (>= 5.0, < 7.0)
+  rake
+  rbexy!
+  rspec (~> 3.9)
+  rspec-html-matchers (~> 0.9.3)
+  rspec-rails (~> 4.0, >= 4.0.1)
+  sqlite3
+
+BUNDLED WITH
+   2.1.4

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+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,452 @@
+# A Ruby template language inspired by JSX
+
+[![Build Status](https://travis-ci.org/patbenatar/rbexy.svg?branch=master)](https://travis-ci.org/patbenatar/rbexy)
+
+Love JSX and component-based frontends, but sick of paying the costs of SPA development? Rbexy brings the elegance of JSX—operating on HTML elements and custom components with an interchangeable syntax—to the world of Rails server-rendered apps.
+
+Combine this with CSS Modules in your Webpacker PostCSS pipeline and you'll have a first-class frontend development experience while maintaining the development efficiency of Rails.
+
+_But what about Javascript and client-side behavior?_ You probably don't need as much of it as you think you do. See how far you can get with layering RailsUJS, vanilla JS, Turbolinks, and/or StimulusJS onto your server-rendered components. I think you'll be pleasantly surprised with the modern UX you're able to build while writing and maintaining less code.
+
+## Example
+
+Use your custom Ruby class components from `.rbx` templates just like you would React components in JSX:
+
+```jsx
+<body>
+  <Hero size="fullscreen" {**splat_some_attributes}>
+    <h1>Hello {@name}</h1>
+    <p>Welcome to rbexy, marrying the nice parts of React templating with the development efficiency of Rails server-rendered apps.</p>
+    <Button to={about_path}>Learn more</Button>
+  </Hero>
+</body>
+```
+
+after defining them in Ruby:
+
+```ruby
+class HeroComponent < Rbexy::Component # or use ViewComponent, or another component lib
+  def setup(size:)
+    @size = size
+  end
+end
+
+class ButtonComponent < Rbexy::Component
+  def setup(to:)
+    @to = to
+  end
+end
+```
+
+with their accompying template files (also can be `.rbx`!), scoped scss files, JS and other assets (not shown).
+
+## Getting Started (with Rails)
+
+Add it to your Gemfile and `bundle install`:
+
+```ruby
+gem "rbexy"
+```
+
+In `config/application.rb`:
+
+```ruby
+require "rbexy/rails/engine"
+```
+
+_Not using Rails? See "Usage outside of Rails" below._
+
+Create your first component at `app/components/hello_world_component.rb`:
+
+```ruby
+class HelloWorldComponent < Rbexy::Component
+  def setup(name:)
+    @name = name
+  end
+end
+```
+
+With a template `app/components/hello_world_component.rbx`:
+
+```jsx
+<div>
+  <h1>Hello {@name}</h1>
+  {content}
+</div>
+```
+
+Add a controller, action, route, and `rbx` view like `app/views/hello_worlds/index.rbx`:
+
+```jsx
+<HelloWorld name="Nick">
+  <p>Welcome to the world of component-based frontend development in Rails!</p>
+</HelloWorld>
+```
+
+_Or you can render Rbexy components from ERB with `<%= HelloWorldComponent.new(self, name: "Nick").render %>`_
+
+Fire up `rails s`, navigate to your route, and you should see Rbexy in action!
+
+## Template Syntax
+
+### Text
+
+You can put arbitrary strings anywhere.
+
+At the root:
+
+```jsx
+Hello world
+```
+
+Inside tags:
+
+```jsx
+<p>Hello world</p>
+```
+
+As attributes:
+
+```jsx
+<div class="myClass"></div>
+```
+
+### Comments
+
+Start a line with `#` to leave a comment:
+
+```jsx
+# Comments can be at the root
+<div>
+  # Or within tags
+  # spanning multiple lines
+  <h1>Hello world</h1>
+</div>
+```
+
+### Expressions
+
+You can put ruby code anywhere that you would put text, just wrap it in `{ ... }`
+
+At the root:
+
+```jsx
+{"hello world".upcase}
+```
+
+Inside a sentence:
+
+```jsx
+Hello {"world".upcase}
+```
+
+Inside tags:
+
+```jsx
+<p>{"hello world".upcase}</p>
+```
+
+As attributes:
+
+```jsx
+<p class={@dynamic_class}>Hello world</p>
+```
+
+#### Tags within expressions
+
+To conditionalize your template:
+
+```jsx
+<div>
+  {some_boolean && <h1>Welcome</h1>}
+  {another_boolean ? <p>Option One</p> : <p>Option Two</p>}
+</div>
+```
+
+Loops:
+
+```jsx
+<ul>
+  {[1, 2, 3].map { |n| <li>{n}</li> }}
+</ul>
+```
+
+As an attribute:
+
+```jsx
+<Hero title={<h1>Hello World</h1>}>
+  Content here...
+</Hero>
+```
+
+Pass a lambda to a prop, that when called returns a tag:
+
+```jsx
+<Hero title={-> { <h1>Hello World</h1> }}>
+  Content here...
+</Hero>
+```
+
+### Tags
+
+You can put standard HTML tags anywhere.
+
+At the root:
+
+```jsx
+<h1>Hello world</h1>
+```
+
+As children:
+
+```jsx
+<div>
+  <h1>Hello world</h1>
+</div>
+```
+
+As siblings with other tags:
+
+```jsx
+<div>
+  <h1>Hello world</h1>
+  <p>Welcome to rbexy</p>
+</div>
+```
+
+As siblings with text and expressions:
+
+```jsx
+<h1>Hello world</h1>
+{an_expression}
+Some arbitrary text
+```
+
+Self-closing tags:
+
+```jsx
+<input type="text" />
+```
+
+#### Attributes
+
+Text and expressions can be provided as attributes:
+
+```jsx
+<div class="myClass" id={dynamic_id}></div>
+```
+
+Value-less attributes are allowed:
+
+```jsx
+<input type="submit" disabled>
+```
+
+You can splat a hash into attributes:
+
+```jsx
+<div {**{ class: "myClass" }} {**@more_attrs}></div>
+```
+
+## Custom components
+
+You can use custom components alongside standard HTML tags:
+
+```jsx
+<div>
+  <PageHeader title="Welcome" />
+  <PageBody>
+    <p>To the world of custom components</p>
+  </PageBody>
+</div>
+```
+
+### `Rbexy::Component`
+
+We ship with a component superclass that integrates nicely with Rails' ActionView and the controller rendering context. You can use it to easily implement custom components in your Rails app:
+
+```ruby
+# app/components/page_header_component.rb
+class PageHeaderComponent < Rbexy::Component
+  def setup(title:)
+    @title = title
+  end
+end
+```
+
+By default, we'll look for a template file in the same directory as the class and with a matching filename:
+
+```jsx
+// app/components/page_header_component.rbx
+<h1>{@title}</h1>
+```
+
+You can call this component from another `.rbx` template file (`<PageHeader title="Hello" />`)—either one rendered by another component class or a Rails view file like `app/views/products/index.rbx`. Or you can call it from ERB (or any other template language) like `PageHeaderComponent.new(self, title: "Hello").render`.
+
+Your components and their templates run in the same context as traditional Rails views, so you have access to all of the view helpers you're used to as well as any custom helpers you've defined in `app/helpers/`.
+
+#### Template-less components
+
+If you'd prefer to render your components entirely from Ruby, e.g. using Rails `tag` helpers, you can do so with `#call`:
+
+```ruby
+class PageHeaderComponent < Rbexy::Component
+  def setup(title:)
+    @title = title
+  end
+
+  def call
+    tag.h1 @title
+  end
+end
+```
+
+#### Context
+
+`Rbexy::Component` implements a similar notion to React's Context API, allowing you to pass data through the component tree without having to pass props down manually.
+
+Given a template:
+
+```jsx
+<Form>
+  <TextField field={:title} />
+</Form>
+```
+
+The form component can use Rails `form_for` and then pass the `form` builder object down to any field components using context:
+
+```ruby
+class FormComponent < Rbexy::Component
+  def setup(form_object:)
+    @form_object = form_object
+  end
+
+  def call
+    form_for @form_object do |form|
+      create_context(:form, form)
+      content
+    end
+  end
+end
+
+class TextFieldComponent < Rbexy::Component
+  def setup(field:)
+    @field = field
+    @form = use_context(:form)
+  end
+
+  def call
+    @form.text_field @field
+  end
+end
+```
+
+### `ViewComponent`
+
+Using Github's view_component library? Rbexy ships with a provider that'll resolve your RBX tags like `<Button />` to their corresponding `ButtonComponent < ViewComponent::Base` components.
+
+```ruby
+require "rbexy/component_providers/view_component_provider"
+
+Rbexy.configure do |config|
+  config.component_provider = Rbexy::ComponentProviders::ViewComponentProvider.new
+end
+```
+
+### Other types of components
+
+You just need to tell rbexy how to resolve your custom component classes as it encounters them while evaluating your template by implementing a ComponentProvider:
+
+```ruby
+class MyComponentProvider
+  def match?(name)
+    # Return true if the given tag name matches one of your custom components
+  end
+
+  def render(context, name, **attrs, &block)
+    # Instantiate and render your custom component for the given name, using
+    # the render context as needed (e.g. ActionView in Rails)
+  end
+end
+
+# Register your component provider with Rbexy
+Rbexy.configure do |config|
+  config.component_provider = MyComponentProvider.new
+end
+```
+
+See `lib/rbexy/component_providers/` for example implementations.
+
+## Usage outside of Rails
+
+Rbexy compiles your template into ruby code, which you can then execute in any context you like, so long as a tag builder is available at `#rbexy_tag`. We provide a built-in runtime leveraging ActionView's `tag` helper that you can extend from or build your own:
+
+Subclass to add methods and instance variables that you'd like to make available to your template.
+
+```ruby
+class MyRuntime < Rbexy::Runtime
+  def initialize
+    super
+    @an_ivar = "Ivar value"
+  end
+
+  def a_method
+    "Method value"
+  end
+end
+
+Rbexy.evaluate("<p class={a_method}>{@an_ivar}</p>", MyRuntime.new)
+```
+
+If you're using custom components, inject a ComponentProvider (see "Custom components" for an example implementation):
+
+```ruby
+class MyRuntime < Rbexy::Runtime
+  def initialize(component_provider)
+    super(component_provider)
+    @ivar_val = "ivar value"
+  end
+
+  def splat_attrs
+    {
+      key1: "val1",
+      key2: "val2"
+    }
+  end
+end
+
+Rbexy.evaluate(
+  "<Forms.TextField /><Button prop1=\"val1\" prop2={true && \"val2\">Submit</Button>",
+  MyRuntime.new(MyComponentProvider.new)
+)
+```
+
+Or implement your own runtime, so long as it conforms to the API:
+
+* `#rbexy_tag` that returns a tag builder conforming to the API of `ActionView::Helpers::TagHelpers::TagBuilder`
+* `#evaluate(code)` that evals the given string of ruby code
+
+## Development
+
+```
+docker-compose build
+docker-compose run rbexy rspec
+```
+
+Or auto-run tests with guard if you prefer:
+
+```
+docker-compose run rbexy guard
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rbexy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rbexy/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 Rbexy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rbexy/blob/master/CODE_OF_CONDUCT.md).