null_object_loader 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in null_object_loader.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ivor Paul
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# NullObjectLoader
+
+This little gem lets you declare what null objects to instantiate if a certain method call returns nil.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'null_object_loader'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install null_object_loader
+
+## Usage
+
+In your class
+
+    include NullObjectLoader
+
+Then, if you would like to load a null object if a method returns nil:
+
+    load_null_object :method_name_here, :null_class => NullObjectClassHere
+
+Example:
+
+    class OldSchool
+      attr_accessor :principal
+      def initialize(principal = nil)
+        @principal = principal
+      end
+    end
+    OldSchool.new.principal.name # => NameError: Undefined method 'name' for nil:NilClass
+
+Now, with NullObjectLoader
+
+    class NullPrincipal
+      def name; "No Principal"; end
+    end
+
+    class NewSchool < OldSchool
+      include NullObjectLoader
+
+      load_null_object :principal, :null_class => NullPrincipal
+    end
+    NewSchool.new.principal.name # => "No Principal"
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/null_object_loader/version.rb

@@ -0,0 +1,3 @@
+module NullObjectLoader
+  VERSION = "0.0.1"
+end

data/lib/null_object_loader.rb

@@ -0,0 +1,29 @@
+require "null_object_loader/version"
+
+module NullObjectLoader
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+
+    def load_null_object(name, opts)
+      null_class = opts[:null_class]
+      load_if = opts[:load_if] || :nil?
+
+      alias_method NullObjectLoader.temp_name_for_method(name), name
+      define_method(name) do
+        original_value = send(NullObjectLoader.temp_name_for_method(name))
+        return original_value if !original_value.send(load_if)
+        null_class.new
+      end
+    end
+
+  end
+
+  def self.temp_name_for_method(name)
+    "null_object_loader_original_#{name}".to_sym
+  end
+
+end

data/null_object_loader.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'null_object_loader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "null_object_loader"
+  spec.version       = NullObjectLoader::VERSION
+  spec.authors       = ["Ivor Paul"]
+  spec.email         = ["ivorpaul@gmail.com"]
+  spec.description   = "Lets you specify what NullObject to instantiate instead of returning nil for instance methods."
+  spec.summary       = "Loading null objects for instance methods."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/load_null_object_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe "Null Object loaded if 'load_null_object' is declared" do
+  context "a class without a load_null_object call" do
+
+    it "should raise an exception when calling name on nil" do
+      s = School.new("High School")
+      s.principal.nil?.should be_true
+      expect { s.principal.name }.to raise_error(NameError)
+    end
+
+    it "should not raise a name error if the principal is not nil" do
+      p = Principal.new("Jim Kirk", "jim@enterprise.uss","1234567890")
+      s = School.new("High School", p)
+      s.principal.nil?.should be_false
+      expect { s.principal.name }.to_not raise_error(NameError)
+      s.principal.name.should == "Jim Kirk"
+    end
+
+  end
+
+  context "a class that has a load_null_object declaration" do
+    # Create a school class that using this gem.
+    class SchoolWithNullObjectLoader < School
+      include NullObjectLoader
+
+      load_null_object :principal, :null_class => NullPrincipal
+    end
+
+    it "should not raise an exception when calling name on nil" do
+      s = SchoolWithNullObjectLoader.new("High School")
+      s.principal.nil?.should be_true
+      expect { s.principal.name }.to_not raise_error(NameError)
+      s.principal.name.should == NullPrincipal.new.name
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+GEM_ROOT = File.expand_path("../../", __FILE__)
+
+require 'null_object_loader'
+Dir[File.join(GEM_ROOT, "spec", "support", "**/*.rb")].each { |f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/null_principal.rb

@@ -0,0 +1,19 @@
+class NullPrincipal
+
+  def name
+    "No Principal"
+  end
+
+  def email
+    ""
+  end
+
+  def number
+    ""
+  end
+
+  def nil?
+    true
+  end
+
+end

data/spec/support/principal.rb

@@ -0,0 +1,11 @@
+class Principal
+
+  attr_accessor :name, :email, :number
+
+  def initialize(name, email, number)
+    @name = name
+    @email = email
+    @number = number
+  end
+
+end

data/spec/support/school.rb

@@ -0,0 +1,10 @@
+class School
+
+  attr_accessor :name, :principal
+
+  def initialize(name, principal = nil)
+    @name = name
+    @principal = principal
+  end
+
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: null_object_loader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ivor Paul
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lets you specify what NullObject to instantiate instead of returning
+  nil for instance methods.
+email:
+- ivorpaul@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/null_object_loader.rb
+- lib/null_object_loader/version.rb
+- null_object_loader.gemspec
+- spec/load_null_object_spec.rb
+- spec/spec_helper.rb
+- spec/support/null_principal.rb
+- spec/support/principal.rb
+- spec/support/school.rb
+homepage: ''
+licenses:
+- MIT
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Loading null objects for instance methods.
+test_files:
+- spec/load_null_object_spec.rb
+- spec/spec_helper.rb
+- spec/support/null_principal.rb
+- spec/support/principal.rb
+- spec/support/school.rb