overrides_tracker 0.1.9 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3c000898709ba57b70473aa59fd6390dab44ceb1bb6b2f254a8ce42616cbbb7
-  data.tar.gz: fed1aa5117754b7a37794212b74af9ed78aa07a31b3d61710f076cf528d6fd6a
+  metadata.gz: 219f854619f81277c8acbec980e72ecd29baff6ce9977a5411dc75108c367a97
+  data.tar.gz: 6df617ee3d8c9859cd0e9e02e5209a5a19679cc7f5a7e657da3a53892ab049c1
 SHA512:
-  metadata.gz: 3777aba73755ad0bca136387d9cc80408aafc2e1d44516e4b5ab0ba700855c317483ae92815ef642e5a53e818a15b18bfc88b96b0f15628c0f85b1affac9c9f9
-  data.tar.gz: 9c880fb7d42d64357ed24d855a19c913892f7e98c775e17bf254e88b5a9686ed28ff56f9aecc0cc7c3ce30cadf5534ca132b649306c313584fc2239e6eaaea43
+  metadata.gz: 19c3852c01f26cd97c46e95367294a7246d277e9e0c47f8d5e3b65e80d0c899a5344bd82eafdadea51e784e88c745f6a4fac7115342135ba657d6d92f2c83002
+  data.tar.gz: f1a918217ab3df5971148dc95a95276ba5d2de07d973bd6a631a4789252cfce1f6985ac0c6f01466eaf439f1495dbbda1fc9bc2c5343979c718ed4ddc8b6dc6e

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/.gitignore

@@ -1,2 +1,5 @@
 .DS_Store
-*.gem
+*.gem
+
+coverage/*
+.rspec_status

data/Gemfile

@@ -1,6 +1,15 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+group :development do
+  gem 'coveralls_reborn', '~> 0.25.0', require: false
+  gem 'rspec'
+  gem 'rspec_junit_formatter'
+  gem 'rubocop', require: false
+  gem 'simplecov', require: false
+  gem 'simplecov-lcov', '~> 0.8.0'
+end
 
 # Specify your gem's dependencies in overrides_tracker.gemspec
 gemspec
@@ -11,4 +20,4 @@ if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('1.9')
 else
   gem 'vcr', '>= 2.9'
   gem 'webmock', '>= 1.20'
-end
+end

data/Gemfile.lock

@@ -0,0 +1,109 @@
+PATH
+  remote: .
+  specs:
+    overrides_tracker (0.1.11)
+      activesupport
+      method_source
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.7)
+      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.1.10)
+    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.16.3)
+    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.5)
+      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

@@ -1,6 +1,10 @@
 # Overrides Tracker
 Overrides Tracker keeps track of all overriding methods in your project and allows for comparison across branches.
 
+[![Gem Version](https://badge.fury.io/rb/overrides_tracker.svg)](https://badge.fury.io/rb/overrides_tracker)
+[![Coverage Status](https://coveralls.io/repos/github/SyborgStudios/overrides_tracker/badge.svg?branch=master)](https://coveralls.io/github/SyborgStudios/overrides_tracker?branch=master)
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/SyborgStudios/overrides_tracker/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/SyborgStudios/overrides_tracker/tree/master)
+
 ## Contact
 
 *Code and Bug Reports*
@@ -16,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
@@ -43,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.
 
@@ -59,68 +63,124 @@ 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.
+
+Sometimes that is not enough:
+
+If you need further requirements, you can just add a .overrides_tracker folder and add a requirements.rb file to it.
+In that one you can just require the classes your gem depends on. 
+
+You can also use the ['require_all'](https://github.com/jarmo/require_all) way to include complete folders, filter files etc..
+
 ## 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
 
@@ -137,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/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "overrides_tracker"
+require 'bundler/setup'
+require 'overrides_tracker'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "overrides_tracker"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/overrides_tracker

@@ -1,35 +1,53 @@
 #!/usr/bin/env ruby
-if ARGV[0] == "track"
-    # We set this constant so  monkey patching of the gem is only done when checking the overrides
-    puts 'Reading all methods...'
-    OVERRIDES_TRACKER_TRACKING_ENABLED = true
-    require Dir.pwd+'/config/environment.rb'
-    require 'overrides_tracker'
+if ARGV[0] == 'track'
+  # We set this constant so  monkey patching of the gem is only done when checking the overrides
 
-    OverridesTracker::MethodsCollector.instance.build_overrides_hash
-    OverridesTracker::MethodsCollector.instance.save_to_file
+  OVERRIDES_TRACKER_TRACKING_ENABLED = true
+  require 'overrides_tracker'
 
-    if ENV['OVERRIDES_API_TOKEN']
-      OverridesTracker::MethodsCollector.instance.report(ENV['OVERRIDES_API_TOKEN'])
-    elsif !ARGV[1].nil?
-      OverridesTracker::MethodsCollector.instance.report(ARGV[1])
+  app_environment_file = Dir.pwd + '/config/environment.rb'
+  if File.exist?(app_environment_file) 
+    #We are in a Rails app
+    puts 'Reading all methods...'
+    require  app_environment_file
+  else
+    #We are in a gem
+    puts 'Looking for .overrides_tracker/requierements.rb file for extra requirements...'
+    require 'external/require_all'
+    gem_requirements_file = Dir.pwd + '/.overrides_tracker/requirements.rb'
+
+    if File.exist?(gem_requirements_file) 
+      puts 'Reading all methods...'
+      require gem_requirements_file
     else
-      #puts 'No OVERRIDES_API_TOKEN was set. The report will not be uploaded to overrides.io.'
-      #puts ''
-      #puts 'Have no idea what overrides.io is about? Check it out at https://www.overrides.com'
+      puts 'Reading all methods...'
     end
 
-elsif ARGV[0] == "compare"
+   
+    require_all 'lib/**/*.rb', base_dir: Dir.pwd
+    require_all 'app/**/*.rb', base_dir: Dir.pwd
+  end
+  
+  OverridesTracker::MethodsCollector.instance.build_overrides_hash
+  OverridesTracker::MethodsCollector.instance.save_to_file
+
+  if ENV['OVERRIDES_API_TOKEN']
+    OverridesTracker::MethodsCollector.instance.report(ENV['OVERRIDES_API_TOKEN'])
+  elsif !ARGV[1].nil?
+    OverridesTracker::MethodsCollector.instance.report(ARGV[1])
+  end
+
+elsif ARGV[0] == 'compare'
   require 'overrides_tracker'
   OverridesTracker::Comparer.compare
 
   unless ENV['OVERRIDES_API_TOKEN']
     puts ''
-    #puts 'Have you heard of overrides.io?'
-    #puts 'It integrates with your CI pipeline and notifies you whenever original methods are changing or disappearing.'
-    #puts 'Check it out at https://www.overrides.com'
-  end  
-elsif ARGV[0] == "report"
+    # puts 'Have you heard of overrides.io?'
+    # puts 'It integrates with your CI pipeline and notifies you whenever original methods are changing or disappearing.'
+    # puts 'Check it out at https://www.overrides.com'
+  end
+elsif ARGV[0] == 'report'
   require 'overrides_tracker'
 
   if ENV['OVERRIDES_API_TOKEN']