blaml 1.0.0.pre → 1.0.0

data/Manifest.txt

@@ -5,6 +5,7 @@ README.rdoc
 Rakefile
 lib/blaml.rb
 lib/blaml/blamed_io.rb
+lib/blaml/git_blamer.rb
 lib/blaml/meta.rb
 lib/blaml/to_ruby.rb
 lib/blaml/tree_builder.rb

data/README.rdoc

@@ -1,11 +1,11 @@
 = Blaml
 
-* http://github.com/yaksnrainbows/blaml
+* http://yaks.me/blaml
 
 == DESCRIPTION:
 
 Blaml is a parser based on Psych (ruby 1.9 only) for yaml files that have
-been blamed with git.
+been blamed with a SCM.
 Blaml parses the blamed yaml file and makes the blame metadata available on the
 returned ruby object through a 'meta' attribute.
 
@@ -13,12 +13,29 @@ returned ruby object through a 'meta' attribute.
 
 * Load blamed yaml files and access blame data as metadata.
 
-* Currently only works on blamed files generated with 'git blame -f file.yml'
+* Supports custom SCM blaming and parsing (see Blaml::GitBlamer).
 
-== SYNOPSIS:
+== USAGE:
+
+Using the built in GitBlamer:
 
   b = Blaml.load `git blame -f file.yml`
 
+  b = Blaml.blame_file "file.yml"
+
+Using a custom SCM blamer class:
+
+  # Note: First define SvnBlamer with the same interface as GitBlamer
+
+  # Explicitely use a different blamer:
+  b = Blaml.blame_file "file.yml", SvnBlamer
+ 
+  # Always use a different blamer:
+  Blaml.default_blamer = SvnBlamer
+  b = Blaml.blame_file "file.yml"
+
+Working with the blamed data:
+
   b.meta
   # => Returns metadata hash for most recent change in this data structure.
 

data/lib/blaml.rb

@@ -2,6 +2,7 @@ require 'time'
 require 'psych'
 require 'yaml'
 
+require 'blaml/git_blamer'
 require 'blaml/blamed_io'
 require 'blaml/tree_builder'
 require 'blaml/meta'
@@ -10,19 +11,25 @@ require 'blaml/to_ruby'
 class Blaml
 
   # This gem's version.
-  VERSION = "1.0.0.pre"
+  VERSION = "1.0.0"
+
+  class << self
+    # The default blamer interface to use.
+    attr_accessor :default_blamer
+  end
+
+  self.default_blamer = GitBlamer
+
 
   ###
   # 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']
+  # Pass an optional blamer object for blame data parsing
+  # (defaults to Blaml.default_blamer).
 
-  def self.load yaml
-    result = parse(yaml)
+  def self.load yaml, blamer=nil
+    result = parse(yaml, blamer)
     result ? result.to_blamed_ruby : result
   end
 
@@ -32,32 +39,43 @@ class Blaml
   # 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 }
+
+  def self.load_stream yaml, blamer=nil
+    parse_stream(yaml, blamer).children.map { |child| child.to_blamed_ruby }
   end
 
 
   ###
-  # Load the document contained in +filename+.  Returns the yaml contained in
-  # +filename+ as a ruby object
+  # Load the blamed document contained in +filename+.
+  # Returns the yaml contained in +filename+ as a ruby object
 
-  def self.load_file filename
-    self.load File.open(filename)
+  def self.load_file filename, blamer=nil
+    self.load File.open(filename), blamer
+  end
+
+
+  ##
+  # Blame the given file and load the output.
+  # Pass an optional blamer object for blame data parsing
+  # (defaults to Blaml.default_blamer).
+
+  def self.blame_file filename, blamer=nil
+    blamer ||= self.default_blamer
+    self.load blamer.blame(filename), blamer
   end
 
 
   ###
-  # Parse a YAML string in +yaml+.  Returns the first object of a YAML AST.
+  # Parse a blamed 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.
+  # Pass an optional blamer object for blame data parsing
+  # (defaults to self.default_blamer).
+
+  def self.parse yaml, blamer=nil
+    io = BlamedIO.new yaml, blamer
 
-  def self.parse yaml
-    children = parse_stream(BlamedIO.new(yaml)).children
+    children = parse_stream(io).children
     children.empty? ? false : children.first.children.first
   end
 
@@ -65,9 +83,9 @@ class Blaml
   ###
   # Parse a file at +filename+. Returns the YAML AST.
 
-  def self.parse_file filename
+  def self.parse_file filename, blamer=nil
     File.open filename do |f|
-      parse f
+      parse f, blamer
     end
   end
 
@@ -85,7 +103,7 @@ class Blaml
   # Returns the full AST for the YAML document with blame metadata.
   # See Psych::parse_stream for more info.
 
-  def self.parse_stream blaml
+  def self.parse_stream blaml, blamer=nil
     parser = self.parser blaml
     parser.parse blaml
     parser.handler.root

data/lib/blaml/blamed_io.rb

@@ -6,25 +6,21 @@ class Blaml
 
   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.
+    # Pass an optional blamer object for blame data parsing
+    # (defaults to Blaml.default_blamer).
 
-    def initialize io
+    def initialize io, blamer=nil
       io = StringIO.new io if String === io
 
       @io        = io
       @metadata  = []
       @meta_mode = true
+      @blamer    = blamer || Blaml.default_blamer
     end
 
 
@@ -132,11 +128,11 @@ class Blaml
     # Reads blame metadata.
 
     def read_meta
-      buffer = ""
-
+      buffer    = ""
+      meta      = nil
       start_pos = @io.pos
 
-      until buffer =~ META_MATCHER do
+      until meta = @blamer.parse(buffer) do
 
         # Got to the end of line with no metadata.
         # Assume we're reading a regular yml IO.
@@ -149,15 +145,7 @@ class Blaml
         buffer << @io.getc
       end
 
-      meta_key = {
-        :file       => $2,
-        :line       => $6.to_i,
-        :author     => $3,
-        :commit     => $1,
-        :updated_at => Time.parse($4)
-      }
-
-      @metadata << [meta_key]
+      @metadata << [meta]
 
       true
     end

data/lib/blaml/git_blamer.rb

@@ -0,0 +1,52 @@
+class Blaml
+
+  ##
+  # The interface for git repo interaction.
+  # Write your own for other scm tools!
+
+  class GitBlamer
+
+    DATE_MATCHER =
+      %r{(\d+[-\s:]){6}[^\s]+}
+
+    META_MATCHER =
+      %r{([^\s]+)\s+([^\s]+)\s+\(([^\s]+)\s+(#{DATE_MATCHER})\s+(\d+)\)\s}
+
+
+    ##
+    # Returns the blamed contents of the given file.
+
+    def self.blame filepath
+      filepath, filename = File.split filepath
+
+      blame_str = `cd #{filepath} && git blame -f #{filename}`
+      raise blame_str unless $?.success?
+
+      blame_str
+    end
+
+
+    ##
+    # Parses the given string for blame data, returns a hash with blame data
+    # or nil if unparsable.
+    #
+    # Hash keys returned are:
+    # :file:: String - The filepath
+    # :line:: Integer - The line this data came from
+    # :author:: String - The username of the author of the change
+    # :commit:: String - The revision identifier of the commit
+    # :updated_at:: Time - The time when the commit was made
+
+    def self.parse str
+      return unless str =~ META_MATCHER
+
+      {
+        :file       => $2,
+        :line       => $6.to_i,
+        :author     => $3,
+        :commit     => $1,
+        :updated_at => Time.parse($4)
+      }
+    end
+  end
+end

data/lib/blaml/meta.rb

@@ -63,6 +63,14 @@ class Blaml
     def to_value
       @value
     end
+
+
+    ##
+    # Output @value yaml string.
+
+    def to_yaml
+      self.to_value.to_yaml
+    end
   end
 
 
@@ -75,15 +83,18 @@ class Blaml
     # Returns the child metadata with the most recent change.
 
     def meta
-      meta = nil
+      meta     = nil
+      path_key = nil
 
-      @value.each do |val|
+      @value.each_with_index do |val, i|
         next unless val.respond_to? :meta
 
-        meta = val.meta if !meta ||
+        meta = val.meta.dup and path_key = i if !meta ||
           meta && val.meta && val.meta[:updated_at] > meta[:updated_at]
       end
 
+      (meta[:path] ||= []).unshift path_key if meta && path_key
+
       meta
     end
 
@@ -152,20 +163,28 @@ class Blaml
     # Returns the child metadata with the most recent change.
 
     def meta
-      meta = nil
+      meta     = nil
+      path_key = nil
 
       @value.each do |key, val|
         if val.respond_to? :meta
-          meta = val.meta if !meta ||
+          if !meta ||
             meta && val.meta && val.meta[:updated_at] > meta[:updated_at]
+            meta = val.meta.dup
+            path_key = key
+          end
         end
 
         if key.respond_to? :meta
-          meta = key.meta if !meta ||
+          if !meta ||
             meta && val.meta && key.meta[:updated_at] > meta[:updated_at]
+            meta = key.meta.dup
+          end
         end
       end
 
+      (meta[:path] ||= []).unshift path_key if meta && path_key
+
       meta
     end
 

metadata

@@ -1,32 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: blaml
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Jeremie Castagna
-autorequire: !!null 
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-02-03 00:00:00.000000000 -08:00
-default_executable: !!null 
+date: 2012-07-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &2156751600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *2156751600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: ! 'Blaml is a parser based on Psych (ruby 1.9 only) for yaml files that
   have
 
-  been blamed with git.
+  been blamed with a SCM.
 
   Blaml parses the blamed yaml file and makes the blame metadata available on the
 
@@ -36,8 +56,8 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- Manifest.txt
 - History.rdoc
+- Manifest.txt
 - README.rdoc
 files:
 - .autotest
@@ -47,15 +67,15 @@ files:
 - Rakefile
 - lib/blaml.rb
 - lib/blaml/blamed_io.rb
+- lib/blaml/git_blamer.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
+homepage: http://yaks.me/blaml
 licenses: []
-post_install_message: !!null 
+post_install_message: 
 rdoc_options:
 - --main
 - README.rdoc
@@ -70,15 +90,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: blaml
-rubygems_version: 1.5.0
-signing_key: !!null 
+rubygems_version: 1.8.23
+signing_key: 
 specification_version: 3
 summary: Blaml is a parser based on Psych (ruby 1.9 only) for yaml files that have
-  been blamed with git
+  been blamed with a SCM
 test_files:
 - test/test_blaml.rb