modulation 0.32 → 0.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 598679c69845dd516cf7f19ff4ae9f60e254bf488abc1460cd08b121714b4cba
-  data.tar.gz: 6b962c6f2cea4a300918eea8ff0d142999e01a32d64e7e8d814d5d15cbfb0984
+  metadata.gz: 66ef0e0890aa7cba8f462f22cfc1ebbe81ab4cdc48b3ad9733958dc002370d85
+  data.tar.gz: aeda0965bda28cd93eb2b318f8cacc24ea342e49084230cf0cdb522d05f1182d
 SHA512:
-  metadata.gz: 1d8618b49710007df4312cfaefdaacc6291a7ca926945dae9378a6cb77efb0cd54947db9fe1cd84cfc8e39e9295aa22ed12db34be953f6df8eea0a072b32e596
-  data.tar.gz: ed6a9627b2e6dd89e0c3751b59362bf5b78dffb334934028aa2a8895922b64b80d79101a35f9e0ad7882fd6515d71bae87f3d1560c2f8a5d8cbe9ee856e460a2
+  metadata.gz: 12ea537e1662feb88a7ae35cf46a6b23e8970f4255088b20c32962792d0cc4bff4cbd611a1eadc431feb81cb768191917dc6a7eb19e2d9bc75c50ecb50e8caf4
+  data.tar.gz: 1a6b08a109333d8a4ef4513e1607ceb84f177d4287f7114699f9d1d48d7c29959d37b16205dc36eaf627a8418cd886bb6eed6a71782bad4cd8fe7adbf1e50826

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.33 2019-10-02
+---------------
+
+* Add backward compatibility with Ruby 2.4.x
+* Add support for creating modules programmatically
+* Fix use of tags in import_map, auto_import_map, include_from, extend_from
+
 0.32 2019-09-03
 ---------------
 

data/README.md

