blank_slate 1.0.0 → 1.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72b84dd5ad01afcfdb026bf9a830120e95a90c095fd362adcbeea433307bedec
+  data.tar.gz: a76f1f4e546a0c20a1f91f72b58e4d0b39880bf79ab0a0ac468b4d72513abdf2
+SHA512:
+  metadata.gz: 8da83799e3f060a9f225a4c162c16fd60947cae61e99468e23dfe3fcdfa0d99fb88679776d904b02dae61a254115b10df2c646b532821d18f0539c3cfe946780
+  data.tar.gz: 4f4ab28aa58ebd5bb13084111fe4b4f60ddd901f85ac5ac8d9159ea7a9fc706031a20ed2a031eedfe58fb21c3dde462972470081e1c1685fd333494e6600832e

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# 1.1.2
+
+Minor change to simplify the methods that are iterated when creating the BlankSlate class.
+
+# 1.1.1
+
+1.1.0 used method_defined? which has an arity of 2 in Ruby 2.6 but 1 in previous rubies.
+This was changed to check instance_methods(false)
+
+# 1.1.0
+
+Make BlankSlate a shallow copy of a class. Ancestor methods are preserved.
+
+# 1.0.0
+
+Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jim@saturnflyer.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -3,6 +3,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
+  gem 'minitest'
+  gem 'minitest-allow'
   gem 'rake'
   gem 'simplecov'
-end
+end

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2013 'Jim Gay'
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2013-2019 Jim Gay
 
-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:
+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 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.
+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

@@ -7,6 +7,9 @@ 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.
 
+By default, a BlankSlate class will define methods to return `nil` so
+you don't have to.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -41,7 +44,7 @@ A common example of a null object is to use `method_missing` to return the objec
 
     GuestPresenter = BlankSlate(UserPresenter) do
       def welcome
-        "Sign-in or sign-up, cowboy!"
+        "Sign-in or sign-up, cowpoke!"
       end
     end
 
@@ -58,6 +61,46 @@ A common example of a null object is to use `method_missing` to return the objec
 
 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.
 
+### Common ancestor
+
+BlankSlate will preserve the methods of the ancestor of the inherited class.
+
+```ruby
+    class Visitor
+      attr_reader :auth_info
+      def authenticated?
+        auth_info.to_h.has_key?('token')
+      end
+    end
+
+    class User < Visitor
+      def name
+        auth_info.to_h['name']
+      end
+      
+      def email
+        auth_info.to_h['email']
+      end
+    end
+
+    class Guest < BlankSlate(Visitor)
+      def name
+        "Guest"
+      end
+    end
+
+    user = User.new
+    user.auth_info = {'name' => 'Jim', 'email' => 'test@example.com', 'credentials' => 'valid stuff' }
+    user.name #=> "Jim"
+    user.authenticated? #=> true
+
+    guest = Guest.new
+    guest.auth_info = { }
+    guest.name #=> "Guest"
+    guest.authenticated? #=> false
+
+```
+
 ## Contributing
 
 1. Fork it

data/lib/blank_slate/version.rb

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

data/lib/blank_slate.rb

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

data/test/allowed.yml

@@ -0,0 +1,7 @@
+---
+- BlankSlate#test_0001_returns a class with all instance_methods of the given class
+- BlankSlate#test_0002_sets the values of instance methods to nil
+- BlankSlate#test_0003_accepts a block to define methods on the null class
+- BlankSlate#test_0004_allows the block to override method definitions from the given class
+- BlankSlate#test_0005_inherits from the provide class
+- BlankSlate#test_0006_preserves parent methods

data/test/{lib/blank_slate_test.rb → blank_slate_test.rb}

@@ -1,11 +1,15 @@
-require 'minitest/autorun'
-require 'minitest/spec'
-require 'blank_slate'
+require 'test_helper'
 
 include BlankSlate
 
 module BlankSlate
-  class TesterClass
+  class Parent
+    def inherited
+      "this should be inherited"
+    end
+  end
+
+  class TesterClass < Parent
     def one
       "one"
     end
@@ -24,7 +28,7 @@ describe "BlankSlate" do
   it "sets the values of instance methods to nil" do
     null_object = blank_slate.new
 
-    null_object.one.must_be_nil
+    _(null_object.one).must_be_nil
   end
 
   it "accepts a block to define methods on the null class" do
@@ -34,7 +38,7 @@ describe "BlankSlate" do
       end
     end.new
 
-    null_object.passed_block_method.must_equal 'this is from the method defined in the block!'
+    _(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
@@ -44,6 +48,17 @@ describe "BlankSlate" do
       end
     end.new
 
-    null_object.one.must_equal 'not the same one'
+    _(null_object.one).must_equal 'not the same one'
+  end
+
+  it "inherits from the provide class" do
+    null_object = blank_slate.new
+    assert_kind_of BlankSlate::TesterClass, null_object
+    assert_respond_to null_object, :inherited
   end
-end
+
+  it "preserves parent methods" do
+    null_object = blank_slate.new
+    assert_equal null_object.inherited, 'this should be inherited'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+require "minitest/autorun"
+require 'minitest/spec'
+SimpleCov.start do
+  add_filter 'test'
+end
+require "blank_slate"

metadata

@@ -1,64 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: blank_slate
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.1.2
 platform: ruby
 authors:
 - Jim Gay
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2013-02-24 00:00:00.000000000 Z
+date: 2022-07-12 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."
+description: |2-
+
+      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.
 email:
 - jim@saturnflyer.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .simplecov
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- blank_slate.gemspec
 - lib/blank_slate.rb
 - lib/blank_slate/version.rb
-- test/lib/blank_slate_test.rb
+- test/allowed.yml
+- test/blank_slate_test.rb
+- test/test_helper.rb
 homepage: http://github.com/saturnflyer/blank_slate
 licenses: []
-post_install_message: 
+metadata: {}
+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
+rubygems_version: 3.3.17
+signing_key:
+specification_version: 4
 summary: Impliment a null object without resorting to method_missing.
 test_files:
-- test/lib/blank_slate_test.rb
+- test/allowed.yml
+- test/blank_slate_test.rb
+- test/test_helper.rb

data/.gitignore

@@ -1,17 +0,0 @@
-*.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/Rakefile

@@ -1,10 +0,0 @@
-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

@@ -1,23 +0,0 @@
-# -*- 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