expand 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ea9a1efdd9f3eb0013dcf094347e32d3c48aeb6d819d95d76a368c14de20862
-  data.tar.gz: d21f446e4e5a1d793da4cc23c9017d6e15ba80066905cd302e9be33e25cfff2f
+  metadata.gz: 1c749a422399f6bef2c67bd4ab1503cfd5d3ab99a912b2164c6930931d2861ad
+  data.tar.gz: e5639cd2f02dae004d3e7d60eac7a2a3eeace870eb2022ca778d785d451b5d20
 SHA512:
-  metadata.gz: 0660ff8939459c77f34920c14d5b678ed5a8703bc3dfab0b2a523afd75a07b516e9d25596b0ca333ad3c3f52ae1fd623047bb4033961a68e306fef25970f8401
-  data.tar.gz: 3e51316a7a7a0b7c5ca31de138b6c09ebba2446f450166ce1a43ec4a1912b86f1cce7baf3c3e063bd05bd55c34513b67304a8ac99ddeb068b830102afde4d0ad
+  metadata.gz: 3fd15dae2380332348db1806ae0ec289ac57a936404df715d2cb0418cbafd009f213df5d958699510b0d4eed668355ffcba681feb8927adb5fa5e24f87dc0700
+  data.tar.gz: e4197b51d7e9c5c352492c418bae31e385efb17aac68ef0db5d5fe2fbcebe5b9e6397e227d3d0911a81f1fc9044b77412eaf2e3964c1785473bae8f35a00905b

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.0.5
+
+- use pattern matching in the `namespace` method
+- add an `apply` method to eval blocks in the Manager object
+
+## 1.0.4
+
+- 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.

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 'Jim Gay'
+Copyright (c) 2016-2023 'Jim Gay'
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -19,22 +19,19 @@ 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
 require 'expand'
-extend Expand
 
-namespace SomeGem::Thing do
-  create_class :NewThing do
-    # define methods here
-  end
+Expand.namespace SomeGem::Thing, class: :NewThing do
+  # define methods for your class here
 end
 
 SomeGem::Thing::NewThing #=> SomeGem::Thing::NewThing
 ```
 
-And even simpler, you can do it all in one line:
+You can also extend an class or object to add the `namespace` method.
 
 ```ruby
 require 'expand'
@@ -44,11 +41,28 @@ namespace SomeGem::Thing, class: :NewThing, parent: SomeExistingOtherClass do
   # define methods here
 end
 
-namespace SomeGem::Thing, class: :NewModule do
+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 :NewClass do
+    # define methods here
+  end
+
+  create_module :NewModule do
+    # define methods here
+  end
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -4,7 +4,7 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test

data/lib/expand/version.rb

@@ -1,3 +1,3 @@
 module Expand
-  VERSION = "1.0.3"
+  VERSION = "1.0.5"
 end

data/lib/expand.rb

@@ -2,7 +2,6 @@ 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
   #
@@ -48,6 +47,20 @@ module Expand
       @managed.const_set(name, klass)
       klass
     end
+
+    def apply(&block)
+      instance_eval(&block)
+      @managed
+    end
+
+    def self.for(context)
+      unless context.is_a?(Module)
+        context = context.to_s.split("::").inject(Object) do |base, mod|
+          base.const_get(mod)
+        end
+      end
+      new(context)
+    end
   end
 
   # Allows you to open a module namespace to add constants
@@ -63,7 +76,17 @@ module Expand
   #     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.
@@ -72,28 +95,25 @@ module Expand
   # @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)
+    manager = Manager.for(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
+    case class_or_module
+    in { module: Symbol => _creating_module, class: Symbol => _creating_class }
+      raise ArgumentError, "You must choose either class: or module: but not both."
+    in { class: Symbol => 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]}"
+    in { module: Symbol => creating_module, ** }
+      if parent = class_or_module[:parent]
+        warn "An option for :parent was provided as `#{parent}' but was ignored when creating the module: #{creating_module}"
       end
+
       manager.create_module(creating_module, &block)
     else
-      manager.instance_eval(&block)
+      manager.apply(&block)
     end
   end
-  alias expand namespace
+  alias_method :expand, :namespace
+  module_function :expand, :namespace
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expand
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
-- "'Jim Gay'"
+- Jim Gay
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-20 00:00:00.000000000 Z
+date: 2023-01-01 00:00:00.000000000 Z
 dependencies: []
 description: Create classes and modules under an existing namespace
 email:
@@ -17,18 +17,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/dependabot.yml"
-- ".github/workflows/test.yml"
-- ".gitignore"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
-- expand.gemspec
 - lib/expand.rb
 - lib/expand/version.rb
 homepage: https://github.com/saturnflyer/expand
@@ -50,7 +43,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.17
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Create classes and modules under an existing namespace

data/.github/dependabot.yml

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

data/.github/workflows/test.yml

@@ -1,37 +0,0 @@
-# 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/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/Gemfile

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

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "expand"
-
-# 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

data/bin/setup

@@ -1,8 +0,0 @@
-#!/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/expand.gemspec

@@ -1,21 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'expand/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "expand"
-  spec.version       = Expand::VERSION
-  spec.authors       = ["'Jim Gay'"]
-  spec.email         = ["jim@saturnflyer.com"]
-
-  spec.summary       = %q{Create classes and modules under an existing namespace}
-  spec.description   = %q{Create classes and modules under an existing namespace}
-  spec.homepage      = "https://github.com/saturnflyer/expand"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-end