pry-note 0.1.0

data/Rakefile

@@ -0,0 +1,82 @@
+$:.unshift 'lib'
+
+dlext = RbConfig::CONFIG['DLEXT']
+direc = File.dirname(__FILE__)
+
+PROJECT_NAME = "pry-note"
+
+require 'rake/clean'
+require 'rake/gempackagetask'
+require "#{PROJECT_NAME}/version"
+
+CLOBBER.include("**/*~", "**/*#*", "**/*.log")
+CLEAN.include("**/*#*", "**/*#*.*", "**/*_flymake*.*", "**/*_flymake",
+              "**/*.rbc", "**/.#*.*")
+
+def apply_spec_defaults(s)
+  s.name = PROJECT_NAME
+  s.summary = "Ease refactoring and exploration by attaching notes to methods and classes in Pry"
+  s.version = PryNote::VERSION
+  s.date = Time.now.strftime '%Y-%m-%d'
+  s.author = "John Mair (banisterfiend)"
+  s.email = 'jrmair@gmail.com'
+  s.description = s.summary
+  s.require_path = 'lib'
+  s.add_development_dependency('rake', '~> 0.9')
+  s.homepage = "https://github.com/banister"
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
+end
+
+desc "run pry with plugin enabled"
+task :pry do
+  exec("pry -rubygems -I#{direc}/lib/ -r #{direc}/lib/#{PROJECT_NAME}")
+end
+
+desc "Show version"
+task :version do
+  puts "Pry-note version: #{PryNote::VERSION}"
+end
+
+desc "generate gemspec"
+task :gemspec => "ruby:gemspec"
+
+namespace :ruby do
+  spec = Gem::Specification.new do |s|
+    apply_spec_defaults(s)
+    s.platform = Gem::Platform::RUBY
+  end
+
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+
+  desc  "Generate gemspec file"
+  task :gemspec do
+    File.open("#{spec.name}.gemspec", "w") do |f|
+      f << spec.to_ruby
+    end
+  end
+end
+
+desc "build all platform gems at once"
+task :gems => [:clean, :rmgems, :gemspec, "ruby:gem"]
+
+desc "remove all platform gems"
+task :rmgems => ["ruby:clobber_package"]
+
+desc "reinstall gem"
+task :reinstall => :gems do
+  sh "gem uninstall pry-note" rescue nil
+  sh "gem install #{direc}/pkg/#{PROJECT_NAME}-#{PryNote::VERSION}.gem"
+end
+
+desc "build and push latest gems"
+task :pushgems => :gems do
+  chdir("#{File.dirname(__FILE__)}/pkg") do
+    Dir["*.gem"].each do |gemfile|
+      sh "gem push #{gemfile}"
+    end
+  end
+end

data/lib/pry-note.rb

