sub-setter 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sub-setter.gemspec
+gemspec

data/README.md

@@ -0,0 +1,37 @@
+SubSetter Pattern implementation for Ruby
+=========================================
+
+As described in [SubSetter Pattern for Ruby][xaviervia-subsetter].
+
+Installation
+------------
+
+> Not yet
+
+This implementation creates
+---------------------------
+
+- The **SubSetter** Module, containing three methods (and three more aliases) that are included into Object.
+- The **SubSetter::Object** Class, implementation (empty right now) of a generic subsetter for Object.
+
+[xaviervia-subsetter]: http://xaviervia.com.ar/patterns/sub-setter
+
+New methods in Object
+---------------------
+
+### Public
+
+- `subsetter`: returns an instance of the designated subsetter for the class of this instance.
+- `_subsetter`, `by` and `filter`: aliases for `subsetter`. `by` and `filter` are added for legibility, and `_subsetter` in the remote case that all other method names are overriden, in order to not jeopardize the subsetting functionality
+
+> `_subsetter` is the recommended form to be used when developing a library on top of the sub-setter gem.
+
+### Private
+
+- `_subsetter_for(Class)`: returns an instance of the designated subsetting class for the given `Class`
+- `_has_subsetter_for(Class)`: returns true if for the passed class a corresponding subsetter class exists, false otherwise
+
+License
+-------
+
+GPL

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sub-setter.rb

@@ -0,0 +1,3 @@
+require "sub-setter/version"
+require "sub-setter/sub-setter"
+require "sub-setter/object"

data/lib/sub-setter/object.rb

@@ -0,0 +1,3 @@
+class Object
+  include SubSetter
+end

data/lib/sub-setter/sub-setter.rb

@@ -0,0 +1,71 @@
+# SubSetter Pattern implementation for Ruby
+#
+# As described in SubSetter Pattern for Ruby
+# http://xaviervia.com.ar/patterns/sub-setter
+module SubSetter
+  # Gets the subsetter for self
+  #
+  # The default behaviour is, for class Klass, to look for a 
+  # class named SubSetter::Klass; for a class Library::Klass, a class
+  # named SubSetter::Library::Klass, following the criteria described 
+  # in http://xaviervia.com.ar/patterns/sub-setter
+  #
+  # If a SubSetter for the current class is not found, a SubSetter for
+  # the superclass is searched instead, and if is not found in that 
+  # class, further in the class hierarchy until a SubSetter is found.
+  def subsetter
+    _subsetter_for(self.class).new self
+  end
+  
+  alias :by :subsetter
+  alias :filter :subsetter
+  alias :_subsetter :subsetter
+
+  private
+  # Returns an instance of the designated subsetting class for the 
+  # given `Class`
+  def _subsetter_for the_class
+    if RUBY_VERSION.match /1.9/
+      Kernel.raise RuntimeError, "You are awesome. Why on Earth do you want to subset a Basi... Anyway, you rule. Seriously.\nFWI, this is an error, you can't do that. Stop trying. Cheers, xav" if the_class == BasicObject
+    end
+    return eval("SubSetter::#{the_class.name}") if _there_is_subsetter_for? the_class
+    _subsetter_for the_class.superclass
+  end
+  
+  # Returns true if for the passed class a corresponding subsetter 
+  # class exists, false otherwise
+  def _there_is_subsetter_for? the_class
+    unless RUBY_VERSION.match /1.8/
+      return ::SubSetter.const_defined? the_class.name, false unless the_class.name["::"]
+  
+      parts = the_class.name.split("::")
+      class_name = parts.pop
+      current_module = ::SubSetter
+      while parts.length > 0
+        return false unless current_module.const_defined? parts.first, false
+        current_module = current_module.const_get parts.shift, false
+      end
+      current_module.const_defined? class_name, false
+    else
+      return ::SubSetter.const_defined? the_class.name unless the_class.name["::"]
+  
+      parts = the_class.name.split("::")
+      class_name = parts.pop
+      current_module = ::SubSetter
+      while parts.length > 0
+        return false unless current_module.const_defined? parts.first
+        current_module = current_module.const_get parts.shift
+      end
+      current_module.const_defined? class_name
+    end
+  end
+  
+  public
+  
+  # SubSetter for Object: placeholder mostly
+  class Object
+    def initialize instance
+      @source = instance
+    end
+  end
+end

data/lib/sub-setter/version.rb

@@ -0,0 +1,5 @@
+module Sub
+  module Setter
+    VERSION = "0.0.2"
+  end
+end

data/spec/sub-setter/object_spec.rb

@@ -0,0 +1,7 @@
+require "sub-setter/object"
+
+describe Object do
+  it "should include SubSetter in its ancestors" do
+    Object.ancestors.should include SubSetter
+  end
+end

data/spec/sub-setter/sub-setter_spec.rb

@@ -0,0 +1,213 @@
+require "sub-setter/sub-setter"
+
+describe SubSetter do
+  shared_examples_for "any subsetting" do
+    it "should call _subsetter_for with the class as argument" do
+      the_object = Object.new
+      the_object.extend SubSetter
+      the_object.should_receive(:_subsetter_for).with(Object).and_return(SubSetter::Object)
+      the_object.send @method
+    end
+    
+    it "should call .new on the returned class" do
+      the_object = Object.new
+      the_object.extend SubSetter
+      SubSetter::Object.should_receive(:new).with(the_object)
+      the_object.send @method
+    end
+    
+    it "should return an instance of the designated subsetter" do
+      the_object = Object.new
+      the_object.extend SubSetter
+      the_object.send(@method).should be_instance_of SubSetter::Object
+    end
+  end
+  
+  describe "#_subsetter" do
+    before { @method = :_subsetter }
+    it_behaves_like "any subsetting"
+  end
+  
+  describe "#subsetter" do
+    before { @method = :subsetter }
+    it_behaves_like "any subsetting"
+  end
+  
+  describe "#filter" do
+    before { @method = :filter }
+    it_behaves_like "any subsetting"
+  end
+  
+  describe "#by" do
+    before { @method = :by }
+    it_behaves_like "any subsetting"
+  end
+  
+  # Priv8 methods
+  describe "#_there_is_subsetter_for?" do
+    context "there it no subsetter for this class" do
+      it "should return false" do
+        class Klass
+          include SubSetter
+          def test_me
+            _there_is_subsetter_for? self.class
+          end
+        end
+        
+        Klass.new.test_me.should === false
+      end
+    end
+    
+    context "there is a subsetter for this class" do
+      it "should return true" do
+        module SubSetter; class Klass; end; end
+        class Klass
+          include SubSetter
+          def test_me
+            _there_is_subsetter_for? self.class
+          end
+        end
+        
+        Klass.new.test_me.should === true
+      end
+    end
+  end
+  
+  describe "#_subsetter_for" do    
+    context "this is an Object" do
+      it "should return SubSetter::Object" do
+        the_object = Object.new
+        the_object.extend SubSetter
+        class << the_object
+          def test_me
+            _subsetter_for self.class
+          end
+        end
+        
+        the_object.test_me.should == SubSetter::Object
+      end
+    end
+    
+    if RUBY_VERSION.match /1.9/
+      context "this is a BasicObject" do
+        it "should raise an awesome exception" do
+          ay = BasicObject.new
+          class BasicObject
+            include ::SubSetter
+          end
+          
+          def ay.genius
+            _subsetter_for BasicObject
+          end
+          
+          expect { ay.genius
+          }.to raise_error RuntimeError, "You are awesome. Why on Earth do you want to subset a Basi... Anyway, you rule. Seriously.\nFWI, this is an error, you can't do that. Stop trying. Cheers, xav"
+        end
+      end
+    end
+    
+    context "there is a subsetter for the superclass" do
+      it "should return the superclass's subsetter" do
+        class SuperKlass; end
+        class ActualKlass < SuperKlass; end
+        
+        module SubSetter; class SuperKlass; end; end
+        
+        klassy = ActualKlass.new
+        klassy.extend SubSetter
+        
+        def klassy.test_me
+          _subsetter_for self.class
+        end
+        
+        klassy.test_me.should == SubSetter::SuperKlass
+      end
+    end
+    
+    context "there is a subsetter for the supersuperclass" do
+      it "should return the supersuperclass's subsetter" do
+        class CoolKlass; end
+        class IMRunningOutOfNamesKlass < CoolKlass; end
+        class WhyWasThatLong < IMRunningOutOfNamesKlass; end
+        
+        module SubSetter; class CoolKlass; end; end
+        
+        klick = WhyWasThatLong.new
+        klick.extend SubSetter
+        
+        def klick.test_me; _subsetter_for self.class; end
+      
+        klick.test_me.should == SubSetter::CoolKlass
+      end
+    end
+    
+    context "has two superclasses but non of them has a subsetter" do
+      it "should return SubSetter::Object" do
+        class SuperSuper; end
+        class Superr < SuperSuper; end
+        class Aktual < Superr; end
+        
+        kla = Aktual.new
+        kla.extend SubSetter
+        def kla.test; _subsetter_for self.class; end
+        
+        kla.test.should == SubSetter::Object
+      end
+    end
+    
+    context "there is a subsetter for this class" do
+      it "should return that subsetter" do
+        class Hey; end
+        module SubSetter; class Hey; end; end
+        
+        hi = Hey.new
+        hi.extend SubSetter
+        def hi.t; _subsetter_for self.class; end
+        
+        hi.t.should == SubSetter::Hey
+      end
+    end
+    
+    context "this class is within several modules" do
+      context "there is a subsetter for this class" do
+        it "should return that subsetter" do
+          module One; module Two; module Three; class AAA; 
+          end; end; end; end
+          
+          module SubSetter; module One; module Two; module Three;
+          class AAA;
+          end; end; end; end; end
+          
+          deeeep = One::Two::Three::AAA.new
+          deeeep.extend SubSetter
+          
+          def deeeep.dowwwn; _subsetter_for self.class; end
+          
+          deeeep.dowwwn.should == SubSetter::One::Two::Three::AAA
+        end
+      end
+    end
+  end
+end
+
+describe SubSetter::Object do
+  describe "#new" do
+    it "should require an argument" do
+      SubSetter::Object.new "an argument"
+    end
+    
+    it "should store the argument in the @source variable" do
+      module SubSetter
+        class Object
+          def reveal_source
+            @source
+          end
+        end
+      end
+      
+      the_var = %w{1 2 3 4}
+      subsetter_the_var = SubSetter::Object.new the_var
+      subsetter_the_var.reveal_source.should === the_var
+    end
+  end
+end

data/sub-setter.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sub-setter/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sub-setter"
+  s.version     = Sub::Setter::VERSION
+  s.authors     = ["Xavier Via"]
+  s.email       = ["xavierviacanel@gmail.com"]
+  s.homepage    = "http://xaviervia.com.ar/patterns/sub-setter"
+  s.summary     = %q{SubSetter Design Pattern implementation for Ruby}
+  s.description = %q{SubSetter Design Pattern implementation for Ruby}
+
+  s.rubyforge_project = "sub-setter"
+  
+  s.add_development_dependency "rspec"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: sub-setter
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Xavier Via
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70621040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70621040
+description: SubSetter Design Pattern implementation for Ruby
+email:
+- xavierviacanel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/sub-setter.rb
+- lib/sub-setter/object.rb
+- lib/sub-setter/sub-setter.rb
+- lib/sub-setter/version.rb
+- spec/sub-setter/object_spec.rb
+- spec/sub-setter/sub-setter_spec.rb
+- sub-setter.gemspec
+homepage: http://xaviervia.com.ar/patterns/sub-setter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: sub-setter
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: SubSetter Design Pattern implementation for Ruby
+test_files: []