dotmodule 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: afb5ce73d11f4c18dab49f48ef961de191d90aac
+  data.tar.gz: 35b34b660806d538df722e3380f53d1a35ddaba4
+SHA512:
+  metadata.gz: 2f942872744724b7ee18100dae0db5e586aa37e9f900cc2bf94efe2f6eb2b81c837b825db3eb9cb75b5139d010aeb6964c385044be92cdb7334e382952503ec8
+  data.tar.gz: 1c6876fe409f3ce28cee0ee89009ef235dce4f618aadb8b9d4eac67657b9179695b83852e31ebac0e3e43de91e2224609818864cda03a3815ae79e3357ecda21

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+/*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dotmodule.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Cormac Cannon
+
+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,41 @@
+# Dotmodule
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dotmodule`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dotmodule'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dotmodule
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dotmodule.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dotmodule"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+#require "pry"
+#Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dotmodule.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dotmodule/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dotmodule'
+  spec.version       = DotModule::VERSION
+  spec.authors       = ['Cormac Cannon']
+  spec.email         = ['cormacc.public@gmail.com']
+
+  spec.summary       = %q{Manage dotfiles in a modular fashion using GNU Stow}
+  spec.description   = %q{Wraps GNU stow, using a set of conventions for additions to load path, bash/zsh environment etc.}
+  spec.homepage      = 'https://rubygems.org/gems/dotmodule'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^#{spec.bindir}/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'thor', '~> 0.19.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/exe/dotmodule

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'dotmodule'
+
+DotModule::CLI.start(ARGV)

data/lib/dotmodule/cli.rb

@@ -0,0 +1,28 @@
+require 'thor'
+
+module DotModule
+  class CLI < Thor
+    desc 'install', 'Install one or more modules'
+    # option :modules, :type => :array
+    def install(*modules)
+      collection = DotModule::Collection.new(Dir.pwd)
+      if modules.size.zero?
+        modules = case ask("#{collection}\nNo module argument passed. Install (c)ore/(a)ll/(n)one? [n]:").downcase
+                  when 'a'
+                    collection.modules
+                  when 'c'
+                    collection.core_modules
+                  else #none
+                    []
+                  end
+      end
+      collection.install_modules(modules)
+    end
+
+    desc 'info', 'List module collection details'
+    def info
+      collection = DotModule::Collection.new(Dir.pwd)
+      puts collection
+    end
+  end
+end

data/lib/dotmodule/version.rb

@@ -0,0 +1,3 @@
+module DotModule
+  VERSION = "0.0.1"
+end

data/lib/dotmodule.rb

@@ -0,0 +1,124 @@
+require 'dotmodule/version'
+require 'dotmodule/cli'
+
+require 'fileutils'
+require 'pathname'
+require 'yaml'
+
+##
+# Ruby wrapper for GNU stow, designed for modular dotfile maintenance
+#
+# It doesn't really do a huge amount.
+# In addition to creating symlinks using stow, it allows a set of DOT_PATHS
+# to be defined. These may exist in multiple modules and are created prior to
+# installing any module if not already present.
+#
+# GNU Stow is already clever enough to manage this well, for the most part,
+# however this gets around a corner case with paths also used by the system
+# e.g. ~/.config...
+# Given a module a containing a subdirectory .config/A
+# On a clean system (with no existing ~/.config dir), installing just the i3
+# module will create a symlink ~/.config -> ~/dotfiles/A/.config
+# Installing another module B which contains .config/B will happily replace
+# that symlink with a directory ~/.config containg two symlinks,
+# ~/.config/A -> ~/dotfiles/A/.config/A
+# ~/.config/B -> ~/dotfiles/B/.config/B
+# If another application has created a directory in .config in the meantime,
+# however, this directory will now.
+#
+# Short version -- it is only necessary to define paths as DOT_PATHs if they
+# are likely to be written to by applications/scripts outside the dotmodule
+# framework 
+module DotModule
+
+  ##
+  # A collection of modules, with an optional YAML configuration file
+  class Collection
+
+    CONFIG_FILE_NAME = 'dotmodule.collection'.freeze
+    attr_reader :root
+
+    def initialize(root_path = Dir.pwd)
+      @root = Pathname.new(root_path).expand_path
+      raise ArgumentError, "Directory '#{@root}' not found" unless @root.directory?
+      load_config
+    end
+
+    ##
+    # Load the optional YAML configuration file
+    # Currently, this supports a single array entry listing any folders shared with other applications / the system
+    def load_config
+      file = root+CONFIG_FILE_NAME
+      @config = file.file? ? YAML.load_file(file) : { :shared_directories => nil, :core_modules => nil }
+    end
+    
+    def modules
+      @root.children.select(&:directory?).map(&:basename).map(&:to_s).reject {|d| d.start_with?('.')}
+    end
+
+    def shared_directories
+      @config[:shared_directories]
+    end
+
+    def core_modules
+      @config[:core_modules]
+    end
+
+    def default_target
+      @root.parent
+    end
+
+    def create_shared_directories(target_root)
+      shared_directories.each do |dir|
+        abs_path = Pathname.new(target_root + dir).expand_path
+        unless abs_path.directory?
+          puts "Directory '#{abs_path}' not found, creating..."
+          FileUtils.mkdir_p(abs_path)
+        end
+      end
+    end
+
+    def install_module(name, target=default_target)
+      create_shared_directories(target)
+      puts "... installing #{name} ..."
+      raise ArgumentError, "Module '#{name}' not found" unless (@root+name).directory?
+
+      system "stow -d #{@root} -t #{target} #{name}"
+    end
+
+    def install_modules(module_names, target=default_target)
+      puts "Installing #{module_names.size} modules ..." unless modules.size.zero?
+      module_names.each do |m|
+        begin
+          install_module(m)
+        rescue ArgumentError
+          puts "WARNING: Module '#{m}' not found"
+          break unless ask('... (a)bort or (c)ontinue [a]: ') == 'c'
+        end
+      end
+    end
+
+    def install_all(target=default_target)
+      install_modules(modules)
+    end
+
+    def to_s
+      <<~HEREDOC
+
+      Collection root:    #{@root}
+      Default target:     #{default_target}
+
+      Shared target subdirectories:
+        #{shared_directories.join(', ')}
+
+      Modules:
+        #{modules.join(', ')}
+
+      Core modules:
+        #{core_modules.join(', ')}
+
+      HEREDOC
+    end
+  end
+
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: dotmodule
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cormac Cannon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: Wraps GNU stow, using a set of conventions for additions to load path,
+  bash/zsh environment etc.
+email:
+- cormacc.public@gmail.com
+executables:
+- dotmodule
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dotmodule.gemspec
+- exe/dotmodule
+- lib/dotmodule.rb
+- lib/dotmodule/cli.rb
+- lib/dotmodule/version.rb
+homepage: https://rubygems.org/gems/dotmodule
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Manage dotfiles in a modular fashion using GNU Stow
+test_files: []