ed 0.4.0 → 0.5.0

data/README.md

@@ -13,7 +13,7 @@ __DESCRIPTION__
 
   A Domain Specific Language(DSL) that you can use to talk to Git from Ruby.  
   It isn't intended to be a full interface to Git, but a very small subset of  
-  one that you can use to check out commits and then run Ruby code in the 
+  one that you can use to check out commits and then run Ruby code in the  
   context of those commits.
 
   So, for example, you might want to check out tag 'v0.1.0' and tag 'v0.2.0' to   

data/examples/benchmark.rb

@@ -1,25 +1,21 @@
 require "ed"
 require "benchmark"
 
-Repository "git://github.com/robgleeson/barney.git" do  
-  before do |path|
+Repository "git://github.com/robgleeson/barney.git" do
+  before :each do |path|
     $: << File.join(path, "lib/")
-    require "barney" 
+    require "barney"
   end
 
   tag "0.1.0" do
-    Benchmark.bm do |r| 
-      r.report("0.1.0") {
-        Barney::Share.new
-      }
+    Benchmark.bm do |r|
+      r.report("0.1.0") { Barney::Share.new }
     end
   end
 
   tag "0.2.0" do
-    Benchmark.bm do |r| 
-      r.report("0.2.0") {
-        Barney::Share.new
-      }
+    Benchmark.bm do |r|
+      r.report("0.2.0") { Barney::Share.new }
     end
   end
 end

data/examples/pry.rb

@@ -1,10 +1,10 @@
 require "ed"
 require "pry"
 
-Repository "git://github.com/robgleeson/barney.git" do  
-  before do |path|
+Repository "git://github.com/robgleeson/barney.git" do
+  before :each do |path|
     $: << File.join(path, "lib/")
-    require "barney" 
+    require "barney"
   end
 
   tag "0.1.0" do

data/lib/ed.rb

@@ -3,13 +3,13 @@ require 'ed/version'
 require 'ed/env'
 require 'ed/config'
 require 'ed/repository'
-require 'ed/context'
+require 'ed/delegator'
 require 'ed/core_ext/object'
 
 class Ed
 
   include Observe
-    
+
   #
   # @example
   #   Ed.configure do |config|
@@ -17,7 +17,7 @@ class Ed
   #   end
   #
   # @yieldparam config
-  #   (see Ed::Config.change) 
+  #   (see Ed::Config.change)
   #
   # @return [void]
   #
@@ -32,52 +32,55 @@ class Ed
   # @yieldparam [Ed] _self
   #   Yields self, if a block is given.
   #
-  # @return [Ed] 
+  # @return [Ed]
   #
   def initialize path
     @repo = Ed::Repository.new(path)
 
-    if block_given? 
+    if block_given?
       yield self
     end
   end
 
   #
   # @param [Proc] block
-  #   A block executed before {#commit}, {#branch}, or {#tag} is called. 
+  #   Executed before the block for {#commit}, {#tag} or #{branch} is run.
   #
   # @yieldparam [String] path
   #   The path to the repository on local disk.
   #
   # @return [void]
   #
-  def before &block
+  def before stage, &block
     add_observer(:before_filter, &block)
   end
 
   #
-  # @param [String] commit 
-  #   A string you can pass to 'git checkout'.
+  # @param [String] commit
+  #   A valid git commit, or git commit reference(tag or branch name).
   #
   # @param [Proc] block
-  #   A block executed while the repository has switched to 'commit'.
+  #   Executed while the repository has switched to 'commit'.
   #
   # @yieldparam [String] path
   #   The path to the repository on local disk.
   #
-  # @return [void] 
+  # @return [void]
   #
   def commit commit, &block
-    if Ed::Config.fork? 
-      pid = fork { switch(commit, &block) }
-      Process.wait(pid) 
+    if Ed::Config.fork?
+      pid = fork do
+        switch(commit, &block)
+      end
+
+      Process.wait(pid)
     else
       switch(commit, &block)
     end
   end
   alias_method :tag   , :commit
   alias_method :branch, :commit
- 
+
   #
   # Switches to 'commit', and runs &block.
   #
@@ -87,10 +90,10 @@ class Ed
   # @param block
   #   (see Ed#commit)
   #
-  def switch(commit, &block)
-    @repo.checkout '-q', commit 
+  def switch commit, &block
+    @repo.checkout '-q', commit
     notify_observers(:before_filter, @repo.path)
-    block.call(@repo.path) 
+    block.call(@repo.path)
   end
   private :switch
 

data/lib/ed/config.rb

@@ -1,21 +1,21 @@
 require 'pathname'
 
-module Ed::Config 
-  
-  class << self 
+module Ed::Config
+
+  class << self
 
     #
     # @yieldparam [Ed::Config] config
     #   Yields {Ed::Config}.
     #
     # @example
-    #   
+    #
     #   Ed::Config.change do |config|
     #     config.fork = false
     #   end
     #
-    def change 
-      yield self 
+    def change
+      yield self
     end
 
     #
@@ -29,16 +29,16 @@ module Ed::Config
     end
 
     #
-    # @return [Pathname] 
+    # @return [Pathname]
     #   The path being used to store cloned repositories.
     #
     def repo_dir
       @repo_dir
     end
-    
+
     #
     # @param [Boolean] value
-    #   Enable or disable the creation of a subprocess before checking out a commit.
+    #   Enable or disable the creation of a subprocess to check out a commit.
     #
     # @return [Boolean]
     #
@@ -52,7 +52,7 @@ module Ed::Config
 
     #
     # @return [Boolean]
-    #   Returns true if a subprocess is created before checking out a commit. 
+    #   Returns true if a subprocess is created to check out a commit.
     #
     def fork
       @fork

data/lib/ed/core_ext/object.rb

@@ -1,13 +1,12 @@
 #
-# @param [String] path 
-#   The path to the repository.
+# @param [String] path
+#   The URI to a git repository.
 #
-# @param [Proc] block
-#   A block executed in the calling scope, or within {Ed::Context}. 
+# @param [Proc] &block
+#   Executed in the calling scope, or within the scope of {Ed::Delegator}.
 #
 # @yieldparam [Ed] repo
-#   Yields instance of {Ed}.  
-#   If not given, 'block' is run through instance_eval on {Ed::Context} instead.
+#   Optionally yields an instance of {Ed}.
 #
 # @return [void]
 #
@@ -15,7 +14,8 @@ def Repository path, &block
   if block.arity == 1
     block.call Ed.new(path)
   else
-    Ed::Context.new(path, &block) 
+    delegator = Ed::Delegator.new Ed.new(path)
+    delegator.instance_eval(&block)
   end
 end
 

data/lib/ed/{context.rb → delegator.rb}

@@ -1,19 +1,22 @@
-class Ed::Context 
+class Ed::Delegator
 
-  def initialize path, &block
-    @__ed__ = Ed.new(path) 
-    instance_eval(&block)
+  #
+  # @param [Ed] delegate
+  #   An instance of {Ed}.
+  #
+  def initialize delegate
+    @__delegate__ = delegate
   end
 
   #
   # @param block
   #   (see Ed#before)
   #
-  # @return 
-  #   (see Ed#before) 
+  # @return
+  #   (see Ed#before)
   #
   def before &block
-    @__ed__.before(&block)
+    @__delegate__.before(&block)
   end
 
   #
@@ -23,11 +26,11 @@ class Ed::Context
   # @param block
   #   (see Ed#commit)
   #
-  # @return 
-  #   (see Ed#commit) 
+  # @return
+  #   (see Ed#commit)
   #
   def commit commit, &block
-    @__ed__.commit(commit, &block)
+    @__delegate__.commit(commit, &block)
   end
   alias_method :tag   , :commit
   alias_method :branch, :commit

data/lib/ed/env.rb

@@ -1,6 +1,7 @@
 module Ed::Env
 
   class << self
+
     #
     # @return [Boolean]
     #   Are we on Windows?
@@ -8,7 +9,7 @@ module Ed::Env
     def windows?
       RUBY_PLATFORM['mswin32'] ||
       RUBY_PLATFORM['mingw']   ||
-      RUBY_PLATFORM['cygwin']  
+      RUBY_PLATFORM['cygwin']
     end
 
     #

data/lib/ed/version.rb

@@ -1,3 +1,3 @@
 class Ed
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/test/test_ed.rb

@@ -1,20 +1,20 @@
 context Ed do
 
   context 'When given a git:// URI.' do
-    before do 
-      @ed   = Ed.new "git://github.com/robgleeson/barney.git"
-      @repo = @ed.instance_variable_get(:@repo)  
+    before do
+      @ed   = Ed.new "git://github.com/robgleeson/IProcess.git"
+      @repo = @ed.instance_variable_get(:@repo)
     end
 
     it 'must clone and store the repository locally.' do
-      File.exists?(@repo.path).must_equal(true)   
+      File.exists?(@repo.path).must_equal(true)
     end
 
     it 'must checkout the "0.1.0" tag.' do
       Tempfile.open "assertion" do |tmpfile|
-        @ed.before do |path|
+        @ed.before :each do |path|
           $: << File.join(path, "lib")
-          require 'thread'  
+          require 'thread'
           require 'barney'
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ed
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-05 00:00:00.000000000 Z
+date: 2012-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: observe
-  requirement: &70219235715720 !ruby/object:Gem::Requirement
+  requirement: &70336276945460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70219235715720
+  version_requirements: *70336276945460
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70219235715200 !ruby/object:Gem::Requirement
+  requirement: &70336276944900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70219235715200
+  version_requirements: *70336276944900
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70219235714740 !ruby/object:Gem::Requirement
+  requirement: &70336276944340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70219235714740
+  version_requirements: *70336276944340
 description: A Domain Specific Language(DSL) that you can use to talk to Git from
   Ruby.
 email:
@@ -64,8 +64,8 @@ files:
 - examples/test-suite.rb
 - lib/ed.rb
 - lib/ed/config.rb
-- lib/ed/context.rb
 - lib/ed/core_ext/object.rb
+- lib/ed/delegator.rb
 - lib/ed/env.rb
 - lib/ed/repository.rb
 - lib/ed/version.rb
@@ -85,7 +85,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1787377853303757998
+      hash: 4104525377091588512
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -94,10 +94,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1787377853303757998
+      hash: 4104525377091588512
 requirements: []
 rubyforge_project: Ed
-rubygems_version: 1.8.11
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A Domain Specific Language(DSL) that you can use to talk to Git from Ruby.