dotman 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd8b469fcc0d6da51b7488b195248ecccd4b8d74
-  data.tar.gz: 462ec000404811976fdfff032020270d3b6e1251
+  metadata.gz: a3b731737f17c1671451e5b4e769a1004456e586
+  data.tar.gz: 8f7301a47b9dbf857eb18eda8d255aa417d097f5
 SHA512:
-  metadata.gz: 53852745e415c58ca8bf1262088ce74b0f708434f1336588487e5ed742b6515b77d685997b673576a8f2891eeb70e0d42356f5fd527fdb9deeac2f806d9460de
-  data.tar.gz: ef869344289cfbe23a4ec377e552fb71e2e3ad8a4de9ae649ac4a9b636debeffd450eb06e1424df0f1a6db5f1775c7c28fef3eccfa9804b620e3b583170df265
+  metadata.gz: d64c527bb313c8f0d147fd8a1ca5300c7bee05847eb97c0e9af35bee42579fce0ea67aa28f85e6ab679bece1208827b4c7b38ff773fa7f3bb7865cc10c31980e
+  data.tar.gz: 18f2b801b2ebc9e12d496596bef8fbc88ffad4029187601fadb4afe594999c008a264ca15336a637be86a232c2672816960e6724c618e125f61d537fc3cefab2

data/README.md

@@ -1,8 +1,33 @@
 # Dotman
 
-This is a work in progress.  It is not yet in working condition.
+This is a work in progress.
 
-This gem will allow you to switch between different dotfiles on the same user account.
+This gem will allows you to switch between different dotfiles on the same user account.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dotman'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dotman
+
+## Usage
+
+To retrieve your dotfiles and store them
+dot clone your\_dotfiles\_repo alias
+
+To use cloned dotfiles
+dot use alias
+
+To revert dotfiles back to original
+dot use default
 
 ## Contributing
 

data/bin/dot

@@ -10,4 +10,6 @@ when 'clone'
   Dotman::Git.klone(ARGV[1], ARGV[2])
 when 'use'
   Dotman::User.set(ARGV[1])
+else
+  puts "USAGE:\ndot clone git_repository alias : clone the dotfiles repo\ndot use alias : use the dotfiles\ndot use default : switch to the default dot files"
 end

data/lib/dotman.rb

@@ -1,7 +1,9 @@
 require 'fileutils'
 require "dotman/version"
 require "dotman/base"
+Dotman::Base.ensure_dotman_folder_exists
+Dotman::Base.ensure_default_folder_exists
+Dotman::Base.ensure_current_dotman_file_exists
 require "dotman/git"
 require "dotman/dotfile_collection"
 require "dotman/user"
-

data/lib/dotman/base.rb

@@ -32,9 +32,5 @@ module Dotman
         end
       end
     end
-ensure_dotman_folder_exists
-ensure_default_folder_exists
-ensure_current_dotman_file_exists
-
   end
 end

data/lib/dotman/dotfile_collection.rb

@@ -1,46 +1,47 @@
 module Dotman
 
 DOTFILES_PATH = "#{ENV['HOME']}/.dotman/dotfiles.yml"
-DOTFILES_YAML = File.exist?(DOTFILES_PATH) ? YAML::load_file(DOTFILES_PATH) : Hash.new
 
   class DotfileCollection
 
+    def initialize(yaml)
+      @yaml = yaml
+    end
+
     attr_accessor :yaml
 
+    def self.dotfiles_yaml
+      @dotfiles_yaml ||= File.exist?(DOTFILES_PATH) ? YAML::load_file(DOTFILES_PATH) : Hash.new
+    end
+
     def self.find_by_alias(alias_name)
-      dotfile_collection = new
       ensure_default_dotfile_configuration_exists
-      dotfile_collection.yaml = DOTFILES_YAML.fetch(alias_name) if DOTFILES_YAML
-      dotfile_collection
+      new(dotfiles_yaml.fetch(alias_name))
     end
 
     def self.new_configuration(folder_name, alias_name = nil)
-      dotfile_collection = new
       alias_name = folder_name unless alias_name
-      DOTFILES_YAML.store(alias_name, {
+      dotfiles_yaml.store(alias_name, {
           'folder_name' => folder_name 
-        }
-      )
+        })
       save_dotfile_yaml
-      dotfile_collection.yaml = DOTFILES_YAML
-      dotfile_collection
     end
 
 
     def all_dotfiles
-      Dir.entries("#{Dotman::Base.dotman_folder}/#{@yaml['folder_name']}").select{|x| x =~ /\.{1}\w+/ }
+      Dir.entries("#{Dotman::Base.dotman_folder}/#{@yaml['folder_name']}").select{|x| x =~ /\.{1}\w+[^git]/ }
     end
 
     private
 
     def self.ensure_default_dotfile_configuration_exists
-      unless DOTFILES_YAML && DOTFILES_YAML['default']
+      unless dotfiles_yaml && dotfiles_yaml['default']
         new_configuration('default')
       end
     end
 
     def self.save_dotfile_yaml
-      File.open(DOTFILES_PATH, 'w') { |f| f.write DOTFILES_YAML.to_yaml }
+      File.open(DOTFILES_PATH, 'w') { |f| f.write dotfiles_yaml.to_yaml }
     end
 
   end

data/lib/dotman/git.rb

@@ -2,6 +2,10 @@ module Dotman
   class Git
     def self.klone(git_location, alias_name = nil)
       unless git_location.nil?
+        Dotman::Base.ensure_dotman_folder_exists
+        puts "ENSURING DOTMAN FOLDER EXISTS"
+        Dotman::Base.ensure_default_folder_exists
+        Dotman::Base.ensure_current_dotman_file_exists
         clone_repository(git_location, alias_name)
       end
     end

data/lib/dotman/version.rb

@@ -1,3 +1,3 @@
 module Dotman
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/dotman/base_spec.rb

@@ -1,7 +1,5 @@
 require 'spec_helper'
 describe Dotman::Base do
-  let (:dotfiles_folder) { File.expand_path('../../data/dotfiles', __FILE__) }
-  let!(:dotfiles)        {FileUtils.touch "#{dotfiles_folder}/.vimrc"; FileUtils.touch "#{dotfiles_folder}/.bashrc"; FileUtils.touch "#{dotfiles_folder}/.zshrc" }
 
   describe ".ensure_dotman_folder_exists" do
     context "when `$HOME.dotman/` does not exist" do
@@ -20,32 +18,4 @@ describe Dotman::Base do
       end
     end
   end
-
-  describe ".all_dotfiles" do
-    context "when dotfiles exist for a location" do
-
-      it "returns all the dotfiles" do
-        Dotman::Base.all_dotfiles(dotfiles_folder).should include('.vimrc', '.bashrc', '.zshrc')
-      end
-
-      it "should not contain . or .." do
-        Dotman::Base.all_dotfiles(dotfiles_folder).should_not include('..', '.')
-      end
-
-      it "does not contain non dotfiles" do
-        Dotman::Base.all_dotfiles(dotfiles_folder).should_not include('some_nondot_file')
-      end
-
-    end
-  end
-
-  describe ".move_home_files_to_default" do
-    context "when having dotfiles in project" do
-      it "moves the files" do
-        Dotman::Base.move_home_files_to_default(dotfiles_folder)
-        Dir.entries(Dotman::Base.default_folder).should include('.vimrc', '.bashrc', '.zshrc')
-      end
-    end
-  end
-
 end

data/spec/dotman/dotfile_collection_spec.rb

@@ -7,4 +7,34 @@ describe Dotman::DotfileCollection do
       end
     end
   end
+
+  describe ".all_dotfiles" do
+    let (:dotfile_collection)      { Dotman::DotfileCollection.new(Hash.new) }
+
+    before :each do
+      Dir.stub(:entries).and_return(['some_nondot_file', '.gitignore', '.gitconfig', '.vimrc', '.bashrc', '.zshrc', '..', '.', '.git'])
+    end
+
+    context "when dotfiles exist for a location" do
+      it "returns all the dotfiles" do
+        dotfile_collection.all_dotfiles.should include('.vimrc', '.bashrc', '.zshrc')
+      end
+
+      it "should not contain . or .." do
+        dotfile_collection.all_dotfiles.should_not include('..', '.')
+      end
+
+      it "does not contain non dotfiles" do
+        dotfile_collection.all_dotfiles.should_not include('some_nondot_file')
+      end
+
+      it 'excludes .git' do
+        dotfile_collection.all_dotfiles.should_not include('.git')
+      end
+
+      it 'includes .gitignore' do
+        dotfile_collection.all_dotfiles.should include('.gitignore')
+      end
+    end
+  end
 end

data/spec/integration/dotfile_collection_integration_spec.rb

@@ -1,16 +1,21 @@
 require 'spec_helper'
 describe Dotman::DotfileCollection do
+  before :all do
+    Dotman::Git.clone_repository('git@github.com:Timbinous/dotfiles.git', 'tim')
+  end
+
   describe ".find_by_alias" do
     context "when dotfile collection is found" do
       let (:alias_name)                 { 'tim' }
       let (:dotfile_collection_name)    { 'Timbinous_dotfiles' }
       let! (:dotfile_configuration)     { Dotman::DotfileCollection.new_configuration(dotfile_collection_name, alias_name) }
       it "returns the dotfile collection" do
-        Dotman::DotfileCollection.find_by_alias(alias_name)['folder_name'].should == dotfile_collection_name
+        Dotman::DotfileCollection.find_by_alias(alias_name).should be_an_instance_of(Dotman::DotfileCollection)
       end
     end
   end
   after :all do
     FileUtils.rm_r("#{ENV['HOME']}/.dotman/dotfiles.yml")
+    FileUtils.rm_rf("#{ENV['HOME']}/.dotman/Timbinous_dotfiles")
   end
 end

data/spec/integration/git_integration_spec.rb

