triplet 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b40b0b70887646a31162a22cabddccae123dbccda5d43dc80fd7242b5aa94f81
-  data.tar.gz: 48bfda56958ed0fe61cb24706217b7f64488cd5154ef6f35385cb090abc956f0
+  metadata.gz: 6ec92ece8a32167845522f68fc13eb3626fc8050a50c2d9d2a3ec584a6484352
+  data.tar.gz: 776de546e4d65f5e86a918a6b6df82e0d6943865d45bfa141c68fa9392a5b065
 SHA512:
-  metadata.gz: a41c7887916837e1f588fd5ebb224d5de2995abba38f2724d1dbb02aa7c9bea51d59b340851d98cc0fe362aa805f2f226870e745af06bf3224c6bc83fd69dfbe
-  data.tar.gz: a6dd49020e45e0feeb3e0ee616f3c04832956c4a6c0c7d133b8435874092f2d7c7a15861f9b815f5c2025811af62733060ffae0a22acd83ff11e2b3e3a36412c
+  metadata.gz: c1136f57bb9c8f01e6ea6bae45fae3d86ec41257f748ffdcc379d8872cf67c516013eac3d06b2184f2d0ba8ff15beb09e3cffcb9b568cf6de2d65380e2fe2ccf
+  data.tar.gz: 42e305e5979eee1de486473a7bcc38d0172e1f7da5df5fed4ab0960562ccca9a38b24c5fe245322cc76ae10ec2556dcb9994a0a1e1941e3021685b2a6ef1e236

data/.github/workflows/ruby.yml

@@ -0,0 +1,23 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7' ]
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    triplet (0.1.2)
+    triplet (0.2.0)
       actionview (>= 5.0.0, < 7.0)
 
 GEM

data/README.md

