docstrings 0.0.1 → 0.1.0

data/.travis.yml

@@ -1,3 +1,10 @@
 language: ruby
 rvm:
   - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+  - 2.0.0
+  - ree
+  - 1.8.7
+  - jruby-18mode
+  - rbx-18mode

data/README.md

@@ -2,6 +2,22 @@
 
 DocStrings allows you to define and access Python-like docstrings in Ruby.
 
+[![Build Status](https://travis-ci.org/chendo/docstrings.png)](https://travis-ci.org/chendo/docstrings)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'docstrings'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install docstrings
+
 ## Usage
 
 ```ruby
@@ -35,7 +51,7 @@ So `"""Foo"""` simply evaluates to `"Foo"`, and all this gem does is define a me
 
 ## Wouldn't this cause a performance hit every time the method is called?
 
-Nope! At least, not in CRuby. Ruby is smart enough to recognise when string literals aren't actually used, and will skip generating bytecode for it.
+Nope! At least, not in CRuby. Ruby is smart enough to recognise when string literals aren't actually used, and will skip generating bytecode for it. Thanks to @charliesome for pointing this out.
 
 ```ruby
 def no_docstring
@@ -67,20 +83,11 @@ puts RubyVM::InstructionSequence.of(method(:with_docstring)).disasm
 
 See https://eval.in/36676
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'docstrings'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install docstrings
+## Compatibility
 
+* Ruby 1.9.x, 2.x
+* JRuby 1.9 mode
+* Rubinus 1.9 mode
 
 ## Contributing
 

data/docstrings.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "method_source", "~> 0.8"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/lib/docstrings.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__))
 
 require "docstrings/version"
+require "method_source"
 require "docstrings/extensions/base"
 
 module DocStrings

data/lib/docstrings/extensions/base.rb

@@ -3,13 +3,8 @@ module DocStrings
     module Base
       module MethodExtension
         def docstring
-          path, line_number = source_location
-
-          if path && File.exists?(path)
-            file = File.read(path)
-
-            # FIXME: This will work terribly for large files
-            if file =~ Regexp.new(%Q{\\A(?:.*?\n){#{line_number}}\s*?"""([\\s\\S]+?)"""})
+          if respond_to?(:source)
+            if source =~ Regexp.new(%Q{"""([\\s\\S]+?)"""})
               $1.gsub(/\n\s+/, "\n").strip
             end
           end

data/lib/docstrings/version.rb

@@ -1,3 +1,3 @@
 module DocStrings
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docstrings
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,6 +11,22 @@ bindir: bin
 cert_chain: []
 date: 2013-07-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement