sandi_meter 0.0.6 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjEzMjdjMjMzYWE4NzkwMWQyYmNiOTE0ZjY0N2NkZDdmNTM3NWIwMQ==
+    MjRmZDFmOTBlY2IxMzJlMjBhNTQwMDIwMjMzMmNlNWQyZDM2ODEyYQ==
   data.tar.gz: !binary |-
-    NjU1M2UzMTIwNjNhMzkyYzZhMGYyNGJlNjVmOTZhYTI3YjcwNzM2Yg==
+    ZjQyYWJiNDNlY2RlNjk0YTIzYTQ2MGU2YTUwNDAwMWU2OWQ3M2ZjZQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NWJhODU3OWQ4ZmNiYzg1ZWIzMDc5MTBkYTE1MTc3MWEyNWNhMDFkNjZjZDIw
-    NzIzOGFmMmMzMmQ2MjZlMDQ1ZjFlM2I4MmYwMjExMDI1M2E1Yzc5NzFiNjc1
-    M2JmOTllMmI0ZDBkZDM2ZDlmZDZjYzE3MzQxZmJhOWE5YzY1NDM=
+    MzgxY2NjZGZjNTJhYmVhNmZhMDUxYmQ5MWQ2ZWEzNGMwZjA1ZTEyYTdjMjUy
+    MmQ1ZTZiOGE5OTAyMzBmOTA3MGFmNmRlZjkzNjA1ZWI2MzJlMWUzMDdmNDNi
+    MGJjZGFiMzNiNTI2OWIyOTI1YzBkMDNkZGQ0ZDg3ZTc1N2U2Zjc=
   data.tar.gz: !binary |-
-    ZDI5OTYwNjAyZDQyZGQ1YzhkN2FhMWY0ZTllNjc2NmJmZDA5OTgzNzE1MTlk
-    OWRjM2Q4MDMyOTdlZjAxZjI1ZDU5OGE4Yjk3YjhlOTNjMmU2Y2YxNzhkZjk3
-    MThhZDE4ZjNhMWNiMDViNDM2NjNiNTYyY2QxZDJiOGQ0YzAzNDQ=
+    ZDMwMTA4NTA1ZTI3ZjU4OGVmYjI3MDMzMzQ2MGQ5Zjc3OGY0ZGZhYzA2Yjlm
+    NzQ1ODg5NmYzMzc0NjZhMmU5ZjFiYmY1YmEyM2FjMWRmNjg5MTRjY2FmNjU4
+    MDg1NmJmYjE1Mjc0NzU0YmQ1Y2M5ZDY0ZGRkMjM2YjlkMzMxZGY=

data/README.md

@@ -15,25 +15,58 @@ Static analysis tool for checking your Ruby code for [Sandi Metz' four rules](ht
 gem install sandi_meter
 
 sandi_meter --help
--g, --graph                      Create folder and log data to graph
--l, --log                        Show syntax error and indentation log output
--p, --path PATH                  Path to folder or file to analyze
--r, --rules                      Show rules
--h, --help                       Help
-
-sandi_meter -p ~/your/ruby/or/rails/project
-
-1. 94% of classes are under 100 lines.
-2. 53% of methods are under 5 lines.
-3. 98% of methods calls accepts are less than 4 parameters.
-4. 21% of controllers have one instance variable per action.
+    -d, --details                    CLI mode. Show details (path, line number)
+    -g, --graph                      HTML mode. Create folder, log data and output stats to HTML file.
+    -l, --log                        Show syntax error and indentation log output
+    -p, --path PATH                  Path to folder or file to analyze (default is ".")
+    -r, --rules                      Show rules
+    -h, --help                       Help
+
+cd ~/your/ruby/or/rails/project
+sandi_meter -d
+
+1. 85% of classes are under 100 lines.
+2. 45% of methods are under 5 lines.
+3. 99% of method calls accepted are less than 4 parameters.
+4. 66% of controllers have one instance variable per action.
+
+Classes with 100+ lines
+  Class name                 | Size  | Path
+  SandiMeter::Analyzer       | 219   | ./lib/sandi_meter/analyzer.rb:7
+  SandiMeter::Calculator     | 172   | ./lib/sandi_meter/calculator.rb:2
+  SandiMeter::HtmlGenerator  | 135   | ./lib/sandi_meter/html_generator.rb:5
+  Valera                     | 109   | ./spec/test_classes/12.rb:1
+
+Missindented classes
+  Class name        | Path
+  MyApp::TestClass  | ./spec/test_classes/1.rb:2
+  OneLinerClass     | ./spec/test_classes/5.rb:1
+
+Methods with 5+ lines
+  Class name                          | Method name                   | Size  | Path
+  SandiMeter::Analyzer                | initialize                    | 10    | ./lib/sandi_meter/analyzer.rb:10
+  SandiMeter::Analyzer                | analyze                       | 13    | ./lib/sandi_meter/analyzer.rb:22
+
+Missindented methods
+  Class name        | Method name  | Path
+  MyApp::TestClass  | blah         | ./spec/test_classes/1.rb:3
+
+Method calls with 4+ arguments
+  # of arguments  | Path
+  5               | ./lib/sandi_meter/html_generator.rb:55
+  5               | ./lib/sandi_meter/html_generator.rb:71
+
+Controllers with 1+ instance variables
+  Controller name         | Action name  | Instance variables
+  AnotherUsersController  | index        | @users, @excess_variable
 ~~~
 
 ## HTML mode
 
 Try using gem with `-g (--graph)` option, so it will create a folder with beautiful html output and log file with results of any scan.
 
-![SandiMeter HTML mode](http://img545.imageshack.us/img545/5601/t8qk.png)
+![SandiMeter HTML mode pie charts](http://imageshack.us/a/img823/7653/hns3.png)
+![SandiMeter HTML mode details](http://imageshack.us/a/img820/8711/bygo.png)
 
 ## Ruby script mode
 
@@ -47,11 +80,11 @@ pp data
 # {:first_rule=>
 #   {:small_classes_amount=>916,
 #    :total_classes_amount=>937,
-#    :missindented_classes_amount=>1},
+#    :misindented_classes_amount=>1},
 #  :second_rule=>
 #   {:small_methods_amount=>1144,
 #    :total_methods_amount=>1833,
-#    :missindented_methods_amount=>0},
+#    :misindented_methods_amount=>0},
 #  :third_rule=>{:proper_method_calls=>5857, :total_method_calls=>5894},
 #  :fourth_rule=>{:proper_controllers_amount=>17, :total_controllers_amount=>94}}
 ~~~

data/html/_detail_block.html

@@ -0,0 +1,8 @@
+<table class="details-stats">
+  <thead>
+    <% head %>
+  </thead>
+  <tbody>
+    <% rows %>
+  </tbody>
+</table>

data/html/index.html

@@ -13,7 +13,7 @@
   </script>
 </head>
 <body>
-  <a href="https://github.com/makaroni4/sandi_meter"><img style="position: absolute; top: 0; left: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_left_green_007200.png" alt="Fork me on GitHub"></a>
+  <a href="https://github.com/makaroni4/sandi_meter"><img style="position: absolute; top: 0; left: 0; border: 0;" src="assets/forkme.png" alt="Fork me on GitHub"></a>
   <div class="container">
     <header>
       <h1 class="main-title">Sandi Metz rules</h1>
@@ -26,7 +26,10 @@
       <div id="pie4" class="pie-charts-item"></div>
       <div class="clearfix"></div>
     </section>
-    <section class="plot-charts">
+    <nav class="main-menu">
+      <a href="#" class="main-menu-active js-menu-item" data-rel=".js-charts">Charts</a><a href="#" class="js-menu-item" data-rel=".js-details">Details</a>
+    </nav>
+    <section class="plot-charts js-charts js-tab-item">
       <div class="plot-charts-item">
         <div class="plot-charts-item-caption">Number of 100 line classes vs time</div>
         <div class="plot-charts-item-graph" id="plot1"></div>
@@ -46,10 +49,13 @@
       </div>
       <div class="clearfix"></div>
     </section>
+    <section class="details js-details js-tab-item">
+      <% details %>
+    </section>
     <footer class="main-footer">
-      Scanned with love by <a href="https://github.com/makaroni4/sandi_meter">sandi_meter</a> gem. 
-      Please, <a href="https://github.com/makaroni4/sandi_meter/issues/new">leave an issue</a> or 
-      <a href="email:makaroni4@gmail.com">email</a> some feedback!
+      Scanned with love by <a href="https://github.com/makaroni4/sandi_meter">sandi_meter</a> gem.
+      Please, <a href="https://github.com/makaroni4/sandi_meter/issues/new">leave an issue</a> or
+      <a href="mailto:makaroni4@gmail.com">email</a> some feedback!
     </footer>
   </div>
 </body>

data/html/script.js

@@ -61,4 +61,15 @@ $(document).ready(function(){
   plotLine('plot2', data, ['r20', 'r21'], ['under 5 lines', 'more than 5 lines']);
   plotLine('plot3', data, ['r30', 'r31'], ['less than 4 params', 'more than 4 params']);
   plotLine('plot4', data, ['r40', 'r41'], ['one instance variable', 'many instance variables']);
+
+  var $tabs = $(".js-tab-item");
+  var $menuItems = $(".js-menu-item")
+  $menuItems.on("click", function(e){
+    var rel = $(this).data("rel");
+    $tabs.hide();
+    $menuItems.removeClass("main-menu-active");
+    $(rel).show();
+    $(this).addClass("main-menu-active");
+    e.preventDefault();
+  });
 })

data/html/style.css

@@ -51,3 +51,78 @@ body {
 .plot-charts-item-graph {
   height: 280px;
 }
+
+.toggle_report.current_tab {
+  text-decoration: none;
+  cursor: default;
+  pointer-events: none;
+}
+
+.details {
+  display: none;
+}
+
+.details h2 {
+  margin: 0 0 14px;
+}
+
+.details-stats {
+  font-family: monospace;
+  margin-bottom: 40px;
+}
+
+.details-stats td {
+  padding-right: 20px;
+  line-height: 18px;
+}
+
+.details-stats td.warning {
+  color: red;
+}
+
+.main-menu {
+  margin-bottom: 30px;
+}
+
+.main-menu {
+  text-align: center;
+}
+
+.main-menu a {
+  display: inline-block;
+  padding: 4px 16px;
+  font-size: 18px;
+  text-decoration: none;
+  color: black;
+  border: 1px solid rgb(158, 158, 158);
+}
+
+.main-menu a:hover {
+  color: rgb(65, 131, 196);;
+}
+
+.main-menu a:first-child {
+  border-right: none;
+  border-top-left-radius: 4px;
+  border-bottom-left-radius: 4px;
+}
+
+.main-menu a:last-child {
+  border-top-right-radius: 4px;
+  border-bottom-right-radius: 4px;
+}
+
+.main-menu-active {
+  background: rgb(240, 240, 240);
+}
+
+.main-menu .main-menu-active:hover {
+  color: black;
+}
+
+.hint {
+  margin: -40px 0 40px 0;
+  font-family: monospace;
+  font-style: italic;
+  font-weight: normal;
+}

data/lib/sandi_meter/analyzer.rb

@@ -5,15 +5,18 @@ require_relative 'method_arguments_counter'
 
 module SandiMeter
   class Analyzer
-    attr_reader :classes, :missindented_classes, :methods, :missindented_methods, :method_calls, :instance_variables
+    attr_reader :classes, :misindented_classes, :methods, :misindented_methods, :method_calls, :instance_variables
 
     def initialize
       @classes = []
-      @missindented_classes = []
-      @missindented_methods = {}
+      @misindented_classes = []
+      @misindented_methods = {}
       @methods = {}
       @method_calls = []
       @instance_variables = {}
+
+      @parent_token = nil
+      @private_or_protected = false
     end
 
     def analyze(file_path)
@@ -37,19 +40,31 @@ module SandiMeter
 
       @classes.map! do |klass_params|
         klass_params << loc_checker.check(klass_params, 'class')
+        klass_params << "#{@file_path}:#{klass_params[1]}"
+      end
+
+      @misindented_classes.map! do |klass_params|
+        klass_params << "#{@file_path}:#{klass_params[1]}"
       end
 
       @methods.each_pair do |klass, methods|
         methods.each do |method_params|
           method_params << loc_checker.check(method_params, 'def')
+          method_params << "#{@file_path}:#{method_params[1]}"
+        end
+      end
+
+      @misindented_methods.each_pair do |klass, methods|
+        methods.each do |method_params|
+          method_params << "#{@file_path}:#{method_params[1]}"
         end
       end
 
       {
         classes: @classes,
-        missindented_classes: @missindented_classes,
+        misindented_classes: @misindented_classes,
         methods: @methods,
-        missindented_methods: @missindented_methods,
+        misindented_methods: @misindented_methods,
         method_calls: @method_calls,
         instance_variables: @instance_variables
       }
@@ -104,12 +119,12 @@ module SandiMeter
 
         if @indentation_warnings['class'] && @indentation_warnings['class'].any? { |first_line, last_line| first_line == class_params.last }
           class_params << nil
-          @missindented_classes << class_params
+          @misindented_classes << class_params
         else
           class_params += [find_last_line(class_params)]
 
           # in case of one liner class last line will be nil
-          (class_params.last == nil ? @missindented_classes : @classes) << class_params
+          (class_params.last == nil ? @misindented_classes : @classes) << class_params
         end
 
         current_namespace = class_params.first
@@ -127,7 +142,7 @@ module SandiMeter
           counter = SandiMeter::MethodArgumentsCounter.new
           arguments_count, line = counter.count(sexp)
 
-          @method_calls << [arguments_count, line]
+          @method_calls << [arguments_count, "#{@file_path}:#{line}"]
 
           find_args_add_block(sexp)
         else
@@ -145,7 +160,7 @@ module SandiMeter
         if sexp.first == :assign
           @instance_variables[current_namespace] ||= {}
           @instance_variables[current_namespace][method_name] ||= []
-          @instance_variables[current_namespace][method_name] << sexp[1][1][1]
+          @instance_variables[current_namespace][method_name] << sexp[1][1][1] if sexp[1][1][0] == :@ivar
         else
           scan_def_for_ivars(current_namespace, method_name, sexp)
         end
@@ -156,24 +171,41 @@ module SandiMeter
       sexp.each do |element|
         next unless element.kind_of?(Array)
 
+        @parent_token = element.first
         case element.first
         when :def
           method_params = find_method_params(element)
           if @indentation_warnings['def'] && @indentation_warnings['def'].any? { |first_line, last_line| first_line == method_params.last }
             method_params << nil
             method_params << number_of_arguments(element)
-            @missindented_methods[current_namespace] ||= []
-            @missindented_methods[current_namespace] << method_params
+            @misindented_methods[current_namespace] ||= []
+            @misindented_methods[current_namespace] << method_params
           else
             method_params += [find_last_line(method_params, 'def')]
             method_params << number_of_arguments(element)
             @methods[current_namespace] ||= []
             @methods[current_namespace] << method_params
           end
-          scan_def_for_ivars(current_namespace, method_params.first, element) if @scan_instance_variables
+          if @scan_instance_variables && !@private_or_protected
+            scan_def_for_ivars(current_namespace, method_params.first, element)
+          end
+
           find_args_add_block(element)
         when :module, :class
           scan_class_sexp(element, current_namespace)
+        when :vcall
+          if element[1].first == :@ident
+            case element[1][1]
+            when "private"
+              @private_or_protected = true
+            when "public"
+              @private_or_protected = false
+            else
+              scan_sexp(element, current_namespace)
+            end
+          else
+            scan_sexp(element, current_namespace)
+          end
         else
           scan_sexp(element, current_namespace)
         end

data/lib/sandi_meter/calculator.rb

@@ -17,7 +17,9 @@ module SandiMeter
       end
     end
 
-    def calculate!
+    def calculate!(store_details = false)
+      @store_details = store_details
+
       check_first_rule
       check_second_rule
       check_third_rule
@@ -27,18 +29,90 @@ module SandiMeter
     end
 
     private
+    def log_first_rule
+      @output[:first_rule][:log] ||= {}
+      @output[:first_rule][:log][:classes] = @data[:classes].inject([]) do |log, class_params|
+        # TODO
+        # wrap each class params into class and get params with
+        # verbose name instead of array keys (class_params[2] should be klass.line_count)
+        log << [class_params.first, class_params[2], class_params.last] if class_params[-2] == false
+        log
+      end
+
+      @output[:first_rule][:log][:misindented_classes] = @data[:misindented_classes].inject([]) do |log, class_params|
+        log << [class_params.first, nil, class_params.last]
+        log
+      end
+    end
+
+    def log_second_rule
+      @output[:second_rule][:log] ||= {}
+      @output[:second_rule][:log][:methods] ||= []
+      @output[:second_rule][:log][:misindented_methods] ||= []
+
+      @data[:methods].each_pair do |klass, methods|
+        methods.select { |m| m[-2] == false }.each do |method_params|
+          params = [klass, method_params.first]
+          # TODO
+          # wrap method param to method class so method_params[1] becomes method.first_line
+          # and method_params[2] method.last_line
+          params << method_params[2] - method_params[1]
+          params << method_params.last
+
+          @output[:second_rule][:log][:methods] << params
+        end
+      end
+
+      @data[:misindented_methods].each_pair do |klass, methods|
+        methods.each do |method_params|
+          params = [klass, method_params.first]
+          params << nil
+          params << method_params.last
+
+          @output[:second_rule][:log][:misindented_methods] << params
+        end
+      end
+    end
+
+    def log_third_rule
+      @output[:third_rule][:log] ||={}
+      @output[:third_rule][:log][:method_calls] ||= []
+
+      # TODO
+      # add name of method being called
+      proper_method_calls = @data[:method_calls].inject(0) do |sum, params|
+        @output[:third_rule][:log][:method_calls] << params if params.first > 4
+      end
+    end
+
+    def log_fourth_rule
+      @output[:fourth_rule][:log] ||={}
+      @output[:fourth_rule][:log][:controllers] ||= []
+
+      @data[:instance_variables].each_pair do |controller, methods|
+        methods.each_pair do |method, instance_variables|
+          if instance_variables.size > 1
+            @output[:fourth_rule][:log][:controllers] << [controller, method, instance_variables]
+          end
+        end
+      end
+    end
+
     def check_first_rule
       total_classes_amount = @data[:classes].size
       small_classes_amount = @data[:classes].inject(0) do |sum, class_params|
-        sum += 1 if class_params.last == true
+        sum += 1 if class_params[-2] == true
         sum
       end
-      missindented_classes_amount = @data[:missindented_classes].size
+
+      misindented_classes_amount = @data[:misindented_classes].size
 
       @output[:first_rule] ||= {}
       @output[:first_rule][:small_classes_amount] = small_classes_amount
       @output[:first_rule][:total_classes_amount] = total_classes_amount
-      @output[:first_rule][:missindented_classes_amount] = missindented_classes_amount
+      @output[:first_rule][:misindented_classes_amount] = misindented_classes_amount
+
+      log_first_rule if @store_details
     end
 
     def check_second_rule
@@ -46,19 +120,21 @@ module SandiMeter
       small_methods_amount = 0
 
       @data[:methods].each_pair do |klass, methods|
-        small_methods_amount += methods.select { |m| m.last == true }.size
+        small_methods_amount += methods.select { |m| m[-2] == true }.size
         total_methods_amount += methods.size
       end
 
-      missindented_methods_amount = 0
-      @data[:missindented_methods].each_pair do |klass, methods|
-        missindented_methods_amount += methods.size
+      misindented_methods_amount = 0
+      @data[:misindented_methods].each_pair do |klass, methods|
+        misindented_methods_amount += methods.size
       end
 
       @output[:second_rule] ||= {}
       @output[:second_rule][:small_methods_amount] = small_methods_amount
       @output[:second_rule][:total_methods_amount] = total_methods_amount
-      @output[:second_rule][:missindented_methods_amount] = missindented_methods_amount
+      @output[:second_rule][:misindented_methods_amount] = misindented_methods_amount
+
+      log_second_rule if @store_details
     end
 
     # TODO
@@ -74,6 +150,8 @@ module SandiMeter
       @output[:third_rule] ||= {}
       @output[:third_rule][:proper_method_calls] = proper_method_calls
       @output[:third_rule][:total_method_calls] = total_method_calls
+
+      log_third_rule if @store_details
     end
 
     def check_fourth_rule
@@ -88,6 +166,8 @@ module SandiMeter
       @output[:fourth_rule] ||= {}
       @output[:fourth_rule][:proper_controllers_amount] = proper_controllers_amount
       @output[:fourth_rule][:total_controllers_amount] = total_controllers_amount
+
+      log_fourth_rule if @store_details
     end
   end
 end

data/lib/sandi_meter/cli.rb

@@ -20,10 +20,16 @@ module SandiMeter
       description: "Show syntax error and indentation log output",
       boolean: true
 
+    option :details,
+      short: "-d",
+      long: "--details",
+      description: "CLI mode. Show details (path, line number)",
+      boolean: true
+
     option :graph,
       short: "-g",
       long: "--graph",
-      description: "Create folder and log data to graph",
+      description: "HTML mode. Create folder, log data and output stats to HTML file.",
       boolean: true
 
     option :help,
@@ -53,18 +59,26 @@ module SandiMeter
       end
 
       scanner = SandiMeter::FileScanner.new(cli.config[:log])
-      data = scanner.scan(cli.config[:path])
+      data = scanner.scan(cli.config[:path], cli.config[:details] || cli.config[:graph])
+
       formatter = SandiMeter::Formatter.new
 
       formatter.print_data(data)
 
       if cli.config[:graph]
-        logger = SandiMeter::Logger.new
-        logger.log!(cli.config[:path], data)
+        if File.directory?(cli.config[:path])
+          logger = SandiMeter::Logger.new
+          logger.log!(cli.config[:path], data)
+
+          html_generator = SandiMeter::HtmlGenerator.new
+          html_generator.copy_assets!(cli.config[:path])
+          html_generator.generate_data!(cli.config[:path])
+          html_generator.generate_details!(cli.config[:path], data)
 
-        html_generator = SandiMeter::HtmlGenerator.new
-        html_generator.copy_assets!(cli.config[:path])
-        html_generator.generate_data!(cli.config[:path])
+          system "open sandi_meter/index.html"
+        else
+          puts "WARNING!!! HTML mode works only if you scan folder."
+        end
       end
     end
 
@@ -77,4 +91,4 @@ module SandiMeter
       )
     end
   end
-end
+end

data/lib/sandi_meter/file_scanner.rb

@@ -8,14 +8,14 @@ module SandiMeter
       @calculator = SandiMeter::Calculator.new
     end
 
-    def scan(path)
+    def scan(path, store_details = false)
       if File.directory?(path)
         scan_dir(path)
       else
         scan_file(path)
       end
 
-      @calculator.calculate!
+      @calculator.calculate!(store_details)
     end
 
     private
@@ -32,6 +32,8 @@ module SandiMeter
         @calculator.push(data)
       rescue Exception => e
         if @log_errors
+          # TODO
+          # add backtrace
           puts "Checkout #{path} for:"
           puts "\t#{e.message}"
         end

data/lib/sandi_meter/formatter.rb

@@ -4,25 +4,81 @@ module SandiMeter
       if data[:first_rule][:total_classes_amount] > 0
         puts "1. #{data[:first_rule][:small_classes_amount] * 100 / data[:first_rule][:total_classes_amount]}% of classes are under 100 lines."
       else
-        puts "1. No classes to analize."
+        puts "1. No classes to analyze."
       end
 
       if data[:second_rule][:total_methods_amount] > 0
         puts "2. #{data[:second_rule][:small_methods_amount] * 100 / data[:second_rule][:total_methods_amount]}% of methods are under 5 lines."
       else
-        puts "2. No methods to analize."
+        puts "2. No methods to analyze."
       end
 
       if data[:third_rule][:total_method_calls] > 0
-        puts "3. #{data[:third_rule][:proper_method_calls] * 100 / data[:third_rule][:total_method_calls]}% of methods calls accepts are less than 4 parameters."
+        puts "3. #{data[:third_rule][:proper_method_calls] * 100 / data[:third_rule][:total_method_calls]}% of method calls accepted are less than 4 parameters."
       else
-        puts "3. No method calls to analize."
+        puts "3. No method calls to analyze."
       end
 
       if data[:fourth_rule][:total_controllers_amount] > 0
         puts "4. #{data[:fourth_rule][:proper_controllers_amount] * 100 / data[:fourth_rule][:total_controllers_amount]}% of controllers have one instance variable per action."
       else
-        puts "4. No controllers to analize."
+        puts "4. No controllers to analyze."
+      end
+
+      print_log(data)
+    end
+
+    def print_log(data)
+      return unless data[:first_rule][:log] || data[:second_rule][:log] || data[:fourth_rule][:log]
+
+      if data[:first_rule][:log][:classes].any?
+        puts "\nClasses with 100+ lines"
+        print_array_of_arrays [["Class name", "Size", "Path"]] + data[:first_rule][:log][:classes]
+      end
+
+      if data[:first_rule][:log][:misindented_classes].any?
+        puts "\nMissindented classes"
+        print_array_of_arrays [["Class name", "Path"]] + data[:first_rule][:log][:misindented_classes].map { |row| row.delete_at(1); row } # 1 – size, which nil for misindented_classes
+      end
+
+      if data[:second_rule][:log][:methods].any?
+        puts "\nMethods with 5+ lines"
+        print_array_of_arrays [["Class name", "Method name", "Size", "Path"]] + data[:second_rule][:log][:methods]
+      end
+
+      if data[:second_rule][:log][:misindented_methods].any?
+        puts "\nMissindented methods"
+        print_array_of_arrays [["Class name", "Method name", "Path"]] + data[:second_rule][:log][:misindented_methods].map { |row| row.delete_at(2); row } # 2 – size, which nil for misindented_methods
+      end
+
+      if data[:third_rule][:log][:method_calls].any?
+        puts "\nMethod calls with 4+ arguments"
+        print_array_of_arrays [["# of arguments", "Path"]] + data[:third_rule][:log][:method_calls]
+      end
+
+      if data[:fourth_rule][:log][:controllers].any?
+        puts "\nControllers with 1+ instance variables"
+        print_array_of_arrays [["Controller name", "Action name", "Instance variables"]] + data[:fourth_rule][:log][:controllers]
+      end
+    end
+
+    private
+    # TODO
+    # sort output by number of lines or any param
+    def print_array_of_arrays(nested_array)
+      nested_sizes = nested_array.map do |row|
+        row.map { |element| element.to_s.size }
+      end
+
+      sizes = nested_sizes.transpose.map { |row| row.max }
+
+      nested_array.each do |row|
+        line_elements = row.each_with_index.map do |element, index|
+          element_string = element.kind_of?(Array) ? element.join(', ') : element.to_s
+          element_string.ljust(sizes[index] + 1, ' ')
+        end
+
+        puts line_elements.join(' | ').prepend("  ")
       end
     end
   end

data/lib/sandi_meter/html_generator.rb

@@ -8,7 +8,7 @@ module SandiMeter
       FileUtils.mkdir(asset_dir_path) unless Dir.exists?(asset_dir_path)
 
 
-      Dir[File.join(File.dirname(__FILE__), "../../html/*.{js,css}")].each do |file|
+      Dir[File.join(File.dirname(__FILE__), "../../html/*.{js,css,png}")].each do |file|
         FileUtils.cp file, File.join(asset_dir_path, File.basename(file))
       end
 
@@ -39,5 +39,98 @@ module SandiMeter
         file.write(index)
       end
     end
+
+    def generate_details!(path, data)
+      details = ""
+
+      if data[:first_rule][:log][:classes].any?
+        data[:first_rule][:log][:misindented_classes] ||= []
+        data[:first_rule][:log][:misindented_classes].each do |class_params|
+          class_params.insert(1, nil)
+        end
+
+        details << string_to_h2("Classes with 100+ lines")
+        details << generate_details_block(
+          ["Class name", "Size", "Path"],
+          proper_data: data[:first_rule][:log][:classes],
+          warning_data: data[:first_rule][:log][:misindented_classes],
+          hint: "NOTE: Red classes are misindented. Start improving your project by fixing them.",
+          warning_message: 'Misindented classes'
+        )
+      end
+
+      if data[:second_rule][:log][:methods].any?
+        data[:second_rule][:log][:misindented_methods] ||= []
+        data[:second_rule][:log][:misindented_methods].each do |method_params|
+          method_params.insert(2, nil)
+        end
+
+        details << string_to_h2("Methods with 5+ lines")
+        details << generate_details_block(
+          ["Class name", "Method name", "Size", "Path"],
+          proper_data: data[:second_rule][:log][:methods].sort_by { |a| -a[2].to_i },
+          warning_data: data[:second_rule][:log][:misindented_methods].sort_by { |a| -a[1].to_i },
+          hint: "NOTE: Red methods are misindented. Continue your way to perfect code by fixing them.",
+          warning_message: 'Misindented methods'
+        )
+      end
+
+      if data[:third_rule][:log][:method_calls].any?
+        details << string_to_h2("Method calls with 4+ arguments")
+        details << generate_details_block(
+          ["# of arguments", "Path"],
+          proper_data: data[:third_rule][:log][:method_calls]
+        )
+      end
+
+      if data[:fourth_rule][:log][:controllers].any?
+        details << string_to_h2("Controllers with 1+ instance variables")
+        details << generate_details_block(
+          ["Controller name", "Action name", "Instance variables"],
+          proper_data: data[:fourth_rule][:log][:controllers]
+        )
+      end
+
+      index_file = File.join(path, 'sandi_meter', 'index.html')
+      index = File.read(index_file)
+      index.gsub!('<% details %>', details)
+
+      File.open(index_file, 'w') do |file|
+        file.write(index)
+      end
+    end
+
+    private
+    def generate_details_block(head_row, data)
+      block_partial = File.read File.join(File.dirname(__FILE__), "../../html", "_detail_block.html")
+      block_partial.gsub!('<% head %>', array_to_tr(head_row, cell: "th"))
+
+      table_rows = data[:proper_data].map { |row| array_to_tr(row) }.join('')
+
+      if data[:warning_data]
+        table_rows << data[:warning_data].map { |row| array_to_tr(row, css_class: 'warning', tip: data[:warning_message]) }.join('')
+      end
+
+      block_partial.gsub!('<% rows %>', table_rows)
+      block_partial << hint(data[:hint]) if data[:hint]
+      block_partial
+    end
+
+    def hint(string)
+      %(<div class="hint">#{string}</div>)
+    end
+
+    def string_to_h2(string)
+      "<h2>#{string}</h2>\n"
+    end
+
+    def cell_to_s(element)
+      element.kind_of?(Array) ? element.join(', ') : element.to_s
+    end
+
+    def array_to_tr(array, params = {})
+      cell = params[:cell] || "td"
+      array.map { |element| "<#{cell} class=\"#{params[:css_class]}\" title=\"#{params[:tip]}\">#{cell_to_s(element)}</#{cell}>\n" }.join('').prepend("<tr>\n").concat("</tr>\n")
+    end
   end
 end

data/lib/sandi_meter/version.rb

@@ -1,3 +1,3 @@
 module SandiMeter
-  VERSION = "0.0.6"
+  VERSION = "1.0.0"
 end

data/spec/analyzer_spec.rb

@@ -12,21 +12,21 @@ describe SandiMeter::Analyzer do
     end
 
     it 'finds indentation warnings for method' do
-      analyzer.classes.should eq([["TestClass", 1, 5, true]])
-      analyzer.missindented_classes.should be_empty
+      analyzer.classes.should eq([["TestClass", 1, 5, true, "#{test_file_path(3)}:1"]])
+      analyzer.misindented_classes.should be_empty
     end
 
     it 'finds methods' do
-      analyzer.methods.should eq({"TestClass"=>[["blah", 2, 4, 0, true]]})
-      analyzer.missindented_methods.should be_empty
+      analyzer.methods.should eq({"TestClass"=>[["blah", 2, 4, 0, true, "#{test_file_path(3)}:2"]]})
+      analyzer.misindented_methods.should be_empty
     end
 
     it 'finds method calls that brakes third rule' do
-      analyzer.method_calls.should eq([[5,3]])
+      analyzer.method_calls.should eq([[5, "#{test_file_path(3)}:3"]])
     end
   end
 
-  describe 'finds missindented classes without last line' do
+  describe 'finds misindented classes without last line' do
     let(:test_class) { test_file_path(1) }
 
     before do
@@ -35,12 +35,12 @@ describe SandiMeter::Analyzer do
 
     it 'finds indentation warnings for method' do
       analyzer.classes.should be_empty
-      analyzer.missindented_classes.should eq([["MyApp::TestClass", 2, nil]])
+      analyzer.misindented_classes.should eq([["MyApp::TestClass", 2, nil, "#{test_file_path(1)}:2"]])
     end
 
     it 'finds methods' do
       analyzer.methods.should be_empty
-      analyzer.missindented_methods.should eq({"MyApp::TestClass"=>[["blah", 3, nil, 0]]})
+      analyzer.misindented_methods.should eq({"MyApp::TestClass"=>[["blah", 3, nil, 0, "#{test_file_path(1)}:3"]]})
     end
   end
 
@@ -52,15 +52,15 @@ describe SandiMeter::Analyzer do
     end
 
     it 'finds classes' do
-      analyzer.classes.should include(["FirstTestClass", 1, 4, true])
-      analyzer.classes.should include(["SecondTestClass", 6, 9, true])
-      analyzer.missindented_classes.should be_empty
+      analyzer.classes.should include(["FirstTestClass", 1, 4, true, "#{test_file_path(4)}:1"])
+      analyzer.classes.should include(["SecondTestClass", 6, 9, true, "#{test_file_path(4)}:6"])
+      analyzer.misindented_classes.should be_empty
     end
 
     it 'finds methods' do
-      analyzer.methods["FirstTestClass"].should eq([["first_meth", 2, 3, 1, true]])
-      analyzer.methods["SecondTestClass"].should eq([["second_meth", 7, 8, 1, true]])
-      analyzer.missindented_methods.should be_empty
+      analyzer.methods["FirstTestClass"].should eq([["first_meth", 2, 3, 1, true, "#{test_file_path(4)}:2"]])
+      analyzer.methods["SecondTestClass"].should eq([["second_meth", 7, 8, 1, true, "#{test_file_path(4)}:7"]])
+      analyzer.misindented_methods.should be_empty
     end
   end
 
@@ -72,13 +72,13 @@ describe SandiMeter::Analyzer do
     end
 
     it 'finds classes' do
-      analyzer.missindented_classes.should eq([["OneLinerClass", 1, nil]])
+      analyzer.misindented_classes.should eq([["OneLinerClass", 1, nil, "#{test_file_path(5)}:1"]])
       analyzer.classes.should be_empty
     end
 
     it 'finds methods' do
       analyzer.methods.should be_empty
-      analyzer.missindented_methods.should be_empty
+      analyzer.misindented_methods.should be_empty
     end
   end
 
@@ -90,16 +90,16 @@ describe SandiMeter::Analyzer do
     end
 
     it 'finds class and subclass' do
-      analyzer.classes.should include(["MyApp::Blah::User", 5, 13, true])
-      analyzer.classes.should include(["MyApp::Blah::User::SubUser", 9, 12, true])
-      analyzer.missindented_classes.should be_empty
+      analyzer.classes.should include(["MyApp::Blah::User", 5, 13, true, "#{test_file_path(7)}:5"])
+      analyzer.classes.should include(["MyApp::Blah::User::SubUser", 9, 12, true, "#{test_file_path(7)}:9"])
+      analyzer.misindented_classes.should be_empty
     end
 
     it 'finds methods' do
-      analyzer.methods["MyApp::Blah"].should eq([["module_meth", 2, 3, 0, true]])
-      analyzer.methods["MyApp::Blah::User"].should eq([["class_meth", 6, 7, 0, true]])
-      analyzer.methods["MyApp::Blah::User::SubUser"].should eq([["sub_meth", 10, 11, 0, true]])
-      analyzer.missindented_methods.should be_empty
+      analyzer.methods["MyApp::Blah"].should eq([["module_meth", 2, 3, 0, true, "#{test_file_path(7)}:2"]])
+      analyzer.methods["MyApp::Blah::User"].should eq([["class_meth", 6, 7, 0, true, "#{test_file_path(7)}:6"]])
+      analyzer.methods["MyApp::Blah::User::SubUser"].should eq([["sub_meth", 10, 11, 0, true, "#{test_file_path(7)}:10"]])
+      analyzer.misindented_methods.should be_empty
     end
   end
 
@@ -111,15 +111,15 @@ describe SandiMeter::Analyzer do
     end
 
     it 'finds class and subclass' do
-      analyzer.classes.should include(["RailsController", 1, 12, true])
-      analyzer.missindented_classes.should be_empty
+      analyzer.classes.should include(["RailsController", 1, 12, true, "#{test_file_path(8)}:1"])
+      analyzer.misindented_classes.should be_empty
     end
 
     it 'finds methods' do
-      analyzer.methods["RailsController"].should include(["index", 2, 3, 0, true])
-      analyzer.methods["RailsController"].should include(["destroy", 5, 6, 0, true])
-      analyzer.methods["RailsController"].should include(["private_meth", 9, 10, 0, true])
-      analyzer.missindented_methods.should be_empty
+      analyzer.methods["RailsController"].should include(["index", 2, 3, 0, true, "#{test_file_path(8)}:2"])
+      analyzer.methods["RailsController"].should include(["destroy", 5, 6, 0, true, "#{test_file_path(8)}:5"])
+      analyzer.methods["RailsController"].should include(["private_meth", 9, 10, 0, true, "#{test_file_path(8)}:9"])
+      analyzer.misindented_methods.should be_empty
     end
   end
 
@@ -136,6 +136,18 @@ describe SandiMeter::Analyzer do
       end
     end
 
+    context 'in controller class with non instance variables' do
+      let(:test_class) { test_file_path('14_controller') }
+
+      before do
+        analyzer.analyze(test_class)
+      end
+
+      it 'does not find instance variables' do
+        analyzer.instance_variables.should eq({"GuestController"=>{"create_guest_user"=>[]}})
+      end
+    end
+
     context 'not in controller class' do
       let(:test_class) { test_file_path(10) }
 
@@ -147,6 +159,32 @@ describe SandiMeter::Analyzer do
         analyzer.instance_variables.should be_empty
       end
     end
+
+    context 'in controller class with private method' do
+      let(:test_class) { test_file_path("15_controller") }
+
+      before do
+        analyzer.analyze(test_class)
+      end
+
+      it 'finds method defined after public keyword' do
+        analyzer.instance_variables["UsersController"].should have_key("create")
+      end
+
+      it 'omits actions without instance variables' do
+        analyzer.instance_variables["UsersController"].should_not have_key("show")
+      end
+
+      it 'omits private methods' do
+        analyzer.instance_variables["UsersController"].should_not have_key("find_user")
+      end
+
+      it 'omits protected methods' do
+        analyzer.instance_variables["UsersController"].should_not have_key("protected_find_user")
+      end
+
+
+    end
   end
 
   describe 'hash method arguments' do
@@ -157,7 +195,7 @@ describe SandiMeter::Analyzer do
     end
 
     it 'counts arguments' do
-      analyzer.method_calls.should eq([[5, 3]])
+      analyzer.method_calls.should eq([[5, "#{test_file_path(11)}:3"]])
     end
   end
 
@@ -169,11 +207,11 @@ describe SandiMeter::Analyzer do
     end
 
     it 'are count for class definition' do
-      analyzer.classes.should eq([["Valera", 1, 109, false]])
+      analyzer.classes.should eq([["Valera", 1, 109, false, "#{test_file_path(12)}:1"]])
     end
 
     it 'are count for method definition' do
-      analyzer.methods.should eq({"Valera"=>[["doodle", 2, 9, 0, false]]})
+      analyzer.methods.should eq({"Valera"=>[["doodle", 2, 9, 0, false, "#{test_file_path(12)}:2"]]})
     end
   end
 

data/spec/test_classes/10_controller.rb

@@ -0,0 +1,6 @@
+class AnotherUsersController
+  def index
+    @users = User.page(params[:page])
+    @excess_variable = 'blah blah'
+  end
+end

data/spec/test_classes/14_controller.rb

@@ -0,0 +1,8 @@
+class GuestController
+  def create_guest_user
+    u = User.new_guest
+    u.save
+    session[:guest_user_id] = u.id
+    u
+  end
+end

data/spec/test_classes/15_controller.rb

@@ -0,0 +1,21 @@
+class UsersController
+  before_filter :find_user
+
+  def show
+  end
+
+  private
+  def find_user
+    @user = User.find(params[:id])
+  end
+
+  protected
+  def protected_find_user
+    @user = User.find(params[:id])
+  end
+
+  public
+  def create
+    @user = User.new(params[:user])
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sandi_meter
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Anatoli Makarevich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-26 00:00:00.000000000 Z
+date: 2013-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,7 +64,9 @@ files:
 - README.md
 - Rakefile
 - sandi_meter.gemspec
+- html/_detail_block.html
 - html/chart.js
+- html/forkme.png
 - html/index.html
 - html/jquery.js
 - html/morris.css
@@ -88,9 +90,12 @@ files:
 - spec/method_arguments_counter_spec.rb
 - spec/test_classes/1.rb
 - spec/test_classes/10.rb
+- spec/test_classes/10_controller.rb
 - spec/test_classes/11.rb
 - spec/test_classes/12.rb
 - spec/test_classes/13.rb
+- spec/test_classes/14_controller.rb
+- spec/test_classes/15_controller.rb
 - spec/test_classes/2.rb
 - spec/test_classes/3.rb
 - spec/test_classes/4.rb