docstrings 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in docstrings.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jack Chen (chendo)
+
+MIT License
+
+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.md

@@ -0,0 +1,95 @@
+# DocStrings
+
+DocStrings allows you to define and access Python-like docstrings in Ruby.
+
+## Usage
+
+```ruby
+class Dog
+  def bark
+    """Tell the dog to bark."""
+    puts "Woof!"
+  end
+
+  def sit
+    """
+      Makes the dog sit.
+    """
+    @state = :sitting
+  end
+end
+
+Dog.instance_method(:bark).docstring # => "Tell the dog to bark."
+Dog.new.method(:sit).docstring       # => "Makes the dog sit.
+```
+
+## How does it work?
+
+Ruby has this odd syntax which allows you to concatenate two strings by simply having them side by side:
+
+```ruby
+"foo" "bar" # => "foobar"
+```
+
+So `"""Foo"""` simply evaluates to `"Foo"`, and all this gem does is define a method to retrieve this value by using `Method#source_location`.
+
+## 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.
+
+```ruby
+def no_docstring
+  nil
+end
+
+def with_docstring
+  """Foo"""
+  nil
+end
+
+puts RubyVM::InstructionSequence.of(method(:no_docstring)).disasm
+puts "---"
+puts RubyVM::InstructionSequence.of(method(:with_docstring)).disasm
+
+# Output:
+# == disasm: <RubyVM::InstructionSequence:no_docstring@/tmp/execpad-ecb5745fbd46/source-ecb5745fbd46>
+# 0000 trace            8                                               (   1)
+# 0002 putnil
+# 0003 trace            16                                              (   3)
+# 0005 leave
+# ---
+# == disasm: <RubyVM::InstructionSequence:with_docstring@/tmp/execpad-ecb5745fbd46/source-ecb5745fbd46>
+# 0000 trace            8                                               (   5)
+# 0002 putnil
+# 0003 trace            16                                              (   8)
+# 0005 leave
+```
+
+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
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+See `LICENSE.txt`. It's MIT.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/docstrings.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docstrings/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "docstrings"
+  spec.version       = DocStrings::VERSION
+  spec.authors       = ["Jack Chen (chendo)"]
+  spec.email         = ["gems+docstrings@chen.do"]
+  spec.description   = %q{docstrings is a gem that adds the ability to use Python-like docstrings}
+  spec.summary       = %q{docstrings allows you to define and access docstrings on methods in Ruby}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/docstrings.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__))
+
+require "docstrings/version"
+require "docstrings/extensions/base"
+
+module DocStrings
+  module_function
+
+  def init
+    Method.send(:include, DocStrings::Extensions::Base::MethodExtension)
+    UnboundMethod.send(:include, DocStrings::Extensions::Base::MethodExtension)
+  end
+end
+
+DocStrings.init

data/lib/docstrings/extensions/base.rb

@@ -0,0 +1,20 @@
+module DocStrings
+  module Extensions
+    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]+?)"""})
+              $1.gsub(/\n\s+/, "\n").strip
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/docstrings/version.rb

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

data/spec/docstrings_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe DocStrings do
+  class TestClass
+    def no_docstring
+    end
+
+    def simple
+      """Simple"""
+    end
+
+    def multi_line
+      """
+        Line 1
+        Line 2
+      """
+    end
+  end
+
+  def docstring_for_method(method_name)
+    TestClass.instance_method(method_name).docstring
+  end
+
+  it "works with simple docstrings" do
+    docstring_for_method(:simple).should == "Simple"
+  end
+
+  it "returns nil when no docstring" do
+    docstring_for_method(:no_docstring).should be_nil
+  end
+
+  it "works with multiline docstrings" do
+    docstring_for_method(:multi_line).should == "Line 1\nLine 2"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'docstrings'

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: docstrings
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jack Chen (chendo)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: docstrings is a gem that adds the ability to use Python-like docstrings
+email:
+- gems+docstrings@chen.do
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- docstrings.gemspec
+- lib/docstrings.rb
+- lib/docstrings/extensions/base.rb
+- lib/docstrings/version.rb
+- spec/docstrings_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: docstrings allows you to define and access docstrings on methods in Ruby
+test_files:
+- spec/docstrings_spec.rb
+- spec/spec_helper.rb
+has_rdoc: