Rubycritic compare b/w branches #6

HemanthMudalaiah · 2016-11-17T07:05:09Z

No description provided.

… branches

… degraded the code quality

Pushing the status of the code and report location to gitlab using gitlab api

* Code refactoring, DRY * Comparing between branches in local without pr id.

1. Setting a new mode to compare between branches. 2. Moved the code changes to a seperate file. 3. Pushing comments on to pr. 4. Specs for analysed_module_collection.

Upgrade `parser` to `2.3.1.4`. One warning still left which comes from `parser`. Hopefully that is fixed in later versions.

Fix some ruby warnings thrown on rake test

1. Removed Gitlab,Github integrations. 2. Template Changes. 3. Options changes.

1. Added specs for compare module 2. Added threshold as an option in rubycritic before it was as app side configuration 3. Check for any uncommited changes

1. Removed redundant code. 2. Adding config so that browser doesn't open html report during test.

tejasbubane · 2016-11-17T08:00:21Z

lib/rubycritic/cli/options.rb


+          opts.on('-b', '--branch BASE_BRANCH,FEATURE_BRANCH' , 'Set branches') do |branches|
+            self.base_branch = String(branches.split(',')[0].strip)
+            self.feature_branch = String(branches.split(',')[1].strip)


You can use multiple assignment here and use .to_s instead of String()

self.base_branch, self.feature_branch = branches.split(',').map { |b| String(b.strip) }

tejasbubane · 2016-11-17T08:00:49Z

lib/rubycritic/cli/options.rb


      attr_accessor :mode, :root, :format, :deduplicate_symlinks,
-                    :suppress_ratings, :minimum_score, :no_browser, :parser
+                    :suppress_ratings, :minimum_score, :no_browser, :parser, :base_branch, :feature_branch, :threshold_score


line too long

tejasbubane · 2016-11-17T08:21:11Z

lib/rubycritic/commands/compare.rb

+        @files_affected = []
+        @analysed_modules = []
+        @number = 0
+        @code_index_file_location = ''


are these all variables used? If not remove them. Also give better names - eg number is not very intuitive. Also I don't prefer names with data structures like hash, array, etc.

tejasbubane · 2016-11-17T08:22:31Z

lib/rubycritic/commands/compare.rb

+      end
+
+      def update_build_number
+        build_file_location = '/tmp/build_count.txt'


do we need this?

Mention the use of this count file as a comment above the method.

tejasbubane · 2016-11-17T08:23:31Z

lib/rubycritic/commands/compare.rb

+      end
+
+      def set_scores(branch_type, score)
+        branch_type == 'base_branch' ? Config.base_branch_score = score : Config.feature_branch_score = score


Config.send(:"#{branch_type}_score") = score

tejasbubane · 2016-11-17T08:24:45Z

lib/rubycritic/commands/compare.rb

+      end
+
+      def threshold_values_set?
+        Config.threshold_score > 0


if threshold is nil this will fail with undefined method>' for nil:NilClass`

tejasbubane · 2016-11-17T08:27:46Z

test/lib/rubycritic/commands/compare_test.rb

+          true
+        elsif arg == 'feature_branch'
+          true
+        end


What is this? 😳

1. Changes for stub in compare test file 2. Cleaning up compare.rb 3. Changes in option parsing

tejasbubane · 2016-11-18T16:11:14Z

features/command_line_interface/options.feature

          -p, --path [PATH]                Set path where report will be saved (tmp/rubycritic by default)
+          -b BASE_BRANCH,FEATURE_BRANCH,   Set branches
+              --branch
+          -t [THRESHOLD_SCORE],            Set a threshold score


mention that this works only with -b

tejasbubane · 2016-11-18T17:05:16Z

lib/rubycritic/commands/compare.rb

+      end
+
+      def threshold_values_set?
+        Config.threshold_score > 0


tejasbubane · 2016-11-18T17:06:12Z

lib/rubycritic/commands/compare.rb

+      end
+
+      def update_build_number
+        build_file_location = '/tmp/build_count.txt'


Mention the use of this count file as a comment above the method.

tejasbubane · 2016-11-18T17:06:29Z

lib/rubycritic/commands/compare.rb

+
+      def degraded_files
+        files_affected = []
+        @feature_branch.each do |key, value|


use map instead of each

tejasbubane · 2016-11-18T17:10:08Z

test/lib/rubycritic/core/analysed_modules_collection_test.rb

+      let(:analysed_modules) { [RubyCritic::AnalysedModule.new(pathname: Pathname.new('test/samples/empty.rb'), name: 'Empty'),
+                                RubyCritic::AnalysedModule.new(pathname: Pathname.new('test/samples/unparsable.rb'), name: 'Unparsable'),
+                                ] 
+                              }


use do-end for multi-line blocks.

New Web UI

Bump to v3.1.0

Add screenshots of new ui in README

vijayanandnandam · 2016-11-24T03:55:10Z

@HemanthMudalaiah get this done quickly and raise PR on rubycritic

tejasbubane · 2016-11-24T06:14:22Z

lib/rubycritic/commands/compare.rb

+
+      def build_details
+        details = "Base branch (#{Config.base_branch}) score: " + Config.base_branch_score.to_s + "\n"
+        details += "Feature branch (#{Config.feature_branch}) score: " + Config.feature_branch_score.to_s + "\n"


use multi-line string

tejasbubane · 2016-11-24T06:15:39Z

lib/rubycritic/commands/compare.rb

+      end
+
+      def degraded_files
+        files_affected = []


remove this, return array from map

tejasbubane · 2016-11-24T06:16:26Z

lib/rubycritic/commands/compare.rb

+      end
+
+      def build_cost_hash(cost_hash, analysed_modules)
+        complexity_hash = eval("@#{cost_hash}")


remove eval

tejasbubane · 2016-11-24T06:16:47Z

lib/rubycritic/commands/compare.rb

+
+      def build_cost_hash(cost_hash, analysed_modules)
+        complexity_hash = eval("@#{cost_hash}")
+        analysed_modules.map { |analysed_module| complexity_hash.merge!(:"#{analysed_module.name}" => analysed_module.cost) }


line is too long

tejasbubane · 2016-11-24T06:39:02Z

test/lib/rubycritic/commands/compare_test.rb

+    class Git < Base
+      def self.switch_branch(branch)
+        File.open('test/samples/compare_file.rb', 'w') { |file| file.truncate(0) }
+        File.open('test/samples/compare_file.rb', 'w') { |file| file.puts File.readlines("test/samples/#{branch}_file.rb") }


line too long

1. Generating report for all modified files in the feature branch instead of degraded files as before. 2. Removing methods related to get degraded files. 3. Fixing specs due the above changse.

tejasbubane · 2016-11-25T06:29:58Z

lib/rubycritic/commands/compare.rb

+      def execute
+        Config.no_browser = true
+        compare_branches
+        status_reporter.score = (Config.base_branch_score - Config.feature_branch_score).abs


tell whether score has increased or decreased in the console output.

tejasbubane · 2016-11-25T06:35:35Z

lib/rubycritic/commands/compare.rb

+      # create a txt file with the branch score details
+      def build_details
+        details = "Base branch (#{Config.base_branch}) score: " + Config.base_branch_score.to_s + "\n"\
+                  "Feature branch (#{Config.feature_branch}) score: " + Config.feature_branch_score.to_s + "\n"


use string interpolation