Git Product home page Git Product logo

class_source's Introduction

@markup markdown

@title ClassSource

Getting Started

Installation

ClassSource is distributed via rubygems.

gem install class_source

Inspecting the Source of a Class

First you'll want to extend your class with ClassSource

MyClass.send :extend, ClassSource

Now you can get the source of your class.

MyClass.__source__.to_s

# => "class MyClass\n  def method1\n    puts "hambone"\n  end\nend"

You may want to know where the source was defined. This data will be returned as an array of [file, line_number] pairs, much like the results of Ruby 1.9's UnboundMethod#source_location method.

MyClass.__source__.locations

# => [["lib/my_class.rb", 12], ["lib/monkey_path.rb", 14]]

And at times you may want source file data indexed by location.

MyClass.__source__.all

# => {["lib/my_class.rb", 12] => "class MyClass\nend\n", ["lib/monkey_patch.rb", 14] => "class MyClass\n  def method1\n  puts "hambone"\n  end\nend"}

Caveats

ClassSource is an 80% solution which handles common cases. It is designed to be non-invasive and permit the inspection of a runtime constructed prior to the introduction of ClassSource. It doesn't override 'require' or 'load'. It is implemented in pure Ruby.

Credits

ClassSource is inspired by and in some cases supplemented by code originally used in MethodSource by John Mair (banisterfiend). Thank you.

class_source's People

Contributors

austinworks avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.