Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcoroth/phlexing
Simple ERB to Phlex converter
https://github.com/marcoroth/phlexing
erb hotwire html phlex rails ruby
Last synced: about 2 months ago
JSON representation
Simple ERB to Phlex converter
- Host: GitHub
- URL: https://github.com/marcoroth/phlexing
- Owner: marcoroth
- Created: 2022-09-20T12:49:52.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T19:54:00.000Z (5 months ago)
- Last Synced: 2024-05-01T15:57:58.703Z (5 months ago)
- Topics: erb, hotwire, html, phlex, rails, ruby
- Language: Ruby
- Homepage: https://phlexing.fun
- Size: 1.44 MB
- Stars: 71
- Watchers: 2
- Forks: 9
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Phlexing
[](https://github.com/marcoroth/phlexing/actions/workflows/tests.yml)
[](https://github.com/marcoroth/phlexing/actions/workflows/rubocop.yml)
A simple ERB to [Phlex](https://www.phlex.fun) Converter.
## Website
A hosted version of the converter is running at [https://phlexing.fun](https://phlexing.fun).
## Using the gem
### Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add phlexing
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install phlexing
### Basic Usage
```ruby
require "phlexing"
Phlexing::Converter.convert(%(
Hello World
))
```
##### Output
```ruby
h1(class: "title") { "Hello World" }
```
### Converter Options
| Option | Type | Default Value | Description |
| --- | --- | --- | --- |
| `whitespace` | `Boolean` | `true` | Generate whitespace in and around HTML block elements. |
| `component` | `Boolean` | `false` | Generate a Phlex class with a `view_template` method around your input. |
| `component_name` | `String` | `"Component"` | The name of your Phlex class. |
| `parent_component` | `String` | `"Phlex::HTML"` | The name of the parent class your Phlex class will inherit from. |
| `svg_param` | `String` | `"s"` | The name of the block argument Phlex will use to generate SVG-specific elements. |
| `template_name` | `String` | `"view_template"` | The name of the generated template method in your Phlex class. |
### Multi-line HTML
```ruby
Phlexing::Converter.convert(<<~HTML)
<% @articles.each do |article| %>
<%= article.title %>
<% end %>
HTML
```
##### Output
```ruby
@articles.each { |article| h1 { article.title } }
```
### Component class
```ruby
Phlexing::Converter.convert(<<~HTML, component: true)
<%= @user.name %>
<%= posts.count %> Posts
HTML
```
##### Output
```ruby
class Component < Phlex::HTML
attr_accessor :posts
def initialize(posts:, user:)
@posts = posts
@user = user
end
def view_template
h1 { @user.name }
p do
text posts.count
text %( Posts)
end
end
end
```
### Rails Helpers
```ruby
Phlexing::Converter.convert(%(<%= link_to "Home", root_path %>), component: true)
```
##### Output
```ruby
class Component < Phlex::HTML
include Phlex::Rails::Helpers::LinkTo
include Phlex::Rails::Helpers::Routes
def view_template
link_to "Home", root_path
end
end
```
### Private component methods
```ruby
Phlexing::Converter.convert(%(<% if active? %>Active<% else %>Inactive<% end %>), component: true)
```
##### Output
```ruby
class Component < Phlex::HTML
def view_template
if active?
text "Active"
else
text "Inactive"
end
end
private
def active?(*args, **kwargs)
# TODO: Implement me
end
end
```
### ERB Attribute interpolation
```ruby
Phlexing::Converter.convert(%(
">))
```
##### Output
```ruby
div(style: %(background: #{active? ? "green" : "gray"}))
```
### Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/marcoroth/phlexing. 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/marcoroth/phlexing/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 Phlexing project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marcoroth/phlexing/blob/master/CODE_OF_CONDUCT.md).