berns 3.4.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 844af14032659e36711f21b482d7e07ba1627cdca43045ec1fb30869171ee21a
-  data.tar.gz: 828da05830d2d5c1a516fe51bcc2a5c5c9c346359f9eedde4b3ee5bd60a6bf25
+  metadata.gz: eb2de0ba05a5e234fa5cef7edf3a222411222d0743c0e69492c1e1d5e53541bb
+  data.tar.gz: f62f2273f787a46aa18784b668f1110adb80a1bbb8c33226c9c58e585d5acec7
 SHA512:
-  metadata.gz: 93e0a7fc35666b0395d338cafc5a7aa9bb8aa3d1467158cdb1fc325640d275b3cfa0033921edfd62f0d6a52cbf8728842b45c31ea4d19552d18ee6440c135b59
-  data.tar.gz: 6bc2ea5f4749e09d8bbc4dacd2fac2981ad66dfdc649cb14f78a50ed21af5705d057228764edf6bdd32e4eb4dc8e848f6a42ffbab157ec9bf78f05c94899be6c
+  metadata.gz: 7d8fb46aeb4dc948729b36bbb6a794625618c34742ee2b18024d1cde99bda330b21bd7fb890bd241010a9b60e956c81fe401c3036464a90d28fb4ebca11ba621
+  data.tar.gz: c7c430ae90da5be3b93f15d1ac6ab2bba300b89558cfb131af276b2af9d2e82b118fa0691000402bf7e982e13406defc275c786e2e512304041f660afe0b53cc

data/README.org

@@ -1,6 +1,7 @@
 * Berns
 
 [[https://badge.fury.io/rb/berns][https://badge.fury.io/rb/berns.svg]]
+[[https://github.com/evanleck/berns/actions/workflows/main.yml][https://github.com/evanleck/berns/actions/workflows/main.yml/badge.svg]]
 
 A utility library for generating HTML strings.
 
@@ -121,15 +122,33 @@ template = Berns::Builder.new do
 end
 #+end_src
 
-Within the block provided to =Berns::Builder.new= every standard and void
-element is available as a method and each time you use one of those methods the
-result is appended to an internal buffer. In addition, the =#text= method can be
-used to append a plain text string to the buffer and that text will be HTML
-escaped, so it's good for untrusted content.
+Within the block provided to =Berns::Builder.new= every standard element method,
+void element method, =#element=, and =#void= are available as methods and each
+time you use one of those methods the result is appended to an internal buffer.
+In addition, the =#text= method appends HTML escaped text to the buffer and
+=#raw= appends text to the buffer without modification.
 
-Once initialized, rendering the template to a string can be done with the
-=#call= method and any arguments, positional or keyword, will be passed through
-as-is to the block provided to =#new=.
+The block provided to =Berns::Builder.new= can take both positional and keyword
+arguments.
+
+#+begin_src ruby
+template = Berns::Builder.new do |content, title:|
+  h1 { title }
+  p(class: 'paragraph') { content }
+end
+
+template.call('Some text.', title: 'The title') # =>
+# <h1>
+#   The title
+# </h1>
+# <p>
+#   Some text.
+# </p>
+#+end_src
+
+Once initialized, the =#call= method will render the template to a string. Any
+arguments, positional or keyword, are passed through as-is to the block provided
+to =#new=.
 
 #+begin_src ruby
 string = template.call # =>
@@ -167,6 +186,7 @@ end # =>
 # </p>
 #+end_src
 
+
 *** Standard and void elements
 
 All standard and void HTML elements are defined as methods on Berns, so you can

data/ext/berns/berns.c

@@ -228,7 +228,7 @@ static char * hash_value_to_attribute(const char *attr, const size_t attrlen, VA
 
   Check_Type(value, T_HASH);
 
-  if (rb_hash_size(value) == 1) {
+  if (RHASH_SIZE(value) == 0) {
     return strdup("");
   }
 
@@ -439,7 +439,7 @@ static VALUE external_to_attribute(RB_UNUSED_VAR(VALUE self), VALUE attr, VALUE
 static VALUE external_to_attributes(RB_UNUSED_VAR(VALUE self), VALUE attributes) {
   Check_Type(attributes, T_HASH);
 
-  if (rb_hash_size(attributes) == 1) {
+  if (RHASH_SIZE(attributes) == 0) {
     return rb_utf8_str_new_cstr("");
   }
 
@@ -453,37 +453,32 @@ static VALUE external_to_attributes(RB_UNUSED_VAR(VALUE self), VALUE attributes)
 }
 
 static char * void_element(const char *tag, size_t tlen, VALUE attributes) {
-  /* T_IMEMO is what we get if an optional argument was not passed. */
-  if (TYPE(attributes) == T_IMEMO) {
-    size_t total = tag_olen + tlen + tag_clen + 1;
-    char *string = malloc(total);
-    char *ptr;
-    char *end = string + total;
+  const char *empty = "";
+  char *attrs = hash_value_to_attribute(empty, 0, attributes);
+  size_t alen = strlen(attrs);
 
-    ptr = stecpy(string, tag_open, end);
-    ptr = stecpy(ptr, tag, end);
-    ptr = stecpy(ptr, tag_close, end);
+  size_t total = tag_olen + tlen + tag_clen + 1;
 
-    return string;
-  } else {
-    const char *empty = "";
-    char *attrs = hash_value_to_attribute(empty, 0, attributes);
+  /* If we have some attributes, add a space and the attributes' length. */
+  if (alen > 0) {
+    total += splen + alen;
+  }
 
-    size_t total = tag_olen + tlen + splen + strlen(attrs) + tag_clen + 1;
-    char *string = malloc(total);
-    char *ptr;
-    char *end = string + total;
+  char *dest = malloc(total);
+  char *ptr = NULL;
+  char *end = dest + total;
 
-    ptr = stecpy(string, tag_open, end);
-    ptr = stecpy(ptr, tag, end);
+  ptr = stecpy(dest, tag_open, end);
+  ptr = stecpy(ptr, tag, end);
+
+  if (alen > 0) {
     ptr = stecpy(ptr, space, end);
     ptr = stecpy(ptr, attrs, end);
-    ptr = stecpy(ptr, tag_close, end);
+  }
 
-    free(attrs);
+  ptr = stecpy(ptr, tag_close, end);
 
-    return string;
-  }
+  return dest;
 }
 
 /*

data/ext/berns/extconf.rb

@@ -9,5 +9,6 @@ append_cflags '-Wstrict-overflow'
 append_cflags '-flto'
 append_cflags '-fno-strict-aliasing'
 append_cflags '-msse4'
+append_cflags '-std=c99'
 
 create_makefile 'berns/berns'

data/lib/berns/builder.rb

@@ -5,22 +5,28 @@ module Berns
   # An HTML builder DSL using Berns' HTML methods.
   class Builder
     def initialize(&block)
+      raise(ArgumentError, 'Berns::Builder initialized without a block argument', caller) unless block
+
       @block = block
-      @buffer = +''
     end
 
     # @return [String]
-    def call(*args, **opts)
-      instance_exec(*args, **opts, &@block)
-      to_s
-    end
+    def call(*args, **kwargs)
+      @buffer = +''
+      content = instance_exec(*args, **kwargs, &@block)
 
-    # @return [String]
-    def to_s
-      @buffer.freeze
+      # This is a special case where the buffer hasn't been appended to but the
+      # block returned a string.
+      if @buffer.empty? && content.is_a?(String)
+        Berns.escape_html(content).freeze
+      else
+        @buffer.freeze
+      end
     end
+    alias to_s call
+    alias to_str call
 
-    # Append text to the buffer.
+    # Append HTML escaped text to the buffer.
     #
     # @param string [String]
     # @return [String]
@@ -28,16 +34,39 @@ module Berns
       @buffer << Berns.escape_html(string.to_s)
     end
 
+    # Append raw text to the buffer.
+    #
+    # @param string [String]
+    # @return [String]
+    def raw(string)
+      @buffer << string.to_s
+    end
+
+    # Append an arbitrary standard element to the buffer.
+    #
+    # @return [String]
+    def element(elm, *args, **kwargs, &block)
+      content = Builder.new(&block).call if block
+      @buffer << Berns.element(elm, *args, **kwargs) { content }
+    end
+
+    # Append an arbitrary void element to the buffer.
+    #
+    # @return [String]
+    def void(...)
+      @buffer << Berns.void(...)
+    end
+
     Berns::STANDARD.each do |meth|
-      define_method(meth) do |*args, **opts, &block|
-        content = Builder.new.instance_exec(*args, **opts, &block) if block
-        @buffer << Berns.send(meth, *args, **opts) { content }
+      define_method(meth) do |*args, **kwargs, &block|
+        content = Builder.new(&block).call if block
+        @buffer << Berns.send(meth, *args, **kwargs) { content }
       end
     end
 
     Berns::VOID.each do |meth|
-      define_method(meth) do |*args, **opts|
-        @buffer << Berns.send(meth, *args, **opts)
+      define_method(meth) do |*args, **kwargs|
+        @buffer << Berns.send(meth, *args, **kwargs)
       end
     end
   end

data/lib/berns/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Berns
-  VERSION = '3.4.0'
+  VERSION = '4.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: berns
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Taylor Beck
@@ -9,148 +9,8 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: benchmark-ips
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake-compiler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-packaging
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2022-06-14 00:00:00.000000000 Z
+dependencies: []
 description: A utility library for generating HTML strings.
 email:
 - beck.taylorg@gmail.com
@@ -175,6 +35,8 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/evanleck/berns/issues
+  changelog_uri: https://github.com/evanleck/berns/blob/main/CHANGELOG.org
+  homepage_uri: https://github.com/evanleck/berns
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/evanleck/berns
 post_install_message:
@@ -185,14 +47,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A utility library for generating HTML strings.