recollect 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 305d66ecdca334b3935b8966bf334103cf91d77b
-  data.tar.gz: c2a8e0aae304513710da049184540fb1521fffad
+  metadata.gz: 8c177e96f7e3949dbcef4f928ee87732e5d63236
+  data.tar.gz: 44d7d65b15fd1094cca08a241f803bb94b4d08eb
 SHA512:
-  metadata.gz: d88b248012759ed8967d51aa516910e3a29c7e8c3ccf53f11b4f653e6c46ccbe8c5338d5e29bd4a755024c5b55853dcf2f0521952598ef6b17dce8865944def5
-  data.tar.gz: aed5fdfe030853859b1c66cda69b037a371ab44ccdc5a0f0b867b833c9d558432db9ef5d0d957d12bda78c67d8853e40b9a8e363d8d94ffc57b0024f4362ba36
+  metadata.gz: 7ab03355d64eaa96130f471ba609c9bb25edefd3fd686869a13701318850357b91f2867b35267c3261d44aefbbce710a903c38ce2c81dd34ea37c9268209c954
+  data.tar.gz: c74cd30221dc64d570de0aa62d97e6d2e2f72bf9ec8f18feb9f185b861a62bf7ecdb7923b4c3a2f84ca89fe92059a890c94aa3f524ddef00cb44fe4e73583173

data/CHANGELOG

@@ -0,0 +1,4 @@
+0.0.6
+  - add support for subdirectories
+  - add verbose mode via DEBUG environment variable
+  - list subdirectory contents when matching recollection not found but subdirectory exists

data/TODO

@@ -1,9 +1,3 @@
-Known Issues:
-
-- Add an open license
-
 Feature Requests:
 
-- Allow for the creation of nested snippets (sub-directories)
-  - when listing, count topics in subdirectories but don't list the individual snippets
 - Add a search functionality that lists the snippet(s) containing the item searched for along with any matching content lines

data/lib/recollect/recollect.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'pathname'
 
 module Recollect
   class Recollection
@@ -11,6 +12,7 @@ module Recollect
       @separator = '-------------------------'
       @recollect_path = File.join(ENV['HOME'], '.recollections')
       FileUtils.mkdir_p(@recollect_path)
+      @debug = ENV['DEBUG']
     end
 
     def usage(msg = nil)
@@ -19,42 +21,67 @@ module Recollect
       puts 'Recollect manages a series of things worth remembering "recollections" as a series of'
       puts "text files.\n\n"
       puts '  Actions: list, new, edit, or <name> where <name> is the recollection to be displayed.'
-      puts '    list            - provides a listing of all available recollections'
+      puts '    list [category] - provides a listing of all available recollections.'
+      puts '                      use [category] to specify a subdirectory'
       puts "    name            - displays the recollection matching 'name'"
-      puts '    new [name]      - creates a new recollection'
-      puts '    edit [name]     - modifies an existing recollection'
-      puts '    remove [name]   - removes a recollection'
+      puts '    new <name>      - creates a new recollection'
+      puts '    edit <name>     - modifies an existing recollection'
+      puts '    remove <name>   - removes a recollection'
       puts "\nNote: #{@reserved} are reserved and cannot be the name"
       puts 'of a recollection.'
       exit 1
     end
+    
+    def debug(msg)
+      puts msg if @debug == '1' or @debug == 'true'
+    end
 
-    def recollection_names
-      recollections.map { |r| File.basename(r, File.extname(r)) }
+    def recollection_names(search_path = @recollect_path)
+      rec = []
+      recollections(search_path).each do |r| 
+        abs = Pathname.new(File.expand_path(r))
+        rel = abs.relative_path_from(Pathname.new(File.expand_path(search_path)))
+        *p, f = rel.to_s.split('/')
+        file = File.basename(f, File.extname(f))
+        out = p.empty? ? file : File.join(p, file)
+        rec << out
+      end
+      rec
     end
 
-    def recollections
-      @recollections ||= Dir.glob(File.join(@recollect_path, '**'))
+    def recollections(search_path = @recollect_path)
+      Dir.glob(File.join(search_path, '**/*')).select { |f| f unless File.directory?(f) }
     end
 
     def verify_name(item = @name)
       unless item_exists?(item)
-        puts "Unable to find a recollecter matching '#{item}'"
-        usage
+        puts "**** Unable to find a recollection matching '#{item}'"
+        if File.directory?(File.join(@recollect_path, item))
+          puts "Here are the contents of that category:"
+          list_recollections(item)
+          exit
+        else
+          usage
+        end
       end
     end
 
     def item_exists?(item)
       recollections.find { |e| /#{item}\./ =~ e }
     end
-
+    
     def write_file
-      `#{ENV['EDITOR']} #{File.join(@recollect_path, @name) + '.txt'}`
+      fullPath = File.join(@recollect_path, @name) + '.txt'
+      subdir = File.dirname(fullPath)
+      FileUtils.mkdir_p(subdir) unless subdir == '.'
+      `#{ENV['EDITOR']} #{fullPath}`
     end
 
-    def list_recollections
+    def list_recollections(local_name = @name)
+      location = @recollect_path
+      location = File.join(@recollect_path, local_name) unless local_name.nil?
       puts "Available recollections:\n#{@separator}"
-      puts recollection_names.map { |r| '  ' + r }
+      puts recollection_names(location).map { |r| '  ' + r }
     end
 
     def new_recollection
@@ -70,13 +97,23 @@ module Recollect
 
     def remove_recollection
       verify_name
-      File.delete(File.join(@recollect_path, @name) + '.txt') if confirm?
+      if confirm?
+        File.delete(File.join(@recollect_path, @name) + '.txt')
+        cleanup_path(File.dirname(File.join(@recollect_path, @name)))
+      end
+    end
+    
+    def cleanup_path(path)
+      if path != @recollect_path && Dir["#{path}/*"].empty?
+        debug "removing #{path}..."
+        FileUtils.rmdir(path)
+        cleanup_path(File.dirname(path))
+      end
     end
 
     def print_recollection
       verify_name(@action)
       puts @separator
-      #puts `cat #{File.join(@recollect_path, @action) + '.*'}`
       File.open(File.join(@recollect_path, @action) + '.txt', 'r') do |f|
         f.each_line do |line|
           puts line

data/lib/recollect/version.rb

@@ -1,3 +1,3 @@
 module Recollect
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recollect
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Tyler Poland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-27 00:00:00.000000000 Z
+date: 2017-04-29 00:00:00.000000000 Z
 dependencies: []
 description: Storage, Management and Retrieval of things you'd like to remember (recollect).
 email: recollect@tylerpoland.com