commit 517b911eead1740b4435194a0e893bf7ffad7efc Author: Evan Walsh Date: Tue Jun 18 20:17:37 2019 -0400 Hrb: not as good as I thought diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..aaea9de --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +/.bundle/ +/.yardoc +/_yardoc/ +/coverage/ +/doc/ +/pkg/ +/spec/reports/ +/tmp/ +/benchmark/profile/ diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 0000000..d6a9f87 --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,29 @@ +require: + - rubocop-performance + +Layout/MultilineMethodCallIndentation: + EnforcedStyle: indented + +Layout/SpaceInsideHashLiteralBraces: + EnforcedStyle: no_space + +Metrics/LineLength: + Max: 120 + +Style/Documentation: + Enabled: false + +Style/MutableConstant: + EnforcedStyle: strict + +Style/StringLiterals: + EnforcedStyle: double_quotes + +Style/StringLiteralsInInterpolation: + EnforcedStyle: double_quotes + +Style/TrailingCommaInArrayLiteral: + EnforcedStyleForMultiline: comma + +Style/TrailingCommaInHashLiteral: + EnforcedStyleForMultiline: comma diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..3020548 --- /dev/null +++ b/Gemfile @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +source "https://rubygems.org" + +# Specify your gem's dependencies in hrb.gemspec +gemspec diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..7d31b57 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,63 @@ +PATH + remote: . + specs: + hrb (1.0.0.pre.alpha.1) + +GEM + remote: https://rubygems.org/ + specs: + ansi (1.5.0) + ast (2.4.0) + coderay (1.1.2) + docile (1.3.2) + jaro_winkler (1.5.2) + json (2.2.0) + method_source (0.9.2) + minitest (5.11.3) + oga (2.15) + ast + ruby-ll (~> 2.1) + parallel (1.17.0) + parser (2.6.3.0) + ast (~> 2.4.0) + pry (0.12.2) + coderay (~> 1.1.0) + method_source (~> 0.9.0) + rainbow (3.0.0) + rake (10.5.0) + rubocop (0.71.0) + jaro_winkler (~> 1.5.1) + parallel (~> 1.10) + parser (>= 2.6) + rainbow (>= 2.2.2, < 4.0) + ruby-progressbar (~> 1.7) + unicode-display_width (>= 1.4.0, < 1.7) + rubocop-performance (1.3.0) + rubocop (>= 0.68.0) + ruby-ll (2.1.2) + ansi + ast + ruby-progressbar (1.10.1) + simplecov (0.16.1) + docile (~> 1.1) + json (>= 1.8, < 3) + simplecov-html (~> 0.10.0) + simplecov-html (0.10.2) + unicode-display_width (1.6.0) + +PLATFORMS + ruby + +DEPENDENCIES + bundler (~> 2.0) + hrb! + minitest (~> 5.0) + oga + pry + rake (~> 10.0) + rubocop + rubocop-performance + simplecov + +BUNDLED WITH + 2.0.1 diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..14e2f77 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 index 0000000..969f527 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# Hrb + +Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hrb`. To experiment with that code, run `bin/console` for an interactive prompt. + +TODO: Delete this and the text above, and describe your gem + +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'hrb' +``` + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install hrb + +## Usage + +TODO: Write usage instructions here + +## Development + +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. + +To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). + +## Contributing + +Bug reports and pull requests are welcome on GitHub at https://github.com/evanwalsh/hrb. diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..8ca97e1 --- /dev/null +++ b/Rakefile @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +require "bundler/gem_tasks" +require "rake/testtask" + +Rake::TestTask.new(:test) do |t| + t.libs << "test" + t.libs << "lib" + t.test_files = FileList["test/**/*_test.rb"] +end + +task default: :test diff --git a/benchmark/profile.rb b/benchmark/profile.rb new file mode 100644 index 0000000..354ee34 --- /dev/null +++ b/benchmark/profile.rb @@ -0,0 +1,44 @@ +# frozen_string_literal: true + +require "bundler/inline" + +gemfile ENV.key?("INSTALL_GEMS") do + source "https://rubygems.org" + gem "hrb", path: "../" + gem "memory_profiler" + gem "ruby-prof" + gem "stackprof" +end + +def run + 10_000.times do + Hrb::Template.render_file("../test/fixtures/basic.html.rb", locals: {created: "2019-06-17", numbers: (1..10)}) + end +end + +def prof + result = RubyProf.profile do + run + end + + printer = RubyProf::MultiPrinter.new(result) + printer.print(path: "./profile", profile: "profile") +end + +def stackprof + StackProf.run(mode: :wall, out: "./profile/stackprof.dump", interval: 1000) do + run + end +end + +def memory_profiler + report = MemoryProfiler.report do + run + end + + report.pretty_print +end + +memory_profiler +prof +stackprof diff --git a/benchmark/simple.rb b/benchmark/simple.rb new file mode 100644 index 0000000..aa853b4 --- /dev/null +++ b/benchmark/simple.rb @@ -0,0 +1,78 @@ +# frozen_string_literal: true + +require "bundler/inline" + +gemfile ENV.key?("INSTALL_GEMS") do + source "https://rubygems.org" + gem "benchmark-ips" + gem "benchmark-memory" + gem "erubi" + gem "markaby" + gem "pry" + gem "rubyoshka" + gem "slim" + gem "tilt" + gem "hrb", path: "../" +end + +def render(extension) + Tilt.new(File.join(__dir__, "templates", "simple.#{extension}")).render(nil, created: "2019-06-17", numbers: (1..100)) +end + +def render_rubyoshka + Rubyoshka.new do + with(created: "2019-06-17", numbers: (1..100)) do + instance_eval(File.read(File.join(__dir__, "templates", "simple.html.rb"))) + end + end.render +end + +erubi_src = Erubi::Engine.new(File.join(__dir__, "templates", "simple.erb")).src +numbers = (1..100) +created = "2019-06-17" + +require "benchmark/ips" + +Benchmark.ips do |x| + x.report("Erubi:") do + render("erb") + end + + x.report("Erubi fast:") do + eval(erubi_src) + end + + x.report("Rubyoshka:") do + render_rubyoshka + end + + x.report("Hrb:") do + render("html.rb") + end + + x.compare! +end + +if ENV.key?("MEMORY") + require "benchmark/memory" + + Benchmark.memory do |x| + x.report("Erubi:") do + render("erb") + end + + x.report("Erubi fast:") do + eval(erubi_src) + end + + x.report("Hrb:") do + render("html.rb") + end + + x.report("Rubyoshka:") do + render_rubyoshka + end + + x.compare! + end +end \ No newline at end of file diff --git a/benchmark/templates/simple.erb b/benchmark/templates/simple.erb new file mode 100644 index 0000000..2883071 --- /dev/null +++ b/benchmark/templates/simple.erb @@ -0,0 +1,20 @@ + + + + Hello! + + + + + + + +
+
+ <% numbers.each do |n| %> +
This is div #<%= n %>
+ <% end %> +
+
+ + diff --git a/benchmark/templates/simple.html.rb b/benchmark/templates/simple.html.rb new file mode 100644 index 0000000..2618c79 --- /dev/null +++ b/benchmark/templates/simple.html.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +doctype +html do + head do + title "Hello!" + meta charset: "utf-8" + meta name: "viewport", content: "width=device-width, initial-scale=1" + link rel: "stylesheet", href: "/test.css" + meta name: "created", content: created + end + + body do + div(id: "content") do + div(class: "container") do + h1("Hello!") + numbers.each do |i| + div("This is div ##{i}") + end + end + end + end +end diff --git a/benchmark/templates/simple.mab b/benchmark/templates/simple.mab new file mode 100644 index 0000000..1a851b4 --- /dev/null +++ b/benchmark/templates/simple.mab @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +html5 do + html do + head do + title "Hello!" + meta charset: "utf-8" + meta name: "viewport", content: "width=device-width, initial-scale=1" + link rel: "stylesheet", href: "/test.css" + meta name: "created", content: created + end + + body do + div(id: "content") do + div(class: "container") do + h1("Hello!") + numbers.each do |i| + div("This is div ##{i}") + end + end + end + end + end +end \ No newline at end of file diff --git a/benchmark/templates/simple.slim b/benchmark/templates/simple.slim new file mode 100644 index 0000000..794dd3f --- /dev/null +++ b/benchmark/templates/simple.slim @@ -0,0 +1,14 @@ +doctype html +html + head + title Hello! + meta charset="utf-8" + meta name="viewport" content="width=device-width, initial-scale=1" + link rel="stylesheet" href="/test.css" + meta name="created" content=created + body + #content + .container + h1 Hello! + - numbers.each do |i| + div This is div ##{i} diff --git a/bin/console b/bin/console new file mode 100755 index 0000000..fe9cb0a --- /dev/null +++ b/bin/console @@ -0,0 +1,11 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +require "bundler/setup" +require "hrb" + +# You can add fixtures and/or initialization code here to make experimenting +# with your gem easier. You can also use a different console, if you like. + +require "pry" +Pry.start diff --git a/bin/setup b/bin/setup new file mode 100755 index 0000000..dce67d8 --- /dev/null +++ b/bin/setup @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +set -euo pipefail +IFS=$'\n\t' +set -vx + +bundle install + +# Do any other automated setup that you need to do here diff --git a/hrb.gemspec b/hrb.gemspec new file mode 100644 index 0000000..c79ba48 --- /dev/null +++ b/hrb.gemspec @@ -0,0 +1,34 @@ +# frozen_string_literal: true + +lib = File.expand_path("lib", __dir__) +$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) +require "hrb/version" + +Gem::Specification.new do |spec| + spec.name = "hrb" + spec.version = Hrb::VERSION + spec.authors = ["Evan Walsh"] + spec.email = ["evan@hellowelcome.org"] + + spec.summary = "HTML in Ruby" + spec.description = "HTML in Ruby" + spec.homepage = "https://labs.hellowelcome.org/evan/hrb" + + # Specify which files should be added to the gem when it is released. + # The `git ls-files -z` loads the files in the RubyGem that have been added into git. + spec.files = Dir.chdir(File.expand_path(__dir__)) do + `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } + end + spec.bindir = "exe" + spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) } + spec.require_paths = ["lib"] + + spec.add_development_dependency "bundler", "~> 2.0" + spec.add_development_dependency "minitest", "~> 5.0" + spec.add_development_dependency "oga" + spec.add_development_dependency "pry" + spec.add_development_dependency "rake", "~> 10.0" + spec.add_development_dependency "rubocop" + spec.add_development_dependency "rubocop-performance" + spec.add_development_dependency "simplecov" +end diff --git a/lib/hrb.rb b/lib/hrb.rb new file mode 100644 index 0000000..7a678c4 --- /dev/null +++ b/lib/hrb.rb @@ -0,0 +1,18 @@ +# frozen_string_literal: true + +require "hrb/version" +require "hrb/template" +require "hrb/tilt" if defined?(Tilt) +require "hrb/action_view" if defined?(ActionView::Template) + +module Hrb + module_function + + def render(locals: {}, scope: nil, &block) + Hrb::Template.render(locals: locals, scope: scope, &block) + end + + def render_file(path, locals: {}, scope: nil) + Hrb::Template.render_file(path, locals: locals, scope: scope) + end +end diff --git a/lib/hrb/action_view.rb b/lib/hrb/action_view.rb new file mode 100644 index 0000000..039571e --- /dev/null +++ b/lib/hrb/action_view.rb @@ -0,0 +1,17 @@ +# frozen_string_literal: true + +module Hrb + module Rails + class TemplateHandler + def call(template) + <<-CODE + Hrb::Template.build do + #{template.source} + end.to_s + CODE + end + end + end +end + +ActionView::Template.register_template_handler :hrb, Hrb::Rails::TemplateHandler diff --git a/lib/hrb/template.rb b/lib/hrb/template.rb new file mode 100644 index 0000000..298ffdb --- /dev/null +++ b/lib/hrb/template.rb @@ -0,0 +1,131 @@ +# frozen_string_literal: true + +require "erb" + +module Hrb + class Template + TAGS = %i[a address article aside b bdi body button code details dialog div dd dl dt em fieldset figcaption figure + footer form h1 h2 h3 h4 h5 h6 head header html i iframe label li main mark menuitem meter nav ol option + option p pre progress rp rt ruby s script section select small span strong summary table tbody td textarea + th thead time title tr u ul video wbr].freeze + EMPTY_TAGS = %i[img br hr input link meta source].freeze + + ENDINGS = Hash[TAGS.map do |tag| + [tag, ""] + end].freeze + + def self.render(locals: {}, scope: nil, &block) + template = Template.new(locals: locals, scope: scope) + template.instance_eval(&block) + template.to_s + end + + def self.render_file(path, locals: {}, scope: nil) + template = Template.new(locals: locals, scope: scope) + template.instance_eval(File.read(path)) + template.to_s + end + + def initialize(locals: {}, scope: nil) + @fragments = [[]] + self.locals = locals + @scope = scope + @view = @fragments.last + end + + TAGS.each do |name| + define_method(name) do |content = nil, options = {}, &block| + tag(name, content, options, &block) + end + end + + EMPTY_TAGS.each do |name| + define_method(name) do |options = {}| + tag(name, nil, options, end_tag: false) + end + end + + def tag(name, content = nil, options = {}, end_tag: true, &block) + output = "<#{name}#{tag_attributes(content&.is_a?(Hash) ? content : options)}>" + output += content if content&.is_a?(String) + output += capture(&block) if block + output += ENDINGS[name] if end_tag + + raw output + end + + def method_missing(name, *args, &block) + if @scope.respond_to?(name) + @scope.send(name, *args, &block) + elsif @locals&.key?(name) || @locals&.key?(name.to_s) + @locals.fetch(name) { @locals[name.to_s] } + else + super + end + end + + def respond_to_missing?(name, include_all = false) + @scope.respond_to?(name) || @locals&.key?(name) || @locals&.key?(name.to_s) || super + end + + def view + @fragments.last + end + + def doctype + raw "" + end + + def text(output) + raw escape(output) + end + + def raw(output) + view.push output.to_s + end + + def capture(&block) + @fragments.push [] + instance_eval(&block) + + view.join.tap do + @fragments.pop + end + end + + def locals=(locals) + locals.each do |key, value| + metaclass do + define_method key do + value + end + end + end + end + + def to_s + @fragments.join + end + + private + + def metaclass(&block) + metaclass = class << self; self; end + metaclass.class_eval(&block) + end + + def tag_attributes(options) + attrs = "" + + options.each do |key, value| + attrs += %( #{key.to_s.tr("_", "-")}="#{escape(value)}") + end + + attrs + end + + def escape(value) + ERB::Util.html_escape(value.respond_to?(:join) ? value.join(" ") : value.to_s) + end + end +end diff --git a/lib/hrb/tilt.rb b/lib/hrb/tilt.rb new file mode 100644 index 0000000..ffa6881 --- /dev/null +++ b/lib/hrb/tilt.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +module Tilt + class HrbTemplate < Tilt::Template + def prepare; end + + def evaluate(scope, locals, &block) + builder = Hrb::Template.new(locals: locals, scope: scope) + + if block + builder.capture(&block) + else + builder.instance_eval(data) + end + + builder.to_s + end + end + + register Tilt::HrbTemplate, "rb" +end diff --git a/lib/hrb/version.rb b/lib/hrb/version.rb new file mode 100644 index 0000000..ceab689 --- /dev/null +++ b/lib/hrb/version.rb @@ -0,0 +1,5 @@ +# frozen_string_literal: true + +module Hrb + VERSION = "1.0.0-alpha.1" +end diff --git a/test/fixtures/basic.html.rb b/test/fixtures/basic.html.rb new file mode 100644 index 0000000..2618c79 --- /dev/null +++ b/test/fixtures/basic.html.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +doctype +html do + head do + title "Hello!" + meta charset: "utf-8" + meta name: "viewport", content: "width=device-width, initial-scale=1" + link rel: "stylesheet", href: "/test.css" + meta name: "created", content: created + end + + body do + div(id: "content") do + div(class: "container") do + h1("Hello!") + numbers.each do |i| + div("This is div ##{i}") + end + end + end + end +end diff --git a/test/fixtures/complex.html.rb b/test/fixtures/complex.html.rb new file mode 100644 index 0000000..ae3a3da --- /dev/null +++ b/test/fixtures/complex.html.rb @@ -0,0 +1,45 @@ +# frozen_string_literal: true + +def pet(name:, kind:, favorite_food:) + div(class: "pet") do + strong(name) + text(" the ") + em(kind) + text(" likes ") + em(favorite_food) + end +end + +# rubocop:disable Metrics/BlockLength +doctype +html(lang: "en-us") do + head do + title "My pets" + meta "http-equiv" => "Content-Type", content: "text/html; charset=utf-8" + end + + body do + header(class: "top") do + h1("My pets") + end + + main(class: "content") do + subjects = [ + {name: "Orion", kind: "dog", favorite_food: "icing"}, + {name: "Finn", kind: "dog", favorite_food: "beef"}, + {name: "Mao", kind: "cat", favorite_food: "canned cat food"}, + {name: "Stella", kind: "cat", favorite_food: "hate"}, + {name: "Teemo", kind: "cat", favorite_food: "tuna"}, + {name: "Merlin", kind: "cat", favorite_food: "tuna"}, + {name: "Taakoyaki", kind: "axolotl", favorite_food: "earthworms"}, + ] + + subjects.each do |subject| + pet(name: subject[:name], kind: subject[:kind], favorite_food: subject[:favorite_food]) + end + + text("") + end + end +end +# rubocop:enable Metrics/BlockLength diff --git a/test/hrb/template_test.rb b/test/hrb/template_test.rb new file mode 100644 index 0000000..d7e19c7 --- /dev/null +++ b/test/hrb/template_test.rb @@ -0,0 +1,65 @@ +# frozen_string_literal: true + +require "test_helper" + +module Hrb + class TemplateTest < Minitest::Test + def test_render + assert rendered.css("#test > #top + #content").size == 1 + assert rendered.css("#content > p").size == 2 + end + + def test_locals + html = Oga.parse_html(Hrb::Template.render(locals: {name: "Evan", date: "2019-06-17"}) do + strong("Hi, I am #{name}") + small("The date is #{date}") + end) + + assert_equal "Hi, I am Evan", html.css("strong").text + assert_equal "The date is 2019-06-17", html.css("small").text + end + + def test_scope + html = Oga.parse_html(Hrb::Template.render(scope: scope) do + h1("Hi, I am #{name}") + h2("The date is #{date}") + end) + + assert_equal "Hi, I am Evan", html.css("h1").text + assert_equal "The date is 2019-06-17", html.css("h2").text + end + + def test_to_s + template = Hrb::Template.new + template.instance_eval do + div("Hello!") + end + + assert_equal "
Hello!
", template.to_s + end + + private + + Scope = Struct.new(:name, :date) + + def scope + Scope.new("Evan", "2019-06-17") + end + + # rubocop:disable Metrics/MethodLength + def rendered + Oga.parse_html(Hrb::Template.render do + div(id: "test") do + header(id: "top") do + h1("Hrb is HTML in Ruby") + end + main(id: "content") do + p("It's not a new idea, but it's neat.") + p("I hope you like it.") + end + end + end) + end + end + # rubocop:enable Metrics/MethodLength +end diff --git a/test/hrb_test.rb b/test/hrb_test.rb new file mode 100644 index 0000000..3c6ad7c --- /dev/null +++ b/test/hrb_test.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true + +require "test_helper" + +class HrbTest < Minitest::Test + def test_render + assert_equal "Hello from Hrb!", rendered.css("h1").text + assert_equal "This is great!", rendered.css(".test-div > p").text + end + + def test_render_file + assert_equal "2019-06-17", rendered_file.xpath("/html/head/meta[@name='created']/@content").first.value + assert_equal "This is div #1", rendered_file.css(".container > div:nth(1)").text + assert_equal "This is div #100", rendered_file.css(".container > div:last-child").text + end + + private + + def rendered + html = Hrb.render do + h1 "Hello from Hrb!" + h2("This is a test") + div(class: "test-div") do + p("This is great!") + end + end + + Oga.parse_html(html) + end + + def rendered_file + file = File.join(__dir__, "fixtures", "basic.html.rb") + Oga.parse_html Hrb.render_file(file, locals: {created: "2019-06-17", numbers: (1..100)}) + end +end diff --git a/test/test_helper.rb b/test/test_helper.rb new file mode 100644 index 0000000..bfdc5da --- /dev/null +++ b/test/test_helper.rb @@ -0,0 +1,9 @@ +# frozen_string_literal: true + +require "simplecov" +SimpleCov.start + +$LOAD_PATH.unshift File.expand_path("../lib", __dir__) +require "hrb" +require "oga" +require "minitest/autorun"