dotter_dotfiles 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3256b80787b7b02945fff1db5d2fd45a0e3b8c1
+  data.tar.gz: 8d04cbd1f070d83d568f7a80ec053fd5511ec8f8
+SHA512:
+  metadata.gz: 9ce81490651bfc0e09bd428afdc61568f0576ddc9b502b0a294a0230ee258c56054bd43da60c20f19de60907759d9cd7b0e9cb50d3b50c43ad8587c877c866ba
+  data.tar.gz: 500df8b98f9558054e4218c449158046fb38667d42c79a772a46d6947e2585ee036b242ea3950b265d8650481994cb72b3f0c01a0da07d604fb3948bd7a9b238

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+README.md
+ChangeLog.md
+
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle
+/Gemfile.lock
+/html/
+/pkg/
+/vendor/cache/*.gem
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+*.un~
+Session.vim
+.netrwhist
+*~

data/.rdoc_options

@@ -0,0 +1,16 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+  - .
+charset: UTF-8
+exclude: 
+hyperlink_all: false
+line_numbers: false
+main_page: README.md
+markup: markdown
+show_hash: false
+tab_width: 8
+title: dotter Documentation
+visibility: :protected
+webcvs:

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2015-10-13
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Samuel Hodgkins
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,16 @@
+# Dotter, a dotfiles manager using stow & git
+
+As the title explained, dotter is a tool to manage your dotfiles. It is written in ruby and uses the tools stow and git in order to manage your dotfiles effectively.
+It wraps around both tools in order to achieve easy and effective management of dotfiles. Stow handles the symlinking of them while Git tracks the history.
+It is very new, unfinished software that likely has multiple bugs. However, due to the specific tools used there is not too much risk with using it.
+
+It is not yet published to rubygems but you can install the required dependencies via bundler.
+
+To see all available commands, use `dotter help`. Not all commands are currently implemented.
+
+## TODO
+1. Refactor and clean up the code.
+2. Implement all unimplemented commands.
+3. Implement error handling
+4. Add any useful suggested features.
+5. Port to Crystal so it can be a single executable.

data/Rakefile

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  abort e.message
+end
+
+require 'rake'
+
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rdoc/task'
+RDoc::Task.new
+task :doc => :rdoc

data/bin/dotter

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+root = File.expand_path(File.join(File.dirname(__FILE__),'..'))
+if File.directory?(File.join(root,'.git'))
+  Dir.chdir(root) do
+    begin
+      require 'bundler/setup'
+    rescue LoadError => e
+      warn e.message
+      warn "Run `gem install bundler` to install Bundler"
+      exit -1
+    end
+  end
+end
+require 'dotter/cli'
+Dotter::CLI.start(ARGV)

data/dotter.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dotter/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "dotter_dotfiles"
+  gem.version       = Dotter::VERSION
+  gem.summary       = %q{A dotfiles managaer}
+  gem.description   = %q{A simple, yet powerful dotfiles manager that wraps around stow and git}
+  gem.license       = "MIT"
+  gem.authors       = ["Samuel Hodgkins"]
+  gem.email         = "samuel.hodgkins@sky.com"
+  gem.homepage      = "https://rubygems.org/gems/dotter_dotfiles"
+
+  gem.files         = `git ls-files`.split($/)
+
+  `git submodule --quiet foreach --recursive pwd`.split($/).each do |submodule|
+    submodule.sub!("#{Dir.pwd}/",'')
+
+    Dir.chdir(submodule) do
+      `git ls-files`.split($/).map do |subpath|
+        gem.files << File.join(submodule,subpath)
+      end
+    end
+  end
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'bundler', '~> 1.10'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rdoc', '~> 4.0'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  gem.add_runtime_dependency 'thor'
+  gem.add_runtime_dependency 'git'
+  gem.add_runtime_dependency 'inifile'
+end

data/lib/dotter.rb

@@ -0,0 +1 @@
+require 'dotter/version'

data/lib/dotter/cli.rb

@@ -0,0 +1,185 @@
+require 'thor'
+require 'dotter/utilities'
+require 'dotter/gitrepo'
+require 'dotter/version'
+require 'dotter/configuration'
+require 'dotter/package'
+require 'dotter/publicgitrepo'
+require 'pathname'
+module Dotter
+class CLI < Thor
+	include Utilities
+	desc "version", "Print the dotter version"
+	def version
+		puts "This is dotter #{Dotter::VERSION}"
+	end
+	desc "init", "Initialise the directory structure for ~/dotfiles"
+	def init
+		puts "Initialising ~/dotfiles"
+		puts "Creating the dotfiles directory."
+		FileUtils.mkpath(dotfiles_path)
+		go_to_dotfiles
+		puts "Creating the directory for the combined public dotfiles."
+		FileUtils.mkpath('public')
+		puts "Creating an initial package for dotter."
+		FileUtils.mkpath('dotter/.dotter/gitrepos')
+		FileUtils.mkpath('dotter/.dotter/indexes/')
+	end
+	desc "list", "List all packages present in ~/dotfiles"
+	def list
+		puts "List of packages in ~/dotfiles"
+		directory_name = dotfiles_path
+		directory = Pathname.new(directory_name)
+		directories = directory.children.select { |c| c.directory? }
+		package_names = []
+		directories.each do |directory| 
+			package_names.push(directory.basename)
+		end
+		package_names.each do |package| 
+			puts package
+		end
+	end
+	desc "stow PACKAGE", "Stow the given package name."
+	def stow(package)
+		package = Package.new(package)
+		if package.stowed?
+			error "Package #{package} is already stowed."
+			exit(1)
+		end
+		puts "Stowing package #{package}"
+		puts package.stow
+	end
+	desc "unstow PACKAGE", "Unstow the given package name."
+	def unstow(package)
+		package = Package.new(package)
+		if package.unstowed?
+			error "Package #{package} is not stowed."
+			exit(1)
+		end
+		puts "Unstowing package #{package}"
+		puts package.unstow
+	end
+	desc "track PACKAGE", "Begin tracking the given package with Git"
+	def track(package)
+		puts "Initialising Git repository for package #{package}"
+		package = Package.new(package)
+		package.track
+		puts "Repository for package #{package} initialised. Git's metadata is stored in #{package.repo.metadata_path.to_s}"
+		puts "Creating an initial snapshot to serve as a starting point."
+		repo = package.repo
+		repo.add('.')
+		repo.commit_all("Initial snapshot of the package's contents")
+		puts "Initial snapshot created."
+	end
+	desc "publish PACKAGE", "Make a package available in your public dotfiles repository"
+	def publish(package)
+		puts "Making package #{package} public"
+		public_repo = PublicGitRepo.new
+		puts public_repo.add_package(package)
+	end
+	desc "unpublish PACKAGE", "Make a package private after publishing it."
+	def unpublish(package)
+		puts "Making package #{package} private again"
+		public_repo = PublicGitRepo.new
+		public_repo.remove_package(package)
+	end
+	method_option :commit_message, :required => true, :aliases => "-m"
+	method_option :all, :type => :boolean, :aliases => "-a"
+	desc "commit PACKAGE", "Commit your changes to a Git-tracked package."
+	def commit(package)
+		package = Package.new(package)
+		if package.untracked?
+			error "Package #{package} is not tracked by Git."
+			exit 1
+		end
+		puts "Committing the changes to package #{package} with commit message #{options.commit_message}."
+		commit_message = options.commit_message
+		repo = package.repo
+		if options.all
+			repo.commit_all(commit_message)
+		else
+			repo.commit(commit_message)
+		end
+	end
+	desc "update PACKAGE", "Updates the specified package"
+	def update(package)
+		puts "Updating the contents / symlinks for package #{package}"
+		package = Package.new(package)
+		if package.unstowed?
+			error "Package #{package} is not stowed and therefore cannot be updated."
+			exit 1
+		end
+		package.update
+	end
+	desc "update_all", "Updates all stowed packages."
+	def update_all()
+		puts "Updating all stowed packages"
+	end
+	desc "import PATH PACKAGE", "Imports a file or directory into the specified package"
+	def import(path, package)
+		puts "Importing #{path} into package {package}"
+		filepath = Pathname.new(File.expand_path(path))
+		packagepath = package_path(package)
+		homepath = Pathname.new(File.expand_path('~'))
+		relative_filepath = filepath.relative_path_from(homepath)
+		complete_path = packagepath + relative_filepath
+		FileUtils.copy(File.expand_path(path), complete_path.to_s)
+		puts "File imported successfully. Update the package to make the symlink."
+	end
+	desc "import_repo REPO_URL PACKAGE", "Clones the specified git repository as the contents of the specified Package."
+	def import_repo(repo_url, package)
+		puts "Cloning repository #{repo_url} into package #{package}"
+	end
+	desc "clone REPO_URL", "Clones the dotfiles / packages of the specified repository into ~/dotfiles. Will overwrite any existing data."
+	def clone(repo_url)
+		puts "Cloning repository #{repo_url} directly into ~/dotfiles"
+	end
+	desc "status PACKAGE", "Obtain the repository status of a Git-tracked package."
+	def status(package)
+		package = Package.new(package)
+		if package.untracked?
+			error "Package #{package} is not tracked by Git."
+			exit 1
+		end
+		metadata_path = repo_path(package.to_s)
+		metadata_indexes_path = index_path(package.to_s)
+		# Punt because it does this better than ruby-git.
+		system({"GIT_DIR" => metadata_path.to_s, "GIT_INDEX_FILE" => metadata_indexes_path.to_s}, "git status")
+	end
+	desc "add PACKAGE FILE", "Add a file from a package to the next commit of that package."
+	def add(package,file)
+		package = Package.new(package)
+		if package.untracked?
+			error "Package #{package} is not tracked by Git."
+			exit 1
+		end
+		puts "Marking #{file} to be committed for package #{package}"
+		repo = package.repo
+		repo.add(file)
+    end
+	desc "reset PACKAGE", "Reset what will be commmitted in the next commit to the given package."
+	def reset(package)
+		package = Package.new(package)
+		if package.untracked?
+			error "Package #{package} is not tracked by Git."
+			exit 1
+		end
+		puts "Resetting what will be committed to package #{package}"
+		repo = package.repo
+		repo.reset()
+	end
+	desc "log PACKAGE", "View the commit log of a package."
+	def log(package)
+		package = Package.new(package)
+		if package.untracked?
+			error "Package #{package} is not tracked by Git."
+			exit 1
+		end
+		puts "Obtaining the log of package #{package}"
+		repo = package.repo
+		repo.log.each do |commit|
+			puts "[#{commit.date}] #{commit.message} (#{commit.author.name})"
+		end
+	end
+end
+end

data/lib/dotter/configuration.rb

@@ -0,0 +1,39 @@
+require 'dotter/utilities'
+require 'inifile'
+module Dotter
+	class Configuration
+		include Utilities
+		attr_reader :config_file
+		attr_accessor :config
+		def initialize(config_file=package_path('dotter') + '.dotter/Dotfile')
+			@config_file = config_file
+			@config = IniFile.load(config_file)
+		end
+		def package_config(package)
+			@config[package]
+		end
+		def save()
+			@config.write()
+		end
+		def set_state(package, state)
+			package_conf = self.package_config(package)
+			package_conf['state'] = state
+			self.save()
+		end
+		def track(package)
+			package_conf = self.package_config(package)
+			package_conf['tracked'] = true
+			self.save()
+		end
+		def publish(package)
+			package_conf = self.package_config(package)
+			package_conf['public'] = true
+			self.save()
+		end
+		def unpublish(package)
+			package_conf = self.package_config(package)
+			package_conf['public'] = false
+			self.save()
+		end
+	end
+end

data/lib/dotter/gitrepo.rb

@@ -0,0 +1,43 @@
+require 'git'
+module Dotter
+	require 'dotter/utilities'
+	class GitRepo
+		include Utilities
+		def initialize(package,init=false)
+			@package = package
+			@project_path = package_path(package)
+			@metadata_path = repo_path(package)
+			@metadata_indexes_path = index_path(package)
+			unless init
+				self.open()
+			else
+				self.init()
+			end
+		end
+		def open()
+			@repo = Git.open(@project_path.to_s,  { :repository => @metadata_path.to_s, :index => @metadata_indexes_path.to_s})
+			@log = @repo.log
+		end
+		def init()
+			@repo = Git.init(@project_path.to_s,  { :repository => @metadata_path.to_s, :index => @metadata_indexes_path.to_s})
+		end
+		attr_reader :repo
+		attr_reader :project_path
+		attr_reader :package
+		attr_reader :metadata_path
+		attr_reader :metadata_indexes_path
+		attr_reader :log
+		def add(file)
+			@repo.add(file)
+		end
+		def reset()
+			@repo.reset()
+		end
+		def commit_all(commit_message)
+			@repo.commit_all(commit_message)
+		end
+		def commit(commit_message)
+			@repo.commit(commit_message)
+		end
+	end
+end

data/lib/dotter/package.rb

@@ -0,0 +1,60 @@
+require 'dotter/utilities'
+require 'dotter/configuration'
+require 'dotter/gitrepo'
+module Dotter
+	class Package
+		include Utilities
+		def initialize(name)
+			@name = name
+			@config = Configuration.new
+			@our_config = @config.package_config(@name)
+			if self.tracked?
+				@repo = GitRepo.new(name)
+			end
+		end
+		def stow
+			go_to_dotfiles
+			returned_output =  `stow -v #{@name}`
+			@config.set_state(@name, 'stowed')
+			returned_output
+		end
+		def unstow
+			go_to_dotfiles
+			returned_output =  `stow -Dv #{@name}`
+			@config.set_state(@name, 'unstowed')
+			returned_output
+		end
+		def track
+			@repo = GitRepo.new(@name,true)
+			@config.track(@name)
+		end
+		def update
+			go_to_dotfiles
+			returned_output = `stow -Rv #{@name}`
+		end
+		def stowed?
+			@our_config['state'] == 'stowed'
+		end
+		def unstowed?
+			!self.stowed?
+		end
+		def tracked?
+			@our_config['tracked']
+		end
+		def untracked?
+			!self.tracked?
+		end
+		def to_s
+			@name
+		end
+		def public?
+			@our_config['public'] = true
+		end
+		def private?
+			!self.public?
+		end
+		attr_reader :name
+		attr_accessor :config
+		attr_reader :repo
+	end
+end

data/lib/dotter/publicgitrepo.rb

@@ -0,0 +1,42 @@
+require 'git'
+require 'dotter/utilities'
+require 'dotter/gitrepo'
+module Dotter
+	class PublicGitRepo
+		include Utilities
+		def initialize(init=false)
+			@project_path = package_path('public')
+			unless init
+				self.open()
+			else
+				self.init()
+			end
+		end
+		def open
+			@repo = Git.open(@project_path.to_s)
+		end
+		def init
+			@repo = Git.init(@project_path.to_s)
+		end
+		def add_package(package)
+			Dir.chdir(@project_path)
+			packagerepo = GitRepo.new(package)
+			package_repo = packagerepo.repo
+			@repo.add_remote(package.to_s, package_repo)
+			subtree_output = `git subtree add --prefix #{package.to_s} #{package.to_s} master`
+			conf = Configuration.new
+			conf.publish(package)
+			subtree_output
+		end
+		def remove_package(package)
+			Dir.chdir(@project_path)
+			# This was broken with ruby-git. Someone else should check.
+			`git remote remove #{package}`
+			FileUtils.remove_dir(package)
+			@repo.commit_all('Removed package #{package}')
+			conf = Configuration.new
+			conf.unpublish(package)
+		end
+		attr_reader :repo
+	end
+end

data/lib/dotter/utilities.rb

@@ -0,0 +1,25 @@
+ require 'pathname'
+ module Dotter
+	 module Utilities
+		@@dotfiles_path = Pathname(File.expand_path('~/dotfiles')) 
+		def dotfiles_path
+			@@dotfiles_path
+		end
+		def go_to_dotfiles()
+			Dir.chdir(@@dotfiles_path)
+		end
+		def package_path(package)
+			@@dotfiles_path + package
+		end
+		@@dotter_path = @@dotfiles_path + 'dotter'
+		def dotter_path
+			@@dotter_path
+		end
+		def repo_path(package)
+			@@dotter_path + '.dotter/gitrepos/' + package 
+		end
+		def index_path(package)
+			@@dotter_path + '.dotter/indexes/' + package
+		end
+	 end
+end

data/lib/dotter/version.rb

@@ -0,0 +1,4 @@
+module Dotter
+  # dotter version
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: dotter_dotfiles
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Hodgkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple, yet powerful dotfiles manager that wraps around stow and git
+email: samuel.hodgkins@sky.com
+executables:
+- dotter
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rdoc_options"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/dotter
+- dotter.gemspec
+- lib/dotter.rb
+- lib/dotter/cli.rb
+- lib/dotter/configuration.rb
+- lib/dotter/gitrepo.rb
+- lib/dotter/package.rb
+- lib/dotter/publicgitrepo.rb
+- lib/dotter/utilities.rb
+- lib/dotter/version.rb
+homepage: https://rubygems.org/gems/dotter_dotfiles
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A dotfiles managaer
+test_files: []