@@ -4,9 +4,6 @@
 #
 require 'spec_helper'
 describe Dotman::Git do
-  before :all do
-    Dotman::Base.ensure_dotman_folder_exists
-  end
 
   context "cloning a new repo" do
 

data/spec/integration/user_integration_spec.rb

@@ -1,5 +1,11 @@
 require 'spec_helper'
 describe Dotman::User do
+  let (:tim)                 { Dotman::User.new('tim') }
+
+  before :all do
+    Dotman::Git.clone_repository("git@github.com:Timbinous/dotfiles.git", 'tim')
+  end
+
   describe ".current_user_alias" do
     before :all do
       File.open(Dotman::Base.current_dotman, 'w') { |f| f.write 'tim' }
@@ -11,15 +17,10 @@ describe Dotman::User do
   end
 
   describe "#set_current_user" do
-    let (:user)             { Dotman::User.new('frank') }
-
-    before :all do
-      Dotman::DotfileCollection.new_configuration('frankie_dotfiles', 'frank')
-    end
 
     it 'writes to the .current file, the alias of the current user' do
-      user.set_current_user
-      Dotman::User.current_user_alias.should == 'frank'
+      tim.set_current_user
+      Dotman::User.current_user_alias.should == 'tim'
     end
   end
 
@@ -27,15 +28,17 @@ describe Dotman::User do
   describe ".current" do
 
     it 'returns the current users information' do
-      Dotman::User.current.folder_name.should == 'frankie_dotfiles'
+      tim.set_current_user
+      Dotman::User.current.folder_name.should == 'Timbinous_dotfiles'
     end
   end
 
   describe "#set" do
 
-    before :each do
-      Dotman::Git.clone_repository("git@github.com:Timbinous/dotfiles.git", 'tim')
+    before :all do
+      $default_user.set_current_user
       FileUtils.touch(["#{ENV['HOME']}/.vimrc", "#{ENV['HOME']}/.zshrc", "#{ENV['HOME']}/.bashrc"])
+      FileUtils.mkdir("#{ENV['HOME']}/.dotman/default")
       Dotman::User.set('tim')
     end
 
@@ -51,12 +54,5 @@ describe Dotman::User do
       end
     end
 
-    after :each do
-      FileUtils.rm_r("#{ENV['HOME']}/.dotman/dotfiles.yml")
-      FileUtils.rm_rf("#{ENV['HOME']}/.dotman/Timbinous_dotfiles")
-      $default_user.collection.all_dotfiles.each do |df|
-        FileUtils.rm("#{ENV['HOME']}/.dotman/default/#{df}")
-      end
-    end
   end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,16 @@
 ENV['HOME'] = File.expand_path('../data/home', __FILE__)
-require_relative '../lib/dotman.rb'
+require 'fileutils'
+require_relative "../lib/dotman"
+
+RSpec.configure do |config|
+
+  config.after(:all) do
+    FileUtils.rm_rf(File.join(ENV['HOME'], '.dotman')) if File.directory? (File.join(ENV['HOME'], '.dotman'))
+    FileUtils.rm(File.join(ENV['HOME'], '.bashrc')) if File.symlink? (File.join(ENV['HOME'], '.bashrc'))
+    FileUtils.rm(File.join(ENV['HOME'], '.gitignore')) if File.symlink? (File.join(ENV['HOME'], '.gitignore'))
+    FileUtils.rm(File.join(ENV['HOME'], '.tmux.conf')) if File.symlink? (File.join(ENV['HOME'], '.tmux.conf'))
+    FileUtils.rm(File.join(ENV['HOME'], '.vim')) if File.symlink? (File.join(ENV['HOME'], '.vim'))
+    FileUtils.rm(File.join(ENV['HOME'], '.vimrc')) if File.symlink? (File.join(ENV['HOME'], '.vimrc'))
+    FileUtils.rm(File.join(ENV['HOME'], '.zshrc')) if File.symlink? (File.join(ENV['HOME'], '.zshrc'))
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotman
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,10 +88,7 @@ files:
 - lib/dotman/git.rb
 - lib/dotman/user.rb
 - lib/dotman/version.rb
-- spec/data/dotfiles/.bashrc
-- spec/data/dotfiles/.vimrc
-- spec/data/dotfiles/.zshrc
-- spec/data/dotfiles/some_nondot_file
+- spec/data/home/.gitkeep
 - spec/dotman/base_spec.rb
 - spec/dotman/dotfile_collection_spec.rb
 - spec/dotman_spec.rb
@@ -127,10 +124,7 @@ specification_version: 4
 summary: Use this utility to manage your dotfiles and others who may use the same
   login user as yourself
 test_files:
-- spec/data/dotfiles/.bashrc
-- spec/data/dotfiles/.vimrc
-- spec/data/dotfiles/.zshrc
-- spec/data/dotfiles/some_nondot_file
+- spec/data/home/.gitkeep
 - spec/dotman/base_spec.rb
 - spec/dotman/dotfile_collection_spec.rb
 - spec/dotman_spec.rb