git-meta 1.0.0 → 2.0.0

data/.gitignore

@@ -19,3 +19,4 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+repos

data/README.md

@@ -11,33 +11,45 @@ It is also completely compatible for people wanting to read this metadata direct
 Syntax
 ------
 
-In your git commit, you just need a section that looks something like the following:
+In your git commit, you just need a few yaml-like structures like the following:
 
-    ---git-meta---
-    foo:
-      bar: "baz"
-    ---git-meta---
+    foo: bar
+    Signed-Off-By: Me!
 
-This is a YAML formatted block. Currently the only way of setting this metadata is writing the YAML by hand in the commit message.
+Currently the only way of setting this metadata is writing the YAML by hand in the commit message. The Regex that i use (no longer a YAML parser for simplification) will catch all non-whitespace before each colon and the rest of the line afterwards. 
+
+The change where I have removed YAML means that we can no longer have hierarchal data structures, which both makes it easier to use with small amounts of data but harder to use with larger amounts of data.
+
+If you want to re-implement this in another language, I ask that you please use the following regular expression to parse the git messages (we make a call to the `git-cat-file` utility to get the messages):
+
+    /(\S+):\s*(.+)$/
 
 Usage
 =====
 
-Querying
---------
+Getting
+-------
 
-You can use `git-meta [sha|ref] --get-all` to return just the YAML-block.
+You can use `git-meta get [ sha | ref ]` to return all keys and values. `[ sha | ref ]` can be anything that `git-cat-file` will understand. 
 
-You can also use `git-meta [sha|ref] --get foo.bar` to return "baz" from the earlier example. Will return an empty string if nothing is returned for that piece of metadata. 
+You can also use `git-meta get [ sha | ref ] --get foo` to return "bar" from the earlier example. Will return an empty string if nothing is returned for that piece of metadata. 
 
-If you were to specify just `--get foo` then the underlying YAML would be returned (in this case `bar: "baz"`).
+I am aware that this is open to shenanigans including something like `git-meta get 'HEAD && echo "foo: baz"'` but really, I don't care. I don't foresee this being used anywhere that would be a problem - ie i guess it will mostly be used by a person wanting the data, or a computer processing the data with other values like commit shas or refs that it has deduced itself.
 
-Storing
+Setting
 -------
 
-I have not yet got this sorted. I need to think a bit more about this. 
+I have not yet got this sorted. A solution will be forthcoming in a compatible release, but at the moment i have not yet thought enough about how it's going to be implemented.
+
+Installation
+============
+
+As easy as `gem install git-meta` (as long as you have gemcutter as a source)
+
+Requirements
+============
 
-I originally thought i could use `./.git/COMMIT\_EDIT\_MSG` but it turns out that is overwritten just before every commit. Whack me an email or a github message if you want to help with this feature, or have an idea for implementation.
+Only `shoulda` and `mocra` for testing. I have tried to keep this as lean as possible.
 
 Copyright
 ---------

data/Rakefile

@@ -1,5 +1,19 @@
-require 'rubygems'
+begin
+  require 'rubygems'
+rescue LoadError
+  # meh
+end
 require 'rake'
+require 'rake/testtask'
+
+$:.unshift File.expand_path("#{File.dirname(__FILE__)}/lib")
+require 'git_meta'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/test_*.rb'
+  t.verbose = false
+end
 
 begin
   require 'jeweler'
@@ -14,6 +28,10 @@ This gem allows reading this data.}
     gem.email = "sam@lenary.co.uk"
     gem.homepage = "http://github.com/lenary/git-meta"
     gem.authors = ["Sam Elliott"]
+    gem.version = GitMeta::VERSION
+    gem.add_development_dependency "shoulda", "~>2.10.2"
+    gem.add_development_dependency "mocha", "~>0.9.8"
+    # these are the two versions i have been testing with.
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/bin/git-meta

@@ -2,19 +2,17 @@
 
 require 'optparse'
 
-options = {:all => false, :sha => ARGV.shift}
+$:.unshift File.expand_path("#{File.dirname(__FILE__)}/../lib")
+require 'git_meta'
+
+options = {:command => ARGV.shift || "get", :sha => ARGV.shift, :key => nil}
 
 optparser = OptionParser.new  do |parser|
-  parser.banner = "Usage: git-meta [sha|ref] [ --get | --get-all ]"
-  
-  parser.on('-a', '--get-all',
-            "Retrieves all the keys as YAML data.") do |all|
-    options[:all] = all
-  end
+  parser.banner = "Usage: git-meta get [ sha | ref ] [ --get KEY ]"
 
   parser.on('-g', '--get KEY',
             "Retrives a certain KEY from the git commit object") do |key|
-    options[:keys] = key.split(".")
+    options[:key] = key
   end
   
   parser.on('-h', '--help',
@@ -32,20 +30,5 @@ end
 
 optparser.parse(ARGV)
 
-git_commit_info, data, output = nil, nil, nil
-
-IO.popen("git-cat-file -p #{options[:sha]}", 'r') do |git_cat_file|
-  git_commit_info = git_cat_file.read
-end
-
-if git_commit_info =~ /^(---git-meta---\s*\n)(.*\n)(^---git-meta---.*\n)/m
-  if options[:keys]
-    data = YAML.load($2)
-    options[:keys].each do |key|
-      data = data.fetch(key, Hash.new(""))
-    end
-    puts data.to_yaml.gsub(/^--- \n?/, '')
-  elsif options[:all]
-    puts $2
-  end
-end
+@getter = GitMeta::Get.new(options[:sha], options[:key])
+puts @getter

data/git-meta.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{git-meta}
+  s.version = "2.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sam Elliott"]
+  s.date = %q{2010-02-13}
+  s.default_executable = %q{git-meta}
+  s.description = %q{It's a way to store data along with a git commit object that is less freeform than something like "Close gh-11" but more freeform than having to add extra data structures to the git commit object. 
+      
+It is also completely compatible for people wanting to read this metadata directly from an interface like git-log or github.
+
+This gem allows reading this data.}
+  s.email = %q{sam@lenary.co.uk}
+  s.executables = ["git-meta"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "bin/git-meta",
+     "git-meta.gemspec",
+     "lib/git_meta.rb",
+     "test/test_git_meta.rb"
+  ]
+  s.homepage = %q{http://github.com/lenary/git-meta}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A less than freeform way of storing some metadata in git commit objects.}
+  s.test_files = [
+    "test/test_git_meta.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, ["~> 2.10.2"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.9.8"])
+    else
+      s.add_dependency(%q<shoulda>, ["~> 2.10.2"])
+      s.add_dependency(%q<mocha>, ["~> 0.9.8"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, ["~> 2.10.2"])
+    s.add_dependency(%q<mocha>, ["~> 0.9.8"])
+  end
+end
+

data/lib/git_meta.rb

@@ -0,0 +1,51 @@
+module GitMeta
+
+  VERSION = "2.0.0"
+
+  class Scanner
+
+    attr_accessor :info
+
+    REGEX = /(\S+):\s*(.+)$/
+
+    def initialize(text)
+      self.info = Hash.new("")
+      text.scan(REGEX) do |k,v|
+        self.info[k] = v
+      end
+    end
+
+    def ==(comrade)
+      info == comrade.info
+    end
+
+  end
+
+  class Hash < ::Hash
+
+    def to_s
+      inject("") do |result, hash|
+        result += "#{hash[0]}: #{hash[1]}\n"
+        # hash is an array of schema [key, value]
+      end
+    end
+
+  end
+
+  class Get
+    attr_accessor :scanner, :key
+    def initialize(sha, key=nil)
+      output = IO.popen("git-cat-file -p #{sha}", 'r') do |git_cat_file|
+        git_cat_file.read
+      end
+      self.scanner = Scanner.new(output)
+      self.key = key
+    end
+
+    def to_s
+      key ? @scanner.info[key] : @scanner.info.to_s
+    end
+
+  end
+
+end

data/test/test_git_meta.rb

@@ -0,0 +1,82 @@
+begin
+  require 'rubygems'
+rescue LoadError
+  # meh
+end
+require 'shoulda'
+require 'mocha'
+require 'git_meta'
+
+class GitMetaTest < Test::Unit::TestCase
+  context "A Scanner instance" do
+    should "parse the data" do
+      scanner = GitMeta::Scanner.new("\nfoo: bar\nfuzz: bazz\n")
+      expected = {"foo"=> "bar", "fuzz"=> "bazz"}
+      assert_equal expected, scanner.info
+    end
+
+    should "accept hypens in the keys" do
+      scanner = GitMeta::Scanner.new("\nhi-there: you\nfoo: bar\n")
+      expected = {"hi-there" => "you", "foo" => "bar"}
+      assert_equal expected, scanner.info
+    end
+
+    should "accept whitespace in the values" do
+      scanner = GitMeta::Scanner.new("\nSigned-off-by: José Valim <jose.valim@gmail.com>\nfoo: bear\n")
+      expected = {"Signed-off-by" => "José Valim <jose.valim@gmail.com>", "foo" => "bear"}
+      assert_equal expected, scanner.info
+    end
+
+    should "play nice with comrades" do
+      scanner = GitMeta::Scanner.new("\nhi-there: you\nfoo: bar\n")
+      other_scanner = GitMeta::Scanner.new("\nhi-there: you\nfoo: bar\n")
+      assert_equal scanner, other_scanner
+    end
+  end
+
+  context "A Get instance" do
+    setup do
+      @cat_file = <<-FOO
+      tree 0b31db52b0f96659a93dee8c5c7a1f8a95f0bb2b
+      parent e033a2271fa3c59ae2c8b30f4b5ef8eb83e739db
+      author Sam Elliott <sam@lenary.co.uk> 1266027667 +0100
+      committer Sam Elliott <sam@lenary.co.uk> 1266027667 +0100
+
+      foo: bar
+      Signed-Off-By: Me!
+      FOO
+      IO.expects(:popen).with("git-cat-file -p HEAD", 'r').returns(@cat_file).at_least_once
+    end
+
+    should "initialize correctly without key" do
+      @getter = GitMeta::Get.new("HEAD", nil)
+      assert_nil @getter.key
+      assert_equal @getter.scanner, GitMeta::Scanner.new(@cat_file)
+    end
+
+    should "initialize correctly with a key" do
+      @getter = GitMeta::Get.new("HEAD", "foo")
+      assert_equal @getter.key, "foo"
+      assert_equal @getter.scanner, GitMeta::Scanner.new(@cat_file)
+    end
+
+    should "display itself nicely" do
+      @getter = GitMeta::Get.new("HEAD", "foo")
+      assert_equal @getter.to_s, "bar"
+      long_expectation = "foo: bar\nSigned-Off-By: Me!\n"
+      @getter = GitMeta::Get.new("HEAD", nil)
+      assert_equal @getter.to_s, long_expectation
+    end
+  end
+
+  context "A Hash instance" do
+    should "print correctly" do
+      hash = GitMeta::Hash.new
+      hash["foo"] = "bar"
+      hash["fuzz"] = "bazz"
+
+      expected = "foo: bar\nfuzz: bazz\n"
+      assert_equal expected, hash.to_s
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: git-meta
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Sam Elliott
@@ -9,10 +9,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-15 00:00:00 +01:00
+date: 2010-02-13 00:00:00 +01:00
 default_executable: git-meta
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.10.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
 description: |-
   It's a way to store data along with a git commit object that is less freeform than something like "Close gh-11" but more freeform than having to add extra data structures to the git commit object. 
         
@@ -32,8 +51,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- VERSION
 - bin/git-meta
+- git-meta.gemspec
+- lib/git_meta.rb
+- test/test_git_meta.rb
 has_rdoc: true
 homepage: http://github.com/lenary/git-meta
 licenses: []
@@ -62,5 +83,5 @@ rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: A less than freeform way of storing some metadata in git commit objects.
-test_files: []
-
+test_files: 
+- test/test_git_meta.rb

data/VERSION

@@ -1 +0,0 @@
-1.0.0