peter-notes 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24dcc4e40cda3fd1cc04a6a571f7b545a190e36f
-  data.tar.gz: 54e4dc169ec29966017bd43774180c47ee99e26c
+  metadata.gz: f1a21b583cef933540e0039eb042232c65f5dab7
+  data.tar.gz: 6fd4913e95b32a3096584cab526bdeae7578831c
 SHA512:
-  metadata.gz: 0417a4fbc402adefacced99f1360b078b7dc69db2dad9ac3dfabff85b13cc8fff2a20b5cf6e14623503ab684efff724557bda5764ff049906d3d8df6e04be19b
-  data.tar.gz: 9a902e2d34c5aaeb462f921b8ff0bedbd0b4bf0f0af075232903221bf64dd52dbd793ceaff7488100dc85c750318fa784562b9d5d307073fe2566287bbbd7cc2
+  metadata.gz: b6d7da6e4bff5e00f305bd55b21589519ecc843c37c5639c5a2f2bbec28f2e3e7ce5e3cc1ddee3c1c49740f88a51f206de37a173726b1588b3188ebee9715d23
+  data.tar.gz: dbc24e02be65b36e18873daf20b6e4d96f21f12b4c84badbc2530b34153d4b1479a304a137ac50694e7b2725d61f38762363d6c8b7496b4780a0145f5eff49a5

data/README.md

@@ -1,22 +1,12 @@
-<div>
-  <a href="https://travis-ci.org/fonsecapeter/peter-notes">
-    <img src="https://travis-ci.org/fonsecapeter/peter-notes.svg?branch=master"></img>
-  </a>
-</div>
+# Peter Notes <a href="https://travis-ci.org/fonsecapeter/peter-notes"><img src="https://travis-ci.org/fonsecapeter/peter-notes.svg?branch=master"></img></a>
 
-# Peter Notes
+Manage your notes from the console. ([ruby gem](https://rubygems.org/gems/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, when it comes time to ditch the paper note-pad, you refuse to to use the more popular gui-driven apps.
 
-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 your notes in some text files and don't want to have to start over.
 
-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.
+Anyway, I went through the same thing and made this this lightweight tool (originally from some aliases in my bashrc) to do what I wanted it to do, which isn't a lot. But, like ruby, it has a nice interface, and it'll stay out of the way. That means you can 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. So if you already have your own notes, you can just point `peter-notes` at them (see preferences below) and start using worlds simplest (and coolest) notes-manager.
 
 ## Installation
 
@@ -30,7 +20,7 @@ But you can do more!
 
 Lets assume you have the following notes:
 
-    /Users/peter/Notes/
+    ~/Notes
     |-- projects
     |   |-- python
     |   |   +-- jarbs.txt
@@ -39,24 +29,24 @@ Lets assume you have the following notes:
     +-- 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).
+Most of the time you just want to open them. To do that, type `notes`. You can specify your text editor and where your notes are in `~/peter-notes.yaml` (see the preferences section below). This will basically `cd` into your notes and open them all with `YOUR-EDITOR ./`. Some editors don't super work when you open a directory, but I use vim with [NerdTree](https://github.com/scrooloose/nerdtree) and I'm sure other editors have similar plugins.
 
 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.
+Now, lets say you want to open `other/motorcycle.txt`. You could run `notes "other/motorcycle.txt"`. But that's kind of lame, so you could also do `notes "motorcycle.txt"`, or even `notes "moto*"`. If you're feeling extra crazy, you could get away with `m*` here. Basically if you pass a glob in, `peter-notes` will just take the first match from `--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`.
+  Search within notes for text matching the specified `REGEX`. This isn't magic, it's just [grep](http://linuxcommand.org/man_pages/grep1.html). 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`.
+  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.
 
@@ -68,7 +58,7 @@ Preferences are saved in `~/.peter-notes.yml`. There are just 2 options that you
   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.
+  (more?) I haven't tested others but I know they're out there.
 
   **Default Value**: `vim`
 
@@ -90,10 +80,12 @@ notes_dir: /home/peter/Notes
 
 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`.
 
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, first update the version number in `lib/peter_notes/version.rb`, then build the gem with `bundle exec rake build`. Now you can and push the `.gem` file to [rubygems.org](https://rubygems.org) with `gem push pkg/peter-notes-VERSION.gem`.
+
 ## 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.
@@ -104,4 +96,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## 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).
+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/bin/notes

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

data/bin/test

@@ -1,2 +1,2 @@
 #!/usr/bin/env bash
-rake spec
+bundle exec rake spec

data/lib/models/console_app.rb

@@ -1,4 +1,5 @@
 require 'optparse'
+require 'models/preferences'
 
 class ConsoleApp
   def run
@@ -12,7 +13,7 @@ class ConsoleApp
         self.search(regex)
         exit(0)
       end
-      opts.on('-f', '--find FILE-GLOB', 'Find notes that match FILE-GLOB') do |glob|
+      opts.on('-f', '--find FILE-GLOB', 'Find notes that fuzzily match FILE-GLOB') do |glob|
         puts(self.find(glob))
         exit(0)
       end
@@ -24,6 +25,16 @@ class ConsoleApp
         puts(opts)
         exit(0)
       end
+      opts.on('-v', '--version', 'Show version') do
+        puts(self.version)
+        exit(0)
+      end
+      opts.separator('')
+      opts.separator("Preferences are loaded from #{Preferences.prefs_file} and should look like:")
+      opts.separator(Preferences.defaults_yaml)
+
+      opts.separator('')
+      opts.separator("Documentation at https://github.com/fonsecapeter/peter-notes or man peter-notes")
     end.parse!
     self.on_run(arg)
   end

data/lib/models/notes.rb

@@ -1,5 +1,6 @@
-require_relative 'console_app'
-require_relative 'preferences'
+require 'models/console_app'
+require 'models/preferences'
+require 'peter_notes/version'
 
 class Notes < ConsoleApp
   attr_reader :editor, :notes_dir
@@ -14,12 +15,11 @@ class Notes < ConsoleApp
   end
 
   def find(glob)
-    parsed = glob.split('/')
-    glob_terminus = parsed.pop
-    glob_path = parsed.join('/')
+    glob_path, glob_terminus = File.split(glob)
+    glob_path.gsub!(File::SEPARATOR, '.*')
     cmd = "find \"#{@notes_dir}\" -name \"#{glob_terminus}\""
-    if glob_path != ''
-      cmd += " | grep \"#{glob_path}\""
+    if glob_path != '.'  # FILE::split breaks out . for bare file names
+      cmd += " | grep -e \"#{glob_path}\""
     end
     found = `#{cmd}`
     return found.split
@@ -36,13 +36,18 @@ class Notes < ConsoleApp
   end
 
   def list(path)
-    system("tree #{@notes_dir}/#{path}")
+    notes_path = File.join(@notes_dir, path)
+    system("tree #{notes_path}")
   end
 
   def on_run(glob)
     open_notes(glob)
   end
 
+  def version
+    return PeterNotes::VERSION
+  end
+
   private
 
   def enter_dir

data/lib/models/preferences.rb

@@ -18,6 +18,10 @@ class Preferences
     @@prefs_file
   end
 
+  def self.defaults_yaml
+    @@defaults.to_yaml
+  end
+
   def initialize(prefs=nil)
     @preferences = prefs || load_preferences
     @preferences[:notes_dir] = File.expand_path(@preferences[:notes_dir])
@@ -26,7 +30,7 @@ class Preferences
   end
 
   def self.write_yaml_defaults
-    File.write(@@prefs_file, @@defaults.to_yaml)
+    File.write(@@prefs_file, self.defaults_yaml)
   end
 
   private

data/lib/peter_notes/peter_notes.rb

@@ -1,6 +1,6 @@
-require_relative "version"
-require_relative '../models/preferences'
-require_relative '../models/notes'
+require "peter_notes/version"
+require 'models/preferences'
+require 'models/notes'
 
 def run
   preferences = Preferences.new

data/lib/peter_notes/version.rb

@@ -1,3 +1,3 @@
 module PeterNotes
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/peter-notes.gemspec

@@ -1,30 +1,39 @@
 # coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "peter_notes/version"
+require 'peter_notes/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "peter-notes"
+  spec.name          = 'peter-notes'
   spec.version       = PeterNotes::VERSION
-  spec.authors       = ["Peter Fonseca"]
-  spec.email         = ["peter.nfonseca@gmail.com"]
+  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.description   = %q{Manage notes from the console with this minimal gem.
+
+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, when it comes time to ditch the paper 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 your notes in some text files and don't want to have to start over.
+
+Anyway, I went through the same thing and made this this lightweight tool (originally from some aliases in my bashrc) to do what I wanted it to do, which isn't a lot. But, like ruby, it has a nice interface, and it'll stay out of the way. That means you can 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. So if you already have your own notes, you can just point `peter-notes` at them (see preferences below) and start using worlds simplest (and coolest) notes-manager.
+
+This is a cli tool, don't try to import it into some ruby source code.}
+  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"
+  spec.bindir        = 'bin'
+  spec.executables   = ['notes']
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'manpages', '~> 0.6.1'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'pry', '~> 0.10.4'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'ronn', '~> 0.7.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov-console', '~> 0.4.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: peter-notes
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Peter Fonseca
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2017-06-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: manpages
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -25,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.10.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.10.4
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: ronn
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.7.3
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
@@ -94,9 +108,16 @@ dependencies:
     - - "~>"
       - !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.
+description: |-
+  Manage notes from the console with this minimal gem.
+
+  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, when it comes time to ditch the paper 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 your notes in some text files and don't want to have to start over.
+
+  Anyway, I went through the same thing and made this this lightweight tool (originally from some aliases in my bashrc) to do what I wanted it to do, which isn't a lot. But, like ruby, it has a nice interface, and it'll stay out of the way. That means you can 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. So if you already have your own notes, you can just point `peter-notes` at them (see preferences below) and start using worlds simplest (and coolest) notes-manager.
+
+  This is a cli tool, don't try to import it into some ruby source code.
 email:
 - peter.nfonseca@gmail.com
 executables: