gitmethere 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a9e37922446adc92aac3e9d7f4d5757342f7399
-  data.tar.gz: 8d1c993adcd6089e943a82d1879395082a60f491
+  metadata.gz: 49ea805052840c2b1178ac266fd630082582c77b
+  data.tar.gz: 5d0bbd16dbced3a15fb28cf0ec8fb41e1b49943e
 SHA512:
-  metadata.gz: d5ad9bcd14a47774e5dcaea24dd11c43912398307794d858485e436e0842e7c4fbd0878e8077c0208891cd54c649b2cfbbeb77033b52033e7084665d278481d7
-  data.tar.gz: d0d3dc30f37f5aa12fec4f21702cbc978116db01245321ca789c8667bcdf57cefd89f8770e840660390cb649641581a13a2de2156dc853fa8f557a5781686adc
+  metadata.gz: 2a4360076415dc645893f5cded03dc668b4ec72530a0dca0d98ec90dfe60a7f4aea9b31956a16349eaa760dbe5c722edf106763f8b647e7495917a0e48d3dfae
+  data.tar.gz: e59082cb5abaf3dbc267934c69ad4a54412096170a5475db3329a531be35ee914898a30884569401935bfeb1fbd486e24ca2e55c594fe4ca2b9935f60c669acb

data/README.md

@@ -26,10 +26,13 @@ setup = {
     This repository demonstrates how merge conflicts occur."
 }
 
-scenario = GitMeThere::Scenario.new(name = setup['name'], explanation = setup['explanation'])
+scenario = GitMeThere::Scenario.new(name = setup[:name], explanation = setup[:explanation])
+other_author = GitMeThere::Author.new("Other Developer", "test@example.com")
 
 scenario.checkout_branch('feature')
 
+scenario.pause("Pausing between steps for an explanation...")
+
 scenario.append_to_file(
   file="README.md",
   content="A feature branch was created off of the `Initial commit`.
@@ -38,7 +41,7 @@ scenario.append_to_file(
 
 scenario.stage_changes
 
-scenario.commit('Add line to feature branch.')
+scenario.commit('Add line to feature branch.', author=other_author)
 
 scenario.checkout_branch('master')
 

data/lib/gitmethere/author.rb

@@ -0,0 +1,14 @@
+module GitMeThere
+  class Author
+    attr_reader :name, :email
+
+    def initialize(name, email)
+      @name = name
+      @email = email
+    end
+
+    def git_author
+      "#{name} <#{email}>"
+    end
+  end
+end

data/lib/gitmethere/version.rb

@@ -1,3 +1,3 @@
 module Gitmethere
-  VERSION = "0.1.0"
+  VERSION = "0.1.3"
 end

data/lib/gitmethere.rb

@@ -1,12 +1,14 @@
 require "gitmethere/version"
+require "gitmethere/author"
 
 require 'git'
+require 'io/console'
 
 module GitMeThere
 
   class Scenario
 
-    # All scenarios are automatically generated as a fresh repositorywith a README.md file
+    # All scenarios are automatically generated as a fresh repository with a README.md file
     # and an initial commit on the master branch.
     #
     # If an explanation is specified, it will be included as README.md text in the first commit.
@@ -19,6 +21,10 @@ module GitMeThere
     #   name: (String)
     #   explanation: (String)
     #
+
+    # Give direct access to the Git::Base object in a scenario
+    attr_accessor :g
+
     def initialize(name="my-scenario", explanation="")
       @name = name
       @g = Git.init(name)
@@ -50,8 +56,25 @@ module GitMeThere
       end
     end
 
-    def commit(message)
-      @g.commit(message)
+    def commit(message, author = nil)
+      if author.nil?
+        @g.commit(message)
+      else
+        @g.commit(message, author: author.git_author)
+      end
+    end
+
+    def pause(message = nil)
+      STDIN.echo = false
+      if message
+        puts message
+      end
+      puts "Press any key to continue..."
+      input = STDIN.getch
+
+    ensure
+      STDIN.ioflush
+      STDIN.echo = true
     end
 
   end

data/spec/gitmethere/author_spec.rb

@@ -0,0 +1,27 @@
+require 'gitmethere'
+require 'fakefs/spec_helpers'
+
+RSpec.describe GitMeThere::Author do
+
+  before(:each) do
+    @author = GitMeThere::Author.new("Test User", "test@example.com")
+  end
+
+  describe ".new()" do
+
+    it "should create an author with the specified name and email" do
+      expect(@author.name).to eq("Test User")
+      expect(@author.email).to eq("test@example.com")
+    end
+
+  end
+
+  describe ".git_author()" do
+
+    it 'should return a valid git author identifier (name <email>)' do
+      expect(@author.git_author).to eq("Test User <test@example.com>")
+    end
+
+  end
+
+end

data/spec/scenario_spec.rb

@@ -54,6 +54,18 @@ RSpec.describe GitMeThere::Scenario do
 
   end
 
+  describe ".g" do
+
+    before(:each) do
+      @scenario = GitMeThere::Scenario.new()
+    end
+
+    it 'should return Git::Base object' do
+      expect(@scenario.g.class).to eq(Git::Base)
+    end
+
+  end
+
   describe ".create_file()" do
 
     before(:each) do
@@ -149,6 +161,19 @@ RSpec.describe GitMeThere::Scenario do
       @scenario.commit("Testing the commit function")
       expect(@scenario.instance_variable_get(:@g).log.first.message).to eq("Testing the commit function")
     end
+
+    it "with message and author" do
+      author = GitMeThere::Author.new("Test User", "test@example.com")
+      @scenario.create_file(
+        name = "test-commit-file",
+        content = "commit this file."
+      )
+      @scenario.stage_changes
+      @scenario.commit("Testing the commit function with a different user", author)
+      expect(@scenario.instance_variable_get(:@g).log.first.message).to eq("Testing the commit function with a different user")
+      expect(@scenario.instance_variable_get(:@g).log.first.author.name).to eq(author.name)
+      expect(@scenario.instance_variable_get(:@g).log.first.author.email).to eq(author.email)
+    end
   end
 
   after(:each) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitmethere
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Allen Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2017-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,7 +98,9 @@ files:
 - Rakefile
 - gitmethere.gemspec
 - lib/gitmethere.rb
+- lib/gitmethere/author.rb
 - lib/gitmethere/version.rb
+- spec/gitmethere/author_spec.rb
 - spec/scenario_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/loranallensmith/gitmethere
@@ -121,10 +123,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A tool for demonstrating Git scenarios
 test_files:
+- spec/gitmethere/author_spec.rb
 - spec/scenario_spec.rb
 - spec/spec_helper.rb