effigie 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e3e94658266f19a81320015ac9f6548563148748cb87c59803db452e7d6758e
+  data.tar.gz: 9a1c25b65ed533297d79cf87c5f10a62a20ac419de202e249b711e8e2685c990
+SHA512:
+  metadata.gz: 6ce4f9a131488b164a2bc9b2df9084c981b873c1ed87a18b72790b191c2075f484eee107b8deda88f920dcb74fe51ce058149622920210b94489da47c866f50c
+  data.tar.gz: b585bdec127acf5d1b456a8cdff0545f99f91e45253c310993e98e5aa90973e8b5c79b63b0e8a46d620c82227a927aa994ef871f55db83e614fd2c609b799f13

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/.travis.yml

@@ -0,0 +1,10 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+
+before_install: gem install bundler -v 1.17.1

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 mauro.berlanda@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 effigie.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    effigie (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.2)
+      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.17)
+  effigie!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Mauro Berlanda
+
+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,109 @@
+# Effigie
+
+[![Build Status](https://travis-ci.com/mberlanda/effigie.svg?branch=master)](https://travis-ci.com/mberlanda/effigie)
+
+Simple utility to render ERB templates from hash, objects or self.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'effigie'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install effigie
+
+## Usage
+
+### Using a static file and the default template:
+
+Template under `tasks.erb`:
+```erb
+These are my tasks:
+<% tasks.each do |t| %>* <%= t.name %>: <%= t.due_date %>
+<% end %>
+```
+
+```rb
+Task = Struct.new(:name, :due_date)
+template = Effigie::Template.new(filepath)
+tasks_list = [Task.new('foo', 'today'), Task.new('bar', 'tomorrow')]
+
+# Using an object responding to these methods
+class Agenda
+  attr_accessor :tasks
+end
+
+agenda = Agenda.new.tap { |a| a.tasks = tasks_list }
+template.render(agenda)
+
+# Using an OpenStruct
+template.render(OpenStruct.new(tasks: tasks_list))
+
+# Using self
+def tasks
+  tasks_list
+end
+template.render(self)
+```
+
+### Using custom subclasses
+
+```rb
+# Override default erb private method to avoid reading from file
+class HelloTemplate < Effigie::Template
+  def erb
+    ERB.new("Hello <%= name %>")
+  end
+end
+Person = Struct.new(:name)
+
+HelloWorldTemplate.new.render(Person.new("John Doe"))
+
+# Read from instance variables and methods
+class UserTemplate < Effigie::Template
+  def erb
+    ERB.new("Hello <%= current_user.name %>, welcome into <%= @application %>.")
+  end
+end
+
+def current_user
+  Person.new("John Doe")
+end
+
+@application = "Effigie"
+
+# Read from an hash table
+class HashTemplate < Effigie::Template
+  def erb
+    ERB.new("Hello <%= self[:name] %>, welcome into <%= self[:application] %>.")
+  end
+end
+
+HashTemplate.new.render(name: "John Doe", application: "Effigie")
+```
+
+## 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.
+
+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/mberlanda/effigie. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Effigie project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mberlanda/effigie/blob/master/CODE_OF_CONDUCT.md).

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 "effigie"
+
+# 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/effigie.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "effigie/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "effigie"
+  spec.version       = Effigie::VERSION
+  spec.authors       = ["Mauro Berlanda"]
+  spec.email         = ["mauro.berlanda@gmail.com"]
+
+  spec.summary       = %q{Simple utility to render ERB templates from hash, objects or self.}
+  spec.description   = %q{Utility to render ERB templates out of hash maps, objects or self using ruby standard library}
+  spec.homepage      = "https://www.github.com/mberlanda/effigie"
+  spec.license       = "MIT"
+
+  # 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.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/effigie.rb

@@ -0,0 +1,7 @@
+require "effigie/version"
+require "effigie/template"
+
+module Effigie
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/effigie/template.rb

@@ -0,0 +1,67 @@
+require 'erb'
+
+# The +Effigie::Template+ class provides
+# provides some utilities to read an ERB
+# template and render it within ruby standard library
+class Effigie::Template
+  attr_reader :filepath
+
+  # Creates a new instance of +Effigie::Template+
+  #
+  # Params:
+  # +filepath+:: +string+ a file path
+  #
+  # In case you do not want to read from file
+  # You should override +erb+ private method
+  #
+  # Usage:
+  #
+  # Reading from file path
+  # +Effigie::Template.new("path/to/file.erb")
+  #
+  # Overriding +erb+ method
+  #
+  #    class HelloWorldTemplate < Effigie::Template
+  #      def erb
+  #        ERB.new("Hello <%= name %>")
+  #      end
+  #    end
+  #
+  #    HelloWorldTemplate.new.render(OpenStruct.new(name: "World"))
+
+  def initialize(filepath = nil)
+    @filepath = filepath
+  end
+
+  # It renders your template out of the +Binding+ instance
+  # of the object passed as argument
+  #
+  # Params:
+  # +ctx+:: any object
+  #
+  # E.g. Usage with +Hash+
+  #
+  #    class HashTemplate < Effigie::Template
+  #      def erb
+  #        ERB.new("Hello <%= self[:name] %>")
+  #      end
+  #    end
+  #
+  #    HashTemplate.new.render(name: "World")
+  #
+  # Please see the tests for further examples
+
+  def render(ctx)
+    erb.result(ctx.instance_eval { binding })
+  end
+
+  private
+
+  def erb
+    @erb ||= ERB.new(read)
+  end
+
+  def read
+    @read ||= File.read(filepath)
+  end
+end

data/lib/effigie/version.rb

@@ -0,0 +1,3 @@
+module Effigie
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: effigie
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mauro Berlanda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-06 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: 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: Utility to render ERB templates out of hash maps, objects or self using
+  ruby standard library
+email:
+- mauro.berlanda@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- effigie.gemspec
+- lib/effigie.rb
+- lib/effigie/template.rb
+- lib/effigie/version.rb
+homepage: https://www.github.com/mberlanda/effigie
+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.6
+signing_key: 
+specification_version: 4
+summary: Simple utility to render ERB templates from hash, objects or self.
+test_files: []