pry-note 0.2.5 → 0.2.6

data/lib/pry-note.rb

@@ -24,4 +24,29 @@ module PryNote
     expanded_path = File.expand_path(file_name)
     File.open(expanded_path, "w") { |f| f.puts YAML.dump(PryNote.notes) }
   end
+
+  # @return [Pry::Method, Pry::WrappedModule, Pry::Command] The code_object
+  def self.retrieve_code_object_safely(name, target, _pry_)
+    code_object = Pry::Helpers::CommandHelpers.retrieve_code_object_from_string(name, target)  ||
+      _pry_.commands.find_command(name)
+
+    if !code_object
+      raise Pry::CommandError, "No code object found named #{name}"
+    elsif code_object.name.to_s == ""
+      raise Pry::CommandError, "Object #{name} doesn't have a proper name, can't create note"
+    end
+
+    code_object
+  end
+
+  # @return [String] the `name` of the code object
+  def self.code_object_name(co)
+    if co.is_a?(Pry::Method)
+      co.name_with_owner
+    elsif co.is_a?(Pry::WrappedModule)
+      co.name
+    elsif co <= Pry::Command
+      co.command_name
+    end
+  end
 end

data/lib/pry-note/commands.rb

@@ -27,7 +27,7 @@ Pry::Commands.create_command "note" do
     cmd.on :export
     cmd.on :load
     cmd.on :delete do |opt|
-      opt.on :all, "Delete all notes."
+      opt.on :a, :all, "Delete all notes."
     end
 
     cmd.on :edit do |opt|
@@ -50,6 +50,10 @@ Pry::Commands.create_command "note" do
     end
   end
 
+  def code_object_name(co)
+    PryNote.code_object_name(co)
+  end
+
   def process
     if opts.command?(:add)
       cmd_opts = opts[:add]
@@ -87,15 +91,7 @@ Pry::Commands.create_command "note" do
   end
 
   def retrieve_code_object_safely(name)
-    code_object = retrieve_code_object_from_string(name, target)
-
-    if !code_object
-      raise Pry::CommandError, "No code object found named #{name}"
-    elsif code_object.name.to_s == ""
-      raise Pry::CommandError, "Object #{name} doesn't have a proper name, can't create note"
-    end
-
-    code_object
+    PryNote.retrieve_code_object_safely(name, target, _pry_)
   end
 
   def default_object_name
@@ -109,10 +105,6 @@ Pry::Commands.create_command "note" do
     end
   end
 
-  def code_object_name(co)
-    co.is_a?(Pry::Method) ? co.name_with_owner : co.name
-  end
-
   def add_note(name, message=nil)
     name ||= default_object_name
     co_name = code_object_name(retrieve_code_object_safely(name))
@@ -129,51 +121,58 @@ Pry::Commands.create_command "note" do
     output.puts "Added note to #{co_name}!"
   end
 
+  # @param [String] co_name Name of note object.
+  # @param [String, nil] note_number_s The note number as a string
+  # @param [Boolean] must_provide_number Whether note number is
+  #   allowed to be nil.
+  def ensure_note_number_in_range(co_name, note_number_s, must_provide_number=true)
+    if notes[co_name]
+      total_notes = notes[co_name].count
+    else
+      raise Pry::CommandError, "No notes available for #{co_name}"
+    end
+
+    if !note_number_s && !must_provide_number
+      # we're allowed nil, so just return
+      return
+    elsif !note_number_s
+      raise Pry::CommandError, "Must specify a note number. Allowable range is 1-#{total_notes}."
+    elsif note_number_s.to_i < 1 || note_number_s.to_i > total_notes
+      raise Pry::CommandError,  "Invalid note number (#{note_number_s}). Allowable range is 1-#{total_notes}."
+    end
+  end
+
   def reedit_note(name, message=nil)
     name, note_number_s = name.split(/:(\d+)$/)
     co_name = code_object_name(retrieve_code_object_safely(name))
-    raise Pry::CommandError, "No notes to edit!" if !notes[co_name]
 
-    total_notes = notes[co_name].count
-    note_number = note_number_s.to_i
+    ensure_note_number_in_range(co_name, note_number_s)
 
-    out = ""
-    if !notes[co_name]
-      out << "No notes to edit for #{co_name}!\n"
-    elsif !note_number_s
-      raise Pry::CommandError, "Must specify a note number. Allowable range is 1-#{total_notes}."
-    elsif note_number < 1 || note_number > total_notes
-      raise Pry::CommandError,  "Invalid note number (#{note_number}). Allowable range is 1-#{total_notes}."
+    if message
+      new_content = message
     else
-      if message
-        new_content = message
-      else
-        old_content = notes[co_name][note_number.to_i - 1]
-        new_content = edit_note(co_name, old_content.to_s)
-      end
-
-      notes[co_name][note_number.to_i - 1] = new_content
-      out << "Updated note #{note_number} for #{co_name}!\n"
+      old_content = notes[co_name][note_number.to_i - 1]
+      new_content = edit_note(co_name, old_content.to_s)
     end
+
+    notes[co_name][note_number_s.to_i - 1] = new_content
+    output.puts "Updated note #{note_number_s} for #{co_name}!\n"
   end
 
   def delete_note(name)
-    name, note_number = name.split(/:(\d+)$/)
+    name, note_number_s = name.split(/:(\d+)$/)
     co_name = code_object_name(retrieve_code_object_safely(name))
 
-    out = ""
-    if !notes[co_name]
-      out << "No notes to delete for #{co_name}!\n"
-    elsif note_number
-      notes[co_name].delete_at(note_number.to_i - 1)
+    ensure_note_number_in_range(co_name, note_number_s, false)
+
+    if note_number_s
+      notes[co_name].delete_at(note_number_s.to_i - 1)
       notes.delete(co_name) if notes[co_name].empty?
-      out << "Deleted note #{note_number} for #{co_name}!\n"
+      output.puts "Deleted note #{note_number_s} for #{co_name}!\n"
     else
       notes.delete(co_name)
-      out << "Deleted all notes for #{text.bold(co_name)}!\n"
+      output.puts "Deleted all notes for #{text.bold(co_name)}!\n"
     end
-
-    stagger_output out
   end
 
   def create_note_output(name, verbose=false)
@@ -202,8 +201,8 @@ Pry::Commands.create_command "note" do
   end
 
   def list_all
+    out = ""
     if notes.any?
-      out = ""
       out << text.bold("Showing all available notes:\n")
       notes.each do |key, content|
         begin
@@ -220,12 +219,12 @@ Pry::Commands.create_command "note" do
   end
 
   def list_notes
+    out = ""
     if notes.any?
-      out = ""
       out << text.bold("Showing all available notes:\n\n")
       notes.each do |key, content|
         begin
-          if retrieve_code_object_from_string(key, target)
+          if retrieve_code_object_safely(key)
             out << "#{text.bold(key)} has #{content.count} notes\n"
           end
         rescue

data/lib/pry-note/hooks.rb

@@ -1,7 +1,7 @@
 reminder = proc do
   begin
-    co = Pry::Helpers::CommandHelpers.retrieve_code_object_from_string(args.first.to_s, target)
-    co_name = co.is_a?(Pry::Method) ? co.name_with_owner : co.name
+    co = PryNote.retrieve_code_object_safely(args.first.to_s, target, _pry_)
+    co_name = PryNote.code_object_name(co)
     if PryNote.notes.keys.include?(co_name)
       output.puts "\n\n#{text.bold("Notes:")}\n--\n\n"
 

data/lib/pry-note/version.rb

@@ -1,3 +1,3 @@
 module PryNote
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

data/pry-note.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "pry-note"
-  s.version = "0.2.5"
+  s.version = "0.2.6"
 
   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.date = "2012-12-02"
   s.description = "Ease refactoring and exploration by attaching notes to methods and classes in Pry"
   s.email = "jrmair@gmail.com"
   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"]

data/test/test_pry_note.rb

@@ -20,7 +20,7 @@ describe PryNote do
   end
 
   describe "note add" do
-    describe "opens an editor when -m flag not provided" do
+    describe "notes added with editor" do
       it 'should open the editor' do
         used_editor = nil
         Pry.config.editor = proc { used_editor = true; nil }
@@ -28,13 +28,13 @@ describe PryNote do
         used_editor.should == true
       end
 
-      it 'should save the note' do
+      it 'should store the added note' do
         Pry.config.editor = proc { nil }
         @t.process_command "note add PryNote::TestClass"
         PryNote.notes["PryNote::TestClass"].count.should == 1
       end
 
-      it 'should put default note content in file' do
+      it 'should use default content when none other given' do
         Pry.config.editor = proc { nil }
         @t.process_command "note add PryNote::TestClass"
         PryNote.notes["PryNote::TestClass"].first.should =~ /Enter note content here/
@@ -54,6 +54,12 @@ describe PryNote do
         PryNote.notes["PryNote::TestClass#ping"].first.should =~ /my note/
       end
 
+      it 'should add a new note for a command' do
+        @t.process_command "note add show-source -m 'my note'"
+        @t.last_output.should =~ /Added note to show-source/
+        PryNote.notes["show-source"].first.should =~ /my note/
+      end
+
       it 'should add a new note for a class' do
         @t.process_command "note add PryNote::TestClass -m 'my note'"
         @t.last_output.should =~ /Added note to PryNote::TestClass/
@@ -61,15 +67,15 @@ describe PryNote do
       end
     end
 
-    describe "implicit object" do
-      it 'should add a new note for class of object implicitly (without specifying object)' do
+    describe "implicit object ('current' object extracted from binding)" do
+      it 'should add a new note for class of current object, when not in a method context' do
         @t.process_command "cd 0"
         @t.process_command "note add -m 'my note'"
         @t.last_output.should =~ /Added note to Fixnum/
         PryNote.notes["Fixnum"].first.should =~ /my note/
       end
 
-      it 'should add a new note for a method implicitly (without specifying object)' do
+      it 'should add a new note for a method, when in method context' do
         o = PryNote::TestClass.new
         t = pry_tester(o.ping)
         t.process_command "note add -m 'my note'"
@@ -139,6 +145,19 @@ describe PryNote do
     end
   end
 
+  describe "note list" do
+    it 'should list note counts for each object' do
+      @t.process_command "note add PryNote::TestClass -m 'my note1'"
+      @t.process_command "note list"
+      @t.last_output.should =~ /PryNote::TestClass has 1 notes/
+    end
+
+    it 'should indicate when there are no notes available' do
+      @t.process_command "note list"
+      @t.last_output.should =~ /No notes available/
+    end
+  end
+
   describe "note edit" do
     describe "errors" do
       it 'should error when not given a note number' do
@@ -160,11 +179,11 @@ describe PryNote do
       it 'should error when editing object with no notes' do
         capture_exception do
           @t.process_command "note edit PryNote::TestClass:2 -m 'bing'"
-        end.message.should =~ /No notes to edit/
+        end.message.should =~ /No notes available/
       end
     end
 
-    describe "-m switch" do
+    describe "-m switch (used to amend note inline and bypass editor)" do
       it 'should amend the content of a note' do
         @t.process_command "note add PryNote::TestClass -m 'my note1'"
         @t.process_command "note edit PryNote::TestClass:1 -m 'bing'"
@@ -175,12 +194,6 @@ describe PryNote do
   end
 
   describe "note show" do
-    it 'should display method source when -v flag is used' do
-      @t.process_command "note add PryNote::TestClass -m 'my note1'"
-      @t.process_command "note show PryNote::TestClass -v"
-      @t.last_output.should =~ /ping/
-    end
-
     it 'should just display number of notes by default' do
       @t.process_command "note add PryNote::TestClass -m 'my note1'"
       @t.process_command "note add PryNote::TestClass -m 'my note2'"
@@ -189,13 +202,19 @@ describe PryNote do
       @t.last_output.should.not =~ /ping/
     end
 
+    it 'should display method source when -v flag is used' do
+      @t.process_command "note add PryNote::TestClass -m 'my note1'"
+      @t.process_command "note show PryNote::TestClass -v"
+      @t.last_output.should =~ /ping/
+    end
+
     it 'should ignore :number suffix (as used in edit and delete)' do
       @t.process_command "note add PryNote::TestClass -m 'my note2'"
       @t.process_command "note show PryNote::TestClass:99"
       @t.last_output.should =~ /1/
     end
 
-    it 'should implicitly display notes for current object (class)' do
+    it 'should display notes for current object (class)' do
       @t.process_command "note add PryNote::TestClass -m 'my note1'"
       @t.process_command "note add PryNote::TestClass -m 'my note2'"
       @t.process_command "cd PryNote::TestClass"
@@ -203,13 +222,31 @@ describe PryNote do
       @t.last_output.should =~ /ping/
     end
 
-    it 'should implicitly display notes for current object (method)' do
+    it 'should display notes for current object (method)' do
       t = pry_tester(Pad.obj.ping)
       t.process_command "note add PryNote::TestClass#ping -m 'my note1'"
       t.process_command "note add PryNote::TestClass#ping -m 'my note2'"
       t.process_command "note show -v"
       t.last_output.should =~ /binding/
     end
+
+    describe "command notes" do
+      it 'should show notes for a command' do
+        @t.process_command "note add show-source -m 'my note1'"
+        @t.process_command "note show show-source"
+        @t.last_output.should =~ /show-source/
+        @t.last_output.should =~ /my note1/
+      end
+
+      it 'should show command source when -v switch is used' do
+        @t.process_command "note add show-source -m 'my note1'"
+        @t.process_command "note show show-source -v"
+
+        # note this test may fail in future if we change command
+        # creation API
+        @t.last_output.should =~ /create_command/
+      end
+    end
   end
 
   describe "note export" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-note
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-01 00:00:00.000000000 Z
+date: 2012-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake