opal-erubi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 28b2ec7bf06d7c568035145132abedf54f6f76544fbeb73f9b7316bf5f158fba
+  data.tar.gz: db14ec171666f0d1c7b27b5c078b29f385b862dbc1f1bb81cdb88d113d9f64d1
+SHA512:
+  metadata.gz: a5d0e3dc8d048df7554e58fb248b1e384843011d7bc63ee9514fa96b148c6dca1152f6d2bafbd4ba426cb22436d02abe6cac3ce4679a9dcd95577c0e20b68f96
+  data.tar.gz: bedbde578f02ede63013a17b0357870b11db4da00596807d7108d89febe87701813de7f53e1940010f3001800ec9b4397054a23783c086d1fbc189405adc12d1

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+*.gem
+*~

data/Gemfile

@@ -0,0 +1,8 @@
+
+source 'https://rubygems.org'
+gemspec
+
+gem "opal-rspec", "> 0.6.2"
+gem "opal"
+gem "erubi"
+

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (C) 2019-2020 by hmdne
+opal-haml: Copyright (C) 2013 by Adam Beynon, 2015 Elia Schito
+
+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/README.md

@@ -0,0 +1,116 @@
+# Opal Erubi
+
+*Erubi templates for Opal*
+
+This gem adds `.erubi` files to precompile templates for opal. This gem does
+not make the Erubi compiler available under opal, just the result of
+pre-compiling an Erubi template.
+
+A micro runtime is included to handle escaping.
+
+All Erubi templates become available under the `Template` constant in Opal,
+which allows a template to be easily rendered in a context:
+
+```ruby
+Template['user'].render(my_user)
+# => <div>..</div>
+```
+
+This code is related to an opal-haml gem. It's mostly compatible, but it doesn't
+include sprockets support by default. Since Erubi is most likely to be used in a
+Roda stack which uses just Tilt to render assets this shouldn't be of any issue.
+Including sprockets support is as simple as doing `include "opal/erubi/processor"`.
+
+This code is opinionated - it assumes that you want to run it in an "escape: true"
+mode.
+
+## Usage
+
+Add opal-erubi to your `Gemfile`:
+
+```ruby
+gem 'opal-erubi'
+```
+
+Create an erubi file in the opal load path (e.g. `app/user_template.erubi`):
+
+```erb
+<div class="row">
+  <div class="col-md-6">
+    <%= self.name %>
+  </div>
+  <div class="col-md-6">
+    <%= self.age %>
+  </div>
+</div>
+```
+
+Render the erubi template:
+
+```ruby
+# app/application.rb
+require 'user_template'
+
+class User
+  attr_accessor :name, :age
+
+  def initialize(name, age)
+    @name, @age = name, age
+  end
+end
+
+user = User.new('Ford Prefect', 42)
+html = Template['user_template'].render(user)
+puts html
+# => <div class="row">...</div>
+```
+
+## Running tests
+
+Get dependencies:
+
+```
+$ bundle install
+```
+
+Run tests using opal-rspec:
+
+```
+$ bundle exec rake
+```
+
+Run specs in the browser:
+
+```
+$ bundle exec rackup
+```
+
+## License
+
+This gem contains adapted parts from opal-haml.
+
+(The MIT License)
+
+Copyright (C) 2019 by ahmadine
+
+opal-haml: Copyright (C) 2013 by Adam Beynon, 2015 Elia Schito
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler.require
+Bundler::GemHelper.install_tasks
+require 'opal/erubi/processor' # Sprockets support
+
+require 'opal/rspec/rake_task'
+Opal::RSpec::RakeTask.new(:default) do |_, task|
+  task.default_path = 'spec-opal'
+  task.pattern = 'spec-opal/**/*_spec.{rb,opal}'
+end

data/config.ru

@@ -0,0 +1,19 @@
+
+require 'bundler'
+Bundler.require
+
+require 'opal-sprockets'
+require 'opal-rspec'
+require 'opal/erubi/processor' # Sprockets support
+
+sprockets_env = Opal::RSpec::SprocketsEnvironment.new(
+  spec_pattern         = 'spec-opal/**/*_spec.{rb,opal}',
+  spec_exclude_pattern = nil,
+  spec_files           = nil,
+  default_path         = 'spec-opal')
+
+run Opal::Sprockets::Server.new(sprockets: sprockets_env) { |s|
+  s.main = 'opal/rspec/sprockets_runner'
+  s.append_path 'spec-opal'
+  s.debug = true
+}

data/lib-opal/erubi.rb

@@ -0,0 +1,15 @@
+require 'template'
+
+module Erubi
+  ESCAPE_TABLE={"&"=>"&amp;", "<"=>"&lt;", ">"=>"&gt;", "\""=>"&quot;", "'"=>"&#39;"}
+
+  def self.h value
+    value.to_s.gsub(/[&<>"']/, ESCAPE_TABLE)
+  end
+end
+
+class Template
+  class OutputBuffer
+    alias << append
+  end
+end

data/lib/opal-erubi.rb

@@ -0,0 +1 @@
+require 'opal/erubi'

data/lib/opal/erubi.rb

@@ -0,0 +1,21 @@
+require 'erubi'
+
+require 'opal/erubi/version'
+require 'opal/erubi/builder'
+
+#require 'opal/erubi/processor' <<< sprockets support, disabled by default
+
+Opal.append_path File.expand_path('../../../lib-opal', __FILE__).untaint
+
+module Opal
+  module Erubi
+    def self.compile_erubi(source, path)
+      ::Erubi::Engine.new(source.to_s, 
+        bufval: "__buf",
+        postamble: "_buf.join }",
+        escape: true,
+        src: "require 'erubi';Template.new('#{path}') { |__buf| ",
+        filename: path).src.dup
+    end
+  end
+end

data/lib/opal/erubi/builder.rb

@@ -0,0 +1,28 @@
+require 'opal'
+
+module Opal
+  module BuilderProcessors
+    class ErubiProcessor < RubyProcessor
+      handles :erubi
+
+      def initialize(*args)
+        super
+        @source = prepare(@source, @filename)
+      end
+
+      def requires
+        ['erubi'] + super
+      end
+
+      private
+
+      def prepare(source, path)
+        ::Opal::Erubi::compile_erubi(source, path)
+      end
+    end
+  end
+
+  # You could do this if you wanted to reclaim "erb" extension but I'm afraid
+  # it may cause some problems. ERB is used for preprocessing (Opal) Ruby code.
+  #Builder.processors.delete(BuilderProcessors::ERBProcessor)
+end

data/lib/opal/erubi/processor.rb

@@ -0,0 +1,29 @@
+# This file is for sprockets support.
+
+require 'opal-sprockets'
+
+module Opal
+  module Erubi
+    class Processor < ::Opal::Processor
+      self.default_mime_type = 'application/javascript'
+
+      def evaluate(context, locals, &block)
+        @data = Opal::Erubi.compile_erubi @data, context.logical_path.sub(/^templates\//, '')
+        super
+      end
+
+      def self.compiler_options
+        # otherwise would check current class `attr_accessor`s
+        ::Opal::Processor.compiler_options
+      end
+    end
+  end
+end
+
+if Sprockets.respond_to? :register_transformer
+  extra_args = [{mime_type: 'application/javascript', silence_deprecation: true}]
+else
+  extra_args = []
+end
+
+Sprockets.register_engine '.erubi', Opal::Erubi::Processor, *extra_args

data/lib/opal/erubi/version.rb

@@ -0,0 +1,5 @@
+module Opal
+  module Erubi
+    VERSION = '0.0.1'
+  end
+end

data/opal-erubi.gemspec

@@ -0,0 +1,25 @@
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+require 'opal/erubi/version'
+
+Gem::Specification.new do |s|
+  s.name         = 'opal-erubi'
+  s.version      = Opal::Erubi::VERSION
+  s.author       = 'hmdne'
+  s.email        = '54514036+hmdne@users.noreply.github.com'
+  s.homepage     = 'https://github.com/hmdne/opal-erubi'
+  s.summary      = 'Run Erubi templates client-side with Opal'
+  s.description  = 'Run Erubi templates client-side with Opal.'
+  s.license      = 'MIT'
+
+  s.files          = `git ls-files`.split("\n")
+  s.executables    = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.test_files     = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths  = ['lib']
+
+  s.add_dependency 'opal', ['>= 0.11', '< 2']
+  s.add_dependency 'erubi'
+
+  s.add_development_dependency 'opal-rspec'
+  s.add_development_dependency 'opal-sprockets' #for RSpec
+  s.add_development_dependency 'rake'
+end

data/spec-opal/erubi_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'fixtures/simple'
+require 'fixtures/advanced'
+require 'fixtures/html_content'
+#require 'fixtures/yielder'
+
+describe "Erubi files" do
+  let(:simple)            { Template['fixtures/simple'] }
+  let(:advanced)          { Template['fixtures/advanced'] }
+  let(:html_content)      { Template['fixtures/html_content'] }
+  #let(:yielder)           { Template['fixtures/yielder'] }
+
+  it "should be defined by filename on Template namespace" do
+    expect(simple).to be_kind_of(Template)
+  end
+
+  it "should render using #render" do
+    expect(simple.render(self).chomp).to eq('lol')
+  end
+
+  it "accepts a context to render template with" do
+    @erubi_message = "hello world"
+    expect(advanced.render(self).chomp).to include('hello world')
+    expect(advanced.render(self).chomp).to eq(<<~EOF.chomp)
+      hello world
+      <a foo="123" bar="baz" quz="1134" href="#">
+        foofoofoo
+      </a>
+    EOF
+  end
+
+  it "generates html with a given context" do
+    @h1_content = 'Ford Perfect'
+    expect(html_content.render(self).chomp).to eq('<h1>Ford Perfect</h1>')
+  end
+
+  # There are issues to be solved before such a syntax can be supported
+  xit "yields a block" do
+    out = yielder.render self do
+      "<strong>Hello world!</strong>"
+    end
+    expect(out.chomp).to eq("<div>\n  <strong>Hello world!</strong>\n</div>")
+  end
+end

data/spec-opal/fixtures/advanced.erubi

@@ -0,0 +1,4 @@
+<%= @erubi_message %>
+<a foo="123" bar="baz" quz="<%= 456+678 %>" href="#">
+  <%= 'foo' * 3 %>
+</a>

data/spec-opal/fixtures/html_content.erubi

@@ -0,0 +1 @@
+<h1><%= @h1_content %></h1>

data/spec-opal/fixtures/simple.erubi

@@ -0,0 +1 @@
+lol

data/spec-opal/fixtures/yielder.erubi

@@ -0,0 +1,3 @@
+<div>
+  <%== yield %>
+</div>

data/spec-opal/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'opal'
+require 'erubi'
+
+RSpec.configure do |c|
+  c.color = true
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: opal-erubi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- hmdne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: erubi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opal-rspec
+  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: opal-sprockets
+  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'
+description: Run Erubi templates client-side with Opal.
+email: 54514036+hmdne@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- config.ru
+- lib-opal/erubi.rb
+- lib/opal-erubi.rb
+- lib/opal/erubi.rb
+- lib/opal/erubi/builder.rb
+- lib/opal/erubi/processor.rb
+- lib/opal/erubi/version.rb
+- opal-erubi.gemspec
+- spec-opal/erubi_spec.rb
+- spec-opal/fixtures/advanced.erubi
+- spec-opal/fixtures/html_content.erubi
+- spec-opal/fixtures/simple.erubi
+- spec-opal/fixtures/yielder.erubi
+- spec-opal/spec_helper.rb
+homepage: https://github.com/hmdne/opal-erubi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Run Erubi templates client-side with Opal
+test_files: []