@@ -0,0 +1,182 @@
+Pry::Commands.create_command "note" do
+  description "Note stuff."
+
+  banner <<-USAGE
+    Usage: note [OPTIONS]
+    Add notes to classes and methods.
+
+    e.g note -a Pry#repl   #=> add a note 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
+  USAGE
+
+  def options(opt)
+    opt.on :a, :add, "Add a note to a method or class.", :argument => true
+    opt.on :s, :show, "Show any notes associated with the given method or class.", :argument => true
+    opt.on :d, :delete, "Delete notes for a method or class.", :argument => true
+    opt.on "delete-all", "Delete all notes."
+    opt.on :e, :export, "Export notes to a file.", :argument => :optional
+    opt.on :load, "Load notes from a file.", :argument => :optional
+    opt.on :l, :list, "List all notes."
+  end
+
+  def setup
+    if !state.initial_setup_complete
+      add_reminders
+      load_notes
+      state.initial_setup_complete = true
+      _pry_.hooks.add_hook(:after_session, :export_notes) { export_notes }
+    end
+  end
+
+  def notes
+    state.notes ||= {}
+  end
+
+  # edit a note in a temporary file and return note content
+  def edit_note(obj_name)
+    temp_file do |f|
+      f.puts("Enter note content here for #{obj_name} (and erase this line)")
+      f.flush
+      f.close(false)
+      invoke_editor(f.path, 1, false)
+      File.read(f.path)
+    end
+  end
+
+  def process
+    if opts.present?(:add)
+      add_note(opts[:a])
+    elsif opts.present?(:show)
+      show_note(opts[:s])
+    elsif opts.present?(:list)
+      list_notes
+    elsif opts.present?(:export)
+      export_notes(opts[:e])
+    elsif opts.present?(:delete)
+      delete_note(opts[:d])
+    elsif opts.present?(:"delete-all")
+      notes.replace({})
+    elsif opts.present(:load)
+      load_notes(opts[:load])
+    end
+  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
+  end
+
+  def code_object_name(co)
+    co.is_a?(Pry::Method) ? co.name_with_owner : co.name
+  end
+
+  def add_note(name)
+    co_name = code_object_name(retrieve_code_object_safely(name))
+    note = edit_note(co_name)
+
+    notes[co_name] ||= []
+    notes[co_name] << note
+  end
+
+  def delete_note(name)
+    name, note_number = name.split(":")
+    co_name = code_object_name(retrieve_code_object_safely(name))
+
+    if !notes[co_name]
+      output.puts "No notes to delete for #{co_name}!"
+    elsif note_number
+      notes[co_name].delete_at(note_number.to_i - 1)
+      notes.delete(co_name) if notes[co_name].empty?
+      output.puts "Deleted note #{note_number} for #{co_name}!"
+    else
+      notes.delete(co_name)
+      output.puts "Deleted all notes for #{co_name}!"
+    end
+  end
+
+  def show_note(name)
+    code_object = retrieve_code_object_safely(name)
+
+    co_name = code_object_name(code_object)
+
+    if !notes.has_key?(co_name)
+      output.puts "No notes saved for #{co_name}"
+      return
+    end
+
+    output.puts "Showing note(s) for #{co_name}:"
+
+    notes[code_object_name(code_object)].each_with_index do |note, index|
+      output.puts "\nNote #{index + 1}:\n--"
+      output.puts note
+    end
+  end
+
+  def export_notes(file_name=nil)
+    require 'yaml'
+    file_name ||= "./notes.yml"
+
+    expanded_path = File.expand_path(file_name)
+    File.open(expanded_path, "w") { |f| f.puts YAML.dump(notes) }
+    output.puts "Exported notes to #{expanded_path}!"
+  end
+
+  def load_notes(file_name=nil)
+    require 'yaml'
+    file_name ||= "./notes.yml"
+
+    expanded_path = File.expand_path(file_name)
+    if File.exists?(expanded_path)
+      notes.replace YAML.load File.read(expanded_path)
+    end
+  end
+
+  def list_notes
+    if notes.any?
+      output.puts "Showing all available notes:\n\n"
+      notes.each do |key, content|
+        if retrieve_code_object_from_string(key, target)
+          output.puts "#{key} has #{content.count} notes"
+        end
+      end
+
+      output.puts "\nTo view notes for an item type, e.g: `note -s Klass#method`"
+    else
+      output.puts "No notes available."
+    end
+  end
+
+  def add_reminders
+    me = self
+    max_length = 40
+    reminder = proc do
+      begin
+        code_object = retrieve_code_object_from_string(args.first.to_s, target)
+        if me.notes.keys.include?(me.code_object_name(code_object))
+          co_name = me.code_object_name(code_object)
+          output.puts "\n\n#{text.bold("Notes:")}\n--\n\n"
+
+          me.notes[me.code_object_name(code_object)].each_with_index do |note, index|
+            clipped_note = note.lines.count < 3  ? note : note.lines.to_a[0..2].join + text.bold("<...clipped...>") + " Use `note -s #{co_name}` to view unelided notes."
+            amended_note = clipped_note.lines.each_with_index.map { |line, idx| idx > 0 ? "#{' ' * ((index + 1).to_s.size + 2)}#{line}" : line }.join
+            output.puts "#{text.bold((index + 1).to_s)}. #{amended_note}"
+          end
+
+        end
+        rescue
+      end
+    end
+
+    _pry_.commands.after_command("show-source", &reminder)
+    _pry_.commands.after_command("show-doc", &reminder)
+  end
+end

data/lib/pry-note/version.rb

@@ -0,0 +1,3 @@
+module PryNote
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: pry-note
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- John Mair (banisterfiend)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Ease refactoring and exploration by attaching notes to methods and classes
+  in Pry
+email: jrmair@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/pry-note.rb
+- lib/pry-note/version.rb
+homepage: https://github.com/banister
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Ease refactoring and exploration by attaching notes to methods and classes
+  in Pry
+test_files: []