pear 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28a67c8113b82c9c71639c1ad69fcbde175d4ee3
+  data.tar.gz: 96b2002c7dd64684a68bda14e465b702b66e5ac4
+SHA512:
+  metadata.gz: f074c5d2a4df01c257e0dfb917251a092546cae8a0bb66b08bc58eabb881eb4dea8743c622e877e8565c4d7882547bf974a26fb47963e092945b53f1ce23a2ce
+  data.tar.gz: c8af44667f283240b22272ab95b847187b0f83034b41fb61cf20c1554e1f7a63af56a72fc3bc3e56c535401b0914856ffb44a44068dcaa2ccc5ec1101fc939c6

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+pear

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1-head

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Horacio Bertorello
+
+MIT License
+
+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

@@ -0,0 +1,48 @@
+PEAR(1) -- pair-programming tool for Git
+
+SYNOPSIS
+
+    pear -i, --init
+    pear -s, --start-session [initials ...]
+    pear -c, --clean
+
+DESCRIPTION
+
+    Pear helps you set pair-programming sessions with your co-workers.
+
+EXAMPLES
+
+    pear --init
+    pear --start-session hb,np
+    pear --clean
+
+OPTIONS
+
+    -i, --init
+          This command initializes Pear in your working directory (that must
+          be a Git repository), writing a sample configuration file named
+          `.pear.yml` on it. Of course, you can provide this configuration
+          file manually and skip this command.
+
+    -s, --start-session [initials ...]
+          This command starts the pair-programming session setting your
+          `user.name` and `user.email` Git configuration variables to
+          display properly all collaborators working on subsequent commits.
+
+          On the latest version, you must provide a list of registered
+          authors initials separated by commas. See EXAMPLES to check out
+          how this works.
+
+    -c, --clean
+          This commands removes the `user` section added by Pear from your
+          local Git repository configuration. It doesn't remove any global
+          configuration. Please, remember to re-set your local Git repository
+          configuration if you had one before running Pear.
+
+HISTORY
+
+    I wanted to design and build a tool that would help me do what I found
+    most exciting to do while working in teams: pair programming. So I started
+    pronouncing 'pair programming' a lot, specially 'pair'. Like, /peə(r)/.
+
+    Well, that's pretty much it.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+
+begin
+  require 'rspec/core/rake_task'
+  desc "Run the specs"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  puts "Unfortunately, it seems that RSpec is unavailable."
+end

data/bin/pear

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'pear'
+
+class PearOptionParser
+  def self.parse(args)
+    options_parser = OptionParser.new do |parser|
+      parser.on('-i',
+                '--init',
+                'Initialize Pear on the Git repository.') do
+        configuration = Pear::Configuration.new
+        configuration.write_sample_configuration
+
+        puts 'Writing sample configuration file... done.'
+      end
+
+      parser.on('-s',
+                '--start-session p1,p2,pN',
+                Array,
+                'Start pairing session.') do |pair|
+        pairing_session = Pear::PairingSession.new(participants: pair)
+        pairing_session.configure_repository
+
+        puts <<-MESSAGE
+Git has been reconfigured for your pairing session!
+Remember to run `pear -c` to end your pairing session.
+      MESSAGE
+      end
+
+      parser.on('-c',
+                '--clean',
+                'Clean leftovers from the Git repository.') do
+        runner = Pear::SystemRunner.new
+        runner.run("git config --remove-section user")
+
+        puts 'Done. Re-set your repository-specific user configuration at will.'
+      end
+
+      parser.on_tail('-v',
+                     '--version',
+                     'Shows current version.') do
+        puts Pear::VERSION
+      end
+
+      parser.on_tail('-h',
+                     '--help',
+                     'Shows this message.') do
+        puts parser
+      end
+    end
+
+    begin
+      options_parser.parse!(args)
+    rescue OptionParser::InvalidOption => invalid_option
+      puts invalid_option
+      abort('Please run `pear --help` to see the available commands.')
+    end
+  end
+end
+
+PearOptionParser.parse(ARGV)

data/lib/pear.rb

@@ -0,0 +1,9 @@
+require "yaml"
+
+require "pear/configuration"
+require "pear/pairing_session"
+require "pear/system_runner"
+require "pear/version"
+
+module Pear
+end

data/lib/pear/configuration.rb

@@ -0,0 +1,49 @@
+module Pear
+  class Configuration
+    CONFIG_FILE = '.pear.yml'
+
+    attr_reader :authors, :email
+
+    def write_sample_configuration
+      abort('This doesn\'t look like a Git repository.') \
+        unless Dir.exists?('.git')
+
+      abort('Whoa there! A configuration file is already present.') \
+        if File.exists?('.pear.yml')
+
+      File.write(CONFIG_FILE, <<-config)
+email: team@example.com
+authors:
+  - ad Alice Doe
+  - bd Bob Doe
+      config
+    end
+
+    def authors
+      @authors ||= \
+        configuration['authors'].each_with_object({}) do |author_data, hash|
+          author = Author.new(author_data)
+          hash[author.initials] = author.full_name
+      end
+    end
+
+    def email
+      @email ||= configuration['email']
+    end
+
+    private
+
+    def configuration
+      @configuration ||= YAML.load(File.open(CONFIG_FILE))
+    end
+  end
+
+  class Author
+    attr_reader :initials, :full_name
+
+    def initialize(author_data)
+      @initials, *full_name = author_data.split
+      @full_name = full_name.join(' ')
+    end
+  end
+end

data/lib/pear/pairing_session.rb

@@ -0,0 +1,59 @@
+module Pear
+  class PairingSession
+    attr_reader :participants, :runner
+
+    def initialize(participants:,
+                   configuration: Pear::Configuration.new,
+                   runner: Pear::SystemRunner.new)
+      @configuration = configuration
+      @runner = runner
+
+      set_session_participants(participants)
+    end
+
+    def configure_repository
+      if repository_already_configured?
+        abort('Already pairing! Run `pear -c` to start over.')
+      else
+        runner.run("git config --add user.name \'#{git_user_name}\'")
+        runner.run("git config --add user.email \'#{git_user_email}\'")
+      end
+    end
+
+    def git_user_name
+      to_sentence(session_participants_names)
+    end
+
+    def git_user_email
+      to_email(participants)
+    end
+
+    private
+
+    def set_session_participants(participants)
+      raise ArgumentError, 'Participants must be registered' \
+        unless participants.all? { |p| @configuration.authors.key?(p) }
+      @participants = participants
+    end
+
+    def repository_already_configured?
+      runner.run("git config --get-all user.name").split(/\n/).any? do |name|
+        name == git_user_name
+      end
+    end
+
+    def session_participants_names
+      participants.map { |p| @configuration.authors[p] }
+    end
+
+    def to_sentence(full_names)
+      last_name = full_names.pop
+      [full_names.join(', '), last_name].join(' and ')
+    end
+
+    def to_email(initials)
+      team, domain = @configuration.email.split('@')
+      "#{team}+#{initials.join('-')}@#{domain}"
+    end
+  end
+end

data/lib/pear/system_runner.rb

@@ -0,0 +1,7 @@
+module Pear
+  class SystemRunner
+    def run(command)
+      %x(#{command}).strip
+    end
+  end
+end

data/lib/pear/version.rb

@@ -0,0 +1,3 @@
+module Pear
+  VERSION = "0.0.1"
+end

data/pear.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pear/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pear"
+  spec.version       = Pear::VERSION
+  spec.authors       = ["Horacio Bertorello"]
+  spec.email         = ["syrii@msn.com"]
+  spec.summary       = %q{Pear is a simple pair-programmint tool for teams.}
+  spec.homepage      = "https://github.com/svankmajer/pear"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/spec/pear_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Pear do
+  before do
+    allow(File).to receive(:open).and_return(<<-config)
+email: team@example.com
+authors:
+  - hb Horacio Bertorello
+  - mp Markus Persson
+    config
+  end
+
+  describe Pear::Configuration do
+    subject(:configuration) { Pear::Configuration.new }
+
+    describe '#configuration' do
+      it 'contains an Hash of registered authors' do
+        expect(configuration.authors).to \
+          match('hb' => 'Horacio Bertorello', 'mp' => 'Markus Persson')
+      end
+
+      it 'contains a custom team email address' do
+        expect(configuration.email).to be_a(String)
+      end
+    end
+  end
+
+  describe Pear::PairingSession do
+    describe '.new' do
+      it 'fails without a list of initials from registered authors' do
+        expect { Pear::PairingSession.new(participants: %w(mm sw)) }.to \
+          raise_error(ArgumentError, 'Participants must be registered')
+      end
+    end
+
+    context 'valid pairing session' do
+      subject(:session) do
+        Pear::PairingSession.new(participants: %w(hb mp))
+      end
+
+      describe '#git_user_name' do
+        it 'returns a compound user name for the participants' do
+          expect(session.git_user_name).to \
+            eq('Horacio Bertorello and Markus Persson')
+        end
+      end
+
+      describe '#git_user_email' do
+        it 'returns a compound user email addres for the participants' do
+          expect(session.git_user_email).to \
+            eq('team+hb-mp@example.com')
+        end
+      end
+
+      describe '#configure_repository' do
+        subject(:session) do
+          Pear::PairingSession.new(
+            participants: %w(hb mp),
+            runner: instance_double('Pear::SystemRunner')
+          )
+        end
+
+        it 'configures the repository for a pairing session' do
+          expect(session.runner).to receive(:run)
+            .with("git config --get-all user.name")
+            .and_return("Horacio Bertorello\n")
+
+          expect(session.runner).to receive(:run).with \
+            "git config --add user.name 'Horacio Bertorello and Markus Persson'"
+
+          expect(session.runner).to receive(:run).with \
+            "git config --add user.email 'team+hb-mp@example.com'"
+
+          session.configure_repository
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'pear'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+   expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+ config.mock_with :rspec do |mocks|
+   mocks.verify_partial_doubles = true
+   mocks.verify_doubled_constant_names = true
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: pear
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Horacio Bertorello
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- syrii@msn.com
+executables:
+- pear
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README
+- Rakefile
+- bin/pear
+- lib/pear.rb
+- lib/pear/configuration.rb
+- lib/pear/pairing_session.rb
+- lib/pear/system_runner.rb
+- lib/pear/version.rb
+- pear.gemspec
+- spec/pear_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/svankmajer/pear
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Pear is a simple pair-programmint tool for teams.
+test_files:
+- spec/pear_spec.rb
+- spec/spec_helper.rb