im 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 844192c05246f7a6fdf91f2999e1af62ffa0124fafc26666b0215bebbb276645
-  data.tar.gz: a077e568115fc13153de58c087288c465c1f7be1851499f511c2a5372e83d5ca
+  metadata.gz: 99d5cc6d355489148cd6f39fee0e50ce1a25d0e770e4f06c4918fdd41b05935b
+  data.tar.gz: ec2372445636beac68c84c0249b68e7e454dda3b0c49293bea4e8f14bfa52053
 SHA512:
-  metadata.gz: a6769bba616d834f2869366bdd072120cacf0e596e59a390433dd3b8380ab14e501e1e88254ff11f281e8a7df7e5a48706712669d01fef711ed3832c84ad6af8
-  data.tar.gz: 8857482df7b59722dae014fa5f5b789e16f5407dae62643907cd9578329fcc4c83bc0cdca817c74d712479401562ad615c84599c2a987e5c97f981c0a1c17730
+  metadata.gz: f9099a8d43b9772952916c21bd84da42da3eeac2541c0b4fe675fd7c373988d00a9522fc7dc2ce662ea7d0f3231ec4aec11941ab8f079350529d6476e535a19f
+  data.tar.gz: 764b1d2454d0158deba3cd4244453aab0d194036b0fe4104c0cb40bced64d5a0bdb6099db3f5c0b9d98cf75c1417707949f353524b8061c5db18ef96ea0aad2d

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+## [Unreleased]
+
+## [0.1.4] - 2022-09-19
+- Correctly assign constants imported via recursive requires
+
+## [0.1.3] - 2022-09-16
+- Fix gemspec
+
+## [0.1.1] - 2022-09-16
+
+- Fix TracePoint event
+- Simplify import inspect
+- Remove unnecessary Kernel#autoload patch
+- Encode comprehensive list of top-level constants
+
+## [0.1.0] - 2022-09-15
+
+- Initial release, requires patched version of Ruby.
+
+## [0.0.1] - 2022-07-13
+
+- Stub

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in im.gemspec
+gemspec
+
+gem "rspec", "~> 3.0"
+gem "rails"

data/Gemfile.lock

@@ -0,0 +1,179 @@
+PATH
+  remote: .
+  specs:
+    im (0.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.4)
+      actionpack (= 7.0.4)
+      activesupport (= 7.0.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.4)
+      actionpack (= 7.0.4)
+      activejob (= 7.0.4)
+      activerecord (= 7.0.4)
+      activestorage (= 7.0.4)
+      activesupport (= 7.0.4)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.4)
+      actionpack (= 7.0.4)
+      actionview (= 7.0.4)
+      activejob (= 7.0.4)
+      activesupport (= 7.0.4)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.4)
+      actionview (= 7.0.4)
+      activesupport (= 7.0.4)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.4)
+      actionpack (= 7.0.4)
+      activerecord (= 7.0.4)
+      activestorage (= 7.0.4)
+      activesupport (= 7.0.4)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.4)
+      activesupport (= 7.0.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.4)
+      activesupport (= 7.0.4)
+      globalid (>= 0.3.6)
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activestorage (7.0.4)
+      actionpack (= 7.0.4)
+      activejob (= 7.0.4)
+      activerecord (= 7.0.4)
+      activesupport (= 7.0.4)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    digest (3.1.0)
+    erubi (1.11.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.19.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
+    minitest (5.16.3)
+    net-imap (0.2.3)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.1)
+      digest
+      net-protocol
+      timeout
+    net-protocol (0.1.3)
+      timeout
+    net-smtp (0.3.1)
+      digest
+      net-protocol
+      timeout
+    nio4r (2.5.8)
+    nokogiri (1.13.8)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails (7.0.4)
+      actioncable (= 7.0.4)
+      actionmailbox (= 7.0.4)
+      actionmailer (= 7.0.4)
+      actionpack (= 7.0.4)
+      actiontext (= 7.0.4)
+      actionview (= 7.0.4)
+      activejob (= 7.0.4)
+      activemodel (= 7.0.4)
+      activerecord (= 7.0.4)
+      activestorage (= 7.0.4)
+      activesupport (= 7.0.4)
+      bundler (>= 1.15.0)
+      railties (= 7.0.4)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (7.0.4)
+      actionpack (= 7.0.4)
+      activesupport (= 7.0.4)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.0.6)
+    rake-compiler (1.2.0)
+      rake
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    strscan (3.0.4)
+    thor (1.2.1)
+    timeout (0.3.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  im!
+  rails
+  rake (~> 13.0)
+  rake-compiler
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.4.0.dev

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Chris Salzberg
+
+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,64 @@
+# Im
+
+Im is a (currently) experimental implementation of import modules in Ruby,
+similar to systems like CommonJS, ESmodules, and RequireJS in Javascript. It
+requires a patched version of Ruby which you will need to build in order to use
+the gem.
+
+## Installation
+
+Im requires a patched version of Ruby to use; if not installed, the gem will raise and exit.
+
+You can find the patched version of Ruby here:
+
+https://github.com/shioyama/ruby/tree/import_modules
+
+Once installed, install the gem and the error should go away.
+
+## Usage
+
+Extend `Im` and use `import` to import files or gems under an anonymous module namespace:
+
+```ruby
+require "im"
+
+extend Im
+
+mod = import "activemodel"
+#=> #<Im::Import:0x00007f2d34dfd0c8 root: active_model>
+```
+
+Constants in the imported files are under the returned module, not the root namespace:
+
+```ruby
+ActiveModel
+#=> uninitialized constant ActiveModel (NameError)
+
+mod::ActiveModel
+#=> ActiveModel
+```
+
+You can now assign your custom parent namespace and use the gem constants as always:
+
+```ruby
+MyRails = mod
+
+class EmailContact
+  include MyRails::ActiveModel::API
+
+  attr_accessor :name
+  validates :name, presence: true
+end
+
+contact = EmailContact.new
+contact.valid?
+#=> false
+
+contact.name = "foo"
+contact.valid?
+#=> true
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/im/autoload.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Im
+  module Autoload
+    def autoload(name, path)
+      Im.autoloads[path] = Im.current_import if Im.importing?
+      super(name, path)
+    end
+  end
+end

data/lib/im/constants.rb

@@ -0,0 +1,104 @@
+module Im
+  # It's faster to just hard-code constants than to introspect them at runtime
+  CONSTANTS = [
+    :ArgumentError,
+    :Array,
+    :BasicObject,
+    :Binding,
+    :Class,
+    :ClosedQueueError,
+    :Comparable,
+    :Complex,
+    :ConditionVariable,
+    :DidYouMean,
+    :Dir,
+    :Encoding,
+    :EncodingError,
+    :Enumerable,
+    :Enumerator,
+    :EOFError,
+    :Errno,
+    :ErrorHighlight,
+    :Exception,
+    :FalseClass,
+    :Fiber,
+    :FiberError,
+    :File,
+    :FileTest,
+    :Float,
+    :FloatDomainError,
+    :FrozenError,
+    :GC,
+    :Gem,
+    :Hash,
+    :IndexError,
+    :Integer,
+    :Interrupt,
+    :IO,
+    :IOError,
+    :Kernel,
+    :KeyError,
+    :LoadError,
+    :LocalJumpError,
+    :Marshal,
+    :MatchData,
+    :Math,
+    :Method,
+    :Module,
+    :Monitor,
+    :MonitorMixin,
+    :Mutex,
+    :NameError,
+    :NilClass,
+    :NoMatchingPatternError,
+    :NoMatchingPatternKeyError,
+    :NoMemoryError,
+    :NoMethodError,
+    :NotImplementedError,
+    :Numeric,
+    :Object,
+    :ObjectSpace,
+    :Proc,
+    :Process,
+    :Queue,
+    :Ractor,
+    :Random,
+    :Range,
+    :RangeError,
+    :Rational,
+    :RbConfig,
+    :Refinement,
+    :Regexp,
+    :RegexpError,
+    :RubyVM,
+    :RuntimeError,
+    :ScriptError,
+    :SecurityError,
+    :Set,
+    :Signal,
+    :SignalException,
+    :SizedQueue,
+    :StandardError,
+    :StopIteration,
+    :String,
+    :Struct,
+    :Symbol,
+    :SyntaxError,
+    :SystemCallError,
+    :SystemExit,
+    :SystemStackError,
+    :Thread,
+    :ThreadError,
+    :ThreadGroup,
+    :Time,
+    :TracePoint,
+    :TrueClass,
+    :TypeError,
+    :UnboundMethod,
+    :UncaughtThrowError,
+    :UnicodeNormalize,
+    :URI,
+    :Warning,
+    :ZeroDivisionError,
+  ]
+end

data/lib/im/kernel.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Kernel
+  alias_method :im_original_require, :require
+
+  def require(path)
+    if Im.autoloads.key?(path)
+      return Im.with_import(Im.autoloads.delete(path)) do |_context|
+        !!Im.import(path)
+      end
+    end
+
+    if Im.importing? && (resolved = $LOAD_PATH.resolve_feature_path(path))
+      resolved_path = resolved[1]
+      Im.registry[resolved_path] ||= Im::Dependency.new(resolved_path, Im.current_import)
+    end
+
+    loaded = im_original_require(path)
+    return loaded unless Im.importing?
+
+    if resolved
+      dependency = Im.registry[resolved_path]
+
+      if loaded && Im.registry.key?(location = caller_locations(1, 1).first.path)
+        Im.registry[location].dependencies << dependency
+      end
+
+      dependency.dependencies.each { |d| require d.path }
+
+      dependency.modules.each do |m|
+        name = m.name
+
+        # Do not assign constants that are aliased to root namespace
+        root = name.split("::", 2)[0]
+        next if Object.const_defined?(root) &&
+          Im.current_import.const_defined?(root, false) &&
+          Object.const_get(root) == Im.current_import.const_get(root)
+
+        Im.current_import.const_set(name, m) unless Im.current_import.const_defined?(name, false)
+      end
+    end
+
+    return loaded
+  end
+end

data/lib/im/module.rb

@@ -0,0 +1,8 @@
+class Module
+  alias_method :im_original_autoload, :autoload
+
+  def autoload(name, path)
+    Im.autoloads[path] = Im.current_import if Im.importing?
+    im_original_autoload(name, path)
+  end
+end

data/lib/im/ruby_version_check.rb

@@ -0,0 +1,22 @@
+RubyVersionCheck = Module.new
+
+unless RubyVersionCheck.name == "RubyVersionCheck"
+  raise RuntimeError, <<~MSG
+
+
+\e[33m!!! RUNNING INCOMPATIBLE VERSION OF RUBY !!!\e[0m
+
+In order to implement module imports, Im depends on features not currently
+available in Ruby. To use it, you must build a custom version of Ruby,
+currently available at:
+
+https://github.com/shioyama/ruby/tree/import_modules
+
+Install this Ruby following the instructions here:
+
+https://docs.ruby-lang.org/en/master/contributing/building_ruby_md.html
+
+Once installed, ensure you are using this patched version and then gem install Im,
+and this message should no longer appear.
+MSG
+end

data/lib/im/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Im
+  VERSION = "0.1.4"
+end

data/lib/im.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Im
+  load $LOAD_PATH.resolve_feature_path("im/ruby_version_check")[1], true
+  require "im/version"
+  require "im/kernel"
+
+  class << self
+    attr_reader :current_import
+
+    def with_import(import)
+      original_import = current_import
+      @current_import = import
+
+      unless tracer_originally_enabled = @tracer.enabled?
+        @tracer.enable
+      end
+
+      yield(import)
+
+    ensure
+      @current_import = original_import
+      @tracer.disable unless tracer_originally_enabled
+    end
+
+    def registry
+      @registry ||= {}
+    end
+
+    def autoloads
+      @autoloads ||= {}
+    end
+
+    def importing?
+      !!Im.current_import
+    end
+  end
+
+  class Import < Module
+    def initialize(root)
+      @root = root
+      super()
+      Im::CONSTANTS.each do |const|
+        self.const_set(const, Object.const_get(const))
+      end
+    end
+
+    def inspect
+      @inspect ||= "<#Im::Import root: #{@root}>"
+    end
+  end
+
+  Dependency = Struct.new(:path, :import, :modules, :dependencies) do
+    def initialize(path, import, modules = [], dependencies = [])
+      super(path, import, modules, dependencies)
+    end
+  end
+
+  def import(path)
+    if resolved = $LOAD_PATH.resolve_feature_path(path)
+      resolved_path = resolved[1]
+      raise LoadError, "import can only import ruby files" unless resolved[0] == :rb
+    else
+      raise LoadError, "cannot load such file -- #{path}"
+    end
+
+    Im.registry.fetch(resolved_path) do
+      # handle autoload within import
+      return nil if $LOADED_FEATURES.include?(resolved_path)
+
+      $LOADED_FEATURES << resolved_path
+
+      import = Im.current_import || Import.new(path)
+      (Im.registry[resolved_path] ||= Dependency.new(resolved_path, import)).tap do
+        Im.with_import(import) do
+          load resolved_path, import
+        end
+      end
+    end&.import
+  end
+
+  # This is a hack to catch references to top-level constants (`::Foo`) and, if
+  # the calling line is a key in the Im registry, replace the toplevel constant
+  # reference with its corresponding constant under the import namespace.
+  #
+  # By doing this, a reference to `::Foo` in an imported file will resolve to
+  # `mod::Foo`, where `mod` is the import module. Ideally this should
+  # ultimately happen at the Ruby implementation level.
+  module RootNamespaceRedirect
+    def const_missing(name)
+
+      # Take top five locations to allow for other `const_missing` overrides
+      # in the backtrace. If there are more than five, then this will no longer
+      # work. This is currently very inefficient.
+      if location = caller_locations(1, 5).find { |l| Im.registry.key?(l.path) }
+        Im.registry[location.path].import.const_get(name)
+      else
+        super
+      end
+    end
+  end
+
+  @tracer = TracePoint.new(:class) do |event|
+    next unless (name = event.self.name)
+    next if Im::CONSTANTS.include?(name.to_sym)
+
+    if resolved = $LOAD_PATH.resolve_feature_path(event.path)
+      resolved_path = resolved[1]
+      if Im.registry.key?(resolved_path)
+        (Im.registry[resolved_path].modules << event.self).uniq!
+      else
+        Im.registry[resolved_path] = Dependency.new(resolved_path, Im.current_import, [event.self])
+      end
+    end
+  end
+
+  require "im/module"
+  require "im/autoload"
+  require "im/constants"
+
+  extend self
+end
+
+Object.extend Im::RootNamespaceRedirect

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: im
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Chris Salzberg
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2022-09-16 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -58,14 +58,29 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/im.rb
+- lib/im/autoload.rb
+- lib/im/constants.rb
+- lib/im/kernel.rb
+- lib/im/module.rb
+- lib/im/ruby_version_check.rb
+- lib/im/version.rb
 homepage: https://github.com/shioyama/im
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/shioyama/im
   source_code_uri: https://github.com/shioyama/im
+  bug_tracker_uri: https://github.com/shioyama/im/issues
   changelog_uri: https://github.com/shioyama/im/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: