gitenv 0.0.4 → 0.0.5

data/README.md

@@ -1,6 +1,115 @@
 # gitenv
 
-**Git environment project manager.**
+Creates symlinks to your configuration files in a git repository (<a href="https://github.com/AlphaHydrae/env">like mine</a>).
+
+Run gitenv without arguments to check the symlink configuration. First-time users will be prompted to enter the path to their environment repository so gitenv can set up its own config file.
+
+    #=> gitenv
+
+     ~/.gemrc -> ~/projects/env/.gemrc           ok
+     ~/.gitconfig -> ~/projects/env/.gitconfig   not yet set up
+     ~/.zshrc -> ~/projects/env/.zshrc           not yet set up
+
+Then run it with **update** to set up the missing symlinks.
+
+    #=> gitenv update
+
+     ~/.gemrc -> ~/projects/env/.gemrc           ok
+     ~/.gitconfig -> ~/projects/env/.gitconfig   ok
+     ~/.zshrc -> ~/projects/env/.zshrc           ok
+
+Read on for <a href="#configuration">more advanced options</a>.
+
+## Installation
+
+    gem install gitenv
+
+<a name="configuration"></a>
+## Configuration
+
+If your repository is more complex than a bunch of dot files or you want to put the links somewhere other than in your home folder, you will have to customize your configuration file. Gitenv prompts you to create one the first time you run it. It looks for `~/.gitenv.rb` by default. You can override this with the `-c, --config` option or by setting the `GITENV_CONFIG` environment variable.
+
+The following sections demonstrate the various options you can customize in the configuration file.
+
+### Repository
+
+```ruby
+# Path to your environment repository.
+repo '~/projects/env'
+
+# Note that you can also set the GITENV_REPO environment variable.
+```
+
+### Symlinks
+
+```ruby
+# This will create symlinks in your home folder to all dot files (e.g. .vimrc, .gitconfig) in the repository.
+symlink dot_files
+
+# This creates symlinks for all files, not just dot files.
+symlink all_files
+
+# You can also create symlinks one at a time.
+symlink '.zshrc'
+symlink 'my_config_file'
+
+# If you want the name of link to be different than that of the file, use the :as option.
+symlink 'zshconfig', :as => '.zshconfig'
+```
+
+### Sub-folders in the repository
+
+```ruby
+# If your configuration file or files are in a sub-folder, use #from to tell gitenv where to find them.
+from 'subfolder' do
+  symlink dot_files
+end
+
+# The following syntax is also available.
+symlink('.zshrc').from('zsh')
+symlink(all_files).from('a/b/c')
+
+# You can chain several #from calls to traverse hierarchies.
+from 'a' do
+  from 'b' do
+    from 'c' do
+      # Symlink all dot files in a/b/c in your repository.
+      symlink dot_files
+    end
+  end
+end
+```
+
+### Change the destination
+
+```ruby
+# If you want to put the symlinks somewhere other than in your home folder, use #to.
+to 'links' do
+  symlink dot_files
+end
+
+# The following syntax is also available.
+symlink('.zshrc').to('links')
+symlink(all_files).to('a/b/c')
+
+# Paths are relative to your home folder. If you need an absolute path, use #to_abs.
+symlink('my_config_file').to_abs('/opt/config')
+```
+
+### Copy files
+
+```ruby
+# Gitenv can also copy files instead of creating symlinks.
+copy dot_files
+
+# Path modifiers work the same as for symlinks.
+copy(dot_files).from('zsh')
+copy('my_config_file').to('configs')
+```
+
+### Symlinks or copies in system directories
+
+Just use `sudo`. Gitenv will happily set up your symlinks. You might have to add the `-E` switch to keep gitenv in the PATH.
 
 ## License (MIT)
 

data/Rakefile

@@ -17,8 +17,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "gitenv"
   gem.homepage = "http://github.com/AlphaHydrae/gitenv"
   gem.license = "MIT"
-  gem.summary = %Q{Git environment project manager.}
-  gem.description = %Q{Creates symlinks to configuration files in a git repository.}
+  gem.summary = %Q{Symlink manager for git repositories with configuration files.}
+  gem.description = %Q{Gitenv sets up symlinks to your configuration files in a git repository.}
   gem.email = "hydrae.alpha@gmail.com"
   gem.authors = ["AlphaHydrae"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/gitenv.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "gitenv"
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["AlphaHydrae"]
-  s.date = "2012-09-23"
-  s.description = "Creates symlinks to configuration files in a git repository."
+  s.date = "2012-09-24"
+  s.description = "Gitenv sets up symlinks to your configuration files in a git repository."
   s.email = "hydrae.alpha@gmail.com"
   s.executables = ["gitenv"]
   s.extra_rdoc_files = [
@@ -50,7 +50,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.24"
-  s.summary = "Git environment project manager."
+  s.summary = "Symlink manager for git repositories with configuration files."
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/gitenv.rb

@@ -2,7 +2,7 @@
 require 'paint'
 
 module Gitenv
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end
 
 [ :context, :config, :controller, :symlink, :copy, :enumerator, :action ].each do |lib|

data/lib/gitenv/action.rb

@@ -4,14 +4,20 @@ module Gitenv
   class Action
     include Context
     
-    def initialize config, type, files
-      @type, @files = type, files
+    def initialize config, type, files, options
+      @type, @files, @options = type, files, options
       copy! config
     end
 
-    def each &block
-      @files.each File.join(*[repository, from_path].compact) do |f|
-        block.call @type.new(self, f)
+    def each options = {}, &block
+      @files.each from_path do |f|
+        block.call @type.new(self, f, @options.merge(options))
+      end
+    end
+
+    def each_file &block
+      @files.each from_path do |f|
+        block.call File.join(from_path, f)
       end
     end
   end

data/lib/gitenv/config.rb

@@ -5,7 +5,7 @@ module Gitenv
     include Context
 
     attr_reader :actions
-    attr_reader :repository
+    attr_accessor :repository
     attr_reader :home
 
     def initialize home
@@ -17,8 +17,12 @@ module Gitenv
       @repository = File.expand_path path
     end
 
-    def symlink file
-      Action.new(self, Symlink, enumerator(file)).tap{ |a| @actions << a }
+    def symlink file, options = {}
+      Action.new(self, Symlink, enumerator(file), options).tap{ |a| @actions << a }
+    end
+
+    def copy file, options = {}
+      Action.new(self, Copy, enumerator(file), options).tap{ |a| @actions << a }
     end
 
     def all_files

data/lib/gitenv/context.rb

@@ -2,8 +2,7 @@
 module Gitenv
 
   module Context
-    attr_accessor :home, :repository
-    attr_accessor :from_paths, :to_paths
+    attr_accessor :from_paths, :to_paths, :absolute
 
     def from path, &block
       (@from_paths ||= []) << path
@@ -11,10 +10,11 @@ module Gitenv
         instance_eval &block
         @from_paths.pop
       end
+      self
     end
 
     def from_path
-      @from_paths ? File.join(*@from_paths) : nil
+      @from_paths ? File.join(*([ @config.repository, @from_paths ].flatten)) : @config.repository
     end
 
     def to path, &block
@@ -23,17 +23,38 @@ module Gitenv
         instance_eval &block
         @to_paths.pop
       end
+      self
+    end
+
+    def to_abs path, &block
+      previous = @to_paths
+      @to_paths = [ path ]
+      @absolute = true
+      if block
+        instance_eval &block
+        @to_paths = previous
+        @absolute = false
+      end
+      self
     end
 
     def to_path
-      @to_paths ? File.join(*@to_paths) : nil
+      @to_paths ? File.join(*(@absolute ? @to_paths : [ @config.home, @to_paths ]).flatten) : @config.home
+    end
+
+    def copy! config
+      self.from_paths = config.from_paths ? config.from_paths.dup : []
+      self.to_paths = config.to_paths ? config.to_paths.dup : []
+      self.absolute = config.absolute
+      @config = config
+    end
+
+    def home
+      @config.home
     end
 
-    def copy! source
-      self.from_paths = source.from_paths ? source.from_paths.dup : []
-      self.to_paths = source.to_paths ? source.to_paths.dup : []
-      self.repository = source.repository
-      self.home = source.home
+    def repository
+      @config.repository
     end
   end
 end

data/lib/gitenv/controller.rb

@@ -1,3 +1,4 @@
+require 'readline'
 
 module Gitenv
 
@@ -13,10 +14,30 @@ module Gitenv
     end
 
     def run
+
+      check_config_file!
+
+      if !File.exists?(config_file) and !repository
+        create_config_file!
+      end
+
       load_config_file!
+
+      @config.repository = repository
+      check_repository!
+
+      # load dot files by default
+      if @config.actions.empty?
+        @config.symlink @config.dot_files
+      end
+
+      check_files!
+
+      longest = 0
+      @config.actions.each{ |a| a.each{ |impl| longest = impl.description.length if impl.description.length > longest } }
+
       @config.actions.each do |a|
-        a.each do |impl|
-          impl.build!
+        a.each :justify => longest + 3 do |impl|
           impl.update! if @action == :update
           puts impl
         end
@@ -25,25 +46,123 @@ module Gitenv
 
     private
 
+    def create_config_file!
+
+      file = config_file
+      unless agree "You have no configuration file (#{file}); do you wish to create one? (y/n) "
+        puts
+        abort "To use gitenv, you must either create a configuration file\nor specify an environment repository with the -r, --repo option."
+      end
+
+      repo = @options.repo || ENV['GITENV_REPO']
+      unless repo
+        Readline.completion_append_character = '/'
+        Readline.completion_proc = Proc.new do |str|
+          Dir[str+'*'].grep /^#{Regexp.escape(str)}/
+        end
+        begin
+          repo = Readline.readline('Type the path to your environment repository: ', true)
+        rescue Interrupt
+          exit 1
+        end
+      end
+
+      if !repo or repo.strip.empty?
+        puts; abort "You must specify an environment repository."
+      elsif !File.directory?(File.expand_path(repo))
+        puts; abort "No such directory #{repo}."
+      end
+
+      config = String.new.tap do |s|
+        s << %|\n# Path to your environment repository.|
+        s << %|\nrepo "#{repo}"\n|
+        s << %|\n# Create symlinks in your home folder.|
+        s << %|\nsymlink dot_files\n\n|
+      end
+
+      File.open(file, 'w'){ |f| f.write config }
+
+      puts
+      puts Paint["Successfully wrote configuration to #{file}", :green]
+      puts
+    end
+
+    def repository
+      @options.repo || @config.repository || ENV['GITENV_REPO']
+    end
+
+    def config_file
+      if @options.config
+        File.expand_path @options.config
+      elsif ENV['GITENV_CONFIG']
+        File.expand_path ENV['GITENV_CONFIG']
+      else
+        File.join @home, '.gitenv.rb'
+      end
+    end
+
     def load_config_file!
-      
-      config_file = @options.config ? File.expand_path(@options.config) : File.join(@home, '.gitenv.rb')
-      if !File.exists?(config_file) and @options.config
-        abort "No such configuration file #{config_file}"
-      elsif !File.exists?(config_file)
-        abort "You must create a configuration file #{config_file} or load another one with the --config option"
-      elsif !File.file?(config_file)
-        abort "Configuration file #{config_file} is not a file"
-      elsif !File.readable?(config_file)
-        abort "Configuration file #{config_file} is not readable"
+      file = config_file
+      return unless File.exists? file
+      contents = File.open(file, 'r').read
+      @config.instance_eval contents, file
+    end
+
+    def check_files!
+      problems = []
+      @config.actions.each do |a|
+        a.each_file do |f|
+          if !File.exists?(f)
+            problems << { :file => f, :msg => "does not exist" }
+          elsif !File.file?(f)
+            problems << { :file => f, :msg => "is not a file" }
+          elsif !File.readable?(f)
+            problems << { :file => f, :msg => "is not readable" }
+          end
+        end
+      end
+
+      return unless problems.any?
+
+      msg = "There are problems with the following files in your repository:"
+      problems.each do |p|
+        msg << "\n   #{p[:file]} #{p[:msg]}"
+      end
+      abort msg
+    end
+
+    def check_config_file!
+      file = config_file
+      return if !File.exists?(file)
+      if !File.file?(file)
+        abort "#{file} is not a file. It cannot be used as a configuration file."
+      elsif !File.readable?(file)
+        abort "#{file} is not readable. It cannot be used as a configuration file."
       end
+    end
 
-      contents = File.open(config_file, 'r').read
-      @config.instance_eval contents, config_file
+    def check_repository!
+      if !@config.repository
+        msg = "You have not specified an environment repository."
+        msg << "\nYou must either use the -r, --repo option or create"
+        msg << "\na configuration file (~/.gitenv.rb by default) with"
+        msg << "\nthe repo setting."
+        abort msg
+      end
+      return if File.directory? @config.repository
+      notice = File.exists?(@config.repository) ? 'is not a directory' : 'does not exist'
+      from = if @options.repo
+        "--repo #{@options.repo}"
+      elsif ENV['GITENV_REPO']
+        "$GITENV_REPO = #{ENV['GITENV_REPO']}"
+      else
+        %/repo "#{@config.repository}"/
+      end
+      abort "The repository you have specified #{notice}.\n   (#{from})"
     end
 
     def abort msg, code = 1
-      warn ms
+      warn Paint[msg, :red]
       exit code
     end
   end

data/lib/gitenv/copy.rb

@@ -1,12 +1,68 @@
+# encoding: UTF-8
+require 'fileutils'
+require 'digest/sha1'
 
 module Gitenv
 
   class Copy
-    include Context
 
-    def initialize config, file
-      @config, @file = config, file
-      copy! config
+    def initialize config, file, options = {}
+      @config, @file, @options = config, file, options
+    end
+
+    def update!
+      if File.exists?(target) && !File.exists?(target_copy)
+        FileUtils.mv target, target_copy
+      end
+      if !File.exists?(target)
+        FileUtils.copy source, target
+      end
+    end
+
+    def to_s
+      color, mark, msg = status
+      justification = @options[:justify] ? ' ' * (@options[:justify] - description.length) : ''
+      %/ #{Paint[mark, color]} #{Paint[target, :cyan]} << #{source}#{justification}#{Paint[msg, color]}/
+    end
+
+    def description
+      "#{target} << #{source}"
+    end
+
+    private
+
+    def status
+      if !File.exists?(target)
+        [ :blue, "✗", "is not set up; update will create the copy" ]
+      elsif digest(source) == digest(target)
+        [ :green, "✓", "ok" ]
+      elsif File.exists?(target_copy)
+        [ :red, "✗", "already exists with backup copy" ]
+      else
+        [ :blue, "✗", "already exists; update will backup the file and create the copy" ]
+      end
+    end
+
+    def target
+      @target ||= File.join(*[ @config.to_path, target_name].compact)
+    end
+
+    def target_copy
+      @target_copy ||= "#{target}.orig"
+    end
+
+    def target_name
+      @options[:as] || @file
+    end
+
+    def source
+      @source ||= File.join(*[ @config.from_path, @file ].compact)
+    end
+
+    def digest file
+      Digest::SHA1.new.tap do |dig|
+        File.open(file, 'rb'){ |io| dig.update io.readpartial(4096) while !io.eof }
+      end
     end
   end
 end

data/lib/gitenv/symlink.rb

@@ -3,59 +3,58 @@
 module Gitenv
 
   class Symlink
-    include Context
 
-    def initialize config, file
-      @config, @file = config, file
-      copy! config
-    end
-
-    def build!
-      @color, @mark, @message = if File.symlink? link
-        @current_target = File.expand_path File.readlink(link)
-        if @current_target == target
-          [ :green, "✓", "ok" ]
-        else
-          [ :yellow, "✗", "currently points to #{@current_target}" ]
-        end
-      elsif File.file? link
-        [ :red, "✗", "is a file" ]
-      elsif File.directory? link
-        [ :red, "✗", "is a directory" ]
-      elsif File.exists? link
-        [ :red, "✗", "exists but is not a symlink" ]
-      else
-        [ :blue, "✓", "is not set up" ]
-      end
+    def initialize config, file, options = {}
+      @config, @file, @options = config, file, options
     end
 
     def update!
-      if !File.exists? link
+      unless File.exists? link
         File.symlink target, link
-        @color, @mark, @message = :green, "✓", "ok"
       end
     end
 
     def to_s
-      %/ #{status_mark} #{Paint[link, :cyan]} -> #{target}   #{status_message}/
+      color, mark, msg = status
+      justification = @options[:justify] ? ' ' * (@options[:justify] - description.length) : ''
+      %/ #{Paint[mark, color]} #{Paint[link, :cyan]} -> #{target}#{justification}#{Paint[msg, color]}/
     end
 
-    private
-
-    def status_mark
-      Paint["#{@mark}", @color]
+    def description
+      "#{link} -> #{target}"
     end
 
-    def status_message
-      Paint["#{@message}", @color]
+    private
+
+    def status
+      if File.symlink? link
+        current_target = File.expand_path File.readlink(link)
+        if current_target == target
+          [ :green, "✓", "ok" ]
+        else
+          [ :yellow, "✗", "currently points to #{current_target}; update will overwrite" ]
+        end
+      elsif File.file? link
+        [ :red, "✗", "is a file; update will ignore" ]
+      elsif File.directory? link
+        [ :red, "✗", "is a directory; update will ignore" ]
+      elsif File.exists? link
+        [ :red, "✗", "exists but is not a symlink; update will ignore" ]
+      else
+        [ :blue, "✗", "is not set up; update will create the link" ]
+      end
     end
 
     def link
-      File.join(*[ @config.home, to_path, @file].compact)
+      @link ||= File.join(*[ @config.to_path, link_name].compact)
     end
 
     def target
-      File.join(*[ @config.repository, from_path, @file ].compact)
+      @target ||= File.join(*[ @config.from_path, @file ].compact)
+    end
+
+    def link_name
+      @options[:as] || @file
     end
   end
 end

data/lib/program.rb

@@ -5,20 +5,27 @@ program :name, 'gitenv'
 program :version, Gitenv::VERSION
 program :description, 'Symlink manager for git repositories with configuration files.'
 
+global_option '-r', '--repo PATH', 'Specify the path to the environment repository'
+global_option '-c', '--config PATH', 'Use a custom configuration file (defaults to ~/.gitenv.rb)'
+
 command :info do |c|
+  c.syntax = 'gitenv info'
+  c.description = 'Display the current configuration (default action)'
   c.action do |args,options|
     Gitenv::Controller.new(:info, options).run
   end
 end
 
 command :update do |c|
+  c.syntax = 'gitenv update'
+  c.description = 'Create/update the symlinks'
   c.action do |args,options|
     Gitenv::Controller.new(:update, options).run
   end
 end
 
-global_option '-r', '--repo PATH', 'Specify the path to the environment repository'
-global_option '-c', '--config PATH', 'Use a custom configuration file (defaults to ~/.gitenv.rb)'
+# TODO: add a verbose option (show repo, show config file path)
+# TODO: add link to documentation in help
 
 default_command :info
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitenv
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-23 00:00:00.000000000 Z
+date: 2012-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paint
@@ -171,7 +171,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Creates symlinks to configuration files in a git repository.
+description: Gitenv sets up symlinks to your configuration files in a git repository.
 email: hydrae.alpha@gmail.com
 executables:
 - gitenv
@@ -231,5 +231,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Git environment project manager.
+summary: Symlink manager for git repositories with configuration files.
 test_files: []