ruyml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46b25c10159d9211c79de3ed33a83129c9ab43c6
+  data.tar.gz: 38ee47d13a655055f155185385b2e0ea0de751bb
+SHA512:
+  metadata.gz: 9a3808d44846fd8d9872ae574c44198ee4201a5526148c76536278e564882c91364727c1da6a352fdfe9169d6ec22469466a3ab81e531c45320c724a46d028fb
+  data.tar.gz: 1422071ca3be7056e4ec26f8ad964df3a64ae02c2c299ed035f314a7ffcac25da06b9a14493ed5ccea399703a5b967e66f88da20c48eef4a2b9677287f5bc73b

data/.gitignore

@@ -0,0 +1 @@
+*.swap

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruyml.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    ruyml (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  rake (~> 10.0)
+  ruyml!
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Xavier Lucas
+
+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,85 @@
+# RUYML
+
+Ruby templating using YAML datasources
+
+# Usage
+
+```
+Usage : ruyml [options]
+
+Mandatory options:
+    -d, --datasources DATASOURCES
+    -t, --template TEMPLATE
+
+Optional options:
+    -o, --output FILE
+```
+
+## Simple usage
+
+Given a yaml file :
+
+```yaml
+alert:
+  message: 'hello world !'
+```
+
+And an erb file :
+
+```erb
+message = "<%= alert.message.capitalize %>"
+```
+
+Running :
+
+```bash
+ruby ruyml.rb -d alert.yaml -t template.erb
+```
+
+Gives the following output :
+
+```
+message = "Hello world !"
+```
+
+### Advanced usage
+#### Multiple data sources
+You can refer to multiple YAML datasources in a template and render it using :
+
+```bash
+ruyml -d data1.yaml,data2.yaml -t template.erb
+```
+
+#### Accessing Hash methods
+When iterating over an item which is not a leaf of the YAML file, you can access
+methods of the Hash class directly. In case a propertie has the same name than
+the method you are trying to use, simply use the `<method>!` form.
+
+For instance :
+
+```yaml
+object:
+  each: value
+```
+
+```erb
+Each object will have <%= object.each %>.
+
+Full object properties:
+<% object.each! do |k, v| -%>
+  <%= k %> : <%= v %>
+<% end -%>
+```
+
+Once rendered, the result is :
+
+```
+Each object will have value.
+
+Full object properties:
+  each : value
+```
+
+## Status
+
+Alot of todos in there ... but you can feel the spirit.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruyml"
+
+# 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

data/bin/ruyml

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+# *****************************************************************************
+#  RUYML : Ruby templating using YAML datasources
+# *****************************************************************************
+#  @author : Xavier Lucas
+# *****************************************************************************
+
+require 'ruyml'
+require 'yaml'
+require 'optparse'
+require 'ostruct'
+
+# Parse CLI
+data = {}
+options = OpenStruct.new
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage : #{File.basename($0)} [options]"
+  opts.separator ""
+  opts.separator "Mandatory options:"
+
+  opts.on("-d", "--datasources DATASOURCES", Array) do |datasources|
+    options.datasources = datasources
+  end
+
+  opts.on("-t", "--template TEMPLATE") do |template|
+    options.template = template
+  end
+
+  opts.separator ""
+  opts.separator "Optional options:"
+
+  opts.on("-o", "--output FILE") do |output|
+    options.output = output
+  end
+end
+
+parser.parse!(ARGV)
+
+if options.template.nil? || options.datasources.nil?
+  abort parser.help
+end
+
+options.datasources.each do |datasource|
+  data.merge!(YAML.load(File.read(datasource)))
+end
+
+Ruyml::Data.new(data).render(options.template, options.output)

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/lib/ruyml/version.rb

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

data/lib/ruyml.rb

@@ -0,0 +1,53 @@
+require "ruyml/version"
+
+require 'erb'
+
+module Ruyml
+
+  class Data
+    # Create RUYML data from a YAML hash.
+    # Underlying hashes will be accessed
+    # as instances of this class. Other
+    # types are kept untouched and returned
+    # as is.
+    def initialize(hash)
+      @hash = hash
+      @hash.each do |k, v|
+        self.define_singleton_method k.to_sym do
+          return v.class == Hash ? Data.new(v) : v
+        end
+      end
+    end
+
+    # Renders RUYML data using the given template.
+    # Rendered data is either written to an optional
+    # output file path or to stdout.
+    def render(template, output)
+      result = ERB.new(File.read(template), 0, '-').result(binding)
+      if !output.nil?
+        File.open(output, "w") do |file|
+          file.write(result)
+        end
+      else
+        puts result
+      end
+    end
+
+    # Access Hash class methods. If a YAML propertie
+    # matches the method name, then the target method
+    # is called if a '!' terminates the method name.
+    private
+    def method_missing(name, *args, &block)
+      method = name.to_s
+      if method =~ /.+!$/ && self.respond_to?(method.chop)
+        method.chop!
+      end
+      if @hash.respond_to?(method)
+        @hash.send(method, *args, &block)
+      else
+        raise NameError, "Undefined property or method '#{name}'"
+      end
+    end
+  end
+
+end

data/ruyml.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruyml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruyml"
+  spec.version       = Ruyml::VERSION
+  spec.authors       = ["Xavier Lucas"]
+  spec.email         = ["xavier_lucas@ymail.com"]
+
+  spec.summary       = %q{Ruby templating from YAML datasources.}
+  spec.description   = %q{A command line interface and a library to render erb templates using one or multiple YAML datasources.}
+  spec.homepage      = "https://github.com/xlucas/ruyml"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: ruyml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Xavier Lucas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: A command line interface and a library to render erb templates using
+  one or multiple YAML datasources.
+email:
+- xavier_lucas@ymail.com
+executables:
+- console
+- ruyml
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/ruyml
+- bin/setup
+- lib/ruyml.rb
+- lib/ruyml/version.rb
+- ruyml.gemspec
+homepage: https://github.com/xlucas/ruyml
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby templating from YAML datasources.
+test_files: []