Module: MethodExtensions::MethodSourceWithDoc

Defined in:
lib/method_extensions/method/source_with_doc.rb

Defined Under Namespace

Classes: MethodDocRipper, MethodSourceRipper

Instance Method Summary collapse

Instance Method Details

#doc ⇒ Object

Returns comment preceding the method definition by parsing the file returned by ‘Method#source_location`

Sample IRB session:

ruby-1.9.2-head > require 'fileutils'

ruby-1.9.2-head > puts FileUtils.method(:mkdir).doc
#
# Options: mode noop verbose
#
# Creates one or more directories.
#
#   FileUtils.mkdir 'test'
#   FileUtils.mkdir %w( tmp data )
#   FileUtils.mkdir 'notexist', :noop => true  # Does not really create.
#   FileUtils.mkdir 'tmp', :mode => 0700
#



53
54
55
 
# File 'lib/method_extensions/method/source_with_doc.rb', line 53

def doc
  MethodDocRipper.doc_from_source_location(source_location)
end

#full_inspect ⇒ Object 



110
111
112
 
# File 'lib/method_extensions/method/source_with_doc.rb', line 110

def full_inspect
  "#{ to_s }\n#{ source_location }\n#{ source_with_doc }"
end

#irb_inspect ⇒ Object

Place this to the ~/.irbrc class Method

alias_method :inspect, :irb_inspect if method_defined?(:irb_inspect)

end class UnboundMethod

alias_method :inspect, :irb_inspect if method_defined?(:irb_inspect)

end



121
122
123
124
125
126
 
# File 'lib/method_extensions/method/source_with_doc.rb', line 121

def irb_inspect
  require "coderay"
  puts "#{ to_s }\n#{ source_location }"
  puts CodeRay.scan(source_with_doc, :ruby).term
  nil
end

#source ⇒ Object

Returns method source by parsing the file returned by ‘Method#source_location`.

If method definition cannot be found ‘ArgumentError` exception is raised (this includes methods defined `attr_accessor`, `module_eval` etc.).

Sample IRB session:

ruby-1.9.2-head > require 'fileutils'

ruby-1.9.2-head > puts FileUtils.method(:mkdir).source
def mkdir(list, options = {})
    fu_check_options options, OPT_TABLE['mkdir']
    list = fu_list(list)
    fu_output_message "mkdir #{options[:mode] ? ('-m %03o ' % options[:mode]) : ''}#{list.join ' '}" if options[:verbose]
    return if options[:noop]

    list.each do |dir|
      fu_mkdir dir, options[:mode]
    end
  end
 => nil



31
32
33
 
# File 'lib/method_extensions/method/source_with_doc.rb', line 31

def source
  MethodSourceRipper.source_from_source_location(source_location)
end

#source_with_doc ⇒ Object

ruby-1.9.2-head > irb_context.inspect_mode = false # turn off inspect mode so that we can view sources

ruby-1.9.2-head > ActiveRecord::Base.method(:find).source_with_doc ArgumentError: failed to find method definition around the lines:

delegate :find, :first, :last, :all, :destroy, :destroy_all, :exists?, :delete, :delete_all, :update, :update_all, :to => :scoped
delegate :find_each, :find_in_batches, :to => :scoped

ruby-1.9.2-head > ActiveRecord::Base.method(:scoped).source_with_doc

# Returns an anonymous scope.
#
#   posts = Post.scoped
#   posts.size # Fires "select count(*) from  posts" and returns the count
#   posts.each {|p| puts p.name } # Fires "select * from posts" and loads post objects
#
#   fruits = Fruit.scoped
#   fruits = fruits.where(:colour => 'red') if options[:red_only]
#   fruits = fruits.limit(10) if limited?
#
# Anonymous \scopes tend to be useful when procedurally generating complex queries, where passing
# intermediate values (scopes) around as first-class objects is convenient.
#
# You can define a scope that applies to all finders using ActiveRecord::Base.default_scope.
def scoped(options = {}, &block)
  if options.present?
    relation = scoped.apply_finder_options(options)
    block_given? ? relation.extending(Module.new(&block)) : relation
  else
    current_scoped_methods ? unscoped.merge(current_scoped_methods) : unscoped.clone
  end
end

ruby-1.9.2-head > ActiveRecord::Base.method(:unscoped).source_with_doc
 => def unscoped
  @unscoped ||= Relation.new(self, arel_table)
  finder_needs_type_condition? ? @unscoped.where(type_condition) : @unscoped
end

ruby-1.9.2-head > ActiveRecord::Relation.instance_method(:find).source_with_doc
 => # Find operates with four different retrieval approaches:
...
def find(*args, &block)
  return to_a.find(&block) if block_given?

  options = args.extract_options!

  if options.present?
...



104
105
106
107
108
 
# File 'lib/method_extensions/method/source_with_doc.rb', line 104

def source_with_doc
  return unless source_location

  [doc.to_s.chomp, source_unindent(source)].compact.reject(&:empty?).join("\n")
end