alias2 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2ca79b58531d2f43d184204d979e460be1132e27
-  data.tar.gz: 414e6aedd76c1b46a7ceb0c6dedfe264003d8769
+SHA256:
+  metadata.gz: '086b102714da0bad17fa027730bab6e2b5db8ed1dbd76e4813cc94754e0b4324'
+  data.tar.gz: 91c87e7e03ed79033b487cb45d4c0aac9a579f5bccecebe02f3a52fb3dba2a38
 SHA512:
-  metadata.gz: 513da498fe3e3e4c61ef3702eae7ff711790d9a0e4d6802560c08595205eb8ab7270119e2bdc489f23f8cd9bd32f3fd766e5f9001ab54abb39695e893b027cd0
-  data.tar.gz: 648985efa3ef7b101f03b9f4c80a1b8f0a9781148ba3d3d9d64b0cc9906ffddbdb37920dae89e89d1bddfbbcf9defb45c4758147d2fa74f9bf8f63968ce81302
+  metadata.gz: c737a1662da7810bb640f830870a1a23227299dde7ddcf1c7a134ee6275413b517515b70104dbe42dc5b4228649626433c2e37e25f8af9da71ee6841188cb01d
+  data.tar.gz: 2b499f4df51047583bfd0da28377f4e8403fa2f408a7aa4a9f5189891ca9a67f0f0e01f48ee162de849fec0f4c7ae0866f6bcae986285dc01e2d5931d8c69a02

data/README.md

@@ -25,6 +25,18 @@ Baz = Some::Very::Long::Name::Here::Baz
 
 The namespace can also be a `String`.
 
+To alias everything in the namespace to the top-level:
+```rb
+alias2 Some::Very::Long::Name::Here, "*"
+```
+
+Same as above:
+```rb
+Foo = Some::Very::Long::Name::Here::Foo
+Bar = Some::Very::Long::Name::Here::Bar
+Baz = Some::Very::Long::Name::Here::Baz
+```
+
 If you'd like to alias them using a different name you can:
 ```rb
 alias2 Some::Very::Long::Name::Here, :Foo => "FooHoo", :Bar => "BarHar", :Baz => "Bazzzz"
@@ -34,12 +46,42 @@ Same as:
 ```rb
 FooHoo = Some::Very::Long::Name::Here::Foo
 BarHar = Some::Very::Long::Name::Here::Bar
-Bazzzz = Some::Very::Long::Name::Here::Bar
+Bazzzz = Some::Very::Long::Name::Here::Baz
 ```
 
 Keys can also be `String`s.
 
-The target can be a namespace you want created:
+You can filter the classes/modules to alias:
+```rb
+alias2 Some::Very::Long::Name::Here, "*" do |klass|
+  klass < ActiveRecord::Base
+end
+```
+
+The above is the same as:
+```rb
+Foo = Some::Very::Long::Name::Here::Foo if Some::Very::Long::Name::Here::Foo.is_a?(ActiveRecord::Base)
+Bar = Some::Very::Long::Name::Here::Bar if Some::Very::Long::Name::Here::Bar.is_a?(ActiveRecord::Base)
+Baz = Some::Very::Long::Name::Here::Baz if Some::Very::Long::Name::Here::Baz.is_a?(ActiveRecord::Base)
+```
+
+When a block is given you can omit the alias. It will default to `"*"`.
+
+The block can also return an alias:
+```rb
+alias2 Some::Very::Long::Name::Here do |klass|
+  klass.name.end_with?("Foo") ? "Foo_X" : klass.name.split("::")[-1]
+end
+```
+
+This is the same as:
+```rb
+Foo_X = Some::Very::Long::Name::Here::Foo if Some::Very::Long::Name::Here::Foo.name.end_with?("Foo")
+Bar = Some::Very::Long::Name::Here::Bar
+Baz = Some::Very::Long::Name::Here::Baz
+```
+
+An alias' target can also be a namespace you want created:
 ```rb
 alias2 Some::Very::Long::Name::Here, :Foo => "New::Namespace::SameFoo", :Bar => "BarHar"
 ```
@@ -70,12 +112,13 @@ In all cases the original namespace is not modified and remains in scope.
 
 ### Errors
 
-A `NameError` is raised when a constant cannot be found or when a constant is already defined.
+- `NameError` - raised when a constant cannot be found or when a constant is already defined
+- `ArgumentError` - raised when an alias list or block is not provided
 
 ## See Also
 
 * [aliased](https://metacpan.org/pod/aliased) - The Perl module that served as inspiration
-* [require2](https://github.com/sshaw/require2) - `Kernel#require` something and make it accessible via a different namespace
+* [require3](https://github.com/sshaw/require3) - `Kernel#require` something and make it accessible via a different namespace
 * [class2](https://github.com/sshaw/class2) - Easily create hierarchies that support nested attributes, type conversion, serialization and more
 
 ## Author

data/lib/alias2.rb

@@ -1,13 +1,30 @@
+# frozen_string_literal: true
+
 module Alias2
-  VERSION = "0.0.1".freeze
+  VERSION = "0.1.0".freeze
 
   class << self
-    def alias(namespace, aliases)
+    def alias(namespace, aliases = nil)
+      raise ArgumentError, "you must provide an alias or a block" if aliases.nil? && !block_given?
+
       namespace = constant(namespace)
+      aliases = find_names(namespace) if aliases.nil? || aliases == "*"
+
       if aliases.is_a?(String)
         set(namespace, aliases)
-      else
-        aliases.each { |target, alias_as| set(namespace.const_get(target), (alias_as || target).to_s) }
+        return
+      end
+
+      aliases.each do |target, alias_as|
+        klass = namespace.const_get(target)
+        if block_given?
+          keep_or_alias = yield klass
+          next unless keep_or_alias
+          # Block returned a new alias
+          alias_as = keep_or_alias if keep_or_alias != true
+        end
+
+        set(klass, (alias_as || target).to_s)
       end
 
       nil
@@ -20,6 +37,16 @@ module Alias2
       Object.const_get(namespace)
     end
 
+    def find_names(namespace)
+      names = []
+      namespace.constants.each do |name|
+        const = namespace.const_get(name)
+        names << name if const.is_a?(Module)
+      end
+
+      names
+    end
+
     # Stolen from class2: https://github.com/sshaw/class2
     def find_and_or_create_namespace(str)
       parts = str.split("::")
@@ -51,7 +78,7 @@ module Alias2
 end
 
 unless %w[true 1].include?(ENV["ALIAS2_NO_EXPORT"])
-  def alias2(target, alias_as)
-    Alias2.alias(target, alias_as)
+  def alias2(target, alias_as = nil, &block)
+    Alias2.alias(target, alias_as, &block)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alias2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Skye Shaw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-03 00:00:00.000000000 Z
+date: 2019-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,8 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Make classes, modules, and constants accessible via a different namespace