named_imports 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfc9a0d0b8e5f11fc766551ff061c718b590fe78c8a0d389731899953a38aadc
-  data.tar.gz: 11e50d338348cc168e96fc314bc41981407c3483a5d78db814ed4bb61cd5543e
+  metadata.gz: bb15d783f22496923d8eb7770bc934347bbd84a0019fad85380e3e43a29361d7
+  data.tar.gz: fb90680e03f17db882f40cd38e93e3d51c729177d90e67bc7b6f5d82fd99fe8d
 SHA512:
-  metadata.gz: 01572a85739777dca2eb49050098e9e07ca7c93f7ba7a5716442bc36690e6a6c296b26ed2a1c8b473f68c6ea4097ae67d860a9850a19dadeb58b60b61ef617a7
-  data.tar.gz: 0074367a1fddfb4b935026e0604ca80555d1bcaf6e6cf5c574dfbf9865ccac6e6ac8462271cc27218c30955300cfb80ad4cd08705d5169c34ca43b2860edb80a
+  metadata.gz: 498ea8dd7a20b2e9a5070e2edfa97b31911b471fa93fe28800ad076f69b031b1132ea5bc65d12db206b52c5bb0dd1903dd41ff611fa1b637cb5aa16947bf0445
+  data.tar.gz: 88c609ed4e0649b998752474c78d6496978b1adc5144fe294a0ed770561f0120668977c75885fe8e605748f22a137f08b3d2541becd23e8ab2a92d1c2a9db8f1

data/lib/named_imports.rb

@@ -1,79 +1,101 @@
 # frozen_string_literal: true
 
 require_relative "named_imports/version"
+require_relative "named_imports/error"
 
 module NamedImports
-  class Error < StandardError; end
-
   class << self
-    def from(path, constants, context = Object)
-      path_where_import_occurs = caller(2..2).first
-      full_path = full_path_for_import(path, path_where_import_occurs)
+    def from(raw_path, constant_names, context = Object)
+      into_path, import_line = caller_path_and_line
+      from_path = full_path_for_import(from_path: raw_path, into_path: into_path)
+      sandbox = sandbox_eval(file_path: from_path)
+      load_constants(constant_names, from_sandbox: sandbox, into_context: context)
+    end
 
-      File.open(full_path, "r") do |file|
-        file_content = file.read
-        anon_mod = Module.new
+    def import(context = Object, &block)
+      into_path, import_line = caller_path_and_line
+      constant_names = []
 
-        anon_mod.define_singleton_method(:from) do |path, constants|
-          NamedImports.from(path, constants, anon_mod)
-        end
+      begin
+        block.call
+      rescue => e
+        constant_name = constant_name_from_error(e)
 
-        anon_mod.define_singleton_method(:import) do |&block|
-          NamedImports.import(&block)
+        if constant_name.nil?
+          raise NamedImports::Error::ImportBlockError.new(into_path, import_line, e)
         end
 
-        anon_mod.class_eval(file_content, full_path)
-
-        constants.each do |constant_name|
-          context.send(:remove_const, constant_name) if context.const_defined?(constant_name, false)
-          context.const_set(constant_name, anon_mod.const_get(constant_name))
+        if !constant_names.include?(constant_name)
+          constant_names << constant_name
+          context.const_set(constant_name, nil)
         end
+
+        retry
       end
+
+      constant_names
     end
 
-    def import(context = Object)
-      constants = []
+    def make_named_imports_available(in_context: Object)
+      def_method = in_context == Object ? :define_method : :define_singleton_method
 
-      begin
-        yield
-      rescue NameError => e
-        raise e unless /uninitialized constant /.match?(e.message)
+      in_context.send(def_method, :from) do |path, constants|
+        NamedImports.from(path, constants, in_context)
+      end
 
-        constant_match = e.message.match(/uninitialized constant (?:#<Module:[^>]+>::)?(\w*(?:::\w+)*)$/)
-        constant_name = constant_match && constant_match[1]
+      in_context.send(def_method, :import) do |&block|
+        NamedImports.import(in_context, &block)
+      end
+    end
 
-        if constant_name.nil?
-          raise NameError, "unable to import constant: #{e.message.gsub(/uninitialized constant /, '')}"
-        end
+    private
 
-        already_there = constants.include?(constant_name)
+    def caller_path_and_line
+      caller_path_info = caller(3..3).first
+      caller_path_info.match(/\A(.+?):(\d+):/)[1..2]
+    end
 
-        unless already_there
-          constants << constant_name
-          context.const_set(constant_name, nil)
-        end
+    def full_path_for_import(from_path:, into_path:)
+      ext = %r{[^/]+\.[^/]+$}.match?(from_path) ? "" : ".rb"
+      from_path_with_ext = "#{from_path}#{ext}"
+      importer_dir = File.dirname(into_path)
+      File.expand_path(from_path_with_ext, importer_dir)
+    end
 
-        retry
-      end
+    def catchable_missing_constant_error?(error)
+      error.is_a?(NameError) && error.message =~ /uninitialized constant /
+    end
 
-      constants
+    def constant_name_from_error(error)
+      return unless error.is_a?(NameError)
+      constant_matcher = /uninitialized constant (?:#<Module:[^>]+>::)?(\w*(?:::\w+)*)$/
+      constant_match = error.message.match(constant_matcher)
+      constant_match && constant_match[1]
     end
 
-    private
+    def read_content(file_path:)
+      File.open(file_path, &:read)
+    end
 
-    def full_path_for_import(imported_path, importer_path)
-      ext = %r{[^/]+\.[^/]+$}.match?(imported_path) ? "" : ".rb"
-      imported_path_with_ext = "#{imported_path}#{ext}"
-      importer_dir = File.dirname(importer_path)
-      File.expand_path(imported_path_with_ext, importer_dir)
+    def sandbox_eval(file_path:)
+      sandbox_module = Module.new
+      make_named_imports_available(in_context: sandbox_module)
+      ruby_code = read_content(file_path: file_path)
+      sandbox_module.class_eval(ruby_code, file_path)
+      sandbox_module
     end
-  end
 
-  Object.define_method(:from) do |path, constants|
-    NamedImports.from(path, constants)
-  end
+    def load_constants(constant_names, from_sandbox:, into_context:)
+      constant_names.each do |constant_name|
+        if into_context.const_defined?(constant_name, false)
+          into_context.send(:remove_const, constant_name)
+        end
 
-  Object.define_method(:import) do |&block|
-    NamedImports.import(&block)
+        sandboxed_constant = from_sandbox.const_get(constant_name)
+        into_context.const_set(constant_name, sandboxed_constant)
+      end
+    end
   end
+
+  make_named_imports_available
 end

data/lib/named_imports/error.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module NamedImports
+  module Error
+    class Base < ::StandardError
+    end
+
+    class ImportBlockError < NamedImports::Error::Base
+      def initialize(importer_file, importer_line, original_error = nil)
+        error_details = []
+        error_details << "Something went wrong when evaluating the named import at #{importer_file}:#{importer_line}."
+        error_details << "This is likely to be an error in your 'import' block."
+        if original_error
+          original_error_class = original_error.class.to_s
+          article = original_error_class[0].match(/aeiou/i) ? "an" : "a"
+          error_details << "The original error was #{article} #{original_error_class}: #{original_error.message}"
+        end
+
+        error_message = error_details.join(" ")
+        super(error_message)
+
+        set_backtrace(original_error.backtrace) if original_error
+      end
+    end
+
+    class ImportError < ::NameError
+    end
+
+    class ConstantImportError < NamedImports::Error::ImportError
+      def initialize(imported_name, imported_file, importer_file, importer_line)
+        super("Unable to import #{imported_name} from #{imported_file} (import occurs in #{importer_file}:#{importer_line})")
+      end
+    end
+  end
+end

data/lib/named_imports/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NamedImports
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: named_imports
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Keegan Leitz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,6 +156,7 @@ files:
 - bin/console
 - bin/setup
 - lib/named_imports.rb
+- lib/named_imports/error.rb
 - lib/named_imports/version.rb
 - named_imports.gemspec
 homepage: https://github.com/kjleitz/named_imports