jumanjiman_spec_helper 0.1.0 → 0.2.0

data/.repo/config

@@ -0,0 +1,38 @@
+#############################################################
+# vim: set ts=2 sw=2 ai et ruler:
+#
+# We are a cross-platform shop.
+# Do not allow OS personalities in this configuration.
+#
+# Note: This is not a dumping ground for personal preferences.
+#       Apply a minimal configuration to the local .git/config
+#       for consistency among authors.
+#       Be selective when adding parameters here.
+#       Do not usurp user preferences lightly.
+#
+# ref for gitconfig directives:
+# http://git-scm.com/docs/git-config
+#
+# also see:
+# http://nuclearsquid.com/writings/git-tricks-tips-workflows/
+# https://github.com/cypher/dotfiles
+#############################################################
+[core]
+autocrlf = false # preserve line endings (we're cross-platform)
+
+[branch]
+autosetuprebase = always # maintain linear history
+
+[push]
+default = tracking # push to tracking branch, not upstream
+
+[remote "upstream"]
+url = https://github.com/jumanjiman/jumanjiman_spec_helper.git
+fetch = +refs/heads/*:refs/remotes/upstream/*
+
+[alias]
+# use these when reviewing PRs
+authors = shortlog -sn
+behind  = !git log ..upstream/master --oneline
+ahead   = !git log upstream/master.. --oneline
+files   = !git diff --name-only upstream/master..

data/README.md

@@ -104,3 +104,99 @@ end
 
 That's it! Now environment variables are automatically
 cleaned up between rspec examples.
+
+### Git helper
+
+`JumanjimanSpecHelper::Git` adds...
+
+* a custom `repo_root` setting to the rspec configuration
+* a custom rake task to merge `.repo/config` into `.git/config`
+
+#### Discovery (Queries)
+
+You may want to discover the path to a repo.
+
+1. Add to `spec/spec_helper.rb`:
+
+   ```ruby
+   require 'jumanjiman_spec_helper/git'
+   ```
+
+2. Add to any spec:
+
+   ```ruby
+   require 'spec_helper'
+
+   # either...
+   absolute_path_to_repo = RSpec.configuration.repo_root
+
+   # or...
+   absolute_path_to_repo = JumanjimanSpecHelper::Git.repo_root
+   ```
+
+#### Configuration
+
+Perhaps you want to ensure every clone of your repo has
+a specific git configuration. You may want to ensure a
+linear history within the repo or provide a commit template
+to help authors use a specific local format. Specifically,
+assume you want to:
+
+* Provide a git commit template specific to the repo,
+  overriding system-wide or user-default setting
+
+* Replace `REPO_ROOT` with the actual path to the repo as it
+  exists on the user's workstation ("REPO_ROOT" gets replaced)
+
+* Set `autosetuprebase` as `always`,
+  overriding system-wide or user-default setting
+
+Steps:
+
+1. Add to `Rakefile`:
+
+   ```ruby
+   require 'jumanjiman_spec_helper/git'
+
+   # either merge the configs via method call...
+   JumanjimanSpecHelper::Git.update_git_config
+
+   # or add a task dependency, such as...
+   task :default => 'j:update_git_config' do |t|
+     # your normal default task code
+   end
+
+   # or...
+   RSpec::Core::RakeTask.new(:spec => 'j:update_git_config') do |t|
+     t.pattern = 'spec/*/*_spec.rb'
+   end
+   ```
+
+2. Create `.repo/config` with git configuration info, such as:
+
+   ```
+   [branch]
+   autosetuprebase = always # maintain linear history
+
+   [commit]
+   template = REPO_ROOT/.repo/commit.template # provide guidance
+   ```
+
+3. Create `.repo/commit.template`, such as:
+
+   ```
+   modulename: purpose
+   #========= your lines should not be wider than this ============
+   # modulename should be name of puppet module
+   # purpose should be high-level summary
+   # Use present tense: "do"; NOT "doing", "did", or "will"
+
+   # Request for Change number, "TBD", or "not required"
+   RFC:
+
+   # Briefly describe affected nodes/environments
+   Impacted area:
+
+   More info:
+   #========= your lines should not be wider than this ============
+   ```

data/Rakefile

@@ -8,6 +8,12 @@ JumanjimanSpecHelper::Bundle.setup :development
 # bundle skeleton
 require "bundler/gem_tasks"
 
+# add namespaced rake tasks
+require 'jumanjiman_spec_helper/git'
+
+# always keep clone config up-to-date
+JumanjimanSpecHelper::Git.update_git_config
+
 task :default do |t|
   puts %x!rake -T!
 end

data/jumanjiman_spec_helper.gemspec

@@ -28,9 +28,21 @@ Gem::Specification.new do |gem|
   # http://docs.rubygems.org/read/chapter/20#dependencies
   # http://docs.rubygems.org/read/chapter/20#development_dependencies
 
+  # these are needed for both dev and runtime
+  common_dependencies = {
+    'inifile' => '~> 2.0.2', # https://github.com/TwP/inifile
+    'minigit' => '~> 0.0.3', # https://github.com/3ofcoins/minigit
+    'rake'    => '>= 10.0',
+    'rspec'   => '2.12.0',
+  }
+  common_dependencies.each do |dep, ver|
+    gem.add_dependency             dep, ver
+    gem.add_development_dependency dep, ver
+  end
+
+  # these are only needed for dev
   gem.add_development_dependency 'rake', '>= 10.0'
   gem.add_development_dependency 'rspec-core', '2.12.2'
-  gem.add_development_dependency 'rspec', '2.12.0'
   gem.add_development_dependency 'rspec-expectations', '2.12.1'
   gem.add_development_dependency 'rspec-mocks', '2.12.2'
   # https://github.com/freerange/mocha#bundler

data/lib/jumanjiman_spec_helper.rb

@@ -2,6 +2,7 @@
 require "jumanjiman_spec_helper/version"
 require 'jumanjiman_spec_helper/bundle'
 require 'jumanjiman_spec_helper/environment_context'
+require 'jumanjiman_spec_helper/git'
 
 module JumanjimanSpecHelper
 end

data/lib/jumanjiman_spec_helper/git.rb

@@ -0,0 +1,50 @@
+# vim: set ts=2 sw=2 ai et ruler:
+require 'rake'
+require 'rspec'
+
+module JumanjimanSpecHelper
+  class Git
+    require 'inifile'
+    require 'minigit'
+
+    def self.repo_root
+      ENV['GIT_PAGER'] = '' # https://github.com/3ofcoins/minigit#issues
+      repo_root ||= MiniGit.new(Dir.pwd).git_work_tree
+    end
+
+    def self.config_data(path)
+      IniFile.new(:filename => path).read
+    end
+
+    def self.git_config_path
+      File.join(repo_root, '.git', 'config')
+    end
+
+    def self.repo_config_path
+      File.join(repo_root, '.repo', 'config')
+    end
+
+    def self.update_git_config
+      repo_data = config_data(repo_config_path)
+      if repo_data
+        git_data = config_data(git_config_path)
+        repo_data.each do |sect, param, val|
+          git_data[sect][param] = val.gsub(/REPO_ROOT/, repo_root)
+        end
+        i = IniFile.new(:filename => git_config_path).read.merge(git_data)
+        i.save
+      end
+    end
+  end
+end
+
+namespace :j do
+  desc 'Merge .repo/config into .git/config'
+  task :update_git_config do
+    JumanjimanSpecHelper::Git.update_git_config
+  end
+end
+
+RSpec.configure do |c|
+  c.add_setting 'repo_root', :default => JumanjimanSpecHelper::Git.repo_root
+end

data/lib/jumanjiman_spec_helper/version.rb

@@ -1,4 +1,4 @@
 # vim: set ts=2 sw=2 ai et ruler:
 module JumanjimanSpecHelper
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/fixtures/source.ini

@@ -0,0 +1,5 @@
+[unit test]
+foo = bar
+
+[commit]
+template = REPO_ROOT/.repo/commit.template

data/spec/fixtures/target.ini

@@ -0,0 +1,6 @@
+[branch "master"]
+remote = origin
+merge = refs/heads/master
+
+[commit]
+template = /etc/commit.template

data/spec/unit/config_spec.rb

@@ -0,0 +1,9 @@
+# vim: set ts=2 sw=2 ai et ruler:
+require 'spec_helper'
+
+describe '.repo/config' do
+  it 'does not use ssh for upstream remote' do
+    lines = MiniGit::Capturing.remote(:show, :upstream, :n => true).lines
+    /git@/.should_not match lines.grep(/Fetch URL/).first
+  end
+end

data/spec/unit/fixtures_spec.rb

@@ -0,0 +1,20 @@
+# vim: set ts=2 sw=2 ai et ruler:
+require 'spec_helper'
+
+fixtures_path = File.expand_path('../../fixtures', __FILE__)
+
+# Other rspec examples depend on the content of these fixtures,
+# so we detect accidental change that could cause side effects.
+describe 'spec/fixtures' do
+  fixtures = {
+    'source.ini'   => '403d536f49e2142ea9af9296e56c4f7f',
+    'target.ini'   => 'a9e7ac8cee79e417f31ec2a97201ba9c',
+  }
+
+  fixtures.each do |file, md5sum|
+    it "#{file} has the expected content" do
+      path = File.join(fixtures_path, file)
+      Digest::MD5.hexdigest(File.read(path)).should == md5sum
+    end
+  end
+end

data/spec/unit/git_spec.rb

@@ -0,0 +1,164 @@
+# vim: set ts=2 sw=2 ai et ruler:
+require 'spec_helper'
+require 'tmpdir'
+
+fixtures_path = File.expand_path('../../fixtures', __FILE__)
+
+describe 'JumanjimanSpecHelper::Git' do
+  before :each do
+    # create a random dir name for stubbing a root dir
+    @fake_repo_root = Dir.mktmpdir
+  end
+  after :each do
+    FileUtils.rm_rf @fake_repo_root
+  end
+
+  describe 'repo_root' do
+    before :each do
+      @repo_root = JumanjimanSpecHelper::Git.repo_root
+    end
+
+    it 'is an absolute path' do
+      Pathname.new(@repo_root).absolute?.should be_true
+    end
+
+    it 'contains .git dir' do
+      Dir.entries(@repo_root).include?('.git').should be_true
+    end
+
+    it 'is accessible as RSpec.configuration.repo_root' do
+      RSpec.configuration.method_exists?(:repo_root).should be_true
+    end
+
+    it 'RSpec.configuration.repo_root has correct value' do
+      RSpec.configuration.repo_root.should == @repo_root
+    end
+  end
+
+  describe 'git_config_path' do
+    before :each do
+      JumanjimanSpecHelper::Git.stubs(:repo_root).returns(@fake_repo_root)
+      @path = JumanjimanSpecHelper::Git.git_config_path
+    end
+
+    it 'is an absolute path' do
+      Pathname.new(@path).absolute?.should be_true
+    end
+
+    it 'returns path to .git/config' do
+      @path.should == File.join(@fake_repo_root, '.git', 'config')
+    end
+  end
+
+  describe 'repo_config_path' do
+    before :each do
+      JumanjimanSpecHelper::Git.stubs(:repo_root).returns(@fake_repo_root)
+      @path = JumanjimanSpecHelper::Git.repo_config_path
+    end
+
+    it 'is an absolute path' do
+      Pathname.new(@path).absolute?.should be_true
+    end
+
+    it 'returns path to .repo/config' do
+      @path.should == File.join(@fake_repo_root, '.repo', 'config')
+    end
+  end
+
+  describe 'config_data(path)' do
+    it 'returns nil if path does not exist' do
+      path = 'uhetansuhteoahutsheotsuhteoashutsanhoetusahtusha'
+      JumanjimanSpecHelper::Git.config_data(path).should be_nil
+    end
+
+    it 'returns ini data if path exists' do
+      path = File.join(fixtures_path, 'source.ini')
+      data = IniFile.new(:filename => path).read
+      data['unit test']['foo'].should == 'bar'
+    end
+  end
+
+  describe 'update_git_config' do
+    before :each do
+      # fixtures
+      @fix_source = File.join(fixtures_path, 'source.ini')
+      @fix_target = File.join(fixtures_path, 'target.ini')
+
+      # copy target to tmp dir
+      @tmpdir = Dir.mktmpdir
+      @tmp_target = File.join(@tmpdir, 'target.ini')
+      FileUtils.cp @fix_target, @tmp_target
+
+      # stub paths so we don't write target in repo
+      JumanjimanSpecHelper::Git.stubs(:git_config_path).returns(@tmp_target)
+      JumanjimanSpecHelper::Git.stubs(:repo_config_path).returns(@fix_source)
+
+      # stub repo_path
+      JumanjimanSpecHelper::Git.stubs(:repo_root).returns(@fake_repo_root)
+    end
+
+    after :each do
+      FileUtils.rm_rf @tmpdir
+    end
+
+    describe 'rake task' do
+      task_name = 'j:update_git_config'
+      task_path = File.join('lib', 'jumanjiman_spec_helper', 'git.rb')
+
+      it "is accessible as #{task_name}" do
+        Rake::Task.task_defined?(task_name).should be_true
+      end
+
+      it 'calls update_git_config method' do
+        # we stub the git config path above to protect against side effects
+        JumanjimanSpecHelper::Git.expects(:update_git_config)
+        Rake::Task[task_name].invoke
+      end
+    end
+
+    context 'when .repo/config does not exist' do
+      it 'does not change .git/config' do
+        # override stub
+        path = 'uhetansuhteoahutsheotsuhteoashutsanhoetusahtusha'
+        JumanjimanSpecHelper::Git.stubs(:repo_config_path).returns(path)
+
+        # update target
+        JumanjimanSpecHelper::Git.update_git_config
+
+        # target should not be changed
+        FileUtils.cmp(@fix_target, @tmp_target).should be_true
+      end
+    end
+
+    context 'when .repo/config exists' do
+      before :each do
+        # update target
+        JumanjimanSpecHelper::Git.update_git_config
+
+        # read target
+        @data = IniFile.new(:filename => @tmp_target).read
+      end
+
+      it 'modifies .git/config' do
+        FileUtils.cmp(@fix_target, @tmp_target).should be_false
+      end
+
+      it 'adds keys to .git/config' do
+        @data['unit test']['foo'].should == 'bar'
+      end
+
+      it 'overrides keys in .git/config' do
+        @data['commit']['template'].should =~ /\.repo/
+      end
+
+      it "substitutes 'REPO_ROOT' with real repo_root" do
+        path = File.join(@fake_repo_root, '.repo', 'commit.template')
+        @data['commit']['template'].should == path
+      end
+
+      it 'preserves keys in .git/config that are not in .repo/config' do
+        @data['branch "master"']['remote'] == 'origin'
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jumanjiman_spec_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,88 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-18 00:00:00.000000000 Z
+date: 2013-03-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: minigit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: minigit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -28,21 +108,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-core
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.12.2
-  type: :development
+        version: 2.12.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.12.2
+        version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,6 +139,38 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.2
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +243,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .repo/config
 - .travis.yml
 - CONTRIBUTING.md
 - Gemfile
@@ -141,9 +254,15 @@ files:
 - lib/jumanjiman_spec_helper.rb
 - lib/jumanjiman_spec_helper/bundle.rb
 - lib/jumanjiman_spec_helper/environment_context.rb
+- lib/jumanjiman_spec_helper/git.rb
 - lib/jumanjiman_spec_helper/version.rb
+- spec/fixtures/source.ini
+- spec/fixtures/target.ini
 - spec/spec_helper.rb
+- spec/unit/config_spec.rb
 - spec/unit/environment_context_spec.rb
+- spec/unit/fixtures_spec.rb
+- spec/unit/git_spec.rb
 - spec/unit/version_spec.rb
 homepage: ''
 licenses: []
@@ -159,7 +278,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1737154054071565292
+      hash: -2228649649261654348
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -168,7 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1737154054071565292
+      hash: -2228649649261654348
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -176,6 +295,11 @@ signing_key:
 specification_version: 3
 summary: Provides common rspec tests for Puppet modules
 test_files:
+- spec/fixtures/source.ini
+- spec/fixtures/target.ini
 - spec/spec_helper.rb
+- spec/unit/config_spec.rb
 - spec/unit/environment_context_spec.rb
+- spec/unit/fixtures_spec.rb
+- spec/unit/git_spec.rb
 - spec/unit/version_spec.rb