scm 0.1.0.pre1

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.*
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,2 @@
+doc/
+pkg/

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "SCM Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2011-06-16
+
+* Initial release:
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Hal Brodigan
+
+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,46 @@
+# SCM
+
+* [Source](http://github.com/postmodern/scm)
+* [Issues](http://github.com/postmodern/scm/issues)
+* [Documentation](http://rubydoc.info/gems/scm/frames)
+* [Email](mailto:postmodern.mod3 at gmail.com)
+
+## Description
+
+{SCM} is a simple Ruby library for interacting with common SCMs,
+such as Git, Mercurial (Hg) and SubVersion (SVN).
+
+## Features
+
+* Supports:
+  * [Git](http://www.git-scm.org/)
+  * [Mercurial (Hg)](http://mercurial.selenic.com/)
+  * [SubVersion (SVN)](http://subversion.tigris.org/)
+* Provides a basic {SCM::Repository API} for each SCM.
+
+## Examples
+
+    require 'scm'
+
+    repo = SCM::Git.new('path/to/repo')
+
+    repo.branches
+    # => [...]
+
+    repo.tags
+    # => [...]
+
+    repo.status
+    # => {...}
+
+    repo.log
+
+## Install
+
+    $ gem install scm
+
+## Copyright
+
+Copyright (c) 2011 Hal Brodigan
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'ore-tasks', '~> 0.4'
+  require 'ore/tasks'
+
+  Ore::Tasks.new
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
+end
+
+begin
+  gem 'rspec', '~> 2.4'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+
+task :test => :spec
+task :default => :spec
+
+begin
+  gem 'yard', '~> 0.7.0'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end
+task :doc => :yard

data/gemspec.yml

@@ -0,0 +1,16 @@
+name: scm
+summary: Ruby interface to common SCMs
+description:
+  SCM is a simple Ruby library for interacting with common SCMs,
+  such as Git, Mercurial (Hg) and SubVersion (SVN).
+
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: http://github.com/postmodern/scm
+has_yard: true
+
+development_dependencies:
+  ore-tasks: ~> 0.4
+  rspec: ~> 2.4
+  yard: ~> 0.7.0

data/lib/scm/commits/commit.rb

@@ -0,0 +1,64 @@
+module SCM
+  module Commits
+    #
+    # Base-class for other SCM Commit classes.
+    #
+    class Commit
+
+      # The commit hash or revision number
+      attr_reader :commit
+
+      # The date of the commit
+      attr_reader :date
+
+      # The author of the commit
+      attr_reader :author
+
+      # The summary of the commit
+      attr_reader :summary
+
+      #
+      # Creates a new commit object.
+      #
+      # @param [String, Integer] commit
+      #   The commit hash or revision number.
+      #
+      # @param [Time] date
+      #   The date of the commit.
+      #
+      # @param [String] author
+      #   The author of the commit.
+      #
+      # @param [String] summary
+      #   The summary of the commit.
+      #
+      def initialize(commit,date,author,summary)
+        @commit = commit
+        @date = date
+        @author = author
+        @summary = summary
+      end
+
+      #
+      # Converts the commit to a String.
+      #
+      # @return [String]
+      #   The commit hash or revision.
+      #
+      def to_s
+        @commit.to_s
+      end
+
+      #
+      # Coerces the commit into an Array.
+      #
+      # @return [Array<commit, date, author, summary>]
+      #   The commit components.
+      #
+      def to_ary
+        [@commit, @date, @author, @summary]
+      end
+
+    end
+  end
+end

data/lib/scm/commits/git.rb

@@ -0,0 +1,62 @@
+require 'scm/commits/commit'
+
+module SCM
+  module Commits
+    class Git < Commit
+
+      # The parent of the commit
+      attr_reader :parent
+
+      # The tree of the commit
+      attr_reader :tree
+
+      # The email of the author
+      attr_reader :email
+
+      #
+      # Creates a new Git commit.
+      #
+      # @param [String] commit
+      #   The SHA1 hash of the commit.
+      #
+      # @param [String] parent
+      #   The SHA1 hash of the parent commit.
+      #
+      # @param [String] tree
+      #   The SHA1 hash of the tree.
+      #
+      # @param [Time] date
+      #   The date the commit was made.
+      #
+      # @param [String] author
+      #   The author of the commit.
+      #
+      # @param [String] email
+      #   The email for the author.
+      #
+      # @param [String] summary
+      #   The summary of the commit.
+      #
+      def initialize(commit,parent,tree,date,author,email,summary)
+        super(commit,date,author,summary)
+
+        @parent = parent
+        @tree = tree
+        @email = email
+      end
+
+      alias sha1 commit
+
+      #
+      # Coerces the Git commit into an Array.
+      #
+      # @return [Array<commit, parent, tree, date, author, email, summary>]
+      #   The commit components.
+      #
+      def to_ary
+        [@commit, @parent, @tree, @date, @author, @email, @summary]
+      end
+
+    end
+  end
+end

data/lib/scm/commits/hg.rb

@@ -0,0 +1,69 @@
+require 'scm/commits/commit'
+
+module SCM
+  module Commits
+    #
+    # Represents a commit in an {SCM::Hg Hg Repository}.
+    #
+    class Hg < Commit
+
+      # The Hash of the commit
+      attr_reader :hash
+
+      # The branch of the commit
+      attr_reader :branch
+
+      #
+      # Creates a new Hg commit.
+      #
+      # @param [String, Integer] revision
+      #   The revision of the commit.
+      #
+      # @param [String] hash
+      #   The hash of the commit.
+      #
+      # @param [String] branch
+      #   The branch the commit belongs to.
+      #
+      # @param [String] user
+      #   The Hg user that made the commit.
+      #
+      # @param [Time] date
+      #   The date the commit was made on.
+      #
+      # @param [String] summary
+      #   The summary of the commit.
+      #
+      def initialize(revision,hash,branch,user,date,summary)
+        super(revision,date,user,summary)
+
+        @hash = hash
+        @branch = branch
+      end
+
+      alias revision commit
+      alias user author
+
+      #
+      # Converts the commit to an Integer.
+      #
+      # @return [Integer]
+      #   The commit revision.
+      #
+      def to_i
+        @commit.to_i
+      end
+
+      #
+      # Coerces the Hg commit into an Array.
+      #
+      # @return [Array<commit, hash, branch, date, author, summary>]
+      #   The commit components.
+      #
+      def to_ary
+        [@commit, @hash, @branch, @date, @user, @summary]
+      end
+
+    end
+  end
+end

data/lib/scm/commits/svn.rb

@@ -0,0 +1,12 @@
+require 'scm/commits/commit'
+
+module SCM
+  module Commits
+    class SVN < Commit
+
+      alias revision commit
+      alias user author
+
+    end
+  end
+end