yamlquery 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd72fe86b03a3a1318464ca2693bfe3fa44c4ed6
+  data.tar.gz: 6335a0dfdacde846eb7ef63cd0a4e33398f46eb6
+SHA512:
+  metadata.gz: a9f7984a2933153d9dd38c673da27bfb83fe86da2f2b1127ada40629e99205ae2c64243021e6e6727a78ab0eabaae766b27af541d4ce67258f168fd5bdbeeb96
+  data.tar.gz: 96c6eca597f41aefd52fa5bd7e41165585cfaf8495dd11b6deee7c845b7d49a1de7e2e33733f3ae26563d3a7e98252cc28fe6585db206a25342f9687192c391b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nick B
+
+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,33 @@
+# Yamlquery
+
+Searches yaml files for keys and values using a simple query language. This was developed with the intention of managing puppet hiera files.
+
+## Examples
+
+```bash
+# yq -y -p ../examples/example.yaml 'foo.funk==head'
+---
+foo:
+  funk:
+  - head
+  - shoulders
+```
+
+## Installation
+
+    $ gem install yamlquery
+
+## Usage
+
+TODO: Write usage instructions here
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nburgess/yamlquery.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "yamlquery"
+
+# 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 "pry"
+Pry.start

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/bin/yq

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'psych'
+require 'yamlquery'
+
+options = YamlQuery::Settings.get_options
+
+Dir.glob(options[:yamlpath]).each do |file|
+  if File.file?(file)
+    if yaml = Psych.load_file(file)
+      yq = YamlQuery.new(yaml, options)
+      results = yq.object_search
+      if ! results.empty?
+        YamlQuery::Output.display_results(file, results, options)
+      end
+    end
+  end
+end

data/examples/example.yaml

@@ -0,0 +1,8 @@
+---
+foo:
+  bar:
+  - baz
+  table: vinny
+  funk:
+  - head
+  - shoulders

data/lib/yamlquery/output.rb

@@ -0,0 +1,32 @@
+class YamlQuery::Output
+  def flatten_results
+    # TODO
+  end
+
+  def self.display_results(file, results, options)
+    puts file
+    if options[:onlyfile?]
+    elsif options[:depth]
+      gather_keys(results, options[:depth])
+    elsif options[:yaml?]
+      puts Psych.dump(results)
+      puts
+    elsif options[:oneline?]
+      p results
+      puts
+    else
+      pp results
+      puts
+    end
+  end
+
+  def self.gather_keys(results, depth, index = 1)
+    if index == depth.to_i
+      puts results.keys
+    else
+      results.each do |k, v|
+        gather_keys(v, depth, index + 1) if v.is_a?(Hash)
+      end
+    end
+  end
+end

data/lib/yamlquery/parser.rb

@@ -0,0 +1,28 @@
+require 'parslet'
+
+class YamlQuery::Parser < Parslet::Parser
+  def initialize(delimiter)
+    @delimiter = delimiter
+  end
+  rule(:key) { match("[^\s#{@delimiter}!<>&= ]").repeat(1) >> space? }
+
+  rule(:space) { match('\s').repeat(1) }
+  rule(:space?) { space.maybe }
+
+  rule(:delimiter) { match("\\#{@delimiter}") >> space? }
+  rule(:delimiter?) { delimiter.maybe >> space? }
+
+  rule(:operator) { match('[&!=><]') >> match('=').maybe >> space? }
+  rule(:argument) { match('.').repeat(1) }
+  rule(:argument?) { argument.maybe }
+
+  rule(:keypath) { key.as(:key) >> delimiter? }
+  rule(:expression) { operator.as(:operator) >> argument?.as(:arg) }
+  rule(:expression?) { expression.maybe }
+  rule(:rooty) { keypath.repeat(1).as(:keys) >> expression? }
+  root(:rooty)
+end
+
+class YamlQuery::Transform < Parslet::Transform
+  rule(:key => simple(:x)) { String(x) }
+end

data/lib/yamlquery/settings.rb

@@ -0,0 +1,71 @@
+require 'optparse'
+require 'psych'
+
+class YamlQuery::Settings
+  @options = {}
+
+  attr_reader :options
+
+  def self.get_options
+    get_rc
+    set_default
+    get_flags
+    @options
+  end
+
+  private 
+
+  def self.get_flags
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: yq [options] "yaml.path.to.parameter"'
+
+      opts.on('-h', '--help', 'Prints this help') do
+        puts opts
+        exit
+      end
+
+      opts.on('-y', '--yaml', "Generate output as yaml") do
+        @options[:yaml?] = true
+      end
+
+      opts.on('-d', '--depth DEPTH', 'Only return keys from DEPTH in output') do |depth|
+        @options[:depth] = depth
+      end
+
+      opts.on('-p', '--yamlpath PATH', 'Path to yaml files', String) do |path|
+        @options[:yamlpath] = path
+      end
+
+      opts.on('-f', '--onlyfile', 'Only list file names that match') do
+        @options[:onlyfile?] = true
+      end
+
+      opts.on('-1', '--oneline', 'Matches will be displayed in oneline mode') do
+        @options[:oneline?] = true
+      end
+
+      opts.on('--debug', 'Prints some extra output helpful for debugging') do
+        @options[:debug] = true
+      end
+    end.parse!
+
+    if ARGV.empty?
+      puts 'Query string is required.'
+      exit 1
+    else
+      @options[:query] = ARGV[0]
+    end
+  end
+
+  def self.get_rc
+    yqrc_path = "#{ENV['HOME']}/.yqrc.yaml"
+    if File.exist?(yqrc_path)
+      @options = Psych.load_file(yqrc_path)
+    end
+  end
+
+  def self.set_default
+    @options[:delimiter] = '.'
+  end
+
+end

data/lib/yamlquery/version.rb

@@ -0,0 +1,3 @@
+class YamlQuery
+  VERSION = '0.0.1'
+end

data/lib/yamlquery.rb

@@ -0,0 +1,110 @@
+class YamlQuery
+  def initialize(object, options)
+    @object   = object
+    @options = options
+    tree = parse(@options)
+    yqt = YamlQuery::Transform.new
+    parsed_query = yqt.apply(tree)
+    if options[:debug]
+      pp parsed_query
+    end
+    @keys     = parsed_query[:keys]
+    @operator = parsed_query[:operator].to_s
+    @arg      = parsed_query[:arg].to_s
+  end
+
+  def object_search(object = @object, index = 0)
+    result_hash = {}
+    object.each do |k, v|
+      if @keys[index] == k or @keys[index] == '*'
+        if @keys.length == index + 1
+          result_hash[k] = v if compare(v)
+        elsif v.is_a?(Hash)
+          result_hash[k] = object_search(v, index + 1)
+          result_hash.delete(k) if result_hash[k].empty?
+        end
+        # A key shouldn't show up more than once, so we can return
+        # as soon as we find a match if we aren't matching a wildcard.
+        return result_hash unless @keys[index] == '*'
+      end
+    end
+    return result_hash
+  end
+
+  private
+
+  def parse(options)
+    yqp = YamlQuery::Parser.new(options[:delimiter])
+    yqp.parse(options[:query])
+  rescue Parslet::ParseFailed => failure
+    puts failure.cause.ascii_tree
+  end
+
+  def compare(value)
+    case @operator
+    when ''
+      return true
+    when '=='
+      equal?(value)
+    when '!='
+      notequal?(value)
+    when '!'
+      nil?(value)
+    when '>='
+      ge?(value)
+    when '<='
+      le?(value)
+    when '<'
+      lt?(value)
+    when '>'
+      gt?(value)
+    end
+  end
+
+  def assign
+    # not yet implemented
+  end
+
+  def ge?(value)
+    value >= @arg
+  end
+
+  def le?(value)
+    value <= @arg
+  end
+
+  def lt?(value)
+    value < @arg
+  end
+
+  def gt?(value)
+    value > @arg
+  end
+
+  def equal?(value)
+    case value
+    when Array, Hash
+      value.include?(@arg)
+    else
+      value == @arg
+    end
+  end
+
+  def notequal?(value)
+    value != @arg
+  end
+
+  def nil?(value)
+    case value
+    when Array, Hash
+      value.empty?
+    else
+      value.nil?
+    end
+  end
+end
+
+require 'yamlquery/parser'
+require 'yamlquery/settings'
+require 'yamlquery/output'
+require 'pp'

data/yamlquery.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yamlquery/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yamlquery"
+  spec.version       = YamlQuery::VERSION
+  spec.authors       = ["Nicholas Burgess"]
+  spec.email         = ["nburgess@uchicago.edu"]
+
+  spec.summary          = 'YamlQuery helps you search yaml files.'
+  spec.description      = 'Search and set values in multiple yaml files. This is particularly useful for wrangling data in puppetlabs hiera.'
+  spec.homepage      = "http://github.com/nburg/yamlquery"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", '~> 0.10.4'
+ 
+  spec.add_runtime_dependency "parslet", '~> 1.7.1'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: yamlquery
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nicholas Burgess
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+description: Search and set values in multiple yaml files. This is particularly useful
+  for wrangling data in puppetlabs hiera.
+email:
+- nburgess@uchicago.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/yq
+- examples/example.yaml
+- lib/yamlquery.rb
+- lib/yamlquery/output.rb
+- lib/yamlquery/parser.rb
+- lib/yamlquery/settings.rb
+- lib/yamlquery/version.rb
+- yamlquery.gemspec
+homepage: http://github.com/nburg/yamlquery
+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.5.1
+signing_key: 
+specification_version: 4
+summary: YamlQuery helps you search yaml files.
+test_files: []