psych-inherit-file 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25d5eb1755ecc9f5d1b41cc5ff86586ad0817bd5
+  data.tar.gz: 4d35bf4df0a7e02f512d9720dc74ef6069ff6667
+SHA512:
+  metadata.gz: b06a918686d7c2985448d34fdc7b6e38cf7cd8f176dee755f8c9fb2b5956690e8f37da3dfc7359247596d3b59e44eceac8bf316929bdd5e2e1916b34acb87f19
+  data.tar.gz: eec6250d475d7aab374dce572c41cdd39afe7e78b0bb462834303041269ae428784146958f63a0febaf9359861e4ea759d797e2ad33e137af59aaf21a87d46ef

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Florian Gilcher
+
+MIT License
+
+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,59 @@
+# Psych::Inherit::File
+
+A psych handler and parser that allows inherit other files within YAML files.
+
+It is an extraction from [elasticsearch-rake-tasks](http://github.com/asquera/elasticsearch-rake-tasks).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'psych-require-file'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install psych-require-file
+
+## Usage
+
+Just use the `Parser` class instead of your YAML parser:
+
+```ruby
+parser = Psych::Inherit::File::Parser.new
+parser.parse_file('myfile.yaml')
+```
+
+This parser allows you to include the following tag in your YAML:
+
+```yaml
+# bar.yml
+---
+name: &string_analyzed
+  type: string
+```
+
+```
+# foo.yml
+properties:
+  inherit: !file "bar.yml"
+  surname: *string_analyzed
+```
+
+This allows you to share definitions between files. The "inherit" node will be replaced by inherited file.
+
+## Contributors
+
+* [Sebastian Ziebell](http://github.com/zebel) (original implementation)
+* [Florian Gilcher](http://github.com/skade) (extraction)
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/lib/psych/inherit/file.rb

@@ -0,0 +1,11 @@
+require "psych/inherit/file/version"
+require "psych/inherit/file/handler"
+require "psych/inherit/file/parser"
+
+module Psych
+  module Require
+    module File
+      # Your code goes here...
+    end
+  end
+end

data/lib/psych/inherit/file/handler.rb

@@ -0,0 +1,51 @@
+require "psych"
+
+module Psych
+  module Inherit
+    module File
+      class Handler < Psych::TreeBuilder
+        TAG_NAME = '!file'
+        NODE_NAME = 'inherit'
+
+        attr_reader :reader
+
+        def initialize(reader)
+          @reader = reader
+          super()
+        end
+
+        def document
+          root.children.first
+        end
+
+        def last_node
+          @last.children.last
+        end
+
+        def include_node?(node)
+          node.respond_to?(:value) && node.value == NODE_NAME
+        end
+
+        def scalar(value, anchor, tag, plain, quoted, style)
+          if tag == TAG_NAME && include_node?(last_node)
+            pop_previous_node
+
+            nodes = @stack.last.children
+            content = reader.parse_file(value).children.first
+            nodes << content
+            push content
+          else
+            super
+          end
+        end
+
+        private
+
+        def pop_previous_node
+          @stack.pop
+          @stack.last.children.pop
+        end
+      end
+    end
+  end
+end

data/lib/psych/inherit/file/parser.rb

@@ -0,0 +1,25 @@
+require 'ostruct'
+
+module Psych
+  module Inherit
+    module File
+      class Parser
+        def load_file(file)
+          parse_file(file).to_ruby
+        end
+
+        def parse_file(file)
+          parse(::File.read(file))
+        rescue StandardError => e
+          # STDOUT.puts "Error while reading file #{file}: #{e}"
+          raise e
+        end
+
+        def parse(content)
+          parser = Psych::Parser.new(File::Handler.new(self))
+          parser.parse(content).handler.document
+        end
+      end
+    end
+  end
+end

data/lib/psych/inherit/file/version.rb

@@ -0,0 +1,7 @@
+module Psych
+  module Inherit
+    module File
+      VERSION = "1.0.0"
+    end
+  end
+end

data/lib/psych/require/file/version.rb

@@ -0,0 +1,7 @@
+module Psych
+  module Require
+    module File
+      VERSION = "0.0.1"
+    end
+  end
+end

data/psych-require-file.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'psych/inherit/file/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "psych-inherit-file"
+  spec.version       = Psych::Inherit::File::VERSION
+  spec.authors       = ["Sebastian Ziebell", "Florian Gilcher"]
+  spec.email         = ["sebastian.ziebell@asquera.de", "florian.gilcher@asquera.de"]
+  spec.description   = %q{A handler for Psych that allows you to inhert other YAML files,
+for example to share certain repetitive definitions.}
+  spec.summary       = %q{A handler for Psych allowing you to inherit other files.}
+  spec.homepage      = "http://github.com/asquera/psych-inherit-file"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/examples/include/mappings/alias.yml

@@ -0,0 +1,4 @@
+---
+properties:
+  inherit: !file "bar.yml"
+  surname: *string_analyzed

data/spec/examples/include/mappings/bar.yml

@@ -0,0 +1,3 @@
+---
+name: &string_analyzed
+  type: string

data/spec/examples/simple/mappings/bar.yml

@@ -0,0 +1,6 @@
+---
+properties:
+  inherit: !file "foo.yml"
+  name:
+    type: string
+    analyzer: foo_analyzer

data/spec/examples/simple/mappings/foo.yml

@@ -0,0 +1,4 @@
+---
+title:
+  type: string
+  analyzer: foo_analyzer

data/spec/examples/simple/settings.yaml

@@ -0,0 +1,8 @@
+---
+index:
+  analysis:
+    analyzer:
+      foo_analyzer:
+        filter:
+          - standard
+          - lowercase

data/spec/examples/simple/template_pattern

@@ -0,0 +1 @@
+foo

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'psych/inherit/file'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end
+
+def examples_root
+  templates = "examples"
+  @root ||= File.join(File.dirname(__FILE__), templates)
+end

data/spec/yaml_parser_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+describe Psych::Inherit::File::Parser do
+  let(:parser){ described_class.new }
+
+  def mapping_folder(template)
+    "#{examples_root}/#{template}/mappings"
+  end
+
+  describe "#parse_yaml_content" do
+    subject{ parser.parse(yaml) }
+    context "without an inherit value" do
+      let(:yaml){ "---\nfoo:\n  bar: !file \"test.yml\"" }
+
+      it "does not load external file" do
+        described_class.should_not_receive(:parse_file)
+        subject.to_ruby
+      end
+
+      it "parses correctly" do
+        subject.to_ruby.should == {
+          'foo' => { 'bar' => 'test.yml' }
+        }
+      end
+    end
+
+    context "without a !file tag" do
+      let(:yaml){ "---\nfoo:\n  inherit: \"bar.yml\"" }
+
+      it "does not load external file" do
+        described_class.should_not_receive(:parse_file)
+        subject.to_ruby
+      end
+
+      it "parses correctly" do
+        subject.to_ruby.should == {
+          'foo' => { 'inherit' => 'bar.yml' }
+        }
+      end
+    end
+
+    context "with distant properties" do
+      let(:yaml){ "---\nfoo:\n  inherit:\n    foo: !file \"bar.yml\"" }
+
+      it "does not load external file" do
+        described_class.should_not_receive(:parse_file)
+        subject.to_ruby
+      end
+
+      it "parses correctly" do
+        subject.to_ruby.should == {
+          'foo' => { 'inherit' => { 'foo' => 'bar.yml' } }
+        }
+      end
+    end
+  end
+
+  describe "#load_file" do
+    subject do
+      Dir.chdir(dir) do
+        parser.load_file(yaml)
+      end
+    end
+
+    context "missing file" do
+      let(:dir){ mapping_folder("simple") }
+      let(:yaml){ "#{dir}/unknow.yml" }
+
+      it "raises an error" do
+        expect{ subject }.to raise_error
+      end
+    end
+
+    context "simple template" do
+      let(:dir){ mapping_folder("simple") }
+      let(:yaml){ "#{dir}/foo.yml" }
+
+      it "does not raise error" do
+        expect{ subject }.not_to raise_error
+      end
+
+      it "matches hash" do
+        subject.should == {
+          'title' => {
+            'type'     => 'string',
+            'analyzer' => 'foo_analyzer'
+          }
+        }
+      end
+    end
+
+    context "template with file include" do
+      let(:dir){ mapping_folder("simple") }
+      let(:yaml){ "#{dir}/bar.yml" }
+
+      it "does not raise error" do
+        expect{ subject }.not_to raise_error
+      end
+
+      it "matches hash" do
+        subject.should == {
+          'properties' => {
+            'title' => {
+              'type'     => 'string',
+              'analyzer' => 'foo_analyzer'
+            },
+            'name' => {
+              'type'     => 'string',
+              'analyzer' => 'foo_analyzer'
+            }
+          }
+        }
+      end
+    end
+
+    context "template with external alias" do
+      let(:dir){ mapping_folder("include") }
+      let(:yaml){ "#{dir}/alias.yml" }
+
+      it "does not raise error" do
+        expect{ subject }.not_to raise_error
+      end
+
+      it "matches hash" do
+        subject.should == {
+          'properties' => {
+            'name'    => { 'type' => 'string' },
+            'surname' => { 'type' => 'string' }
+          }
+        }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: psych-inherit-file
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sebastian Ziebell
+- Florian Gilcher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  A handler for Psych that allows you to inhert other YAML files,
+  for example to share certain repetitive definitions.
+email:
+- sebastian.ziebell@asquera.de
+- florian.gilcher@asquera.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/psych/inherit/file.rb
+- lib/psych/inherit/file/handler.rb
+- lib/psych/inherit/file/parser.rb
+- lib/psych/inherit/file/version.rb
+- lib/psych/require/file/version.rb
+- psych-require-file.gemspec
+- spec/examples/include/mappings/alias.yml
+- spec/examples/include/mappings/bar.yml
+- spec/examples/include/settings.yaml
+- spec/examples/simple/mappings/bar.yml
+- spec/examples/simple/mappings/foo.yml
+- spec/examples/simple/settings.yaml
+- spec/examples/simple/template_pattern
+- spec/spec_helper.rb
+- spec/yaml_parser_spec.rb
+homepage: http://github.com/asquera/psych-inherit-file
+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.0.14
+signing_key: 
+specification_version: 4
+summary: A handler for Psych allowing you to inherit other files.
+test_files:
+- spec/examples/include/mappings/alias.yml
+- spec/examples/include/mappings/bar.yml
+- spec/examples/include/settings.yaml
+- spec/examples/simple/mappings/bar.yml
+- spec/examples/simple/mappings/foo.yml
+- spec/examples/simple/settings.yaml
+- spec/examples/simple/template_pattern
+- spec/spec_helper.rb
+- spec/yaml_parser_spec.rb
+has_rdoc: