sheldon 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3849dcc28716d5aafca1ee0dafda7347d12ae85
-  data.tar.gz: e6a90dc5d6027d5f4e7114aecae52d5b14db2995
+  metadata.gz: 487c6c4147a1150abb17257433fcda2b6f6ad629
+  data.tar.gz: 53510c73fd4fda5290524726616714f012ccbb27
 SHA512:
-  metadata.gz: fc98eca6fdbb01a0c384aa029620c0286764f36f3d3599ac3dcd9751b07b81eb9548ec108e3421adda50da998949af08942d15adb3ccd91d93a774a9f8d52577
-  data.tar.gz: 58a7b7b0dddead7f6363b513198026bc7501d4f980c1d71ad38d5ac0d333aa9ccefbd8c78d55cad428239cb8efeaf07575b94c7aa25c5cbc166ce122ae9e06c4
+  metadata.gz: 84bf9a06bd954b774f95b1d8888fe6b271e7a5a2f09d178365720110d24ceea9fcf2734f32f3939359349e2687c7b3ecc07405b7578910d5d6cbf74a7494ab20
+  data.tar.gz: 0d21743a01c3495b37c257f7c5ad670eb7f754f15dd6d0a83ea3a35ee82c51b8097a8c6a805705947edf77e8ecc00c7750bce63901deb2f92e820a50f97c15a0

data/bin/sheldon

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 require "thor"
+require "tty-prompt"
 require_relative "../lib/sheldon"
 
 module CLI
@@ -18,23 +19,23 @@ module CLI
         if sheldon.build(abs_build_path)
           announce("Built #{File.basename(rel_path_to_target)}")
         else
-          say("Could not find any config_ files at #{abs_build_path}", :red)
+          prompt.error("Could not find any config_ files at #{abs_build_path}")
         end
       end
     end
 
     desc "forget recall_cue", "Remove file/folder from Sheldon's brain"
     def forget(recall_cue=nil)
-      recall_cue ||= ask("Recall Cue For File/Folder")
+      recall_cue ||= cue_picker("What would you like to forget?")
       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."
+    desc "learn path_to_target", "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)
       default_cue = File.basename(rel_path_to_target)
-      recall_cue = ask("Recall Cue For File/Folder", default: default_cue)
+      recall_cue = prompt.ask("Recall Cue For File/Folder", default: default_cue, required: true)
       with_exception_handling { sheldon.learn(recall_cue, abs_learn_path) }
       with_exception_handling { sheldon.recall(recall_cue) }
     end
@@ -42,21 +43,36 @@ module CLI
     desc "list", "List all recall cues known by Sheldon"
     def list
       sheldon.list_cues.each do |recall_cue|
-        sheldon.recalled?(recall_cue) ? say(recall_cue, :green) : say(recall_cue, :red)
+        sheldon.recalled?(recall_cue) ? prompt.say(recall_cue, color: :green) : prompt.say(recall_cue, color: :red)
       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."
+    desc "open recall_cue", "Open your file/folder contents in your default editor"
+    def open(recall_cue=nil)
+      editor = ENV['EDITOR']
+      error_and_exit("Your system does not define a default editor. Please set $EDITOR and try again.") if editor.nil?
+
+      recall_cue ||= cue_picker("What would you like to open?")
+      error_and_exit("#{recall_cue} has not been recalled on this computer. Use `sheldon recall #{recall_cue}` and then try again.") unless sheldon.recalled?(recall_cue)
+
+      with_exception_handling do
+        memory_entry = sheldon.brain.memory.recall(recall_cue)
+        filepath = add_home(memory_entry[:filepath])
+        system("#{ENV['EDITOR']} '#{filepath}'")
+      end
+    end
+
+    desc "recall recall_cue", "Recall 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 = ask("Recall #{recall_cue}? (Y/N)")
+          answer = prompt.yes?("Recall #{recall_cue}?")
           with_exception_handling { sheldon.recall(recall_cue) if answer.downcase == "y" }
         end
       else
-        recall_cue ||= ask("Recall Cue For File/Folder")
+        recall_cue = cue_picker("What would you like to recall?")
         with_exception_handling { sheldon.recall(recall_cue) }
       end
 
@@ -65,16 +81,16 @@ module CLI
 
     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 ||= ask("Please supply location for new/existing data directory")
+      rel_data_path ||= prompt.ask("Please supply location for new/existing data directory", required: true)
       abs_data_path = File.expand_path(rel_data_path)
       with_exception_handling do
         sheldon = ::Sheldon.new(abs_data_path)
 
         if sheldon.brain.present?
-          say("Using existing Sheldon database found at #{abs_data_path}.", :green)
+          prompt.ok("Using existing Sheldon database found at #{abs_data_path}.")
         else
           sheldon.setup!
-          say("New Sheldon database created at #{abs_data_path}", :green)
+          prompt.ok("New Sheldon database created at #{abs_data_path}")
         end
 
         write_to_dotfile("data_directory", sheldon.brain.location)
@@ -93,6 +109,19 @@ module CLI
       puts logo + " Sheldon" + logo + "  #{message}"
     end
 
+    def error_and_exit(message)
+      prompt.error(message)
+      exit!
+    end
+
+    def prompt
+      @prompt ||= TTY::Prompt.new(interrupt: :exit)
+    end
+
+    def cue_picker(message)
+      prompt.select(message, sheldon.list_cues, per_page: 20, filter: true)
+    end
+
     def read_from_dotfile(key)
       dotfile = YAML::Store.new(add_home(".sheldon"))
       dotfile.transaction { dotfile[key] }
@@ -104,7 +133,7 @@ module CLI
 
     def sheldon_data_dir
       sheldon_data_dir = read_from_dotfile("data_directory") || ENV['SHELDON_DATA_DIR']
-      sheldon_data_dir || raise("No configuration found. Please run `sheldon setup`")
+      sheldon_data_dir || error_and_exit("No configuration found. Please run `sheldon setup`")
     end
 
     def with_exception_handling(&block)
@@ -113,7 +142,7 @@ module CLI
       if options[:debug]
         puts ([e.inspect] + e.backtrace).join("\n")
       else
-        say(e.message + "\nUse --debug to print backtrace", :red)
+        prompt.error(e.message + "\nUse --debug to print backtrace")
       end
       exit!
     end

data/lib/sheldon/brain.rb

@@ -24,7 +24,7 @@ class Brain
   def learn(recall_cue, abs_learn_path)
     raise "recall cue cannot be empty." if recall_cue.strip.empty?
     raise "This cue has already been used." if has_cue?(recall_cue)
-    raise "Unable to find a file or folder at #{abs_learn_path}" unless File.exists?(abs_learn_path)
+    raise "Unable to find a file or folder at #{abs_learn_path}" unless File.exist?(abs_learn_path)
 
     brain_path = brain_path_for_cue(recall_cue)
     FileUtils.mkdir_p(brain_path)

data/lib/sheldon/memory.rb

@@ -30,7 +30,7 @@ class Memory
   end
 
   def present?
-    File.exists?(@database.path)
+    File.exist?(@database.path)
   end
 
   def save!

data/lib/sheldon/sheldon.rb

@@ -1,11 +1,11 @@
 require "fileutils"
 
 class Sheldon
-  VERSION = "0.5.5".freeze
+  VERSION = "0.6.0".freeze
   attr_reader :brain, :builder
 
   def initialize(sheldon_data_dir)
-    unless Dir.exists?(sheldon_data_dir)
+    unless Dir.exist?(sheldon_data_dir)
       raise MissingDataDirectoryException, "Directory #{sheldon_data_dir} does not exist."
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sheldon
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
 platform: ruby
 authors:
 - David Jones
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-29 00:00:00.000000000 Z
+date: 2018-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -24,6 +24,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement