blaml 1.0.0.pre

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.rdoc

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2011-02-02
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,11 @@
+.autotest
+History.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/blaml.rb
+lib/blaml/blamed_io.rb
+lib/blaml/meta.rb
+lib/blaml/to_ruby.rb
+lib/blaml/tree_builder.rb
+test/test_blaml.rb

data/README.rdoc

@@ -0,0 +1,77 @@
+= Blaml
+
+* http://github.com/yaksnrainbows/blaml
+
+== DESCRIPTION:
+
+Blaml is a parser based on Psych (ruby 1.9 only) for yaml files that have
+been blamed with git.
+Blaml parses the blamed yaml file and makes the blame metadata available on the
+returned ruby object through a 'meta' attribute.
+
+== FEATURES:
+
+* Load blamed yaml files and access blame data as metadata.
+
+* Currently only works on blamed files generated with 'git blame -f file.yml'
+
+== SYNOPSIS:
+
+  b = Blaml.load `git blame -f file.yml`
+
+  b.meta
+  # => Returns metadata hash for most recent change in this data structure.
+
+  b.keys.first.meta
+  # => Returns metadata hash for when this key was changed.
+
+  b[:key]
+  # => "value"
+
+  b[:key].meta
+  # => {:updated_at => 2010-10-28 22:43:33 +0000, :author => 'user', :line => 12, :commit => '25kjpp43', :file => 'file.yml'}
+
+  b[:key].class
+  # => Blaml::MetaNode
+
+  b[:key] == "value"
+  # => true
+
+  b[:key].value.class
+  # => String
+
+  b.to_value
+  # => Returns the full original data structure (not wrapped in meta classes)
+  # => {:key => "value"}
+
+== INSTALL:
+
+  $ gem install blaml
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Jeremie Castagna
+
+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/Rakefile

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+require 'psych'
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'blaml' do
+  developer('Jeremie Castagna', 'yaksnrainbows@gmail.com')
+
+  self.readme_file      = "README.rdoc"
+  self.history_file     = "History.rdoc"
+  self.extra_rdoc_files = FileList['*.rdoc']
+end
+
+# vim: syntax=ruby

data/lib/blaml.rb

@@ -0,0 +1,93 @@
+require 'time'
+require 'psych'
+require 'yaml'
+
+require 'blaml/blamed_io'
+require 'blaml/tree_builder'
+require 'blaml/meta'
+require 'blaml/to_ruby'
+
+class Blaml
+
+  # This gem's version.
+  VERSION = "1.0.0.pre"
+
+  ###
+  # Load +yaml+ in to a Ruby data structure.  If multiple documents are
+  # provided, the object contained in the first document will be returned.
+  #
+  # Example:
+  #
+  #   Psych.load("--- a")           # => 'a'
+  #   Psych.load("---\n - a\n - b") # => ['a', 'b']
+
+  def self.load yaml
+    result = parse(yaml)
+    result ? result.to_blamed_ruby : result
+  end
+
+
+  ###
+  # Load multiple documents given in +yaml+.  Returns the parsed documents
+  # as a list.  For example:
+  #
+  #   Psych.load_stream("--- foo\n...\n--- bar\n...") # => ['foo', 'bar']
+  #
+  def self.load_stream yaml
+    parse_stream(yaml).children.map { |child| child.to_blamed_ruby }
+  end
+
+
+  ###
+  # Load the document contained in +filename+.  Returns the yaml contained in
+  # +filename+ as a ruby object
+
+  def self.load_file filename
+    self.load File.open(filename)
+  end
+
+
+  ###
+  # Parse a YAML string in +yaml+.  Returns the first object of a YAML AST.
+  #
+  # Example:
+  #
+  #   Psych.parse("---\n - a\n - b") # => #<Psych::Nodes::Sequence:0x00>
+  #
+  # See Psych::Nodes for more information about YAML AST.
+
+  def self.parse yaml
+    children = parse_stream(BlamedIO.new(yaml)).children
+    children.empty? ? false : children.first.children.first
+  end
+
+
+  ###
+  # Parse a file at +filename+. Returns the YAML AST.
+
+  def self.parse_file filename
+    File.open filename do |f|
+      parse f
+    end
+  end
+
+
+  ###
+  # Returns a default parser
+
+  def self.parser blaml
+    Psych::Parser.new(TreeBuilder.new(blaml))
+  end
+
+
+  ###
+  # Parse a YAML blame string in +yaml+.
+  # Returns the full AST for the YAML document with blame metadata.
+  # See Psych::parse_stream for more info.
+
+  def self.parse_stream blaml
+    parser = self.parser blaml
+    parser.parse blaml
+    parser.handler.root
+  end
+end

data/lib/blaml/blamed_io.rb

@@ -0,0 +1,165 @@
+class Blaml
+
+  ##
+  # IO wrapper that removes and parses blame data and makes it
+  # available as metadata
+
+  class BlamedIO
+
+    DATE_MATCHER =
+      %r{(\d+[-\s:]){6}[^\s]+}
+
+    META_MATCHER =
+      %r{([^\s]+)\s+([^\s]+)\s+\(([^\s]+)\s+(#{DATE_MATCHER})\s+(\d+)\)\s}
+
+    # Accessor for currently available metadata.
+    attr_reader :metadata
+
+
+    ##
+    # Create new BlamedIO with a string or IO object.
+
+    def initialize io
+      io = StringIO.new io if String === io
+
+      @io        = io
+      @metadata  = []
+      @meta_mode = true
+    end
+
+
+    %w{close closed? eof eof? rewind}.each do |meth|
+      class_eval "def #{meth}; @io.#{meth}; end"
+    end
+
+
+    ##
+    # Retrieves the metadata for a given string that matches
+    # the next line in the IO stream and deletes it permanently.
+
+    def shift_metadata_for str
+      meta, line = @metadata.first
+
+      if line.nil? || line.empty? || line[0..0] == '#'
+        @metadata.shift
+        return meta if str.empty?
+      end
+
+      meta, line = @metadata.first
+
+      if str.length > line.length
+
+        while str.include? @metadata.first[1] do
+          tmp_meta, line = @metadata.shift
+          meta = tmp_meta if
+            !meta    || !meta[:updated_at]    ||
+            meta     && meta[:updated_at]     &&
+            tmp_meta && tmp_meta[:updated_at] &&
+            tmp_meta[:updated_at] > meta[:updated_at]
+        end
+
+      else
+        @metadata.first[1] = line.split(str, 2).last.strip
+        @metadata.first[1].gsub!(%r{^:(\s+|$)}, "")
+      end
+
+      #puts "#{str}  ->  #{meta.inspect}"
+      meta
+    end
+
+
+    ##
+    # Removes leading spaces and dashes from a line of yaml data.
+
+    def sanitize_data str
+      str.to_s.strip.gsub(%r{^(-\s)+}, "")
+    end
+
+
+    ##
+    # Read single char as an integer.
+
+    def getc
+      read(1).unpack('c')[0]
+    end
+
+
+    ##
+    # Read from the IO instance and parse the blame data.
+
+    def read length=nil, buffer=nil
+      buffer  ||= ""
+      meta_line = ""
+
+      until buffer.length == length || @io.eof?
+        if @meta_mode
+          read_meta
+          @meta_mode = false
+        end
+
+        char = @io.getc
+        buffer    << char
+        meta_line << char
+
+        if buffer[-1..-1] == $/
+          @meta_mode = true
+          @metadata.last << sanitize_data(meta_line)
+          meta_line = ""
+        end
+      end
+
+      #puts @metadata.map{|i| i.inspect}.join("\n")
+      buffer
+    end
+
+
+    ##
+    # Read a single line.
+
+    def readline sep_string=$/
+      buffer = ""
+      until buffer[-1..-1] == sep_string || @io.eof?
+        buffer << read(1)
+      end
+
+      buffer
+    end
+
+    alias gets readline
+
+
+    ##
+    # Reads blame metadata.
+
+    def read_meta
+      buffer = ""
+
+      start_pos = @io.pos
+
+      until buffer =~ META_MATCHER do
+
+        # Got to the end of line with no metadata.
+        # Assume we're reading a regular yml IO.
+        if @io.eof? || buffer =~ %r{#{$/}$}
+          @io.pos = start_pos
+          @metadata << [nil]
+          return
+        end
+
+        buffer << @io.getc
+      end
+
+      meta_key = {
+        :file       => $2,
+        :line       => $6.to_i,
+        :author     => $3,
+        :commit     => $1,
+        :updated_at => Time.parse($4)
+      }
+
+      @metadata << [meta_key]
+
+      true
+    end
+  end
+end

data/lib/blaml/meta.rb

@@ -0,0 +1,190 @@
+class Blaml
+
+
+  ##
+  # Simple wrapper class to assign metadata to object instances.
+
+  class MetaNode
+
+
+    # The object to assign metadata to.
+    attr_reader :value
+
+    # The metadata assigned to the wrapped object.
+    attr_writer :meta
+
+    ##
+    # Create a new MetaNode with the value to wrap and optional metadata.
+
+    def initialize value, meta=nil
+      @value = value
+      @meta  = meta
+    end
+
+
+    ##
+    # Checks for equality against the value attribute.
+
+    def == obj
+      case obj
+      when MetaNode then obj.value == @value
+      else
+        @value == obj
+      end
+    end
+
+
+    ##
+    # Accessor for the meta attribute.
+    # Overridden in MetaArray and MetaHash classes.
+
+    def meta
+      @meta
+    end
+
+
+    %w{to_s to_i to_f to_sym inspect}.each do |meth|
+      class_eval "def #{meth}; @value.#{meth}; end"
+    end
+
+
+    ##
+    # Sends non-defined methods to the value attribute
+
+    def method_missing name, *args, &block
+      @value.send name, *args, &block
+    end
+
+
+    ##
+    # Accessor for the value attribute.
+    # Overridden in MetaArray and MetaHash classes.
+
+    def to_value
+      @value
+    end
+  end
+
+
+  ##
+  # Wraps Array instances with metadata.
+
+  class MetaArray < MetaNode
+
+    ##
+    # Returns the child metadata with the most recent change.
+
+    def meta
+      meta = nil
+
+      @value.each do |val|
+        next unless val.respond_to? :meta
+
+        meta = val.meta if !meta ||
+          meta && val.meta && val.meta[:updated_at] > meta[:updated_at]
+      end
+
+      meta
+    end
+
+
+    ##
+    # Strips MetaNode wrapper from the value and calls to_value
+    # on all array elements.
+
+    def to_value
+      @value.map{|v| v.respond_to?(:to_value) ? v.to_value : v }
+    end
+  end
+
+
+  ##
+  # Wraps Hash instances with metadata.
+
+  class MetaHash < MetaNode
+
+    ##
+    # Access a value of the wrapped hash.
+
+    def [] key
+      @value.each{|k,v| return v if k == key}
+    end
+
+
+    ##
+    # Assign a value of the wrapped hash.
+
+    def []= key, val
+      @value.each{|k,v| @value[k] = val and return if k == key}
+    end
+
+
+    ##
+    # Merge with and modify the wrapped hash.
+
+    def merge! hash
+      hash.each do |k,v|
+        key = @value.keys.find{|vk| vk == k || k == vk } || k
+        @value.delete key
+        @value[k] = v
+      end
+
+      self
+    end
+
+
+    ##
+    # Create a new MetaHash merged with the given hash or metahash.
+
+    def merge hash
+      clone = @value.dup
+      hash.each do |k,v|
+        key = clone.keys.find{|vk| vk == k || k == vk } || k
+        clone.delete key
+        clone[k] = v
+      end
+
+      clone
+    end
+
+
+    ##
+    # Returns the child metadata with the most recent change.
+
+    def meta
+      meta = nil
+
+      @value.each do |key, val|
+        if val.respond_to? :meta
+          meta = val.meta if !meta ||
+            meta && val.meta && val.meta[:updated_at] > meta[:updated_at]
+        end
+
+        if key.respond_to? :meta
+          meta = key.meta if !meta ||
+            meta && val.meta && key.meta[:updated_at] > meta[:updated_at]
+        end
+      end
+
+      meta
+    end
+
+
+    ##
+    # Strips MetaNode wrapper from the value and calls to_value
+    # on all hash elements.
+
+    def to_value
+      clone = Hash.new
+
+      @value.each do |k, v|
+        key = k.respond_to?(:to_value) ? k.to_value : k
+        val = v.respond_to?(:to_value) ? v.to_value : v
+
+        clone[key] = val
+      end
+
+      clone
+    end
+  end
+end

data/lib/blaml/to_ruby.rb

@@ -0,0 +1,55 @@
+class Blaml
+
+  ##
+  # Subclass Psych's to_ruby to build node values with metadata.
+
+  class ToRuby < Psych::Visitors::ToRuby
+
+    ##
+    # Wraps ruby object with MetaNode.
+    # See Psych::Visitors::ToRuby
+
+    def visit_Psych_Nodes_Scalar o
+      MetaNode.new super, o.meta
+    end
+
+
+    ##
+    # Wraps ruby Arrays with MetaArray.
+    # See Psych::Visitors::ToRuby
+
+    def visit_Psych_Nodes_Sequence o
+      seq  = super
+      return seq unless Array === seq
+
+      MetaArray.new seq
+    end
+
+
+
+    ##
+    # Wraps ruby Arrays with MetaHash.
+    # See Psych::Visitors::ToRuby
+
+    def visit_Psych_Nodes_Mapping o
+      mapp = super
+      return mapp unless Hash === mapp
+
+      MetaHash.new mapp
+    end
+  end
+end
+
+
+class Psych::Nodes::Node
+
+  # Metadata accessor.
+  attr_accessor :meta
+
+  ##
+  # Tells Psych nodes to use Blaml::ToRuby.
+
+  def to_blamed_ruby
+    Blaml::ToRuby.new.accept self
+  end
+end

data/lib/blaml/tree_builder.rb

@@ -0,0 +1,30 @@
+class Blaml
+
+  class TreeBuilder < Psych::TreeBuilder
+
+    def initialize meta_binding
+      @meta_binding = meta_binding
+      super()
+    end
+
+
+    ##
+    # Sets the @meta instance variable to the metadata
+    # matched for the string object.
+    # Returns the passed instance.
+
+    def add_meta obj
+      obj.meta = @meta_binding.shift_metadata_for obj.value
+      obj
+    end
+
+
+    ##
+    # Calls parent and applies metadata to return value.
+
+    def scalar value, anchor, tag, plain, quoted, style
+      super
+      add_meta @last.children.last
+    end
+  end
+end

data/test/test_blaml.rb

@@ -0,0 +1,8 @@
+require "test/unit"
+require "blaml"
+
+class TestBlaml < Test::Unit::TestCase
+  def test_sanity
+    assert true
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: blaml
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Jeremie Castagna
+autorequire: !!null 
+bindir: bin
+cert_chain: []
+date: 2011-02-03 00:00:00.000000000 -08:00
+default_executable: !!null 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &2156751600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156751600
+description: ! 'Blaml is a parser based on Psych (ruby 1.9 only) for yaml files that
+  have
+
+  been blamed with git.
+
+  Blaml parses the blamed yaml file and makes the blame metadata available on the
+
+  returned ruby object through a ''meta'' attribute.'
+email:
+- yaksnrainbows@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- Manifest.txt
+- History.rdoc
+- README.rdoc
+files:
+- .autotest
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/blaml.rb
+- lib/blaml/blamed_io.rb
+- lib/blaml/meta.rb
+- lib/blaml/to_ruby.rb
+- lib/blaml/tree_builder.rb
+- test/test_blaml.rb
+- .gemtest
+has_rdoc: true
+homepage: http://github.com/yaksnrainbows/blaml
+licenses: []
+post_install_message: !!null 
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: blaml
+rubygems_version: 1.5.0
+signing_key: !!null 
+specification_version: 3
+summary: Blaml is a parser based on Psych (ruby 1.9 only) for yaml files that have
+  been blamed with git
+test_files:
+- test/test_blaml.rb