expand 1.0.1 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 67a04674a13b0dbfca22f2452f5f206af05452bb
-  data.tar.gz: 7ea40c2d4bae7463a3ad99420107e96a5fc4d2e7
+SHA256:
+  metadata.gz: f98f240f7a6d7b3912beedba4414dd8488ab84a79c8da8e987ea76f624c862ef
+  data.tar.gz: 5ed64f4889cd305c8c131213613b5c7558ef1a5274989ae3822589ea75a77a61
 SHA512:
-  metadata.gz: 8df7158a2bdaf8375cc5d8b7f782ae367fc081efcdd17e21352d252d20f3d1dfe33b3718046f693b58567fa58949514905373e70e850cfd3bcb8767478512c92
-  data.tar.gz: 8c8f197f5ce23a87e9db11382be77e3f97b0ce50f07f7013c4390d72d335f6020727993f9bbf107f6e7f86dfc632b51a1dcd4bc4ec83a75bba58123251310d89
+  metadata.gz: c08ae5d1c6d495364ee299c40565af87246fc37976d40bdb0f0bf02298e651206062a6ba4accfbce2d99575bc24b316a56e0bef7f3071233eed14bdedc65d14e
+  data.tar.gz: 5cdf7a8d3d945e8fb4b85ee9390b101fbc32d4f4cd7b5519a520fe8af5e1b67fa53c842b5026b496d10902da5af882d55a27b483df1c6e03fa2b2188abf84413

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "10:00"
+  open-pull-requests-limit: 10

data/.github/workflows/test.yml

@@ -0,0 +1,37 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,6 +1,18 @@
-	## 1.0.1
-	- allow specified namespace to be a module instead of a string
+## 1.0.4
 
-	## 1.0.0 (2016-01-14)
-	Initial release.
-	- allow creation of classes and modules under a namespace
+- use a module function `Expand.namespace` so you don't need to extend
+
+## 1.0.3
+
+- allow the creation of a module or class in the namespace/expand method itself.
+
+## 1.0.2
+
+- Add documentation
+
+## 1.0.1
+- allow specified namespace to be a module instead of a string
+
+## 1.0.0 (2016-01-14)
+Initial release.
+- allow creation of classes and modules under a namespace

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in expand.gemspec
 gemspec
+
+gem "minitest"
+gem "simplecov"
+gem "rake"

data/README.md

@@ -19,19 +19,48 @@ end
 SomeGem::Thing::NewThing #=> warning: toplevel constant NewThing referenced by SomeGem::Thing::NewThing
 ```
 
-To make this simpler, you can require `expand` and extend your current context with Expand.
+To make this simpler, you can require `expand` and specify the namespace and the new class or module.
 
 ```ruby
-reuire 'expand'
+require 'expand'
+
+Expand.namespace SomeGem::Thing, class: :NewThing do
+  # define methods for your class here
+end
+
+SomeGem::Thing::NewThing #=> SomeGem::Thing::NewThing
+```
+
+You can also extend an class or object to add the `namespace` method.
+
+```ruby
+require 'expand'
+extend Expand
+
+namespace SomeGem::Thing, class: :NewThing, parent: SomeExistingOtherClass do
+  # define methods here
+end
+
+namespace SomeGem::Thing, module: :NewModule do
+  # define methods here
+end
+```
+
+If you want more explicit code or to create multiple modules or classes under a sinngle namespace you can use `create_class` and `create_module`
+
+```ruby
+require 'expand'
 extend Expand
 
 namespace SomeGem::Thing do
-  create_class :NewThing do
+  create_class :NewClass do
     # define methods here
   end
-end
 
-SomeGem::Thing::NewThing #=> SomeGem::Thing::NewThing
+  create_module :NewModule do
+    # define methods here
+  end
+end
 ```
 
 ## Installation

data/expand.gemspec

@@ -18,8 +18,4 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
 end

data/lib/expand/version.rb

@@ -1,3 +1,3 @@
 module Expand
-  VERSION = "1.0.1"
+  VERSION = "1.0.4"
 end

data/lib/expand.rb

@@ -1,17 +1,48 @@
 require "expand/version"
 
+# Extend your classes or modules to use the Expand methods
 module Expand
+
+  # The primary way to access Manager objects is to use the Expand namespace method.
+  # @see Expand#namespace
+  #
   class Manager
-    def initialize(namespace)
+    # @see Expand#namespace
+    def initialize(namespace, **class_or_module, &block)
       @managed = namespace
     end
 
+    # Create a module under the namespace for this object
+    # @example
+    #   create_module 'Another' do
+    #     def do_something
+    #     end
+    #   end
+    #
+    # @param name [String, Symbol] name to be used for the module
+    # @yield provide a block to be used when creating the module
+    #
+    # @return [Module] the named module you created
+    #
     def create_module(name, &block)
       mod = Module.new(&block)
       @managed.const_set(name, mod)
       mod
     end
 
+    # Create a class under the namespace for this object
+    # @example
+    #   create_class 'Other' do
+    #     def do_something
+    #     end
+    #   end
+    #
+    # @param name [String, Symbol] name to be used for the class
+    # @param parent [Class] an optional class to be used as the direct ancestor of the class
+    # @yield provide a block to be used when creating the class
+    #
+    # @return [Class] the named class you created
+    #
     def create_class(name, parent: Object, &block)
       klass = Class.new(parent, &block)
       @managed.const_set(name, klass)
@@ -19,13 +50,61 @@ module Expand
     end
   end
 
-  def namespace(context, &block)
+  # Allows you to open a module namespace to add constants
+  # @example
+  #   require 'expand'
+  #   extend Expand
+  #   namespace SomeGem::Thing do
+  #     create_class 'Other' do
+  #       # add your class code here
+  #     end
+  #     create_module 'Another' do
+  #       # add your module code here
+  #     end
+  #   end
+  #
+  #   namespace SomeGem::Thing, class: :Other do
+  #     # add methods here
+  #   end
+  #   namespace SomeGem::Thing, module: :Another do
+  #     # add methods here
+  #   end
+  #
+  # @param context [Module, String, or any object responding to to_s] representing a module namespace.
+  # @param module: module name to create
+  # @param class: class name to create
+  # @param parent: optional parent class for the created class, defaults to Object
+  # @yield the provided block is executed against an instance of Expand::Manager using instance_eval
+  #
+  # @return [Expand::Manager] instance which can allow you to create classes and modules in the given context.
+  #
+  # @see Expand::Manager#create_class
+  # @see Expand::Manager#create_module
+  #
+  def namespace(context, **class_or_module, &block)
     unless context.is_a?(Module)
       context = context.to_s.split('::').inject(Object) do |base, mod|
         base.const_get(mod)
       end
     end
-    Manager.new(context).instance_eval(&block)
+    manager = Manager.new(context)
+
+    creating_class, creating_module = class_or_module[:class], class_or_module[:module]
+    raise ArgumentError, "You must choose either class: or module: but not both." if creating_class && creating_module
+
+    case
+    when creating_class
+      parent = class_or_module[:parent] || Object
+      manager.create_class(creating_class, parent: parent, &block)
+    when creating_module
+      if class_or_module[:parent]
+        warn "An option for :parent was provided as `#{class_or_module[:parent]}' but was ignored when creating the module: #{class_or_module[:module]}"
+      end
+      manager.create_module(creating_module, &block)
+    else
+      manager.instance_eval(&block)
+    end
   end
   alias expand namespace
+  module_function :expand, :namespace
 end

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: expand
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.4
 platform: ruby
 authors:
 - "'Jim Gay'"
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
+date: 2022-07-22 00:00:00.000000000 Z
+dependencies: []
 description: Create classes and modules under an existing namespace
 email:
 - jim@saturnflyer.com
@@ -59,8 +17,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -76,7 +35,7 @@ homepage: https://github.com/saturnflyer/expand
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -91,9 +50,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.3.17
+signing_key:
 specification_version: 4
 summary: Create classes and modules under an existing namespace
 test_files: []

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.11.2