berns 3.0.5 → 3.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8425c17303f3c8faa2b32ae094b2f0ba0c75249023f6f13fea6861f3d320c6a
-  data.tar.gz: d0ce018f731270df5fbd2da25b6f8d16c1d087b36cf9257bd4ac1c380b97e7e9
+  metadata.gz: a0513b5d30f4b3b8cc581baa1d46a2bd64469d76224638cdcdb45fe3faab1e66
+  data.tar.gz: 857d58645cdad849eea710bc68bd3e5ab3695e9e0ba763b54392fa96956836dc
 SHA512:
-  metadata.gz: 97c05a7a5ba067842dbc4a52027729944a38138001fd62f265b1ef62c73f0110c94457b18777e403c58de6f13aedea67f6043cff81e77c7ff10b71e9460cc98b
-  data.tar.gz: 814dcbc51d7a9b522ba5c1dc5c87e552cfe1a9146a5cbaa841b202d854d02b92485f2a868a3593b3bae4a39302223546833f5188efbd1f8c667687efba45a45a
+  metadata.gz: aa90410871bd7491fc665c55cb3527dfa7441c43962c2a50fab5f68fb0e87f9c5b2960e619aa97273d0f91164c9d7c6d63dda6ebd93534227e3b3f5a034fcf34
+  data.tar.gz: d8ed28163f684577aec0f8b1fe8010e9135e8c03ecabba2797a8e60640d55143763b9db0adf0f0258fd660faf7f6d975dc70f9c97dfa39691fc90a9b7e4945ed

data/README.org

@@ -26,10 +26,7 @@ gem install berns
 
 ** Usage
 
-All standard and void HTML elements are defined as methods on Berns, so you can
-create e.g. a link with =Berns.a=. In addition, there are methods to sanitize
-strings i.e. remove HTML from them, convert hashes into a string of HTML
-attributes, and more.
+Note that all return string values will be UTF-8 encoded.
 
 *** =void(tag, attributes)=
 
@@ -94,8 +91,8 @@ Berns.sanitize('This <span>should be clean</span>') # => 'This should be clean'
 
 *** Standard and void elements
 
-As mentioned above, all standard and void HTML elements are defined as singleton
-methods on the Berns module. Below is the full list of standard elements.
+All standard and void HTML elements are defined as methods on Berns, so you can
+create e.g. a link with =Berns.a=. Below is the full list of standard elements.
 
 #+begin_example
 a abbr address article aside audio b bdi bdo blockquote body button

data/ext/berns/berns.c

@@ -316,6 +316,8 @@ static VALUE berns_internal_element(VALUE tag, VALUE attributes) {
 
     if (TYPE(content) == T_NIL || TYPE(content) == T_FALSE) {
       content = rb_utf8_str_new_cstr("");
+    } else if (TYPE(content) != T_STRING) {
+      content = rb_funcall(content, rb_intern("to_s"), 0);
     }
   } else {
     content = rb_utf8_str_new_cstr("");

data/ext/mkmf.log

@@ -0,0 +1,7 @@
+extconf.h is:
+/* begin */
+1: #ifndef EXTCONF_H
+2: #define EXTCONF_H
+3: #endif
+/* end */
+

data/lib/berns/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: berns
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.0.6
 platform: ruby
 authors:
 - Taylor Beck
 - Evan Lecklider
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-16 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -109,6 +109,20 @@ dependencies:
     - - ">="
       - !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
@@ -146,19 +160,14 @@ extensions:
 - ext/berns/extconf.rb
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".github/workflows/main.yml"
-- ".gitignore"
-- ".rubocop.yml"
-- CHANGELOG.org
-- Gemfile
 - LICENSE.txt
 - README.org
-- Rakefile
-- berns.gemspec
 - ext/berns/berns.c
 - ext/berns/extconf.rb
+- ext/mkmf.log
 - lib/berns.rb
+- lib/berns/berns.bundle
+- lib/berns/berns.so
 - lib/berns/version.rb
 homepage: https://github.com/evanleck/berns
 licenses:
@@ -166,7 +175,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/evanleck/berns/issues
   source_code_uri: https://github.com/evanleck/berns
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -182,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.15
-signing_key:
+signing_key: 
 specification_version: 4
 summary: A utility library for generating HTML strings.
 test_files: []

data/.editorconfig

@@ -1,20 +0,0 @@
-# http://EditorConfig.org
-# This is the top most config file.
-root = true
-
-# All files
-[*]
-
-# Unix-style newlines with a newline ending every file
-end_of_line = lf
-insert_final_newline = true
-
-# Character set
-charset = utf-8
-
-# Trim extra whitespace.
-trim_trailing_whitespace = true
-
-# Soft tabs and 2 spaces.
-indent_style = space
-indent_size = 2

data/.github/workflows/main.yml

@@ -1,24 +0,0 @@
-name: Ruby
-
-on: [push,pull_request]
-
-jobs:
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, macos-latest]
-        ruby-version: ['3.0', 2.7, 2.6, 2.5]
-
-    runs-on: ${{ matrix.os }}
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Set up Ruby ${{ matrix.ruby-version }}
-      uses: ruby/setup-ruby@v1
-      with:
-        bundler-cache: true
-        ruby-version: ${{ matrix.ruby-version }}
-
-    - name: Run tests & lint
-      run: bundle exec rake

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rubocop.yml

@@ -1,58 +0,0 @@
-# http://rubocop.readthedocs.io
-# https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
-require:
-  - rubocop-minitest
-  - rubocop-performance
-  - rubocop-rake
-
-AllCops:
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  ExtraDetails: true
-  NewCops: enable
-  TargetRubyVersion: 2.5
-
-Layout/ParameterAlignment:
-  EnforcedStyle: with_fixed_indentation
-
-Layout/EmptyLineAfterMagicComment:
-  Enabled: false
-
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/MultilineOperationIndentation:
-  EnforcedStyle: indented
-
-Layout/SpaceInsideStringInterpolation:
-  EnforcedStyle: space
-
-Layout/LineLength:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ModuleLength:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Style/Next:
-  MinBodyLength: 8

data/CHANGELOG.org

@@ -1,157 +0,0 @@
-* Berns Changelog
-
-** 3.0.5
-
-Fix a regression when content blocks are false. They should be treated the same
-as if they are not there instead of throwing an error.
-
-This allows the use of conditions in combination with content blocks e.g.
-
-#+begin_src ruby
-Berns.div { user_can_view? && "You can see this sometimes" }
-#+end_src
-
-** 3.0.4
-
-Fix an =ArgumentError= when passing a nested empty hash to =to_attribute=.
-
-** 3.0.3
-
-Fix a buffer overflow error.
-
-** 3.0.2
-
-Ensure all returned strings are UTF-8 encoded.
-
-** 3.0.1
-
-Fix a regression when content blocks are nil. They should be treated the same as
-if they are not there instead of throwing an error.
-
-** 3.0.0
-
-Version 3.0 is another mostly API-compatible refactor of Berns, this time in
-blazing fast C! I debated simply calling this version 2.1.0 but because it's a
-complete rewrite it didn't seem right to do a simple point release and there may
-be corner cases that I've not accounted for in this new C-backed version.
-
-Running the same benchmarks as from 2.0 but pitting 2.0 against 3.0 yields some
-great speed improvements, particularly for the =empty= and =simple= cases.
-
-/These benchmarks were performed on a desktop with a AMD Ryzen 5 3600X 6-Core
-Processor running Linux Mint 20.1 and kernel 5.4./
-
-Before:
-
-#+begin_example
- empty      1.668M (± 0.6%) i/s -      8.356M in   5.011099s
-simple    442.102k (± 1.3%) i/s -      2.214M in   5.008068s
-nested    267.716k (± 0.4%) i/s -      1.357M in   5.068747s
-#+end_example
-
-After:
-
-#+begin_example
- empty      3.573M (± 1.2%) i/s -     17.881M in   5.005001s
-simple    840.631k (± 0.6%) i/s -      4.253M in   5.059771s
-nested    267.281k (± 0.5%) i/s -      1.347M in   5.037887s
-#+end_example
-
-With both empty and simple attributes we see performance effectively double, and
-with nested attributes performance remains more or less the same.
-
-This is another set of fairly contrived benchmarks, testing a singleton method,
-=void= call, and =element= call against each other.
-
-Before:
-
-#+begin_example
-            br      3.061M (± 0.8%) i/s -     15.613M in   5.100154s
-    void("br")      6.141M (± 1.4%) i/s -     30.990M in   5.047338s
-element("div")      2.789M (± 0.6%) i/s -     14.171M in   5.080626s
-#+end_example
-
-After:
-
-#+begin_example
-            br      8.155M (± 1.0%) i/s -     41.339M in   5.069681s
-    void("br")      9.782M (± 1.5%) i/s -     49.096M in   5.020114s
-element("div")      6.769M (± 1.1%) i/s -     33.983M in   5.021362s
-#+end_example
-
-Lastly, benchmarking =to_attributes= with the following hash as the only
-argument shows about double the performance with 3.0.
-
-#+begin_src ruby
-ATTRS = { this: 'tag', should: 'work', data: { foo: 'bar', bar: { baz: 'foo' } } }.freeze
-#+end_src
-
-Before:
-
-#+begin_example
-to_attributes    228.829k (± 1.3%) i/s -      1.159M in   5.065714s
-#+end_example
-
-After:
-
-#+begin_example
-to_attributes    457.387k (± 1.2%) i/s -      2.305M in   5.041036s
-#+end_example
-
-** 2.0.0
-
-Version 2.0 is a mostly API-compatible refactor of all of the core
-methods that make up Berns. The goal is to improve performance, mostly
-using mutable strings and inlining variables that were otherwise short
-lived.
-
-In addition, the target Ruby version has been raised to 2.5 or later.
-2.4 has reached its end of life.
-
-Running this benchmarking code:
-
-#+begin_src ruby
-Benchmark.ips do |x|
-  x.report('empty') { Berns.element(:a) { 'Link to something' } }
-  x.report('simple') { Berns.element(:a, { href: 'Something', class: 'my-class' }) { 'Link to something' } }
-  x.report('nested') { Berns.element(:a, { href: 'Something', class: 'my-class', data: { something: 'Else' } }) { 'Link to something' } }
-
-  x.compare!
-end
-#+end_src
-
-Before:
-
-#+begin_example
- empty    993.521k (± 1.7%) i/s -      5.062M in   5.096368s
-simple    340.795k (± 0.4%) i/s -      1.729M in   5.074101s
-nested    215.160k (± 1.0%) i/s -      1.081M in   5.025324s
-#+end_example
-
-After:
-
-#+begin_example
- empty      1.769M (± 1.9%) i/s -      9.012M in   5.094973s
-simple    441.020k (± 1.0%) i/s -      2.233M in   5.063326s
-nested    280.255k (± 3.0%) i/s -      1.400M in   5.001009s
-#+end_example
-
-With empty attributes we see ~ 100% increase in iterations per second,
-with simple attributes we see ~ 30% increase in the same, and with
-nested attributes we see ~ 30% increase as well.
-
-** 1.3.0
-
-With version 1.3, nested HTML attributes can be created with nil keys
-and boolean values to produce e.g. "data-foo data-foo-bar='whatever'"
-from =data: { foo: { nil => true, bar: 'whatever' } }=
-
-** 1.2.0 - 1.2.2
-
-Starting with version 1.2, Berns will now HTML-escape all attribute
-values using =CGI.escapeHTML=. This should prevent attribute values from
-escaping themselves and injecting HTML into the DOM.
-
-** 1.1.0
-
-- Add =#sanitize= method.

data/Gemfile

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in berns.gemspec
-gemspec

data/Rakefile

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-require 'bundler/gem_tasks'
-require 'rake/extensiontask'
-require 'rake/testtask'
-require 'rubocop/rake_task'
-
-Rake::ExtensionTask.new 'berns' do |ext|
-  ext.lib_dir = 'lib/berns'
-end
-
-Rake::TestTask.new(:test) do |t|
-  t.deps = :compile
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-RuboCop::RakeTask.new
-
-task default: %i[test rubocop]

data/berns.gemspec

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-require_relative 'lib/berns/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'berns'
-  spec.version = Berns::VERSION
-  spec.authors = ['Taylor Beck', 'Evan Lecklider']
-  spec.email = ['beck.taylorg@gmail.com', 'evan@lecklider.com']
-
-  spec.summary = 'A utility library for generating HTML strings.'
-  spec.description = 'A utility library for generating HTML strings.'
-  spec.homepage = 'https://github.com/evanleck/berns'
-  spec.license = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
-
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
-  end
-
-  spec.require_paths = ['lib']
-  spec.extensions = %w[ext/berns/extconf.rb]
-
-  spec.metadata = {
-    'bug_tracker_uri' => 'https://github.com/evanleck/berns/issues',
-    'source_code_uri' => 'https://github.com/evanleck/berns'
-  }
-
-  spec.add_dependency 'cgi'
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rake-compiler'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-minitest'
-  spec.add_development_dependency 'rubocop-performance'
-  spec.add_development_dependency 'rubocop-rake'
-end