yaml_master 0.4.2 → 1.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b92fa420cc7d3c24f1bb62a31383d801a9723fb
-  data.tar.gz: 18dc5fe8f6ac65c4b5944bca3ab5a1cc1beb05c2
+  metadata.gz: 070d60a6d5c053d57f09ac3b78adbadc0624a221
+  data.tar.gz: ad225310f64d0f800a4d31134098a901a440942b
 SHA512:
-  metadata.gz: 77f5487fa6c68e326d89277ff4e94e6cb8c4338e28c817009921df0697c807b8533f25736b37c85eca140d53c285b1aba7cc5bfd287f5e748e1eacec0ec55b39
-  data.tar.gz: 1ac82cbab64bd30db593e37bac4db1d3913a0540b30e5e5312948390d70a8edfa740be60ef30d54d0a6e779a3ddc30b59b797d42192c6f810146e2b6e01ce9ef
+  metadata.gz: bfc70674eb8c9a0208e0c1232cceb98d551089fa1c5184e796a23c6042d4df2ca7a87fb188a48ff8fa888184b0f61699df53839238c7b073fa17e5d271ef88b9
+  data.tar.gz: 582379f1ee6357a8336c1b0c1c19c7a4554bf865a0c376471d84025de3a1c01efd711a860e779e954baff02e419839ad2c8b751fc28dc73926b2ea97a44a940d

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 sudo: false
 rvm:
-  - 2.2.3
-before_install: gem install bundler -v 1.10.5
+  - 2.3.4
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4
 cache: bundler

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby:2.4-alpine
+
+ARG version
+
+RUN if [[ "$version" = "" ]]; then gem install yaml_master --no-document; else gem install yaml_master --no-document --version ${version}; fi
+
+ENTRYPOINT ["yaml_master"]

data/README.md

@@ -35,6 +35,17 @@ Usage: yaml_master [options]
         --version         print the version
 ```
 
+### Support YAML tags
+
+| tag                            | description                                                                                   |
+| ------------------------       | -------------------------------------------------------------------------------------         |
+| !include {yaml_filename}       | Replace value by other yaml file content. included file can use alias in master file.         |
+| !master_path                   | Replace value by master file path                                                             |
+| !user_home                     | Replace value by `ENV["HOME"]`.                                                               |
+| !env {key}                     | Replace value by `ENV["{key}"]`.                                                              |
+| !properties {key}              | Replace value by fetched value from given properties.                                         |
+| !read_file_if_exist {filename} | Replace value by content of {filename}. if {filename} does not exist, Replace value by `null` |
+
 at first, Write master.yml
 
 ```yaml
@@ -96,6 +107,15 @@ data:
       database: my_database
       table: my_table
       mode: insert
+
+tag_sample
+  included: !include included.yml
+  master_path: !master_path
+  user_home: !user_home
+  env: !env HOME
+  properties: !properties foo
+  read_file_if_exist: !read_file_if_exist sample.txt
+  read_file_if_exist_nothing: !read_file_if_exist nothing.txt
 ```
 
 ### single output
@@ -193,6 +213,54 @@ out:
   mode: insert
 ```
 
+```yaml
+# ./tag_sample.yml
+
+---
+included:
+  xyz: hoge
+  db:
+    adapter: mysql2
+    encoding: utf8
+    database: development
+    pool: 5
+    host:
+    username: root
+    password:
+    socket: "/tmp/mysql.sock"
+  abc:
+  - 1
+  - 2.3
+  - a: 1
+    b: 2
+included2:
+- foo: bar
+- hoge: fuga
+- :abc:
+  - 1
+  - 2
+  - 3
+master_path: "/home/joker/.ghq/github.com/joker1007/yaml_master/spec/sample.yml"
+master_path2: "/home/joker/.ghq/github.com/joker1007/yaml_master/spec/sample.yml"
+user_home: "/home/joker"
+user_home2: "/home/joker"
+env: "/home/joker"
+properties: '24'
+read_file_if_exist: 'dummy
+
+'
+read_file_if_exist_nothing:
+read_file_if_exist2: 'dummy '
+```
+
+## How to use with Docker
+
+```sh
+docker run --rm \
+  -v `pwd`/:/vol \
+  joker1007/yaml_master -m /vol/spec/sample.yml -k database_yml -o /vol/test.yml
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/yaml_master

@@ -1,45 +1,71 @@
 #!/usr/bin/env ruby
 
+require "optparse"
 require "yaml_master"
-require "slop"
-
-opts = Slop.parse(strict: true) do
-  on 'm', 'master=', 'master yaml file'
-  on 'k', 'key=', 'single generate target key (in data: block)'
-  on 'o', 'output=', 'output filename for single generate target'
-  on 'a', 'all', 'target all key (defined in yaml_master: block)'
-  on 'p', 'properties=', 'set property (--properties="NAME=VALUE,NAME=VALUE" or -p "NAME=VALUE" -p "NAME=VALUE")', as: Array
-  on 'h', 'help', 'display this help'
-  on 'v', 'verbose', 'verbose mode'
-  on '--version', 'print the version' do
+
+options = {properties: []}
+
+opt_parser = OptionParser.new do |opts|
+  opts.on("-m", "--master=MASTER_FILE", "master yaml file") do |master|
+    options[:master] = master
+  end
+
+  opts.on("-k", "--key=KEY", "single generate target key (in data: block)") do |key|
+    options[:key] = key
+  end
+
+  opts.on("-o", "--output=OUTPUT", "output filename for single generate target") do |output|
+    options[:output] = output
+  end
+
+  opts.on("-a", "--all", "target all key (defined in yaml_master: block)") do |all|
+    options[:all] = true
+  end
+
+  opts.on("-d", "--dump", "dump evaluated master yaml") do ||
+    options[:dump] = true
+  end
+
+  opts.on("-p", "--properties=PROPERTIES", %q{set property (--properties="NAME=VALUE,NAME=VALUE" or -p "NAME=VALUE" -p "NAME=VALUE")}) do |properties|
+    options[:properties].concat(properties.split(/\s*,\s*/))
+  end
+
+  opts.on("-v", "--verbose", "verbose mode") do |verbose|
+    options[:verbose] = true
+  end
+
+  opts.on("--version", "Print version") do
     puts YamlMaster::VERSION
     exit
   end
-end
 
-options = opts.to_hash
-
-if options[:help]
-  puts opts
-  exit
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
 end
 
+opt_parser.parse!(ARGV)
+
 unless options[:master]
   puts "--master options is necessary"
-  puts opts
+  puts opt_parser
   exit 1
 end
 
-if options[:all].nil? && options[:key].nil?
-  puts "--all or --key is necessary"
-  puts opts
+if options[:all].nil? && options[:key].nil? && options[:dump].nil?
+  puts "--all or --key or --dump is necessary"
+  puts opt_parser
   exit 1
 end
 
-yaml_master = YamlMaster.new(options[:master], options[:properties] || [])
+yaml_master = YamlMaster.new(options[:master], options[:properties])
 
 if options[:all]
   yaml_master.generate_all(verbose: options[:verbose])
+elsif options[:dump]
+  result = yaml_master.dump(options[:output], {verbose: options[:verbose]})
+  puts result unless options[:output]
 else
   result = yaml_master.generate(options[:key], options[:output], {verbose: options[:verbose]})
   puts result unless options[:output]

data/lib/yaml_master.rb

@@ -3,11 +3,8 @@ require "yaml_master/version"
 require "yaml"
 require "erb"
 require "pathname"
-require "pp"
 
-YAML.add_domain_type(nil, "include") do |type, val|
-  YAML.load_file(val)
-end
+require "yaml_master/yaml_tree_builder"
 
 class YamlMaster
   class KeyFetchError < StandardError
@@ -15,36 +12,36 @@ class YamlMaster
       super("cannot fetch key \"#{key}\" from\n#{data.pretty_inspect}")
     end
   end
-  class PropertyParseError < StandardError; end
-
   attr_reader :master, :master_path, :properties
 
   def initialize(io_or_filename, property_strings = [])
-    parse_properties(property_strings)
+    case io_or_filename
+    when String
+      @master_path = Pathname(io_or_filename).expand_path
+    when File
+      @master_path = Pathname(io_or_filename.absolute_path)
+    end
 
-    embedded_methods_binding = EmbeddedMethods.new(self).get_binding
-    data =
-      if io_or_filename.is_a?(IO)
-        ERB.new(io_or_filename.read).result(embedded_methods_binding)
-      else
-        @master_path = File.expand_path(io_or_filename)
-        ERB.new(File.read(io_or_filename)).result(embedded_methods_binding)
-      end
+    @properties = PropertyParser.parse_properties(property_strings)
+    yaml = Context.new(master_path, @properties).render_master
+
+    parser = YAML::Parser.new
+    parser.handler = YamlMaster::YAMLTreeBuilder.new(@master_path, @properties, parser)
+    @tree = parser.parse(yaml).handler.root
+    @master = @tree.to_ruby[0]
 
-    @master = YAML.load(data)
     raise "yaml_master key is necessary on toplevel" unless @master["yaml_master"]
     raise "data key is necessary on toplevel" unless @master["data"]
   end
 
   def generate(key, output = nil, options = {})
-    puts "gen: #{output}" if options[:verbose]
     yaml = YAML.dump(fetch_data_from_master(key))
+    write_to_output(yaml, output, options[:verbose])
+  end
 
-    return yaml unless output
-
-    File.open(output, 'w') do |f|
-      f.write(yaml)
-    end
+  def dump(output = nil, options = {})
+    yaml = @tree.to_yaml
+    write_to_output(yaml, output, options[:verbose])
   end
 
   def generate_all(options = {})
@@ -76,30 +73,43 @@ class YamlMaster
     end
   end
 
-  def parse_properties(property_strings)
-    @properties = {}
-    if property_strings.is_a?(Hash)
-      @properties = property_strings
-    else
-      property_strings.each_with_object(@properties) do |str, hash|
-        key, value = str.split("=")
-        raise PropertyParseError.new("#{str} is invalid format") unless key && value
-        hash[key] = value
-      end
+  def write_to_output(yaml, output, verbose)
+    if output && verbose
+      puts <<~VERBOSE
+        gen: #{output}
+        #{yaml}
+      VERBOSE
     end
-  end
 
-  class EmbeddedMethods
-    def initialize(yaml_master)
-      @yaml_master = yaml_master
+    return yaml unless output
+
+    File.open(output, 'w') do |f|
+      f.write(yaml)
     end
+  end
+
+  module PropertyParser
+    class ParseError < StandardError; end
 
-    def master_path
-      Pathname(@yaml_master.master_path)
+    def self.parse_properties(property_strings_or_hash)
+      if property_strings_or_hash.is_a?(Hash)
+        property_strings_or_hash
+      else
+        property_strings_or_hash.each_with_object({}) do |str, hash|
+          key, value = str.split("=")
+          raise ParseError.new("#{str} is invalid format") unless key && value
+          hash[key] = value
+        end
+      end
     end
+  end
+
+  class Context
+    attr_reader :master_path, :properties
 
-    def properties
-      @yaml_master.properties
+    def initialize(master_path, properties)
+      @master_path = master_path
+      @properties = properties
     end
 
     def user_home
@@ -111,8 +121,8 @@ class YamlMaster
       File.read(path)
     end
 
-    def get_binding
-      binding
+    def render_master
+      ERB.new(File.read(@master_path)).result(binding)
     end
   end
 end

data/lib/yaml_master/version.rb

@@ -1,3 +1,3 @@
 class YamlMaster
-  VERSION = "0.4.2"
+  VERSION = "1.0.0.beta"
 end

data/lib/yaml_master/yaml_tree_builder.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: false
+require 'yaml'
+require 'pathname'
+
+class YamlMaster::YAMLTreeBuilder < YAML::TreeBuilder
+  def initialize(master_path, properties, parser)
+    super()
+    @master_path = master_path
+    @properties = properties
+    @parser = parser
+  end
+
+  def scalar(value, anchor, tag, plain, quoted, style)
+    case tag
+    when "!include"
+      ensure_tag_argument(tag, value)
+
+      path = Pathname(value)
+      path = path.absolute? ? path : @master_path.dirname.join(path)
+      tree = YAML.parse(File.read(path))
+      @last.children << tree.children[0]
+    when "!master_path"
+      s = build_scalar_node(@master_path.to_s)
+      @last.children << s
+      s
+    when "!user_home"
+      s = build_scalar_node(ENV["HOME"])
+      @last.children << s
+      s
+    when "!properties"
+      ensure_tag_argument(tag, value)
+
+      s = build_scalar_node(@properties[value])
+      @last.children << s
+      s
+    when "!env"
+      ensure_tag_argument(tag, value)
+
+      s = build_scalar_node(ENV[value])
+      @last.children << s
+      s
+    when "!read_file_if_exist"
+      ensure_tag_argument(tag, value)
+
+      path = Pathname(value)
+      path = path.absolute? ? path : @master_path.dirname.join(path)
+      content = path.file? && path.readable? ? File.read(path) : nil
+      s = build_scalar_node(content, false, true, 4)
+      @last.children << s
+      s
+    else
+      super
+    end
+  end
+
+  private
+
+  def ensure_tag_argument(tag, value)
+    if value.empty?
+      mark = @parser.mark
+      $stderr.puts "tag format error"
+      $stderr.puts "#{tag} requires 1 argument at #{mark.line}:#{mark.column}"
+      exit 1
+    end
+  end
+
+  def build_scalar_node(value, plain = true, quoted = true, style = 1)
+    if value
+      YAML::Nodes::Scalar.new(value, nil, nil, plain, quoted, style)
+    else
+      YAML::Nodes::Scalar.new("null", nil, nil, true, false, 1)
+    end
+  end
+end

data/yaml_master.gemspec

@@ -18,9 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "slop", "~> 3.6"
-
-  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "fakefs"

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: yaml_master
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 1.0.0.beta
 platform: ruby
 authors:
 - joker1007
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2017-09-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: slop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +77,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Dockerfile
 - Gemfile
 - README.md
 - Rakefile
@@ -99,6 +86,7 @@ files:
 - exe/yaml_master
 - lib/yaml_master.rb
 - lib/yaml_master/version.rb
+- lib/yaml_master/yaml_tree_builder.rb
 - yaml_master.gemspec
 homepage: https://github.com/joker1007/yaml_master
 licenses: []
@@ -114,12 +102,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Helper of YAML file generation from single master YAML file