tree_structure_digest 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41d5a4f7e0d216beb3825460ec803daba17e58ce
-  data.tar.gz: 951b266f1b45e3205a8904b1f5485efc1e7ba559
+  metadata.gz: 6feccfd4e179cbabb4602bbc2717af3af5845353
+  data.tar.gz: 8e4f1ae6ee53ad6c4a4f4548436e34a18dce7bb8
 SHA512:
-  metadata.gz: eaa75ee033f765b0826264b7d917de6b92e1c6eb6153f062e6155211368c86510c1c445e62c9e29db440400aa0b1fb94b58650a09040c857ce3aba0deaf551b6
-  data.tar.gz: be606e2835481fc87331df89b2b4b62a84f6e27dae7b57d6af4c76b4c4024b5d9bd8c319fed8dee96008bc623f1dd27395feb36958e55105d1d31165453234c5
+  metadata.gz: bfe33d146ecbc7062c6b75125e60e122d6bf4d718a253a4bc801b761be8c87e2909923df9da1e3278be7e1ea396575a980bba5f741b6304218bcacab809b0197
+  data.tar.gz: 77533393a26a524be382a3aa619026e1c6bd2c968ed75a98d8fc5792600675d857bd83759c934b6c6bd8fdb6c0b83a9b144a1fdd0decd43bf309a4645276579b

data/README.md

@@ -19,7 +19,60 @@ Or install it yourself as:
 
 ## Usage
 
-`tree_structure_digest example.yml`
+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.
+
+`tree_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
 

data/bin/tree_structure_digest

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

data/lib/tree_structure_digest.rb

@@ -1,5 +1 @@
-require "tree_structure_digest/version"
-Dir[File.dirname(__FILE__) + '/tree_structure_digest/*.rb'].each {|file| require file }
-
-module TreeStructureDigest
-end
+Dir[File.dirname(__FILE__) + "/**/*.rb"].each(&method(:require))

data/lib/tree_structure_digest/digest.rb

@@ -2,6 +2,10 @@ require 'yaml'
 
 module TreeStructureDigest
   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)
@@ -33,7 +37,38 @@ module TreeStructureDigest
     end
 
     def shorthand
-      @abstract_paths.map(&:serialize).uniq
+      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

data/lib/tree_structure_digest/version.rb

@@ -1,3 +1,3 @@
 module TreeStructureDigest
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/sandbox/Gemfile

@@ -0,0 +1,2 @@
+gem 'pry'
+gem 'tree_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 'tree_structure_digest'
+
+describe "tree_structure_digest" do
+
+  def digest_fixture(file, opts={})
+    TreeStructureDigest::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/specs.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+diff spec/output_fixtures/sample_output.yml <(bin/tree_structure_digest spec/fixtures/sample.yml)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tree_structure_digest
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Serguei Filimonov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-08 00:00:00.000000000 Z
+date: 2014-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,11 @@ files:
 - lib/tree_structure_digest/path.rb
 - lib/tree_structure_digest/value.rb
 - lib/tree_structure_digest/version.rb
+- sandbox/Gemfile
+- spec/fixtures/sample.json
+- spec/fixtures/sample.yml
+- spec/integration_spec.rb
+- specs.sh
 - tree_structure_digest.gemspec
 homepage: ''
 licenses:
@@ -82,9 +87,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: run the binary on YAML files to check it out
-test_files: []
+test_files:
+- spec/fixtures/sample.json
+- spec/fixtures/sample.yml
+- spec/integration_spec.rb
 has_rdoc: