sandi_meter 1.0.5 → 1.1.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2I4MGJlNTJhY2UwMzdjN2M3NWQxNzdlMzgwMDRiNTVhZDYwMzA5OQ==
+    MTM2ZjcwMzM2NmQ5ZTliOGU5OGY0ZGY0Zjg1NjRhMzM1ZmJhNTVkNw==
   data.tar.gz: !binary |-
-    MTU0N2IzMzFlMDc1Mjk0ZGQ1ODY5YmQ5ZDAzMTk1MThkOTZiZDVlNA==
+    ZTYzNDVjNmM1NDcxOGE2MmVlZjZlYjMzMTI2N2Y0YTRmNzdiYjBmNg==
 SHA512:
   metadata.gz: !binary |-
-    YWNiNWJjMDE4OTI0OTc5MjAzZjgwMzU1YTk2MDlhZjFiODNlM2U4MjU3Y2Zh
-    MTdlMTkwYmU5ZjBhMzc2OGE4YjEzMDU0ZWI0NDIyYjkxODYwMzZiMThiODYz
-    Mzg2MjAwYzk1ZDBkZWVjZDVhMWEwYzVkZGRmOGI2NzY5ZmRiMzc=
+    YTgwMTUwZmQ3ZjEwNTBlYmExM2ExMjU5NzU1YTkxZmZlNWU2MTc5YTRkODE4
+    YjU5N2JkMGQyYzUyMGQwMTFhYWJiMTIyNjUzYTg1YjhhMDRjMjM5OTQwNzlk
+    NmJiZWJlZDZiZDZlNGNhZTI5OGRhMzlkMTJiMzMxN2JkMzY1NGM=
   data.tar.gz: !binary |-
-    Mzg2NGI4Y2E2NzM0OTVkOTg4YzE3MzRiM2ZhZmQ1ZTE5YTIyNDEwOGNkNzM4
-    NWI0OGQ5MjU4OWY0YjFjNmUxMTliMThhNTdkZmI0NDU1ZDRjNWM1YzIwY2Zh
-    NGJjMzlmYjE5MGE4N2U0MzdkYWZlOTVkNzE0MjE5YjQzMzM1MTI=
+    ZjA4YTQzNWVhMDZhZThkZjg4NjdmZTFjYmQ1MDZiNzc0ZjQzOTY2ODQ4NTMw
+    MWE2YTdjZWQyY2VhZDliMmFlZTlmMDI4ZmUzM2I1ZTQwMzVkY2EzOGViM2Zj
+    ZDE1NmY2ZDM4ZGQyOWQyZmExM2VhMGFkZmU3MGEyOTE4MDg1ZmI=

data/README.md

