yard-link_stdlib 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7966efdc84cb97c6137cbb70585abb20633f388b
-  data.tar.gz: bcdc1e6b09e76868433f0a3165a69fa1972d940b
+  metadata.gz: 35b7b23700c4d77f2a017aa1881974617980d255
+  data.tar.gz: 475ee0d06dfc6d358398e59eb6a80bccc09b8e8c
 SHA512:
-  metadata.gz: 58df15ecd9f973b793b7578c3b8bc566de595f8cd1c6de7d80d11ef613e8f562fde34d2808361c8471e105d5ae05e4dd80c8a80e58608ce1463d4209d9ab1d94
-  data.tar.gz: 81249ca138789654b2027bd81ff9936499da5baaef927a17cafc833d91de661fc1b08164daf0cb8d3ecba2af0f7f4a34755d75f33304e31eccb4dc0531efb1fb
+  metadata.gz: 9b2b26d8c1f3facd41e9b171d48138672a2cd8db0b166faf099ebafb3fffb2cae93150b9947f2a8660e195285b3d10e7fb86f062fc4a221fcf18ff51a5086809
+  data.tar.gz: ea374fb3df62ffcac1e5af88277bd7f96af1b0d8c9df342e801a84f67862a0895671f2e53f309c13f112a4944e3f9883f5a1f784afd4052ef0206bf36ded7fe5

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/yard/cli/link_stdlib.rb

@@ -230,24 +230,58 @@ class LinkStdlib < Command
     USAGE = "yard stdlib search [OPTIONS] TERMS..."
     
     def run *args
+      # Default format is `:plain`
+      opts[ :format ] = :plain
+      
       OptionParser.new { |op|
         add_header op, <<~END
           Examples:
           
             1.  {Pathname} instance methods
                 
-                yard stdlib search '^Pathname#'
+                    $ yard stdlib search '^Pathname#'
           
-            2. All `#to_s` methods
+            2.  All `#to_s` methods
+                
+                    $ yard stdlib search '#to_s$'
+            
+            3.  Print results in serialized formats.
+                
+                All `#to_s` instance methods in JSON:
+                
+                    $ yard stdlib search --format=json '#to_s$'
+                
+                Supports a short `-f` flag and first-letter formats too.
                 
-                yard stdlib search '#to_s$'
+                Instance methods of {Array} in YAML:
+                
+                    $ yard stdlib search -f y '^Array#'
         END
         
         add_version_opt op
         
         op.on(  '-u', '--urls',
                 %(Print doc URLs along with names)
-        ) { |urls| opts[ :urls ] = urls }
+        ) { |urls| opts[ :urls ] = !!urls }
+        
+        op.on(  '-f FORMAT', '--format=FORMAT',
+                %(Specify print format: (p)lain, (j)son or (y)aml)
+        ) { |format|
+          opts[ :format ] = \
+            case format.downcase
+            when 'p', 'plain'
+              :plain
+            when 'j', 'json'
+              :json
+            when 'y', 'yaml'
+              :yaml
+            else
+              log.fatal \
+                %(Unknown format - expected "plain", "json" or "yaml"; ) +
+                %(given #{ format.inspect })
+              exit false
+            end
+        }
         
       }.parse! args
       
@@ -266,15 +300,31 @@ class LinkStdlib < Command
       
       names = YARD::LinkStdlib.grep *terms
       
-      names.each { |name|
-        line = \
-          if opts[ :urls ]
-            "#{ name } <#{ YARD::LinkStdlib::ObjectMap.current.url_for name }>"
+      results = \
+        if opts[ :urls ]
+          names.each_with_object( {} ) { |name, hash|
+            hash[ name ] = YARD::LinkStdlib::ObjectMap.current.url_for name
+          }
+        else
+          names
+        end
+      
+      case opts[ :format ]
+      when :plain
+        results.each do |entry|
+          if entry.is_a? ::Array
+            log.puts "#{ entry[0] } <#{ entry[ 1 ]}>"
           else
-            name
+            log.puts entry
           end
-        log.puts line
-      }
+        end
+      when :json
+        require 'json'
+        log.puts JSON.pretty_generate( results )
+      when :yaml
+        require 'yaml'
+        log.puts YAML.dump( results )
+      end
       
       exit true
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-link_stdlib
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-10 00:00:00.000000000 Z
+date: 2019-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard