structure_digest 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8184011e1799c2b33e1341e3dad068f0aabd094c
+  data.tar.gz: ba65e85584a22cbc2efac85705e0de0b6eb1b262
+SHA512:
+  metadata.gz: 0360f22b4bf9d8febe85219c0a0650c61538a20c8785e3746b63f2136a9cc278589c7729c65c291305f9b4330eea62058dda7d5e2e6f6fafe9384161e51d0852
+  data.tar.gz: b4ad1f41ef59909ece4e1de10af1e951f16337270d5be9818509fcf0e12e2051a449b90cd115266c46d45127e79beeffed115270d02fbe5ba2b21f6188334629

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/.ruby-gemset

@@ -0,0 +1 @@
+structure_digest

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mike Grafton and Sara Tansey
+
+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,85 @@
+# StructureDigest
+
+Run the binary with one or more YAML files to find out what it does
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'structure_digest'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install structure_digest
+
+## Usage
+
+Given a sample YAML document from Wikipedia:
+
+    ---
+    receipt:     Oz-Ware Purchase Invoice
+    date:        2012-08-06
+    customer:
+        given:   Dorothy
+        family:  Gale
+
+    items:
+        - part_no:   A4786
+          descrip:   Water Bucket (Filled)
+          price:     1.47
+          quantity:  4
+
+        - part_no:   E1628
+          descrip:   High Heeled "Ruby" Slippers
+          size:      8
+          price:     100.27
+          quantity:  1
+
+    bill-to:  &id001
+        street: |
+                123 Tornado Alley
+                Suite 16
+        city:   East Centerville
+        state:  KS
+
+    ship-to:  *id001
+
+    specialDelivery:  >
+        Follow the Yellow Brick
+        Road to the Emerald City.
+        Pay no attention to the
+        man behind the curtain.
+
+`structure_digest example.yml` will produce:
+
+    .receipt
+    .date
+    .customer.given
+    .customer.family
+    .items[].part_no
+    .items[].descrip
+    .items[].price
+    .items[].quantity
+    .items[].size
+    .bill-to.street
+    .bill-to.city
+    .bill-to.state
+    .ship-to.street
+    .ship-to.city
+    .ship-to.state
+    .specialDelivery
+
+## Contributing
+
+Could use a shorter name maybe
+
+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 @@
+require "bundler/gem_tasks"

data/bin/structure_digest

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+$LOAD_PATH << File.join(File.dirname(__FILE__), '../lib/')
+require 'structure_digest'
+require 'tempfile'
+
+require 'optparse'
+ARGV << "--help" if ARGV.empty? && STDIN.tty?
+tree = false
+
+opt = OptionParser.new do |opt|
+  opt.banner = "Usage: structure_digest [options] File1[, File2, ...]"
+  opt.on('-t', '--tree', 'replace repeated suffixes with indents') { tree = true }
+end
+
+opt.parse!
+
+files = ARGV
+file = Tempfile.new('structure_digest_in')
+if !STDIN.tty?
+  file.write STDIN.read
+  files += [file.path]
+  file.rewind
+end
+
+$h = StructureDigest::Digest.new(tree: tree).injest_yml_files(files)
+print $h.shorthand
+
+file.close!
+

data/lib/structure_digest/abstract_array_dereference.rb

@@ -0,0 +1,16 @@
+module StructureDigest
+  module SchemaParts
+    class AbstractArrayDereference
+      def ==(other)
+        self.class == other.class
+      end
+
+      def serialize
+        "[]"
+      end
+
+      alias :eql? :==
+      def hash; [].hash; end
+    end
+  end
+end

data/lib/structure_digest/abstract_path.rb

@@ -0,0 +1,45 @@
+module StructureDigest
+  module SchemaParts
+    class AbstractPath
+      def initialize(abstract_parts)
+        @parts = abstract_parts
+      end
+
+      def serialize
+        @parts.map(&:serialize).join
+      end
+
+      def accepts(path)
+        self == path.abstract
+      end
+
+      def add_part(part)
+        AbstractPath.new(@parts + [part])
+      end
+
+      def self.from_shorthand(shorthand)
+        shorthand = orig_shorthand.clone
+        abstract_path = AbstractPath.new
+        while !shorthand.empty?
+          if key = shorthand[/^\.(\w+)/, 1]
+            abstract_path = abstract_path.add_part(HashDereference.new(key))
+            shorthand.sub!(/^\.\w+/, '')
+          elsif shorthand[/^\[\]/]
+            abstract_path = abstract_path.add_part(AbstractArrayDereference.new)
+            shorthand.sub!("[]", '')
+          else
+            raise "shorthand #{shorthand} isn't a valid path shorthand"
+          end
+        end
+        abstract_path
+      end
+
+      attr_reader :parts
+      def ==(other)
+        self.class == other.class && @parts == other.parts
+      end
+      alias :eql? :==
+      def hash; [@parts].hash; end
+    end
+  end
+end

data/lib/structure_digest/array_dereference.rb

@@ -0,0 +1,20 @@
+module StructureDigest
+  module SchemaParts
+    class ArrayDereference
+      attr_reader :index
+      def initialize(index)
+        @index = index
+      end
+
+      def ==(other)
+        self.class == other.class && @index == other.index
+      end
+
+      alias :eql? :==
+      def hash; [@index].hash; end
+      def abstract
+        AbstractArrayDereference.new
+      end
+    end
+  end
+end

data/lib/structure_digest/digest.rb

@@ -0,0 +1,104 @@
+require 'yaml'
+
+module StructureDigest
+  class Digest
+    def initialize(opts={})
+      @tree = opts[:tree] || false
+    end
+
+    def injest_yml_files(file_paths)
+      file_paths.each do |p|
+        y = YAML.load_file(p)
+        gather_paths(y, paths)
+      end
+      @abstract_paths = paths.map(&:abstract).uniq
+      self
+    end
+
+    def add_validation(shorthand, &validateFn)
+      raise "isn't applicable for core paths of schema" unless @abstract_paths.include? SchemaParts::AbstractPath.from_shorthand(shorthand)
+      validators[shorthand] ||= []
+      validators[shorthand] << validateFn
+    end
+
+    def validate(hash)
+      paths = []
+      gather_paths(hash, paths)
+      paths.all? do |p|
+        print '.'
+        @abstract_paths.any?{|my_p| my_p.accepts(p) } && validators_for(p).all?{|v| v.call(p.last[:value]) }
+      end.tap do
+        puts
+      end
+    end
+
+    def validators_for(p)
+      validators[p.abstract.serialize] || []
+    end
+
+    def shorthand
+      if @tree
+        root = {}
+        @abstract_paths.each do |apath|
+          append_to_tree(root, apath.parts)
+        end
+        sio = StringIO.new
+        pretty_print(sio, root)
+        sio.rewind
+        sio.read.chomp
+      else
+        @abstract_paths.map(&:serialize).uniq.sort.join("\n")
+      end
+    end
+
+    def pretty_print(io, tree, level=0)
+      tree.keys.sort.each do |k|
+        v = tree[k]
+        io << '  '*level + k
+        if v.keys.empty?
+          io << "\n"
+        elsif v.keys.size == 1
+          pretty_print(io, v, level)
+        else
+          io << "\n"
+          pretty_print(io, v, level+1)
+        end
+      end
+    end
+
+    def append_to_tree(tree, parts)
+      return if parts.empty?
+      append_to_tree(tree[parts.first.serialize] || (tree[parts.first.serialize] = {}), parts.drop(1))
+    end
+
+    private
+
+    def paths
+      @paths ||= []
+    end
+
+    def validators
+      @validators ||= {}
+      @validators
+    end
+
+    def gather_paths(node, solutions=[], partial_solution=SchemaParts::Path.new)
+      if Array === node
+        node.each.with_index do |e, i|
+          gather_paths(e, solutions, partial_solution.add_part(SchemaParts::ArrayDereference.new(i)))
+        end
+      elsif Hash === node
+        node.each do |k,v|
+          gather_paths(v, solutions, partial_solution.add_part(SchemaParts::HashDereference.new(k)))
+        end
+      else
+        solutions << (partial_solution.add_part(SchemaParts::Value.new(node)))
+      end
+      self
+    end
+
+    def deserialize(orig_shorthand)
+      SchemaParts::AbstractPath.from_shorthand(orig_shorthand)
+    end
+  end
+end

data/lib/structure_digest/hash_dereference.rb

@@ -0,0 +1,23 @@
+module StructureDigest
+  module SchemaParts
+    class HashDereference
+      def initialize(key)
+        @key = key
+      end
+
+      def serialize
+        ".#{key}"
+      end
+
+      def abstract
+        self
+      end
+      attr_reader :key
+      def ==(other)
+        self.class == other.class && @key == other.key
+      end
+      alias :eql? :==
+      def hash; [@key].hash; end
+    end
+  end
+end

data/lib/structure_digest/path.rb

@@ -0,0 +1,24 @@
+module StructureDigest
+  module SchemaParts
+    class Path
+      def initialize(parts=[])
+        @parts = parts
+      end
+
+      def abstract
+        AbstractPath.new(@parts.map(&:abstract).compact)
+      end
+
+      def add_part(part)
+        Path.new(@parts + [part])
+      end
+
+      attr_reader :parts
+      def ==(other)
+        self.class == other.class && @parts == other.parts
+      end
+      alias :eql? :==
+      def hash; [@parts].hash; end
+    end
+  end
+end

data/lib/structure_digest/value.rb

@@ -0,0 +1,20 @@
+module StructureDigest
+  module SchemaParts
+    class Value
+      def initialize(val)
+        @value = val
+      end
+
+      def abstract
+        nil
+      end
+
+      attr_reader :value
+      def ==(other)
+        self.class == other.class && @value == other.value
+      end
+      alias :eql? :==
+      def hash; [@value].hash; end
+    end
+  end
+end

data/lib/structure_digest/version.rb

@@ -0,0 +1,3 @@
+module StructureDigest
+  VERSION = "0.2.0"
+end

data/lib/structure_digest.rb

@@ -0,0 +1 @@
+Dir[File.dirname(__FILE__) + "/**/*.rb"].each(&method(:require))

data/sandbox/Gemfile

@@ -0,0 +1,2 @@
+gem 'pry'
+gem 'structure_digest', path: '../'

data/spec/fixtures/sample.json

@@ -0,0 +1,21 @@
+{
+  "firstName": "John",
+  "lastName": "Smith",
+  "age": 25,
+  "address": {
+    "streetAddress": "21 2nd Street",
+    "city": "New York",
+    "state": "NY",
+    "postalCode": 10021
+  },
+  "phoneNumbers": [
+    {
+      "type": "home",
+      "number": "212 555-1234"
+    },
+    {
+      "type": "fax",
+      "number": "646 555-4567"
+    }
+  ]
+}

data/spec/fixtures/sample.yml

@@ -0,0 +1,44 @@
+---
+receipt:     Oz-Ware Purchase Invoice
+date:        2012-08-06
+customer:
+    given:   Dorothy
+    family:  Gale
+
+problem:
+    return: true
+
+recursive:
+    problem:
+      que: 'what'
+      ans: 'who'
+    problem2:
+      que: 'a'
+      ans: 'b'
+
+items:
+    - part_no:   A4786
+      descrip:   Water Bucket (Filled)
+      price:     1.47
+      quantity:  4
+
+    - part_no:   E1628
+      descrip:   High Heeled "Ruby" Slippers
+      size:      8
+      price:     100.27
+      quantity:  1
+
+bill-to:  &id001
+    street: |
+            123 Tornado Alley
+            Suite 16
+    city:   East Centerville
+    state:  KS
+
+ship-to:  *id001
+
+specialDelivery:  >
+    Follow the Yellow Brick
+    Road to the Emerald City.
+    Pay no attention to the
+    man behind the curtain.

data/spec/integration_spec.rb

@@ -0,0 +1,68 @@
+lib_path = File.join(File.dirname(__FILE__), '../lib/')
+$LOAD_PATH << lib_path
+require 'structure_digest'
+
+describe "structure_digest" do
+
+  def digest_fixture(file, opts={})
+    StructureDigest::Digest.new(opts).injest_yml_files(
+      [File.expand_path("./fixtures/#{file}", File.dirname(__FILE__))]
+    ).shorthand
+  end
+
+  it "works with yml" do
+    digest_fixture("sample.yml").should == <<HEREDOC.chomp
+.bill-to.city
+.bill-to.state
+.bill-to.street
+.customer.family
+.customer.given
+.date
+.items[].descrip
+.items[].part_no
+.items[].price
+.items[].quantity
+.items[].size
+.problem.return
+.receipt
+.recursive.problem.ans
+.recursive.problem.que
+.recursive.problem2.ans
+.recursive.problem2.que
+.ship-to.city
+.ship-to.state
+.ship-to.street
+.specialDelivery
+HEREDOC
+  end
+
+  it "works with JSON" do
+    digest_fixture("sample.json").should == <<HEREDOC.chomp
+.address.city
+.address.postalCode
+.address.state
+.address.streetAddress
+.age
+.firstName
+.lastName
+.phoneNumbers[].number
+.phoneNumbers[].type
+HEREDOC
+  end
+
+  it "works with JSON in tree format" do
+    digest_fixture("sample.json", tree: true).should == <<HEREDOC.chomp
+.address
+  .city
+  .postalCode
+  .state
+  .streetAddress
+.age
+.firstName
+.lastName
+.phoneNumbers[]
+  .number
+  .type
+HEREDOC
+  end
+end

data/structure_digest.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'structure_digest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "structure_digest"
+  spec.version       = StructureDigest::VERSION
+  spec.authors       = ["Serguei Filimonov"]
+  spec.email         = ["serguei.filimonov@gmail.com"]
+  spec.description   = %q{Digests and lists all the paths through a nested dictionary}
+  spec.summary       = %q{run the binary on YAML files to check it out}
+  spec.homepage      = ""
+  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"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: structure_digest
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Serguei Filimonov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-12 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'
+description: Digests and lists all the paths through a nested dictionary
+email:
+- serguei.filimonov@gmail.com
+executables:
+- structure_digest
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/structure_digest
+- lib/structure_digest.rb
+- lib/structure_digest/abstract_array_dereference.rb
+- lib/structure_digest/abstract_path.rb
+- lib/structure_digest/array_dereference.rb
+- lib/structure_digest/digest.rb
+- lib/structure_digest/hash_dereference.rb
+- lib/structure_digest/path.rb
+- lib/structure_digest/value.rb
+- lib/structure_digest/version.rb
+- sandbox/Gemfile
+- spec/fixtures/sample.json
+- spec/fixtures/sample.yml
+- spec/integration_spec.rb
+- structure_digest.gemspec
+homepage: ''
+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.2.1
+signing_key: 
+specification_version: 4
+summary: run the binary on YAML files to check it out
+test_files:
+- spec/fixtures/sample.json
+- spec/fixtures/sample.yml
+- spec/integration_spec.rb