comment_collector 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd7163400e0f5dad62167c657187a19b3b7d86d19aad2f3c2d878190e22a0853
+  data.tar.gz: 8ec29610159563a21f8d5c70d28e1b76894912c636a6a3c893f86b936781c133
+SHA512:
+  metadata.gz: cbf8a96d9f0c327db8f7eb8423319eda02f7c92ddf0d08571ce611dc15986642d247115b2ddb2f2e329417b298a609afd37b4d8f1ed6af4721452758288b4512
+  data.tar.gz: 76faf9432d6f64ea29a309a4238a9de4ce5de213dbf9013e3f38ec9a87154f7cf6155ffda91ec67553d3d342a046bc9f07661b10d8d26bfb2b88203dbd0db169

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - ruby-2.6.0-preview2
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tmshuichi@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in comment_collector.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    comment_collector (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  comment_collector!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Shuichi Tamayose
+
+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,79 @@
+# CommentCollector
+
+Get source code comments of Ruby.
+
+require RUBY_VERSION >= '2.6.0'
+
+
+## Installation
+
+Or install it yourself as:
+
+```
+$ gem install comment_collector
+```
+
+## Usage
+
+`example.rb`
+
+```ruby
+# class comment
+# this is sample
+class Foo
+  BAR = 'hello' # string
+
+  # method
+  def say
+    'hi'
+  end
+end
+
+=begin
+multi line
+commens
+=end
+```
+
+`comment.rb`
+
+```ruby
+require 'comment_collector'
+
+comments = CommentCollector.get(File.read('example.rb'))
+
+puts '=' * 20
+
+comments.each do |comment|
+  puts comment.value
+  puts '=' * 20
+end
+```
+
+result
+
+```
+$ ruby comment.rb
+====================
+# class comment
+# this is sample
+====================
+# string
+====================
+# method
+====================
+=begin
+multi line
+commens
+=end
+====================
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CommentCollector project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/comment_collector/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "comment_collector"
+
+# 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(__FILE__)

data/bin/setup

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

data/comment_collector.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'comment_collector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'comment_collector'
+  spec.version       = CommentCollector::VERSION
+  spec.authors       = ['Shuichi Tamayose']
+  spec.email         = ['tmshuichi@gmail.com']
+
+  spec.summary       = %q{Commenct collector}
+  spec.description   = %q{Commenct collector}
+  spec.homepage      = 'https://github.com/siman-man/comment_collector'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '> 2.5.9'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/comment_collector.rb

@@ -0,0 +1,92 @@
+require 'comment_collector/version'
+
+class CommentCollector
+  Comment = Struct.new(:value, :first_lineno, :first_column, :last_lineno, :last_column)
+
+  def self.get(src)
+    new(src).comments
+  end
+
+  def initialize(src)
+    @last_of_lines = Array.new(src.lines.size, 0)
+    @exists_any_node = Array.new(src.lines.size, false)
+    @end_of_lines = src.lines.map { |l| l.size - 1 } # for 0-index
+    @src = src
+
+    traverse(RubyVM::AST.parse(src))
+  end
+
+  def comments
+    return @_comments if defined?(@_comments)
+    comments = []
+    value = ''
+    multi_line_comment_f = false
+    first_lineno = -1
+    first_column = -1
+    last_lineno = -1
+
+    @src.lines.each_with_index do |line, lineno|
+      sp = @last_of_lines[lineno]
+      l = line[sp..]
+
+      break if line.start_with?('__END__')
+
+      if l =~ /^\s*#/
+        if value.empty?
+          first_lineno = lineno
+          first_column = sp + l.index('#')
+          value = l.lstrip
+        elsif sp.zero?
+          value += l
+        else
+          comments << Comment.new(value, first_lineno, first_column, last_lineno, @end_of_lines[last_lineno])
+          first_lineno = lineno
+          first_column = sp + l.index('#')
+          value = l.lstrip
+        end
+
+        last_lineno = lineno
+      elsif l =~ /^=begin/
+        value = l
+        first_lineno = lineno
+        first_column = 0
+        multi_line_comment_f = true
+      elsif l =~ /^=end/
+        value += l
+        comments << Comment.new(value, first_lineno, first_column, lineno, @end_of_lines[lineno])
+        value = ''
+        multi_line_comment_f = false
+      elsif multi_line_comment_f
+        value += l
+      elsif !value.empty? && (line =~ /^\s+$/ || @exists_any_node[lineno])
+        comments << Comment.new(value, first_lineno, first_column, last_lineno, @end_of_lines[last_lineno])
+        value = ''
+      end
+    end
+
+    unless value.empty?
+      comments << Comment.new(value, first_lineno, first_column, last_lineno, @end_of_lines[last_lineno])
+    end
+
+    @_comments = comments
+  end
+
+  private
+
+  def traverse(parent)
+    if parent.type != 'NODE_SCOPE'
+      first_lineno = parent.first_lineno - 1
+      first_column = parent.first_column
+      last_lineno = parent.last_lineno - 1
+      last_column = parent.last_column
+
+      @last_of_lines[first_lineno] = [@last_of_lines[first_lineno], first_column].max
+      @last_of_lines[last_lineno] = [@last_of_lines[last_lineno], last_column].max
+      @exists_any_node[first_lineno] = @exists_any_node[last_lineno] = true
+    end
+
+    parent.children.compact.each do |child|
+      traverse(child)
+    end
+  end
+end

data/lib/comment_collector/version.rb

@@ -0,0 +1,3 @@
+class CommentCollector
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: comment_collector
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shuichi Tamayose
+autorequire: 
+bindir: exe
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEPDCCAqSgAwIBAgIBATANBgkqhkiG9w0BAQsFADAkMSIwIAYDVQQDDBl0bXNo
+  dWljaGkvREM9Z21haWwvREM9Y29tMB4XDTE4MDYwNTEwNDMxNloXDTE5MDYwNTEw
+  NDMxNlowJDEiMCAGA1UEAwwZdG1zaHVpY2hpL0RDPWdtYWlsL0RDPWNvbTCCAaIw
+  DQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBAO1YxdwwyCxpUsYMJrCHkAEJKPro
+  xsUMzsYu70ZGuJRROQvIVXt5VRm11/K5MqUxOfJ29zcb+NGmR1bu7VgTnfV2LUQ+
+  3n23us1uKDokf8xiJvN9Z03Q0Ng6xqF9y7meytoVWA6Wi7H7xRpVxXq8KXq5UwME
+  TMUcjcglCB0zmXJG4mu5Y+25on93sRlaPt7bK28sOspXU4hLJbBF/gNrBQoDGjPB
+  seoXkNKxoYa8mbjNtdvrDN1Cru06EeyJdcDWTchVgdcpt2G4Cd9He/M7sMgGmAHt
+  z5TU7VBSki7q1g30jIZHGd1htI1bWEVar9b7TxCvlkhYdHOp2yxOxr8hMBKUjz5A
+  cZeiJpUfdm2uTwFQuO9ffcGgLGIgyu9AV/89pYITA7RPDFtWW4G8orLXigirFC/0
+  CcZGC2Wg9FWit6PmwhGsv1eB/0IoCyWNlC1Y5NPnwjZHvI8LiYKu5xV0/Qi62RaL
+  hpbDP2/yYazo8B6IHldAh3YYuUoDfRoahOTyvQIDAQABo3kwdzAJBgNVHRMEAjAA
+  MAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUs04KxvYpTBGbFeIOrP57iuj9BI8wHgYD
+  VR0RBBcwFYETdG1zaHVpY2hpQGdtYWlsLmNvbTAeBgNVHRIEFzAVgRN0bXNodWlj
+  aGlAZ21haWwuY29tMA0GCSqGSIb3DQEBCwUAA4IBgQDK+gwlFgeOxtX3ju9xYt0u
+  EDwzZkyAutsRSyUC3D/Xkvj2r+ON8GMupRcb6m+1yhsEPf2lHKEuvDF/1Qz/4upj
+  FtmrnXOWDU8d9BWIoQusX9ifVX232r4Jxg4W6tfp1NckQj2M/AEXtTv2pdX8kerI
+  vFCoZpQlUKkcebHO1UlQP2S1W1uk+Ss/0ds6VHX/JENi8TlqNhvX6CyXkZhtBubE
+  EIHgBk3NBymdmaMNmlFR25Pq83VCHQ5D41n2it3QNacnKYqrkGbNrl2Q/j5atgfu
+  zslpHv2c8jZnJW+sf/RrxMm7/NECNeaK9/+tg31QIowLKO8v9DzbiAAHXZkIFn75
+  p6iTQKLI/q7Gnl5DWnL7ZUjva9Dqio6oaV3gyb0wod0fF+nUUtuGvVgLg9Ma5KE8
+  qhBmALr0zPrR292f2IxpPPpA3EGv375Yy0dblIxJ2U0C0p2JafJlIbdzTttaG+nR
+  hYkTSRBLdxDTa7SbFGW40+TWobTOX/itwk9w0F6Zo7Y=
+  -----END CERTIFICATE-----
+date: 2018-06-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.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Commenct collector
+email:
+- tmshuichi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- comment_collector.gemspec
+- lib/comment_collector.rb
+- lib/comment_collector/version.rb
+homepage: https://github.com/siman-man/comment_collector
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 2.5.9
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Commenct collector
+test_files: []