coypond 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.10)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Amit Levy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= coypond
+
+Description goes here.
+
+== Contributing to coypond
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Amit Levy. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "coypond"
+  gem.homepage = "http://github.com/alevy/coypond"
+  gem.license = "MIT"
+  gem.summary = %Q{Semantic grep for Ruby}
+  gem.description = %Q{Semantic grep for Ruby}
+  gem.email = "aalevy@gmail.com"
+  gem.authors = ["Amit Levy"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "coypond #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/bin/coypond

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require 'coypond'
+
+def print_help
+  puts "Usage:"
+  puts "  coypond search_term [options] file1 [file2 [file3 [...]]]"
+  puts ""
+  puts "Options:"
+  puts "  -m search method names"
+  puts "  -c search class names"
+  puts "  -M search Module names"
+  puts "  -a search all available type names (default: true unless another search option was given)"
+end
+
+if $*.first == "-h" || $*.first == "--help"
+  print_help
+  exit(0)
+end
+options = {:search_term => $*.shift}
+while !$*.empty? and $*.first.start_with?("-")
+  option = $*.shift
+  case option
+  when "-r"
+    options[:regexp] = true
+  when "-i"
+    options[:ignore_case] = true
+  when "-m"
+    options[:method] = true
+  when "-c"
+    options[:class] = true
+  when "-M"
+    options[:module] = true
+  when "-a"
+    options[:all] = true
+  end
+end
+
+options[:all] ||= (options.keys & [:class, :method, :module]).empty?
+
+coypond = Coypond::CoypondRunner.new($*)
+results = coypond.search(options)
+
+results.each do |file_name, res|
+  unless res.empty?
+    puts "#{file_name}:"
+    res.each do |dec, location, context|
+      puts "  #{location.join(",")}: #{context.strip}"
+    end
+    puts ""
+  end
+end

data/lib/coypond.rb

@@ -0,0 +1,52 @@
+require 'ripper'
+require 'coypond/parser'
+
+module Coypond
+  class CoypondRunner
+    
+    def initialize(files)
+      @files = files
+    end
+    
+    def search(options)
+      final_result = {}
+      each_file do |file_name, source, parser|
+        final_result[file_name] = []
+        classes = modules = methods = {}
+        classes = search_in_collection(parser.classes, options) if options[:class] || options[:all]
+        modules = search_in_collection(parser.modules, options) if options[:module] || options[:all]
+        methods = search_in_collection(parser.methods, options) if options[:method] || options[:all]
+        result = classes.merge(modules.merge(methods))
+        result.each do |dec, location|
+          context = source.lines.to_a[location.first - 1]
+          final_result[file_name] << [dec, location, context]
+        end
+      end
+      return final_result
+    end
+    
+    private
+    def search_in_collection(collection, options)
+      search_term = options[:search_term]
+      search_term = search_term.downcase if options[:ignore_case]
+      collection.select do |k,v|
+        k = k.downcase if options[:ignore_case]
+        if options[:regexp]
+          Regexp.new("#{search_term}$").match(k)
+        else
+          k.end_with?(search_term)
+        end
+      end
+    end
+    
+    def each_file
+      @files.each do |file|
+        source = File.read(file)
+        parse_tree = Ripper::SexpBuilder.new(source).parse
+        parser = Coypond::Parser.new.parse(parse_tree)
+        yield(file, source, parser)
+      end
+    end
+    
+  end
+end

data/lib/coypond/parser.rb

@@ -0,0 +1,58 @@
+module Coypond
+  class Parser
+    
+    attr_reader :classes, :modules, :methods
+    
+    def initialize
+      @classes = {}
+      @modules = {}
+      @methods = {}
+    end
+    
+    def extract_ref(type, *tail)
+      case type
+      when :const_path_ref
+        var_ref = extract_ref(*(tail.first)).first
+        name, location = extract_const_and_location(tail[1])
+        return [[var_ref, name].join("::"), location]
+      else
+        return extract_const_and_location(tail.first)
+      end
+    end
+    
+    def parse(parse_tree, prefix=nil)
+      return self unless parse_tree.is_a? Array
+      case parse_tree.first
+      when :module
+        name, location = extract_ref(*(parse_tree[1]))
+        prefix = [prefix, name].compact.join("::")
+        @modules[prefix] = location
+        parse_tree[2..-1].each do |pt|
+          parse(pt, prefix)
+        end
+      when :class
+        name, location = extract_ref(*(parse_tree[1]))
+        prefix = [prefix, name].compact.join("::")
+        @classes[prefix] = location
+        parse_tree[2..-1].each do |pt|
+          parse(pt, prefix)
+        end
+      when :def
+        name, location = extract_const_and_location(parse_tree[1])
+        prefix = [prefix, name].compact.join("#")
+        @methods[prefix] = location
+      else
+        parse_tree[1..-1].each do |pt|
+          parse(pt, prefix)
+        end
+      end
+      return self
+    end
+    
+    private
+    def extract_const_and_location(tuple)
+      return tuple[1..2]
+    end
+    
+  end
+end

data/test/coypond/test_parser.rb

@@ -0,0 +1,101 @@
+require 'helper'
+require 'coypond/parser'
+require 'ripper'
+
+class TestParser < Test::Unit::TestCase
+  should  "correctly extract const_ref" do
+    result = Coypond::Parser.new.extract_ref(*[:const_ref, [:@const, "Baz", [1, 22]]])
+    assert_equal ["Baz", [1, 22]], result
+  end
+  
+  should  "correctly extract var_ref" do
+    result = Coypond::Parser.new.extract_ref(*[:var_ref, [:@const, "Baz", [1, 22]]])
+    assert_equal ["Baz", [1, 22]], result
+  end
+  
+  should  "correctly extract const_path_ref" do
+    result = Coypond::Parser.new.extract_ref(*[:const_path_ref,
+                                               [:var_ref, [:@const, "Bar", [1, 22]]],
+                                               [:@const, "Baz", [1, 24]]])
+    assert_equal ["Bar::Baz", [1, 24]], result
+  end
+  
+  should "capture instances of `class` in classes instance variable" do
+    parse_tree = [:program,
+                  [:stmts_add,
+                    [:stmts_add,
+                      [:stmts_new],
+                      [:class, [:const_ref, [:@const, "Foo", [1, 6]]], nil,
+                                [:bodystmt,
+                                  [:stmts_add,
+                                    [:stmts_new],
+                                    [:void_stmt]], nil, nil, nil]]],
+                    [:class, [:const_ref, [:@const, "Baz", [1, 22]]], nil,
+                                [:bodystmt,
+                                  [:stmts_add,
+                                    [:stmts_new],
+                                    [:void_stmt]], nil, nil, nil]]]]
+    parser = Coypond::Parser.new.parse(parse_tree)
+
+    assert_equal ["Foo", "Baz"], parser.classes.keys
+  end
+
+  should "use fully qualified class name in classes instance variable" do
+    parse_tree = [:class,
+                   [:const_path_ref,
+                     [:var_ref,
+                       [:@const, "Bar", [1, 6]]],
+                     [:@const, "Foo", [1, 11]]],
+                   nil,
+                   [:bodystmt, [:stmts_add, [:stmts_new], [:void_stmt]], nil, nil, nil]]
+    parser = Coypond::Parser.new.parse(parse_tree)
+    
+    assert_equal ["Bar::Foo"], parser.classes.keys
+  end
+  
+  should "use multi-level fully qualified class name in classes instance variable" do
+    parse_tree = [:class,
+                   [:const_path_ref,
+                     [:const_path_ref,
+                       [:var_ref,
+                         [:@const, "Bar", [1, 6]]],
+                       [:@const, "Baz", [1, 11]]],
+                     [:@const, "Foo", [1, 16]]],
+                     nil,
+                     [:bodystmt, [:stmts_add, [:stmts_new], [:void_stmt]], nil, nil, nil]]
+    parser = Coypond::Parser.new.parse(parse_tree)
+    
+    assert_equal ["Bar::Baz::Foo"], parser.classes.keys
+  end
+
+  should "use fully qualified class name with module in classes instance variable" do
+    parse_tree = [:module, [:const_ref, [:@const, "Bar", [1, 7]]],
+                           [:bodystmt, [:stmts_add, [:stmts_add, [:stmts_new], [:void_stmt]],
+                                       [:class, [:const_ref, [:@const, "Foo", [1, 17]]], nil,
+                                                [:bodystmt,
+                                                  [:stmts_add,
+                                                    [:stmts_new],
+                                                    [:void_stmt]], nil, nil, nil]]], nil, nil, nil]]
+    parser = Coypond::Parser.new.parse(parse_tree)
+    
+    assert_equal ["Bar::Foo"], parser.classes.keys
+  end
+  
+  should "capture instances of `module` in modules instance variable" do
+    parse_tree = [:module, [:const_ref, [:@const, "Bar", [1, 7]]],
+                           [:bodystmt, [:stmts_add, [:stmts_new], [:void_stmt]], nil, nil, nil]]
+    parser = Coypond::Parser.new.parse(parse_tree)
+    
+    assert_equal ["Bar"], parser.modules.keys
+  end
+  
+  should "capture instances of `def` in methods instance variable" do
+    parse_tree = [:def, [:@ident, "foo", [1, 4]],
+                        [:params, nil, nil, nil, nil, nil],
+                        [:bodystmt, [:stmts_add, [:stmts_new], [:void_stmt]], nil, nil, nil]]
+    parser = Coypond::Parser.new.parse(parse_tree)
+    
+    assert_equal ["foo"], parser.methods.keys
+  end
+  
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'coypond'
+
+class Test::Unit::TestCase
+end

data/test/test_coypond.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestCoypond < Test::Unit::TestCase
+  # should "probably rename this file and start testing for real" do
+  #   flunk "hey buddy, you should probably rename this file and start testing for real"
+  # end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: coypond
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Amit Levy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-10 00:00:00.000000000 -07:00
+default_executable: coypond
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2157206000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157206000
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2157205080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2157205080
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2157204160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2157204160
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2157203060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157203060
+description: Semantic grep for Ruby
+email: aalevy@gmail.com
+executables:
+- coypond
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/coypond
+- lib/coypond.rb
+- lib/coypond/parser.rb
+- test/coypond/test_parser.rb
+- test/helper.rb
+- test/test_coypond.rb
+has_rdoc: true
+homepage: http://github.com/alevy/coypond
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3557283599531574218
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Semantic grep for Ruby
+test_files: []