overrides_tracker 0.1.12 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66085bc82fe4b27b6fc5672a257751effdac97f3ee0492b2764b6a6ccd721ae3
-  data.tar.gz: 2f93dc7369c1b9dc2cf87c737d037167c44bc6e42e83e708aebd56d1b3b4d477
+  metadata.gz: 43cf4d931371c4f3781a672310dc100f2a6ec14ebff9d75113c3d0d1b5c336fb
+  data.tar.gz: ab49ef6c8b619543497708efd105451ad718450900a0d171ff2dde092b045239
 SHA512:
-  metadata.gz: 501e4191f85c326858b8dac38f5db8a6f434f2d0dd49131e0b8bd72ce276e652296a97bac278609424c25475d6626fec7101939a01294387da0376274455b2c4
-  data.tar.gz: de27da503a2ad558f38d186b1d3056771029e907cde457f2de62ff37857e5285a53a1849de67322e2e37ffb9ef97b17bb30d6c655d3474ae9eabdf9c5759a13e
+  metadata.gz: d84a9f391b0c4b25fe4f6c661fe001eb081265b8adb8d03913481382e9387e86598aa90dff56b16808ab5793a7f493cd88e0a86f3bd2ecdaefb8fc5b86d1f362
+  data.tar.gz: 7fd010bfa2cc019ff906bbe192005deaf43234f9772f27c5eed835ac031ae7679cff57662f840b5a4a102257c4a6cbb8f9c9767af90e28c13d06763724f1f590

data/.circleci/config.yml

@@ -0,0 +1,20 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@1.0.4
+  coveralls: coveralls/coveralls@1.0.6
+jobs:
+  test:
+    docker:
+      - image: cimg/ruby:2.7.2-node
+    steps:
+      - checkout
+      - ruby/install-deps
+      - run:
+          name: Run tests
+          command: bundle exec rspec
+ 
+workflows:
+  version: 2
+  deploy:
+    jobs:
+      - test

data/Gemfile.lock

@@ -0,0 +1,109 @@
+PATH
+  remote: .
+  specs:
+    overrides_tracker (0.1.13)
+      activesupport
+      method_source
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.7.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.0)
+    coveralls_reborn (0.25.0)
+      simplecov (>= 0.18.1, < 0.22.0)
+      term-ansicolor (~> 1.6)
+      thor (>= 0.20.3, < 2.0)
+      tins (~> 1.16)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    method_source (1.0.0)
+    minitest (5.17.0)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.40.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-lcov (0.8.0)
+    simplecov_json_formatter (0.1.4)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.2.1)
+    tins (1.32.1)
+      sync
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls_reborn (~> 0.25.0)
+  overrides_tracker!
+  rspec
+  rspec_junit_formatter
+  rubocop
+  simplecov
+  simplecov-lcov (~> 0.8.0)
+  vcr (>= 2.9)
+  webmock (>= 1.20)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -20,7 +20,7 @@ Getting started
     ```ruby
     gem 'overrides_tracker', group: [:test, :development]
     ```
-2. Add `overrides_tracker/*.otf` to your .gitignore file because you do won't to keep hold of your report file when changing branches.
+2. Add `overrides_tracker/*.otf` to your .gitignore file because you want to keep hold of your report file when switching branches.
 
 3. Track you overrides by running:
     ```ruby
@@ -47,7 +47,7 @@ Getting started
     Report saved to /PATH_TO_PROJECT/overrides_tracker/BRANCH_NAME#LAST_COMMIT_ID.otf
     ```
 
-4. This will create a folder called overrides_tracker and creates a file containing all overriding methods of your branch.
+4. This will create a folder called overrides_tracker and a file containing all methods you override as well as your overrides in that branch.
 
 5. Switch branch and follow steps 1-3 again. If you want to compare multiple branches you need to redo these steps for every branch.
 
@@ -63,65 +63,110 @@ Getting started
     ```
     ===========================================================================================
 
-    1) BClass#a_instance_method_override: No Changes
+    1) Override: OrdinaryGem::AnotherTypicalClass#a_singleton_method_that_stays_the_same
 
-    ===========================================================================================
+    ...........................................................................................
 
-    2)....
-    .
-    .
-    .
+    main#cc5a31dc4833734a177f01bd161047f8c7909e16.otf
+    -------------------------------------------------------------------------------------------
 
-    ===========================================================================================
+    Original:
 
-    26) YClass#a_singelton_method_override: Changes between files
+    def self.a_singleton_method_that_stays_the_same
+      "This is the implementation of a simple singleton method."
+      "This method will stay the same in the next version."
+    end
 
-    in: master#528a0206d8f7cfe08737193659f85e28ccb260eb.otf
-    YClass#a_singelton_method_override:
 
-    Source:
-    def self.a_singelton_method_override
-      does_stuff_one_way
-    end
+    in BUNDLE_PATH/bundler/gems/ordinary-gem-e67e062189bb/lib/ordinary_gem/another_typical_class.rb:19
+
 
-    ../.rbenv/versions/2.3.8/lib/ruby/gems/2.3.0/bundler/gems/some_gem/lib/some_gem/y_class.rb:2
+    -------------------------------------------------------------------------------------------
 
     Override:
-    def self.a_singelton_method_override
-      does_stuff_one_way_but_slitly_different
+
+    def self.a_singleton_method_that_stays_the_same
+      "This is our override of a simple singleton method."
+      "This method should stay the same in the next version."
     end
 
-    /PATH_TO_PROJECT/app/models/decorators/y_class_decorator.rb:13
+
+    in: APP_PATH/app/models/ordinary_gem/another_typical_class_monkey_patch.rb:2
 
 
-    in: upgrade_to_latest#beadcdd8e07a2c9dc2aefddeef04fc42e6fff0d5.otf
-    YClass#a_singelton_method_override:
 
-    Source:
-    def self.a_singelton_method_override
-      does_stuff_in_a_different_way
+    ...........................................................................................
+
+    attached-to-next-version#a7231014c006a4a5848eb4d92bb465eb5c89ee01.otf
+    -------------------------------------------------------------------------------------------
+
+    Original:
+
+    def self.a_singleton_method_that_stays_the_same
+      "This is the implementation of a simple singleton method."
+      "This method will stay the same in the next version."
     end
 
-    ../.rbenv/versions/2.3.8/lib/ruby/gems/2.3.0/bundler/gems/some_gem/lib/some_gem/y_class.rb:2
+
+    in BUNDLE_PATH/bundler/gems/ordinary-gem-f92e5a1a70a6/lib/ordinary_gem/another_typical_class.rb:13
+
+
+    -------------------------------------------------------------------------------------------
 
     Override:
-    def self.a_singelton_method_override
-      does_stuff_one_way_but_slitly_different
+
+    def self.a_singleton_method_that_stays_the_same
+      "This is our override of a simple singleton method."
+      "This method should stay the same in the next version."
     end
 
-    /PATH_TO_PROJECT/app/models/decorators/y_class_decorator.rb:13
 
+    in: APP_PATH/app/models/ordinary_gem/another_typical_class_monkey_patch.rb:2
+
+
+
+    ...........................................................................................
+
+    main#1d279724b26c9491e6e5a01e9711b61a73e9f7e0.otf
+    Method not available
+
+
+
+
+
+    ...........................................................................................
+    .
+    .
+    .
+    .
     ===========================================================================================
 
     Summary:
-    Found 29 distinct overridden methods
-    10 overridden methods have not changed
-    19 overridden methods have changed
-    1 where method is not an override
-    4 where method is not in codebase
-    15 source method bodies have changed
+
+    Investigated methods: 70
+    Diffences on overrides: 42
+    Diffences on added methods: 28
+
     ```
-    
+
+## Overrides.io integration
+<img width="1000" alt="Bildschirm­foto 2023-01-10 um 21 39 42" src="https://user-images.githubusercontent.com/9799974/211657428-c2a7e272-ae86-4c1c-8e77-0a07acc1a4a0.png">
+
+Overrides.io is a service that monitors code you override for changes. It notifies you whenever those changes occur.
+Additionally it gives you a beautiful overview of all the methods you have overridden as well as your overrides side by side.
+<p float="left">
+<img width="500" alt="Bildschirm­foto 2023-01-10 um 21 39 15" src="https://user-images.githubusercontent.com/9799974/211658325-60c21057-1a07-4b55-a4d5-3d82470fb3ee.png">
+<img width="500" alt="Bildschirm­foto 2023-01-10 um 21 39 28" src="https://user-images.githubusercontent.com/9799974/211658362-f50435dd-56c5-498b-9038-f702addb0717.png">
+</p>
+Overrides Tracker can easily be integrated into you CI/CD pipeline and configured to send the result files to overrides.io.
+
+You basically just have to set OVERRIDES_API_TOKEN environment variable and call 'bundle exec overrides_tracker track'.
+To push it to overrides.io locally you could also just call 'bundle exec overrides_tracker track YOUR_OVERRIDES_API_TOKEN'.
+
+You can find a detailed description how to integrate it with CircleCI, GitHub Action and Jenkins here:
+
+https://www.overrides.io/continuous_integration
+
 ## GEM support
 
 Overrides Tracker can also be used on GEMs. It will autoload all classes in the lib and app folders.
@@ -135,7 +180,7 @@ You can also use the ['require_all'](https://github.com/jarmo/require_all) way t
 
 ## Ruby version compatibility
 
-OverridesTracker is built in [Continuous Integration] on Ruby 2.3+.
+Overrides Tracker is built in [Continuous Integration] on Ruby 2.3+.
 
 ## Code of Conduct
 
@@ -152,4 +197,4 @@ Everyone participating in this project's development, issue trackers and other c
 
 ## Copyright
 
-Copyright (c) 2022 Simon Meyborg. See MIT-LICENSE for details.
+Copyright (c) 2023 Simon Meyborg. See MIT-LICENSE for details.

data/bin/overrides_tracker

@@ -29,6 +29,7 @@ if ARGV[0] == 'track'
   end
   
   OverridesTracker::MethodsCollector.instance.build_overrides_hash
+  OverridesTracker::MethodsCollector.instance.summarize_overrides
   OverridesTracker::MethodsCollector.instance.save_to_file
 
   if ENV['OVERRIDES_API_TOKEN']

data/lib/external/require_all.rb

@@ -0,0 +1,252 @@
+#--
+# Copyright (C)2009 Tony Arcieri
+# You can redistribute this under the terms of the MIT license
+# See file LICENSE for details
+#++
+
+module RequireAll
+  LoadError = Class.new(::LoadError)
+
+  # A wonderfully simple way to load your code.
+  #
+  # The easiest way to use require_all is to just point it at a directory
+  # containing a bunch of .rb files.  These files can be nested under 
+  # subdirectories as well:
+  #
+  #  require_all 'lib'
+  #
+  # This will find all the .rb files under the lib directory and load them.
+  #
+  # If a file required by require_all references a constant that is not yet
+  # loaded, a RequireAll::LoadError will be thrown.
+  #
+  # You can also give it a glob, which will enumerate all the matching files: 
+  #
+  #  require_all 'lib/**/*.rb'
+  #
+  # It will also accept an array of files:
+  #
+  #  require_all Dir.glob("blah/**/*.rb").reject { |f| stupid_file(f) }
+  # 
+  # Or if you want, just list the files directly as arguments:
+  #
+  #  require_all 'lib/a.rb', 'lib/b.rb', 'lib/c.rb', 'lib/d.rb'
+  #
+  def require_all(*args)
+    # Handle passing an array as an argument
+    args.flatten!
+
+    options = {method: :require}
+    options.merge!(args.pop) if args.last.is_a?(Hash)
+
+    if args.empty?
+      puts "no files were loaded due to an empty Array" if $DEBUG
+      return false
+    end
+
+    if args.size > 1
+      # Expand files below directories
+      files = args.map do |path|
+        if File.directory? path
+          Dir[File.join(path, '**', '*.rb')]
+        else
+          path
+        end
+      end.flatten
+    else
+      arg = args.first
+      begin
+        # Try assuming we're doing plain ol' require compat
+        stat = File.stat(arg)
+
+        if stat.file?
+          files = [arg]
+        elsif stat.directory?
+          files = Dir.glob File.join(arg, '**', '*.rb')
+        else
+          raise ArgumentError, "#{arg} isn't a file or directory"
+        end
+      rescue SystemCallError
+        # If the stat failed, maybe we have a glob!
+        files = Dir.glob arg
+
+        # Maybe it's an .rb file and the .rb was omitted
+        if File.file?(arg + '.rb')
+          file = arg + '.rb'
+          options[:method] != :autoload ? __require(options[:method], file) : __autoload(file, file, options)
+          return true
+        end
+
+        # If we ain't got no files, the glob failed
+        #raise LoadError, "no such file to load -- #{arg}" if files.empty?
+      end
+    end
+
+    return if files.empty?
+
+    if options[:method] == :autoload
+      files.map! { |file_| [file_, File.expand_path(file_)] }
+      files.each do |file_, full_path|
+        __autoload(file_, full_path, options)
+      end
+
+      return true
+    end
+
+    files.map { |file_| File.expand_path file_ }.sort.each do |file_|
+      begin
+        __require(options[:method], file_)
+      rescue NameError => e
+        # Only wrap NameError exceptions for uninitialized constants
+        #raise e unless e.instance_of?(NameError) && e.message.include?('uninitialized constant')
+        #raise LoadError, "Could not require #{file_} (#{e}). Please require the necessary files"
+      end
+    end
+
+    true
+  end
+
+  # Works like require_all, but paths are relative to the caller rather than 
+  # the current working directory
+  def require_rel(*paths)
+    # Handle passing an array as an argument
+    paths.flatten!
+    return false if paths.empty?
+
+    source_directory = File.dirname caller.first.sub(/:\d+$/, '')
+    paths.each do |path|
+      require_all File.join(source_directory, path)
+    end
+  end
+
+  # Loads all files like require_all instead of requiring
+  def load_all(*paths)
+    require_all paths, method: :load
+  end
+
+  # Loads all files by using relative paths of the caller rather than
+  # the current working directory
+  def load_rel(*paths)
+    paths.flatten!
+    return false if paths.empty?
+
+    source_directory = File.dirname caller.first.sub(/:\d+$/, '')
+    paths.each do |path|
+      require_all File.join(source_directory, path), method: :load
+    end
+  end
+
+  # Performs Kernel#autoload on all of the files rather than requiring immediately.
+  #
+  # Note that all Ruby files inside of the specified directories should have same module name as
+  # the directory itself and file names should reflect the class/module names.
+  # For example if there is a my_file.rb in directories dir1/dir2/ then
+  # there should be a declaration like this in my_file.rb:
+  #   module Dir1
+  #     module Dir2
+  #       class MyFile
+  #         ...
+  #       end
+  #     end
+  #  end
+  #
+  # If the filename and namespaces won't match then my_file.rb will be loaded into wrong module!
+  # Better to fix these files.
+  #
+  # Set $DEBUG=true to see how files will be autoloaded if experiencing any problems.
+  #
+  # If trying to perform autoload on some individual file or some inner module, then you'd have
+  # to always specify *:base_dir* option to specify where top-level namespace resides.
+  # Otherwise it's impossible to know the namespace of the loaded files.
+  #
+  # For example loading only my_file.rb from dir1/dir2 with autoload_all:
+  #
+  #   autoload_all File.dirname(__FILE__) + '/dir1/dir2/my_file',
+  #                base_dir: File.dirname(__FILE__) + '/dir1'
+  #
+  # WARNING: All modules will be created even if files themselves aren't loaded yet, meaning
+  # that all the code which depends of the modules being loaded or not will not work, like usages
+  # of define? and it's friends.
+  #
+  # Also, normal caveats of using Kernel#autoload apply - you have to remember that before
+  # applying any monkey-patches to code using autoload, you'll have to reference the full constant
+  # to load the code before applying your patch!
+
+  def autoload_all(*paths)
+    paths.flatten!
+    return false if paths.empty?
+    require "pathname"
+
+    options = {method: :autoload}
+    options.merge!(paths.pop) if paths.last.is_a?(Hash)
+
+    paths.each do |path|
+      require_all path, {base_dir: path}.merge(options)
+    end
+  end
+
+  # Performs autoloading relatively from the caller instead of using current working directory
+  def autoload_rel(*paths)
+    paths.flatten!
+    return false if paths.empty?
+    require "pathname"
+
+    options = {method: :autoload}
+    options.merge!(paths.pop) if paths.last.is_a?(Hash)
+
+    source_directory = File.dirname caller.first.sub(/:\d+$/, '')
+    paths.each do |path|
+      file_path = Pathname.new(source_directory).join(path).to_s
+      require_all file_path, {method: :autoload,
+                              base_dir: source_directory}.merge(options)
+    end
+  end
+
+  private
+
+  def __require(method, file)
+    Kernel.send(method, file)
+  end
+
+  def __autoload(file, full_path, options)
+    last_module = "Object" # default constant where namespaces are created into
+    begin
+      base_dir = Pathname.new(options[:base_dir]).realpath
+    rescue Errno::ENOENT
+      raise LoadError, ":base_dir doesn't exist at #{options[:base_dir]}"
+    end
+    Pathname.new(file).realpath.descend do |entry|
+      # skip until *entry* is same as desired directory
+      # or anything inside of it avoiding to create modules
+      # from the top-level directories
+      next if (entry <=> base_dir) < 0
+
+      # get the module into which a new module is created or
+      # autoload performed
+      mod = Object.class_eval(last_module)
+
+      without_ext = entry.basename(entry.extname).to_s
+
+      const =
+        if defined? ActiveSupport::Inflector
+          ActiveSupport::Inflector.camelize(without_ext)
+        else
+          without_ext.split("_").map {|word| word.capitalize}.join
+        end
+
+      if entry.file? || (entry.directory? && entry.sub_ext('.rb').file?)
+        mod.class_eval do
+          puts "autoloading #{mod}::#{const} from #{full_path}" if $DEBUG
+          autoload const, full_path
+        end
+      else
+        mod.class_eval "module #{const} end" if entry.directory?
+      end
+
+      last_module += "::#{const}" if entry.directory?
+    end
+  end
+
+end
+
+include RequireAll

data/lib/overrides_tracker/comparer.rb

@@ -111,9 +111,11 @@ class OverridesTracker::Comparer
               if is_source_changed_flag
                 line_differerence_array = []
                 all_methods_collections.each do |build_id, all_methods_hash|
+                  begin
+                    line_differerence_array << method_result_hash[:builds][build_id][:original_body].split(/\n/)
+                  rescue 
 
-                  line_differerence_array << method_result_hash[:builds][build_id][:original_body].split(/\n/)
-                  
+                  end
                   if method_result_hash[:builds][build_id][:result] == 'override_has_changed'
                     numbers[:overrides][:override_changed_count] -= 1
                     numbers[:overrides][:source_changed_count] += 1
@@ -130,11 +132,13 @@ class OverridesTracker::Comparer
               if is_override_changed_flag
                 line_differerence_array = []
                 begin
+                  begin
+                    all_methods_collections.each do |build_id, all_methods_hash|
+                      line_differerence_array << method_result_hash[:builds][build_id][:overriding_body].split(/\n/)
+                    end
+                  rescue
 
-                  all_methods_collections.each do |build_id, all_methods_hash|
-                    line_differerence_array << method_result_hash[:builds][build_id][:overriding_body].split(/\n/)
                   end
-               
                   max_length = line_differerence_array.map(&:length).max
                   transposed_array = line_differerence_array.map{|e| e.values_at(0...max_length)}.transpose
                   method_result_hash[:overriding_mark_lines] = transposed_array.map.with_index{|val, index| val.uniq.size > 1 ? index : nil}.compact

data/lib/overrides_tracker/hash_decorator.rb

@@ -0,0 +1,41 @@
+# Adding deep merge functionality
+Hash.class_eval do
+  def deep_merge(other_hash, &block)
+    dup.deep_merge!(other_hash, &block)
+  end
+
+  def deep_merge!(other_hash, &block)
+    merge!(other_hash) do |key, this_val, other_val|
+      if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+        this_val.deep_merge(other_val, &block)
+      elsif block_given?
+        block.call(key, this_val, other_val)
+      else
+        other_val
+      end
+    end
+  end
+
+  def deep_stringify_keys!
+    deep_transform_keys!(&:to_s)
+  end
+
+  def deep_transform_keys!(&block)
+    _deep_transform_keys_in_object!(self, &block)
+  end
+
+  def _deep_transform_keys_in_object!(object, &block)
+    case object
+    when Hash
+      object.keys.each do |key|
+        value = object.delete(key)
+        object[yield(key)] = _deep_transform_keys_in_object!(value, &block)
+      end
+      object
+    when Array
+      object.map! { |e| _deep_transform_keys_in_object!(e, &block) }
+    else
+      object
+    end
+  end
+end