sheldon 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73892f48dbd187ec12c86c61e4e4a7db3ba3fd28
-  data.tar.gz: 9b7c3048b7cd07c67fdcfc4d705ed559f0e30df3
+  metadata.gz: 09ae36b8d2caa6f99c7615897f8be3f0307d2046
+  data.tar.gz: 983e9c673075ade9d355051d478ba2d5384c27a0
 SHA512:
-  metadata.gz: 6e90b362ed860b5de2a01629144c827628af88d70817864d6fe8b47106e6acd640547c627e3279ab79ba0e1862b080b5571ef8cabc3c33c405018f10716c3d89
-  data.tar.gz: 7c94643012c59f402686f4d2c2bddf0ae81361d2dafa916a3f0f7cdaf4814c9a22f25edf1d94c04f3b55082fee582d75ec5ea4ac9dc2e904cafb63aca99bf6bc
+  metadata.gz: 574459c5e4af0e7039ff69d9c2e23ad53830414961cbed245a478966f7eb685cfff85b023d324cf0991240aeabf8d8f946857c8f77e9a93d91f120a3c7dc2fee
+  data.tar.gz: 52be880c55eab8afbd7f9f34524179a74b55b5f5ebf60b6c790a119d83bc54ed75adf39b800a540a96ab989a04b7998aebd7b004cfec44fd244eac114f7aff24

data/bin/sheldon

@@ -9,13 +9,22 @@ module CLI
     map "-v" => :version
     map "--version" => :version
 
+    class_option :debug, :desc => "Print errors and backtraces to the console for debugging."
+
     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)
-      with_exception_handling{ sheldon.build(abs_learn_path) }
+      abs_build_path = File.expand_path(rel_path_to_target)
+      with_exception_handling{ sheldon.build(abs_build_path) }
       announce("Built #{File.basename(rel_path_to_target)}")
     end
 
+    desc "forget recall_cue", "Remove file/folder from Sheldon's brain"
+    def forget(recall_cue=nil)
+      recall_cue ||= prompt_user("Recall Cue For File/Folder")
+      with_exception_handling { sheldon.forget(recall_cue) }
+      announce("I've forgotten about #{recall_cue}. Let us never mention it again.")
+    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)
@@ -25,6 +34,13 @@ module CLI
       with_exception_handling { sheldon.recall(recall_cue) }
     end
 
+    desc "list", "List all recall cues known by Sheldon"
+    def list
+      sheldon.list_cues.each do |recall_cue|
+        sheldon.recalled?(recall_cue) ? green(recall_cue) : red(recall_cue)
+      end
+    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"
 
@@ -42,17 +58,21 @@ module CLI
       announce("Recall Complete.")
     end
 
-    desc "forget recall_cue", "Remove file/folder from Sheldon's brain"
-    def forget(recall_cue=nil)
-      recall_cue ||= prompt_user("Recall Cue For File/Folder")
-      with_exception_handling { sheldon.forget(recall_cue) }
-      announce("I've forgotten about #{recall_cue}. Let us never mention it again.")
-    end
+    desc "setup path_to_data_directory", "Setup Sheldon on this host, supplying the path that where Sheldon's data directory can be found, or should be created."
+    def setup(rel_data_path=nil)
+      rel_data_path ||= prompt_user("Please supply location for new/existing data directory")
+      abs_data_path = File.expand_path(rel_data_path)
+      with_exception_handling do
+        sheldon = ::Sheldon.new(abs_data_path)
+
+        if sheldon.brain.present?
+          green "Using existing Sheldon database found at #{abs_data_path}."
+        else
+          sheldon.setup!
+          green "New Sheldon database created at #{abs_data_path}"
+        end
 
-    desc "list", "List all recall cues known by Sheldon"
-    def list
-      sheldon.list_cues.each do |recall_cue|
-        sheldon.recalled?(recall_cue) ? green(recall_cue) : red(recall_cue)
+        write_to_dotfile("data_directory", sheldon.brain.location)
       end
     end
 
@@ -63,41 +83,55 @@ module CLI
 
     private
 
+    def announce(message)
+      logo = "💥".encode("utf-8")
+      puts logo + " Sheldon" + logo + "  #{message}"
+    end
+
+    def green(message)
+      puts "\e[32m#{message}\e[0m"
+    end
+
     def prompt_user(prompt)
       print(prompt + ": ")
       input = STDIN.gets.chomp.strip
       input.empty? ? nil : input
     end
 
-    def green(message)
-      puts "\e[32m#{message}\e[0m"
+    def read_from_dotfile(key)
+      dotfile = YAML::Store.new(add_home(".sheldon"))
+      dotfile.transaction { dotfile[key] }
     end
 
     def red(message)
       puts "\e[31m#{message}\e[0m"
     end
 
-    def announce(message)
-      logo = "💥".encode("utf-8")
-      puts logo + " Sheldon" + logo + "  #{message}"
-    end
-
     def sheldon
       with_exception_handling { @sheldon ||= ::Sheldon.new(sheldon_data_dir) }
     end
 
     def sheldon_data_dir
-      path = ENV["SHELDON_DATA_DIR"] || "~/sheldon"
-      File.expand_path(path)
+      sheldon_data_dir = read_from_dotfile("data_directory") || ENV['SHELDON_DATA_DIR']
+      sheldon_data_dir || raise("No configuration found. Please run `sheldon setup`")
     end
 
     def with_exception_handling(&block)
       yield
     rescue Exception => e
-      announce(e.message)
+      if options[:debug]
+        puts ([e.inspect] + e.backtrace).join("\n")
+      else
+        red(e.message + "\nUse --debug to print backtrace")
+      end
       exit(1)
     end
 
+    def write_to_dotfile(key, value)
+      dotfile = YAML::Store.new(add_home(".sheldon"))
+      dotfile.transaction { dotfile[key] = value }
+    end
+
   end
 end
 

data/lib/sheldon/brain.rb

@@ -1,12 +1,25 @@
 class Brain
 
-  attr_reader :memory
+  attr_reader :memory, :location
 
-  def initialize(sheldon_data_dir, opts = {})
-    @brain_location = sheldon_data_dir
-    @memory = opts[:memory] || Memory.new(@brain_location)
+  def initialize(sheldon_data_dir)
+    @location = sheldon_data_dir
+    @memory = Memory.new(@location)
   end
 
+  def forget(recall_cue)
+    entry = memory.recall(recall_cue)
+    brain_path = brain_path_for_cue(recall_cue)
+    destination_path = add_home(entry[:filepath])
+    FileUtils.rm_r(destination_path) if recalled?(recall_cue)
+    FileUtils.rm_r(brain_path)
+
+    memory.forget(recall_cue)
+  end
+
+  def has_cue?(recall_cue)
+    memory.has_cue?(recall_cue)
+  end
 
   def learn(recall_cue, abs_learn_path)
     raise "recall cue cannot be empty." if recall_cue.strip.empty?
@@ -20,6 +33,14 @@ class Brain
     memory.add(recall_cue, entry)
   end
 
+  def list_cues
+    memory.list_cues
+  end
+
+  def present?
+    memory.present?
+  end
+
   def recall(recall_cue)
     entry = memory.recall(recall_cue)
     destination_path = add_home(entry[:filepath])
@@ -27,16 +48,7 @@ class Brain
     FileUtils.mkdir_p(destination_dir) unless File.directory?(destination_dir)
     brain_path = brain_path_for_cue(recall_cue)
     FileUtils.ln_s(get_content(brain_path), destination_path, force: true)
-  end
-
-  def forget(recall_cue)
-    entry = memory.recall(recall_cue)
-    brain_path = brain_path_for_cue(recall_cue)
-    destination_path = add_home(entry[:filepath])
-    FileUtils.rm_r(destination_path) if recalled?(recall_cue)
-    FileUtils.rm_r(brain_path)
-
-    memory.forget(recall_cue)
+    return true
   end
 
   def recalled?(recall_cue)
@@ -47,22 +59,14 @@ class Brain
     File.symlink?(destination_path) && File.exists?(File.readlink(destination_path))
   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 brain_path_for_cue(recall_cue)
-    File.join(@brain_location, recall_cue)
+    File.join(@location, recall_cue)
   end
 
   def get_content(path)

data/lib/sheldon/builder.rb

@@ -7,9 +7,12 @@ class Builder
       is_config?(entry) ? add_entry_to_buffer(entry, buffer) : buffer
     end
 
-    unless master_content.empty?
+    if master_content.empty?
+      return false
+    else
       master_path = File.join(abs_build_path, "config")
       File.open(master_path, "w") { |f| f.write(master_content) }
+      return true
     end
   end
 

data/lib/sheldon/helpers.rb

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

data/lib/sheldon/memory.rb

@@ -12,28 +12,38 @@ class Memory
     @database.transaction do
       @database[recall_cue] = hash
     end
-  end
-
-  def recall(recall_cue)
-    raise "no entry for cue '#{recall_cue}'" unless has_cue?(recall_cue)
-    @database.transaction { @database[recall_cue] }
+    return true
   end
 
   def forget(recall_cue)
     raise "no entry for cue" unless has_cue?(recall_cue)
     @database.transaction{ @database.delete(recall_cue) }
+    return true
   end
 
-  def size
-    list_cues.size
+  def has_cue?(recall_cue)
+    list_cues.any?{ |cue| cue == recall_cue }
   end
 
   def list_cues
     @database.transaction { @database.roots }
   end
 
-  def has_cue?(recall_cue)
-    list_cues.any?{ |cue| cue == recall_cue }
+  def present?
+    File.exists?(@database.path)
+  end
+
+  def save!
+    @database.transaction{@database.commit}
+  end
+
+  def recall(recall_cue)
+    raise "no entry for cue '#{recall_cue}'" unless has_cue?(recall_cue)
+    @database.transaction { @database[recall_cue] }
+  end
+
+  def size
+    list_cues.size
   end
 
 end

data/lib/sheldon/sheldon.rb

@@ -1,36 +1,40 @@
 require "fileutils"
 
 class Sheldon
-  VERSION = "0.4.1".freeze
+  VERSION = "0.5.0".freeze
   attr_reader :brain, :builder
 
-  def initialize(sheldon_data_dir, opts = {})
+  def initialize(sheldon_data_dir)
     unless Dir.exists?(sheldon_data_dir)
-      raise MissingDataDirectoryException, "The data directory (#{sheldon_data_dir}) doesn't exist. Please create the directory or set an alternative using the $SHELDON_DATA_DIR environment variable."
+      raise MissingDataDirectoryException, "Directory #{sheldon_data_dir} does not exist."
     end
 
-    @brain = opts[:brain] || Brain.new(sheldon_data_dir)
-    @builder = opts[:builder] || Builder.new
+    @brain = Brain.new(sheldon_data_dir)
+    @builder = Builder.new
   end
 
   def build(abs_learn_path)
     builder.build(abs_learn_path)
   end
 
+  def forget(recall_cue)
+    brain.forget(recall_cue)
+  end
+
   def learn(recall_cue, abs_learn_path)
     brain.learn(recall_cue, abs_learn_path)
   end
 
-  def recall(recall_cue)
-    brain.recall(recall_cue)
+  def list_cues
+    brain.list_cues
   end
 
-  def forget(recall_cue)
-    brain.forget(recall_cue)
+  def recall(recall_cue)
+    brain.recall(recall_cue)
   end
 
-  def list_cues
-    brain.list_cues
+  def setup!
+    brain.memory.save!
   end
 
   def recalled?(recall_cue)

metadata

@@ -1,89 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: sheldon
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - David Jones
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-16 00:00:00.000000000 Z
+date: 2018-04-11 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: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.13
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '9.0'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 9.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '9.0'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 9.0.0
 description: Another config and dotfile manager for unix environments
@@ -93,16 +93,16 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
-- README.md
-- bin/sheldon
-- lib/sheldon.rb
 - lib/sheldon/brain.rb
 - lib/sheldon/builder.rb
 - lib/sheldon/exceptions.rb
 - lib/sheldon/helpers.rb
 - lib/sheldon/memory.rb
 - lib/sheldon/sheldon.rb
+- lib/sheldon.rb
+- bin/sheldon
+- LICENSE
+- README.md
 homepage: https://github.com/dvjones89/sheldon
 licenses:
 - MIT
@@ -113,17 +113,17 @@ 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
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Another config and dotfile manager for unix environments