@@ -65,8 +65,8 @@ Controllers with 1+ instance variables
 
 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 pie charts](http://imageshack.us/a/img823/7653/hns3.png)
-![SandiMeter HTML mode details](http://imageshack.us/a/img820/8711/bygo.png)
+![SandiMeter HTML mode pie charts](http://cl.ly/image/1p142M3K1S2x/content)
+![SandiMeter HTML mode details](http://cl.ly/image/2R163v283V3Q/content)
 
 Add ignore files and folders in `sandi_meter/.sandi_meter` file.
 

data/lib/sandi_meter/calculator.rb

@@ -1,7 +1,7 @@
 module SandiMeter
   class Calculator
     def initialize
-      @data = {}
+      @data = {classes: [], methods: {}, method_calls: []}
       @output = {}
     end
 
@@ -77,15 +77,21 @@ module SandiMeter
       @output[:fourth_rule][:log] ||={}
       @output[:fourth_rule][:log][:controllers] ||= []
 
-      @data[:classes].select { |c| c.controller }.each do |klass|
-        @data[:methods][klass].each do |method|
-          next if method.ivars.empty?
-
-          @output[:fourth_rule][:log][:controllers] << [klass.name, method.name, method.ivars]
+      controllers.each do |controller|
+        methods_for(controller).select { |m| m.ivars.length > 1 }.each do |method|
+          @output[:fourth_rule][:log][:controllers] << [controller.name, method.name, method.ivars.uniq]
         end
       end
     end
 
+    def controllers
+      @data[:classes].select { |c| c.controller? }
+    end
+
+    def methods_for(controller)
+      @data[:methods].fetch(controller.name) { [] }
+    end
+
     def check_first_rule
       total_classes_amount = @data[:classes].size
       small_classes_amount = @data[:classes].select(&:small?).size
@@ -154,5 +160,6 @@ module SandiMeter
 
       log_fourth_rule if @store_details
     end
+
   end
 end

data/lib/sandi_meter/cli.rb

@@ -6,6 +6,7 @@ require 'sandi_meter/rules_checker'
 require 'sandi_meter/logger'
 require 'sandi_meter/version'
 require 'sandi_meter/html_generator'
+require 'yaml'
 
 module SandiMeter
   class CommandParser
@@ -58,71 +59,89 @@ module SandiMeter
   end
 
   class CLI
-    def self.execute
-      cli = CommandParser.new
-      cli.parse_options
-
-      if cli.config[:graph]
-        log_dir_path = File.join(cli.config[:path], 'sandi_meter')
-        FileUtils.mkdir(log_dir_path) unless Dir.exists?(log_dir_path)
-        # put ignore file
-        ignore_file_path = File.join(cli.config[:path], 'sandi_meter', '.sandi_meter')
-        if File.directory?(cli.config[:path]) && !File.exists?(ignore_file_path)
-          File.open(ignore_file_path, "w") do |file|
-            file.write %w(db vendor).join("\n")
-          end
+    class << self
+      def execute
+        cli = CommandParser.new
+        cli.parse_options
+
+        if cli.config[:graph]
+          log_dir_path = File.join(cli.config[:path], 'sandi_meter')
+          FileUtils.mkdir(log_dir_path) unless Dir.exists?(log_dir_path)
+
+          create_config_file(cli.config[:path], 'sandi_meter/.sandi_meter', %w(db vendor).join("\n"))
+          create_config_file(cli.config[:path], 'sandi_meter/config.yml', YAML.dump({ threshold: 90 }))
         end
-      end
 
-      if cli.config[:version]
-        # stolen from gem 'bubs' :)
-        puts "SandiMeter ".tr('A-Za-z1-90', 'Ⓐ-Ⓩⓐ-ⓩ①-⑨⓪').split('').join(' ') + SandiMeter::VERSION
-        exit 0
-      end
+        if cli.config[:version]
+          puts version_info
+          exit 0
+        end
 
-      if cli.config[:rules]
-        show_sandi_rules
-        exit 0
-      end
+        if cli.config[:rules]
+          show_sandi_rules
+          exit 0
+        end
 
-      scanner = SandiMeter::FileScanner.new(cli.config[:log])
-      data = scanner.scan(cli.config[:path], cli.config[:details] || cli.config[:graph])
+        scanner = SandiMeter::FileScanner.new(cli.config[:log])
+        data = scanner.scan(cli.config[:path], cli.config[:details] || cli.config[:graph])
 
-      formatter = SandiMeter::Formatter.new
+        formatter = SandiMeter::Formatter.new
+        formatter.print_data(data)
 
-      formatter.print_data(data)
+        if cli.config[:graph]
+          if File.directory?(cli.config[:path])
+            logger = SandiMeter::Logger.new(data)
+            logger.log!(cli.config[:path])
 
-      if cli.config[:graph]
-        if File.directory?(cli.config[:path])
-          logger = SandiMeter::Logger.new(data)
-          logger.log!(cli.config[:path])
+            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])
-          html_generator.generate_details!(cli.config[:path], data)
+            index_html_path = File.join(cli.config[:path], 'sandi_meter/index.html')
+            system "open #{index_html_path}"
+          else
+            puts "WARNING!!! HTML mode works only if you scan folder."
+          end
+        end
+
+        config_file_path = File.join(cli.config[:path], 'sandi_meter', 'config.yml')
+        config =  if File.exists?(config_file_path)
+                    YAML.load(File.read(config_file_path))
+                  else
+                    { threshold: 90 }
+                  end
 
-          index_html_path = File.join(cli.config[:path], 'sandi_meter/index.html')
-          system "open #{index_html_path}"
+        if RulesChecker.new(data, config).ok?
+          exit 0
         else
-          puts "WARNING!!! HTML mode works only if you scan folder."
+          exit 1
         end
       end
 
-      if RulesChecker.new(data).ok?
-        exit 0
-      else
-        exit 1
+      def show_sandi_rules
+        puts %(
+          1. 100 lines per class
+          2. 5 lines per method
+          3. 4 params per method call (and don't even try cheating with hash params)
+          4. 1 instance variables per controller' action
+        )
       end
-    end
 
-    def self.show_sandi_rules
-      puts %(
-        1. 100 lines per class
-        2. 5 lines per method
-        3. 4 params per method call (and don't even try cheating with hash params)
-        4. 1 instance variables per controller' action
-      )
+      private
+      def create_config_file(path, relative_path, content)
+        file_path = File.join(path, relative_path)
+        if File.directory?(path) && !File.exists?(file_path)
+          File.open(file_path, "w") do |file|
+            file.write(content)
+          end
+        end
+      end
+
+      def version_info
+        # stolen from gem 'bubs' :)
+        "SandiMeter ".tr('A-Za-z1-90', 'Ⓐ-Ⓩⓐ-ⓩ①-⑨⓪').split('').join(' ') + SandiMeter::VERSION
+      end
     end
   end
 end

data/lib/sandi_meter/rules_checker.rb

@@ -1,6 +1,7 @@
 module SandiMeter
   class RulesChecker
-    def initialize(data)
+    def initialize(data, config)
+      @config = config
       @rules = []
       @rules << percentage(data[:first_rule][:small_classes_amount], data[:first_rule][:total_classes_amount])
       @rules << percentage(data[:second_rule][:small_methods_amount], data[:second_rule][:total_methods_amount])
@@ -9,12 +10,12 @@ module SandiMeter
     end
 
     def ok?
-      @rules.all? { |rule| rule == 1 }
+      @rules.reduce(:+) / 4 > @config[:threshold]
     end
 
     private
     def percentage(amount, total)
-      total > 0 ? amount / total : 1
+      total > 0 ? (amount / total.to_f)*100 : 100
     end
   end
 end

data/lib/sandi_meter/version.rb

@@ -1,3 +1,3 @@
 module SandiMeter
-  VERSION = "1.0.5"
+  VERSION = "1.1.5"
 end

data/spec/calculator_spec.rb

@@ -26,4 +26,55 @@ describe SandiMeter::Calculator do
       method_params[2].should eq(6)
     end
   end
+
+  describe "#log_fourth_rule" do
+    context "when there are violations of the fourth rule" do
+      let(:test_class) { test_file_path("10_controller") }
+
+      before do
+        data = analyzer.analyze(test_class)
+        calculator.push(data)
+      end
+
+      it "adds the expected entries to the log" do
+        output = calculator.calculate!(true)
+
+        fourth_rule_log_entry = output[:fourth_rule][:log][:controllers][0]
+        controller_name = fourth_rule_log_entry[0]
+        action = fourth_rule_log_entry[1]
+        instance_variables = fourth_rule_log_entry[2]
+
+        expect(controller_name).to eq "AnotherUsersController"
+        expect(action).to eq "index"
+        expect(instance_variables).to include("@users")
+        expect(instance_variables).to include("@excess_variable")
+        expect(instance_variables.length).to eq 2
+      end
+    end
+    context "when there are no violations of the fourth rule" do
+      let(:test_class) { test_file_path("9_controller") }
+
+      before do
+        data = analyzer.analyze(test_class)
+        calculator.push(data)
+      end
+
+      it "does not add any entries to the log" do
+        output = calculator.calculate!(true)
+        expect(output[:fourth_rule][:log][:controllers]).to eq []
+      end
+    end
+  end
+
+  describe 'no matchig ruby files found' do
+    it 'counts class lines' do
+      output = calculator.calculate!(false)
+      output[:first_rule][:total_classes_amount].should eql(0)
+    end
+
+    it 'counts method lines' do
+      output = calculator.calculate!(true)
+      output[:second_rule][:total_methods_amount].should eql(0)
+    end
+  end
 end

data/spec/rules_checker_spec.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 require_relative '../lib/sandi_meter/rules_checker'
 
 describe SandiMeter::RulesChecker do
-  let(:fail_conditions) do
+  let(:conditions) do
     {
       first_rule:  { small_classes_amount: 1,      total_classes_amount: 2 },
       second_rule: { small_methods_amount: 2,      total_methods_amount: 2 },
@@ -11,22 +11,13 @@ describe SandiMeter::RulesChecker do
     }
   end
 
-  let(:succeed_conditions) do
-    {
-      first_rule:  { small_classes_amount: 2,      total_classes_amount: 2 },
-      second_rule: { small_methods_amount: 2,      total_methods_amount: 2 },
-      third_rule:  { proper_method_calls: 2,       total_method_calls: 2 },
-      fourth_rule: { proper_controllers_amount: 0, total_controllers_amount: 0 }
-    }
-  end
-
   describe "#ok?" do
-    it "returns false in any of conditions fail" do
-      expect(SandiMeter::RulesChecker.new(fail_conditions)).to_not be_ok
+    it "returns false with 100 threshold" do
+      expect(SandiMeter::RulesChecker.new(conditions, {threshold: 100})).to_not be_ok
     end
 
-    it "returns true if all of conditions succeed" do
-      expect(SandiMeter::RulesChecker.new(succeed_conditions)).to be_ok
+    it "returns true with threshold less than 100" do
+      expect(SandiMeter::RulesChecker.new(conditions, {threshold: 50})).to be_ok
     end
   end
 end

data/spec/test_classes/10_controller.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sandi_meter
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.5
 platform: ruby
 authors:
 - Anatoli Makarevich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-03 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler