sheldon 0.2.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc997c5b4f37ad9017e95676da13f93ccda540c2
+  data.tar.gz: 3597991837046118327d7a54d29bac5c648755c5
+SHA512:
+  metadata.gz: fdf2d411262be96f41d48f8c09d49e89214d5cc66adcbacdf6f4501e84e709d45145df515a687d43096857a619c774b5b776ad16024757129875d5aa8374ab43
+  data.tar.gz: 9b20b0a6110eb0f7210314f00c80d26c2302d70c411bd2ceea67a994ce3c9bf250d1dc9aa2df2489eae49b4cf53431a10bd488ff032e967fdcc64f2d721ad95b

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 David V Jones
+
+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,86 @@
+# Sheldon
+[![Build Status](https://travis-ci.org/dvjones89/sheldon.svg?branch=master)](https://travis-ci.org/dvjones89/sheldon)
+
+Designed with the obsessive developer in mind, Sheldon makes it easy for you to manage your .dotfiles and configs across all your OS X / linux devices.  
+
+### How It Works
+#### Add files/folders to Sheldon (sheldon learn)
+Teach Sheldon about new files or directories using the `learn` command:
+```shell
+sheldon learn ~/.gitconfig
+Recall Cue For File/Folder: git
+```
+
+Sheldon will move the original file/directory into his data directory (defaults to `~/sheldon`) and symlink back to it's original location.
+```shell
+ls -al ~ | grep .gitconfig
+.gitconfig -> /Users/dave/sheldon/git/.gitconfig
+```
+Keep Sheldon's data directory synchronised across all your devices using your tool of choice, Dropbox, Google Drive, BTSync.
+
+#### Recall your files on other machines (sheldon recall)
+Sheldon's `recall` command will symlink the file from the data directory to it's correct location on any filesystem (even under different home directories):
+
+```shell
+sheldon recall git
+
+ls -al ~ | grep .gitconfig
+.gitconfig -> /Users/john/sheldon/git/.gitconfig
+```
+
+Pass the `-i` flag to Sheldon's `recall` command for interactive mode:
+```shell
+sheldon recall -i
+Recall git_config (Y/N): y
+Recall .zshrc (Y/N): y
+```
+
+#### Build Bespoke Configs For Your Host (sheldon build)
+Sometimes copying an entire config file between all your machine is overkill. What if you only want a subset of your configuration? Sheldon can help.
+
+Split your ssh config into `config_work` and `config_personal`
+
+Use Sheldon `learn` and `recall` to make the appropriate `_config` files available on the appropriate hosts.
+
+Once the files are in the right place, use Sheldon `build` to create a single `config` file that can be easily sourced.
+
+```shell
+cd ~/.ssh
+
+ls -l
+config_dev -> /Users/dave/sheldon/ssh_config_dev/config_dev
+config_personal -> /Users/dave/sheldon/ssh_config_personal/config_personal
+
+sheldon build ~/.ssh
+💥 Sheldon💥  Built .ssh
+
+ls -l
+config_dev -> /Users/dave/sheldon/ssh_config_dev/config_dev
+config_personal -> /Users/dave/sheldon/ssh_config_personal/config_personal
+config
+
+source ~/.ssh/config
+```
+
+### Installation:
+1) `gem install Sheldon-<version>.gem`
+
+2) Sync Sheldon's data directory (`~/sheldon` by default) across all of your machines. You can override the default folder location by setting the`SHELDON_DATA_DIR` environment variable on each host.
+
+### Isn't This Just Homesick?
+Yes, yes it is. Unfortunately, I'd written 90% of Sheldon before I discovered the awesome [homesick](https://github.com/technicalpickles/homesick) so I decided to keep going.  
+Sheldon's `build` command is (as far as I know) unique to Sheldon and will perhaps prove useful to those who chunk their configs.  
+If nothing else, I hope this code will be a good point of reference for other developers (and indeed my future self).
+
+### Contributing
+
+1. Fork it ( https://github.com/[your-github-username]/sheldon/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Make sure you haven't broken anything `bundle exec rspec`
+5. Add your own specs for your new feature
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create a new Pull Request
+
+### License
+See LICENSE

data/bin/sheldon

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+require "thor"
+require_relative "../lib/sheldon"
+
+module CLI
+  class Sheldon < Thor
+    map link: :recall
+    map ls: :list
+
+    desc "build path", "Tell Sheldon to build all config_ files in a directory to single master config"
+    def build(rel_path_to_target)
+      abs_learn_path = File.expand_path(rel_path_to_target)
+      sheldon.build(abs_learn_path)
+      announce("Built #{File.basename(rel_path_to_target)}")
+    end
+
+    desc "learn path", "Add a new file/folder to Sheldon's brain. Supply a recall_cue at runtime."
+    def learn(rel_path_to_target)
+      abs_learn_path = File.expand_path(rel_path_to_target)
+      recall_cue = prompt_user("Recall Cue For File/Folder")
+      sheldon.learn(recall_cue, abs_learn_path)
+    end
+
+    desc "recall recall_cue", "Symlink a previously learnt file/directory to it's original location on the filesystem.\nUse `sheldon list` for available cues."
+    option :i, type: :boolean, desc: "Interactive mode - prompts Y/N for each available recall_cue"
+
+    def recall(recall_cue=nil)
+      if options[:i]
+        sheldon.list_cues.each do |recall_cue|
+          answer = prompt_user("Recall #{recall_cue}? (Y/N)")
+          sheldon.recall(recall_cue) if answer.downcase == "y"
+        end
+      else
+        recall_cue ||= prompt_user("Recall Cue For File/Folder")
+        sheldon.recall(recall_cue)
+      end
+
+      announce("Recall Complete.")
+    end
+
+    desc "list", "List all recall cues known by Sheldon"
+    def list
+      puts sheldon.list_cues
+    end
+
+    desc "version", "Prints the current version of Sheldon"
+    def version
+      announce ::Sheldon::VERSION
+    end
+
+    private
+
+    def prompt_user(prompt)
+      print(prompt + ": ")
+      STDIN.gets.chomp
+    end
+
+    def announce(message)
+      logo = "💥".encode("utf-8")
+      puts logo + " Sheldon" + logo + "  #{message}"
+    end
+
+    def sheldon
+      @sheldon ||= ::Sheldon.new(sheldon_data_dir)
+    end
+
+    def sheldon_data_dir
+      path = ENV["SHELDON_DATA_DIR"] || "~/sheldon"
+      File.expand_path(path)
+    end
+
+  end
+end
+
+CLI::Sheldon.start(ARGV)

data/lib/sheldon.rb

@@ -0,0 +1,7 @@
+require_relative "sheldon/brain"
+require_relative "sheldon/builder"
+require_relative "sheldon/helpers"
+require_relative "sheldon/memory"
+require_relative "sheldon/sheldon"
+
+include Helpers

data/lib/sheldon/brain.rb

@@ -0,0 +1,51 @@
+class Brain
+
+  attr_reader :memory
+
+  def initialize(sheldon_data_dir, opts = {})
+    @brain_location = sheldon_data_dir
+    @memory = opts[:memory] || Memory.new(@brain_location)
+  end
+
+
+  def learn(recall_cue, abs_learn_path)
+    cell = get_cell(recall_cue)
+    FileUtils.mkdir_p(cell)
+    FileUtils.mv(abs_learn_path, cell)
+    entry = { filepath: remove_home(abs_learn_path) }
+    memory.add(recall_cue, entry)
+  end
+
+  def recall(recall_cue)
+    entry = memory.recall(recall_cue)
+    destination_path = add_home(entry[:filepath])
+    destination_dir = File.dirname(destination_path)
+    FileUtils.mkdir_p(destination_dir) unless File.directory?(destination_dir)
+    source_cell = get_cell(recall_cue)
+    FileUtils.ln_s(read_cell(source_cell), destination_path, force: true)
+  end
+
+  def has_cue?(recall_cue)
+    memory.has_cue?(recall_cue)
+  end
+
+  def size
+    memory.size
+  end
+
+  def list_cues
+    memory.list_cues
+  end
+
+  private
+
+  def get_cell(recall_cue)
+    File.join(@brain_location, recall_cue)
+  end
+
+  def read_cell(cell)
+    basename = (Dir.entries(cell) - [".", "..", ".DS_Store"]).first
+    File.join(cell, basename)
+  end
+
+end

data/lib/sheldon/builder.rb

@@ -0,0 +1,28 @@
+class Builder
+  require "fileutils"
+
+  def build(abs_build_path)
+    entries = Dir.glob(abs_build_path + "/*")
+    master_content = entries.inject("") do |buffer, entry|
+      is_config?(entry) ? add_entry_to_buffer(entry, buffer) : buffer
+    end
+
+    unless master_content.empty?
+      master_path = File.join(abs_build_path, "config")
+      File.open(master_path, "w") { |f| f.write(master_content) }
+    end
+  end
+
+  private
+
+  def add_entry_to_buffer(abs_path, buffer)
+    content = File.read(abs_path)
+    buffer + content + "\n"
+  end
+
+  def is_config?(abs_path)
+    basename = File.basename(abs_path)
+    File.file?(abs_path) && basename.include?("config_") ? true : false
+  end
+
+end

data/lib/sheldon/helpers.rb

@@ -0,0 +1,18 @@
+module Helpers
+  require "pathname"
+
+  def remove_home(path)
+    home_path = Pathname(File.expand_path("~"))
+    Pathname(path).relative_path_from(home_path).to_s
+  end
+
+  def add_home(path)
+    abs_home = File.expand_path("~")
+    File.join(abs_home, path).to_s
+  end
+
+  def abs(rel_path)
+    File.expand_path(rel_path).to_s
+  end
+
+end

data/lib/sheldon/memory.rb

@@ -0,0 +1,34 @@
+require "yaml/store"
+
+class Memory
+
+  def initialize(brain_location)
+    database_path = File.join(brain_location, "db.yml")
+    @database = YAML::Store.new(database_path)
+  end
+
+  def add(recall_cue, hash)
+    raise "cue already used" if has_cue?(recall_cue)
+    @database.transaction do
+      @database[recall_cue] = hash
+    end
+  end
+
+  def recall(recall_cue)
+    raise "no entry for cue" unless has_cue?(recall_cue)
+    @database.transaction { @database[recall_cue] }
+  end
+
+  def size
+    list_cues.size
+  end
+
+  def list_cues
+    @database.transaction { @database.roots }
+  end
+
+  def has_cue?(recall_cue)
+    list_cues.any?{ |cue| cue == recall_cue }
+  end
+
+end

data/lib/sheldon/sheldon.rb

@@ -0,0 +1,35 @@
+require "fileutils"
+
+class Sheldon
+  VERSION = "0.2.6".freeze
+  attr_reader :brain, :builder
+
+  def initialize(sheldon_data_dir, opts = {})
+    raise "Directory #{sheldon_data_dir} does not exist" unless Dir.exists?(sheldon_data_dir)
+    @brain = opts[:brain] || Brain.new(sheldon_data_dir)
+    @builder = opts[:builder] || Builder.new
+  end
+
+  def build(abs_learn_path)
+    builder.build(abs_learn_path)
+  end
+
+  def learn(recall_cue, abs_learn_path)
+    if brain.has_cue?(recall_cue)
+      raise "This cue has already been used."
+    else
+      brain.learn(recall_cue, abs_learn_path)
+      brain.recall(recall_cue)
+    end
+  end
+
+  def list_cues
+    brain.list_cues
+  end
+
+  def recall(recall_cue)
+    raise "Cue '#{recall_cue}' could not be found." unless brain.has_cue?(recall_cue)
+    brain.recall(recall_cue)
+  end
+
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: sheldon
+version: !ruby/object:Gem::Version
+  version: 0.2.6
+platform: ruby
+authors:
+- David Jones
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Another config and dotfile manager for unix environments
+email: david@dvj.me.uk
+executables:
+- sheldon
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/sheldon
+- lib/sheldon.rb
+- lib/sheldon/brain.rb
+- lib/sheldon/builder.rb
+- lib/sheldon/helpers.rb
+- lib/sheldon/memory.rb
+- lib/sheldon/sheldon.rb
+homepage: https://github.com/dvjones89/sheldon
+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: Another config and dotfile manager for unix environments
+test_files: []