@@ -3,6 +3,14 @@
 A simple Ruby DSL for defining templates. (Maybe) useful for defining single file [view
 components](https://github.com/github/view_component).
 
+Features:
+
+* Easy to use "AST" for defining HTML tags. `[:a, { href: "/" }, "Home"]`
+* DSL methods to make defining triplets easier. `a(href: "/") { "Home" }`
+* Supports Rails helper methods. e.g. `form_for`, `text_field_tag`, `link_to`,
+  etc.
+* View Component support via `include Triplet::ViewComponent`
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,22 +26,18 @@ And then execute: `bundle install` in your shell.
 ```ruby
 nav_items = { "home": "/", "Sign Up": "/sign-up" }
 
-Triplet.template do
-  nav class: "max-w-3xl mx-auto flex" do
-    h1(class: "font-3xl") { "My App" }
-
-    ul class: "" do
-      nav_items.each do |name, link|
-        li class: "bold font-xl" do
-          a href: link.html_safe { name }
-        end
+Triplet.template {[
+  nav(class: "max-w-3xl mx-auto flex") {[
+    h1(class: "font-3xl") { "My App" },
+    ul(class: "") {[
+      nav_items.map do |name, link|
+        li(class: "bold font-xl") {[ a(href: link.html_safe) { name } ]}
       end
-    end
-  end
-
-  text "Hello"
-  span(class: "bold") { "world" }
-end
+    ]}
+  ]},
+  "Hello",
+  span(class: "bold") { "world" },
+]}
 ```
 
 Will output the equivalent HTML:
@@ -42,26 +46,25 @@ Will output the equivalent HTML:
 <nav class="max-w-3xl mx-auto flex">
    <h1 class="font-3xl">My App</h1>
    <ul class="">
-      <li class="bold font-xl"><a href="/"></a></li>
-      <li class="bold font-xl"><a href="/sign-up"></a></li>
+      <li class="bold font-xl"><a href="/">home</a></li>
+      <li class="bold font-xl"><a href="/sign-up">Sign Up</a></li>
    </ul>
 </nav>
 Hello<span class="bold">world</span>
 ```
 
-If you need a custom tag, you can use the `tag` helper method:
+The tag methods (e.g. `nav`, `h1`, `p`) are helpers that turn Ruby code into
+triples, or 3 element arrays.
 
-```ruby
-tag("my-tag", "custom-attribute" => "value") { "body content" }
-# <my-tag custom-attribute="value">body content</my-tag>
-```
+e.g. `p(class: "font-xl") { "hello world!" }` becomes `[:p, { class: "font-xl" }, "hello world!"]`
 
-To output strings with no wrapping tag, use the `text` helper:
+The two formats can be used interchangeably in templates.
+
+If you need a custom tag, you can return a triplet directly:
 
 ```ruby
-text "hello "
-b { "world" }
-# hello <b>world</b>
+[:"my-tag", { "custom-attribute" => "value" }, ["body content"]]
+# <my-tag custom-attribute="value">body content</my-tag>
 ```
 
 ### View Component Support
@@ -70,14 +73,15 @@ To use in view components, include the `Triplet::ViewComponent` module and
 define a `call` method. The module will handle the rest.
 
 ```ruby
-class NavComponent < ::ViewComponent::Base
+class NavComponent < ViewComponent::Base
   include Triplet::ViewComponent
 
-  def call
-    h1 { "hello world" }
-
-    render NavItemComponent.new(title: "Home", path: "/")
-    render NavItemComponent.new(title: "Pricing", path: "/pricing")
+  def template
+    [
+      h1 { "hello world" },
+      render NavItemComponent.new(title: "Home", path: "/"),
+      render NavItemComponent.new(title: "Pricing", path: "/pricing")
+    ]
   end
 end
 ```

data/lib/triplet.rb

@@ -3,8 +3,8 @@
 require "action_view" # Necessary for output buffer
 
 require "triplet/version"
-require "triplet/template"
 require "triplet/dsl"
+require "triplet/template"
 
 module Triplet
   class Error < StandardError; end

data/lib/triplet/dsl.rb

@@ -2,6 +2,9 @@
 
 module Triplet
   module DSL
+    include ActionView::Helpers::CaptureHelper
+    include ActionView::Helpers::TagHelper
+
     TAGS = [
       :a, :abbr, :address, :area, :article, :aside, :audio,
       :b, :base, :bdi, :bdo, :blockquote, :body, :br, :button,
@@ -30,61 +33,51 @@ module Triplet
     # TODO handle VOID_TAGS specially
     TAGS.each do |tag|
       define_method tag do |attrs = {}, &block|
-        tag(tag, attrs, &block)
+        [
+          tag,
+          attrs,
+          block&.call,
+        ]
       end
     end
 
-    def text(text)
-      @output_buffer << text
-    end
-
-    def tag(tag, attrs = {}, &block)
-      @output_buffer.safe_concat "<#{tag}"
-      @output_buffer.safe_concat " " unless attrs.empty?
-      _write_attributes(attrs)
-      @output_buffer.safe_concat ">"
-
-      if block
-        value = nil
-        result = capture do
-          value = block.call
-        end
+    def render_triplet(triplet)
+      if triplet.is_a?(String)
+        triplet
+      elsif triplet.is_a?(Array)
+        # If the array size is 3 and the first object is a
+        # symbol, it's likely a renderable triplet
+        if triplet.length == 3 && triplet[0].is_a?(Symbol)
+          tag, attrs, children = triplet
 
-        # Supports returning a string directlycfrom blocks
-        if result.length == 0 && value
-          @output_buffer << value
+          content_tag(tag, attrs) do
+            if children.is_a?(Array)
+              safe_join(children.map { |c| render_triplet(c) }, "")
+            else
+              render_triplet(children)
+            end
+          end
         else
-          @output_buffer << result
+          safe_join(triplet.map { |c| render_triplet(c) }, "")
         end
+      else
+        triplet.to_s
       end
-
-      @output_buffer.safe_concat "</#{tag}>"
     end
 
     private
 
-    def _write_attributes(attrs)
-      attrs.each_with_index do |(k,v), i|
-        @output_buffer << k.to_s
-        @output_buffer.safe_concat '="'
-        @output_buffer << v.to_s
-        @output_buffer.safe_concat '"'
-        @output_buffer.safe_concat ' ' if i != attrs.length - 1
-      end
-    end
+    attr_accessor :output_buffer
 
-    def capture
-      original_output_buffer = @output_buffer
-
-      begin
-        @output_buffer = ActionView::OutputBuffer.new
-        yield
-        @output_buffer
-      ensure
-        @output_buffer = original_output_buffer
+    # Override capture to support triplets
+    def capture(*args)
+      value = nil
+      buffer = with_output_buffer { value = yield(*args) }
+      if (string = buffer.presence || value) && string.is_a?(String)
+        ERB::Util.html_escape string
+      elsif value.is_a?(Array) # This is the only change, adds triplet support
+        render_triplet(value)
       end
     end
   end
 end
-
-Triplet::Template.include(Triplet::DSL)

data/lib/triplet/rails_compatibility.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+#
+require "view_component"
+
+module Triplet
+  module RailsCompatibility
+    VALID_SUFFIXES = ["_field", "_button", "text_area"].freeze
+    VALID_METHODS = [
+      "form_for",
+      "form_with",
+      "label",
+      "fields_for",
+      "fields",
+    ].freeze
+    include ActionView::Helpers::FormTagHelper
+    include ActionView::Helpers::FormHelper
+
+    # Override helpers to modify @output_buffer directly
+    (
+      ActionView::Helpers::FormTagHelper.public_instance_methods +
+      ActionView::Helpers::FormHelper.public_instance_methods
+    ).each do |method|
+      alias_method :"original_#{method}", method
+      define_method method do |*args, **kwargs, &block|
+        puts "calling #{method}"
+        result = public_send(:"original_#{method}", *args, **kwargs, &block)
+
+        if result.class < String
+          @output_buffer << result
+        end
+
+        nil # Necessary to prevent double renders
+      end
+    end
+  end
+end

data/lib/triplet/template.rb

@@ -2,10 +2,12 @@
 
 module Triplet
   class Template
+    include Triplet::DSL
+
     def initialize(output_buffer = ActionView::OutputBuffer.new, &block)
       @output_buffer = output_buffer
 
-      instance_eval(&block)
+      @output_buffer << render_triplet(instance_eval(&block))
     end
 
     def to_s

data/lib/triplet/version.rb

@@ -1,3 +1,3 @@
 module Triplet
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/triplet/view_component.rb

@@ -5,10 +5,12 @@ require "view_component"
 module Triplet
   module ViewComponent
     include Triplet::DSL
+    alias_method :template_tag, :template
 
-    def render_in(view_context, &block)
-      @output_buffer ||= ActionView::OutputBuffer.new
-      super(view_context, &block)
+    def self.included(klass)
+      klass.define_method(:call) do
+        render_triplet(template)
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: triplet
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Blake Williams
@@ -107,6 +107,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -118,6 +119,7 @@ files:
 - bin/setup
 - lib/triplet.rb
 - lib/triplet/dsl.rb
+- lib/triplet/rails_compatibility.rb
 - lib/triplet/template.rb
 - lib/triplet/version.rb
 - lib/triplet/view_component.rb