namespaces 0.0.1 → 0.0.2

data/README.markdown

@@ -1,45 +1,46 @@
 ## SYNOPSIS
-The purpose of namespace is probably not just to define a scope for classes, 
-I think there are cases when it could be used as placeholder of something 
-shared among these classes. The generic code accessing whatever is shared
-could use #namespaces method, which just returns Array of modules enclosing
-the callee. Here is an example of shared constant XML_NAMESPACE and generic 
-code in Atom::Base class:
-
-    require 'rubygems'
-    require 'namespaces'
-
-    module Atom
-      XML_NAMESPACE = 'http://www.w3.org/2005/Atom'
-      class Base
-        extend Namespaces
-        def self.inherited(klass) # generic code:
-          puts klass.namespaces[-1]::XML_NAMESPACE
+
+Provides *#namespaces* method returning list of modules a class declared within. (For explanations why one might ever need this, please see below):
+
+    module One
+      module Two
+        module Three
+          class A
+            include Namespaces
+            extend Namespaces
+          end
         end
       end
-      class Entry < Base; end
-      class Feed < Base; end
     end
 
-    module GData
-      XML_NAMESPACE = 'http://schemas.google.com/g/2005'
-      class Entry < Atom::Entry; end
-      class Feed < Atom::Feed; end
+    assert_equal [One, One::Two, One::Two::Three], One::Two::Three::A.namespaces
+    assert_equal [One, One::Two, One::Two::Three], One::Two::Three::A.new.namespaces
+
+## Raison d'etre
+
+Modules are two fold constructs in Ruby - they are namespaces and mixins. Sometimes when several 
+classes get placed under one namespace (in one module in Ruby) and they share something 
+it makes a perfect sense to put that thing they share in the same namespace. For example:
+
+    module A
+      COMMON_CONST = "value common for all classes in A"
+      class B; puts COMMON_CONST; end
+      class C; puts COMMON_CONST; end
     end
 
+Now imagine if we building a library where that approach is common, and we want to write some
+generic code taking a class as an argument and  printing a COMMON_CONST for module where that 
+class is defined:
 
-    module GCalendar
-      XML_NAMESPACE = "http://schemas.google.com/gCal/2005"
-      class Entry < GData::Entry; end
-      class Feed < GData::Feed; end
+    def generic_code(klass)
+      # How to do this? - klass.what? 
     end
 
-The output is:
+In Ruby there is no way to ask class: "Please give modules where you defined in". The *namespaces* gem
+helps to bridge the gap:
+
+    def generic_code(klass)
+      puts klass.namespaces[-1].COMMON_CONST
+    end
 
-    http://www.w3.org/2005/Atom
-    http://www.w3.org/2005/Atom
-    http://schemas.google.com/g/2005
-    http://schemas.google.com/g/2005
-    http://schemas.google.com/gCal/2005
-    http://schemas.google.com/gCal/2005
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/namespaces.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{namespaces}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Fedor Kocherga"]
-  s.date = %q{2009-12-28}
+  s.date = %q{2010-07-04}
   s.email = %q{fkocherga@gmail.com}
   s.extra_rdoc_files = [
     "README.html",
@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/fkocherga/namespaces}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Gives access to enclosing modules through #namespaces.}
   s.test_files = [
     "test/test.rb"

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: namespaces
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Fedor Kocherga
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-28 00:00:00 -06:00
+date: 2010-07-04 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -45,18 +50,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: "Gives access to enclosing modules through #namespaces."