recollect 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0600b7dae82a9c3853a28f73ce154cdd77a105ea
-  data.tar.gz: b2df4c99b9c99c2aee08e051cf07f0042b6f63e1
+  metadata.gz: e3d00282c17fba86e18ad631460ffcc5cc226e76
+  data.tar.gz: a59f90c81d71381aa96892d9d8ee3505faf85538
 SHA512:
-  metadata.gz: ae745ccda2932e8fb783321a627f0875cfdbbcf5e7385ea9c6729efca42ee77f872ac1e7ddb64d414a3e764524d383e5b1a7e697e9a6c79da6c5dbab53e0c94d
-  data.tar.gz: 32eba3f3a177b06d1e3beb8bc6593be4a8d4a989f24d41b8258d9f4dcceeae253073c5fecdd92804e11a447d6e747b42789ac06da749ae0543fca07fed098fc1
+  metadata.gz: '084a527836009242fc5658f36dccc22131dede1092d1bcfc68e171c928f006e648b74cc364d1c35f0fb6d28f0c213600075fbe64826016ee8ae08d9a95158871'
+  data.tar.gz: 7395a729ae2753b11a1da054191f8e9bf0d1ff745b78985b00688e6277f5bf8ec9f9374522eb677bcea257576f82a4ec45a8ded1544f9074e6c233f90bb390cb

data/README.md

@@ -7,9 +7,13 @@ A simple tool for creating, managing, and viewing snippets, notes, or pretty muc
 
     gem install recollect
 
-If you haven't already, you should set your EDITOR. On OSX you can set it to Textmate with a command like:
 
-    echo 'export EDITOR="mate -w" >> ~/.bash_profile
+### Search Functions
+Recollect includes both a `search` directive and a recollection matching capability.
+
+The search capability looks inside of files for a specific search string using a line match (`=~ /string/`).
+
+The recollection match will try to find similar recollection names when showing a recollection or when using edit, remove, or append. When only one match is found the user is prompted to confirm this is the recollection intended; on confirmation the requested action will be executed. When multiple matches are found they will be displayed as suggestions.
 
 ### Usage
 
@@ -30,4 +34,38 @@ If you haven't already, you should set your EDITOR. On OSX you can set it to Tex
     Note: ["new", "edit", "remove", "help", "search", "append"] are reserved and cannot be the name
     of a recollection.
 
-    Version: 0.1.0
+    Version: 0.2.0
+
+### Examples
+
+If you haven't already, you should set your EDITOR. On OSX you can set it to Textmate with a command like:
+
+    echo 'export EDITOR="mate -w" >> ~/.bash_profile
+
+##### Create a new recollection named git
+    recollect new git   # edit, save, and close the editor
+    
+##### List the available recollections
+    recollect list
+
+##### List the available recollections under mysql/
+    recollect list mysql
+    
+##### Edit the git recollection
+    recollect edit git  # edit, save, and close the editor
+    
+##### Display the git recollection
+    recollect git
+    
+##### Search for recollections containing 'postgres'
+    recollect search 'postgres'
+    
+##### Find with a partial recollection name
+    recollect ra
+    
+    > **** Unable to find a recollection matching 'ra'
+    > You might have meant:
+    >   raid
+    >   rails
+    >   unicorn/rack
+    

data/lib/recollect/recollect.rb

@@ -5,12 +5,12 @@ require 'version'
 module Recollect
   class Recollection
     def initialize(args)
-      @reserved = %w[new edit remove help search append]
+      @reserved = %w[new edit remove help list search append]
       @action, @name, @append_string = args
       usage unless args.length >= 1 && args.length <= 3
       usage if @action == 'append' && args.length != 3
       usage if @action != 'append' && args.length > 2
-      usage if @reserved.include?(@action) && args.length < 2
+      usage if @reserved.include?(@action) && args.length < 2 && @action != 'list'
       usage if args.length == 2 && @reserved.include?(@name)
       @separator = '-------------------------'
       @recollect_path = File.join(ENV['HOME'], '.recollections')
@@ -66,10 +66,22 @@ module Recollect
     def verify_name(item = @name)
       unless item_exists?(item)
         puts "**** Unable to find a recollection matching '#{item}'"
+        similar = find_similar(item)
         if File.directory?(File.join(@recollect_path, item))
           puts "Here are the contents of that category:"
           list_recollections(item)
           exit
+        elsif similar.length == 1
+          puts "Did you mean: '#{nice_name(similar.first)}' [Y/n]?"
+          if confirm?
+            @name = nice_name(similar.first)
+          else
+            exit
+          end
+        elsif similar.length > 1
+          puts "You might have meant:"
+          similar.each { |s| puts "  #{nice_name(s)}" }
+          exit
         else
           usage
         end
@@ -80,6 +92,10 @@ module Recollect
       recollections.find { |e| /#{item}\./ =~ e }
     end
     
+    def find_similar(item)
+      recollections.reject { |e| e unless /\b#{item}/ =~ nice_name(e) }
+    end
+    
     def write_file
       fullPath = File.join(@recollect_path, @name) + '.txt'
       subdir = File.dirname(fullPath)
@@ -117,6 +133,7 @@ module Recollect
 
     def remove_recollection
       verify_name
+      puts "Are you sure you want to remove #{@name} [Y/n]?"
       if confirm?
         File.delete(File.join(@recollect_path, @name) + '.txt')
         cleanup_path(File.dirname(File.join(@recollect_path, @name)))
@@ -132,9 +149,9 @@ module Recollect
     end
 
     def print_recollection
-      verify_name(@action)
+      verify_name
       puts @separator
-      File.open(File.join(@recollect_path, @action) + '.txt', 'r') do |f|
+      File.open(File.join(@recollect_path, @name) + '.txt', 'r') do |f|
         f.each_line do |line|
           puts line
         end
@@ -159,7 +176,6 @@ module Recollect
     end
 
     def confirm?
-      puts "Are you sure you want to remove #{@name} [Y/n]?"
       a = $stdin.gets.chomp.downcase
       a == 'y' ? true : false
     end
@@ -179,6 +195,7 @@ module Recollect
       when 'append'
         append_recollection
       else
+        @name = @action
         print_recollection
       end
     end

data/lib/recollect/version.rb

@@ -1,3 +1,3 @@
 module Recollect
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recollect
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tyler Poland