cans 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Bryce Kerley
+
+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,20 @@
+= cans
+
+Interactive online source browser for Rack applications.
+
+Experimental and unfinished. This gem will probably kill
+you in your sleep if you try to use it right now.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Bryce Kerley. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cans"
+    gem.summary = %Q{Source browser for Rack applications}
+    gem.description = %Q{Interactive on-line source browser for rack applications}
+    gem.email = "bkerley@brycekerley.net"
+    gem.homepage = "http://github.com/bkerley/cans"
+    gem.authors = ["Bryce Kerley"]
+
+    gem.add_dependency 'sinatra', '~> 1.1.0'
+    gem.add_dependency 'haml', '~> 3.0.22'
+    gem.add_dependency 'method_extensions', '~> 0.0.8'
+
+    gem.add_development_dependency "shoulda", "~> 2.11.3"
+    gem.add_development_dependency 'rack-test', '~> 0.5.6'
+
+    gem.required_ruby_version = '~> 1.9.2'
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cans #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/config.ru

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__), 'lib', 'cans.rb')
+use Rack::ContentLength
+
+run(Cans::Application.new)

data/lib/cans/address.rb

@@ -0,0 +1,49 @@
+module Cans
+  class Address
+    METHOD_KIND_REGEX = %r{\.(.)}
+    MODULE_NAME_REGEX = /^(.+)\/\.|^(.+)$/
+    METHOD_NAME_REGEX = %r{\../(.+)$}
+
+    def initialize(address_string)
+      @string = address_string
+    end
+
+    def module_name
+      md = MODULE_NAME_REGEX.match @string
+      raise "No module_name found in #{@string.inspect}" unless md
+      return md.captures.detect{ |m| !(m.nil? || m.empty?) }.gsub('/','::')
+    end
+
+    def method_kind
+      md = METHOD_KIND_REGEX.match @string
+      raise "No method_kind found" unless md
+      return case md[1]
+             when 'i'
+               :instance
+             when 'm'
+               :module
+             else
+               raise 'Unexpected method_kind found'
+             end
+    end
+
+    def method_name
+      md = METHOD_NAME_REGEX.match @string
+      raise 'No method_name found' unless md
+      return md[1].gsub('/','')
+    end
+
+    def target_module
+      eval "::#{module_name}"
+    end
+
+    def target_method
+      case method_kind
+      when :instance
+        target_module.instance_method method_name
+      when :module
+        target_module.method method_name
+      end
+    end
+  end
+end

data/lib/cans/application.rb

@@ -0,0 +1,33 @@
+module Cans
+  class Application < Sinatra::Base
+      set :views, File.dirname(__FILE__) + '/views'
+
+    get '/' do
+      @constants = Object.constants
+      @modules = @constants.map{ |c| Object.const_get c}.select{ |c| c.kind_of? Module}.sort_by(&:name)
+      haml :index
+    end
+
+    get '/module/*' do
+      @address = Address.new(params[:splat].first)
+      @module = @address.target_module
+
+      @local_instance_methods = @module.instance_methods false
+      @all_instance_methods = @module.instance_methods true
+      @super_instance_methods = @all_instance_methods - @local_instance_methods
+
+      @class_methods = @module.methods
+
+      @ancestors = @module.ancestors
+      @child_modules = @module.constants.map{ |c| @module.const_get c}.select{ |c| c.kind_of? Module}.sort_by(&:name)
+      haml :module
+    end
+
+    get '/method/*' do
+      @address = Address.new(params[:splat].first)
+      @module = @address.target_module
+      @method = @address.target_method
+      haml :method
+    end
+  end
+end

data/lib/cans/views/index.haml

@@ -0,0 +1,10 @@
+!!! 5
+%html
+  %head
+    %title Cans
+  %body
+    %h1 Top-Level Modules
+    %ul
+      - @modules.each do |m|
+        %li
+          %a{:href=>"/module/#{m.name}"}&= m.name

data/lib/cans/views/method.haml

@@ -0,0 +1,11 @@
+!!! 5
+%html
+  %head
+    %title #{@module.name} #{@method.name} | Cans
+  %body
+    %h1 #{@module.name} #{@method.name}
+    - unless @method.source_location.nil?
+      %p #{@method.name} is defined at #{@method.source_location.map(&:inspect).join(', line ')}
+      %pre=@method.source_with_doc
+    - else
+      %p #{@method.name} is defined in the Ruby source code.

data/lib/cans/views/module.haml

@@ -0,0 +1,36 @@
+!!! 5
+%html
+  %head
+    %title #{@module.name} | Cans
+  %body
+    %h1 #{@module.name}
+    %p #{@module.name} inherits from:
+    %ul
+      - @ancestors.sort_by(&:name).each do |a|
+        %li
+          %a{:href=>"/module/#{a.name.gsub('::','/')}"}
+            &=a.name
+    %h2 Child Modules
+    %ul
+      - @child_modules.each do |c|
+        %li
+          %a{:href=>"/module/#{c.name.gsub('::','/')}"}
+            &=c.name
+    %h2 Class/Module Methods
+    %ul
+      - @class_methods.sort_by(&:to_s).each do |m|
+        %li
+          %a{:href=>"/method/#{@module.name}/.m/#{m.to_s}"}
+            &=m.to_s
+    %h2 Local Instance Methods
+    %ul
+      - @local_instance_methods.sort_by(&:to_s).each do |m|
+        %li
+          %a{:href=>"/method/#{@module.name}/.i/#{m.to_s}"}
+            &=m.to_s
+    %h2 Inherited Instance Methods
+    %ul
+      - @super_instance_methods.sort_by(&:to_s).each do |m|
+        %li
+          %a{:href=>"/method/#{@module.name}/.i/#{m.to_s}"}
+            &=m.to_s

data/lib/cans.rb

@@ -0,0 +1,11 @@
+%w{ method_extensions sinatra/base haml }.each do |g|
+  require g
+end
+
+%w{ address application }.each do |f|
+  require File.join(File.dirname(__FILE__), 'cans', f)
+end
+
+module Cans
+
+end

data/test/fixtures/beverage.rb

@@ -0,0 +1,5 @@
+class Beverage
+  def refreshing
+    'quite'
+  end
+end

data/test/helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack/test'
+require 'shoulda'
+
+ENV['RACK_ENV'] = 'test'
+
+require File.join(File.dirname(__FILE__), 'fixtures', 'beverage')
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'cans'
+
+class Test::Unit::TestCase
+  include Rack::Test::Methods
+end

data/test/test_address.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+class TestAddress < Test::Unit::TestCase
+  context 'an Address to an instance method on the Beverage class' do
+    setup do
+      @address = Cans::Address.new 'Beverage/.i/refreshing'
+    end
+    subject { @address }
+
+    should 'decode a module_name' do
+      assert_equal 'Beverage', subject.module_name
+    end
+
+    should 'decode a method_kind' do
+      assert_equal :instance, subject.method_kind
+    end
+
+    should 'decode a method_name' do
+      assert_equal 'refreshing', subject.method_name
+    end
+
+    should 'find the target_module' do
+      assert_equal Beverage, subject.target_module
+    end
+    
+    should 'find the target_method' do
+      assert_equal Beverage.instance_method(:refreshing), subject.target_method
+    end
+  end
+
+  context 'an Address to the Beverage class' do
+    setup do
+      @address = Cans::Address.new 'Beverage'
+    end
+    subject { @address }
+
+    should 'decode the module_name' do
+      assert_equal 'Beverage', subject.module_name
+    end
+
+    should 'find the target_module' do
+      assert_equal Beverage, subject.target_module
+    end
+  end
+end

data/test/test_application.rb

@@ -0,0 +1,69 @@
+require 'helper'
+
+class TestApplication < Test::Unit::TestCase
+  context 'an Application instance' do
+    subject { app.new }
+
+    context '#call method' do
+      subject { app.new.method :call }
+
+      should 'exist' do
+        assert subject
+      end
+
+      should 'have an arity of 1' do
+        assert_equal 1, subject.arity
+      end
+    end
+  end
+
+  context 'get to /' do
+    setup do
+      get '/'
+    end
+
+    should 'be ok' do
+      assert last_response.ok?
+    end
+
+    should 'list some known modules' do
+      expected_constants = %w{ Cans Beverage TestApplication }
+
+      expected_constants.each do |c|
+        assert_match c, last_response.body
+      end
+    end
+  end
+
+  context 'get to /method/Beverage/.i/refreshing' do
+    setup do
+      get '/method/Beverage/.i/refreshing'
+    end
+
+    should 'be ok' do
+      assert last_response.ok?
+    end
+
+    should 'include the source' do
+      assert_match /quite/, last_response.body
+    end
+  end
+
+  context 'get to /module/Beverage' do
+    setup do
+      get '/module/Beverage'
+    end
+
+    should 'be ok' do
+      assert last_response.ok?
+    end
+
+    should 'include the "refreshing" instance method' do
+      assert_match /refreshing/, last_response.body
+    end
+  end
+
+  def app
+    Cans::Application
+  end
+end

data/test/test_cans.rb

@@ -0,0 +1,4 @@
+require 'helper'
+
+class TestCans < Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification 
+name: cans
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bryce Kerley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 22
+        version: 3.0.22
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: method_extensions
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 8
+        version: 0.0.8
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 11
+        - 3
+        version: 2.11.3
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 6
+        version: 0.5.6
+  type: :development
+  version_requirements: *id005
+description: Interactive on-line source browser for rack applications
+email: bkerley@brycekerley.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- config.ru
+- lib/cans.rb
+- lib/cans/address.rb
+- lib/cans/application.rb
+- lib/cans/views/index.haml
+- lib/cans/views/method.haml
+- lib/cans/views/module.haml
+- test/fixtures/beverage.rb
+- test/helper.rb
+- test/test_address.rb
+- test/test_application.rb
+- test/test_cans.rb
+has_rdoc: true
+homepage: http://github.com/bkerley/cans
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ~>
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 9
+      - 2
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Source browser for Rack applications
+test_files: 
+- test/fixtures/beverage.rb
+- test/helper.rb
+- test/test_address.rb
+- test/test_application.rb
+- test/test_cans.rb