code_web 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29bda801a6f5634ec882c6633c08647ce1833308
-  data.tar.gz: d6b58d6ee533c2dd7ff66a4c86f39d1ad5d77cf0
+  metadata.gz: 9b78e826e03736b6ad03ecca86454dd8a21e77d3
+  data.tar.gz: 17716b11fbfca39fa06742ed670c806e3e37fba4
 SHA512:
-  metadata.gz: 2219f31b3e506ed95f633bc9bbb68b1984533ea6e7e391095da3634fc203b8e2d1a5755035c8df2dd02289e7d060a19db7b66d84db72328012cdec0b57f057d4
-  data.tar.gz: ae10f2d3cce4ead971d55654b2ab3d61a142f7cb024d85ec0789708c4321bbb05ec7eb3301002cfa5646f37ee5f0a362e513cc67cda5fe023e667e0db84d93b2
+  metadata.gz: d198666367ffbafea550fecc6cd5eac0190bb6b2511293aefd9f3353aebabbb3053f8c35db2a4e049351e9f5a2a0a530a76aea4a797d2aca75334aaf69c56bf2
+  data.tar.gz: 88ab6844ea0c04842467c103c187d0b9ac45df5590c01969c8887a3e854ffd28880c9c63748479bd729524343ab3c40844b812800d0c786ce44a448d472d8a0a

data/CHANGELOG.md

@@ -1,5 +1,3 @@
-# Change Log
-
 # Change Log
 All notable changes to this project will be documented in this file.
 
@@ -8,6 +6,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.0.6] - 2017-06-13
+- filenames in output, but only show first one
+- added flag `--url` to link to github instead of local filesystem
+- removed empty spans in output when blank or all of text fits in screen
+- removed first blank line in report output
+
 ## [0.0.5] - 2017-05-16
 - added a changelog (sorry olivier)
 - fixed gem metadata
@@ -19,5 +23,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - added flags for byebug and pry to allow debugging of issues (sorry not more stable)
 
 
-[Unreleased]: https://github.com/kbrock/code_web/compare/v0.0.5...HEAD
+[Unreleased]: https://github.com/kbrock/code_web/compare/v0.0.6...HEAD
+[0.0.6]: https://github.com/kbrock/code_web/compare/v0.0.5...v0.0.6
 [0.0.5]: https://github.com/kbrock/code_web/compare/v0.0.4...v0.0.5

data/lib/code_web/cli.rb

@@ -16,6 +16,10 @@ module CodeWeb
     def verbose=(val) ; code_parser.verbose = val ; end
     def debug=(val) ; code_parser.debug = val ; end
     def debug? ; code_parser.debug? ; end
+    # @attribute base_url [rw]
+    #   @return url for files (i.e.: https://github.com/ManageIQ/manageiq/blob/master)
+    #   defaults to local filesystem
+    attr_accessor :base_url
 
     # @attribute report_generator [rw]
     #   @return class that runs the report (i.e.: TextReport, HtmlReport) 
@@ -57,6 +61,7 @@ module CodeWeb
         opt.banner = "Usage: code_web regex [file_name ...]"
 #       opt.on('-n', '--requests=count',   Integer, "Number of requests (default: #{requests})")  { |v| options[:requests] = v }
         opt.on('-t', '--text',                      'Use text reports')                           { |v| self.report_generator = ::CodeWeb::TextReport }
+        opt.on('u',  '--url URL',                   'Base url (e.g.: https://github.com/miq/miq/blob/master)') { |v| self.base_url = v }
         opt.on('-a', '--arg ARG_REGEX',             'Only files with hash argument')              { |v| self.arg_regex = Regexp.new(v) }
         opt.on('-o', '--output FILENAME',           'Output filename')                            { |v| self.output = (v == '-') ? STDOUT : File.new(v,'w') }
         opt.on('-e', '--error-out',                 'exit on unknown tags')                       { |v| self.exit_on_error = true}
@@ -95,7 +100,7 @@ module CodeWeb
 
     def display_results
       STDOUT.puts "parsed #{files_parsed} files"
-      report_generator.new(method_calls, class_map, arg_regex, output).report
+      report_generator.new(method_calls, class_map, arg_regex, base_url, output).report
     end
   end
 end

data/lib/code_web/html_report.rb

@@ -8,6 +8,7 @@ module CodeWeb
     #   @return [Array<MethodCall>]
     attr_accessor :method_calls
     attr_accessor :arg_regex
+    attr_accessor :base_url
     def arg_regex? ; ! arg_regex.nil? ; end
 
     # @!attribute :class_map [rw]
@@ -17,15 +18,15 @@ module CodeWeb
     #   @return [Map<Regexp,color>] regex expressing name of main file
     attr_accessor :class_map
 
-    def initialize(method_calls, class_map={}, arg_regex=nil, out=STDOUT)
+    def initialize(method_calls, class_map={}, arg_regex=nil, base_url=nil, out=STDOUT)
       @method_calls = method_calls
       @class_map = class_map
       @arg_regex = arg_regex
+      @base_url = base_url
       @out = out
     end
 
-    TEMPLATE=%{
-<html>
+    TEMPLATE=%{<html>
 <head><style>
 table {border-collapse:collapse;}
 table, td, th { border:1px solid black;  }
@@ -55,14 +56,18 @@ table, td, th { border:1px solid black;  }
         <%- methods_with_type.group_by(:signature, arg_regex).each do |methods_by_signature| -%>
           <tr>
           <%- methods_with_type.arg_keys.each do |arg| -%>
-            <td><%= simplified_argument(methods_by_signature.hash_arg[arg]) %></td>
+            <td><%= simplified_argument(methods_by_signature.hash_arg[arg]) if methods_by_signature.hash_arg.key?(arg) %></td>
           <%- end -%>
             <%- if display_yield_column -%>
             <td><%= methods_by_signature.f.yields? %></td>
             <%- end -%>
-            <td><%- methods_by_signature.each_with_index do |method, i| -%>
-                <%= method_link(method, i+1) %>
-            <%- end -%></td>
+            <td>
+            <%- methods_by_signature.group_by(:filename).each do |methods_by_filename| -%>
+            <%- methods_by_filename.each_with_index do |method, i| -%>
+              <%= method_link(method, i == 0 ? nil : i+1) %>
+            <%- end -%>
+            <%- end -%>
+            </td>
           </tr>
         <%- end -%>
         </tbody>
@@ -81,9 +86,13 @@ table, td, th { border:1px solid black;  }
           <%- if display_yield_column -%>
             <td><%= methods_by_signature.f.yields? ? 'yields' : 'no yield'%></td>
           <%- end -%>
-            <td><%- methods_by_signature.each_with_index do |method, i| -%>
-                <%= method_link(method, i+1) %>
-            <%- end -%></td>
+            <td>
+            <%- methods_by_signature.group_by(:filename).each do |methods_by_filename| -%>
+            <%- methods_by_filename.each_with_index do |method, i| -%>
+              <%= method_link(method, i == 0 ? nil : i+1) %>
+            <%- end -%>
+            <%- end -%>
+            </td>
           </tr>
         <%- end -%>
       <%- end -%>
@@ -119,13 +128,17 @@ table, td, th { border:1px solid black;  }
     def simplified_argument(arg)
       short_arg = case arg
       when nil
-        nil
+        "nil"
       when String
         arg.split("::").last[0..12]
       else
         arg.to_s[0..12]
       end
-      %{<span title="#{html_safe(arg)}">#{short_arg}</span>}
+      if short_arg == arg || short_arg == "nil"
+        short_arg
+      else
+        %{<span title="#{html_safe(arg)}">#{short_arg}</span>}
+      end
     end
 
     def html_safe(str)
@@ -142,7 +155,7 @@ table, td, th { border:1px solid black;  }
     # add a class if the method is in a particular file
 
     def method_link(m, count=nil)
-      name = count ? "[#{count}]" : m.signature
+      name = count ? "[#{count}]" : m.short_filename
       class_name = nil
       class_map.each_with_index do |(pattern, color), i|
         if m.filename =~ pattern
@@ -150,8 +163,17 @@ table, td, th { border:1px solid black;  }
           break
         end
       end
-      #NOTE: may want to CGI::escape(m.filename)
-      %{<a href="subl://open?url=file://#{m.filename}&amp;line=#{m.line}" title="#{html_safe(m.signature)}"#{" class=\"#{class_name}\"" if class_name}>#{name}</a>}
+      url = if base_url
+              "#{m.filename.gsub(pwd, base_url)}#L#{m.line}"
+            else
+              #NOTE: may want to CGI::escape(m.filename)
+              "subl://open?url=file://#{m.filename}&amp;line=#{m.line}"
+            end
+        %{<a href="#{url}" title="#{html_safe(m.signature)}"#{" class=\"#{class_name}\"" if class_name}>#{name}</a>}
+    end
+
+    def pwd
+      @pwd ||= `pwd`.chomp
     end
   end
 end

data/lib/code_web/text_report.rb

@@ -5,11 +5,13 @@ module CodeWeb
     #   @return [Array<MethodCall>]
     attr_accessor :method_calls
     attr_accessor :arg_regex
+    attr_accessor :base_url
     def arg_regex? ; ! arg_regex.nil? ; end
 
-    def initialize(method_calls, class_map=nil, arg_regex=nil, out=STDOUT)
+    def initialize(method_calls, class_map=nil, arg_regex=nil, base_url=nil, out=STDOUT)
       @method_calls = method_calls
       @arg_regex = arg_regex
+      @base_url = base_url
       @out = out
     end
     

data/lib/code_web/version.rb

@@ -1,3 +1,3 @@
 module CodeWeb
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/code_parser_spec.rb

@@ -5,13 +5,6 @@ require 'spec_helper'
 describe CodeWeb::CodeParser do
 
   context "method call" do
-    it 'should add a method' do
-      subject << CodeWeb::MethodCall.new(nil, "puts", ['"x"'], false )
-      expect(method_calls('puts')).to eq([
-        meth('puts',['"x"'])
-      ])
-    end
-
     it 'should support basic method call' do
       parse %{puts}
       expect(method_calls('puts')).to eq([
@@ -22,7 +15,7 @@ describe CodeWeb::CodeParser do
     it 'should support method call with arguments' do
       parse %{puts "x", :y, true, false}
       expect(method_calls('puts')).to eq([
-        meth('puts',['"x"', :y, :true, :false])
+        meth('puts',['x', :y, true, false]) # may want x => '"x"'
       ])
     end
 
@@ -36,7 +29,7 @@ describe CodeWeb::CodeParser do
     it 'should support method call ob objects' do
       parse %{y.puts "x"}
       expect(method_calls('y.puts')).to eq([
-        meth('y.puts',['"x"'])
+        meth(['y', :puts],['x'])
       ])
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_web
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Keenan Brock
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-16 00:00:00.000000000 Z
+date: 2017-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_parser