recollect 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f81e3005b101852633f48d786a7e5ec784a22f24
+  data.tar.gz: b6e1d9c8c52b8409bdb55c652ee07e20e8d500aa
+SHA512:
+  metadata.gz: 78ff54fa471dce776dc219db37608773b7685ee69078c425dc49f375fe1c00146c41fd6942688250312add7587cff29623a2d785c681485ddf4228face6f2441
+  data.tar.gz: 3974c2e56cce5b7ee556540b866bfe0af02fedbaecdc231a2aaf4f13adb2270df516a158b6b1dc934b62f809687542b782103b017b56635019b96d32106502f2

data/.ruby-gemset

@@ -0,0 +1 @@
+recollect

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2017 Tyler Poland.
+
+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,19 @@
+# Recollect
+A simple tool for creating, managing, and viewing snippets, notes, or pretty much any other text-based content at the command line. The original purpose was to store infrequently used complex command strings in a location where they could easily be indexed and retrieved.
+
+*Note* If you find yourself outlining complex procedures, you should consider if a shared team knowledge base might be a better fit.
+
+### Installation
+
+    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
+
+### Walkthrough
+
+
+
+
+

data/TODO

@@ -0,0 +1,16 @@
+Known Issues:
+
+- Add an open license
+- Convert to Ruby functionality only (no shell commands)
+- Need to reserve words so topics can't be (new, edit, remove, list, search)
+
+Feature Requests:
+
+- Make snippets directory ${HOME}/.recollect/
+- Build in paging functionality
+- Needs to obey ${EDITOR} environment variable (how does this play on Windows?)
+- 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
+- Create a mobile app synced via dropbox?
+- add support for markdown instead of just txt files

data/bin/recollect

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib', 'recollect'))
+
+require 'recollect'
+
+Recollect::Recollection.new(ARGV).run

data/lib/recollect/recollect.rb

@@ -0,0 +1,105 @@
+require 'fileutils'
+
+module Recollect
+  class Recollection
+    def initialize(args)
+      @reserved = %w[new edit remove help]
+      usage unless args.length >= 1 && args.length <= 2
+      @action, @name = args
+      usage if @reserved.include?(@action) && args.length < 2
+      usage if args.length == 2 && @reserved.include?(@name)
+      @separator = '-------------------------'
+      @recollect_path = File.join(ENV['HOME'], '.recollections')
+      FileUtils.mkdir_p(@recollect_path)
+    end
+
+    def usage(msg = nil)
+      puts msg unless msg.nil?
+      puts "USAGE: recollect ACTION [arg]"
+      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 "    name        - displays the recollection matching 'name'"
+      puts '    new [name]  - provides a listing of all available recollections'
+      puts '    edit [name] - provides a listing of all available recollections'
+      puts '    remove [name]   - removes a recollections'
+      puts "Note: #{@reserved} are reserved and cannot be the name of a recollection."
+      exit 1
+    end
+
+    def recollection_names
+      recollections.map { |r| File.basename(r, File.extname(r)) }
+    end
+
+    def recollections
+      @recollections ||= Dir.glob(File.join(@recollect_path, '**'))
+    end
+
+    def verify_name(item = @name)
+      unless item_exists?(item)
+        puts "Unable to find a recollecter matching '#{item}'"
+        usage
+      end
+    end
+
+    def item_exists?(item)
+      recollections.find { |e| /#{item}\./ =~ e }
+    end
+
+    def write_file
+      `#{ENV['EDITOR']} #{File.join(@recollect_path, @name) + '.txt'}`
+    end
+
+    def list_recollections
+      puts "Available recollections:\n#{@separator}"
+      puts recollection_names.map { |r| '  ' + r }
+    end
+
+    def new_recollection
+      msg = "'#{@name}' Already exists; use edit to change."
+      abort msg if item_exists?(@name)
+      write_file
+    end
+
+    def edit_recollection
+      verify_name
+      write_file
+    end
+
+    def remove_recollection
+      verify_name
+      File.delete(File.join(@recollect_path, @name) + '.txt') if confirm?
+    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
+        end
+      end
+    end
+
+    def confirm?
+      puts "Are you sure you want to remove #{@name} [Y/n]?"
+      a = $stdin.gets.chomp.downcase
+      a == 'y' ? true : false
+    end
+
+    def run
+      case @action
+      when 'list'
+        list_recollections
+      when 'new'
+        new_recollection
+      when 'edit'
+        edit_recollection
+      when 'remove'
+        remove_recollection
+      else
+        print_recollection
+      end
+    end
+  end
+end

data/lib/recollect/version.rb

@@ -0,0 +1,3 @@
+module Recollect
+  VERSION = '0.0.1'
+end

data/recollect.gemspec

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+require 'recollect/version'
+
+Gem::Specification.new do |s|
+  s.name = 'recollect'
+  s.version = Recollect::VERSION
+  s.authors = ['Tyler Poland']
+  s.email = 'recollect@tylerpoland.com'
+  s.homepage = 'http://github.com/tpoland/recollect'
+  s.summary = "Storage, Management and Retrieval of things you'd like to remember (recollect)."
+  s.description = s.summary
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '~> 1.9'
+  s.has_rdoc = true
+  s.extra_rdoc_files = %w[LICENSE TODO]
+  s.bindir = 'bin'
+  s.executables = %w[recollect]
+  s.default_executable = 'recollect'
+  s.files = `git ls-files`.split("\n")
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: recollect
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tyler Poland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-26 00:00:00.000000000 Z
+dependencies: []
+description: Storage, Management and Retrieval of things you'd like to remember (recollect).
+email: recollect@tylerpoland.com
+executables:
+- recollect
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- TODO
+files:
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG
+- LICENSE
+- README.md
+- TODO
+- bin/recollect
+- lib/recollect/recollect.rb
+- lib/recollect/version.rb
+- recollect.gemspec
+homepage: http://github.com/tpoland/recollect
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Storage, Management and Retrieval of things you'd like to remember (recollect).
+test_files: []