modulation 0.11 → 0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c196472c3122b723a0d76849c604cb6b8ce13cc2613cb418bf8ecbf9c794bbe8
-  data.tar.gz: cd027cc00a894ed92c43db09570ee301b82efb002d410d6daf9a584aca8c8357
+  metadata.gz: 72f329f0720d40aea09237c6cce4dc9eeb5ccfd3a94d78ae7d9ce956ea016051
+  data.tar.gz: 1541fdfbef9bec5ab3b7f6ed14a5eb7445f01b9c240baaf89b77959b9e0ffcfe
 SHA512:
-  metadata.gz: 9c4d82cb9ae8ea84364dffbdd56603bf7db864d4254a587545436c983e157d315068cde11e51fbfec84cb8db08382769506e8f5273f70a64f4440d56150b18f4
-  data.tar.gz: bf00f6e03d79ce2a2c77322aee2f433780989030cceffc031421dcec419c1f9e7bf4a9c8cf178864942e12ceb713760e4b5634a430b5b21e5840e342608d151a
+  metadata.gz: bb267ba2a1a29119346c0ccd9d001f77614945a43c4e7006b5d4900f9de9812e4afff393ec3eb7c1ffb9bf5e2ba539ef51e4811bbd203b08e66602711bb57856
+  data.tar.gz: 5fbb09abc67eaa52d345f3c9d828a46a1bcd0b77f7a36317e9d2c81e5465009bc537df80ce437c1ed64ca01e61cf1883381531206d60856a916c9a6d73562c1b

data/CHANGELOG.md

@@ -0,0 +1,56 @@
+## [0.12] 2018-08-20
+
+* Fix sanitizing of error backtrace.
+* Fix importing of gems.
+
+## [0.11] 2018-08-20
+
+* Add Modulation.mock for use in testing.
+
+## [0.10] 2018-08-19
+
+* Refactor and cleanup code.
+
+## [0.9.1] 2018-08-15
+
+* Small fixes to README.
+
+## [0.9] 2018-08-13
+
+* Add support for module reloading.
+
+## [0.8] 2018-08-05
+
+* Add support for nested namespaces.
+* Add support for circular dependencies.
+
+## [0.7] 2018-07-29
+
+* Add `MODULE` constant for accessing module from nested namespaces within itself
+
+## [0.6] 2018-07-23
+
+* Add support for using gems as imported modules (experimental feature)
+* Add Modulation.full_trace! method for getting full backtrace on errors
+* Fix Modulation.transform_export_default_value
+* Change name to *Modulation*
+
+## [0.5.1] 2018-07-20
+
+* Fix extend_from, include_from to work with ruby 2.4
+
+## [0.5] 2018-07-19
+
+* Add extend_from, include_from to include imported methods in classes and modules
+
+## [0.4] 2018-07-19
+
+* Refactor code
+* Add tests
+* Remove namespace feature (owing to the way Ruby handles constants in blocks)
+
+## [0.3.3] 2018-07-09
+
+* Switch to explicit exports
+* More documentation
+* Better error handling

data/README.md

@@ -393,14 +393,17 @@ end
 
 Gems written using modulation can also be loaded using `import`. If modulation
 does not find the module specified by the given relative path, it will attempt
-to load a gem by the same name.
-
-> **Note**: using `import` to load a gem is very much *experimental*, and might
-> introduce problems not encountered when loading with `require` such as 
-> shadowing of global namespaces, or any other bizarre and unexpected
-> behaviors. Actually, there's not much point in using it to load a gem which
-> does not use Modulation. When loading gems using import, Modulation will
-> raise an exception if no symbols were exported by the gem.
+to load a gem by the same name. It is also possible to load specific files
+inside modules by specifying a sub-path:
+
+```ruby
+require 'modulation'
+MyFeature = import 'my_gem/my_feature'
+```
+
+> **Note**: Since there's not much of a point in `import`ing gems that do not use
+> Modulation to export symbols, Modulation will refuse to import any gem that
+> does not depend on Modulation.
 
 ## Coding style recommendations
 

data/lib/modulation.rb

@@ -1,4 +1,8 @@
 # frozen_string_literal: true
 
+module Modulation
+  DIR = File.dirname(__FILE__)
+end
+
 require_relative 'modulation/ext'
 require_relative 'modulation/core'

data/lib/modulation/core.rb

@@ -26,14 +26,27 @@ module Modulation
     @full_backtrace = true
   end
 
+  GEM_REQUIRE_ERROR_MESSAGE = <<~EOF
+    Can't import from a gem that doesn't depend on Modulation. Please use `require` instead of `import`.
+  EOF
+
   # Imports a module from a file
   # If the module is already loaded, returns the loaded module.
   # @param path [String] unqualified file name
   # @param caller_location [String] caller location
   # @return [Module] loaded module object
   def import(path, caller_location = caller(1..1).first)
-    path = Paths.absolute_path(path, caller_location)
-    @loaded_modules[path] || create_module_from_file(path)
+    abs_path = Paths.absolute_path(path, caller_location) ||
+               Paths.lookup_gem_path(path)
+
+    case abs_path
+    when String
+      @loaded_modules[abs_path] || create_module_from_file(abs_path)
+    when :require_gem
+      raise_error(LoadError.new(GEM_REQUIRE_ERROR_MESSAGE), caller)
+    else
+      raise_error(LoadError.new("Module not found: #{path}"), caller)
+    end
   end
 
   # Creates a new module from a source file
@@ -42,16 +55,21 @@ module Modulation
   def create_module_from_file(path)
     Builder.make(location: path)
   rescue StandardError => e
-    @full_backtrace ? raise : raise_with_clean_backtrace(e)
+    raise_error(e)
   end
 
-  # (Re-)raises an error, filtering its backtrace to remove stack frames
-  # occuring in Modulation code
+  # (Re-)raises an error, potentially filtering its backtrace to remove stack
+  # frames occuring in Modulation code
   # @param error [Error] raised error
+  # @param caller [Array] error backtrace
   # @return [void]
-  def raise_with_clean_backtrace(error)
-    backtrace = error.backtrace.reject { |l| l.include?(__FILE__) }
-    raise(error, error.message, backtrace)
+  def raise_error(error, caller = error.backtrace)
+    if @full_backtrace
+      error.set_backtrace(caller)
+    else
+      error.set_backtrace(caller.reject { |l| l =~ /^#{Modulation::DIR}/ })
+    end
+    raise error
   end
 
   # Reloads the given module from its source file
@@ -70,7 +88,7 @@ module Modulation
     mod.tap { Builder.set_exported_symbols(mod, mod.__exported_symbols, true) }
   end
 
-  # Maps the given path to the given mock module, restoring the previously 
+  # Maps the given path to the given mock module, restoring the previously
   # loaded module (if any) after calling the given block
   # @param path [String] module path
   # @param mod [Module] module

data/lib/modulation/paths.rb

@@ -13,14 +13,12 @@ module Modulation
     # @param path [String] unqualified file name
     # @param caller_location [String] caller location
     # @return [String] absolute file name
-    def absolute_path(path, caller_location = caller(1..1).first)
-      orig_path = path
+    def absolute_path(path, caller_location)
       caller_file = caller_location[CALLER_FILE_REGEXP, 1]
-      raise 'Could not expand path' unless caller_file
+      return nil unless caller_file
 
       path = File.expand_path(path, File.dirname(caller_file))
-      check_path(path) || lookup_gem(orig_path) ||
-        (raise "Module not found: #{path}")
+      check_path(path)
     end
 
     # Checks that the given path references an existing file, adding the .rb
@@ -35,19 +33,44 @@ module Modulation
       end
     end
 
-    # Resolves the provided file name into a gem. If no gem is found, returns
-    # nil
+    GEM_NAME_RE = /^([^\/]+)/
+
+    # Resolves the provided path by looking for a corresponding gem. If no gem
+    # is found, returns nil. If the corresponding gem does not use modulation,
+    # returns :require_gem, which signals that the gem must be required.
     # @param name [String] gem name
-    # @return [String] absolute path to gem main source file
-    def lookup_gem(name)
-      spec = Gem::Specification.find_by_name(name)
-      unless spec.dependencies.map(&:name).include?('modulation')
-        raise NameError, 'Cannot import gem not based on modulation'
+    # @return [String, Symbol] absolute path or :require_gem
+    def lookup_gem_path(name)
+      gem = name[GEM_NAME_RE, 1] || name
+      spec = Gem::Specification.find_by_name(gem)
+
+      if gem_uses_modulation?(spec)
+        find_gem_based_path(spec, name)
+      else
+        :require_gem
       end
-      path = File.join(spec.full_require_paths, "#{name}.rb")
-      File.file?(path) ? path : nil
     rescue Gem::MissingSpecError
       nil
     end
+
+    # Returns true if given gemspec depends on modulation, which means it can
+    # be loaded using `import`
+    # @param gemspec [Gem::Specification] gem spec
+    # @return [Boolean] does gem depend on modulation?
+    def gem_uses_modulation?(gemspec)
+      gemspec.dependencies.map(&:name).include?('modulation')
+    end
+
+    # Finds full path for gem file based on gem's require paths
+    # @param gemspec [Gem::Specification] gem spec
+    # @param path [String] given import path
+    # @return [String] full path
+    def find_gem_based_path(gemspec, path)
+      gemspec.full_require_paths.each do |p|
+        full_path = check_path(File.join(p, path))
+        return full_path if full_path
+      end
+      nil
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: modulation
 version: !ruby/object:Gem::Version
-  version: '0.11'
+  version: '0.12'
 platform: ruby
 authors:
 - Sharon Rosner
@@ -9,7 +9,35 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2018-08-20 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.1
 description: "Modulation provides an better way to organize Ruby code. Modulation
   lets you \nexplicitly import and export declarations in order to better control
   \ndependencies in your codebase. Modulation helps you refrain from littering\nthe
@@ -19,7 +47,9 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
+- CHANGELOG.md
 files:
+- CHANGELOG.md
 - README.md
 - lib/modulation.rb
 - lib/modulation/builder.rb