expand 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67a04674a13b0dbfca22f2452f5f206af05452bb
-  data.tar.gz: 7ea40c2d4bae7463a3ad99420107e96a5fc4d2e7
+  metadata.gz: fa05996ba3e525e97297fadc5e958ede85494fb8
+  data.tar.gz: 6f4425acb6142ef5e273c39bcc00b6140812dccf
 SHA512:
-  metadata.gz: 8df7158a2bdaf8375cc5d8b7f782ae367fc081efcdd17e21352d252d20f3d1dfe33b3718046f693b58567fa58949514905373e70e850cfd3bcb8767478512c92
-  data.tar.gz: 8c8f197f5ce23a87e9db11382be77e3f97b0ce50f07f7013c4390d72d335f6020727993f9bbf107f6e7f86dfc632b51a1dcd4bc4ec83a75bba58123251310d89
+  metadata.gz: 557437e0b3f3677503e81e591eccbbb41c46603a26674d95e02c394f8cb87e590bd5fec8cb33eaf162a7c5c963f3a178760592f9d9b22822cf4fcb3085a57ff4
+  data.tar.gz: dcc31bf73a0a410bd6b81958d8acc4a602a687331f90d5080fd53ca59079da07ea66f091678b8119483cad8af3516086dabdb4f7d4be50ecb0ab382dd94ad97c

data/README.md

@@ -22,7 +22,7 @@ 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

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
+    # @see Expand#namespace
     def initialize(namespace)
       @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,6 +50,27 @@ module Expand
     end
   end
 
+  # 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, &block)
     unless context.is_a?(Module)
       context = context.to_s.split('::').inject(Object) do |base, mod|

data/lib/expand/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expand
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - "'Jim Gay'"
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2016-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,3 +97,4 @@ signing_key:
 specification_version: 4
 summary: Create classes and modules under an existing namespace
 test_files: []
+has_rdoc: