phlex-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7aecef08e1a9afbf2def43dd58671faa685463b7016d476a6b99016eb05a80c
-  data.tar.gz: 6f45234e367ebf519ea7e3d450b8405d01835e525d4c1aa4e587248892e1c154
+  metadata.gz: 6ef3316773401cb9a664f24dfaf751f282bdceafc22db5d5aa59173d96b0794c
+  data.tar.gz: 253849ceeeb4af1c1a3dd673c6e862cb17f8b1c3a13695556ccfc5b8d2855ce0
 SHA512:
-  metadata.gz: 4ca68105eef571350a8d819e3717b429dc4a650bf7fb0992743e5028373e3f6fdeaf6c0d0792c90c0aa5ea21d4b840a8fb8eee0620aae4c331c65e5532d5df82
-  data.tar.gz: 3b7feb02f6db71ce8122401d8b8ce4980d1a2c1a2e43100d6d2f1d7196ba9bf6d21b71f4f883d3df0ba8d7c287d1a602a58f787e609c641c3e0d1647b24d16e0
+  metadata.gz: 5e3cedfb00ab5762f2ffeeecf66e59a28dd8eac55d44272521c3c4094f0bd66d41d6a64925242cf429678417e87c536d644b3da0ebc0a566900665fb8863e894
+  data.tar.gz: a88ea4826134ece2cda7cfae473e362dc1571822a4e27865e99b695bbdcf5bf2cd4d745334d6a1927a10cd463c7ccac54244af99d7255be6b28a144b5f6020e3

data/.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 2
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[*.erb]
+indent_style = space
+indent_size = 2

data/.rubocop.yml

@@ -0,0 +1,31 @@
+inherit_from:
+  - "https://www.goodcop.style/rubocop.yml"
+  - "https://www.goodcop.style/tabs.yml"
+
+AllCops:
+  TargetRubyVersion: 2.7
+  Exclude:
+    - "lib/phlex-rails.rb"
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Layout/CaseIndentation:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false
+
+
+
+Security/Eval:
+  Enabled: false
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+
+Style/MixinUsage:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false

data/Appraisals

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+appraise "rails-6" do
+	gem "rails", "~> 6.1"
+end
+
+appraise "rails-7" do
+	gem "rails"
+end
+
+appraise "rails-edge" do
+	gem "rails", github: "rails/rails"
+end

data/CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Contributing to Phlex
+
+## Priorities
+
+We’re trying to provide the best possible developer experience for the people using Phlex in their apps and the best possible performance for the users of those apps.
+
+Phlex is incredibly complex and requires a lot of meta-programming but when you use it, it feels simple. Phlex views feel like plain old Ruby objects. You just subclass and define a couple of methods. That’s it. That’s how it should be.
+
+## Setup
+
+- Install dependencies `bundle install`
+- Run the tests `bundle exec sus`
+- Run Rubocop and auto-correct `bundle exec rubocop -A`
+
+## Tests
+
+We use the **[Sus](https://github.com/ioquatix/sus)** testing framework. It feels a bit like RSpec with a few small differences. There’s no documentation for Sus at the moment, but you should be able to pick up the basics from reading other tests or looking at the implementation in the Sus repo.
+
+You can run all the tests with `bundle exec sus`.
+
+## Documentation
+
+Documentation is deployed when it’s merged into the `latest` branch with a release. But you can build and preview the docs locally by running `bin/docs`.

data/Gemfile

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
 source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-# Specify your gem's dependencies in phlex-rails.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
-gem "minitest", "~> 5.0"
+gem "phlex", github: "joeldrapper/phlex"
+gem "sus"
+gem "combustion"
+gem "rubocop"
+gem "solargraph"
+gem "appraisal", github: "excid3/appraisal", branch: "fix-bundle-env"

data/README.md

@@ -1,43 +1,27 @@
-# Phlex::Rails
+<a href="https://www.phlex.fun"><img alt="Phlex logo" src="phlex_logo.png" width="180" /></a>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/phlex/rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+Phlex is a framework that lets you compose web views in pure Ruby.
 
-TODO: Delete this and the text above, and describe your gem
+### Documentation 📗
 
-## Installation
+Documentation can be found at [www.phlex.fun](https://www.phlex.fun).
 
-Add this line to your application's Gemfile:
+### Support ✋
 
-```ruby
-gem 'phlex-rails'
-```
+If you run into any trouble, please [start a discussion](https://github.com/joeldrapper/phlex/discussions/new), or [open an issue](https://github.com/joeldrapper/phlex/issues/new) if you think you’ve found a bug.
 
-And then execute:
+### Community 🙌
 
-    $ bundle install
+Everyone interacting in Phlex codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joeldrapper/phlex/blob/main/CODE_OF_CONDUCT.md).
 
-Or install it yourself as:
+### Sponsorship 💖
 
-    $ gem install phlex-rails
+Maintaining a library is a lot of work. If your company benefits from this work or is likely to benefit from it in the future, please consider [sponsorship](https://github.com/sponsors/joeldrapper). Phlex is actively developed and maintained by **[Joel Drapper](https://github.com/sponsors/joeldrapper)**.
 
-## Usage
+### Security 🚨
 
-TODO: Write usage instructions here
+If you’ve found a potential security issue, please email [security@phlex.fun](mailto:security@phlex.fun).
 
-## Development
+### Thanks 🙏
 
-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/[USERNAME]/phlex-rails. 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]/phlex-rails/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 Phlex::Rails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/phlex-rails/blob/master/CODE_OF_CONDUCT.md).
+Thanks [Logology](https://www.logology.co) for sponsoring our logo.

data/SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you found a possible security vulnerability in Phlex, please email security@phlex.fun.

data/fixtures/dummy/app/components/comment_component.html.erb

@@ -0,0 +1,14 @@
+<div>
+  <span>
+    <%= @name %>
+  </span>
+  <span>
+    <%= @body %>
+  </span>
+
+  <%= content %>
+
+  <%= render Views::Comments::Reaction.new(emoji: 'hamburger') do |reaction| %>
+    <p>Emoji reaction for a comment from <%= @name %> with body <%= @body %></p>
+  <% end %>
+</div>

data/fixtures/dummy/app/components/comment_component.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class CommentComponent < ViewComponent::Base
+	def initialize(name:, body:)
+		@name = name
+		@body = body
+	end
+end

data/fixtures/dummy/app/components/reaction_component.html.erb

@@ -0,0 +1,3 @@
+<p><%= @emoji %></p>
+
+<%= content %>

data/fixtures/dummy/app/components/reaction_component.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class ReactionComponent < ViewComponent::Base
+	def initialize(emoji:)
+		@emoji = emoji
+	end
+end

data/fixtures/dummy/app/controllers/articles_controller.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ArticlesController < ActionController::Base
+end

data/fixtures/dummy/app/controllers/comments_controller.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class CommentsController < ActionController::Base
+end

data/fixtures/dummy/app/views/application_view.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Views
+	class ApplicationView < Phlex::HTML
+		include Rails.application.routes.url_helpers
+	end
+end

data/fixtures/dummy/app/views/articles/form.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Views
+	module Articles
+		class Form < ApplicationView
+			include Phlex::Rails::Helpers::FormWith
+
+			def template
+				form_with url: "test" do |f|
+					f.text_field :name
+				end
+			end
+		end
+	end
+end

data/fixtures/dummy/app/views/articles/index.html.erb

@@ -0,0 +1,14 @@
+<p>Before</p>
+
+<%= render(Views::Heading.new) { "Hello World!" } %>
+
+<%= render Views::Card.new do |a| %>
+  <p>Start Card A</p>
+  <%= a.title "Hello from A" %>
+  <%= render Views::Card.new do |b| %>
+    <p>Start Card B</p>
+    <%= b.title "Hello from B" %>
+    <p>End Card B</p>
+  <% end %>
+  <p>End Card A</p>
+<% end %>

data/fixtures/dummy/app/views/articles/new.html.erb

@@ -0,0 +1 @@
+<%= render Views::Articles::Form.new %>

data/fixtures/dummy/app/views/card.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Views
+	class Card < ApplicationView
+		def template(&block)
+			article class: "drop-shadow p-5 rounded", &block
+		end
+
+		def title(text)
+			h3 class: "font-bold" do
+				text
+			end
+		end
+	end
+end

data/fixtures/dummy/app/views/comments/comment.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Views
+	module Comments
+		class Comment < ApplicationView
+			def initialize(name:, body:)
+				@name = name
+				@body = body
+			end
+
+			def template(&block)
+				div {
+					span { @name }
+					span { @body }
+
+					yield_content(&block)
+
+					render(::ReactionComponent.new(emoji: "hamburger")) do
+						p { "Emoji reaction for a comment from #{@name} with body #{@body}" }
+					end
+				}
+			end
+		end
+	end
+end

data/fixtures/dummy/app/views/comments/index.html.erb

@@ -0,0 +1,3 @@
+<%= render(CommentComponent.new(name: "Matz", body: "hey, folks")) do %>
+  Hello, World from a ViewComponent!
+<% end %>

data/fixtures/dummy/app/views/comments/reaction.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Views
+	module Comments
+		class Reaction < ApplicationView
+			def initialize(emoji:)
+				@emoji = emoji
+			end
+
+			def template(&block)
+				p { @emoji }
+
+				yield_content(&block)
+			end
+		end
+	end
+end

data/fixtures/dummy/app/views/comments/show.html.erb

@@ -0,0 +1,3 @@
+<%= render Views::Comments::Comment.new(name: "_why", body: "I'm back") do %>
+  Hello, World from a Phlex Component!
+<% end %>

data/fixtures/dummy/app/views/heading.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Views
+	class Heading < ApplicationView
+		def template(&block)
+			h1(&block)
+		end
+	end
+end

data/fixtures/dummy/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/fixtures/dummy/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+	# Rails routes here
+end

data/fixtures/dummy/config/storage.yml

@@ -0,0 +1,3 @@
+test:
+  service: Disk
+  root: /Users/joeldrapper/src/joeldrapper/phlex/tmp/storage

data/fixtures/dummy/db/schema.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+ActiveRecord::Schema.define do
+	# Set up any tables you need to exist for your test suite that don't belong
+	# in migrations.
+end

data/fixtures/dummy/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/fixtures/rails_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+Bundler.require :default
+
+Combustion.path = "fixtures/dummy"
+
+Combustion.initialize! :action_controller do
+	config.autoload_paths << "#{root}/app"
+end

data/fixtures/view_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ViewHelper
+	def self.extended(parent)
+		parent.class_exec do
+			let(:output) { example.call }
+			let(:example) { view.new }
+		end
+	end
+
+	def view(&block)
+		let :view do
+			Class.new(Phlex::HTML, &block)
+		end
+	end
+end

data/lib/generators/phlex/collection/USAGE

@@ -0,0 +1,8 @@
+Description:
+  Generates a Phlex collection view with the given name
+
+Example:
+  rails generate phlex:collection Articles::List
+
+This will create:
+  app/views/articles/list.rb

data/lib/generators/phlex/collection/collection_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Phlex
+	module Generators
+		class CollectionGenerator < ::Rails::Generators::NamedBase
+			source_root File.expand_path("templates", __dir__)
+
+			def create_view
+				template "collection.rb.erb", File.join("app/views", class_path, "#{file_name}.rb")
+			end
+		end
+	end
+end

data/lib/generators/phlex/collection/templates/collection.rb.erb

@@ -0,0 +1,16 @@
+<% module_namespacing do -%>
+module Views
+  class <%= class_name %> < Phlex::HTML
+    include ApplicationView
+    include Phlex::Collection
+
+    def collection_template(&)
+      ul(&)
+    end
+
+    def item_template
+      li { @item }
+    end
+  end
+end
+<% end %>

data/lib/generators/phlex/controller/USAGE

@@ -0,0 +1,10 @@
+Description:
+  Generates a Rails controller with Phlex views for the supplied actions
+
+Example:
+  rails generate phlex:controller Articles index show
+
+This will create:
+  app/controllers/articles_controller.rb
+  app/views/articles/index.rb
+  app/views/articles/show.rb

data/lib/generators/phlex/controller/controller_generator.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Phlex
+	module Generators
+		class ControllerGenerator < ::Rails::Generators::NamedBase # :nodoc:
+			source_root File.expand_path("templates", __dir__)
+
+			argument :actions, type: :array, default: [], banner: "action action"
+			class_option :skip_routes, type: :boolean, desc: "Don't add routes to config/routes.rb."
+			class_option :parent, type: :string, default: "ApplicationController", desc: "The parent class for the generated controller"
+
+			check_class_collision suffix: "Controller"
+
+			def create_controller_files
+				template "controller.rb.erb", File.join("app/controllers", class_path, "#{file_name}_controller.rb")
+			end
+
+			def copy_view_files
+				base_path = File.join("app/views", class_path, file_name)
+				empty_directory base_path
+
+				actions.each do |action|
+					Rails::Generators.invoke("phlex:view", [remove_possible_suffix(name) + "/" + action])
+				end
+			end
+
+			def add_routes
+				return if options[:skip_routes]
+				return if actions.empty?
+
+				routing_code = actions.map { |action| "get '#{file_name}/#{action}'" }.join("\n")
+				route routing_code, namespace: regular_class_path
+			end
+
+			hook_for :test_framework, as: :controller do |generator|
+				invoke generator, [remove_possible_suffix(name), actions]
+			end
+
+			private
+
+			def parent_class_name
+				options[:parent]
+			end
+
+			def file_name
+				@_file_name ||= remove_possible_suffix(super)
+			end
+
+			def remove_possible_suffix(name)
+				name.sub(/_?controller$/i, "")
+			end
+		end
+	end
+end

data/lib/generators/phlex/controller/templates/controller.rb.erb

@@ -0,0 +1,10 @@
+<% module_namespacing do -%>
+class <%= class_name %>Controller < <%= parent_class_name.classify %>
+<% actions.each do |action| -%>
+  def <%= action %>
+    render Views::<%= class_name %>::<%= action.camelize %>.new
+  end
+<%= "\n" unless action == actions.last -%>
+<% end -%>
+end
+<% end -%>

data/lib/generators/phlex/controller/templates/view.rb.erb

@@ -0,0 +1,14 @@
+<% module_namespacing do -%>
+module Views
+  class <%= class_name %>::<%= @action.camelize %> < Phlex::HTML
+    include ApplicationView
+
+    def template
+      <%= "# " unless @has_layout %>render Layout.new(title: "<%= class_name.gsub("::", " ").titlecase %> - <%= @action.titlecase %>") do
+        h1 { "<%= class_name %>#<%= @action %>" }
+        p { "Find me in <%= @path %>" }
+      <%= "# " unless @has_layout %>end
+    end
+  end
+end
+<% end %>

data/lib/generators/phlex/layout/USAGE

@@ -0,0 +1,8 @@
+Description:
+  Generates a Phlex layout view with the given name
+
+Example:
+  rails generate phlex:layout Layout
+
+This will create:
+  app/views/layout.rb

data/lib/generators/phlex/layout/layout_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Phlex
+	module Generators
+		class LayoutGenerator < ::Rails::Generators::NamedBase
+			source_root File.expand_path("templates", __dir__)
+
+			def create_view
+				template "layout.rb.erb", File.join("app/views", class_path, "#{file_name}.rb")
+			end
+		end
+	end
+end

data/lib/generators/phlex/layout/templates/layout.rb.erb

@@ -0,0 +1,31 @@
+<% module_namespacing do -%>
+module Views
+  class <%= class_name %> < Phlex::HTML
+    include ApplicationView
+    include Phlex::Rails::Layout
+
+    def initialize(title:)
+      @title = title
+    end
+
+    def template(&)
+      doctype
+
+      html do
+        head do
+          meta charset: "utf-8"
+          csp_meta_tag
+          csrf_meta_tags
+          meta name: "viewport", content: "width=device-width,initial-scale=1"
+          title { @title }
+          stylesheet_link_tag "application"
+        end
+
+        body do
+          main(&)
+        end
+      end
+    end
+  end
+end
+<% end %>

data/lib/generators/phlex/page/USAGE

@@ -0,0 +1,8 @@
+Description:
+  Generates a Phlex page view with the given name
+
+Example:
+  rails generate phlex:page Articles::Index
+
+This will create:
+  app/views/articles/index.rb

data/lib/generators/phlex/page/page_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Phlex
+	module Generators
+		class PageGenerator < ::Rails::Generators::NamedBase
+			source_root File.expand_path("templates", __dir__)
+
+			def create_view
+				template "page.rb.erb", File.join("app/views", class_path, "#{file_name}.rb")
+			end
+		end
+	end
+end

data/lib/generators/phlex/page/templates/page.rb.erb

@@ -0,0 +1,13 @@
+<% module_namespacing do -%>
+module Views
+  class <%= class_name %> < Phlex::HTML
+    include ApplicationView
+
+    def template
+      render Layout.new(title: "<%= class_name.gsub("::", " ") %>") do
+        h1 { "👋 Hello World!" }
+      end
+    end
+  end
+end
+<% end %>