pry-note 0.2.3 → 0.2.4

data/README.md

@@ -0,0 +1,37 @@
+Pry-note
+========
+
+__Ease refactoring and exploration by attaching notes to methods and classes in Pry__
+
+```
+[1] pry(main)> note -h
+  add
+    -m, --message      Provide the note inline (without opening an editor).
+
+  show
+    -v, --verbose      Show all notes together with source code.
+
+  list
+    -v, --verbose      List all notes and content with source code.
+
+  delete
+        --all      Delete all notes.
+
+  edit
+    -m, --message      Update the note inline (without opening an editor).
+
+  Other options
+Usage: note [OPTIONS]
+Add notes to classes and methods.
+
+e.g note -a Pry#repl "this is my note" #=> add a note without opening editor
+e.g note -a Pry#repl   #=> add a note (with editor) to Pry#repl method
+e.g note -d Pry#repl:1 #=> delete the 1st note from Pry#repl
+e.g note -d Pry#repl   #=> delete all notes from Pry#repl
+e.g note -l            #=> list all notes
+
+    -h, --help      Show this message.
+```
+
+
+See the following showterm for an example session: http://showterm.io/c194f02da5545e9210cb9#fast

data/lib/pry-note/commands.rb

@@ -204,10 +204,10 @@ Pry::Commands.create_command "note" do
   def list_all
     if notes.any?
       out = ""
-      out << text.bold("Showing all available notes:\n\n")
+      out << text.bold("Showing all available notes:\n")
       notes.each do |key, content|
         begin
-          out << create_note_output(key, true) << "\n"
+          out << "\n" << create_note_output(key, true) << "\n"
         rescue
         end
       end

data/lib/pry-note/version.rb

@@ -1,3 +1,3 @@
 module PryNote
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/pry-note.gemspec

@@ -2,14 +2,14 @@
 
 Gem::Specification.new do |s|
   s.name = "pry-note"
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mair (banisterfiend)"]
   s.date = "2012-12-01"
   s.description = "Ease refactoring and exploration by attaching notes to methods and classes in Pry"
   s.email = "jrmair@gmail.com"
-  s.files = ["Rakefile", "lib/pry-note.rb", "lib/pry-note/commands.rb", "lib/pry-note/hooks.rb", "lib/pry-note/version.rb", "pry-note.gemspec", "test/helper.rb", "test/test_pry_note.rb"]
+  s.files = ["README.md", "Rakefile", "lib/pry-note.rb", "lib/pry-note/commands.rb", "lib/pry-note/hooks.rb", "lib/pry-note/version.rb", "pry-note.gemspec", "test/helper.rb", "test/test_pry_note.rb"]
   s.homepage = "https://github.com/banister"
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.23"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-note
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -34,6 +34,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - Rakefile
 - lib/pry-note.rb
 - lib/pry-note/commands.rb