expand 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b8eefdf8421d88d75e752a92262a63aa0ab5b66d
-  data.tar.gz: 765b248f040050472314a7a41f47112c46b02e16
+SHA256:
+  metadata.gz: 2ea9a1efdd9f3eb0013dcf094347e32d3c48aeb6d819d95d76a368c14de20862
+  data.tar.gz: d21f446e4e5a1d793da4cc23c9017d6e15ba80066905cd302e9be33e25cfff2f
 SHA512:
-  metadata.gz: fcc95af895dc067897c1bb317ac648a64b6ec78d35e91cdfc6d490bbf72e369304dc5c68251b0defe9437abfb49052364f9536f1e7c233fd899eb34c7470eebe
-  data.tar.gz: 313b4e3b52652337c358c2c043d1a7461f5b0cdf18c26c430dd0bdf6e0ea8bfecbc97d04ffbf9119133b086329414f38470b205b5d5e0315a3200c0502cc4b28
+  metadata.gz: 0660ff8939459c77f34920c14d5b678ed5a8703bc3dfab0b2a523afd75a07b516e9d25596b0ca333ad3c3f52ae1fd623047bb4033961a68e306fef25970f8401
+  data.tar.gz: 3e51316a7a7a0b7c5ca31de138b6c09ebba2446f450166ce1a43ec4a1912b86f1cce7baf3c3e063bd05bd55c34513b67304a8ac99ddeb068b830102afde4d0ad

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

@@ -0,0 +1,14 @@
+## 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

@@ -1,4 +1,4 @@
-# Epand
+# Expand
 
 Use Expand to create classes or modules under an existing namespace.
 
@@ -22,10 +22,10 @@ SomeGem::Thing::NewThing #=> warning: toplevel constant NewThing referenced by S
 To make this simpler, you can require `expand` and extend your current context with Expand.
 
 ```ruby
-reuire 'expand'
+require 'expand'
 extend Expand
 
-namespace 'SomeGem::Thing' do
+namespace SomeGem::Thing do
   create_class :NewThing do
     # define methods here
   end
@@ -34,6 +34,21 @@ end
 SomeGem::Thing::NewThing #=> SomeGem::Thing::NewThing
 ```
 
+And even simpler, you can do it all in one line:
+
+```ruby
+require 'expand'
+extend Expand
+
+namespace SomeGem::Thing, class: :NewThing, parent: SomeExistingOtherClass do
+  # define methods here
+end
+
+namespace SomeGem::Thing, class: :NewModule do
+  # define methods here
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

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.0"
+  VERSION = "1.0.3"
 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,11 +50,50 @@ module Expand
     end
   end
 
-  def namespace(string, &block)
-    namespace = string.split('::').inject(Object) do |base, mod|
-      base.const_get(mod)
+  # 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
+  #
+  # @param context [Module, String, or any object responding to to_s] representing a module namespace.
+  # @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 = 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
-    Manager.new(namespace).instance_eval(&block)
   end
   alias expand namespace
 end

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: expand
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 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-20 00:00:00.000000000 Z
+dependencies: []
 description: Create classes and modules under an existing namespace
 email:
 - jim@saturnflyer.com
@@ -59,8 +17,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -75,7 +35,7 @@ homepage: https://github.com/saturnflyer/expand
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -90,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