git-meta 1.0.0

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Sam Elliott
+
+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/README.md

@@ -0,0 +1,45 @@
+git-meta
+========
+A less than freeform way of storing some metadata in git commit objects.
+
+What is this?
+-------------
+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.
+
+Syntax
+------
+
+In your git commit, you just need a section that looks something like the following:
+
+    ---git-meta---
+    foo:
+      bar: "baz"
+    ---git-meta---
+
+This is a YAML formatted block. Currently the only way of setting this metadata is writing the YAML by hand in the commit message.
+
+Usage
+=====
+
+Querying
+--------
+
+You can use `git-meta [sha|ref] --get-all` to return just the YAML-block.
+
+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. 
+
+If you were to specify just `--get foo` then the underlying YAML would be returned (in this case `bar: "baz"`).
+
+Storing
+-------
+
+I have not yet got this sorted. I need to think a bit more about this. 
+
+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.
+
+Copyright
+---------
+
+Copyright (c) 2009 Sam Elliott. See LICENSE for details. (MIT Licence)

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "git-meta"
+    gem.summary = %Q{A less than freeform way of storing some metadata in git commit objects.}
+    gem.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.}
+    gem.email = "sam@lenary.co.uk"
+    gem.homepage = "http://github.com/lenary/git-meta"
+    gem.authors = ["Sam Elliott"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

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

data/bin/git-meta

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+options = {:all => false, :sha => ARGV.shift}
+
+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.on('-g', '--get KEY',
+            "Retrives a certain KEY from the git commit object") do |key|
+    options[:keys] = key.split(".")
+  end
+  
+  parser.on('-h', '--help',
+            "Returns Usage Notes") do 
+    puts parser
+    exit
+  end
+  
+end
+
+if !options[:sha]
+  puts optparser
+  exit
+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

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: git-meta
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Sam Elliott
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-15 00:00:00 +01:00
+default_executable: git-meta
+dependencies: []
+
+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. 
+        
+  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.
+email: sam@lenary.co.uk
+executables: 
+- git-meta
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/git-meta
+has_rdoc: true
+homepage: http://github.com/lenary/git-meta
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+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: []
+