modspace 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2930117c3d626d7606136b50133295902be4eb26cf4ea6377f8216964eec5140
+  data.tar.gz: 0d9db6db194eab6c1ae0d2b89b412f45fbdb7d63c7280b8b4cc9a1fbfe647f5f
+SHA512:
+  metadata.gz: 3b409b9dfd31444b2e63fa3a545d3141b871407145fb159c3336dad316254aae4db1aed91682a853662a22f8fe7267f0c06da9c478708ff04ffe1e57d396814d
+  data.tar.gz: ae8fc8258b54aee5a422606a72e0189a6b88dde8195c7a9aa7fdd364f5e881f85113fe4a188b8183238e37c68b0d08af59b45e3aa254f31c95a67eeb301a99d7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in modspace.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    modspace (0.1.0)
+      byebug (~> 11.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  modspace!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Declan McGrath declan@weuseopensource.com
+
+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,99 @@
+# Modspace
+
+
+Modspace is a small library to allow the easy definition and management of namespaces and nested modules in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'modspace'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install modspace
+
+## The Problem
+
+In Ruby, if you want to define nested modules you typically have to do some
+extreme indentation in your source code files. For example, to define
+a function - `some_funct()` - in a module, such as `Foo::Bar::Zoo::Shoe`,
+would require this...
+
+    module Foo
+        module Bar
+            module Zoo
+                module Shoe
+                    def some_funct
+                        puts "Eek"
+                    end
+                end
+            end
+        end
+    end
+
+This "nested plane of death" can be a massive pain. Not only does it
+look awkward but, given many teams have coding standards with set line
+length limits, it quickly eats up your available character count. Why
+should a developer be penalised for nesting modules? (Unneccessary
+nesting is not recommended of course!) One solution is to define the
+parent namespace in advance of the implementation - and this is much
+better...
+
+    # Define parent namespace
+    module Foo
+        module Bar
+            module Zoo
+            end
+        end
+    end
+
+    # Implementation
+    module Foo::Bar::Zoo::Shoe
+        def some_funct
+            puts "Eek"
+        end
+    end
+
+_Note: We use the term "namespace" to mean a nested module or nested class._
+
+__The Modspace gem goes the extra mile and let's you clean up the
+definition of the parent namespace (or any namespace for that matter) as
+we will see in the next section.__
+
+## Usage
+
+Define a new namespace (ie. nested module), such as `Foo::Bar::Zoo` in one line...
+
+    require 'modspace'
+
+    # Define parent namespace
+    Modspace.def_mod('Foo', 'Bar', 'Zoo')
+    # Note: This creates the namespace Foo::Bar::Zoo
+
+    # Implementation
+    module Foo::Bar::Zoo::Shoe
+        def some_funct
+            puts "Eek"
+        end
+    end
+
+__Note: You only need to define the parent namespace. For example, we
+omit "Shoe" from the initial namespace definition above.__
+
+For more examples, see the `examples/` directory.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/theirishpenguin/modspace.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "modspace"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/simple_example.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+# This line is only needed if you don't have the modspace gem installed (and
+# you are in the root directory of modspace cloned repo
+$:.unshift File.dirname('./lib/modspace')
+
+require 'modspace'
+
+# 1) Create a new namespace (ie. nested module) in one line...
+Modspace.def_mod('Foo', 'Bar', 'Zoo1')
+
+if Foo::Bar::Zoo1.is_a? Module
+    puts "1) We have defined a nested module Foo::Bar::Zoo1"
+else
+    raise StandardError
+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...
+zoo2_module = Modspace.def_mod('Foo', 'Bar', 'Zoo2')
+
+if zoo2_module == Foo::Bar::Zoo2
+    puts "2) We have defined a nested module Foo::Bar::Zoo2 and assigned it to the variable zoo2_module"
+else
+    raise StandardError
+end
+
+# 3) Create a new namespace (ie. nested module) within a class...
+class SomeClass; end
+
+zoo3_module = Modspace.def_mod('Foo', 'Bar', 'Zoo3', in_namespace: SomeClass)
+
+if zoo3_module == SomeClass::Foo::Bar::Zoo3
+    puts "3) We have defined a nested module Foo::Bar::Zoo3 within an explicit class"
+else
+    raise StandardError
+end
+
+# 4) Create a new namespace (ie. nested module) within a class...
+
+an_instance_of_some_class = SomeClass.new
+
+zoo4_module = Modspace.def_mod('Foo', 'Bar', 'Zoo4', in_class_of_instance: an_instance_of_some_class)
+
+if zoo4_module == SomeClass::Foo::Bar::Zoo4
+    puts "4) We have defined a nested module Foo::Bar::Zoo4 within the class of a specified object"
+else
+    raise StandardError
+end
+
+# 5) Create a new namespace (ie. nested module) within a module...
+module SomeModule; end
+
+zoo5_module = Modspace.def_mod('Foo', 'Bar', 'Zoo5', in_namespace: SomeModule)
+
+if zoo5_module == SomeModule::Foo::Bar::Zoo5
+    puts "5) We have defined a nested module Foo::Bar::Zoo5 within an explicit module"
+else
+    raise StandardError
+end

data/lib/modspace.rb

@@ -0,0 +1,49 @@
+require "modspace/version"
+
+module Modspace
+    class Error < StandardError; end
+
+    class << self
+        # With thanks to https://stackoverflow.com/questions/37154774/ruby-define-modules-dynamically/37156102 :-)
+
+        # Note: We use the term "namespace" to mean "class" or "module". The term abstracts away the differences
+        # for our purposes.
+
+        def def_mod(*args, in_namespace: Object, in_class_of_instance: nil)
+            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
+                in_namespace
+            else
+                raise ArgumentError, "If in_class or for_instance non-nil is specified they must be non-nil."
+            end
+
+            defp_class_mod(parent_namespace, *args)
+        end
+
+        private
+
+        def defp_class_mod(parent_namespace, *args)
+            nesting_list = *args
+
+            return parent_namespace if nesting_list.empty?
+
+            desired_nested_module_name = nesting_list.shift # mutates nested list (but it's local-only)
+
+            # The desired nested module name may have already been defined elsewhere in the overall Ruby codebase.
+            # If this is the case, we just reuse that constant definition.
+            #
+            # Note 1: if we don't do this then we will get the warning: "already initialized constant Foo"
+            #
+            # Note 2: The false passed to const_defined?() and const_get() methods prevent Ruby from looking up the
+            # inheritance tree when searching for the desired nested module name.
+            desired_nested_module = if parent_namespace.const_defined?(desired_nested_module_name, false)
+                parent_namespace.const_get(desired_nested_module_name, false)
+            else
+                parent_namespace.const_set(desired_nested_module_name, Module.new)
+            end
+
+            defp_class_mod(desired_nested_module, *nesting_list)
+        end
+    end
+end

data/lib/modspace/version.rb

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

data/modspace.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/modspace/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "modspace"
+  spec.version       = Modspace::VERSION
+  spec.authors       = ["declan@weuseopensource.com"]
+  spec.email         = ["declan@weuseopensource.com"]
+
+  spec.summary       = %q{Modspace is a small library to allow the easy definition and management of namespaces and nested modules in Ruby.}
+  spec.description   = %q{Modspace is a small library to allow the easy definition and management of namespaces and nested modules in Ruby.}
+  spec.homepage      = "https://github.com/theirishpenguin/modspace"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/theirishpenguin/modspace"
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "byebug", "~> 11.1.3"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: modspace
+version: !ruby/object:Gem::Version
+  version: 0.1.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
+description: Modspace is a small library to allow the easy definition and management
+  of namespaces and nested modules in Ruby.
+email:
+- declan@weuseopensource.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/simple_example.rb
+- lib/modspace.rb
+- lib/modspace/version.rb
+- modspace.gemspec
+homepage: https://github.com/theirishpenguin/modspace
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/theirishpenguin/modspace
+  source_code_uri: https://github.com/theirishpenguin/modspace
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Modspace is a small library to allow the easy definition and management of
+  namespaces and nested modules in Ruby.
+test_files: []