method_source 0.9.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a028cf570a878212656d23cea883b8c951d1faba
-  data.tar.gz: 3470552886d0ea7f7ca782dc3d3dee9aed645776
+SHA256:
+  metadata.gz: e936459f65ba807442d464e51a8d70421850fab753f17df974ffc28e9d414983
+  data.tar.gz: 977611dfab90d749a6001794295428fe05becc43d878db7abdc6014ae589c17a
 SHA512:
-  metadata.gz: 587e875c403107b65ec2148565a1fef1c95e6a4426f691f03750382ba10c894f165818e30c52a69fe07ccdf0cec4290f966a382b107bed9e093efd8b7f13f288
-  data.tar.gz: 3ca93afc377f2f53da696f326251688c9cc45956027cdefca84df8ac37c90be26d31ba60405c8cd0d001e0841999286040a6941acecb679671fa850266a093a1
+  metadata.gz: 9021fc9ca214aebf3337563b544137c8a80fb30872222f8334f104a3b6a9ef5ce37f7aed8caabb1061f63066afc16fc6c9a87f384f2279dec7fc9b26d312595f
+  data.tar.gz: 965fc6d9f5df92dee0d8d300e5e7b4942395c9e17d120b727a82ee2082d00c7ca4edbed9689b332eed0007e0ac128322bda317464800c5b1f089961bacdeaa43

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# method_source changelog
+
+### master
+
+### [v1.1.0][v1.1.0] (April 15, 2024)
+
+- Added `MethodSource.clear_cache`
+- Added support for `RUBYOPT="--enable-frozen-string-literal"`
+
+### [v1.0.0][v1.0.0] (March 19, 2020)
+
+- Added Ruby 2.7 support
+
+[v1.0.0]: https://github.com/banister/method_source/releases/tag/v1.0.0
+[v1.1.0]: https://github.com/banister/method_source/releases/tag/v1.1.0

data/Gemfile

@@ -1,2 +1,6 @@
 source 'https://rubygems.org'
+
 gemspec
+
+gem "rake"
+gem "rspec"

data/LICENSE

@@ -1,7 +1,4 @@
-License
--------
-
-(The MIT License) 
+MIT License
 
 Copyright (c) 2011 John Mair (banisterfiend)
 

data/README.markdown

