mini_erb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aff6f338bd13d799f411d961cfdff3567c970257
+  data.tar.gz: 5f52a24d7c91a2e9f023e9bbac0099df920a1091
+SHA512:
+  metadata.gz: 6af56e3cba6a6f1db760840d6dce4298f7fb2c1bc33d9bb66f7d0e15a3066aeae1103a642d0031c0a71fbe595476797f075f970cc4b36e64dc1eff3468ba096b
+  data.tar.gz: 2749572d1280b968f2eb61a855d94592971dbeebe526de074efcc9c545f838f67996e693732a0e450557ec5d5804c334dae64519c5367f2dd2441cd9eb7818f9

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at peter.c.camilleri@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mini_erb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 PeterCamilleri
+
+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,254 @@
+# MiniErb
+
+The mini_erb gem is another spin off from the mysh project. In testing the
+handlebars embedded Ruby system used there, it was observed that the test
+code was faster than both the native erb and the faster erubi.
+
+The mini_erb gem returns to the syntax of erb but is based on the same
+algorithm of the mysh handlebars.
+
+In performance it is still faster. This is laid out in this
+[report](https://github.com/PeterCamilleri/mini_erb/blob/master/docs/embbed_ruby_study.pdf)
+.
+
+### Embedding Ruby into text or html
+
+The use of erb to embed ruby code into text or html is widely covered, so only
+a brief summary of this topic is presented here.
+
+1. **Embedding ruby computed values into the text.**
+
+The following embeds the results of the execution of the ruby into the results.
+
+```ruby
+env = binding
+
+str = "ABCD<%= (1..9).to_a.join %>EFGH"
+puts MiniErb.new(str).result(env)
+```
+produces
+
+    ABCD123456789EFGH
+
+2. **Using ruby to control the generated text.**
+
+You can also use ruby to control what text or html is included in the output.
+This allows the ruby code to select which text/html is included and even to
+repeat sections.
+
+```ruby
+x   = 42
+env = binding
+
+str = "<% if x==42 %>Life, the Universe and Everything<% else %>Some stuff<% end %>"
+puts MiniErb.new(str).result(env)
+```
+produces
+
+    Life, the Universe and Everything
+
+and
+
+```ruby
+env = binding
+
+str = "<% 5.times { |i| %> <%= i+1 %> sheep <% } %>"
+puts MiniErb.new(str).result(env)
+```
+produces
+
+     1 sheep  2 sheep  3 sheep  4 sheep  5 sheep
+
+3. **Control of debug code.**
+
+Sometimes, there is a need to add code for debug or testing purposes. In
+production, we do not want this code interfering with normal operation but we
+may not wish to simply delete it. The following example shows some "debug"
+code.
+
+```ruby
+env = binding
+
+str = "Now is the hour of our discontent! <%= "Answer=42" %>"
+puts MiniErb.new(str).result(env)
+```
+produces
+
+    Now is the hour of our discontent! Answer=42
+
+In production use, we can turn off that code with:
+```ruby
+env = binding
+
+str = "Now is the hour of our discontent! <%#= "Answer=42" %>"
+puts MiniErb.new(str).result(env)
+```
+and now we get this clean output
+
+    Now is the hour of our discontent!
+
+4. **Removal of unwanted new-lines**
+
+Sometimes in formatting the embedded ruby code, it is desired to add extra
+new-lines to make the code easier to read and understand. These extra lines
+may not be desirable in the output. These can be controlled as follows:
+
+```ruby
+env = binding
+
+str = <<-end_of_string
+ABCD<%= (1..9).to_a.join -%>
+EFGH
+end_of_string
+
+puts MiniErb.new(str).result(env)
+```
+produces
+
+    ABCD123456789EFGH
+
+Note how the output does not contain the spurious new line between the
+"9" and "E" characters.
+
+### Differences from traditional erb.
+
+The mini_erb gem supports a subset of the functionality of erb.
+The following lays out the differences:
+
+* The suppression of new lines with a tag ending in -&#37;> is active by default.
+* The use of code lines starting with a % sign is not supported. Instead use
+<%  ... %> embedded code blocks.
+* In erb, <%% maps to <%. In mini_erb use <\&#37; instead. The same goes for
+%%> which is replaced by \&#37;>.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mini_erb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mini_erb
+
+## Usage
+
+The use of the mini_erb gem comes in two distinct phases.
+
+1. Creating a mini_erb object. This object contains the source input transpiled
+into ruby code.
+2. Executing the transpiled code in an execution environment.
+
+### Phase 1
+
+Creating a mini_erb object is done simply with the standard new method. The
+corresponding initialize method is:
+
+```ruby
+def initialize(string, safe_level=nil, _=nil, eoutvar='_erbout')
+  @safe_level, @eoutvar = safe_level, eoutvar
+  @filename, @lineno = "(mini_erb)", 0
+  @src = compile(string)
+end
+```
+
+where:
+
+* *string* is a string containing the source text embedded with ruby code.
+* *safe_level* is an optional parameter controlling the level of distrust of the
+embedded ruby code. While outside the purview of this file, the following gives
+a nice summary of the available options:
+
+safe_level | constraints
+-----------|--------------
+0          | No checking of the use of externally supplied (tainted) data is performed. This is the default.
+≥ 1        | Ruby disallows the use of tainted data by potentially dangerous operations.
+≥ 2        | Ruby prohibits the loading of program files from globally writable locations.
+≥ 3        | All newly created objects are considered tainted and untrusted.
+≥ 4        | Ruby effectively partitions the running program in two. Nontrusted objects may not be modified.
+
+(Source: Programming Ruby by Dave Thomas with Chad Fowler and Andy Hunt)
+
+* *_* is an optional and unused parameter retained only for erb compatibility.
+* *eoutvar* is an optional parameter used to specify a different local variable
+name to contain the results of the embedding process.
+
+In many cases, only one parameter is required as in the many examples above.
+
+#### Adding location info.
+
+For purposes of debugging, it may be useful to tie the transpiled code to a
+file or line number. This information can be added to the mini_erb object as
+follows:
+
+```ruby
+file_name = "my_file.erb"
+erbed = MiniErb.new(IO.read(file_name))
+erbed.filename = file_name
+```
+This sets up the erb file and establishes its file name for debug purposes.
+
+#### The transpiled code.
+
+Optionally, the transpiled ruby code may be accessed using the *src* attribute.
+This is most often done to verify that the transpiler is operating correctly
+but is also useful to those who wish to gain insights into the operation of
+the mini_erb gem. It was this same access provided by the erb library that
+made this gem possible.
+
+### Phase 2
+
+The next step is to execute the transpiled code in an environment. This
+environment is a ruby binding to the virtual location of the code execution.
+In effect, code is executed from the place where the binding is taken.
+
+This use of bindings allows access to any variables that may have been defined
+in that a location and also allows the state of that location to be modified.
+For example:
+
+```ruby
+x = 42
+str = "x is now <%=x%>.<%x+=1%> x is now <%=x%>."
+puts MiniErb.new(str).result(binding), x
+```
+produces
+
+    x is now 42. x is now 43.
+    43
+
+Note how the environment was modified by adding one to x.
+
+If no binding is specified, the binding of the top level file of the current
+program is used as a default.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+OR...
+
+* Make a suggestion by raising an
+ [issue](https://github.com/PeterCamilleri/mini_erb/issues)
+. All ideas and comments are welcome.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](./LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the mini_erb project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](./CODE_OF_CONDUCT.md).

data/lib/mini_erb.rb

@@ -0,0 +1,76 @@
+require_relative "mini_erb/version"
+
+# A simplified, streamlined erb replacement.
+class MiniErb
+
+  # The Ruby code generated by mini erb.
+  attr_reader :src
+
+  # The optional file name used when the mini_erb code is run.
+  attr_accessor :filename
+
+  # The optional line number used when the mini_erb code is run.
+  attr_accessor :lineno
+
+  # Set the file name and optional line number associated with the compiled code.
+  def location=((filename, lineno))
+    @filename = filename
+    @lineno = lineno if lineno
+  end
+
+  # Create a mini_erb object. Spurious parameter is for erb compatibility.
+  def initialize(string, safe_level=nil, _=nil, eoutvar='_erbout')
+    @safe_level, @eoutvar = safe_level, eoutvar
+    @filename, @lineno = "(mini_erb)", 0
+    @src = compile(string)
+  end
+
+  # Compile the mini erb input
+  def compile(string)
+    buffer, suppress = [], false
+
+    until string.empty?
+      text, code, string = string.partition(/<%.*?%>/m)
+
+      text.sub!(/\A$\r?\n?/, "") if suppress
+      suppress = false
+
+      buffer << "#{@eoutvar}<<#{text.inspect};" unless text.empty?
+
+      unless code.empty?
+        end_point = (suppress = code[-3] == "-") ? -3 : -2
+
+        unless code[2] == "#"
+          if code[2] == "="
+            buffer << "#{@eoutvar}<<(#{code[3...end_point]}).to_s;"
+          else
+            buffer << "#{code[2...end_point]};"
+          end
+        end
+      end
+    end
+
+    @eoutvar + "='';" + buffer.join + @eoutvar
+  end
+
+  # Return the mini erb text with embedded Ruby results.
+  def result(evaluator = new_toplevel)
+    if @safe_level
+      proc {$SAFE = @safe_level; eval(@src, evaluator, @filename, @lineno)}.call
+    else
+      eval(@src, evaluator, @filename, @lineno)
+    end
+  end
+
+  # Generate results and print them.
+  def run(evaluator = new_toplevel)
+    print result(evaluator)
+  end
+
+private
+
+  # Get a duplicate of the default binding if none is specified.
+  def new_toplevel
+    TOPLEVEL_BINDING.dup
+  end
+end

data/lib/mini_erb/version.rb

@@ -0,0 +1,6 @@
+
+class MiniErb
+  VERSION = "0.1.0".freeze
+
+  DESCRIPTION = "mini_erb: A simplified, streamlined erb replacement.".freeze
+end

data/mini_erb.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mini_erb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mini_erb"
+  spec.version       = MiniErb::VERSION
+  spec.authors       = ["PeterCamilleri"]
+  spec.email         = ["peter.c.camilleri@gmail.com"]
+
+  spec.summary       = MiniErb::DESCRIPTION
+  spec.description   = "A simplified, streamlined, pure ruby replacement for erb."
+  spec.homepage      = "https://github.com/PeterCamilleri/mini_erb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+                          f.match(%r{^(test|docs)/})
+                        end
+  spec.bindir        = "exe"
+  spec.executables   = spec
+                         .files
+                         .reject { |f| f.downcase == 'exe/readme.md'}
+                         .grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'minitest_visible', "~> 0.1"
+end

data/rakefile.rb

@@ -0,0 +1,16 @@
+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
+
+desc "What version of mini_erb is this?"
+task :vers do |t|
+  puts
+  puts "mini_erb version = #{::MiniErb::VERSION}"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: mini_erb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- PeterCamilleri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest_visible
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: A simplified, streamlined, pure ruby replacement for erb.
+email:
+- peter.c.camilleri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/mini_erb.rb
+- lib/mini_erb/version.rb
+- mini_erb.gemspec
+- rakefile.rb
+homepage: https://github.com/PeterCamilleri/mini_erb
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: 'mini_erb: A simplified, streamlined erb replacement.'
+test_files: []