inch 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d83d6f4f550c102c6a68ab8eb6940ac9985caacc
-  data.tar.gz: 78cabc5fcaf7e7fc1deb86ed614a41933dbf5903
+  metadata.gz: 8b2d25865d4af4a7a7d2d8ae09344ac7b828148e
+  data.tar.gz: dc387ecfacf69092c3344fc5c1b4bfe7229087b0
 SHA512:
-  metadata.gz: 7ad47baff71a66d2c059eb2034f71bb4a0fd4d31caa6b5961ec41203cb4c2bf565f16596477d5bb3be47f2f627ae80c3a6520890dcb3b00f251b8c36e3548f3d
-  data.tar.gz: 57eded7a64cc79f1d81e3cd24a1583f984268ed5fa35d4883a5dbf19eae4e140dfdb5170689a9a1b7de5a48e70d0aa8b66e6e9f1ad555be8751ab454879c70a1
+  metadata.gz: 248469d48cdaf7dd7ffc82614a3e043ecde92ce800f5d64c271f8f268d0f5b20a7e7ee3f34a05a2a611cae3e5be128af02adc013490546343abe7dd5a4412c74
+  data.tar.gz: af2f65be144c7edc0367f8bde04e1bc97cacbe0afcf0947c1fbe62cb8bb14b2236b412e884b3442df133729884168a4be0a7881a65f03376db97d5791d86a6e7

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
 
+## 0.4.2
+
+- The 'inspect' command now shows the original docstring provided by the
+  YARD object provider instead of parsing the string itself
+
+
 ## 0.4.1
 
 - Bugfix regarding @overload tags (thanks @cbeer)

data/lib/inch/cli/command/output/inspect.rb

@@ -7,6 +7,7 @@ module Inch
 
           COLOR = :color198     # magenta-ish
           BG_COLOR = :color207  # magenta-ish
+          COMMENT_COLOR = :dark
           LJUST = 20
 
           def initialize(options, objects)
@@ -47,7 +48,7 @@ module Inch
           def print_code_info(o)
             if o.method?
               CommentAndAbbrevSource.new(o).lines.each do |line|
-                echo line.gsub(/\n$/m, '').dark
+                echo line.gsub(/\n$/m, '').color(COMMENT_COLOR)
               end
               echo separator
             end
@@ -149,35 +150,10 @@ module Inch
             end
 
             def comments
-              @comments ||= code_object.files.map do |declaration|
-                get_lines_up_while(declaration.filename, declaration.line_no - 1) do |line|
-                  line =~ /^\s*#/
-                end.flatten.join('')
+              code_object.original_docstring.lines.map do |line|
+                "# #{line}"
               end
             end
-
-            def get_lines_up_while(filename, line_no, &block)
-              lines = []
-              line = get_line_no(filename, line_no)
-              if yield(line) && line_no > 0
-                lines << line.gsub(/^(\s+)/, '')
-                lines << get_lines_up_while(filename, line_no - 1, &block)
-              end
-              lines.reverse
-            end
-
-            # Returns a +line_number+ from a file
-            #
-            # @param filename [String]
-            # @param line_number [Fixnum]
-            # @return [String]
-            def get_line_no(filename, line_number)
-              f = File.open(filename)
-              line_number.times{f.gets}
-              result = $_
-              f.close
-              result
-            end
           end
         end
       end

data/lib/inch/code_object/converter.rb

@@ -33,6 +33,7 @@ module Inch
         method?
         nodoc?
         namespace?
+        original_docstring
         overridden?
         overridden_method_fullname
         parameters

data/lib/inch/code_object/provider/yard/object/base.rb

@@ -175,6 +175,11 @@ module Inch
               false
             end
 
+            # @return [String] the documentation comments
+            def original_docstring
+              object.docstring.all.to_s
+            end
+
             def parameters
               []
             end
@@ -231,11 +236,6 @@ module Inch
               text.scan(/\b(#{Regexp.escape(name)})[^_0-9\!\?]/m).size > 1
             end
 
-            # @return [String] the documentation comments
-            def original_docstring
-              object.docstring.all.to_s
-            end
-
             # @return [Boolean]
             #   +true+ if the object or its parent is tagged as @private
             def private_tag?

data/lib/inch/code_object/proxy/base.rb

@@ -161,6 +161,10 @@ module Inch
           self[:namespace?]
         end
 
+        def original_docstring
+          self[:original_docstring]
+        end
+
         # @return [Boolean] +true+ if the object was tagged not to be documented
         def nodoc?
           self[:nodoc?]

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-06 00:00:00.000000000 Z
+date: 2014-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler