getcomments 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81f3c63a29fc5da2d5720ed6ffd18a3f7b0839c0e225ddb54c0f8fb0cbdc1461
-  data.tar.gz: d2f56c1df54c246104cd1feeeb23bd58d48c3aeb35ea4c3c86dba2d18f10ba44
+  metadata.gz: 1c302859eeba8bb1f91ee222ced925aa24a5e9fef97f2485db3c5f7a14defe4c
+  data.tar.gz: bf5f7894e2bb22879ad1e7c4fa045b7b21369be02ea18a99e992c46bb5b3ae9c
 SHA512:
-  metadata.gz: 6b38b6258c8c5ea428253c33fa9ecad90649b522f8e33cf2cb4ad0b31a525c1aaaa90737475c857b1c77c2bc4599a0ac07a078971711da81f0a48484301e74b6
-  data.tar.gz: 38eaf21fb04cd582938abfcd932e2b376ad66fee466222e6c45bcbdc575d48808b8403f67feef72ed67c7e273ac3f8b0e0d0c942b8ed7ade80a0b157e5fa34fa
+  metadata.gz: 9cc69c370c1b6843ac2b6bd127135682689609b11a43b7fb66e5d1c1209aaf3205983404faee234e9d132e551c1f0e92761e1a5f665af98e0a14a8de2225b4e2
+  data.tar.gz: 1a1f50ad2b81fb98422ab239457c61b877be8ad780389667d2d945055dfee8978569bc5508b3fc55e74f62d7724767ad4258b97851a7703f5ff9d0f86325c054

data/README.md

@@ -4,7 +4,6 @@ GetComments - Extract Comments from Ruby Code
 [![Gem Version](https://badge.fury.io/rb/getcomments.svg)](https://badge.fury.io/rb/getcomments)
 [![Build Status](https://travis-ci.com/DannyBen/getcomments.svg?branch=master)](https://travis-ci.com/DannyBen/getcomments)
 [![Maintainability](https://api.codeclimate.com/v1/badges/bcf41ae9f2c8ebd59f4d/maintainability)](https://codeclimate.com/github/DannyBen/getcomments/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/bcf41ae9f2c8ebd59f4d/test_coverage)](https://codeclimate.com/github/DannyBen/getcomments/test_coverage)
 
 ---
 
@@ -22,7 +21,7 @@ $ gem install getcomments
 
 Or with bundler:
 
-```ruby
+```
 gem 'getcomments'
 ```
 
@@ -30,15 +29,36 @@ gem 'getcomments'
 Usage
 --------------------------------------------------
 
+Get comments from a file:
+
 ```ruby
+# GetComments.from_file
 require 'getcomments'
-comments = GetComments::Read.from 'filename.rb'
-p comments
+comments = GetComments.from_file 'spec/fixtures/minimal.rb'
+comments.each do |key, value|
+  puts "#{key}: #{value}"
+end
+
+#=> module TestModule: Module comment
+#=> class TestClass: Class comment
+#=> attr_reader :some_attr: Attribute comment
+#=> def some_method: Method comment
+```
+
+Get coimments from a string:
+
+```ruby
+# GetComments.from_string
+code = <<-EOF
+  # This function just sits here
+  def the_function
+  end
+EOF
 
-# => {
-#      "module TestModule" => "This is the module comment",
-#      "class TestClass"   => "This is the class comment",
-#      "def some_method"   => "This is a multiline\nmethod comment"
-#    }
+comments = GetComments.from_string code
+comments.each do |key, value|
+  puts "#{key}: #{value}"
+end
 
+#=> def the_function: This function just sits here
 ```

data/lib/getcomments.rb

@@ -1,2 +1,12 @@
 require 'getcomments/version'
-require 'getcomments/read'
+require 'getcomments/code'
+
+module GetComments
+  def self.from_file(filename)
+    from_string(File.read filename)
+  end
+
+  def self.from_string(code)
+    Code.new(code).comments
+  end
+end

data/lib/getcomments/{read.rb → code.rb}

@@ -1,18 +1,19 @@
 module GetComments
-  class Read
-    attr_reader :filename
-    attr_accessor :comment_index
+  class Code
+    attr_reader :code, :comment_index
 
-    def self.from(filename)
-      new(filename).get
+    def initialize(code)
+      @code = code
+      @comment_index = 0
     end
 
-    def initialize(filename)
-      @filename = filename
-      @comment_index = 0
+    def comments
+      @comments ||= comments!
     end
 
-    def get
+  private
+
+    def comments!
       last_comment = []
       result = {}
 
@@ -34,19 +35,18 @@ module GetComments
       result
     end
 
-    private
-
     def lines
-      @lines ||= File.readlines filename
+      @lines ||= code.lines
     end
 
     def get_key(line='')
       if match = line.match(/^([\w_]+ [\w\:]+)/)
         match.captures.first
       else
-        self.comment_index += 1
+        @comment_index += 1
         "comment_#{comment_index}"
       end
     end
   end
-end
+
+end

data/lib/getcomments/version.rb

@@ -1,3 +1,3 @@
 module GetComments
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: getcomments
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-11 00:00:00.000000000 Z
+date: 2019-12-12 00:00:00.000000000 Z
 dependencies: []
 description: Extract comments from a Ruby source file
 email: db@dannyben.com
@@ -18,7 +18,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/getcomments.rb
-- lib/getcomments/read.rb
+- lib/getcomments/code.rb
 - lib/getcomments/version.rb
 homepage: https://github.com/DannyBen/getcomments
 licenses:
@@ -39,8 +39,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Extract comments from a Ruby source file