0.0
No commit activity in last 3 years
No release in over 3 years
Detects leading and trailing comment blocks in Ruby source. This may be useful for annotating exception and profiling traces.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 1.10
~> 10.0
 Project Readme

CommentScanner

Detect comment blocks in Ruby source.

Installation

Add this line to your application's Gemfile:

gem 'comment_scanner'

And then execute:

$ bundle

Or install it yourself as:

$ gem install comment_scanner

Usage

Given a source file that looks like this:

class Sample
  def test
    # Alpha
    # Beta
    assert true
    assert false
  end
end

Read the file in: src = IO.read("sample.rb"), and then use CommentScanner to find comment blocks.

scanner = CommentScanner.new(src)
scanner.before(4) #=> "# Alpha\n# Beta"
scanner.before(1) #=> nil
scanner.after(1)  #=> "# Alpha\n# Beta"

Instantiate CommentScanner with a :skip parameter to ignore blocks of code before it starts matching. For instance, ignore leading assertions in the example:

scanner = CommentScanner.new(src, skip: /^\s+assert/)
scanner.before(4) #=> "# Alpha\n# Beta"
scanner.before(5) #=> "# Alpha\n# Beta"
scanner.before(6) #=> nil

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/adamsanderson/comment_scanner.