diffable_yaml 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ede5b1945e4249a0b29dd466e7263ea5feb7b59
+  data.tar.gz: 93551e520ff49a88346cbd946e90a0e835ff5baf
+SHA512:
+  metadata.gz: 89562fddf48689216c8345ba7fe9de12561d4192093cc4a48c128092e5f64b7d2a2ad326e3759cd0659b76cb397e8949a0380ed4538874a35d6b8ed2499cde80
+  data.tar.gz: dc21e0b117ba61aecb1b5b8fc8df406e0944a78d5d368d8b733f29e498321e4d1ef2c1219e6e0f228393b9360f7fb7e229d1487fcd0aa8bf4387d15a08cd85c1

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2015, nrser
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of DiffableYAML nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,2 @@
+# DiffableYAML
+dump YAML in Ruby with hash keys ordered to make text diffs easier

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+# require "rspec/core/rake_task"
+
+# RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/diffable_yaml.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'diffable_yaml/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'diffable_yaml'
+  spec.version     = DiffableYAML::VERSION
+  spec.authors     = ["nrser"]
+  spec.email       = 'neil@ztkae.com'
+  spec.summary     = "dump YAML in Ruby with hash keys ordered to make text diffs easier"
+  spec.description = <<-EOS
+this is a little chunck of code i use to dump Ruby objects to YAML with Hash
+keys in a some-what consistent order.
+
+i do this because i often find myself using YAML files as data storage and 
+this makes it a lot easier to compare versions with text-based diff toolspec.
+
+this lib is horribly alpha and has no tests what-so-ever. i'm sure it's
+as full or bugs and bad ideas as 100 lines of code can be. i just put it
+here so it's easier for me to use across projectspec. but you're welcome
+to take it for a spin too if you really want.
+
+this relies on Psych internals, so it has a dependency on pysch ~> 2.0.
+it might work fine with other versions; that's just all i've tested it
+against at the moment.
+EOS
+  spec.homepage      = 'https://github.com/nrser/DiffableYAML'
+  spec.license       = 'BSD'
+  
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency 'psych', '~> 2.0'
+  
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/diffable_yaml/version.rb

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

data/lib/diffable_yaml.rb

@@ -0,0 +1,105 @@
+require 'psych'
+
+require 'diffable_yaml/version'
+
+module DiffableYAML
+  # this dumps YAML with hashes / dicts in a consistent order so that
+  # text diffs make more sense
+  class DiffableYAMLTree < Psych::Visitors::YAMLTree
+    def self.create options = {}, emitter = nil
+      preorder = options.delete(:preorder) || []
+      instance = Psych::Visitors::YAMLTree.create options, emitter
+      instance.instance_variable_set '@preorder', preorder
+      instance
+    end
+
+    def visit_Hash o
+      tag      = o.class == ::Hash ? nil : "!ruby/hash:#{o.class}"
+      implicit = !tag
+
+      register(o, @emitter.start_mapping( nil, 
+                                          tag, 
+                                          implicit, 
+                                          Psych::Nodes::Mapping::BLOCK))
+
+      @preorder.each do |key|
+        if o.key? key
+          accept key
+          accept o[key]
+        end
+      end
+      o.keys.map {|k|
+        [k, k.to_s]
+      }.sort {|(k_a, s_a), (k_b, s_b)|
+        s_a <=> s_b
+      }.each do |k, s|
+        unless @preorder.include? k
+          accept k
+          accept o[k]
+        end
+      end
+
+      @emitter.end_mapping
+    end
+
+    def visit_String o
+      plain = false
+      quote = false
+      style = Psych::Nodes::Scalar::ANY
+
+      if binary?(o)
+        str   = [o].pack('m').chomp
+        tag   = '!binary' # FIXME: change to below when syck is removed
+        #tag   = 'tag:yaml.org,2002:binary'
+        style = Psych::Nodes::Scalar::LITERAL
+      else
+        str   = o
+        tag   = nil
+        quote = !(String === @ss.tokenize(o))
+        plain = !quote
+        if str.index("\n")
+          style = Psych::Nodes::Scalar::LITERAL
+        end
+      end
+
+      ivars = find_ivars o
+
+      if ivars.empty?
+        unless o.class == ::String
+          tag = "!ruby/string:#{o.class}"
+        end
+        @emitter.scalar str, nil, tag, plain, quote, style
+      else
+        maptag = '!ruby/string'
+        maptag << ":#{o.class}" unless o.class == ::String
+
+        register o, @emitter.start_mapping( nil, 
+                                            maptag, 
+                                            false, 
+                                            Pysch::Nodes::Mapping::BLOCK)
+        @emitter.scalar 'str', 
+                        nil, 
+                        nil, 
+                        true, 
+                        false, 
+                        Psych::Nodes::Scalar::ANY
+        @emitter.scalar str, nil, tag, plain, quote, style
+
+        dump_ivars o
+
+        @emitter.end_mapping
+      end
+    end
+  end
+
+  def self.dump(o, io = nil, options = {})
+    if Hash === io
+      options = io
+      io      = nil
+    end
+
+    visitor = DiffableYAMLTree.create options
+    visitor << o
+    visitor.tree.yaml io, options
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: diffable_yaml
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- nrser
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: "this is a little chunck of code i use to dump Ruby objects to YAML with
+  Hash\nkeys in a some-what consistent order.\n\ni do this because i often find myself
+  using YAML files as data storage and \nthis makes it a lot easier to compare versions
+  with text-based diff toolspec.\n\nthis lib is horribly alpha and has no tests what-so-ever.
+  i'm sure it's\nas full or bugs and bad ideas as 100 lines of code can be. i just
+  put it\nhere so it's easier for me to use across projectspec. but you're welcome\nto
+  take it for a spin too if you really want.\n\nthis relies on Psych internals, so
+  it has a dependency on pysch ~> 2.0.\nit might work fine with other versions; that's
+  just all i've tested it\nagainst at the moment.\n"
+email: neil@ztkae.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- diffable_yaml.gemspec
+- lib/diffable_yaml.rb
+- lib/diffable_yaml/version.rb
+homepage: https://github.com/nrser/DiffableYAML
+licenses:
+- BSD
+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.2
+signing_key: 
+specification_version: 4
+summary: dump YAML in Ruby with hash keys ordered to make text diffs easier
+test_files: []