peter-notes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8567079aac32d75f712b96488dc8303f70d6cac5
+  data.tar.gz: 7c3e03bd57b2153f2b0276426a08c4ceb8ac7db7
+SHA512:
+  metadata.gz: 8fbb5fb4259d4343699179c800120ca1a667dabf45f8ace5dcd02275f6763776301f953376511313b4d42b20ab44c8930103aa1d5cf9a6550535890c633f02dd
+  data.tar.gz: aeef8aa50829d6861ca3c8c3439502740934c013d8ecb72d8c878021c36b8284bbf9f6c74b4d18f480c9b3b70edae132e04773d6f40a0259652efa7d0f035061

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*~
+*.swp
+*.swo

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at peter.nfonseca@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in peter-notes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Peter Fonseca
+
+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,101 @@
+# Peter Notes
+
+Manage your notes from the console.
+
+If you're like me, you spend most of your computing time in a terminal. You have a text-editor that's heavily customized to your liking, and you wish you could read and write everything with it. Naturally, you feel the same about your notes and, when it comes time to ditch the note-pad, you refuse to to use the more popular gui-driven apps.
+
+But when you start looking for a console-based notes framework you're blinded by crazy features and unwilling to learn a new tool. You've also already started keeping some text files in a directory and just cd into them all the time. Eventually you write an alias and call it a day.
+
+That's what I did. I also turned my alias into a bash function and wrote a couple more after I got tired of grepping on my own. At a certain point I got tired of writing bash and migrated to a ruby project. It was probably way more work than learning a new tool but I think it's pretty cool so whatever.
+
+Anyway, I made this this lightweight tool to do what I wanted it to do, which isn't a lot. It's essentially `cd`, `grep`, `tree`, and `find` wrapped into some nicer syntax with a preferences file to hold the info that you don't want to keep typing. That means it'll stay out of the way and let you choose where you keep your notes, how you organize them, how you track them (if you do), and what editor you use to write them. You can even just point it at your notes and stop cding and grepping into them manually.
+
+I made it for myself, and mostly packaged it into a ruby gem so I could keep it on all my computers/virtual machines, but if anyone else out there ever uses this, hopefully you like it. Much like Mr. Matsumoto, I think programming should be simple and linguistic, and I feel the same about the console.
+
+## Installation
+
+    $ gem install peter-notes
+
+## Usage
+
+`notes`. Yeah.
+
+But you can do more!
+
+Lets assume you have the following notes:
+
+    /Users/peter/Notes/
+    |-- projects
+    |   |-- python
+    |   |   +-- jarbs.txt
+    |   +-- ruby
+    |       +-- peter_notes.txt
+    +-- other
+        +-- motorcycle.txt
+
+Most of the time you just want to open them. To do that, just type `notes`. You can specify your text editor and where your notes are in `~/peter-notes.yaml` (see the preferences section below).
+
+If you want to open a specific note, you can pass in a `file-glob` to specify which notes you want to open. If you think a file glob is what happens when you spill coffee on your computer, just check this out [this](http://tldp.org/LDP/abs/html/globbingref.html) or google it (hint, you use it in bash a lot, like, when you `ls *.rb`).
+
+If you just want to open `other/motorcycle.txt` you can run `notes "other/motorcycle.txt"`. But that's kind of lame, so you could also fo `notes "motorcycle.txt"`, or even `notes "moto*"`. If you're feeling extra crazy, you could even get away with `m*` in this case, basically if you pass a glob in, `peter-notes` will just take the first match in `--find` (see below) and open that.
+
+If you wanted to open all notes under `projects/` you could also use this same idea and run `notes "projects"`.
+
+That's like what 90% of what you'll ever need and no crazy macros or flags to memorize. Not bad right? Well not all flags are bad, in fact, you also get some super-helpful optional ones for the other 10%:
+
+  - `-s`, `--search REGEX`:
+  Search within notes for text matching the specified `REGEX`. If you haven't guessed, this is the [grep](http://linuxcommand.org/man_pages/grep1.html) part. Specifically, it's running `grep -r YOUR-NOTES-DIR -e REGEX`.
+
+  - `-f`, `--find FILE-GLOB`:
+  Seach for notes that match the specified file-glob. This one's running [find](http://linuxcommand.org/man_pages/find1.html) -- `find YOUR-NOTES-DIR -name FILE-GLOB`. It's a little more than that though, this will be fuzzy in that you can add some path info to your glob. For example, if you ran `notes --find "projects/*.txt"`, you'd get back both `projects/python/jarbs.txt` and `projects/ruby/peter_notes.txt`. So it's better than just find. A little.
+
+  - `-l`, `--list [PATH]`:
+  List all notes or, if a `PATH` is specified, list notes within the specified path. Bet you thought this was running `ls -r`, well it's actually running [tree](http://linuxcommand.org/man_pages/tree1.html) because it's much cooler -- `tree YOUR-NOTES-DIR/PATH`.
+
+Oh yeah, make sure your terminal has `grep`, `find`, and `tree`. It should, but depends on how crazy your 'gear' is. Also, this is a cli tool, don't try to import it into some ruby source code.
+
+## Preferences
+
+Preferences are saved in `~/.peter-notes.yml`. There are just 2 options that you can set so don't freak out:
+
+  - `editor`:
+  The editor of your choice. This value will get passed to bash so make sure you use the exact name your terminal will understand.
+
+  **Possible Values**: `[vim, subl, atom, emacs, nano]`
+  (more?) I haven't tested others and dont know which work well when opening a directory. For vim I use the NerdTree plugin.
+
+  **Default Value**: `vim`
+
+  - `notes_dir`:
+  The home of your notes. This is where `notes` will look for them.
+
+  **Possible Values**: any valid + existing dorectory path. I use `~/GoogleDrive/Notes` because I track mine in google drive (OverGrive for linux).
+
+  **Default Value**: `~/Notes`
+
+That's [yaml](http://www.yaml.org/start.html) so it should look like this:
+
+```yaml
+editor: vim
+notes_dir: /home/peter/Notes
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive [pry](http://pryrepl.org/) prompt.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+If you're changing the man page, generate roff and html files with `bin/ronn`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fonsecapeter/peter-notes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the peter-notes project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fonsecapeter/peter-notes/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "pry"
+require "bundler/setup"
+require "models/console_app"
+require "models/notes"
+require "models/preferences"
+
+Pry.start

data/bin/notes

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/peter_notes/peter_notes.rb'
+run

data/bin/ronn

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+ronn man/peter-notes.7.ronn

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+

data/bin/test

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+rspec spec

data/lib/models/console_app.rb

@@ -0,0 +1,28 @@
+require 'optparse'
+
+class ConsoleApp
+  def run
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: notes [options]'
+      opts.separator('')
+      opts.separator('Options:')
+      opts.separator('    [FILE-GLOB]                      Open the first file that matches FILE-GLOB if supplied')
+      opts.on('-s', '--search REGEX', 'Search within notes') do |regex|
+        self.search(regex)
+        exit(0)
+      end
+      opts.on('-f', '--find FILE-GLOB', 'Find notes that match FILE-GLOB') do |glob|
+        puts(self.find(glob))
+        exit(0)
+      end
+      opts.on('-l', '--list [PATH]', 'List all notes', '  (list notes under PATH if supplied)') do |path|
+        puts(self.list(path))
+        exit(0)
+      end
+      opts.on('-h', '--help', 'Show this message') do
+        puts(opts)
+        exit(0)
+      end
+    end.parse!
+  end
+end

data/lib/models/notes.rb

@@ -0,0 +1,59 @@
+require_relative 'console_app'
+require_relative 'preferences'
+
+class Notes < ConsoleApp
+  attr_reader :editor, :notes_dir
+
+  def initialize(prefs)
+    @editor = prefs.editor
+    @notes_dir = prefs.notes_dir
+  end
+
+  def search(regex)
+    system("grep --color=always -r #{@notes_dir} -e #{regex}")
+  end
+
+  def find(glob)
+    parsed = glob.split('/')
+    glob_terminus = parsed.pop
+    glob_path = parsed.join('/')
+    cmd = "find \"#{@notes_dir}\" -name \"#{glob_terminus}\""
+    if glob_path != ''
+      cmd += " | grep \"#{glob_path}\""
+    end
+    found = `#{cmd}`
+    return found.split
+  end
+
+  def open_notes(glob=nil)
+    enter_dir
+    found = find(glob)[0]
+    if found.nil?
+      found = './'
+    end
+    system("#{@editor} #{found}")
+    leave_dir
+  end
+
+  def list(path)
+    system("tree #{@notes_dir}/#{path}")
+  end
+
+  def run
+    super
+    glob = ARGV[0]
+    open_notes(glob)
+  end
+
+  private
+
+  def enter_dir
+    @cur_dir = Dir.pwd
+    Dir.chdir(@notes_dir)
+  end
+
+  def leave_dir
+    Dir.chdir(@cur_dir)
+  end
+
+end

data/lib/models/preferences.rb

@@ -0,0 +1,52 @@
+require 'yaml'
+
+class Preferences
+  attr_reader :editor, :notes_dir, :preferences
+
+  @@home_dir = ENV['HOME']
+  @@defaults = {
+    editor: 'vim',
+    notes_dir: "#{@@home_dir}/Notes"
+  }
+  @@prefs_file = "#{@@home_dir}/.peter-notes.yml"
+
+  def self.defaults
+    @@defaults
+  end
+
+  def self.prefs_file
+    @@prefs_file
+  end
+
+  def initialize(prefs=nil)
+    @preferences = prefs || load_preferences
+    @preferences[:notes_dir] = File.expand_path(@preferences[:notes_dir])
+    @editor = @preferences[:editor]
+    @notes_dir = @preferences[:notes_dir]
+  end
+
+  def self.write_yaml_defaults
+    File.write(@@prefs_file, @@defaults.to_yaml)
+  end
+
+  private
+
+  def load_yaml_preferences
+    prefs = YAML::load_file(@@prefs_file)
+    return(
+      prefs.inject({}) do |processed, (key, val)|
+        processed[key.to_sym] = val
+        processed
+      end
+     )
+  end
+
+  def load_preferences
+    if File.exists?(@@prefs_file)
+      prefs = load_yaml_preferences
+      return(@@defaults.merge(prefs))
+    else
+      return @@defaults
+    end
+  end
+end

data/lib/peter_notes/peter_notes.rb

@@ -0,0 +1,9 @@
+require_relative "version"
+require_relative '../models/preferences'
+require_relative '../models/notes'
+
+def run
+  preferences = Preferences.new
+  notes = Notes.new(preferences)
+  notes.run
+end

data/lib/peter_notes/version.rb

@@ -0,0 +1,3 @@
+module PeterNotes
+  VERSION = '0.1.0'
+end

data/man/peter-notes.7

@@ -0,0 +1,134 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PETER\-NOTES" "1" "June 2017" "" ""
+.
+.SH "NAME"
+\fBpeter\-notes\fR \- manage your notes from the terminal
+.
+.SH "SYNOPSIS"
+\fBnotes\fR [\fIFILE\-GLOB\fR]
+.
+.br
+\fBnotes\fR \fB\-s\fR|\fB\-\-search\fR \fIREGEX\fR
+.
+.br
+\fBnotes\fR \fB\-f\fR|\fB\-\-find\fR \fIFILE\-GLOB\fR
+.
+.br
+\fBnotes\fR \fB\-l\fR|\fB\-\-list\fR [\fIPATH\fR]
+.
+.br
+.
+.SH "DESCRIPTION"
+This document describes the \fBpeter\-notes\fR tool\. This simple ruby gem is an awesome way to manage personal notes from the terminal\.
+.
+.SH "OPTIONS"
+These options provide some extra utility beyond simply opening notes for editing\.
+.
+.TP
+\fB\-s\fR, \fB\-\-search <REGEX>\fR
+Search within notes for text matching the specified \fBREGEX\fR\. If you havent guessed, this is the grep \fIhttp://linuxcommand\.org/man_pages/grep1\.html\fR part\. Specifically, its running \fBgrep \-r YOUR\-NOTES\-DIR \-e REGEX\fR\.
+.
+.TP
+\fB\-f\fR, \fB\-\-find <FILE\-GLOB>\fR
+Seach for notes that match the specified file\-glob\. This ones running find \fIhttp://linuxcommand\.org/man_pages/find1\.html\fR \-\- \fBfind YOUR\-NOTES\-DIR \-name FILE\-GLOB\fR\. Its a little more than that though, this will be fuzzy in that you can add some path info to your glob\. For example, if you ran \fBnotes \-\-find "projects/*\.txt"\fR, youd get back both \fBprojects/python/jarbs\.txt\fR and \fBprojects/ruby/peter_notes\.txt\fR\. So its better than just find\. A little\.
+.
+.TP
+\fB\-l\fR, \fB\-\-list [<PATH>]\fR
+List all notes or, if a \fBPATH\fR is specified, list notes within the specified path\. Bet you thought this was running \fBls \-r\fR, well its actually running tree \fIhttp://linuxcommand\.org/man_pages/tree1\.html\fR because its much cooler \-\- \fBtree YOUR\-NOTES\-DIR/PATH\fR\.
+.
+.SH "EXAMPLES"
+\fBnotes\fR\. Yeah\.
+.
+.P
+But you can do more!
+.
+.P
+Lets assume you have the following notes:
+.
+.IP "" 4
+.
+.nf
+
+/Users/peter/Notes/
+|\-\- projects
+|   |\-\- python
+|   |   +\-\- jarbs\.txt
+|   +\-\- ruby
+|       +\-\- peter_notes\.txt
++\-\- other
+    +\-\- motorcycle\.txt
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Most of the time you just want to open them\. To do that, just type \fBnotes\fR\. You can specify your text editor and where your notes are in \fB~/peter\-notes\.yaml\fR (see the preferences section below)\.
+.
+.P
+If you want to open a specific note, you can pass in a \fBfile\-glob\fR to specify which notes you want to open\. If you think a file glob is what happens when you spill coffee on your computer, just check this out this \fIhttp://tldp\.org/LDP/abs/html/globbingref\.html\fR or google it (hint, you use it in bash a lot, like, when you \fBls *\.rb\fR)\.
+.
+.P
+If you just want to open \fBother/motorcycle\.txt\fR you can run \fBnotes "other/motorcycle\.txt"\fR\. But thats kind of lame, so you could also fo \fBnotes "motorcycle\.txt"\fR, or even \fBnotes "moto*"\fR\. If youre feeling extra crazy, you could even get away with \fBm*\fR in this case, basically if you pass a glob in, \fBpeter\-notes\fR will just take the first match in \fB\-\-find\fR (see below) and open that\.
+.
+.P
+If you wanted to open all notes under \fBprojects/\fR you could also use this same idea and run \fBnotes "projects"\fR\.
+.
+.P
+Thats like what 90% of what youll ever need and no crazy macros or flags to memorize\. Not bad right? Well not all flags are bad, in fact, you also get some super\-helpful optional ones for the other 10%, just look above at the OPTIONS section\.
+.
+.P
+Oh yeah, make sure your terminal has \fBgrep\fR, \fBfind\fR, and \fBtree\fR\. It should, but depends on how crazy your \'gear\' is\.
+.
+.SH "PREFERENCES"
+Preferences are saved in \'~/\.peter\-notes\.yml\'\. There are just 2 options that you can set:
+.
+.IP "" 4
+.
+.nf
+
+editor:
+    The editor of your choice\. This value will get passed to bash so
+    make sure you use the exact name your terminal will understand\.
+    Possible Values: [\'vim\', \'subl\', \'atom\', \'emacs\', \'nano\']
+                     (more?) I haven\'t tested others and dont know
+                     which work well when opening a directory\. For
+                     vim I use the NerdTree plugin\.
+    Default Value: \'vim\'
+
+notes_dir:
+    The home of your notes\. This is where `peter\-notes` will look
+    for them\.
+    Possible Values: any valid + existing dorectory path\. I use
+                     \'~/GoogleDrive/Notes\' because I track mine in
+                     google drive (OverGrive for linux)\.
+    Default Value: \'~/Notes\'
+.
+.fi
+.
+.IP "" 0
+.
+.P
+That\'s yaml \fIhttp://www\.yaml\.org/start\.html\fR so it should look like this:
+.
+.IP "" 4
+.
+.nf
+
+editor: vim
+notes_dir: /home/peter/Notes
+.
+.fi
+.
+.IP "" 0
+.
+.SH "AUTHORS"
+Peter Fonseca \fIpeter\.nfonseca@gmail\.com\fR
+.
+.SH "SEE ALSO"
+This tool runs on top of a few very useful bash utilities and relies on terminal\-accessible text\-editors\. It was also written in a fantastic language called ruby\.
+.
+.P
+bash(1), grep(1), find(1), tree(1), vim(1), ruby(1)

data/man/peter-notes.7.html

@@ -0,0 +1,181 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>peter-notes(1) - manage your notes from the terminal</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+    <a href="#PREFERENCES">PREFERENCES</a>
+    <a href="#AUTHORS">AUTHORS</a>
+    <a href="#SEE-ALSO">SEE ALSO</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>peter-notes(1)</li>
+    <li class='tc'></li>
+    <li class='tr'>peter-notes(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>peter-notes</code> - <span class="man-whatis">manage your notes from the terminal</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>notes</code> [<var>FILE-GLOB</var>] <br />
+<code>notes</code> <code>-s</code>|<code>--search</code> <var>REGEX</var> <br />
+<code>notes</code> <code>-f</code>|<code>--find</code> <var>FILE-GLOB</var> <br />
+<code>notes</code> <code>-l</code>|<code>--list</code> [<var>PATH</var>] <br /></p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p>This document describes the <strong>peter-notes</strong> tool. This simple ruby
+gem is an awesome way to manage personal notes from the terminal.</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<p>These options provide some extra utility beyond simply opening notes
+for editing.</p>
+
+<dl>
+<dt><code>-s</code>, <code>--search &lt;REGEX></code></dt><dd><p>Search within notes for text matching the specified <code>REGEX</code>. If you havent guessed, this is the <a href="http://linuxcommand.org/man_pages/grep1.html">grep</a> part. Specifically, its running <code>grep -r YOUR-NOTES-DIR -e REGEX</code>.</p></dd>
+<dt><code>-f</code>, <code>--find &lt;FILE-GLOB></code></dt><dd><p>Seach for notes that match the specified file-glob. This ones running <a href="http://linuxcommand.org/man_pages/find1.html">find</a> -- <code>find YOUR-NOTES-DIR -name FILE-GLOB</code>. Its a little more than that though, this will be fuzzy in that you can add some path info to your glob. For example, if you ran <code>notes --find "projects/*.txt"</code>, youd get back both <code>projects/python/jarbs.txt</code> and <code>projects/ruby/peter_notes.txt</code>. So its better than just find. A little.</p></dd>
+<dt><code>-l</code>, <code>--list [&lt;PATH>]</code></dt><dd><p>List all notes or, if a <code>PATH</code> is specified, list notes within the specified path. Bet you thought this was running <code>ls -r</code>, well its actually running <a href="http://linuxcommand.org/man_pages/tree1.html">tree</a> because its much cooler -- <code>tree YOUR-NOTES-DIR/PATH</code>.</p></dd>
+</dl>
+
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<p><code>notes</code>. Yeah.</p>
+
+<p>But you can do more!</p>
+
+<p>Lets assume you have the following notes:</p>
+
+<pre><code>/Users/peter/Notes/
+|-- projects
+|   |-- python
+|   |   +-- jarbs.txt
+|   +-- ruby
+|       +-- peter_notes.txt
++-- other
+    +-- motorcycle.txt
+</code></pre>
+
+<p>Most of the time you just want to open them. To do that, just type <code>notes</code>. You can specify your text editor and where your notes are in <code>~/peter-notes.yaml</code> (see the preferences section below).</p>
+
+<p>If you want to open a specific note, you can pass in a <code>file-glob</code> to specify which notes you want to open. If you think a file glob is what happens when you spill coffee on your computer, just check this out <a href="http://tldp.org/LDP/abs/html/globbingref.html">this</a> or google it (hint, you use it in bash a lot, like, when you <code>ls *.rb</code>).</p>
+
+<p>If you just want to open <code>other/motorcycle.txt</code> you can run <code>notes "other/motorcycle.txt"</code>. But thats kind of lame, so you could also fo <code>notes "motorcycle.txt"</code>, or even <code>notes "moto*"</code>. If youre feeling extra crazy, you could even get away with <code>m*</code> in this case, basically if you pass a glob in, <code>peter-notes</code> will just take the first match in <code>--find</code> (see below) and open that.</p>
+
+<p>If you wanted to open all notes under <code>projects/</code> you could also use this same idea and run <code>notes "projects"</code>.</p>
+
+<p>Thats like what 90% of what youll ever need and no crazy macros or flags to memorize. Not bad right? Well not all flags are bad, in fact, you also get some super-helpful optional ones for the other 10%, just look above at the OPTIONS section.</p>
+
+<p>Oh yeah, make sure your terminal has <code>grep</code>, <code>find</code>, and <code>tree</code>. It should, but depends on how crazy your 'gear' is.</p>
+
+<h2 id="PREFERENCES">PREFERENCES</h2>
+
+<p>Preferences are saved in '~/.peter-notes.yml'. There are just 2
+options that you can set:</p>
+
+<pre><code>editor:
+    The editor of your choice. This value will get passed to bash so
+    make sure you use the exact name your terminal will understand.
+    Possible Values: ['vim', 'subl', 'atom', 'emacs', 'nano']
+                     (more?) I haven't tested others and dont know
+                     which work well when opening a directory. For
+                     vim I use the NerdTree plugin.
+    Default Value: 'vim'
+
+notes_dir:
+    The home of your notes. This is where `peter-notes` will look
+    for them.
+    Possible Values: any valid + existing dorectory path. I use
+                     '~/GoogleDrive/Notes' because I track mine in
+                     google drive (OverGrive for linux).
+    Default Value: '~/Notes'
+</code></pre>
+
+<p>That's <a href="http://www.yaml.org/start.html">yaml</a> so it should look like this:</p>
+
+<pre><code>editor: vim
+notes_dir: /home/peter/Notes
+</code></pre>
+
+<h2 id="AUTHORS">AUTHORS</h2>
+
+<p>Peter Fonseca <a href="&#109;&#x61;&#105;&#108;&#116;&#111;&#x3a;&#x70;&#101;&#x74;&#x65;&#114;&#46;&#x6e;&#102;&#x6f;&#x6e;&#115;&#x65;&#x63;&#x61;&#64;&#103;&#109;&#x61;&#105;&#x6c;&#x2e;&#x63;&#111;&#x6d;" data-bare-link="true">&#x70;&#x65;&#116;&#101;&#x72;&#46;&#x6e;&#x66;&#111;&#110;&#115;&#101;&#x63;&#x61;&#x40;&#103;&#109;&#x61;&#x69;&#x6c;&#46;&#x63;&#111;&#109;</a></p>
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<p>This tool runs on top of a few very useful bash utilities and relies
+on terminal-accessible text-editors. It was also written in a
+fantastic language called ruby.</p>
+
+<p><span class="man-ref">bash<span class="s">(1)</span></span>, <span class="man-ref">grep<span class="s">(1)</span></span>, <span class="man-ref">find<span class="s">(1)</span></span>, <span class="man-ref">tree<span class="s">(1)</span></span>, <span class="man-ref">vim<span class="s">(1)</span></span>, <span class="man-ref">ruby<span class="s">(1)</span></span></p>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>June 2017</li>
+    <li class='tr'>peter-notes(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>

data/man/peter-notes.7.ronn

@@ -0,0 +1,98 @@
+peter-notes(1) -- manage your notes from the terminal
+=============================================
+
+## SYNOPSIS
+
+`notes` [<FILE-GLOB>] <br>
+`notes` `-s`|`--search` <REGEX> <br>
+`notes` `-f`|`--find` <FILE-GLOB> <br>
+`notes` `-l`|`--list` [<PATH>] <br>
+
+## DESCRIPTION
+
+This document describes the **peter-notes** tool. This simple ruby
+gem is an awesome way to manage personal notes from the terminal.
+
+## OPTIONS
+
+These options provide some extra utility beyond simply opening notes
+for editing.
+
+  * `-s`, `--search <REGEX>`:
+    Search within notes for text matching the specified `REGEX`. If you havent guessed, this is the [grep](http://linuxcommand.org/man_pages/grep1.html) part. Specifically, its running `grep -r YOUR-NOTES-DIR -e REGEX`.
+
+  * `-f`, `--find <FILE-GLOB>`:
+    Seach for notes that match the specified file-glob. This ones running [find](http://linuxcommand.org/man_pages/find1.html) -- `find YOUR-NOTES-DIR -name FILE-GLOB`. Its a little more than that though, this will be fuzzy in that you can add some path info to your glob. For example, if you ran `notes --find "projects/*.txt"`, youd get back both `projects/python/jarbs.txt` and `projects/ruby/peter_notes.txt`. So its better than just find. A little.
+
+
+  * `-l`, `--list [<PATH>]`:
+    List all notes or, if a `PATH` is specified, list notes within the specified path. Bet you thought this was running `ls -r`, well its actually running [tree](http://linuxcommand.org/man_pages/tree1.html) because its much cooler -- `tree YOUR-NOTES-DIR/PATH`.
+
+
+## EXAMPLES
+
+`notes`. Yeah.
+
+But you can do more!
+
+Lets assume you have the following notes:
+
+    /Users/peter/Notes/
+    |-- projects
+    |   |-- python
+    |   |   +-- jarbs.txt
+    |   +-- ruby
+    |       +-- peter_notes.txt
+    +-- other
+        +-- motorcycle.txt
+
+Most of the time you just want to open them. To do that, just type `notes`. You can specify your text editor and where your notes are in `~/peter-notes.yaml` (see the preferences section below).
+
+If you want to open a specific note, you can pass in a `file-glob` to specify which notes you want to open. If you think a file glob is what happens when you spill coffee on your computer, just check this out [this](http://tldp.org/LDP/abs/html/globbingref.html) or google it (hint, you use it in bash a lot, like, when you `ls *.rb`).
+
+If you just want to open `other/motorcycle.txt` you can run `notes "other/motorcycle.txt"`. But thats kind of lame, so you could also fo `notes "motorcycle.txt"`, or even `notes "moto*"`. If youre feeling extra crazy, you could even get away with `m*` in this case, basically if you pass a glob in, `peter-notes` will just take the first match in `--find` (see below) and open that.
+
+If you wanted to open all notes under `projects/` you could also use this same idea and run `notes "projects"`.
+
+Thats like what 90% of what youll ever need and no crazy macros or flags to memorize. Not bad right? Well not all flags are bad, in fact, you also get some super-helpful optional ones for the other 10%, just look above at the OPTIONS section.
+
+Oh yeah, make sure your terminal has `grep`, `find`, and `tree`. It should, but depends on how crazy your 'gear' is.
+
+## PREFERENCES
+
+Preferences are saved in '~/.peter-notes.yml'. There are just 2
+options that you can set:
+
+    editor:
+        The editor of your choice. This value will get passed to bash so
+        make sure you use the exact name your terminal will understand.
+        Possible Values: ['vim', 'subl', 'atom', 'emacs', 'nano']
+                         (more?) I haven't tested others and dont know
+                         which work well when opening a directory. For
+                         vim I use the NerdTree plugin.
+        Default Value: 'vim'
+
+    notes_dir:
+        The home of your notes. This is where `peter-notes` will look
+        for them.
+        Possible Values: any valid + existing dorectory path. I use
+                         '~/GoogleDrive/Notes' because I track mine in
+                         google drive (OverGrive for linux).
+        Default Value: '~/Notes'
+
+That's [yaml](http://www.yaml.org/start.html) so it should look like this:
+
+    editor: vim
+    notes_dir: /home/peter/Notes
+
+## AUTHORS
+
+Peter Fonseca <peter.nfonseca@gmail.com>
+
+## SEE ALSO
+
+This tool runs on top of a few very useful bash utilities and relies
+on terminal-accessible text-editors. It was also written in a
+fantastic language called ruby.
+
+bash(1), grep(1), find(1), tree(1), vim(1), ruby(1)

data/peter-notes.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "peter_notes/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "peter-notes"
+  spec.version       = PeterNotes::VERSION
+  spec.authors       = ["Peter Fonseca"]
+  spec.email         = ["peter.nfonseca@gmail.com"]
+
+  spec.summary       = %q{Lightweight notes manager}
+  spec.description   = %q{Manage notes with this minimal gem. You can choose your editor and organize your notes however you choose. If you want to track your notes, this gem will stay out of the way. It's a cli tool, don't try to import it in a ruby file.}
+  spec.homepage      = "https://github.com/fonsecapeter/peter-notes"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["notes"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "ronn", "~> 0.7.3"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+  spec.add_development_dependency "simplecov-console", "~> 0.4.2"
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: peter-notes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Fonseca
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ronn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+description: Manage notes with this minimal gem. You can choose your editor and organize
+  your notes however you choose. If you want to track your notes, this gem will stay
+  out of the way. It's a cli tool, don't try to import it in a ruby file.
+email:
+- peter.nfonseca@gmail.com
+executables:
+- notes
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/notes
+- bin/ronn
+- bin/setup
+- bin/test
+- lib/models/console_app.rb
+- lib/models/notes.rb
+- lib/models/preferences.rb
+- lib/peter_notes/peter_notes.rb
+- lib/peter_notes/version.rb
+- man/peter-notes.7
+- man/peter-notes.7.html
+- man/peter-notes.7.ronn
+- peter-notes.gemspec
+homepage: https://github.com/fonsecapeter/peter-notes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Lightweight notes manager
+test_files: []