modspace 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2930117c3d626d7606136b50133295902be4eb26cf4ea6377f8216964eec5140
-  data.tar.gz: 0d9db6db194eab6c1ae0d2b89b412f45fbdb7d63c7280b8b4cc9a1fbfe647f5f
+  metadata.gz: 95e3764e4a780cee8b92285aa671e446427ba71fa0ce412f093ea0ac8703359d
+  data.tar.gz: 8be8b893403b4db6eac524f133ff4b757d6c458c3669eddd5470172ba1d651a5
 SHA512:
-  metadata.gz: 3b409b9dfd31444b2e63fa3a545d3141b871407145fb159c3336dad316254aae4db1aed91682a853662a22f8fe7267f0c06da9c478708ff04ffe1e57d396814d
-  data.tar.gz: ae8fc8258b54aee5a422606a72e0189a6b88dde8195c7a9aa7fdd364f5e881f85113fe4a188b8183238e37c68b0d08af59b45e3aa254f31c95a67eeb301a99d7
+  metadata.gz: 8ecbd9b92e35b7376b9750bba5a7618d16d157c75cabe512e5024a26e59dccf3e09cbc25cdb9a3842c42148ad25aeca951f510776cf34915813aa2578633b869
+  data.tar.gz: 75fe9c045adf2ad4923f48277da8706ac76d92c4033b65db63873996c86873781549629eb812bd9c189e7cd084f011bca9e60e82703dc1a3ba898d95f8e48f16

data/Gemfile.lock

@@ -1,13 +1,11 @@
 PATH
   remote: .
   specs:
-    modspace (0.1.0)
-      byebug (~> 11.1.3)
+    modspace (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    byebug (11.1.3)
     diff-lcs (1.4.4)
     rake (12.3.3)
     rspec (3.9.0)

data/README.md

@@ -77,7 +77,7 @@ Define a new namespace (ie. nested module), such as `Foo::Bar::Zoo` in one line.
     Modspace.def_mod('Foo', 'Bar', 'Zoo')
     # Note: This creates the namespace Foo::Bar::Zoo
 
-    # Implementation
+    # Implement the module you want with the methods you want...
     module Foo::Bar::Zoo::Shoe
         def some_funct
             puts "Eek"
@@ -87,6 +87,44 @@ Define a new namespace (ie. nested module), such as `Foo::Bar::Zoo` in one line.
 __Note: You only need to define the parent namespace. For example, we
 omit "Shoe" from the initial namespace definition above.__
 
+You can also use a shortcut syntax that looks more like the nested
+module syntax in Ruby...
+
+    require 'modspace'
+
+    # Define parent namespace
+    Modspace.def_mod('Foo::Bar::Zoo')
+    # Note: This creates the namespace Foo::Bar::Zoo
+
+    # Same as before, implement the module you want with the methods you want...
+    module Foo::Bar::Zoo::Shoe
+        def some_funct
+            puts "Eek"
+        end
+    end
+
+All this is quite handle if you are doing functional programming or
+modular programming in Ruby...
+
+    require 'modspace'
+
+    # Define parent namespace
+    Modspace.def_mod('Foo::Bar::Zoo')
+    # Note: This creates the namespace Foo::Bar::Zoo
+
+    # Same as before, implement the module you want with the methods you want...
+    module Foo::Bar::Zoo::Shoe
+        class << self
+            def some_funct
+                puts "Eek"
+            end
+        end
+    end
+
+    # Call you neatly scoped module!
+    Foo::Bar::Zoo::Shoe.some_funct
+    # => "Eek"
+
 For more examples, see the `examples/` directory.
 
 ## Contributing

data/examples/simple_example.rb

@@ -17,7 +17,7 @@ end
 
 # ^ Note: Defaults to defining the namespace within "Object", as that is the top-level namespace within Ruby programs
 
-# 2) Create a new namespace (ie. nested module) and assign it to a variable...
+# 2) Create a new namespace and assign it to a variable...
 zoo2_module = Modspace.def_mod('Foo', 'Bar', 'Zoo2')
 
 if zoo2_module == Foo::Bar::Zoo2
@@ -26,7 +26,7 @@ else
     raise StandardError
 end
 
-# 3) Create a new namespace (ie. nested module) within a class...
+# 3) Create a new namespace within a class...
 class SomeClass; end
 
 zoo3_module = Modspace.def_mod('Foo', 'Bar', 'Zoo3', in_namespace: SomeClass)
@@ -37,7 +37,7 @@ else
     raise StandardError
 end
 
-# 4) Create a new namespace (ie. nested module) within a class...
+# 4) Create a new namespace within a class given an instance...
 
 an_instance_of_some_class = SomeClass.new
 
@@ -49,7 +49,7 @@ else
     raise StandardError
 end
 
-# 5) Create a new namespace (ie. nested module) within a module...
+# 5) Create a new namespace within a module...
 module SomeModule; end
 
 zoo5_module = Modspace.def_mod('Foo', 'Bar', 'Zoo5', in_namespace: SomeModule)
@@ -59,3 +59,14 @@ if zoo5_module == SomeModule::Foo::Bar::Zoo5
 else
     raise StandardError
 end
+
+# 6) Create a new namespace within a module using the shortcut syntax...
+module SomeModule; end
+
+zoo6_module = Modspace.def_mod('Foo::Bar::Zoo6', in_namespace: SomeModule)
+
+if zoo6_module == SomeModule::Foo::Bar::Zoo6
+    puts "6) We have defined a nested module Foo::Bar::Zoo5 within an explicit module using shortcut syntax"
+else
+    raise StandardError
+end

data/lib/modspace.rb

@@ -10,6 +10,8 @@ module Modspace
         # for our purposes.
 
         def def_mod(*args, in_namespace: Object, in_class_of_instance: nil)
+            normalised_args = expand_any_double_colon_namespace_args(args)
+
             parent_namespace = if !in_class_of_instance.nil?
                 in_class_of_instance.class
             elsif !in_namespace.nil? # :in_namespace can be a module or class
@@ -18,7 +20,7 @@ module Modspace
                 raise ArgumentError, "If in_class or for_instance non-nil is specified they must be non-nil."
             end
 
-            defp_class_mod(parent_namespace, *args)
+            defp_class_mod(parent_namespace, *normalised_args)
         end
 
         private
@@ -45,5 +47,10 @@ module Modspace
 
             defp_class_mod(desired_nested_module, *nesting_list)
         end
+
+        # This method takes args like ["Foo::Bar::Zoo"] and turns them into ["Foo", "Bar", "Zoo"]
+        def expand_any_double_colon_namespace_args(args_arr)
+            args_arr.map{|arg| arg.split('::') }.flatten
+        end
     end
 end

data/lib/modspace/version.rb

@@ -1,3 +1,3 @@
 module Modspace
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/modspace.gemspec

@@ -25,5 +25,4 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "byebug", "~> 11.1.3"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: modspace
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - declan@weuseopensource.com
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-04 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 11.1.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 11.1.3
+date: 2020-07-20 00:00:00.000000000 Z
+dependencies: []
 description: Modspace is a small library to allow the easy definition and management
   of namespaces and nested modules in Ruby.
 email: