code_web 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b78e826e03736b6ad03ecca86454dd8a21e77d3
-  data.tar.gz: 17716b11fbfca39fa06742ed670c806e3e37fba4
+  metadata.gz: db6663f8fa280e0e501e377ba513d3c4db1be267
+  data.tar.gz: 2d9904670ee7c4b050c099683360d9d989340532
 SHA512:
-  metadata.gz: d198666367ffbafea550fecc6cd5eac0190bb6b2511293aefd9f3353aebabbb3053f8c35db2a4e049351e9f5a2a0a530a76aea4a797d2aca75334aaf69c56bf2
-  data.tar.gz: 88ab6844ea0c04842467c103c187d0b9ac45df5590c01969c8887a3e854ffd28880c9c63748479bd729524343ab3c40844b812800d0c786ce44a448d472d8a0a
+  metadata.gz: c92eac121116f0d1037498d276b691b4f75aa98b894eabb0579d404bb05852953c0d83255f4455158417de4df70b3e7627690a404082f1abfbb996e6d7bba429
+  data.tar.gz: 1aa905da6a3a5e26a394c4cd6c82c4c391a387403c50c26fbf5a1d207b022294e7e6858ebbfac43af5482e0c7dc2534515e186b75e0a19fc2653a188543bd6e0

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.0.7] - 2017-06-13
+- fix `-u` flag
+- added `--both` to show both github and local filesystem links
+
 ## [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
@@ -23,6 +27,7 @@ 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.6...HEAD
+[Unreleased]: https://github.com/kbrock/code_web/compare/v0.0.7...HEAD
+[0.0.7]: https://github.com/kbrock/code_web/compare/v0.0.6...v0.0.7
 [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

@@ -21,6 +21,10 @@ module CodeWeb
     #   defaults to local filesystem
     attr_accessor :base_url
 
+    # @attribute file_and_url [rw]
+    #   @return true if both url and file are displayed
+    attr_accessor :file_and_url
+
     # @attribute report_generator [rw]
     #   @return class that runs the report (i.e.: TextReport, HtmlReport) 
     attr_accessor :report_generator
@@ -61,7 +65,8 @@ 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('-u', '--url URL',                   'Base url (e.g.: https://github.com/miq/miq/blob/master)') { |v| self.base_url = v }
+        opt.on('-b', '--both',                      'Show file and url references')               { |v| self.file_and_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}

data/lib/code_web/html_report.rb

@@ -9,6 +9,7 @@ module CodeWeb
     attr_accessor :method_calls
     attr_accessor :arg_regex
     attr_accessor :base_url
+    attr_accessor :url_and_file
     def arg_regex? ; ! arg_regex.nil? ; end
 
     # @!attribute :class_map [rw]
@@ -18,11 +19,12 @@ 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, base_url=nil, out=STDOUT)
+    def initialize(method_calls, class_map={}, arg_regex=nil, out=STDOUT, options = {})
       @method_calls = method_calls
       @class_map = class_map
       @arg_regex = arg_regex
-      @base_url = base_url
+      @base_url = options[:base_url]
+      @url_and_file = options[:url_and_file]
       @out = out
     end
 
@@ -44,30 +46,38 @@ table, td, th { border:1px solid black;  }
         <%- display_yield_column = methods_with_type.detect(&:yields?) -%>
         <table>
         <thead><tr>
-          <%- methods_with_type.arg_keys.each do |arg| -%>
-            <td><%=arg%></td>
-          <%- end -%>
-          <%- if display_yield_column -%>
+        <%- methods_with_type.arg_keys.each do |arg| -%>
+          <td><%=arg%></td>
+        <%- end -%>
+        <%- if display_yield_column -%>
           <td>yield?</td>
-          <%- end -%>
+        <%- end -%>
           <td>ref</td>
+        <%- if base_url -%>
+          <td>file ref</td>
+        <%- end -%>
         </tr></thead>
         <tbody>
         <%- 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]) if methods_by_signature.hash_arg.key?(arg) %></td>
+            <td><%= maybe_simplified_argument(methods_by_signature.hash_arg, arg) %></td>
           <%- end -%>
-            <%- if display_yield_column -%>
+          <%- if display_yield_column -%>
             <td><%= methods_by_signature.f.yields? %></td>
-            <%- end -%>
+          <%- end -%>
             <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) %>
+            <%- method_links(methods_by_signature).each do |link| -%>
+              <%= link %>
             <%- end -%>
+            </td>
+          <%- if base_url -%>
+            <td>
+            <%- method_links(methods_by_signature, true).each do |link| -%>
+              <%= link %>
             <%- end -%>
             </td>
+          <%- end -%>
           </tr>
         <%- end -%>
         </tbody>
@@ -87,12 +97,17 @@ table, td, th { border:1px solid black;  }
             <td><%= methods_by_signature.f.yields? ? 'yields' : 'no yield'%></td>
           <%- end -%>
             <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) %>
+            <%- method_links(methods_by_signature).each do |link| -%>
+              <%= link %>
             <%- end -%>
+            </td>
+          <%- if base_url && url_and_file -%>
+            <td>
+            <%- method_links(methods_by_signature, true).each do |link| -%>
+              <%= link %>
             <%- end -%>
             </td>
+          <%- end -%>
           </tr>
         <%- end -%>
       <%- end -%>
@@ -124,6 +139,10 @@ table, td, th { border:1px solid black;  }
 
     private
 
+    def maybe_simplified_argument(hash, arg)
+      simplified_argument(hash[arg]) if hash.key?(arg)
+    end
+
     # shorten the argument
     def simplified_argument(arg)
       short_arg = case arg
@@ -151,25 +170,37 @@ table, td, th { border:1px solid black;  }
       collection.inject(Set.new) {|acc, m| m.arg_keys.each {|k| acc << k} ; acc}.sort_by {|n| n}
     end
 
+    def method_links(methods_by_signature, force_filename = false)
+      methods_by_signature.group_by(:filename).flat_map do |methods_by_filename|
+        methods_by_filename.each_with_index.map do |method, i|
+          method_link(method, (i > 0 || force_filename) ? i+1 : nil, force_filename)
+        end
+      end
+    end
+
     # create a link to a method
     # add a class if the method is in a particular file
 
-    def method_link(m, count=nil)
+    def method_link(m, count, force_filename = false)
       name = count ? "[#{count}]" : m.short_filename
-      class_name = nil
+      class_name = class_for_filename(m.filename)
+      url = url_for_filename(m.filename, m.line, force_filename)
+      %{<a href="#{url}" title="#{html_safe(m.signature)}"#{" class=\"#{class_name}\"" if class_name}>#{name}</a>}
+    end
+
+    def class_for_filename(filename)
       class_map.each_with_index do |(pattern, color), i|
-        if m.filename =~ pattern
-          class_name = "f#{i}"
-          break
-        end
+        return "f#{i}" if filename =~ pattern
+      end
+      nil
+    end
+
+    def url_for_filename(filename, line, force_filename = false)
+      if !force_filename && base_url
+        "#{filename.gsub(pwd, base_url)}#L#{line}"
+      else
+        "subl://open?url=file://#{filename}&amp;line=#{line}"
       end
-      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

data/lib/code_web/text_report.rb

@@ -8,10 +8,11 @@ module CodeWeb
     attr_accessor :base_url
     def arg_regex? ; ! arg_regex.nil? ; end
 
-    def initialize(method_calls, class_map=nil, arg_regex=nil, base_url=nil, out=STDOUT)
+    def initialize(method_calls, class_map={}, arg_regex=nil, out=STDOUT, options = {})
       @method_calls = method_calls
       @arg_regex = arg_regex
-      @base_url = base_url
+      @base_url = options[:base_url]
+      @url_and_file = options[:url_and_file]
       @out = out
     end
     

data/lib/code_web/version.rb

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

data/spec/code_parser_spec.rb

@@ -34,18 +34,18 @@ describe CodeWeb::CodeParser do
     end
 
     #NOTE the chaining isn't perfect
-    it "should support method chaining" do
+    it "should support method chaining" do ##
       parse "x(a:5).y().z(5)"
       expect(method_calls('x')).to eq([
         meth('x', [{a:5}])
       ])
 
       expect(method_calls('x(...).y')).to eq([
-        meth('x(...).y')
+        meth(['x(...)', :y])
       ])
 
       expect(method_calls('x(...).y.z')).to eq([
-        meth('x(...).y.z',[5])
+        meth(['x(...).y', :z],[5])
       ])
     end
 
@@ -139,16 +139,20 @@ describe CodeWeb::CodeParser do
         meth('puts')
       ])
     end
-    it "should support constants" do
+    it "should support global constants" do
       parse %{
         ABC=puts
-        Class::ABC.runx
       }
       expect(method_calls('puts')).to eq([
         meth('puts')
       ])
-      expect(method_calls('Class.ABC.runx')).to eq([
-        meth('Class.ABC.runx')
+    end
+    it "supports class constants" do
+      parse %{
+        Class::ABC.runx
+      }
+      expect(method_calls('Class::ABC.runx')).to eq([
+        meth(["Class::ABC",:runx])
       ])
     end
   end
@@ -226,7 +230,7 @@ describe CodeWeb::CodeParser do
 
   def method_calls(method_name=nil)
     if method_name
-      subject.method_calls.select { |mc| mc.full_method_name =~ /#{method_name}/ }
+      subject.method_calls.select { |mc| mc.full_method_name =~ /#{Regexp.escape(method_name)}$/ }
     else
       subject.method_calls
     end

metadata

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