Repository files navigation

RubySonar is a semantic indexer for Ruby, which doesinterprocedural analysis to infer types. It is one of the underlyingtechnologies that powers the code search siteSourcegraph.

RubySonar is modeled afterPySonar2, which does a similaranalysis for Python and has been in use by Sourcegraph and Google. To understandits technical properties, please refer to my blog posts:

• http://yinwang0.wordpress.com/2010/09/12/pysonar

mvn package

• irb

RubySonar uses theirb interpreter to parse Ruby code, so please make sure youhave it installed and pointed to by thePATH environment variable.

RubySonar is mainly designed as a library for IDEs and other developer tools, soits interface may not be as appealing as an end-user tool, but for yourunderstanding of the library's capabilities, a reasonably nice demo program hasbeen built.

You can build a simple "code-browser" of your ruby code with the followingcommand line:

java -jar target/rubysonar-0.1-SNAPSHOT.jar /path/to/project ./html

This will take a few minutes. You should find some interactive HTML files insidethehtml directory after this process.

RubySonar - an advanced semantic indexer for Ruby

Copyright (c) 2013-2019 Yin Wang

Redistribution and use in source and binary forms, with or without modification,are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, thislist of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,this list of conditions and the following disclaimer in the documentationand/or other materials provided with the distribution.

3. The name of the author may not be used to endorse or promote products derivedfrom this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIEDWARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENTSHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENTOF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESSINTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER INCONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISINGIN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITYOF SUCH DAMAGE.