berns 3.5.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcded7fea247763fc7b27807c2c945943e0f08895b117ae086e4041bf1b08371
-  data.tar.gz: 965518819feb3eef689f19b7cc5470a973198b891e00f9d7f8ac7fd5b4620119
+  metadata.gz: c6e746c49f8701090aa423558ef9ccc644cff448b9c9c4f0c55e2752fda3ccf6
+  data.tar.gz: 9cb5b7761c29041c95b0ae9e00b4d98f8bffc06130bd02f9d3e4cecec31bc310
 SHA512:
-  metadata.gz: f023bfcde5d5b272477d2dd7e7c2d6de430c4ec544d6a10da75f7ff72b5980349d282710796a2ac5c4bede5e72df5456dd733828c7869f3f1231b26314f450e4
-  data.tar.gz: d606bdeed6b199fa467c4f80236d9dab40ef0db13e3105397bbe411caffa71c00274ea5902e1ce3f4764ab915cada0a9574d133905f07e28a348e2e28f9b7cfa
+  metadata.gz: 465a227cbce7038041f4faf90a976fdd2d04a0833f140acf9c3aa26f74d6a9439155aa4bf15fbd78801aefc3b5fa88f7de11b248817e7e3ce83efc5983d9330e
+  data.tar.gz: e33fb6252cd1ab022d7543fb0275d2e1dc3e13fd1c966bb53ca3b806029d3b498212137995597910f6382bc036d4e22c322892732ca8a65ab49bc37b917451c7

data/README.org

@@ -125,12 +125,30 @@ end
 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 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.
+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 # =>
@@ -168,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
@@ -196,20 +215,22 @@ area base br col embed hr img input link menuitem meta param source track wbr
 
 ** Performance
 
-Berns 3 is about three times faster than the pure Ruby implementation used in
-version 2. See the file [[file:benchmarks/performance.rb][benchmarks/performance.rb]] for the benchmark code.
+Berns 3 was a total rewrite from a pure Ruby implementation to one powered by a
+C extension. That rewrite is about three times faster than the pure Ruby
+implementation used in version 2. See the file [[file:benchmarks/performance.rb][benchmarks/performance.rb]] for the
+benchmark code.
 
 #+begin_example
 Warming up --------------------------------------
-             element    27.373k i/100ms
-               berns    94.118k i/100ms
+                ruby    27.521k i/100ms
+               c-ext    74.915k i/100ms
 Calculating -------------------------------------
-             element    314.078k (± 4.5%) i/s -      1.588M in   5.065539s
-               berns    935.528k (± 6.1%) i/s -      4.706M in   5.049718s
+                ruby    275.913k (± 1.0%) i/s -      1.404M in   5.087516s
+               c-ext    813.113k (± 1.0%) i/s -      4.120M in   5.067902s
 
 Comparison:
-               berns:   935527.9 i/s
-             element:   314078.4 i/s - 2.98x  (± 0.00) slower
+               c-ext:   813113.3 i/s
+                ruby:   275913.5 i/s - 2.95x  (± 0.00) slower
 #+end_example
 
 ** Trivia

data/ext/berns/berns.c

@@ -357,7 +357,20 @@ static char * hash_value_to_attribute(const char *attr, const size_t attrlen, VA
     free(combined);
   }
 
-  return destination;
+  /*
+   * Reallocate destination to final size. This is generally a reduction in the
+   * allocated memory since we chunk allocations in 256 byte multiples.
+   */
+  char *rightsizeddest = realloc(destination, occupied + 1);
+
+  if (rightsizeddest == NULL) {
+    free(destination);
+    rb_raise(rb_eNoMemError, "Berns could not allocate sufficient memory.");
+  }
+
+  rightsizeddest[occupied] = '\0';
+
+  return rightsizeddest;
 }
 
 /*

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,31 +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(*args, **opts, &block)
-      content = Builder.new.instance_exec(*args, **opts, &block) if block
-      @buffer << Berns.element(*args, **opts) { content }
+    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(*args, **opts)
-      @buffer << Berns.void(*args, **opts)
+    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.5.0'
+  VERSION = '4.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: berns
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Taylor Beck
@@ -9,148 +9,8 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-15 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-09-01 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.