markaby 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 455850946266c24fdba0054e72e738909a92f031
-  data.tar.gz: fb9ea63ab1b9d64366d7af5deda7c4af1c09ec2a
+SHA256:
+  metadata.gz: 535329bcc48d16625bfba60bf91d25e9fc40f44821057beeea32b4e49d7271b8
+  data.tar.gz: 30e7730d1d4b8c3b7997c9956dda022cd4851cbf16f7a124c4cb1df62eb5b255
 SHA512:
-  metadata.gz: 89dd42bd927211894995fc1fd98633345d140d047e379fb647f8c84c88a8cda28fee5677c7fe0283691045659ed8f96a982987e512828f1d2f97fa7fa4f42616
-  data.tar.gz: 4dcbdfcaa7c11683e572595f24f2cd9267c09d1280a97f38151abaa1e2fdb6bdfc53ae77c04e9cd4a67e8692476a22af11436b9cdb7992136f5bf6d33db886c2
+  metadata.gz: 53e7e2a1b89c5c0bfb2e3758a0f3a3235c7b68539787e7722bc862124b52ac28bab464479e2fc605415616b187251dd69d5e6ee38f64fce20186139a782c9c47
+  data.tar.gz: c105c5c0d893354d6069c9e18d8694a80673bf97f24ee24ec8c41c99c9c86432362ac51f0d8f7d61d8db423a726a77a6796c51e87552e7859d940faef154e8b7

data/.ruby-version

@@ -1 +1 @@
-ruby-2.3.1
+ruby-2.7.3

data/.travis.yml

@@ -1,16 +1,12 @@
 language: ruby
 sudo: false
 rvm:
-  - 1.8
-  - 1.9
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
   - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
 matrix:
   allow_failures:
-    - rvm: 2.5
     - rvm: jruby-9.1.15.0
     - rvm: rbx-2
 install: bundle install --without=development --jobs=3 --retry=3

data/CHANGELOG.rdoc

@@ -1,3 +1,22 @@
+= HEAD
+
+= 0.9.1
+
+* update release tasks [tech task]
+* re-release version since code was included in last release
+
+= 0.9.0
+
+* Add data attributes: https://github.com/markaby/markaby/pull/44 (rahoulb)
+
+  * Add data + aria attributes
+  * Allow creation of custom web components / elements in html5
+      my_custom_element prop: "value" =>
+      "<my-custom-element prop="value"></my-custom-element>"
+    See https://stackoverflow.com/questions/9845011/are-custom-elements-valid-html5
+  * split up tag sets into different files
+  * add standardrb + use code conventions
+
 = 0.7.1 (2010-08-19)
 
 * Rails fixes for form_for called from erb templates

data/Gemfile

@@ -1,12 +1,14 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'builder'
+gem "builder"
+
+group :development do
+  gem "standardrb"
+end
 
 group :test do
-  gem 'rake'
-  gem 'rspec'
-  gem 'test-unit', :platform => [:mri_22, :mri_23, :mri_24, :mri_25]
-  gem 'byebug', :platform => [:mri_20, :mri_21, :mri_22, :mri_23, :mri_24, :mri_25]
-  gem 'ruby-debug', :platform => [:mri_18]
-  gem 'ruby-debug19', :platform => [:mri_19]
+  gem "rake"
+  gem "rspec"
+  gem "test-unit"
+  gem "byebug"
 end

data/Gemfile.lock

@@ -1,65 +1,79 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    archive-tar-minitar (0.6.1)
-      minitar (~> 0.6)
-      minitar-cli (~> 0.6)
-    builder (3.2.2)
-    byebug (2.7.0)
-      columnize (~> 0.3)
-      debugger-linecache (~> 1.2)
-    columnize (0.9.0)
-    debugger-linecache (1.2.0)
-    diff-lcs (1.2.5)
-    hashie (3.5.7)
-    linecache (1.3.1)
-    linecache19 (0.5.12)
-      ruby_core_source (>= 0.1.4)
-    minitar (0.6.1)
-    minitar-cli (0.6.1)
-      minitar (~> 0.6.0)
-      powerbar (~> 1.0)
-    power_assert (1.1.1)
-    powerbar (1.0.18)
-      hashie (>= 1.1.0)
-    rake (10.1.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.4)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
-    ruby-debug (0.10.4)
-      columnize (>= 0.1)
-      ruby-debug-base (~> 0.10.4.0)
-    ruby-debug-base (0.10.4)
-      linecache (>= 0.3)
-    ruby-debug-base19 (0.11.25)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby_core_source (>= 0.1.4)
-    ruby-debug19 (0.11.6)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby-debug-base19 (>= 0.11.19)
-    ruby_core_source (0.1.5)
-      archive-tar-minitar (>= 0.5.2)
-    test-unit (3.2.7)
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    power_assert (2.0.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.28.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.0.1)
+    standard-custom (1.0.0)
+      lint_roller (~> 1.0)
+    standard-performance (1.0.1)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.16.0)
+    standardrb (1.0.1)
+      standard
+    test-unit (3.5.8)
       power_assert
+    unicode-display_width (2.4.2)
 
 PLATFORMS
+  arm64-darwin-22
   ruby
+  x86_64-darwin-17
 
 DEPENDENCIES
   builder
   byebug
   rake
   rspec
-  ruby-debug
-  ruby-debug19
+  standardrb
   test-unit
 
 BUNDLED WITH
-   1.16.1
+   2.4.13

data/Markaby.gemspec

@@ -1,24 +1,20 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'markaby'
+require_relative "lib/markaby/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "markaby"
-  spec.version       = Markaby::VERSION
-  spec.authors       = ["Scott Taylor", "judofyr", "_why"]
-  spec.email         = ["scott@railsnewbie.com"]
-  spec.description   = "_why's markaby templating language"
-  spec.summary       = "A pure ruby based, html markup language"
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.name = "markaby"
+  spec.version = Markaby::VERSION
+  spec.authors = ["Scott Taylor", "judofyr", "_why"]
+  spec.email = ["scott@railsnewbie.com"]
+  spec.description = "_why's markaby templating language"
+  spec.summary = "A pure ruby based, html markup language"
+  spec.homepage = ""
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "builder"
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", ">= 2.2.10"
   spec.add_development_dependency "rake"
 end

data/README.rdoc

@@ -10,14 +10,12 @@ that blend with HTML.
 Just do what everyone else does:
 
   # in Gemfile:
-  gem 'markaby'
+  gem 'markaby', '>= 0.9'
 
 then bundle install:
 
   bundle install
 
-or gem install if you are a weirdo not using bundler.
-
 === Using Markaby with Rails 4/5+:
 
 Install the gem (using bundler), then:
@@ -31,9 +29,6 @@ Install the gem (using bundler), then:
     indent: 2,
   })
 
-Note, Markaby hasn't been tested on anything below Rails 5.  Please submit bugs
-and/or patches if you'd like support for anything before rails 5.
-
 Name your templates with an html.mab extension.  You'll also want to configure
 your text editor to see .mab as ruby.
 
@@ -159,15 +154,17 @@ Which results in:
     <div class="entryContent">Okay, once again, the idea here is ...</div>
   </div>
 
+Alternatively you can define the class as an attribute on your element - see below.
+
 == 2. Element IDs
 
 IDs may be added by the use of bang methods:
 
-  div.page! {
-    div.content! {
+  div.page! do
+    div.content! do
       h1 "A Short Short Saintly Dog"
-    }
-  }
+    end
+  end
 
 Which results in:
 
@@ -177,6 +174,8 @@ Which results in:
     </div>
   </div>
 
+Alternatively you can define the ID as an attribute on your element - see below.
+
 == 3. Validate Your XHTML 1.0 Output
 
 If you'd like Markaby to help you assemble valid XHTML documents,
@@ -195,8 +194,8 @@ tag.
 Now, since Markaby knows which doctype you're using, it checks a big
 list of valid tags and attributes before printing anything.
 
-  >> div :styl => "padding: 10px" do
-  >>   img :src => "samorost.jpg"
+  >> div styl: "padding: 10px" do
+  >>   img src: "samorost.jpg"
   >> end
   InvalidHtmlError: no such attribute `styl'
 
@@ -222,11 +221,11 @@ as an argument:
 One caveat: if you have other tags inside a block, the string
 passed back will be ignored.
 
-  div.comment {
+  div.comment do
     div.author "_why"
     div.says "Torpedoooooes!"
     "<div>Silence.</div>"
-  }
+  end
 
 The final div above won't appear in the output.  You can't mix
 tag modes like that, friend.
@@ -269,6 +268,8 @@ won't work with this technique.
     end
   end
 
+If you wish to register your own, specialist, tags, you can install a TagHandler
+
 == Some other notes, so you aren't confused:
 
 === On using different tagsets:
@@ -283,6 +284,59 @@ sub-template:
 Note, this is only necessary if you were rendering, say, a one off page as
 html transitional but had the default engine as html5.
 
+=== Defining attributes on elements
+
+If you do not use the <tt>CssProxy</tt> (<tt>div.entry</tt> to define the class, <tt>div.page!</tt> to define the ID), then you can pass a hash to your element to define any arbitrary attributes.
+
+  div id: "page-123", class: "entry" do
+    div style: "display: inline-block;" do
+      p "Have you noticed this book is basically written by a lunatic?"
+    end
+  end
+
+Will result in
+
+  <div id="page-123" class="entry">
+    <div style="display: inline-block;">
+      <p>Have you noticed this book is basically written by a lunatic?</p>
+    </div>
+  </div>
+
+If you pass a hash to your attribute definition, Markaby will expand the hash entries.  This is useful for data attributes (for example, if you are using a Stimulus controller), or aria attributes.  Any attributes will have underscores replaced with dashes when the hash is expanded.
+
+  div data: { controller: "something" } do
+    div do
+      h1(data: { something_target: "title" }) { "There goes my pickup" }
+    end
+  end
+
+Will result in
+
+  <div data-controller="something">
+    <div>
+      <h1 data-something-target="title">There goes my pickup</h1>
+    </div>
+  </div>
+
+=== Custom elements and web components
+
+If you are using the HTML5 tagset (which is the default), and your document has custom-elements defined, you can create those in the same way as standard elements.
+
+Unlike standard elements, there is no validity checking for your attributes.
+
+  article do
+    my_custom_panel variant: "primary" do
+      p "Our careers are so over"
+    end
+  end
+
+Results in
+
+  <article>
+    <my-custom-panel variant="primary">
+      <p>Our careers are so over</p>
+    </my-custom-panel>
+  </article>
 
 = Credits
 

data/Rakefile

@@ -1,25 +1,25 @@
-require 'rake'
+require "rake"
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
-require 'rake/clean'
+require "rspec/core/rake_task"
+require "rake/clean"
 
 RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+task default: :spec
 
 Bundler::GemHelper.install_tasks
 
 desc "List any Markaby specific warnings"
 task :warnings do
-  `ruby -w test/test_markaby.rb 2>&1`.split(/\n/).each do |line|
-    next unless line =~ /warning:/
-    next if line =~ /builder-/
+  `ruby -w test/test_markaby.rb 2>&1`.split("\n").each do |line|
+    next unless /warning:/.match?(line)
+    next if /builder-/.match?(line)
     puts line
   end
 end
 
 desc "Start a Markaby-aware IRB session"
 task :irb do
-  sh 'irb -I lib -r markaby -r markaby/kernel_method'
+  sh "irb -I lib -r markaby -r markaby/kernel_method"
 end
 
 namespace :gemspec do
@@ -29,19 +29,25 @@ namespace :gemspec do
   end
 end
 
-# namespace :release do
-#   task :patch => [:spec, "version:bump:patch", :update_gemspec, :rerdoc, :tag_release, :build, :push_tags]
-#
-#   task :update_gemspec => ["gemspec:generate", "gemspec:validate", "gemspec:commit"]
-#   task :tag_release do
-#     require File.dirname(__FILE__) + "/lib/markaby"
-#     version = "v#{Markaby::VERSION}"
-#     sh "git tag #{version}"
-#   end
-#
-#   task :push_tags do
-#     sh "git push --tags"
-#   end
-# end
-#
-# task :release => "release:patch"
+namespace :release do
+  # make sure to bump version + update changelogs in lib/markaby/version.rb before running
+  task :patch => [:spec, :update_gemspec, :tag_release, :build, :push_tags]
+
+  task :update_gemspec => ["gemspec:commit"]
+
+  task :tag_release do
+    require File.dirname(__FILE__) + "/lib/markaby"
+    version = "v#{Markaby::VERSION}"
+    sh "git tag #{version}"
+  end
+
+  task :push_tags do
+    sh "git push --tags"
+  end
+
+  task :push_gem do
+    sh "gem push pkg/markaby-#{Markaby::VERSION}.gem"
+  end
+end
+
+task :release => "release:patch"

data/lib/markaby/builder.rb

@@ -1,5 +1,5 @@
-require 'markaby/tags'
-require 'markaby/builder_tags'
+require "markaby/tagset"
+require "markaby/builder_tags"
 
 module Markaby
   RUBY_VERSION_ID = RUBY_VERSION.split(".").join.to_i
@@ -23,13 +23,12 @@ module Markaby
   #
   class Builder
     include Markaby::BuilderTags
-
     GENERIC_OPTIONS = {
-      :indent                 => 0,
-      :auto_validation        => true,
+      indent: 0,
+      auto_validation: true
     }
 
-    HTML5_OPTIONS   = HTML5.default_options.dup
+    HTML5_OPTIONS = HTML5.default_options.dup
     DEFAULT_OPTIONS = GENERIC_OPTIONS.merge(HTML5_OPTIONS)
 
     @@options = DEFAULT_OPTIONS.dup
@@ -52,7 +51,7 @@ module Markaby
       @tagset = tagset
 
       tagset.default_options.each do |k, v|
-        self.instance_variable_set("@#{k}".to_sym, v)
+        instance_variable_set("@#{k}".to_sym, v)
       end
     end
 
@@ -85,13 +84,11 @@ module Markaby
         instance_variable_set("@#{k}", v)
       end
 
-      if helper
-        helper.instance_variables.each do |iv|
-          instance_variable_set(iv, helper.instance_variable_get(iv))
-        end
+      helper&.instance_variables&.each do |iv|
+        instance_variable_set(iv, helper.instance_variable_get(iv))
       end
 
-      @builder = XmlMarkup.new(:indent => @indent, :target => @streams.last)
+      @builder = XmlMarkup.new(indent: @indent, target: @streams.last)
 
       text(capture(&block)) if block
     end
@@ -150,56 +147,24 @@ module Markaby
     # Create a tag named +tag+. Other than the first argument which is the tag name,
     # the arguments are the same as the tags implemented via method_missing.
     def tag!(tag, *args, &block)
-      ele_id = nil
-
-      # TODO: Move this logic to the tagset so that the tagset itself can validate + raise when invalid
+      attributes = {}
       if @auto_validation && @tagset
-        if !@tagset.tagset.has_key?(tag)
-          raise InvalidXhtmlError, "no element `#{tag}' for #{tagset.doctype}"
-        elsif args.last.respond_to?(:to_hash)
-          attrs = args.last.to_hash
-
-          if @tagset.forms.include?(tag) && attrs[:id]
-            attrs[:name] ||= attrs[:id]
-          end
-
-          attrs.each do |k, v|
-            atname = k.to_s.downcase.intern
-
-            unless k =~ /:/ or @tagset.tagset[tag].include?(atname) or (@tagset == Markaby::HTML5 && atname.to_s =~ /^data-/)
-              raise InvalidXhtmlError, "no attribute `#{k}' on #{tag} elements"
-            end
-
-            if atname == :id
-              ele_id = v.to_s
-
-              if @used_ids.has_key? ele_id
-                raise InvalidXhtmlError, "id `#{ele_id}' already used (id's must be unique)."
-              end
-            end
-
-            if AttrsBoolean.include? atname
-              if v
-                attrs[k] = atname.to_s
-              else
-                attrs.delete k
-              end
-            end
-          end
-        end
+        attributes = @tagset.validate_and_transform_attributes!(tag, *args)
+        tag = @tagset.validate_and_transform_tag_name! tag
       end
-
+      element_id = attributes[:id].to_s
+      raise InvalidXhtmlError, "id `#{element_id}' already used (id's must be unique)." if @used_ids.has_key?(element_id)
       if block
         str = capture(&block)
         block = proc { text(str) }
       end
 
       f = fragment { @builder.tag!(tag, *args, &block) }
-      @used_ids[ele_id] = f if ele_id
+      @used_ids[element_id] = f unless element_id.empty?
       f
     end
 
-  private
+    private
 
     # This method is used to intercept calls to helper methods and instance
     # variables.  Here is the order of interception:
@@ -210,32 +175,40 @@ module Markaby
     # * If +sym+ is also the name of an instance variable, the
     #   value of the instance variable is returned.
     # * If +sym+ has come this far and no +tagset+ is found, +sym+ and its arguments are passed to tag!
-    # * If a tagset is found, though, +NoMethodError+ is raised.
+    # * If a tagset is found, the tagset is tole to handle +sym+
     #
     # method_missing used to be the lynchpin in Markaby, but it's no longer used to handle
     # HTML tags.  See html_tag for that.
     def method_missing(sym, *args, &block)
-      if @_helper.respond_to?(sym, true)
-        @_helper.send(sym, *args, &block)
-      elsif @assigns.has_key?(sym)
-        @assigns[sym]
-      elsif @assigns.has_key?(stringy_key = sym.to_s)
-        # Rails' ActionView assigns hash has string keys for
-        # instance variables that are defined in the controller.
-        @assigns[stringy_key]
-      elsif instance_variables_for(self).include?(ivar = "@#{sym}".to_sym)
-        instance_variable_get(ivar)
-      elsif @_helper && instance_variables_for(@_helper).include?(ivar)
-        @_helper.instance_variable_get(ivar)
-      elsif instance_methods_for(::Builder::XmlMarkup).include?(sym)
-        @builder.__send__(sym, *args, &block)
-      elsif !@tagset
-        tag!(sym, *args, &block)
-      else
-        super
+      case response_for(sym)
+      when :helper then @_helper.send(sym, *args, &block)
+      when :assigns then @assigns[sym]
+      when :stringy_assigns then @assigns[sym.to_s]
+      when :ivar then instance_variable_get(ivar)
+      when :helper_ivar then @_helper.instance_variable_get(ivar)
+      when :xml_markup then @builder.__send__(sym, *args, &block)
+      when :tag then tag!(sym, *args, &block)
+      when :tagset then @tagset.handle_tag sym, self, *args, &block
+      else super
       end
     end
 
+    def response_for sym
+      return :helper if @_helper.respond_to?(sym, true)
+      return :assigns if @assigns.has_key?(sym)
+      return :stringy_assigns if @assigns.has_key?(sym.to_s)
+      return :ivar if instance_variables_for(self).include?(ivar = "@#{sym}".to_sym)
+      return :helper_ivar if @_helper && instance_variables_for(@_helper).include?(ivar)
+      return :xml_markup if instance_methods_for(::Builder::XmlMarkup).include?(sym)
+      return :tag if @tagset.nil?
+      return :tagset if @tagset.can_handle? sym
+      nil
+    end
+
+    def respond_to_missing? sym, include_private = false
+      !response_for(sym).nil?
+    end
+
     if RUBY_VERSION_ID >= 191
       def instance_variables_for(obj)
         obj.instance_variables
@@ -282,11 +255,15 @@ module Markaby
       undef_method method if method_defined?(method)
     end
 
-  private
+    private
 
-    def method_missing(*args, &block)
+    def method_missing(...)
       transform_stream unless transformed_stream?
-      @str.__send__(*args, &block)
+      @str.__send__(...)
+    end
+
+    def respond_to_missing? sym, *args
+      @str.respond_to? sym
     end
 
     def transform_stream