Module: Brick::Util

Defined in:
lib/brick/util.rb

Class Method Summary collapse

Class Method Details

._custom_require_dir ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/brick/util.rb', line 81

def self._custom_require_dir
  unless (custom_require_dir = ::Brick::Util.instance_variable_get(:@_custom_require_dir))
    require 'tmpdir'
    ::Brick::Util.instance_variable_set(:@_custom_require_dir, (custom_require_dir = Dir.mktmpdir))
    # So normal Ruby require will now pick this one up
    $LOAD_PATH.unshift(custom_require_dir)
    # When Ruby is exiting, remove this temporary directory
    at_exit do
      FileUtils.rm_rf(::Brick::Util.instance_variable_get(:@_custom_require_dir))
    end
  end
  custom_require_dir
end

._patch_require(module_filename, folder_matcher, replacements, autoload_symbol = nil, is_bundler = false) ⇒ Object

Epic require patch



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/brick/util.rb', line 8

def self._patch_require(module_filename, folder_matcher, replacements, autoload_symbol = nil, is_bundler = false)
  mod_name_parts = module_filename.split('.')
  extension = case mod_name_parts.last
              when 'rb', 'so', 'o'
                module_filename = mod_name_parts[0..-2].join('.')
                ".#{mod_name_parts.last}"
              else
                '.rb'
              end

  if autoload_symbol
    unless Object.const_defined?('ActiveSupport::Dependencies')
      require 'active_support'
      require 'active_support/dependencies'
    end
    alp = ActiveSupport::Dependencies.autoload_paths
    custom_require_dir = ::Brick::Util._custom_require_dir
    # Create any missing folder structure leading up to this file
    module_filename.split('/')[0..-2].inject(custom_require_dir) do |s, part|
      new_part = File.join(s, part)
      Dir.mkdir(new_part) unless Dir.exist?(new_part)
      new_part
    end
    if ::Brick::Util._write_patched(folder_matcher, module_filename, extension, custom_require_dir, nil, replacements) &&
       !alp.include?(custom_require_dir)
      alp.unshift(custom_require_dir)
    end
  elsif is_bundler
    puts "Bundler hack"
    require 'pry-byebug'
    binding.pry
    x = 5
    # bin_path
    # puts Bundler.require.inspect
  else
    unless (require_overrides = ::Brick::Util.instance_variable_get(:@_require_overrides))
      ::Brick::Util.instance_variable_set(:@_require_overrides, (require_overrides = {}))

      # Patch "require" itself so that when it specifically sees "active_support/values/time_zone" then
      # a copy is taken of the original, an attempt is made to find the line with a circular error, that
      # single line is patched, and then an updated version is written to a temporary folder which is
      # then required in place of the original.

      Kernel.module_exec do
        alias_method :orig_require, :require
        # To be most faithful to Ruby's normal behaviour, this should look like a public singleton
        define_method(:require) do |name|
          # %%% Can get a message such as "ActionDispatch::Routing is not missing constant RouteSet! (NameError)"
          # binding.pry if name.start_with?('action_dispatch/routing/route_') # || name == 'active_support/values/time_zone'
          if (require_override = ::Brick::Util.instance_variable_get(:@_require_overrides)[name])
            extension, folder_matcher, replacements, autoload_symbol = require_override
            patched_filename = "/patched_#{name.tr('/', '_')}#{extension}"
            if $LOADED_FEATURES.find { |f| f.end_with?(patched_filename) }
              false
            else
              is_replaced = false
              if (replacement_path = ::Brick::Util._write_patched(folder_matcher, name, extension, ::Brick::Util._custom_require_dir, patched_filename, replacements))
                is_replaced = Kernel.send(:orig_require, replacement_path)
              elsif replacement_path.nil?
                puts "Couldn't find #{name} to require it!"
              end
              is_replaced
            end
          else
            Kernel.send(:orig_require, name)
          end
        end
      end
    end
    require_overrides[module_filename] = [extension, folder_matcher, replacements, autoload_symbol]
  end
end

._write_patched(folder_matcher, name, extension, dir, patched_filename, replacements) ⇒ Object

Returns the full path to the replaced filename, or false if the file already exists, and nil if it was unable to write anything.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/brick/util.rb', line 97

def self._write_patched(folder_matcher, name, extension, dir, patched_filename, replacements)
  # See if our replacement file might already exist for some reason
  name = +"/#{name}" unless name.start_with?('/')
  name << extension unless name.end_with?(extension)
  puts (replacement_path = "#{dir}#{patched_filename || name}")
  return false if File.exist?(replacement_path)

  # Dredge up the original .rb file, doctor it, and then require it instead
  num_written = nil
  orig_path = nil
  orig_as = nil
  # Using Ruby's approach to find files to require
  $LOAD_PATH.each do |path|
    orig_path = "#{path}#{name}"
    break if path.include?(folder_matcher) && (orig_as = File.open(orig_path))
  end
  puts [folder_matcher, name].inspect
  if (updated_text = orig_as&.read)
    File.open(replacement_path, 'w') do |replaced_file|
      replacements = [replacements] unless replacements.first.is_a?(Array)
      replacements.each do |search_text, replacement_text|
        updated_text.gsub!(search_text, replacement_text)
      end
      num_written = replaced_file.write(updated_text)
    end
    orig_as.close
  end
  (num_written&.> 0) ? replacement_path : nil
end