briefcase 0.4.0 → 0.4.1

data/README.md

@@ -0,0 +1,34 @@
+# Briefcase
+
+[Briefcase](http://jim.github.com/briefcase/) is a tool to facilitate keeping dotfiles in git, including those with private information (such as .gitconfig).
+
+By keeping your configuration files in a git public git repository, you can share your settings with others. Any secret information is kept in a single file outside the repository (it’s up to you to backup and transport this file).
+
+[The project homepage](http://jim.github.com/briefcase/) includes
+installation and usage documentation.
+
+[![Build Status](https://secure.travis-ci.org/jim/briefcase.png)](http://travis-ci.org/jim/briefcase)
+
+## Changelog
+
+* 0.4.1 Git command now properly passes options through to git, and also allows
+        git output to display in color.
+
+        Path environment variables inherit settings for parent directories.
+* 0.4.0 Renamed project to Briefcase. First public release.
+* 0.3.0 Added code documentation, internal renaming, general cleanup. First public release.
+* 0.2.0 Added redact command, use .redacted for dynamic dotfiles
+* 0.1.3 The sync command no longer creates symlinks for dynamic files
+* 0.1.2 Added dynamic file generation
+
+## Note on Patches/Pull Requests
+* Fork the project.
+* Make your feature addition or bug fix on a topic branch.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request.
+
+## Copyright
+
+Copyright (c) 2012 Jim Benton. See LICENSE for details.

data/briefcase.gemspec

@@ -10,21 +10,18 @@ Gem::Specification.new do |s|
   s.default_executable = %q{briefcase}
   s.email = %q{jim@autonomousmachine.com}
   s.executables = ["briefcase"]
-  s.extra_rdoc_files = %w{README.rdoc LICENSE}
   s.files = Dir['lib/**/*.rb'] +                                # library
             Dir['bin/*'] +                                      # executable
             Dir['spec/**/*.rb'] +                               # spec files
             Dir['spec/bin/editor'] +                            # spec editor
-            %w{README.rdoc LICENSE briefcase.gemspec Rakefile}  # misc
+            %w{README.md LICENSE briefcase.gemspec Rakefile}    # misc
 
   s.homepage = %q{http://github.com/jim/briefcase}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.test_files = Dir['spec/*.rb']
 
   s.add_runtime_dependency('commander')
-  s.add_runtime_dependency('activesupport')
   s.add_development_dependency('minitest')
   s.add_development_dependency('open4')
   s.add_development_dependency('rake', '0.9.2.2')

data/lib/briefcase/commands/git.rb

@@ -28,7 +28,8 @@ module Briefcase
       private
 
       def run_git_command(command)
-        puts `cd #{dotfiles_path} && git #{command}`
+        $stdout.flush
+        exec "cd #{dotfiles_path} && git #{command}"
       end
 
     end

data/lib/briefcase/main.rb

@@ -1,6 +1,17 @@
-require 'commander/import'
+require 'highline/import'
 require File.expand_path('../briefcase', File.dirname(__FILE__))
 
+# In the case of the git passthrough command, we want to pass the complete command
+# off to git so the options aren't mangled by Commander.
+#
+# Initializing a Briefcase::Commands::Git object will eventually call out to
+# git using exec, so this script will be aborted.
+if ARGV[0] == 'git'
+  Briefcase::Commands::Git.new(ARGV[1..-1], {})
+end
+
+require 'commander/import'
+
 program :name, 'Briefcase'
 program :version, Briefcase::VERSION
 program :description, 'Makes it easier to keep dotfiles in git'
@@ -29,10 +40,11 @@ command :generate do |c|
   c.when_called Briefcase::Commands::Generate
 end
 
+# This is a placeholder so that this command appears in the documentation. Any git
+# passthrough commands are caught earlier in this file.
 command :git do |c|
   c.syntax = 'briefcase git [options]'
   c.description = 'Run a git command in the dotfiles directory'
-  c.when_called Briefcase::Commands::Git
 end
 
 default_command :help

data/lib/briefcase/version.rb

@@ -1,3 +1,3 @@
 module Briefcase
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

data/lib/briefcase.rb

@@ -1,34 +1,38 @@
 require 'yaml'
 
-require 'active_support/core_ext/hash/deep_merge'
-
 require File.expand_path('briefcase/commands', File.dirname(__FILE__))
 require File.expand_path('briefcase/version', File.dirname(__FILE__))
 
 module Briefcase
 
-  # The user's home path
-  DEFAULT_HOME_PATH = '~'
+  class << self
+    attr_accessor :dotfiles_path, :home_path, :secrets_path, :testing
 
-  # The default path wher dotfiles are stored
-  DEFAULT_DOTFILES_PATH = File.join(DEFAULT_HOME_PATH, '.dotfiles')
+    # The user's home path
+    def default_home_path
+      '~'
+    end
 
-  # The default path to where secret information is stored
-  DEFAULT_SECRETS_PATH = File.join(DEFAULT_HOME_PATH, '.briefcase_secrets')
+    # The default path where dotfiles are stored
+    def default_dotfiles_path
+      File.join(home_path, '.dotfiles')
+    end
 
-  class << self
-    attr_accessor :dotfiles_path, :home_path, :secrets_path, :testing
+    # The default path to where secret information is stored
+    def default_secrets_path
+      File.join(home_path, '.briefcase_secrets')
+    end
 
     def dotfiles_path
-      @dotfiles_path ||= File.expand_path(ENV['BRIEFCASE_DOTFILES_PATH'] || DEFAULT_DOTFILES_PATH)
+      @dotfiles_path ||= File.expand_path(ENV['BRIEFCASE_DOTFILES_PATH'] || default_dotfiles_path)
     end
 
     def home_path
-      @home_path ||= File.expand_path(ENV['BRIEFCASE_HOME_PATH'] || DEFAULT_HOME_PATH)
+      @home_path ||= File.expand_path(ENV['BRIEFCASE_HOME_PATH'] || default_home_path)
     end
 
     def secrets_path
-      @secrets_path ||= File.expand_path(ENV['BRIEFCASE_SECRETS_PATH'] || DEFAULT_SECRETS_PATH)
+      @secrets_path ||= File.expand_path(ENV['BRIEFCASE_SECRETS_PATH'] || default_secrets_path)
     end
 
     def testing?

data/spec/git_spec.rb

@@ -11,7 +11,7 @@ describe Briefcase::Commands::Git do
     cleanup_dotfiles_directory
   end
 
-  it "creates links to existing files" do
+  it "passes commands through to git" do
     create_file(dotfiles_path + '/test.txt', 'testing git integration')
     run_command("git status")
 

data/spec/helpers/files.rb

@@ -28,7 +28,7 @@ def cleanup_home_directory
 end
 
 def create_git_repo
-  mkdir_p(File.join(dotfiles_path, '.git'))
+  `cd #{dotfiles_path} && git init`
 end
 
 def create_dotfiles_directory

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: briefcase
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Jim Benton
@@ -32,7 +32,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: minitest
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -43,10 +43,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: minitest
+  name: open4
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -59,24 +59,10 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: open4
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -89,11 +75,11 @@ dependencies:
         - 2
         version: 0.9.2.2
   type: :development
-  version_requirements: *id005
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: turn
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -103,16 +89,15 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id006
+  version_requirements: *id005
 description: Command line program to migrate dotfiles to a git repo at ~/.dotfiles and generate static dotfiles with secret values.
 email: jim@autonomousmachine.com
 executables: 
 - briefcase
 extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
-- LICENSE
+extra_rdoc_files: []
+
 files: 
 - lib/briefcase/commands/base.rb
 - lib/briefcase/commands/core/files.rb
@@ -138,7 +123,7 @@ files:
 - spec/spec_helper.rb
 - spec/sync_spec.rb
 - spec/bin/editor
-- README.rdoc
+- README.md
 - LICENSE
 - briefcase.gemspec
 - Rakefile
@@ -146,8 +131,8 @@ homepage: http://github.com/jim/briefcase
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/README.rdoc

@@ -1,104 +0,0 @@
-= briefcase
-
-briefcase is a tool to facilitate keeping dotfiles in git, including those with private information (such as .gitconfig).
-
-
-=== This is alpha software! I haven't published a gem yet for a good reason. Use at your own risk.
-
-
-== Getting started
-
-  gem install briefcase
-  briefcase import ~/.bashrc
-
-At this point, a git repository will have been created at ~/.dotfiles. At some point more of the git workflow will be automated (such as creating a repository at Github), but for now most git tasks are manual:
-
-  cd ~/.dotfiles
-  git commit -m "Added bashrc"
-
-== Filesystem layout
-
-With briefcase, dotfiles are stored in a centralized location (by default ~/.dotfiles), and symlinks are created for these files in the user's home directory. Here is a basic setup for a .gitconfig file:
-
-    +-~/                      Home Directory
-    | +-.briefcase_secrets         Secrets file
-    | +-.gitconfig            Symlink to ~/.dotfiles/gitconfig
-    | +-.dotfiles/            Dotfiles directory
-    | | +-gitconfig           Standard Dotfile
-    | | +-gitconfig.dynamic   Redacted dotfile
-
-=== Home directory (~)
-
-Where the action happens. Dotfiles that normally exist here are replaced by symlinks to files in the dotfiles directory
-
-=== Dotfiles directory (~/)
-
-Where dotfiles are stored. There are two types of dotfiles.
-
-==== Standard dotfiles
-
-A basic config file that would normally live in a user's home directory.
-
-==== Redacted dotfiles
-A config file that contains some secret information. The file is stored, sans secret info, with a '.redacted' extension in the repo. The dotfile that is symlinked to the user's home directory is then generated from this file.
-
-=== Secrets file
-
-This file, be default located at ~/.briefcase_secrets, contains the information removed from dotfiles imported using the redact command.
-
-== Commands
-
-=== import PATH_TO_FILE
-
-Imports a dotfile into thedotfiles directory, moving it to the dotfiles directory and replacing it with a symlink to its new location.
-
-
-=== redact PATH_TO_FILE
-
-Imports a dotfile that contains sensitive information. The user is presented with an editor, where the sensitive information can be removed by replacing secret information with a commented out call to a briefcase function
-
-  # before
-  password: superSecretPassword
-
-  # after
-  password: # briefcase(password)
-
-This file is then saved with a '.redacted' extension, and the original file is added to ~/.dotfiles/.gitignore so it will not be added to the repository.
-
-'superSecretPassword' will be stored using the key "password" in the secrets file.
-
-
-=== sync
-Creates a symlink in the user's home directory for each dotfile in the dotfiles directory.
-
-
-=== generate
-Creates local version of a redacted dotfile, using information found in the secrets file to fill in any that was removed.
-
-
-== Configuration
-
-The following environment variables can by used to customized the paths used by briefcase:
-
-  SHHH_DOTFILES_PATH: dotfiles path, defaults to SHHH_HOME_PATH/.dotfiles
-  SHHH_HOME_PATH: home path, defaults to ~
-  SHHH_SECRETS_PATH: secrets path, defaults to SHHH_HOME_PATH/.briefcase_secrets
-
-== Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix on a topic branch.
-* Add tests for it. This is important so I don't break it in a future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request.
-
-== Changelog
-* 0.3.0 Added code documentation, internal renaming, general cleanup. First public release.
-* 0.2.0 Added redact command, use .redacted for dynamic dotfiles
-* 0.1.3 The sync command no longer creates symlinks for dynamic files
-* 0.1.2 Added dynamic file generation
-
-== Copyright
-
-Copyright (c) 2010 Jim Benton. See LICENSE for details.