read_source 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a794d573c3b86ef51a54aceff6519fc1e6ff1768
+  data.tar.gz: 7510310d465840fe9819a5443358454a3c0140a6
+SHA512:
+  metadata.gz: 86a075da435a0fc7072d0db4b8bb844805e4e74b0595c4312c3e84b81fb05f08234fc1f921265895a0ec8b75ef35a1b9bb7a8f8f43b0b25eaf6f1456e0221ad8
+  data.tar.gz: 0372d7ded8fce1cfb45b30ccdd2a5d1030bad5ac3c28f1b556a3f2e93a46462196d0220dc1e1c84d3ae85b6b6345e125a7bf618b299e74d5157f5267499018e5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Daniel P. Clark
+
+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 @@
+# ReadSource
+
+Haha! This little gem was a distraction from my duties but I had to make it.
+
+At first I was going to name it VIM-something because it lets you open the source code for a method in your VIM editor.
+But as I thought about it I discovered it would be so simple to have Ruby read the method for itself. *Yes
+I know there is the `method_source` gem that has been around forever.* But if I'm writing a VIM method
+to read the source file I might as well throw in a method to string function.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'read_source'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install read_source
+
+## Usage
+
+This gem adds instance methods to the Method and UnboundMethod objects.
+
+* `Method#vim`
+* `Method#read_source`
+* `UnboundMethod#vim`
+* `UnboundMethod#read_source`
+
+Currently this assumes VIM is in your executable path.  Future versions of this gem will be more
+accommodating to where VIM may be.
+
+```ruby
+require 'read_source'
+
+require 'pathname'
+puts Pathname.instance_method(:root?).read_source
+#def root?
+#  !!(chop_basename(@path) == nil && /#{SEPARATOR_PAT}/o =~ @path)
+#end
+
+require 'prime'
+puts Integer.method(:each_prime).read_source
+#def Integer.each_prime(ubound, &block) # :yields: prime
+#  Prime.each(ubound, &block)
+#end
+```
+
+You can type `vim` instead of the `read_source` method on either the `Method` or `UnboundMethod` objects
+and it will close irb (or rails console) and open the source code file in VIM at the exact line where
+the method is defined.
+
+--- 
+
+In case you didn't know Ruby already has a bunch of nice methods on `Method` and `UnboundMethod`
+that are quite helpful.
+
+```ruby
+require 'read_source'
+require 'pathname'
+
+Pathname.method(:autoload).owner
+# => Module 
+Pathname.method(:pwd).owner
+# => #<Class:Pathname>
+Pathname.instance_method(:root?).source_location
+# => ["/home/danielpclark/.rvm/rubies/ruby-2.3.1/lib/ruby/2.3.0/pathname.rb", 208]
+```
+
+---
+
+NOTES:
+* If the source code is written in C then the `read_source` and `vim` methods only return nil.
+* If the file is in `GEM_HOME` path then VIM opens it in read only mode.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/danielpclark/read_source.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/lib/read_source/version.rb

@@ -0,0 +1,3 @@
+module ReadSource
+  VERSION = "0.1.0"
+end

data/lib/read_source.rb

@@ -0,0 +1,32 @@
+require "read_source/version"
+
+module ReadSource
+  module VimSource
+    def vim
+      file, line_num = send :source_location
+      read_only = !!/#{ENV["GEM_HOME"]}/.match(file) ? "-M" : ""
+      exec("vim %s +%s %s" % [read_only, line_num, file]) if file
+    end
+  end
+  module ReadSource
+    def read_source
+      file, line_num = send :source_location
+      return unless file
+      readlines = IO.readlines(file)
+      source = readlines[line_num-1]
+      indent = /\A[[:space:]]*/.match(source).to_s.length
+      source = source[indent..-1]
+      readlines[line_num..-1].each do |l|
+        source += l[indent..-1]
+        if indent == /\A[[:space:]]*/.match(l).to_s.length
+          break source
+        end
+      end
+    end
+  end
+
+  ::Method.include VimSource
+  ::Method.include ReadSource
+  ::UnboundMethod.include VimSource
+  ::UnboundMethod.include ReadSource
+end

data/read_source.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'read_source/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "read_source"
+  spec.version       = ReadSource::VERSION
+  spec.authors       = ["Daniel P. Clark"]
+  spec.email         = ["6ftdan@gmail.com"]
+
+  spec.summary       = %q{Read method source to String or in your VIM editor.}
+  spec.description   = %q{Read method source to String or in your VIM editor!}
+  spec.homepage      = "https://github.com/danielpclark/read_source"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: read_source
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel P. Clark
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Read method source to String or in your VIM editor!
+email:
+- 6ftdan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/read_source.rb
+- lib/read_source/version.rb
+- read_source.gemspec
+homepage: https://github.com/danielpclark/read_source
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Read method source to String or in your VIM editor.
+test_files: []