yerbish 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9f4156bbef5616be4f951d0d7a0c1fad4684183
+  data.tar.gz: e9099ece42113b2c23b372ba914b55ddd075ab6e
+SHA512:
+  metadata.gz: 699b0fdd7585a6fe096291097d573ddeefdfec903fb997d5e9a03dc847ef86d320ad63bb865e3eec56edb34c3e2a71905382aafd34268fae6ebf5bea8f0de2e5
+  data.tar.gz: 0603ad7278aa9ef808cd3ecf4fc3ad9ffebe36cd585a3b0f4929399872b7fef827d2af33a25c86a2ffdb4afa36bc7c550ae394720f5ac3999d23dc1c60f14030

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Dave Willkomm
+
+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,29 @@
+# Yerbish [![Build Status](https://travis-ci.org/dinosaurjr10/yerbish.svg?branch=master)](http://travis-ci.org/dinosaurjr10/yerbish) [![Coverage Status](https://img.shields.io/coveralls/dinosaurjr10/yerbish.svg)](https://coveralls.io/r/dinosaurjr10/yerbish?branch=master)
+
+YAML with embedded Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yerbish'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yerbish
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/yerbish/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/yerbish/version.rb

@@ -0,0 +1,3 @@
+module Yerbish
+  VERSION = "0.0.1"
+end

data/lib/yerbish.rb

@@ -0,0 +1,49 @@
+require 'erb'
+require 'json'
+require 'yaml'
+require 'yerbish/version'
+
+module Yerbish
+  FILE_EXTENSION = '.yml.erb'
+
+  attr_accessor :base_path
+
+  def create_binding(base_path, local_variables = {})
+    b = TOPLEVEL_BINDING.dup
+    b.eval 'include Yerbish'
+    local_variables.each { |k,v| b.local_variable_set k, v }
+    b.eval "self.base_path = '#{base_path}'"
+    b
+  end
+
+  # Interprets the specified file's embedded Ruby, parsing the result as YAML and returning the resulting data
+  # structure.
+  def load(file_path, local_variables = {})
+    yaml = render file_path, local_variables
+    YAML.load yaml
+  end
+
+  # Interprets the specified file's embedded Ruby and returns the resulting (YAML) string.
+  def render(file_path, local_variables = {})
+    absolute_path = File.expand_path file_path, base_path
+    absolute_path += FILE_EXTENSION unless absolute_path.end_with?(FILE_EXTENSION)
+    file_content = File.read absolute_path
+    erb = ERB.new file_content
+    erb.result create_binding(base_path, local_variables)
+  end
+
+  # Interprets the specified file's embedded Ruby, parsing the result as YAML and returning it formatted as JSON.
+  def render_json(file_path, local_variables = {})
+    object = load file_path, local_variables
+    JSON.pretty_generate object
+  end
+
+  module_function(
+    :base_path,
+    :base_path=,
+    :create_binding,
+    :load,
+    :render,
+    :render_json,
+  )
+end

data/spec/lib/yerbish_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+require 'yerbish'
+
+describe Yerbish do
+  let(:test_local_variables) { { test_local_variable: 'test-local-variable-value' } }
+
+  describe '#create_binding' do
+    subject { described_class.create_binding 'test-base-path', test_local_variable: 'test-local-variable-value' }
+
+    it 'should mix in Yerbish' do
+      expect(subject.eval 'self.private_methods').to include :base_path
+      expect(subject.eval 'self.private_methods').to include :base_path=
+      expect(subject.eval 'self.private_methods').to include :create_binding
+      expect(subject.eval 'self.private_methods').to include :load
+      expect(subject.eval 'self.private_methods').to include :render
+      expect(subject.eval 'self.private_methods').to include :render_json
+    end
+
+    it 'should set the specified local variables' do
+      expect(subject.eval 'test_local_variable').to eq 'test-local-variable-value'
+    end
+
+    it 'should set base_path' do
+      expect(subject.eval 'base_path').to eq 'test-base-path'
+    end
+  end
+
+  describe '#load' do
+    subject { described_class.load File.expand_path('../resources/load_test', __dir__) }
+
+    it { is_expected.to include 'key' => 'value' }
+  end
+
+  describe '#render' do
+    subject { described_class.render file_path, test_local_variables }
+
+    context 'given an absolute file path' do
+      let(:file_path) { File.expand_path '../resources/render_test', __dir__ }
+
+      it { is_expected.to match /key: test-local-variable-value/ }
+    end
+
+    context 'given a base path and a relative file path' do
+      let(:file_path) { 'render_test' }
+
+      before { described_class.base_path = File.expand_path '../resources', __dir__ }
+      # As base_path is set on the module, we need to reset it as other tests expext it to be nil.
+      after { described_class.base_path = nil }
+
+      it { is_expected.to match /key: test-local-variable-value/ }
+    end
+
+    context 'given a file path with a .yml.erb extension' do
+      let(:file_path) { File.expand_path '../resources/render_test.yml.erb', __dir__ }
+
+      it { is_expected.to match /key: test-local-variable-value/ }
+    end
+  end
+
+  describe '#render_json' do
+    subject { described_class.render_json File.expand_path('../resources/render_json_test', __dir__) }
+
+    it { is_expected.to match /"key": "value"/ }
+
+    it 'should render valid JSON' do
+      expect { JSON.parse subject }.to_not raise_error
+    end
+  end
+
+  describe 'nested rendering' do
+    subject do
+      json = described_class.render_json(
+        File.expand_path('../resources/nested_render_test', __dir__),
+        test_local_variables
+      )
+      JSON.parse json
+    end
+
+    before { described_class.base_path = File.expand_path '../resources', __dir__ }
+
+    it 'should render three nested files' do
+      expect(subject['key1']).to eq 'test-local-variable-value'
+      expect(subject['key2']).to eq 'test-local-variable2-value'
+      expect(subject['key3']).to eq File.expand_path('../resources', __dir__)
+    end
+  end
+end

data/spec/resources/load_test.yml.erb

@@ -0,0 +1,2 @@
+---
+key: value

data/spec/resources/nested_render_test.yml.erb

@@ -0,0 +1,3 @@
+---
+key1: <%= test_local_variable %>
+<%= render 'subdirectory/nested_render_test2', test_local_variable2: 'test-local-variable2-value' %>

data/spec/resources/render_json_test.yml.erb

@@ -0,0 +1,2 @@
+---
+key: value

data/spec/resources/render_test.yml.erb

@@ -0,0 +1,2 @@
+---
+key: <%= test_local_variable %>

data/spec/resources/subdirectory/nested_render_test2.yml.erb

@@ -0,0 +1,2 @@
+key2: <%= test_local_variable2 %>
+<%= render 'subdirectory/nested_render_test3' %>

data/spec/resources/subdirectory/nested_render_test3.yml.erb

@@ -0,0 +1 @@
+key3: <%= base_path %>

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start

data/yerbish.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yerbish/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yerbish'
+  spec.version       = Yerbish::VERSION
+  spec.authors       = ['Dave Willkomm']
+  spec.email         = ['dinosaurjr10@gmail.com']
+  spec.summary       = 'YAML with embedded Ruby'
+  spec.description   = 'Yerbish enables embedding Ruby in YAML files, as well as composing a YAML file from other partial YAML files.'
+  spec.homepage      = 'https://github.com/dinosaurjr10/yerbish'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'coveralls', '~> 0.7'
+  spec.add_development_dependency 'rake', '~> 10.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: yerbish
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dave Willkomm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !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: Yerbish enables embedding Ruby in YAML files, as well as composing a
+  YAML file from other partial YAML files.
+email:
+- dinosaurjr10@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/yerbish.rb
+- lib/yerbish/version.rb
+- spec/lib/yerbish_spec.rb
+- spec/resources/load_test.yml.erb
+- spec/resources/nested_render_test.yml.erb
+- spec/resources/render_json_test.yml.erb
+- spec/resources/render_test.yml.erb
+- spec/resources/subdirectory/nested_render_test2.yml.erb
+- spec/resources/subdirectory/nested_render_test3.yml.erb
+- spec/spec_helper.rb
+- yerbish.gemspec
+homepage: https://github.com/dinosaurjr10/yerbish
+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.3.0
+signing_key: 
+specification_version: 4
+summary: YAML with embedded Ruby
+test_files:
+- spec/lib/yerbish_spec.rb
+- spec/resources/load_test.yml.erb
+- spec/resources/nested_render_test.yml.erb
+- spec/resources/render_json_test.yml.erb
+- spec/resources/render_test.yml.erb
+- spec/resources/subdirectory/nested_render_test2.yml.erb
+- spec/resources/subdirectory/nested_render_test3.yml.erb
+- spec/spec_helper.rb