getcomments 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01cd40028f263855c57e550e4c2578ecc7859ce1
+  data.tar.gz: e4eb10535f97759162a02144138bc24a0b196c17
+SHA512:
+  metadata.gz: 20cb117d9bf0af5f9af33bf59ccf01651c33eccb75aaba462f5bd8a2b0adf7d73f5a9f8e1f1c979e50cdc8aa08ba8f06dc8e899bc2eedb3f9b13767481e14816
+  data.tar.gz: 0a705f0c77c0406cb5be02f4fe6c75edd81fde797ccaaad27c63dd7c736db6e85539f12bbe179309ed6ef1e76511c698a8597f1f4d6c17922b8f7219d84cefb5

data/README.md

@@ -0,0 +1,44 @@
+GetComments - Extract Comments from Ruby Code
+==================================================
+
+[![Gem](https://img.shields.io/gem/v/getcomments.svg?style=flat-square)](https://rubygems.org/gems/getcomments)
+[![Travis](https://img.shields.io/travis/DannyBen/getcomments.svg?style=flat-square)](https://travis-ci.org/DannyBen/getcomments)
+[![Code Climate](https://img.shields.io/codeclimate/github/DannyBen/getcomments.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/getcomments)
+[![Gemnasium](https://img.shields.io/gemnasium/DannyBen/getcomments.svg?style=flat-square)](https://gemnasium.com/DannyBen/getcomments)
+
+---
+
+This library provides an easy way to extract comments from a ruby source file.
+
+---
+
+
+Install
+--------------------------------------------------
+
+```
+$ gem install getcomments
+```
+
+Or with bundler:
+
+```ruby
+gem 'getcomments'
+```
+
+
+Usage
+--------------------------------------------------
+
+```ruby
+require 'getcomments'
+comments = GetComments::Read.from 'filename.rb'
+p comments
+
+# => {
+       "module TestModule" => "This is the module comment",
+       "class TestClass"   => "This is the class comment",
+       "def some_method"   => "This is a multiline\nmethod comment"
+     }
+
+```

data/lib/getcomments.rb

@@ -0,0 +1,2 @@
+require 'getcomments/version'
+require 'getcomments/read'

data/lib/getcomments/read.rb

@@ -0,0 +1,48 @@
+module GetComments
+  class Read
+    attr_reader :filename
+
+    def self.from(filename)
+      new(filename).get
+    end
+
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def get
+      last_comment = []
+      result = {}
+
+      lines.each do |line|
+        line.strip!
+
+        if line[0] == '#'
+          last_comment << line.gsub(/^# ?/, '')
+        elsif !last_comment.empty?
+          key = get_key line
+          result[key] = last_comment.join("\n") if key
+          last_comment = []
+        end
+      end
+
+      result
+    end
+
+    private
+
+    def lines
+      @lines ||= File.readlines filename
+    end
+
+    def get_key(line)
+      key = nil
+
+      if match = line.match(/^([\w_]+ [\w\:]+)/)
+        key = match.captures.first
+      end
+
+      key
+    end
+  end
+end

data/lib/getcomments/version.rb

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

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: getcomments
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: runfile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: runfile-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Extract comments from a Ruby source file
+email: db@dannyben.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/getcomments.rb
+- lib/getcomments/read.rb
+- lib/getcomments/version.rb
+homepage: https://github.com/DannyBen/getcomments
+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.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Extract comments from a Ruby source file
+test_files: []