deprecations_detector 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14223f744285f1f73bc7453f2de6a42a9a8f87b599393cb67fb9345043be5f14
+  data.tar.gz: e1879d540ed9af626488355929a378cfbb71b83b6b9775411a7420173f65dcfc
+SHA512:
+  metadata.gz: 296a9a4345d4aa010f62cd1f967430d3cf40896dbb6361b50fd8b8f8c39e652ce2b44fb464ab91bb78f4c123a786f0702d3dc460d6428b9844457d6eb1ec8dcb
+  data.tar.gz: 14b1e67170d3e0586f6c56e7c9dd9573bc2998895aeb2f792c9afce7252dcc48e03c5c111473744b7f4f8906610652143622ef13181ad995b4a7e886f13fbb68

data/.gitignore

@@ -0,0 +1,56 @@
+*.rbc
+capybara-*.html
+.rspec
+.rspec_status
+.rubocop-*
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+*.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out this rule if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/master.key
+
+# Only include if you have production secrets in this file, which is no longer a Rails default
+# config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+Gemfile.lock
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# Ignore node_modules
+node_modules/
+
+# Others
+spec/faked_project/tmp/deprecations_detector.yml
+
+tmp/

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require:
+  - rubocop-rspec
+
+inherit_from:
+  - https://relaxed.ruby.style/rubocop.yml
+
+Metrics/BlockLength:
+  Exclude:
+    - config/routes.rb
+    - db/seeds/**/*
+    - spec/**/*
+
+RSpec/MultipleExpectations:
+  Max: 5
+  # Default is 1
+
+RSpec/ExampleLength:
+  Max: 20
+  # Default is 5
+
+AllCops:
+  TargetRubyVersion: 1.9

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in deprecations_detector.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Nebulab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nebulab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+[![Gem Version](https://badge.fury.io/rb/deprecations_detector.svg)](https://badge.fury.io/rb/deprecations_detector)
+
+# DeprecationsDetector
+
+The goal of this component is to collect and list all the deprecation of the project visually.
+
+## Installation
+
+Add `gem 'deprecations_detector', git: 'https://github.com/nebulab/deprecations_detector'` to your application's Gemfile and execute `bundle`.
+
+Put the following code under you specs configuration:
+
+```ruby
+require 'deprecations_detector'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DeprecationsDetector::Main.start
+  end
+
+  config.around do |e|
+    e.run
+    DeprecationsDetector::Main.add(e)
+  end
+
+  config.after(:suite) do
+    DeprecationsDetector::Main.save_results
+    coverage_matrix = DeprecationsDetector::Main.coverage_matrix
+    DeprecationsDetector::Formatters::HTML::Formatter.new.format(coverage_matrix)
+  end
+end
+```
+
+# Run it on multiple jobs
+
+Sometimes specs are run concurrently on multiple jobs. In order to collect the result on one file this gem provides some
+helpful task to combine the result in one single file and then format it.
+
+1. Remove the formatter from the after(:suite) hook
+2. Make the task available on your application following the instruction under `Tasks` section.
+3. Save the coverage result on the same directory with different name for any job (e.g. tmp/deps/a.yml, tmp/deps/b.yml etc..)
+4. Run the task to combine the YAML files `bundle exec rake 'deprecations:combine[tmp/deps/,deprecations_detector.yml]'`
+5. Run the task to format the YAML to HTML `bundle exec rake 'deprecations:format[tmp/deps/,deprecations_detector.yml]'`
+
+## Tasks
+
+Add the following lines on your Rakefile to make the DeprecationsDetector tasks available from your application:
+
+```
+spec = Gem::Specification.find_by_name 'deprecations_detector'
+load "#{spec.gem_dir}/lib/tasks/deprecations/combine.rake"
+load "#{spec.gem_dir}/lib/tasks/deprecations/format.rake"
+```
+
+## Testing
+
+Execute `bundle exec rspec` on the component root path, specs are based on an internal fake project.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nebulab/deprecations_detector. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+DeprecationsDetector is copyright © 2023 [Nebulab](http://nebulab.it/). It is free software, and may be redistributed under the terms specified in the [license](LICENSE.txt).
+Inspired by ReverseCoverage
+
+## About
+
+![Nebulab](http://nebulab.it/assets/images/public/logo.svg)
+
+DeprecationsDetector is funded and maintained by the [Nebulab](http://nebulab.it/) team.
+
+We firmly believe in the power of open-source. [Contact us](http://nebulab.it/contact-us/) if you like our work and you need help with your project design or development.

data/Rakefile

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'pry'
+require 'yaml'
+
+RSpec::Core::RakeTask.new(:spec)
+
+import './lib/tasks/deprecations/combine.rake'
+import './lib/tasks/deprecations/format.rake'
+
+task default: :spec
+
+namespace :assets do
+  desc "Compiles all assets"
+  task :compile do
+    puts "Compiling assets"
+    require "sprockets"
+    base_path = 'lib/deprecations_detector/formatters/html'
+    assets = Sprockets::Environment.new
+    assets.append_path "#{base_path}/assets/javascripts"
+    assets.append_path "#{base_path}/assets/stylesheets"
+    assets["application.js"].write_to("#{base_path}/public/application.js")
+    assets["settings.js"].write_to("#{base_path}/public/settings.js")
+    assets["application.css"].write_to("#{base_path}/public/application.css")
+  end
+end

data/deprecations_detector.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'deprecations_detector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'deprecations_detector'
+  spec.version       = DeprecationsDetector::VERSION
+  spec.summary       = 'A tool to find what specs examples cover a specific line of code'
+  spec.description   = spec.summary
+  spec.license       = 'MIT'
+  spec.authors       = ['Daniele Palombo']
+  spec.email         = ['danielepalombo@nebulab.com']
+  spec.homepage      = 'https://github.com/nebulab/deprecations_detector'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|extra)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'activesupport'
+  spec.add_development_dependency 'pry'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.67.2'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.1.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.32.0'
+
+  spec.add_development_dependency 'sass', '~> 3.7.4' # TODO: replace with sassc
+  spec.add_development_dependency 'sprockets', '~> 3.7.2'
+end

data/lib/deprecations_detector/active_support/deprecation_decorator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DeprecationsDetector
+  module ActiveSupport
+    module DeprecationDecorator
+      def warn(message = nil, callstack = caller)
+        DeprecationsDetector::Main.add_deprecation(message, caller)
+
+        return if DeprecationsDetector::Main.suppress_deprecations
+
+        super(message, callstack)
+      end
+
+      ::ActiveSupport::Deprecation.prepend(self)
+    end
+  end
+end

data/lib/deprecations_detector/formatters/html/assets/javascripts/application.js

@@ -0,0 +1,213 @@
+//= require_directory ./libraries/
+//= require_directory ./plugins/
+//= require treeview.js
+//= require_self
+
+$(document).ready(function() {
+  // Configuration for fancy sortable tables for source file groups
+  $('.file_list').dataTable({
+    "aaSorting": [[ 0, "asc" ]],
+    "bPaginate": false,
+    "bJQueryUI": true,
+    "aoColumns": [
+      null,
+      null,
+      null
+    ]
+  });
+
+  // Syntax highlight all files up front - deactivated
+  // $('.source_table pre code').each(function(i, e) {hljs.highlightBlock(e, '  ')});
+
+  // Syntax highlight source files on first toggle of the file view popup
+  $("a.src_link").click(function() {
+    // Get the source file element that corresponds to the clicked element
+    var source_table = $($(this).attr('href'));
+
+    // If not highlighted yet, do it!
+    if (!source_table.hasClass('highlighted')) {
+      source_table.find('pre code').each(function(i, e) {hljs.highlightBlock(e, '  ')});
+      source_table.addClass('highlighted');
+    };
+  });
+
+  var prev_anchor;
+  var curr_anchor;
+
+  // Set-up of popup for source file views
+  $("a.src_link").colorbox({
+    transition: "none",
+    inline: true,
+    opacity: 1,
+    width: "95%",
+    height: "95%",
+    onLoad: function() {
+      prev_anchor = curr_anchor ? curr_anchor : jQuery.url.attr('anchor');
+      curr_anchor = this.href.split('#')[1];
+      window.location.hash = curr_anchor;
+    },
+    onCleanup: function() {
+      if (prev_anchor && prev_anchor != curr_anchor) {
+        $('a[href="#'+prev_anchor+'"]').click();
+        curr_anchor = prev_anchor;
+      } else {
+        $('.group_tabs a:first').click();
+        prev_anchor = curr_anchor;
+        curr_anchor = "#_AllFiles";
+      }
+      window.location.hash = curr_anchor;
+    }
+  });
+
+  window.onpopstate = function(event){
+    if (location.hash.substring(0,2) == "#_") {
+      $.colorbox.close();
+      curr_anchor = jQuery.url.attr('anchor');
+    } else {
+      if ($('#colorbox').is(':hidden')) {
+        $('a.src_link[href="'+location.hash+'"]').colorbox({ open: true });
+      }
+    }
+  };
+
+  // Hide src files and file list container after load
+  $('.source_files').hide();
+  $('.file_list_container').hide();
+
+  // Add tabs based upon existing file_list_containers
+  $('.file_list_container h2').each(function(){
+    var container_id = $(this).parent().attr('id');
+    var group_name = $(this).find('.group_name').first().html();
+
+    $('.group_tabs').append('<li><a href="#' + container_id + '">' + group_name.substring(0, 30) + '</a></li>');
+  });
+
+  $('.group_tabs a').each( function() {
+    $(this).addClass($(this).attr('href').replace('#', ''));
+  });
+
+  // Make sure tabs don't get ugly focus borders when active
+  $('.group_tabs a').live('focus', function() { $(this).blur(); });
+
+  var favicon_path = $('link[rel="icon"]').attr('href');
+  $('.group_tabs a').live('click', function(){
+    if (!$(this).parent().hasClass('active')) {
+      $('.group_tabs a').parent().removeClass('active');
+      $(this).parent().addClass('active');
+      $('.file_list_container').hide();
+      $(".file_list_container" + $(this).attr('href')).show();
+      window.location.href = window.location.href.split('#')[0] + $(this).attr('href').replace('#', '#_');
+
+      // Force favicon reload - otherwise the location change containing anchor would drop the favicon...
+      // Works only on firefox, but still... - Anyone know a better solution to force favicon on local file?
+      $('link[rel="shortcut icon"]').remove();
+      $('head').append('<link rel="shortcut icon" type="image/png" href="'+ favicon_path +'" />');
+    };
+    return false;
+  });
+
+  if (jQuery.url.attr('anchor')) {
+    var anchor = jQuery.url.attr('anchor')
+    if (anchor.length == 40) {
+      $('a.src_link[href=#' + anchor + ']').click();
+    } else {
+      $('.group_tabs a.'+anchor.replace('_', '')).click();
+    }
+  } else {
+    $('.group_tabs a:first').click();
+  };
+
+  $("abbr.timeago").timeago();
+  $('#loading').fadeOut();
+  $('#wrapper').show();
+  $('.dataTables_filter input').focus();
+
+  // https://stackoverflow.com/a/34430701
+  window.getAbsoluteUrl = function (base, relative) {
+    var hashPosition = base.indexOf('#');
+    if (hashPosition > 0){
+      base = base.slice(0, hashPosition);
+    }
+
+    var stack = base.split("/"),
+        parts = relative.split("/");
+    stack.pop();
+    for (var i=0; i<parts.length; i++) {
+      if (parts[i] == ".")
+        continue;
+      if (parts[i] == "..")
+        stack.pop();
+      else
+        stack.push(parts[i]);
+    }
+    return stack.join("/");
+  }
+
+  window.traverseTreeData = function(treeData, paths) {
+    if(paths.length == 0) { return []; }
+
+    const currentNode = paths[0];
+
+    let nodeIndex = treeData.findIndex(function(node) { return node.name == currentNode.name });
+    if(nodeIndex == -1) {
+      let node = {
+        name: currentNode.name,
+        example: currentNode.example,
+        expanded: true,
+        children: traverseTreeData([], paths.slice(1))
+      };
+      treeData.push(node);
+
+    } else {
+      let node = treeData[nodeIndex];
+      node.children = traverseTreeData(node.children, paths.slice(1));
+      node.expanded = (node.children.length > 1) ? false : true;
+      treeData[nodeIndex] = node;
+    }
+
+    return treeData;
+  };
+
+  $('.source_table.highlighted li.covered').live('click', function() {
+    const exampleRefs = $(this).children('.deprecations_detector')[0].dataset.exampleRefs.split(",");
+    if(!$(this).children('.deprecations_detector').is(':visible')){
+      let treeData = [];
+      const self = this;
+      exampleRefs.forEach(function(ref) {
+        const example = window.examples[ref]
+        const treeNodes = []
+        example["file_path"].split('/').slice(1).forEach(function(node_path){
+          treeNodes.push({ name: node_path })
+        });
+        treeNodes.push({ example: example, name: example['full_description'] });
+
+        treeData = traverseTreeData(treeData, treeNodes)
+      })
+
+      const domElement = self.querySelector('.deprecations_detector');
+
+      let tree = new TreeView(treeData, domElement);
+      tree.on('select', function (node) {
+        const example = node.data.example;
+        const url = getAbsoluteUrl('', `${window.base_url}${example.file_path}#L${example.line_number}`);
+        window.open(url, '_blank');
+      });
+      $(this).children('.deprecations_detector').show();
+
+      let divMessages = document.createElement('div');
+      divMessages.className = 'messages';
+      domElement.prepend(divMessages);
+      deprecations = exampleRefs.map(function(ref) { return window.examples[ref]['deprecation_message'] });
+      [...new Set(deprecations)].forEach(function(message){
+        divMessages.append(message);
+        divMessages.append(document.createElement('br'));
+      })
+    } else {
+      $(this).children('.deprecations_detector').html('');
+      $(this).children('.deprecations_detector').hide();
+    }
+  });
+  $('.source_table.highlighted li.covered .deprecations_detector').live('click', function(event) {
+    event.stopPropagation();
+  });
+});