erbb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 50c49f3ca3586eeee28bf7a2b58371d1fbb8b82996dc41fdd8902c45e25a8233
+  data.tar.gz: 83d9b2ec7976df8a40e27114076a843b28b9fff1e0cfaf9a319d677c000f11d7
+SHA512:
+  metadata.gz: ad9a81aacdbf35111ef533bd91d69f5990bb38f5ba42d3ae0449f708e7ff0da5b0f72d52addb4d13faafd0082022c5d848e45f22098a3ba9a140c9da3c6709d3
+  data.tar.gz: f1e5a732eef491b53870f9de8dfa457b36e4a9c04ac2ec818d06858b886e9055e933637628af7a662eae2edd2b2f80054fdaf4a462bc48ee05749bf05f067768

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.1

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: ruby
+
+rvm:
+  - ruby-2.1.5
+  - ruby-2.5.1
+
+before_install:
+  - gem install bundler
+  - gem install rake
+  - gem install rspec
+
+script:
+  - rake

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 erbb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    erbb (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  erbb!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Josh Lauer
+
+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,71 @@
+[![Build Status](https://travis-ci.com/josh-lauer/erbb.svg?branch=master)](https://travis-ci.com/josh-lauer/erbb)
+
+# ERBB
+
+`ERBB` is `ERB`, with the additional ability to name blocks and save the output of rendering those blocks separately. It works exactly like `ERB`, with some additional methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'erbb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install erbb
+
+## Usage
+
+`ERBB` is built on top of `ERB`. It implements a `#named_block` method in templates which tells the parser to save the rendered contents of the block. In every other way, `ERBB` is used the same way as `ERB`.
+
+First, set up your erb template and instantiate.
+
+```ruby
+template = <<~TEMPLATE
+             some text
+             <% named_block :foo do %>
+             some text in the named block
+             <% end %>
+             some more text
+           TEMPLATE
+
+erbb = ERBB.new(template)
+```
+Then call `#result` to get the rendered output
+
+```ruby
+result = erbb.result(binding)
+=> "some text\nsome text in the named block\nsome more text\n"
+```
+The result is a string-like object that has a `#named_blocks` method that returns the rendered contents of all the named blocks in the template.
+
+```ruby
+result.named_blocks
+=> {:foo=>"some text in the named block\n"}
+```
+
+Also, for convenience, the result delegates method calls to `#named_blocks` if they don't collide with String methods
+
+```ruby
+result.foo
+=> "some text in the named block\n"
+```
+That's pretty much it. Use it like `ERB`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/josh-lauer/erbb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "erbb"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/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

data/erbb.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "erbb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "erbb"
+  spec.version       = ERBB::VERSION
+  spec.authors       = ["Josh Lauer", "Jeremiah Hemphill", "Seth Brogan"]
+  spec.email         = ["josh.lauer75@gmail.com", "jeremiah.hemphill@gmail.com", "brogan.seth@gmail.com"]
+
+  spec.summary       = %q{ERB with Blocks}
+  spec.description   = %q{ERB with Blocks}
+  spec.homepage      = "https://github.com/josh-lauer/erbb"
+  spec.license       = "MIT"
+
+  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # 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('..', __FILE__)) 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", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/erbb.rb

@@ -0,0 +1,13 @@
+require "erb"
+require "ostruct"
+
+require "erbb/parser"
+require "erbb/receiver"
+require "erbb/result"
+require "erbb/version"
+
+module ERBB
+  def self.new(*args)
+    ERBB::Parser.new(*args)
+  end
+end

data/lib/erbb/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/erbb/parser.rb

@@ -0,0 +1,46 @@
+module ERBB
+  # Parses ERBB files (erb files with #named_block calls in them). Use like you
+  # would the ERB class, except instead of passing a binding when getting the
+  # result, you pass in an object which will be the implicit receiver for all
+  # ruby calls made in the erb template. This object will be decorated with the
+  # instance methods in ERBB::Receiver when rendering.
+  class Parser < ERB
+    # @see https://ruby-doc.org/stdlib-2.5.1/libdoc/erb/rdoc/ERB.html#method-c-new
+    # @param  str [String] the template to render.
+    # @param  safe_level [Nil,Integer] the safe level.
+    # @param  trim_mode [Nil,String] how to handle newlines.
+    # @param  eoutvar [Nil] if the user passes a 4th arg, error
+    def initialize(str, safe_level=nil, trim_mode='>', eoutvar=nil)
+      # The fourth arg is the name of the variable defined on the receiver
+      # which is used to store the rendered output when parsing a template.
+      # ERBB works by exploiting that, so it has to control it.
+      raise ArgumentError, "In ERBB, the template ivar can’t be set" if eoutvar
+      super(str, safe_level, trim_mode, Receiver::RENDERED_TEMPLATE)
+    end
+
+    # @see https://ruby-doc.org/stdlib-2.5.1/libdoc/erb/rdoc/ERB.html#method-i-result
+    # @param b [Binding] the binding to use for rendering.
+    # @return [ERBB::Result] a string decorated with named blocks
+    def result(b=new_toplevel)
+      receiver = extract_receiver_from_binding(b)
+
+      # Render the template using the binding and return the result along with
+      #   the output of any named blocks.
+      ERBB::Result.new(
+        super(b),
+        receiver.named_blocks
+      )
+    end
+
+    private
+
+    # @param b [Binding] the binding to use to find its implicit receiver.
+    def extract_receiver_from_binding(b)
+      # yoink 'self' out of the binding context.
+      b.send(:eval, "self").tap do |receiver|
+        # decorate it before returning to so erbb methods work in templates.
+        receiver.instance_exec { extend ERBB::Receiver }
+      end
+    end
+  end
+end

data/lib/erbb/receiver.rb

@@ -0,0 +1,44 @@
+module ERBB
+  # Used to decorate the binding receiver with methods we want available in the
+  # template that are not defined on the binding receiver.
+  module Receiver
+    # The name of the ivar to use for storing the rendered template output
+    RENDERED_TEMPLATE = '@_erbb_out'.freeze
+
+    # When called within a template, defines a named_block. Repeated calls to
+    # a block with the same name within a template will be concatenated in the
+    # order in which they appear in the template.
+    def named_block(block_name, *args, &block)
+      # dup the output so far and save it
+      original_output = __erbb_get_rendered_template.dup
+
+      # wipe the template output ivar
+      __erbb_set_rendered_template("")
+
+      # render the block, populating the ivar with the result
+      yield(*args)
+
+      # concatenate the rendered output from the named block into the hash
+      named_blocks[block_name.to_sym] ||= ""
+      named_blocks[block_name.to_sym] << __erbb_get_rendered_template
+
+      # restore the template output ivar to its original value plus this block
+      __erbb_set_rendered_template(original_output + __erbb_get_rendered_template)
+    end
+
+    # @return [Hash] The blocks
+    def named_blocks
+      @_erbb_named_blocks ||= {}
+    end
+
+    private
+
+    def __erbb_get_rendered_template
+      instance_variable_get(RENDERED_TEMPLATE)
+    end
+
+    def __erbb_set_rendered_template(str)
+      instance_variable_set(RENDERED_TEMPLATE, str)
+    end
+  end
+end

data/lib/erbb/result.rb

@@ -0,0 +1,18 @@
+module ERBB
+  class Result < String
+    attr_reader :named_blocks
+
+    def method_missing(method_name)
+      if named_blocks.key?(method_name)
+        named_blocks[method_name]
+      else
+        super
+      end
+    end
+
+    def initialize(str, named_blocks, opts = {})
+      super(str, *opts)
+      @named_blocks = Hash[named_blocks.map { |k,v| [k.to_sym, v] }]
+    end
+  end
+end

data/lib/erbb/version.rb

@@ -0,0 +1,3 @@
+module ERBB
+  VERSION = File.read(File.join(File.dirname(__FILE__), 'VERSION')).strip
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: erbb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Lauer
+- Jeremiah Hemphill
+- Seth Brogan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ERB with Blocks
+email:
+- josh.lauer75@gmail.com
+- jeremiah.hemphill@gmail.com
+- brogan.seth@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- erbb.gemspec
+- lib/erbb.rb
+- lib/erbb/VERSION
+- lib/erbb/parser.rb
+- lib/erbb/receiver.rb
+- lib/erbb/result.rb
+- lib/erbb/version.rb
+homepage: https://github.com/josh-lauer/erbb
+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.7.7
+signing_key: 
+specification_version: 4
+summary: ERB with Blocks
+test_files: []