repo_manager 0.7.1

data/examples/pc_saved_game_backup/README.markdown

@@ -0,0 +1,108 @@
+Using RepoManager to Backup and Synchronize PC Game Saves
+=====================================================
+
+Use case:  Backup and synchronization of PC save games folders to a
+central repository (ie Drop Box folder) using Git.  Game saves are
+typically scattered across multiple folders and drives.
+
+This example demonstrates the following features:
+
+* Adding RepoManager user tasks, see repo_manager/tasks/
+* Adding destructive git commands to the default whitelisted non-destructive git commands
+* Testing user tasks with Cucumber, see repo_manager/features/
+* Relative paths (not absolute) in repo_manager/repo.conf making the folder portable
+* Bash completion for repo names, works on Win32 using Cygwin or MSYS Bash
+* Bash function to 'cd' into a repo's working folder
+
+
+Bootstrapping this example folder
+--------------------------------
+
+In order to try out the example commands below, you will need to bootstrap the
+sample data git repositories and create the configuration files using the
+following commands.  See [INSTALL.markdown](INSTALL.markdown) for a more
+complete explanation.
+
+    repo generate:remote mines --path=saved_games/mines/saves
+    repo generate:remote hearts --path=saved_games/hearts
+
+    repo add:asset saved_games/mines/saves --name=mines --force
+    repo add:asset saved_games/hearts --force
+
+
+Get information on configured saved game repositories
+-----------------------------------------------------
+
+    repo list --short
+    repo status --unmodified DOTS
+
+
+User tasks
+---------
+
+The task 'generate:remote' is a user task, it doesn't ship with RepoManager.
+
+To view all the available tasks
+
+    repo --tasks
+
+or just
+
+    repo -T
+
+### Running tests on user tasks
+
+    gem install bundler
+
+    cd repo_manager
+    bundle
+    bundle exec cucumber
+
+Backup
+------
+
+To backup the saved games, we will need another user task.  This on is called
+'action:update'.  See [repo_manager/tasks/update.rb](repo_manager/tasks/update.rb)
+
+    repo action:update
+
+Synchronize
+----------
+
+Synchronizing saved games to another PC can be accomplished using Git's 'pull' command.
+
+verify working folders are clean, if they are not, either revert them or commit and push
+
+    repo status
+
+pull from remote to all configured repos
+
+    repo pull
+
+Bash completion
+---------------
+
+Handy functions for use under Bash.  These work fine on Win32 using
+Git-Bash.
+
+* rcd: repo cd (change directory).  Wrapper for 'cd', allows for simple cd
+  <repo name> to the working folder on the filesystem referenced by the 'path'
+  configuration variable.
+* rpushd: repo pushd (push directory).  Wrapper for 'pushd'.
+
+Clean
+-----
+Resetting this example folder back to its shipping defaults
+
+### Delete the git repositories
+
+    rm -rf remote/hearts.git
+    rm -rf remote/mines.git
+
+    rm -rf saved_games/mines/saves/.git
+    rm -rf saved_games/hearts/.git
+
+### Remove the asset config files
+
+    rm -rf repo_manager/assets/mines
+    rm -rf repo_manager/assets/hearts

data/examples/pc_saved_game_backup/remote/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

data/examples/pc_saved_game_backup/repo_manager/Gemfile

@@ -0,0 +1,12 @@
+# this Gemfile is not required for RepoManager normal usage, it exists
+# to support testing tasks in the user 'tasks' folder
+source "http://rubygems.org"
+
+gem "repo_manager"
+
+gem "bundler", ">= 1.0.14"
+gem "rspec", ">= 2.6.0"
+gem "cucumber", "~> 1.0"
+gem "aruba", "= 0.4.5"
+
+gem "win32console", :platforms => [:mingw, :mswin]

data/examples/pc_saved_game_backup/repo_manager/Gemfile.lock

@@ -0,0 +1,66 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aruba (0.4.5)
+      bcat (>= 0.6.1)
+      childprocess (>= 0.1.9)
+      cucumber (>= 0.10.7)
+      rdiscount (>= 1.6.8)
+      rspec (>= 2.6.0)
+    bcat (0.6.2)
+      rack (~> 1.0)
+    builder (3.0.0)
+    childprocess (0.3.4)
+      ffi (~> 1.0, >= 1.0.6)
+    chronic (0.6.7)
+    cucumber (1.2.1)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.0)
+      json (>= 1.4.6)
+    diff-lcs (1.1.3)
+    ffi (1.1.0)
+    gherkin (2.11.1)
+      json (>= 1.4.6)
+    git (1.2.5)
+    json (1.7.4)
+    little-plugger (1.1.3)
+    logging (1.7.2)
+      little-plugger (>= 1.1.3)
+    mustache (0.99.4)
+    rack (1.4.1)
+    rdiscount (1.6.8)
+    repo_manager (0.7.1)
+      chronic (>= 0.6.5)
+      git (= 1.2.5)
+      logging (>= 1.6.2)
+      mustache (>= 0.99.4)
+      slim (>= 1.0.4)
+      term-ansicolor (>= 1.0.4)
+      thor (~> 0.15.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    slim (1.2.2)
+      temple (~> 0.4.0)
+      tilt (~> 1.3.3)
+    temple (0.4.0)
+    term-ansicolor (1.0.7)
+    thor (0.15.3)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (= 0.4.5)
+  bundler (>= 1.0.14)
+  cucumber (~> 1.0)
+  repo_manager
+  rspec (>= 2.6.0)
+  win32console

data/examples/pc_saved_game_backup/repo_manager/assets/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

data/examples/pc_saved_game_backup/repo_manager/features/support/aruba.rb

@@ -0,0 +1,15 @@
+require 'aruba/api'
+require 'fileutils'
+
+module Aruba
+  module Api
+
+    # override aruba avoid 'current_ruby' call and make sure
+    # that binary run on Win32 without the binstubs
+    def detect_ruby(cmd)
+      wrapper = which('repo')
+      cmd = cmd.gsub(/^repo/, "ruby -S #{wrapper}") if wrapper
+      cmd
+    end
+  end
+end

data/examples/pc_saved_game_backup/repo_manager/features/support/env.rb

@@ -0,0 +1,11 @@
+require 'repo_manager'
+require 'aruba/cucumber'
+require 'rspec/expectations'
+
+Before do
+  @aruba_timeout_seconds = 10
+end
+
+Before('@slow_process') do
+  @aruba_io_wait_seconds = 2
+end

data/examples/pc_saved_game_backup/repo_manager/features/support/steps.rb

@@ -0,0 +1,3 @@
+require 'repo_manager/test/base_steps'
+require 'repo_manager/test/asset_steps'
+require 'repo_manager/test/repo_steps'

data/examples/pc_saved_game_backup/repo_manager/features/tasks/update.feature

@@ -0,0 +1,144 @@
+@announce
+Feature: Automatically add, commit, and push multiple repos
+
+  This task will run:
+
+      repo add -A, repo commit, and repo push on all dirty repos
+
+  Examples
+
+    Interactive
+
+      repo action:update
+
+    Non-interactive
+
+      repo action:update --force
+
+    Filter repos
+
+      repo action:update --repos=repo1,repo2
+
+  Background: Test repositories and a valid config file
+    Given a repo in folder "test_path_1" with the following:
+      | filename         | status | content  |
+      | .gitignore       | C      |          |
+    And a repo in folder "test_path_2" with the following:
+      | filename         | status | content  |
+      | .gitignore       | C      |          |
+    And a file named "repo.conf" with:
+      """
+      ---
+      folders:
+        assets : repo/asset/configuration/files
+        tasks  : ../../tasks
+      commands:
+      - status
+      - log
+      - add
+      - commit
+      - push
+      """
+    And the folder "repo/asset/configuration/files" with the following asset configurations:
+      | name    | path         |
+      | test1   | test_path_1  |
+      | test2   | test_path_2  |
+
+
+  Scenario: No uncommitted changes
+    When I run `repo action:update`
+    Then its output should contain:
+      """
+      no changed repos
+      """
+
+  Scenario: Uncommitted changes filtered out with the '--repos' param
+    Given a repo in folder "test_path_1" with the following:
+      | filename         | status | content  |
+      | .gitignore       | M      | tmp/*    |
+    And a repo in folder "test_path_2" with the following:
+      | filename         | status | content  |
+      | .gitignore       | M      | tmp/*    |
+      | test             | ?      | test     |
+    And a repo in folder "my_clean_repo" with the following:
+      | filename         | status | content  |
+      | .gitignore       | C      | tmp/*    |
+    When I run `repo action:update --force --repos=my_clean_repo`
+    Then its output should contain:
+      """
+      no changed repos
+      """
+
+  Scenario: Uncommitted changes in multiple repos, non-interactive, custom commit message
+    Given a repo in folder "test_path_1" with the following:
+      | filename         | status | content  |
+      | .gitignore       | M      | tmp/*    |
+    And a repo in folder "test_path_2" with the following:
+      | filename         | status | content  |
+      | .gitignore       | M      | tmp/*    |
+      | test             | ?      | test     |
+    And the repo in folder "test_path_1" has a remote named "origin" in folder "test_path_1.remote.git"
+    And the repo in folder "test_path_2" has a remote named "origin" in folder "test_path_2.remote.git"
+    When I run `repo action:update --force --message="my custom commit message"`
+    Then its output should contain:
+      """
+      updating test1,test2
+      """
+    And its output should contain:
+      """
+      update finished
+      """
+    And its output should not contain:
+      """
+      failed
+      """
+    When I run `repo status --no-verbose`
+    Then the exit status should be 0
+    When I run `repo --no-verbose git log -1 --pretty=format:'%s' --repos test1`
+    Then its output should contain:
+      """
+      my custom commit message
+      """
+    Then its output should not contain:
+      """
+      automatic commit
+      """
+    When I run `repo push --no-verbose --repos test1`
+    Then its output should contain:
+      """
+      up-to-date
+      """
+
+  @slow_process
+  Scenario: Uncommitted changes in a single repo, interactive prompt to continue
+    And a repo in folder "test_path_2" with the following:
+      | filename         | status | content  |
+      | .gitignore       | M      | tmp/*    |
+      | test             | ?      | test     |
+    And the repo in folder "test_path_2" has a remote named "origin" in folder "test_path_2.remote.git"
+    When I run `repo action:update` interactively
+    And I type "y"
+    Then its output should contain:
+      """
+      updating test2
+      """
+    And its output should contain:
+      """
+      update finished
+      """
+    And its output should not contain:
+      """
+      failed
+      """
+    When I run `repo status --no-verbose`
+    Then the exit status should be 0
+    When I run `repo --no-verbose git log -1 --pretty=format:'%s' --repos test2`
+    Then its output should contain:
+      """
+      automatic commit
+      """
+    When I run `repo push --no-verbose --repos test2`
+    Then its output should contain:
+      """
+      up-to-date
+      """

data/examples/pc_saved_game_backup/repo_manager/global/default/asset.conf

@@ -0,0 +1,2 @@
+# defaults
+---

data/examples/pc_saved_game_backup/repo_manager/repo.conf

@@ -0,0 +1,64 @@
+---
+# default CLI options
+options:
+  color      : AUTO
+  verbose    : false
+  short      : false
+  unmodified : HIDE
+  match      : ALL
+  list       : ALL
+
+folders:
+
+  # main repo configuration files
+  assets  : assets
+
+  #
+  # repo user tasks, file extentions can be '.rb' or '.thor'
+  #
+  # @examples:
+  #
+  #     linux:
+  #
+  #         ~/.repoman/tasks
+  #
+  #     win32
+  #
+  #         c:/dat/condenser/tasks
+  #
+  tasks        : tasks
+
+# git commands must be whitelisted
+commands:
+- diff
+- grep
+- log
+- ls-files
+- show
+- status
+- push
+- add
+- commit
+
+logging:
+  loggers:
+    - name          : root
+      appenders:
+        - logfile
+        - stdout
+  appenders:
+    - type          : Stdout
+      name          : stdout
+      level         : info
+      layout:
+        type        : Pattern
+        pattern     : '%l %c : %m\n'
+        color_scheme: default
+    - type          : File
+      name          : logfile
+      level         : info
+      truncate      : true
+      filename      : 'repo.log'
+      layout:
+        type        : Pattern
+        pattern     : '[%d] %l %c : %m\n'