markaby 0.8.1 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aed95364f1421acaab2191897e35fb1a278051cd
-  data.tar.gz: 605b3d61e47bdc08256f2034fd5717ab080585f7
+SHA256:
+  metadata.gz: 535329bcc48d16625bfba60bf91d25e9fc40f44821057beeea32b4e49d7271b8
+  data.tar.gz: 30e7730d1d4b8c3b7997c9956dda022cd4851cbf16f7a124c4cb1df62eb5b255
 SHA512:
-  metadata.gz: 93daf68ab25910cffadcd442f9dd0e05d9e2afb245f16f308776e27e0876d54a9068624d065cf52f03798925aafb4626c14f7ef51d7970d038f4c9a8a2c6e778
-  data.tar.gz: 824f9a360031c25711dadad5bd32a0f84ec12533c2d88bcb57835a9c8ef32804a7a097a338987f48e2c2bd46e029c5830d5195d0fb754a87248cc0bcf55a5e50
+  metadata.gz: 53e7e2a1b89c5c0bfb2e3758a0f3a3235c7b68539787e7722bc862124b52ac28bab464479e2fc605415616b187251dd69d5e6ee38f64fce20186139a782c9c47
+  data.tar.gz: c105c5c0d893354d6069c9e18d8694a80673bf97f24ee24ec8c41c99c9c86432362ac51f0d8f7d61d8db423a726a77a6796c51e87552e7859d940faef154e8b7

data/.gitignore

@@ -18,4 +18,5 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
-tmp
+tmp
+.byebug_history

data/.ruby-version

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

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+matrix:
+  allow_failures:
+    - 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,8 +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'
-end
+  gem "rake"
+  gem "rspec"
+  gem "test-unit"
+  gem "byebug"
+end

data/Gemfile.lock

@@ -1,22 +1,79 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    builder (3.2.2)
-    diff-lcs (1.2.5)
-    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)
+    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
+  standardrb
+  test-unit
+
+BUNDLED WITH
+   2.4.13

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2006-2018 markaby group (Scott Taylor (smtlaissezfaire), Jonathan Gillette (_why), and related maintainers)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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/version'
+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

@@ -5,35 +5,79 @@ It is an alternative to ERb which weaves the two languages together.
 Also a replacement for templating languages which use primitive languages
 that blend with HTML.
 
-=== Install it as a gem
+== Install it
 
-  gem install markaby
+Just do what everyone else does:
 
-== Using Markaby with Sinatra (1.0+)
+  # in Gemfile:
+  gem 'markaby', '>= 0.9'
 
-  get '/foo' do
-    mab :my_template # my_template.mab in the sinatra view path
-  end
+then bundle install:
 
-If you are looking for sinatra support pre 0.7, see http://github.com/sbfaulkner/sinatra-markaby
+  bundle install
+
+=== Using Markaby with Rails 4/5+:
+
+Install the gem (using bundler), then:
+
+  # in config/initializers/markaby.rb:
+
+  require 'markaby/rails'
+
+  Markaby::Rails::TemplateHandler.register!({
+    tagset: Markaby::HTML5,
+    indent: 2,
+  })
+
+Name your templates with an html.mab extension.  You'll also want to configure
+your text editor to see .mab as ruby.
+
+Here's how you'd do that for Atom:
+
+1. Install the file-types module:
+
+    apm install file-types
+
+1. in your config: Atom -> Config:
+
+    "*":
+      "file-types":
+        "\\.mab$": "source.ruby"
+
+Now that's some chunky bacon!
 
-A note on Tilt - using markaby with html5 doesn't quite yet work properly.  If you'd like to render a template with html 5, call this at the start of a .mab template:
+=== Using Markaby in helpers:
 
-enable_html5!
+Just call Markaby::Builder with a block as below.
 
-Or enable html 5 globally:
+You can also require 'markaby/kernel_method' to make it even easier:
 
-Markaby::Builder.class_eval do
-  @@options = Markaby::Builder::HTML5_OPTIONS
-end
+    # my_helper.rb:
+    require 'markaby/kernel_method' # or put this in an initializer
 
-== Using Markaby with other frameworks
+    module MyHelper
+      # note - you can also use Markaby::Builder.new { }.to_s
+      def chunky_bacon
+        mab do
+          p "Chunky Bacon!"
+        end
+      end
+    end
+
+=== Using Markaby with Sinatra (1.0+)
+
+  get '/foo' do
+    mab :my_template # my_template.mab in the sinatra view path
+  end
+
+If you are looking for sinatra support pre 0.7, see http://github.com/sbfaulkner/sinatra-markaby
+
+=== Using Markaby with other frameworks
 
 Tilt has a Markaby module, so in principle, any web framework that supports
 Tilt will also support Markaby.  See the appropriate tilt documentation:
 
-  http://github.com/rtomayko/tilt
-
+http://github.com/rtomayko/tilt
 
 == Using Markaby as a Ruby class
 
@@ -110,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:
 
@@ -128,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,
@@ -146,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'
 
@@ -173,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.
@@ -220,11 +268,81 @@ 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:
+
+Because of the ways various frameworks sub-render templates, to use a different
+tagset in a rendered sub template, you may need to set it at the top of your
+sub-template:
+
+  self.tagset = Markaby::HTML5
+  # or Markaby::Transitional, Markaby::XHTMLStrict, Markaby::XHTMLFrameset
+
+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
 
 Markaby is a work of immense hope by Tim Fletcher and why the lucky stiff.
 It is maintained by joho, spox, and smtlaissezfaire.
-Thankyou for giving it a whirl.
+Thank you for giving it a whirl.
 
 Markaby is inspired by the HTML library within cgi.rb.  Hopefully it will
 turn around and take some cues.

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"