method_reflect 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzFiYzViNDE4NjUzZTMwYTdkMjNkYzViZmE0MGJhNTVlZmMwNzdiMA==
+  data.tar.gz: !binary |-
+    MWEzMzFjZWY0M2I5YjA4NTRhZDdjOTQ5ODY3Y2Q4Y2ViMGM5NjUxNQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZjQxZWZkMWU2YjI3NWYxNTZjM2Y2YzM1OTdhZTZmNWI4ZTdmNjhhNmM1ZmY3
+    NjFkODEzOWI4ZTFmZDI4Njk3ZTMzNWIxZTA2ZWVjNDk3NjdjMjNkNTM0ZWQy
+    ZDU5Njg1MDgzODE5MTZmOWNkOTgxMzgxNWM2NGU5NzZjOTJiZGE=
+  data.tar.gz: !binary |-
+    OGNjOThiODhjODAxNjJhMzZmMDI4MjNlZWFlY2JlNjc1NDQ0NGY3NDc4Y2Q5
+    ZTFkN2NlZTQ3ZWRjOTYwNDA5YmRmMzJjYTIwZDIwYzNiYTdiM2IwNDIyMDM4
+    MmViNzJjYjlhZGZjYTczZTRmOGQwZGRkYTA5NmMwZmJiZDcxYTE=

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Danny Purcell
+
+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,34 @@
+Method Reflect
+---------------
+
+© Danny Purcell 2013 | MIT license
+
+Gives Ruby Methods some deeper self-knowledge.
+
+Features
+---------------
+
+Loading this gem adds several instance methods to the core Method class so methods can tell you more about themselves.
+
+Leverages [YARD](https://github.com/lsegal/yard) and [method_source](https://github.com/banister/method_source) to
+provide easy access to everything you might want to know about a method.
+
+
+Installation
+---------------
+
+#### Install with Gem
+* Available on [Rubygems](https://rubygems.org/gems/method_reflect)
+* Be sure one of your gem sources is `source 'https://rubygems.org'`
+* Run `gem install rubycom`
+
+#### Building locally
+* Fork the repository if you wish
+* Clone repository locally
+    * If using the main repo: `git clone https://github.com/dannypurcell/method_reflect.git`
+* Run `rake install` if installing for the first time
+* If updating to the latest version run the following commands
+    * `git checkout master`
+    * `git pull origin master`
+        * If that causes any problems `git reset --hard origin/master`
+    * `rake upgrade`

data/Rakefile

@@ -0,0 +1,74 @@
+require 'yard'
+require 'rake/testtask'
+
+task :default => [:package]
+
+task :clean do
+  FileUtils.rm_rf('./doc')
+  FileUtils.rm_rf('./.yardoc')
+  FileUtils.rm_rf('./pkg')
+  FileUtils.rm(Dir.glob('./*-*.gem'))
+end
+
+task :bundle do
+  system('bundle install')
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*/*_test.rb']
+  t.verbose = true
+end
+
+YARD::Rake::YardocTask.new
+
+task :package => [:clean, :bundle, :test, :yard] do
+  gem_specs = Dir.glob('**/*.gemspec')
+  gem_specs.each { |gem_spec|
+    system("gem build #{gem_spec}")
+    raise 'Error during build phase' if $?.exitstatus != 0
+  }
+end
+
+task :install => :package do
+  load "#{File.expand_path(File.dirname(__FILE__))}/lib/method_reflect/version.rb"
+  system("gem install #{File.expand_path(File.dirname(__FILE__))}/method_reflect-#{MethodReflect::VERSION}.gem")
+end
+
+task :upgrade => :package do
+  system('gem uninstall method_reflect -a')
+  load "#{File.expand_path(File.dirname(__FILE__))}/lib/method_reflect/version.rb"
+  system("gem install #{File.expand_path(File.dirname(__FILE__))}/method-reflect-#{MethodReflect::VERSION}.gem")
+end
+
+task :version_set, [:version] do |_, args|
+  raise "Must provide a version.\n If you called 'rake version_set 1.2.3', try 'rake version_set[1.2.3]'" if args[:version].nil? || args[:version].empty?
+
+  version_file = <<-END.gsub(/^ {4}/, '')
+    module MethodReflect
+      VERSION = "#{args[:version]}"
+    end
+  END
+  puts "Writing version file:\n #{version_file}"
+  File.open("#{File.expand_path(File.dirname(__FILE__))}/lib/method_reflect/version.rb", 'w+') { |file|
+    file.write(version_file)
+  }
+  file_text = File.read("#{File.expand_path(File.dirname(__FILE__))}/lib/method_reflect/version.rb")
+  raise 'Could not update version file' if file_text != version_file
+end
+
+task :release, [:version] => [:version_set, :package] do |_, args|
+  system('git clean -f')
+  system('git add .')
+  system("git commit -m\"Version to #{args[:version]}\"")
+  if $?.exitstatus == 0
+    system("git tag -a v#{args[:version]} -m\"Version #{args[:version]} Release\"")
+    if $?.exitstatus == 0
+      system('git push origin master --tags')
+      if $?.exitstatus == 0
+        load "#{File.expand_path(File.dirname(__FILE__))}/lib/method_reflect/version.rb"
+        system("gem push #{File.expand_path(File.dirname(__FILE__))}/method_reflect-#{MethodReflect::VERSION}.gem")
+      end
+    end
+  end
+end

data/lib/method_reflect.rb

@@ -0,0 +1,88 @@
+require 'method_source'
+require 'yard'
+
+module MethodReflect
+  module MethodExtensions
+
+    def commented_source
+      if @commented_source == nil
+        @commented_source = self.comment + self.source
+      end
+      @commented_source
+    end
+
+    def code_object
+      if @code_object == nil
+        YARD::Registry.clear
+        YARD::parse_string(commented_source)
+        @code_object = YARD::Registry.first
+      end
+      @code_object
+    end
+
+    def docstring
+      if @docstring == nil
+        @docstring = code_object.docstring
+      end
+      @docstring
+    end
+
+    def docstring_summary
+      if @docstring_summary == nil
+        @docstring_summary = code_object.docstring.summary
+      end
+      @docstring_summary
+    end
+
+    def docstring_tags
+      if @docstring_tags == nil
+        @docstring_tags = docstring.tags.map { |t|
+          {name: t.name, tag_name: t.tag_name, text: t.text, types: t.types}
+        }
+      end
+      @docstring_tags
+    end
+
+    def signature
+      if @signature == nil
+        @signature = code_object.signature
+      end
+      @signature
+    end
+
+    def parameter_defaults
+      if @parameter_defaults == nil
+        @parameter_defaults = code_object.parameters.map{|n,d| [n.to_sym, d]}
+      end
+      @parameter_defaults
+    end
+
+    def visibility
+      if @visibility == nil
+        @visibility = code_object.visibility
+      end
+      @visibility
+    end
+
+    def scope
+      if @scope == nil
+        @scope = code_object.scope
+      end
+      @scope
+    end
+
+  end
+
+end
+
+class Method
+  include MethodReflect::MethodExtensions
+end
+
+class UnboundMethod
+  include MethodReflect::MethodExtensions
+end
+
+class Proc
+  include MethodReflect::MethodExtensions
+end

data/lib/method_reflect/version.rb

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

data/method_reflect.gemspec

@@ -0,0 +1,23 @@
+require "#{File.dirname(__FILE__)}/lib/method_reflect/version.rb"
+
+Gem::Specification.new do |spec|
+  spec.name          = 'method_reflect'
+  spec.version       = MethodReflect::VERSION
+  spec.authors       = ['Danny Purcell']
+  spec.email         = %w(d.purcell.jr+method_reflect@gmail.com)
+  spec.description   = %q{Adds several instance methods to the core Method class so methods can tell you more about themselves.}
+  spec.summary       = %q{Gives Ruby Methods some deeper self-knowledge}
+  spec.homepage      = 'http://dannypurcell.github.io/method_reflect'
+  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 = %w(lib)
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'rake'
+  spec.add_dependency 'method_source', '~> 0.8.2'
+  spec.add_dependency 'yard', '~> 0.8.7.6'
+end

data/test/method_reflect_test.rb

@@ -0,0 +1,133 @@
+require "#{File.dirname(__FILE__)}/../lib/method_reflect.rb"
+
+require 'test/unit'
+
+class MethodReflectTest < Test::Unit::TestCase
+  class TestClass
+    # A test method
+    #
+    # @param a [String] a string param
+    # @param b [String] an array param
+    # @param c [String] a hash param
+    # @param d [String] the rest of the params
+    def test_method a, b=[], c={x: 1, y: 2}, *d, &e
+      @args = [a, b, c, d, e]
+      puts "#{@args}"
+    end
+  end
+
+  def test_commented_source_method
+    expected = <<-END.gsub(/^ {6}/, '')
+      # A test method
+      #
+      # @param a [String] a string param
+      # @param b [String] an array param
+      # @param c [String] a hash param
+      # @param d [String] the rest of the params
+      def test_method a, b=[], c={x: 1, y: 2}, *d, &e
+        @args = [a, b, c, d, e]
+        puts "\#{@args}"
+      end
+    END
+
+    result = TestClass.new.method(:test_method).commented_source
+
+    expected_lines = expected.split("\n").map{|l| l.strip}
+    result_lines = result.split("\n").map{|l| l.strip}
+    expected_lines.zip(result_lines).each{|e, r|
+      assert_equal(e, r)
+    }
+  end
+
+  def test_code_object_method
+
+  end
+
+  def test_docstring_method
+
+  end
+
+  def test_docstring_tags_method
+
+  end
+
+  def test_signature_method
+
+  end
+
+  def test_parameter_defaults_method
+
+  end
+
+  def test_visibility_method
+
+  end
+
+  def test_scope_method
+
+  end
+
+  def test_commented_source_unbound
+
+  end
+
+  def test_code_object_unbound
+
+  end
+
+  def test_docstring_unbound
+
+  end
+
+  def test_docstring_tags_unbound
+
+  end
+
+  def test_signature_unbound
+
+  end
+
+  def test_parameter_defaults_unbound
+
+  end
+
+  def test_visibility_unbound
+
+  end
+
+  def test_scope_unbound
+
+  end
+
+  def test_commented_source_proc
+
+  end
+
+  def test_code_object_proc
+
+  end
+
+  def test_docstring_proc
+
+  end
+
+  def test_docstring_tags_proc
+
+  end
+
+  def test_signature_proc
+
+  end
+
+  def test_parameter_defaults_proc
+
+  end
+
+  def test_visibility_proc
+
+  end
+
+  def test_scope_proc
+
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: method_reflect
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Danny Purcell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+description: Adds several instance methods to the core Method class so methods can
+  tell you more about themselves.
+email:
+- d.purcell.jr+method_reflect@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/method_reflect.rb
+- lib/method_reflect/version.rb
+- method_reflect.gemspec
+- test/method_reflect_test.rb
+homepage: http://dannypurcell.github.io/method_reflect
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Gives Ruby Methods some deeper self-knowledge
+test_files:
+- test/method_reflect_test.rb
+has_rdoc: