krackle 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 935cd8156c0a62d0d94d393c2cba5441004c9af5
+  data.tar.gz: f2cac3c129115a7f6ed77ad772007865816dc7c1
+SHA512:
+  metadata.gz: 8b0ff6f60a1454ea79306cf1c08f7020903a54247fbfe3355e3858f6455278ed28eab0d0129f56a6757d5be5cce8db999b78bcdbdf911010219d84268ffe17e8
+  data.tar.gz: 476d9f5b5a511ef14e3a2d5c504bd847e9811f581ddee3675736486ae21cdb7c370c875865cb000d8127a25df5bfaef4769df9835b042a13bdf79a0d1edc6662

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brad Gessler
+
+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,79 @@
+# Krackle
+
+CLI for querying and flattening YAML data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'krackle'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install krackle
+
+## Usage
+
+You have a YAML file and want to pull a key or many out:
+
+```yaml
+first_name: Brad
+last_name: Gessler
+location:
+  state: CA
+  city: San Francisco
+  tax_brackets:
+    - high
+    - really high
+    - my eyes are bleeding high
+projects:
+  - name: Firehose.io
+    url: https://github.com/firehose/gem
+    contributors:
+      - Brad Gessler
+      - Zach Zolton
+  - name: Krackle
+    url: https://github.com/bradgessler/krackle
+    contributors:
+      - Brad Gessler
+      - Ronald McDonald
+      - first_name: Billy
+        last_name: Goat
+  - name: Nada
+```
+
+What do you do? Krackle it!
+
+```sh
+$ curl https://raw.githubusercontent.com/bradgessler/krackle/master/spec/fixtures/profile.yml > profile.yml
+$ cat profile.yml | krackle first_name
+Brad
+$ cat profile.yml | krackle location.state
+CA
+$ cat profile.yml | krackle location.tax_brackets[1]
+really high
+$ cat profile.yml | krackle projects[].contributors[0]
+Brad Gessler
+Brad Gessler
+$ cat profile.yml | krackle projects[0].contributors[]
+Brad Gessler
+Zach Zolton
+$ cat profile.yml | krackle projects[0].contributors[0]
+Brad Gessler
+```
+
+Now you can query deep into YAML without cracking open a Ruby session.
+
+## Contributing
+
+1. Fork it ( https://github.com/bradgessler/krackle/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,2 @@
+require "bundler/gem_tasks"
+

data/bin/krackle

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/krackle'
+
+puts Krackle::CLI.new.run

data/krackle.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'krackle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "krackle"
+  spec.version       = Krackle::VERSION
+  spec.authors       = ["Brad Gessler"]
+  spec.email         = ["bradgessler@gmail.com"]
+  spec.summary       = %q{Query semi-structure data from the command line.}
+  spec.homepage      = "https://github.com/bradgessler/krackle"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+end

data/lib/krackle.rb

@@ -0,0 +1,78 @@
+require "krackle/version"
+require "yaml"
+
+module Krackle
+  class Engine
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def query(expression)
+      Parser.new(Tokenizer.new(expression).tokenize).parse(@hash)
+    end
+  end
+
+  class Tokenizer
+    def initialize(str)
+      @str = str
+    end
+
+    def tokenize
+      scanner = StringScanner.new(@str)
+      tokens = []
+      until scanner.empty?
+        case 
+          when match = scanner.scan(/\[(\d+)?\]/)
+            tokens << [:COLLECTION, (scanner[1] ? scanner[1].to_i : nil)]
+          when match =scanner.scan(/\.?(\w+)/)
+            tokens << [:KEY, scanner[1]]
+          else
+            raise "Say what? <#{scanner.peek(10).inspect}> at pos #{scanner.pos}"
+          end
+      end
+      tokens
+    end
+  end
+
+  class Parser
+    def initialize(tokens)
+      @tokens = tokens
+    end
+
+    def parse(hash)
+      nodes = Array[hash]
+      # p tokenize
+
+      @tokens.each do |(token, value)|
+        # p [token, value], nodes, "-"*30
+        case token
+        when :KEY
+          nodes = nodes.map{ |node| node[value] }.compact
+        when :COLLECTION
+          if value
+            nodes = nodes.map{ |node| node[value] }.compact
+          else
+            nodes = nodes.flatten.compact
+          end
+        end
+      end
+
+      nodes
+    end
+  end
+
+  class CLI
+    def initialize(args=ARGV)
+      @expression, @path = args
+    end
+
+    def run
+      io = if @path
+        File.open(@path, 'r')
+      else
+        $stdin.tty? ? raise("Specify a file path") : $stdin
+      end
+      Engine.new(YAML.load(io.read)).query(@expression).join("\n")
+    end
+  end
+end

data/lib/krackle/version.rb

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

data/spec/fixtures/profile.yml

@@ -0,0 +1,23 @@
+first_name: Brad
+last_name: Gessler
+location:
+  state: CA
+  city: San Francisco
+  tax_brackets:
+    - high
+    - really high
+    - my eyes are bleeding high
+projects:
+  - name: Firehose.io
+    url: https://github.com/firehose/gem
+    contributors:
+      - Brad Gessler
+      - Zach Zolton
+  - name: Krackle
+    url: https://github.com/bradgessler/krackle
+    contributors:
+      - Brad Gessler
+      - Ronald McDonald
+      - first_name: Billy
+        last_name: Goat
+  - name: Nada

data/spec/lib/krackle_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'yaml'
+
+describe Krackle::Engine do
+  subject { Krackle::Engine.new(hash) }
+  let(:hash) { YAML.load_file('./spec/fixtures/profile.yml') }
+
+  context "queries" do
+    it "values from a list" do
+      expect(subject.query("projects[].name")).to eql(%w[Firehose.io Krackle Nada])
+    end
+
+    it "item in a list in a list" do
+      expect(subject.query("projects[].contributors[].last_name")).to eql(["Goat"])
+    end
+
+    it "nth item in a list in a list" do
+      expect(subject.query("projects[].contributors[0]")).to eql(["Brad Gessler", "Brad Gessler"])
+    end
+
+    it "nth item in an nth list in an nth list" do
+      expect(subject.query("projects[0].contributors[0]")).to eql(["Brad Gessler"])
+    end
+
+    it "list" do
+      expect(subject.query("projects[]").size).to eql(3)
+    end
+
+    it "key" do
+      expect(subject.query("first_name")).to eql(["Brad"])
+    end
+
+    it "deep key" do
+      expect(subject.query("location.state")).to eql(["CA"])
+    end
+
+    it "deep key list nth item" do
+      expect(subject.query("location.tax_brackets[1]")).to eql(["really high"])
+    end
+  end
+end
+
+describe Krackle::CLI do
+  it "parses cli" do
+    expect(Krackle::CLI.new(["projects[].contributors[0]", "spec/fixtures/profile.yml"]).run).to eql("Brad Gessler\nBrad Gessler")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+require "krackle"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: krackle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brad Gessler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 
+email:
+- bradgessler@gmail.com
+executables:
+- krackle
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/krackle
+- krackle.gemspec
+- lib/krackle.rb
+- lib/krackle/version.rb
+- spec/fixtures/profile.yml
+- spec/lib/krackle_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bradgessler/krackle
+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.5
+signing_key: 
+specification_version: 4
+summary: Query semi-structure data from the command line.
+test_files:
+- spec/fixtures/profile.yml
+- spec/lib/krackle_spec.rb
+- spec/spec_helper.rb