@@ -38,6 +38,7 @@ a functional style, minimizing boilerplate code.
 - [Mocking of dependencies](#mocking-dependencies) for testing purposes.
 - Can be used to [write gems](#writing-gems-using-modulation).
 - [Dependency introspection](#dependency-introspection).
+- Support for [creating modules programmatically](#programmatic-module-creation).
 - Easier [unit-testing](#unit-testing-modules) of private methods and
   constants.
 - Pack entire applications [into a single
@@ -361,6 +362,51 @@ end
 what_is = ::THE_MEANING_OF_LIFE
 ```
 
+### Programmatic module creation
+
+In addition to loading modules from files, modules can be created dynamically at
+runtime using `Modulation.create`. You can create modules by supplying a hash
+prototype, a string or a block:
+
+```ruby
+# Using a hash prototype
+m = Modulation.create(
+  add: -> x, y { x + y },
+  mul: -> x, y { x * y }
+)
+m.add(2, 3)
+m.mul(2, 3)
+
+# Using a string
+m = Modulation.create <<~RUBY
+export :foo
+
+def foo
+  :bar
+end
+RUBY
+
+m.foo
+
+# Using a block
+m = Modulation.create do { |mod|
+  export :foo
+
+  def foo
+    :bar
+  end
+
+  class mod::BAZ
+    ...
+  end
+}
+
+m.foo
+```
+
+The creation of a objects using a hash prototype is also available as a separate
+gem called [eg](https://github.com/digital-fabric/eg/).
+
 ### Unit testing modules
 
 Methods and constants that are not exported can be tested using the `#__expose!`

data/lib/modulation/builder.rb

@@ -55,7 +55,7 @@ module Modulation
       # @return [void]
       def load_module_code(mod, info)
         path = info[:location]
-        mod.instance_eval(info[:source] || IO.read(path), path)
+        mod.instance_eval(info[:source] || IO.read(path), path || '(source)')
       end
 
       def finalize_module_exports(info, mod)
@@ -125,7 +125,7 @@ module Modulation
       def add_module_constants(mod, target, *symbols)
         exported = mod.__module_info[:exported_symbols]
         unless symbols.empty?
-          symbols.select! { |s| s =~ /^[A-Z]/ }
+          symbols.select! { |s| s =~ Modulation::RE_CONST }
           exported = filter_exported_symbols(exported, symbols)
         end
         mod.singleton_class.constants(false).each do |sym|
@@ -150,7 +150,7 @@ module Modulation
       #   file and a caller location
       # @return [void]
       def define_auto_import_const_missing_method(receiver, auto_import_hash)
-        receiver.singleton_class.define_method(:const_missing) do |sym|
+        receiver.singleton_class.send(:define_method, :const_missing) do |sym|
           (path, caller_location) = auto_import_hash[sym]
           path ? const_set(sym, import(path, caller_location)) : super(sym)
         end

data/lib/modulation/core.rb

@@ -4,6 +4,7 @@
 module Modulation
   require_relative './paths'
   require_relative './builder'
+  require_relative './creator'
   require_relative './module_mixin'
 
   RE_CONST = /^[A-Z]/.freeze
@@ -153,6 +154,19 @@ module Modulation
     def add_tags(tags)
       Paths.add_tags(tags, caller(CALLER_RANGE).first)
     end
+
+    def create(arg = nil, &block)
+      return Creator.from_block(block) if block
+
+      case arg
+      when Hash
+        Creator.from_hash(arg)
+      when String
+        Creator.from_string(arg)
+      else
+        raise 'Invalid argument'
+      end
+    end
   end
 end
 

data/lib/modulation/creator.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Modulation
+  # Implements programmtically created modules
+  module Creator
+    RE_CONST  = /^[A-Z]/.freeze
+    RE_ATTR   = /^@(.+)$/.freeze
+
+    class << self
+      # Creates a module from a prototype hash
+      # @param hash [Hash] prototype hash
+      # @return [Module] created object
+      def from_hash(hash)
+        Module.new.tap do |m|
+          s = m.singleton_class
+          hash.each do |k, v|
+            if k =~ RE_CONST
+              m.const_set(k, v)
+            elsif k =~ RE_ATTR
+              m.instance_variable_set(k, v)
+            elsif v.respond_to?(:to_proc)
+              s.send(:define_method, k) { |*args| instance_exec(*args, &v) }
+            else
+              s.send(:define_method, k) { v }
+            end
+          end
+        end
+      end
+
+      def from_string(str)
+        m = Builder.make(source: str)
+      end
+
+      def from_block(block)
+        Module.new.tap { |m| m.instance_eval(&block) }
+      end
+    end
+  end
+end

data/lib/modulation/export_default.rb

@@ -14,8 +14,7 @@ module Modulation
       def transform_export_default_value(value, mod)
         return value unless value.is_a?(Symbol)
 
-        case value
-        when /^[A-Z]/
+        if value =~ Modulation::RE_CONST
           get_module_constant(mod, value)
         else
           get_module_method(mod, value)

data/lib/modulation/export_from_receiver.rb

@@ -15,19 +15,21 @@ module Modulation
       # @return [Array] list of receiver methods
       def create_forwarding_methods(mod, receiver)
         receiver_methods(receiver).each do |m|
-          mod.singleton_class.define_method(m) do |*args, &block|
+          mod.singleton_class.send(:define_method, m) do |*args, &block|
             receiver.send(m, *args, &block)
           end
         end
       end
 
+      RE_RESERVED_METHOD = /^__/.freeze
+
       def receiver_methods(receiver)
         ignored_klass = case receiver
                         when Class, Module then receiver.class
                         else Object
                         end
-        
-        methods = receiver.methods.select { |m| m !~ /^__/ }
+
+        methods = receiver.methods.reject { |m| m =~ RE_RESERVED_METHOD }
         methods - ignored_klass.instance_methods
       end
 

data/lib/modulation/exports.rb

@@ -35,11 +35,11 @@ module Modulation
       end
 
       def export_from_receiver(mod, name)
-        if name =~ Modulation::RE_CONST
-          ExportFromReceiver.from_const(mod, name)
-        else
+        if name !~ Modulation::RE_CONST
           raise 'export_from_receiver expects a const reference'
         end
+
+        ExportFromReceiver.from_const(mod, name)
       end
 
       def validate_exported_symbols(mod, symbols)
@@ -86,7 +86,7 @@ module Modulation
           singleton.alias_method(key, value)
         else
           value_proc = value.is_a?(Proc) ? value : proc { value }
-          singleton.define_method(key, &value_proc)
+          singleton.send(:define_method, key, &value_proc)
         end
       end
 

data/lib/modulation/module_mixin.rb

@@ -37,10 +37,12 @@ module Modulation
       }
     end
 
+    EXPORT_DEFAULT_ERROR_MSG = <<~MSG
+      Cannot mix calls to export_from_receiver and export_default in same module
+    MSG
+
     def export_from_receiver(name)
-      if @__export_default_info
-        raise 'Cannot mix calls to export_from_receiver and export_default in same module'
-      end
+      raise EXPORT_DEFAULT_ERROR_MSG if @__export_default_info
 
       @__export_directives ||= []
       @__export_directives << {

data/lib/modulation/paths.rb

@@ -5,7 +5,8 @@ module Modulation
   module Paths
     class << self
       def process(path, caller_location)
-        tagged_path(path) || absolute_path(path, caller_location) ||
+        path = expand_tag(path)
+        absolute_path(path, caller_location) ||
           lookup_gem_path(path)
       end
 
@@ -23,17 +24,13 @@ module Modulation
         end
       end
 
-      def tagged_path(path)
-        return nil unless @tags
+      RE_TAG = /^@([^\/]+)/.freeze
 
-        _, tag, path = path.match(TAGGED_REGEXP).to_a
-        return nil unless tag
-
-        base_path = @tags[tag]
-        return nil unless base_path
-
-        path = path ? File.join(base_path, path) : base_path
-        check_path(path)
+      def expand_tag(path)
+        path.sub RE_TAG do
+          tag = Regexp.last_match[1]
+          (@tags && @tags[tag]) || (raise "Invalid tag #{tag}")
+        end
       end
 
       # Resolves the absolute path to the provided reference. If the file is not
@@ -54,6 +51,7 @@ module Modulation
       # @param caller_location [String] caller location
       # @return [String] absolute directory path
       def absolute_dir_path(path, caller_location)
+        path = expand_tag(path)
         caller_file = caller_location[CALLER_FILE_REGEXP, 1]
         return nil unless caller_file
 

data/lib/modulation/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Modulation
-  VERSION = '0.32'
+  VERSION = '0.33'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulation
 version: !ruby/object:Gem::Version
-  version: '0.32'
+  version: '0.33'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-03 00:00:00.000000000 Z
+date: 2019-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -56,7 +56,7 @@ files:
 - lib/modulation.rb
 - lib/modulation/builder.rb
 - lib/modulation/core.rb
-- lib/modulation/default_export.rb
+- lib/modulation/creator.rb
 - lib/modulation/export_default.rb
 - lib/modulation/export_from_receiver.rb
 - lib/modulation/exports.rb

data/lib/modulation/default_export.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-module Modulation
-  # default export functionality
-  module ExportDefault
-    class << self
-      # Returns exported value for a default export
-      # If the given value is a symbol, returns the value of the corresponding
-      # constant. If the symbol refers to a method, returns a proc enveloping
-      # the method. Raises if symbol refers to non-existent constant or method.
-      # @param value [any] export_default value
-      # @param mod [Module] module
-      # @return [any] exported value
-      def transform_export_default_value(value, mod)
-        return value unless value.is_a?(Symbol)
-
-        case value
-        when /^[A-Z]/
-          get_module_constant(mod, value)
-        else
-          get_module_method(mod, value)
-        end
-      end
-
-      def get_module_constant(mod, value)
-        unless mod.singleton_class.constants(true).include?(value)
-          Exports.raise_exported_symbol_not_found_error(value, :const)
-        end
-
-        mod.singleton_class.const_get(value)
-      end
-
-      def get_module_method(mod, value)
-        unless mod.singleton_class.instance_methods(true).include?(value)
-          Exports.raise_exported_symbol_not_found_error(value, :method)
-        end
-
-        proc { |*args, &block| mod.send(value, *args, &block) }
-      end
-
-      # Error message to be displayed when trying to set a singleton value as
-      # default export
-      DEFAULT_VALUE_ERROR_MSG =
-        'Default export cannot be boolean, numeric, or symbol'
-
-      # Sets the default value for a module using export_default
-      # @param value [any] default value
-      # @param info [Hash] module info
-      # @param mod [Module] module
-      # @return [any] default value
-      def set_module_default_value(value, info, mod, caller)
-        value = transform_export_default_value(value, mod)
-        case value
-        when nil, true, false, Numeric, Symbol
-          raise(TypeError, DEFAULT_VALUE_ERROR_MSG, caller)
-        end
-        set_reload_info(value, mod.__module_info)
-        Modulation.loaded_modules[info[:location]] = value
-      end
-
-      # Adds methods for module_info and reloading to a value exported as
-      # default
-      # @param value [any] export_default value
-      # @param info [Hash] module info
-      # @return [void]
-      def set_reload_info(value, info)
-        value.define_singleton_method(:__module_info) { info }
-        value.define_singleton_method(:__reload!) do
-          Modulation::Builder.make(info)
-        end
-      end
-    end
-  end
-end