comment_scanner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6acae07fa33acf2ff66a424478b786ab17164e71
+  data.tar.gz: 15f63073ce565a3e9a983e9fde7625eb4839ef3c
+SHA512:
+  metadata.gz: de3063156882e26fa4b67eb9f5a681b951bdee43243b9b396318a904e0aaf4ef2418cbc7a0d76692238274748bd6928e75c84a3cf288e6c4c90ba4e6505f73ed
+  data.tar.gz: 4c8826f7c65398d5e68a53d4b39013e4c2481687fb7ed5c9d4274b9d88dd427bc7eee4044f749a31a363275f31d349b6ebe1f22763c930f259620b9f43cfa4b5

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specifies gem dependencies in comment_scanner.gemspec
+gemspec

data/README.md

@@ -0,0 +1,64 @@
+# CommentScanner
+
+Detect comment blocks in Ruby source.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+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:
+
+``` ruby
+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.
+
+``` ruby
+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:
+
+``` ruby
+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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/adamsanderson/comment_scanner.
+

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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "comment_scanner"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/comment_scanner.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'comment_scanner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "comment_scanner"
+  spec.version       = CommentScanner::VERSION
+  spec.authors       = ["Adam Sanderson"]
+  spec.email         = ["netghost@gmail.com"]
+
+  spec.summary       = "Detect comment blocks in Ruby source."
+  spec.description   = "Detects leading and trailing comment blocks in Ruby source.  This may be useful for annotating exception and profiling traces."
+  spec.homepage      = "https://github.com/adamsanderson/comment_scanner"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/comment_scanner.rb

@@ -0,0 +1,64 @@
+require "comment_scanner/version"
+
+# CommentScanner will scan for comment blocks in Ruby source.
+#
+class CommentScanner
+  attr_reader :source
+  attr_reader :skip_pattern
+  
+  COMMENT_REGEXP = /^\s*#/
+  
+  # Creates a new CommentScanner for +source+.
+  #
+  # Options:
+  # [:skip] Skip lines matching this pattern before searching for comments.
+  #  
+  def initialize(source, options={})
+    @source = source.is_a?(Array) ? source : source.each_line.to_a
+    @skip_pattern = options[:skip]
+  end
+  
+  # Detect comment blocks immediately before +index+.
+  # 
+  # Note that +index+ is 0 indexed, where as an editor or stack trace is
+  # typically starts at 1.
+  # 
+  # # Returns +nil+ if there is no match.
+  def before(index)
+    lines = source[0...index].reverse
+    matches = match_comments(lines)
+    
+    strip_lines(matches).reverse.join.chomp unless matches.empty?
+  end
+  
+  # Detect comment blocks immediately after +index+.  This is generally
+  # less useful, you're probably looking for CommentScanner#before.
+  # 
+  # Note that +index+ is 0 indexed, where as an editor or stack trace is
+  # typically starts at 1.
+  # 
+  # Returns +nil+ if there is no match.
+  def after(index)
+    lines = source[index+1..-1]
+    matches = match_comments(lines)
+    
+    strip_lines(matches).join.chomp unless matches.empty?
+  end
+  
+  private
+  
+  # First drops skipped lines, then detects a contiguous block of comments.
+  def match_comments(lines)
+    if skip_pattern
+      lines = lines.drop_while{|line| skip_pattern.match(line) }
+    end
+    
+    lines.take_while{|line| COMMENT_REGEXP.match(line) }
+  end
+  
+  # Strips leading whitespace from comments.
+  def strip_lines(lines)
+    lines.map(&:lstrip)
+  end
+  
+end

data/lib/comment_scanner/version.rb

@@ -0,0 +1,3 @@
+class CommentScanner
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: comment_scanner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Sanderson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+description: Detects leading and trailing comment blocks in Ruby source.  This may
+  be useful for annotating exception and profiling traces.
+email:
+- netghost@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- comment_scanner.gemspec
+- lib/comment_scanner.rb
+- lib/comment_scanner/version.rb
+homepage: https://github.com/adamsanderson/comment_scanner
+licenses: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Detect comment blocks in Ruby source.
+test_files: []