@@ -1,6 +1,8 @@
-method_source [![Build Status](https://travis-ci.org/banister/method_source.svg?branch=master)](https://travis-ci.org/banister/method_source)
+method_source
 =============
 
+[![Circle Build Status](https://circleci.com/gh/banister/method_source.svg?style=shield)](https://circleci.com/gh/banister/method_source)
+
 (C) John Mair (banisterfiend) 2011
 
 _retrieve the sourcecode for a method_
@@ -22,7 +24,7 @@ It is written in pure Ruby (no C).
 `UnboundMethod` and `Proc` classes.
 
 * Install the [gem](https://rubygems.org/gems/method_source): `gem install method_source`
-* Read the [documentation](http://rdoc.info/github/banister/method_source/master/file/README.markdown)
+* Read the [documentation](https://www.rubydoc.info/github/banister/method_source/master)
 * See the [source code](http://github.com/banister/method_source)
 
 Example: display method source
@@ -48,6 +50,14 @@ Example: display method comments
     # Merges the elements of the given enumerable object to the set and
     # returns self.
 
+Example: display module/class comments
+--------------------------------------
+
+    MethodSource::MethodExtensions.method(:included).module_comment
+    # =>
+    # This module is to be included by `Method` and `UnboundMethod` and
+    # provides the `#source` functionality
+
 Limitations:
 ------------
 

data/lib/method_source/code_helpers.rb

@@ -90,7 +90,7 @@ module MethodSource
     # @return [String]  a valid ruby expression
     # @raise [SyntaxError]
     def extract_first_expression(lines, consume=0, &block)
-      code = consume.zero? ? "" : lines.slice!(0..(consume - 1)).join
+      code = consume.zero? ? +"" : lines.slice!(0..(consume - 1)).join
 
       lines.each do |v|
         code << v
@@ -104,7 +104,7 @@ module MethodSource
     # @param [Array<String>]  lines
     # @return [String]
     def extract_last_comment(lines)
-      buffer = ""
+      buffer = +""
 
       lines.each do |line|
         # Add any line that is a valid ruby comment,
@@ -112,7 +112,7 @@ module MethodSource
         if (line =~ /^\s*#/) || (line =~ /^\s*$/)
           buffer << line.lstrip
         else
-          buffer.replace("")
+          buffer.clear
         end
       end
 
@@ -125,7 +125,7 @@ module MethodSource
       GENERIC_REGEXPS = [
         /unexpected (\$end|end-of-file|end-of-input|END_OF_FILE)/, # mri, jruby, ruby-2.0, ironruby
         /embedded document meets end of file/, # =begin
-        /unterminated (quoted string|string|regexp) meets end of file/, # "quoted string" is ironruby
+        /unterminated (quoted string|string|regexp|list) meets end of file/, # "quoted string" is ironruby
         /can't find string ".*" anywhere before EOF/, # rbx and jruby
         /missing 'end' for/, /expecting kWHEN/ # rbx
       ]

data/lib/method_source/version.rb

@@ -1,3 +1,3 @@
 module MethodSource
-  VERSION = '0.9.2'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/method_source.rb

@@ -55,6 +55,11 @@ module MethodSource
     raise SourceNotFoundError, "Could not load source for #{name}: #{e.message}"
   end
 
+  # Clear cache.
+  def self.clear_cache
+    @lines_for_file = {}
+  end
+
   # @deprecated — use MethodSource::CodeHelpers#complete_expression?
   def self.valid_expression?(str)
     complete_expression?(str)
@@ -121,6 +126,37 @@ module MethodSource
     def comment
       MethodSource.comment_helper(source_location, defined?(name) ? name : inspect)
     end
+
+    # Return the comments associated with the method class/module.
+    # @return [String] The method's comments as a string
+    # @raise SourceNotFoundException
+    #
+    # @example
+    #  MethodSource::MethodExtensions.method(:included).module_comment
+    #  =>
+    #     # This module is to be included by `Method` and `UnboundMethod` and
+    #     # provides the `#source` functionality
+    def class_comment
+      if self.respond_to?(:receiver)
+        class_inst_or_module =  self.receiver
+      elsif self.respond_to?(:owner)
+        class_inst_or_module = self.owner
+      else
+        return comment
+      end
+
+      if class_inst_or_module.respond_to?(:name)
+        const_name = class_inst_or_module.name
+      else
+        const_name = class_inst_or_module.class.name
+        class_inst_or_module = class_inst_or_module.class
+      end
+
+      location = class_inst_or_module.const_source_location(const_name)
+
+      MethodSource.comment_helper(location, defined?(name) ? name : inspect)
+    end
+    alias module_comment class_comment
   end
 end
 

data/method_source.gemspec

@@ -1,35 +1,19 @@
 # -*- encoding: utf-8 -*-
-# stub: method_source 0.9.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "method_source".freeze
-  s.version = "0.9.2"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["John Mair (banisterfiend)".freeze]
-  s.date = "2018-11-12"
+  s.date = "2024-04-15"
   s.description = "retrieve the sourcecode for a method".freeze
   s.email = "jrmair@gmail.com".freeze
-  s.files = [".gemtest".freeze, ".travis.yml".freeze, ".yardopts".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.markdown".freeze, "Rakefile".freeze, "lib/method_source.rb".freeze, "lib/method_source/code_helpers.rb".freeze, "lib/method_source/source_location.rb".freeze, "lib/method_source/version.rb".freeze, "method_source.gemspec".freeze, "spec/method_source/code_helpers_spec.rb".freeze, "spec/method_source_spec.rb".freeze, "spec/spec_helper.rb".freeze]
+  s.files = ["CHANGELOG.md".freeze, ".gemtest".freeze, ".yardopts".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.markdown".freeze, "Rakefile".freeze, "lib/method_source.rb".freeze, "lib/method_source/code_helpers.rb".freeze, "lib/method_source/source_location.rb".freeze, "lib/method_source/version.rb".freeze, "method_source.gemspec".freeze, "spec/method_source/code_helpers_spec.rb".freeze, "spec/method_source_spec.rb".freeze, "spec/spec_helper.rb".freeze]
   s.homepage = "http://banisterfiend.wordpress.com".freeze
+  s.metadata["changelog_uri"] = "https://github.com/banister/method_source/blob/master/CHANGELOG.md".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.7.6".freeze
   s.summary = "retrieve the sourcecode for a method".freeze
   s.test_files = ["spec/method_source/code_helpers_spec.rb".freeze, "spec/method_source_spec.rb".freeze, "spec/spec_helper.rb".freeze]
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>.freeze, ["~> 3.6"])
-      s.add_development_dependency(%q<rake>.freeze, ["~> 0.9"])
-    else
-      s.add_dependency(%q<rspec>.freeze, ["~> 3.6"])
-      s.add_dependency(%q<rake>.freeze, ["~> 0.9"])
-    end
-  else
-    s.add_dependency(%q<rspec>.freeze, ["~> 3.6"])
-    s.add_dependency(%q<rake>.freeze, ["~> 0.9"])
-  end
 end

data/spec/method_source_spec.rb

@@ -30,10 +30,12 @@ describe MethodSource do
     @hello_source = "def hello; :hello; end\n"
     @hello_comment = "# A comment for hello\n# It spans two lines and is indented by 2 spaces\n"
     @lambda_comment = "# This is a comment for MyLambda\n"
+    @module_comment = "# This is a comment for module\n"
+    @class_comment = "# This is a comment for class\n"
     @lambda_source = "MyLambda = lambda { :lambda }\n"
     @proc_source = "MyProc = Proc.new { :proc }\n"
     @hello_instance_evaled_source = "  def hello_\#{name}(*args)\n    send_mesg(:\#{name}, *args)\n  end\n"
-    @hello_instance_evaled_source_2 = "  def \#{name}_two()\n    if 44\n      45\n    end\n  end\n"
+    @hello_instance_evaled_source_2 = "  def \#{name}_two()\n    if 40 + 4\n      45\n    end\n  end\n"
     @hello_class_evaled_source = "  def hello_\#{name}(*args)\n    send_mesg(:\#{name}, *args)\n  end\n"
     @hi_module_evaled_source = "  def hi_\#{name}\n    @var = \#{name}\n  end\n"
   end
@@ -109,6 +111,18 @@ describe MethodSource do
     it 'should return comment for lambda' do
       expect(MyLambda.comment).to eq(@lambda_comment)
     end
+
+    it 'should return comment for module' do
+      expect(M.instance_method(:hello).module_comment).to eq(@module_comment)
+    end
+
+    it 'should return comment for class' do
+      expect(C.method(:hello).class_comment).to eq(@class_comment)
+    end
+
+    it 'should return comment for class instance' do
+      expect(C.new.method(:hello).class_comment).to eq(@class_comment)
+    end
   end
   # end
   describe "Comment tests" do

data/spec/spec_helper.rb

@@ -10,10 +10,16 @@ def jruby?
 end
 
 
+# This is a comment for module
 module M
   def hello; :hello_module; end
 end
 
+# This is a comment for class
+class C
+  include M
+end
+
 $o = Object.new
 def $o.hello; :hello_singleton; end
 
@@ -82,14 +88,14 @@ METHOD
 M.instance_eval <<EOF, __FILE__, __LINE__ + 1
 
   def #{name}_one()
-    if 43
+    if 40 + 3
       44
     end
   end
 
 
   def #{name}_two()
-    if 44
+    if 40 + 4
       45
     end
   end

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: method_source
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 1.1.0
 platform: ruby
 authors:
 - John Mair (banisterfiend)
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
+date: 2024-04-15 00:00:00.000000000 Z
+dependencies: []
 description: retrieve the sourcecode for a method
 email: jrmair@gmail.com
 executables: []
@@ -45,8 +17,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gemtest"
-- ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.markdown
@@ -62,8 +34,9 @@ files:
 homepage: http://banisterfiend.wordpress.com
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/banister/method_source/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,9 +51,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: retrieve the sourcecode for a method
 test_files:

data/.travis.yml

@@ -1,31 +0,0 @@
-# To use rbx environment.
-dist: trusty
-bundler_args: "--verbose"
-before_install:
-  - gem update --system
-  - which bundle || gem install bundler
-  - gem update bundler
-rvm:
-  - 1.8.7
-  - 1.9.3
-  - ree
-  - rbx-3
-  - jruby
-  - jruby-head
-  - 2.0.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4.2
-  - ruby-head
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby
-    - rvm: jruby-head
-    - rvm: rbx-3
-  fast_finish: true
-notifications:
-  irc: "irc.freenode.org#pry"
-  recipients:
-    - jrmair@gmail.com