turbo_test_constant_tracer 0.1.11

data/Makefile

@@ -0,0 +1,44 @@
+# Adapted from https://github.com/zspencer/make-many-rubies/blob/master/Makefile
+
+# Allows running (and re-running) of tests against several ruby versions,
+# assuming you use rbenv instead of rvm.
+
+# Uses pattern rules (task-$:) and automatic variables ($*).
+# Pattern rules: http://ftp.gnu.org/old-gnu/Manuals/make-3.79.1/html_chapter/make_10.html#SEC98
+# Automatic variables: http://ftp.gnu.org/old-gnu/Manuals/make-3.79.1/html_chapter/make_10.html#SEC101
+
+# Rbenv-friendly version identifiers for supported Rubys
+24_version = 2.4.10
+25_version = 2.5.8
+26_version = 2.6.6
+27_version = 2.7.1
+
+# The ruby version for use in a given rule.
+# Requires a matched pattern rule and a supported ruby version.
+#
+# Given a pattern rule defined as "install-ruby-%"
+# When the rule is ran as "install-ruby-193"
+# Then the inner addsuffix call evaluates to "193_version"
+# And given_ruby_version becomes "1.9.3-p551"
+given_ruby_version = $($(addsuffix _version, $*))
+
+# Instruct rbenv on which Ruby version to use when running a command.
+# Requires a pattern rule and a supported ruby version.
+#
+# Given a pattern rule defined as "test-%"
+# When the rule is ran as "test-187"
+# Then with_given_ruby becomes "RBENV_VERSION=1.8.7-p375"
+with_given_ruby = RBENV_VERSION=$(given_ruby_version)
+
+
+# Runs tests for all supported ruby versions.
+test: test-24 test-25 test-26 test-27
+test_24: test-24
+test_25: test-25
+test_26: test-26
+test_27: test-27
+
+# Runs tests against a specific ruby version
+test-%:
+	$(with_given_ruby) bundle install
+	$(with_given_ruby) bundle exec rake compile test

data/README.md

@@ -0,0 +1,26 @@
+![Tests](https://github.com/dunkelbraun/turbo_test_constant_tracer/workflows/Tests/badge.svg?branch=main)
+[![Maintainability](https://api.codeclimate.com/v1/badges/6f848135bd1e329faba5/maintainability)](https://codeclimate.com/github/dunkelbraun/turbo_test_constant_tracer/maintainability)
+[![Coverage Status](https://coveralls.io/repos/github/dunkelbraun/turbo_test_constant_tracer/badge.svg?branch=main)](https://coveralls.io/github/dunkelbraun/turbo_test_constant_tracer?branch=main)
+
+# TurboTestConstantTracer
+
+Description @todo.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dunkelbraun/turbo_test_constant_tracer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/dunkelbraun/turbo_test_constant_tracer/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TurboTestConstantTracer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dunkelbraun/turbo_test_constant_tracer/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rake/extensiontask"
+
+ENV["TESTOPTS"] = "#{ENV['TESTOPTS']} --verbose"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test
+
+Rake::ExtensionTask.new "hash_lookup_with_proxy_ext" do |ext|
+  ext.lib_dir = "lib"
+end
+
+if ENV["CI"]
+  require "coveralls/rake/task"
+  Coveralls::RakeTask.new
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "turbo_test_constant_tracer"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/hash_lookup_with_proxy_ext/extconf.h

@@ -0,0 +1,3 @@
+#ifndef EXTCONF_H
+#define EXTCONF_H
+#endif

data/ext/hash_lookup_with_proxy_ext/extconf.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+create_makefile "hash_lookup_with_proxy_ext"

data/ext/hash_lookup_with_proxy_ext/hash_lookup_with_proxy_ext.c

@@ -0,0 +1,34 @@
+ #include "ruby.h"
+
+VALUE turbo_test;
+VALUE turbo_test_constant_tracer;
+VALUE turbo_test_hash_lookup_with_proxy;
+VALUE turbo_test_hash_lookup_with_proxy_methods;
+
+ID turbo_test_proxy_object_method;
+
+VALUE my_rb_hash_aset(VALUE hash, VALUE key, VALUE val) {
+  key = rb_funcall(key, turbo_test_proxy_object_method, 0);
+  return rb_hash_aset(hash, key, val);
+}
+
+VALUE turbo_test_proxy_object(VALUE self){
+  return self;
+}
+
+VALUE add_assign_method(VALUE self) {
+  rb_define_method(turbo_test_hash_lookup_with_proxy_methods, "[]=", my_rb_hash_aset, 2);
+  return Qtrue;
+}
+
+void Init_hash_lookup_with_proxy_ext()
+{
+  turbo_test = rb_define_module("TurboTest");
+  turbo_test_constant_tracer = rb_define_module_under(turbo_test, "ConstantTracer");
+  turbo_test_hash_lookup_with_proxy = rb_define_module_under(turbo_test_constant_tracer, "HashLookupWithProxy");
+  turbo_test_hash_lookup_with_proxy_methods = rb_define_module_under(turbo_test_hash_lookup_with_proxy, "Methods");
+  rb_define_module_function(turbo_test_hash_lookup_with_proxy_methods, "add_assign_method", add_assign_method, 0);
+
+  turbo_test_proxy_object_method = rb_intern("__turbo_test_proxied_class");
+  rb_define_method(rb_cBasicObject, "__turbo_test_proxied_class", turbo_test_proxy_object, 0);
+}

data/lib/turbo_test_constant_tracer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "turbo_test_events"
+
+require_relative "turbo_test_constant_tracer/version"
+
+module TurboTest
+  module ConstantTracer
+  end
+end
+
+require_relative "turbo_test_constant_tracer/definition"
+require_relative "turbo_test_constant_tracer/proxy_klass"
+require_relative "turbo_test_constant_tracer/klass"
+require_relative "turbo_test_constant_tracer/regexp/tilde"
+require_relative "turbo_test_constant_tracer/constructor"
+require_relative "turbo_test_constant_tracer/event_publisher"
+require_relative "turbo_test_constant_tracer/hash_lookup_with_proxy"

data/lib/turbo_test_constant_tracer/constructor.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module TurboTest
+  module ConstantTracer
+    class Constructor
+      def initialize(original_class)
+        @klass = original_class
+        @klass_name = original_class.name.gsub("::", "")
+      end
+
+      def construct
+        return ProxyKlass.const_get(@klass_name) if proxy_class_defined?
+
+        Klass.define(@klass, @klass_name).tap do
+          prepend_equality_operators_to_original_class
+          prepend_equality_operators Numeric
+          prepend_equality_operators Comparable
+        end
+      end
+
+      private
+
+      def proxy_class_defined?
+        ProxyKlass.const_defined? @klass_name, false
+      end
+
+      def prepend_equality_operators_to_original_class
+        s_class = @klass.singleton_class
+        s_class.prepend(CaseEquality)
+        s_class.prepend(Equality)
+      end
+
+      def prepend_equality_operators(mod)
+        return unless @klass.ancestors.include?(mod)
+
+        mod.singleton_class.prepend(CaseEquality)
+        mod.singleton_class.prepend(Equality)
+      end
+    end
+
+    module CaseEquality
+      def ===(other)
+        if other.respond_to?(:turbo_test_proxied_class)
+          other = (other.turbo_test_proxied_class || other)
+        end
+        super
+      end
+    end
+
+    module Equality
+      def ==(other)
+        if other.respond_to?(:turbo_test_proxied_class)
+          other = (other.turbo_test_proxied_class || other)
+        end
+        super
+      end
+    end
+  end
+end

data/lib/turbo_test_constant_tracer/definition.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "binding_of_caller"
+require_relative "definition/templates"
+
+module TurboTest
+  module ConstantTracer
+    module Definition
+      class << self
+        include DefinitionTemplates
+
+        def internal_proxy(klass, name, constant, location)
+          freeze = constant.frozen?
+          constant = constant.dup if freeze
+          create_internal_proxy_methods(constant, klass, name, location)
+          constant.__turbo_test_tt_proxy_dup_object = constant.dup
+          constant.__send__(:__turbo_test_freeze) if freeze
+          set_class_constant(klass, name, constant)
+        end
+
+        def delegator_proxy(klass, name, constant, location)
+          proxy_class = Constructor.new(constant.class).construct
+          proxy_object = proxy_class.new(constant)
+          proxy_object.turbo_test_name = "#{klass}::#{name}"
+          proxy_object.turbo_test_path = location
+          ProxyKlass.proxied_objects[proxy_object.object_id] = true
+          set_class_constant(klass, name, proxy_object)
+        end
+
+        SPECIAL_METHODS = {
+          "String" => %i[scan gsub gsub! sub sub!],
+          "Enumerable" => %i[all? any? grep grep_v none? one? slice_before slice_after]
+        }.freeze
+
+        SUPER_SPECIAL_METHODS = {
+          "String" => [:=~]
+        }.freeze
+
+        private
+
+        def create_internal_proxy_methods(object, klass, name, location)
+          singleton_class = object.singleton_class
+          singleton_class.class_eval { attr_accessor :__turbo_test_tt_proxy_dup_object }
+
+          methods_to_modify(object).each do |mod_method|
+            alias_original_method(singleton_class, mod_method, mod_method)
+            define_proxy_method(singleton_class, klass, mod_method, name, location)
+          end
+
+          modify_string_methods(object, klass, singleton_class, name, location)
+          modify_enumerable_methods(object, klass, singleton_class, name, location)
+        end
+
+        def methods_to_modify(object)
+          singleton_class = object.singleton_class
+          mod_methods = singleton_class.instance_methods.reject do |method|
+            method == :__send__
+          end
+          if object.class == ::String
+            mod_methods -= SPECIAL_METHODS["String"]
+            mod_methods -= SUPER_SPECIAL_METHODS["String"]
+          end
+          mod_methods -= SPECIAL_METHODS["Enumerable"] if object.is_a? ::Enumerable
+          mod_methods
+        end
+
+        def modify_string_methods(object, klass, singleton_class, name, location)
+          return unless object.class == ::String
+
+          SPECIAL_METHODS["String"].each do |mod_method|
+            original_method = mod_method
+            mod_method = mod_method.to_s.gsub("!", "_bang").to_sym
+            alias_original_method(singleton_class, mod_method, original_method)
+            define_proxy_string_template_method(
+              singleton_class, "#{klass}::#{name}", mod_method, location, original_method
+            )
+          end
+          define_equal_tilde_method(singleton_class, klass, name, location)
+        end
+
+        def modify_enumerable_methods(object, klass, singleton_class, name, location)
+          return unless object.is_a? ::Enumerable
+
+          SPECIAL_METHODS["Enumerable"].each do |mod_method|
+            original_method = mod_method
+            mod_method = mod_method.to_s.gsub("?", "_question_mark").to_sym
+            alias_original_method(singleton_class, mod_method, original_method)
+            define_proxy_enumerable_template_method(
+              singleton_class, "#{klass}::#{name}", location, original_method
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/turbo_test_constant_tracer/definition/templates.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "binding_of_caller"
+require "English"
+
+module TurboTest
+  module ConstantTracer
+    module DefinitionTemplates
+      private
+
+      def define_proxy_enumerable_template_method(singleton_class, name, location, original_method)
+        singleton_class.class_eval <<~RUBY, __FILE__, __LINE__ + 1
+          def #{original_method}(*args, &block)
+            send_block = if block
+              Proc.new do |match|
+                block_binding = block.binding
+                block_binding.local_variable_set(:_turbotest_tilde, $~)
+                block_binding.eval("$~=_turbotest_tilde")
+                block.call(match)
+              end
+            else
+              block
+            end
+            result = __turbo_test_tt_proxy_dup_object.#{original_method}(*args, &send_block)
+            caller_binding = binding.of_caller(1)
+            caller_binding.local_variable_set(:_turbotest_tilde, $~)
+            caller_binding.eval("$~=_turbotest_tilde")
+            ::TurboTest::ConstantTracer::EventPublisher.publish("#{name}", "#{location}")
+            result
+          end
+        RUBY
+      end
+
+      def define_equal_tilde_method(singleton_class, _klass, _name, _location)
+        singleton_class.class_eval do
+          def =~(other)
+            caller_binding = binding.of_caller(1)
+            (::String.new(self) =~ other).tap do
+              caller_binding.local_variable_set(:_turbotest_tilde, $LAST_MATCH_INFO)
+              caller_binding.eval("$~=_turbotest_tilde")
+            end
+          end
+        end
+      end
+
+      def alias_original_method(klass, mod_method, original_method)
+        klass.class_eval do
+          aliased_name = "__turbo_test_#{mod_method}"
+          alias_method aliased_name, original_method
+          # rubocop:disable Style/AccessModifierDeclarations
+          private aliased_name
+          # rubocop:enable Style/AccessModifierDeclarations
+        end
+      end
+
+      def define_proxy_method(singleton_class, klass, _mod_method, name, location)
+        singleton_class.class_eval <<~RUBY, __FILE__, __LINE__ + 1
+          aliased_name = "__turbo_test_\#\{_mod_method\}"
+          define_method _mod_method do |*args, &block|
+            result = __send__ aliased_name, *args, &block
+            ::TurboTest::ConstantTracer::EventPublisher.publish("#{klass}::#{name}", "#{location}")
+            result
+          end
+        RUBY
+      end
+
+      # rubocop:disable Layout/LineLength
+      def define_proxy_string_template_method(singleton_class, name, _mod_method, location, original_method)
+        singleton_class.class_eval <<~RUBY, __FILE__, __LINE__ + 1
+          aliased_name = "__turbo_test_\#\{_mod_method\}"
+          define_method :#{original_method} do |*args, &block|
+            res = unless block
+              __send__(aliased_name, *args)
+            else
+              my_proc = Proc.new do |match|
+                block_binding = block.binding
+                block_binding.local_variable_set(:_turbotest_tilde, $~)
+                block_binding.eval("$~=_turbotest_tilde")
+                block.call(match)
+              end
+              __send__(aliased_name, *args, &(my_proc))
+            end
+            ::TurboTest::ConstantTracer::EventPublisher.publish("#{name}", "#{location}")
+            res
+          end
+        RUBY
+      end
+      # rubocop:enable Layout/LineLength
+
+      def set_class_constant(klass, name, object)
+        silence_warnings do
+          klass.const_set(name.gsub("::", ""), object)
+        end
+        object
+      end
+
+      def silence_warnings
+        old_stderr = $stderr
+        $stderr = StringIO.new
+        yield
+      ensure
+        $stderr = old_stderr
+      end
+    end
+  end
+end