blank_slate 1.0.0

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/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'simplecov'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 'Jim Gay'
+
+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,67 @@
+# blank_slate
+
+BlankSlate is useful for implementing the Null Object pattern.
+
+This gem allows you to create null objects without resorting to
+method_missing to catch every message passed. Using method_missing
+means that your objects will respond to any method regardless of
+the behavior you designed in your other related classes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'blank_slate'
+
+## Usage
+
+Here's an example of how you might use it.
+
+A common example of a null object is to use `method_missing` to return the object itself. That allows you to continually call missing methods on the null object. The blank slate approach defines methods based upon another class. This keeps the interface to both objects (valid object and null object) the same.
+
+```ruby
+
+    # Setup some sort of class... this can be anything
+
+    require 'delegate'
+    class UserPresenter < SimpleDelegator
+      def recent_searches
+        last_queries.collect{|query| %{<a href="http://site.co.uk/q?=#{query}">#{query}</a>}}.join(',')
+      end
+
+      def welcome
+        "Welcome! We're so glad to have you!"
+      end
+    end
+
+    require 'blank_slate'
+    include BlankSlate
+
+    # Create a blank slate but provide a specific value for a certain method
+
+    GuestPresenter = BlankSlate(UserPresenter) do
+      def welcome
+        "Sign-in or sign-up, cowboy!"
+      end
+    end
+
+    def Present(user)
+      user.authenticated? ? UserPresenter.new(user) : GuestPresenter.new(user)
+    end
+
+    presenter = Present(current_user)
+
+    presenter.welcome
+    presenter.recent_searches # unauthenticated outputs nothing
+    presenter.bad_method # raises an error in either case
+```
+
+In the example above the call to `bad_method` would have continued with a null object (using method_missing) but failed for the good object. With BlankSlate, we get the behavior we want from both our regular class and the null stand-in.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "simplecov"
+
+desc "Test and run coverage"
+task :test do
+  SimpleCov.start
+  load 'test/lib/blank_slate_test.rb'
+end
+
+task :default => :test

data/blank_slate.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blank_slate/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "blank_slate"
+  gem.version       = BlankSlate::VERSION
+  gem.authors       = ["Jim Gay"]
+  gem.email         = ["jim@saturnflyer.com"]
+  gem.description   = %q{
+    Create null classes based upon other classes.
+    This allows you to create null objects without resorting to
+    method_missing to catch every message passed regardless of
+    the behavior you designed in your other classes.}
+  gem.summary       = %q{Impliment a null object without resorting to method_missing.}
+  gem.homepage      = "http://github.com/saturnflyer/blank_slate"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/blank_slate/version.rb

@@ -0,0 +1,3 @@
+module BlankSlate
+  VERSION = "1.0.0"
+end

data/lib/blank_slate.rb

@@ -0,0 +1,11 @@
+module BlankSlate
+  def BlankSlate(klass, &block)
+    blank_slate = Class.new(&block)
+    blank_slate.class_eval do
+      klass.instance_methods(false).each do |meth|
+        define_method(meth){ nil } unless method_defined?(meth)
+      end
+    end
+    blank_slate
+  end
+end

data/test/lib/blank_slate_test.rb

@@ -0,0 +1,49 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'blank_slate'
+
+include BlankSlate
+
+module BlankSlate
+  class TesterClass
+    def one
+      "one"
+    end
+  end
+end
+
+describe "BlankSlate" do
+  def blank_slate(&block)
+    BlankSlate(BlankSlate::TesterClass, &block)
+  end
+
+  it "returns a class with all instance_methods of the given class" do
+    assert_equal BlankSlate::TesterClass.instance_methods.sort, blank_slate.instance_methods.sort
+  end
+
+  it "sets the values of instance methods to nil" do
+    null_object = blank_slate.new
+
+    null_object.one.must_be_nil
+  end
+
+  it "accepts a block to define methods on the null class" do
+    null_object = blank_slate do
+      def passed_block_method
+        'this is from the method defined in the block!'
+      end
+    end.new
+
+    null_object.passed_block_method.must_equal 'this is from the method defined in the block!'
+  end
+
+  it "allows the block to override method definitions from the given class" do
+    null_object = blank_slate do
+      def one
+        'not the same one'
+      end
+    end.new
+
+    null_object.one.must_equal 'not the same one'
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: blank_slate
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jim Gay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-24 00:00:00.000000000 Z
+dependencies: []
+description: ! "\n    Create null classes based upon other classes.\n    This allows
+  you to create null objects without resorting to\n    method_missing to catch every
+  message passed regardless of\n    the behavior you designed in your other classes."
+email:
+- jim@saturnflyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .simplecov
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- blank_slate.gemspec
+- lib/blank_slate.rb
+- lib/blank_slate/version.rb
+- test/lib/blank_slate_test.rb
+homepage: http://github.com/saturnflyer/blank_slate
+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'
+      segments:
+      - 0
+      hash: 3761206396574154736
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3761206396574154736
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Impliment a null object without resorting to method_missing.
+test_files:
+- test/lib/blank_slate_test.rb