scm 0.1.0.pre1 → 0.1.0.pre2

data/ChangeLog.md

@@ -1,4 +1,7 @@
 ### 0.1.0 / 2011-06-16
 
 * Initial release:
+  * Supports {SCM::Git}.
+  * Supports {SCM::Hg}.
+  * Supports {SCM::SVN}.
 

data/lib/scm/commits/commit.rb

@@ -1,3 +1,5 @@
+require 'time'
+
 module SCM
   module Commits
     #
@@ -17,6 +19,12 @@ module SCM
       # The summary of the commit
       attr_reader :summary
 
+      # The full commit message of the commit
+      attr_reader :message
+
+      # The files changed by the commit
+      attr_reader :files
+
       #
       # Creates a new commit object.
       #
@@ -32,11 +40,29 @@ module SCM
       # @param [String] summary
       #   The summary of the commit.
       #
-      def initialize(commit,date,author,summary)
-        @commit = commit
-        @date = date
-        @author = author
+      # @param [String] message
+      #   The full commit message of the commit.
+      #
+      # @param [String] files
+      #   The files changed in the commit.
+      #
+      def initialize(commit,date,author,summary,message,files=[])
+        @commit  = commit
+        @date    = date
+        @author  = author
         @summary = summary
+        @message = message
+        @files   = files
+      end
+
+      #
+      # Inspects the commit.
+      #
+      # @return [String]
+      #   The inspected commit.
+      #
+      def inspect
+        "#<#{self.class}: #{@commit}>"
       end
 
       #

data/lib/scm/commits/git.rb

@@ -37,12 +37,12 @@ module SCM
       # @param [String] summary
       #   The summary of the commit.
       #
-      def initialize(commit,parent,tree,date,author,email,summary)
-        super(commit,date,author,summary)
+      def initialize(commit,parent,tree,date,author,email,summary,message,files)
+        super(commit,date,author,summary,message,files)
 
         @parent = parent
-        @tree = tree
-        @email = email
+        @tree   = tree
+        @email  = email
       end
 
       alias sha1 commit
@@ -50,11 +50,11 @@ module SCM
       #
       # Coerces the Git commit into an Array.
       #
-      # @return [Array<commit, parent, tree, date, author, email, summary>]
+      # @return [Array<commit, parent, tree, date, author, email, summary, message, files>]
       #   The commit components.
       #
       def to_ary
-        [@commit, @parent, @tree, @date, @author, @email, @summary]
+        [@commit, @parent, @tree, @date, @author, @email, @summary, @message, @files]
       end
 
     end

data/lib/scm/commits/hg.rb

@@ -34,10 +34,10 @@ module SCM
       # @param [String] summary
       #   The summary of the commit.
       #
-      def initialize(revision,hash,branch,user,date,summary)
-        super(revision,date,user,summary)
+      def initialize(revision,hash,branch,user,date,summary,message,files)
+        super(revision,date,user,summary,message,files)
 
-        @hash = hash
+        @hash   = hash
         @branch = branch
       end
 

data/lib/scm/git.rb

@@ -249,11 +249,19 @@ module SCM
     # @param [String, Symbol] name
     #   The name of the branch to switch to.
     #
+    # @param [Hash] options
+    #   Additional options.
+    #
+    #   @option options [Boolean] :quiet 
+    #   Switch branch quietly.
+    #
     # @return [Boolean]
     #   Specifies whether the branch was successfully switched.
     #
-    def switch_branch(name)
-      git(:checkout,name)
+    def switch_branch(name, options={})
+      arguments = ""
+      arguments << '-q' if options[:quiet]
+      git(:checkout, arguments, name)
     end
 
     #
@@ -441,7 +449,10 @@ module SCM
     def commits(options={})
       return enum_for(:commits,options) unless block_given?
 
-      arguments = ["--pretty=format:%H|%P|%T|%at|%an|%ae|%s"]
+      arguments = [
+        '--name-only',
+        '--pretty=format:%H~|~%P~|~%T~|~%at~|~%an~|~%ae~|~%s~|~%b~|~'
+      ]
 
       if options[:limit]
         arguments << "-#{options[:limit]}"
@@ -455,16 +466,23 @@ module SCM
         arguments += ['--', *options[:paths]]
       end
 
-      commit = nil
-      parent = nil
-      tree   = nil
-      tree   = nil
-      parent = nil
-      author = nil
-      date   = nil
+      commit  = nil
+      parent  = nil
+      tree    = nil
+      date    = nil
+      author  = nil
+      email   = nil
+      summary = nil
+
+      io = popen('git log',*arguments)
 
-      popen('git log',*arguments) do |line|
-        commit, parent, tree, date, author, email, summary = line.split('|',7)
+      until io.eof?
+        line = io.readline.chomp
+
+        commit, parent, tree, date, author, email, summary, body, files = line.split('~|~',9)
+
+        message = [summary, '', body].join($/)
+        files   = readlines_until(io)
 
         yield Commits::Git.new(
           commit,
@@ -473,11 +491,41 @@ module SCM
           Time.at(date.to_i),
           author,
           email,
-          summary
+          summary,
+          message,
+          files
         )
       end
     end
 
+    #
+    # Lists the files of the Git repository.
+    #
+    # @param [String] pattern
+    #   Optional glob pattern to filter the files by.
+    #
+    # @yield [file]
+    #   The given block will be passed each file.
+    #
+    # @yieldparam [String] file
+    #   A path of a file tracked by Git.
+    #
+    # @return [Enumerator]
+    #   If no block is given, an Enumerator will be returned.
+    #
+    def files(pattern=nil,&block)
+      return enum_for(:files,pattern) unless block
+
+      arguments = []
+
+      if pattern
+        arguments << '--' << pattern
+      end
+
+      popen('git','ls-files',*arguments,&block)
+      return nil
+    end
+
     protected
 
     #

data/lib/scm/hg.rb

@@ -35,6 +35,10 @@ module SCM
     #   Could not initialize the Hg repository.
     #
     def self.create(path,options={})
+      if options[:bare]
+        raise("Hg does not support creating bare repositories")
+      end
+
       unless path.start_with?('ssh://')
         FileUtils.mkdir_p(path)
       end
@@ -398,7 +402,7 @@ module SCM
     def commits(options={})
       return enum_for(:commits,options) unless block_given?
 
-      arguments = []
+      arguments = ['-v']
 
       if options[:commit]
         arguments << '--rev' << options[:commit]
@@ -422,12 +426,18 @@ module SCM
       user     = nil
       date     = nil
       summary  = nil
+      message  = nil
+      files    = nil
+
+      io = popen('hg log',*arguments)
+
+      until io.eof?
+        line = io.readline.chomp
 
-      popen('hg log',*arguments) do |line|
         if line.empty?
-          yield Commits::Hg.new(revision,hash,branch,user,date,summary)
+          yield Commits::Hg.new(revision,hash,branch,user,date,summary,message,files)
 
-          revision = hash = branch = user = date = summary = nil
+          revision = hash = branch = user = date = summary = message = files = nil
         else
           key, value = line.split(' ',2)
 
@@ -440,13 +450,36 @@ module SCM
             user = value
           when 'date:'
             date = Time.parse(value)
-          when 'summary:'
-            summary = value
+          when 'description:'
+            description = readlines_until(io)
+            summary     = description[0]
+            message     = description.join($/)
+          when 'files:'
+            files = value.split(' ')
           end
         end
       end
     end
 
+    #
+    # Lists the files of the Hg repository.
+    #
+    # @yield [file]
+    #   The given block will be passed each file.
+    #
+    # @yieldparam [String] file
+    #   A path of a file tracked by Hg.
+    #
+    # @return [Enumerator]
+    #   If no block is given, an Enumerator will be returned.
+    #
+    def files(&block)
+      return enum_for(:files) unless block
+
+      popen('hg','manifest',&block)
+      return nil
+    end
+
     protected
 
     #

data/lib/scm/repository.rb

@@ -311,6 +311,33 @@ module SCM
       @path.to_s
     end
 
+    #
+    # Inspects the Repository.
+    #
+    # @return [String]
+    #   The repository class name and path.
+    #
+    def inspect
+      "#<#{self.class}: #{@path}>"
+    end
+
+    #
+    # Lists the files of the repository.
+    #
+    # @yield [file]
+    #   The given block will be passed each file.
+    #
+    # @yieldparam [String] file
+    #   A path of a file within the repository.
+    #
+    # @return [Enumerator]
+    #   If no block is given, an Enumerator will be returned.
+    #
+    # @abstract
+    #
+    def files(&block)
+    end
+
     protected
 
     #

data/lib/scm/svn.rb

@@ -426,7 +426,7 @@ module SCM
     def commits(options={})
       return enum_for(:commits,options) unless block_given?
 
-      arguments = []
+      arguments = ['-v']
 
       if options[:commit]
         arguments << '--revision' << options[:commit]
@@ -443,7 +443,8 @@ module SCM
       revision = nil
       date     = nil
       author   = nil
-      summary  = ''
+      message  = ''
+      files    = []
 
       io = popen('svn log',*arguments)
 
@@ -451,28 +452,50 @@ module SCM
       io.readline
 
       until io.eof?
-        line = io.readline
-        line.chomp!
+        line = io.readline.chomp
 
         revision, author, date, changes = line.split(' | ',4)
         revision = revision[1..-1].to_i
-        date = Time.parse(date)
-
-        # eat the empty line separating the metadata from the summary
-        line.readline
+        date     = Time.parse(date)
 
-        loop do
-          line = io.readline
-          break if line == LOG_SEPARATOR
+        # eat the next line separating the metadata from the summary
+        line = io.readline.chomp
 
-          summary << line
+        if line == 'Changed paths:'
+          files = readlines_until(io)
         end
 
-        yield Commits::SVN.new(revision,date,author,summary)
+        description = readlines_until(io,LOG_SEPARATOR)
+        summary     = description[0]
+        message     = description.join($/)
+
+        yield Commits::SVN.new(revision,date,author,summary,message,files)
 
         revision = date = author = nil
-        summary = ''
+        message  = ''
+        files    = []
+      end
+    end
+
+    #
+    # Lists the files of the SVN repository.
+    #
+    # @yield [file]
+    #   The given block will be passed each file.
+    #
+    # @yieldparam [String] file
+    #   A path of a file tracked by SVN.
+    #
+    # @return [Enumerator]
+    #   If no block is given, an Enumerator will be returned.
+    #
+    def files
+      return enum_for(:files) unless block_given?
+
+      popen('svn','ls','-R') do |file|
+        yield file if File.file?(File.join(@path,file))
       end
+      return nil
     end
 
     protected

data/lib/scm/util.rb

@@ -20,6 +20,9 @@ module SCM
     def run(program,*arguments)
       arguments = arguments.map { |arg| arg.to_s }
 
+      # filter out empty Strings
+      arguments.reject! { |arg| arg.empty? }
+
       system(program.to_s,*arguments)
     end
 
@@ -61,5 +64,32 @@ module SCM
 
       return io
     end
+
+    #
+    # Read lines until a separator line is encountered.
+    #
+    # @param [IO] io
+    #   The IO stream to read from.
+    #
+    # @param [String] separator
+    #   The separator line to stop at.
+    #
+    # @return [Array<String>]
+    #   The read lines.
+    #
+    def readlines_until(io,separator='')
+      lines = []
+
+      until io.eof?
+        line = io.readline
+        line.chomp!
+
+        break if line == separator
+
+        lines << line
+      end
+
+      return lines
+    end
   end
 end

data/lib/scm/version.rb

@@ -1,4 +1,4 @@
 module SCM
   # SCM version
-  VERSION = "0.1.0.pre1"
+  VERSION = "0.1.0.pre2"
 end

data/spec/hg_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'scm/hg'
+
+describe Hg do
+  describe "create" do
+    it "should create the directory, if it does not exist" do
+      repo = Hg.create(directory('create_new_hg_repo'))
+
+      repo.path.should be_directory
+    end
+
+    it "should create a hg repository" do
+      repo = Hg.create(mkdir('init_hg_repo'))
+
+      repo.path.join('.hg').should be_directory
+    end
+
+    it "should raise an exception when :base is specified" do
+      lambda {
+        Hg.create(mkdir('init_bare_hg_repo'), :bare => true)
+      }.should raise_error
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scm
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre1
+  version: 0.1.0.pre2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-18 00:00:00.000000000Z
+date: 2011-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ore-tasks
-  requirement: &18110220 !ruby/object:Gem::Requirement
+  requirement: &12756120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *18110220
+  version_requirements: *12756120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18109620 !ruby/object:Gem::Requirement
+  requirement: &12755360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *18109620
+  version_requirements: *12755360
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &18109100 !ruby/object:Gem::Requirement
+  requirement: &12754740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *18109100
+  version_requirements: *12754740
 description: SCM is a simple Ruby library for interacting with common SCMs, such as
   Git, Mercurial (Hg) and SubVersion (SVN).
 email: postmodern.mod3@gmail.com
@@ -75,6 +75,7 @@ files:
 - scm.gemspec
 - spec/git_spec.rb
 - spec/helpers/scm.rb
+- spec/hg_spec.rb
 - spec/scm_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/postmodern/scm
@@ -98,10 +99,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.8
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby interface to common SCMs
 test_files:
 - spec/git_spec.rb
+- spec/hg_spec.rb
 - spec/scm_spec.rb
+has_rdoc: