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

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Akshay Vishnoi
+
+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,76 @@
+# SuperclassDelegatingAccessor
+
+A Ruby utility that defines both class and instance accessors for class attributes. Creates private *_attr* and *_attr=* methods that can still be used if the public methods are overridden.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```shell
+gem 'superclass_delegating_accessor', '~> 0.0.1'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install superclass_delegating_accessor
+```
+
+## Usage
+
+```ruby
+class Person
+  superclass_delegating_accessor :hair_colors
+end
+
+Person.hair_colors = [:brown, :black, :blonde, :red]
+Person.hair_colors     # => [:brown, :black, :blonde, :red]
+Person.new.hair_colors # => [:brown, :black, :blonde, :red]
+```
+
+If a subclass changes the value then that would also change the value for parent class. Similarly if parent class changes the value then that would change the value of subclasses too.
+
+```ruby
+class Male < Person
+end
+
+Male.hair_colors << :blue
+Person.hair_colors # => [:brown, :black, :blonde, :red, :blue]
+```
+
+To opt out of the instance reader method, pass `instance_reader: false`.
+
+```ruby
+class Person
+  cattr_accessor :hair_colors, instance_writer: false, instance_reader: false
+end
+
+Person.new.hair_colors = [:brown]  # => NoMethodError
+Person.new.hair_colors             # => NoMethodError
+```
+
+Or pass `instance_accessor: false`, to opt out both instance methods.
+
+```ruby
+class Person
+  cattr_accessor :hair_colors, instance_accessor: false
+end
+
+Person.new.hair_colors = [:brown]  # => NoMethodError
+Person.new.hair_colors             # => NoMethodError
+```
+
+## 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/superclass_delegating_accessor.rb

@@ -0,0 +1,5 @@
+require "superclass_delegating_accessor/version"
+require 'superclass_delegating_accessor/class'
+
+module SuperclassDelegatingAccessor
+end

data/lib/superclass_delegating_accessor/class.rb

@@ -0,0 +1 @@
+require 'superclass_delegating_accessor/class/delegating_attributes'

data/lib/superclass_delegating_accessor/class/delegating_attributes.rb

@@ -0,0 +1,41 @@
+require 'superclass_delegating_accessor/class/remove_method'
+
+class Class
+  def superclass_delegating_accessor(name, options = {})
+    # Create private _name and _name= methods that can still be used if the public
+    # methods are overridden.
+    _superclass_delegating_accessor("_#{name}", options)
+
+    # Generate the public methods name, name=, and name?.
+    # These methods dispatch to the private _name, and _name= methods, making them
+    # overridable.
+    singleton_class.send(:define_method, name) { send("_#{name}") }
+    singleton_class.send(:define_method, "#{name}?") { !!send("_#{name}") }
+    singleton_class.send(:define_method, "#{name}=") { |value| send("_#{name}=", value) }
+
+    # If an instance_reader is needed, generate public instance methods name and name?.
+    if options[:instance_reader] != false
+      define_method(name) { send("_#{name}") }
+      define_method("#{name}?") { !!send("#{name}") }
+    end
+  end
+
+  private
+    # Take the object being set and store it in a method. This gives us automatic
+    # inheritance behavior, without having to store the object in an instance
+    # variable and look up the superclass chain manually.
+    def _stash_object_in_method(object, method, instance_reader = true)
+      singleton_class.remove_possible_method!(method)
+      singleton_class.send(:define_method, method) { object }
+      remove_possible_method!(method)
+      define_method(method) { object } if instance_reader
+    end
+
+    def _superclass_delegating_accessor(name, options = {})
+      singleton_class.send(:define_method, "#{name}=") do |value|
+        _stash_object_in_method(value, name, options[:instance_reader] != false)
+      end
+      send("#{name}=", nil)
+      singleton_class.send(:private, name, "#{name}=")
+    end
+end

data/lib/superclass_delegating_accessor/class/remove_method.rb

@@ -0,0 +1,7 @@
+class Module
+  def remove_possible_method!(method)
+    if method_defined?(method) || private_method_defined?(method)
+      undef_method(method)
+    end
+  end
+end

data/lib/superclass_delegating_accessor/version.rb

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

data/superclass_delegating_accessor.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'superclass_delegating_accessor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "superclass_delegating_accessor"
+  spec.version       = SuperclassDelegatingAccessor::VERSION
+  spec.authors       = ["Akshay Vishnoi"]
+  spec.email         = ["akshay.vishnoi@yahoo.com"]
+  spec.description   = 'A Ruby utility that defines both class and instance accessors for class attributes. Creates private *_attr* and *_attr=* methods that can still be used if the public methods are overridden.'
+  spec.summary       = 'A Ruby utility that defines both class and instance accessors for class attributes. Creates private *_attr* and *_attr=* methods that can still be used if the public methods are overridden.'
+  spec.homepage      = 'https://github.com/akshay-vishnoi/superclass_delegating_accessor'
+  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 "minitest", "~> 5.3.1"
+end

data/test/delegating_attributes_test.rb

@@ -0,0 +1,119 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'minitest/autorun'
+require 'superclass_delegating_accessor'
+
+module DelegatingFixtures
+  class Parent
+  end
+
+  class Child < Parent
+    superclass_delegating_accessor :some_attribute
+  end
+
+  class Mokopuna < Child
+  end
+
+  class PercysMom
+    superclass_delegating_accessor :superpower
+  end
+
+  class Percy < PercysMom
+  end
+end
+
+class DelegatingAttributesTest < ::Minitest::Test
+  Assertion = Minitest::Assertion
+  include DelegatingFixtures
+  attr_reader :single_class, :single_class_instance
+
+  def setup
+    @single_class = Class.new(Object)
+    @single_class_instance = @single_class.new
+  end
+
+  def test_simple_accessor_declaration
+    single_class.superclass_delegating_accessor :both
+
+    # `single_class` should have private accessor methods
+    assert single_class.private_methods.include?(:_both)
+    assert single_class.private_methods.include?(:_both=)
+
+    # `single_class` should have public accessor methods
+    assert single_class.public_methods.include?(:both)
+    assert single_class.public_methods.include?(:both=)
+    assert single_class.public_methods.include?(:both?)
+
+    # `single_class` should have public instance methods
+    assert single_class_instance.public_methods.include?(:both)
+    assert single_class_instance.public_methods.include?(:both?)
+  end
+
+  def test_simple_accessor_declaration_with_instance_reader_false
+    single_class.superclass_delegating_accessor :no_instance_reader, instance_reader: false
+
+    # `single_class` should have private accessor methods
+    assert single_class.private_methods.include?(:_no_instance_reader)
+    assert single_class.private_methods.include?(:_no_instance_reader=)
+
+    # `single_class` should have public accessor methods
+    assert single_class.public_methods.include?(:no_instance_reader)
+    assert single_class.public_methods.include?(:no_instance_reader=)
+    assert single_class.public_methods.include?(:no_instance_reader?)
+
+    # `single_class` should not have public instance methods
+    assert !single_class_instance.public_methods.include?(:no_instance_reader)
+    assert !single_class_instance.public_methods.include?(:no_instance_reader?)
+  end
+
+  def test_working_with_simple_attributes
+    single_class.superclass_delegating_accessor :both
+
+    single_class.both = "HMMM"
+
+    assert_equal "HMMM", single_class.both
+    assert_equal true, single_class.both?
+
+    assert_equal "HMMM", single_class.new.both
+    assert_equal true, single_class.new.both?
+
+    single_class.both = false
+    assert_equal false, single_class.both?
+  end
+
+  def test_child_class_delegates_to_parent_but_can_be_overridden
+    parent = Class.new
+    parent.superclass_delegating_accessor :both
+    child = Class.new(parent)
+    parent.both = "1"
+    assert_equal "1", child.both
+
+    child.both = "2"
+    assert_equal "1", parent.both
+    assert_equal "2", child.both
+
+    parent.both = "3"
+    assert_equal "3", parent.both
+    assert_equal "2", child.both
+  end
+
+  def test_delegation_stops_at_the_right_level
+    assert_nil Percy.superpower
+    assert_nil PercysMom.superpower
+
+    PercysMom.superpower = :heatvision
+    assert_equal :heatvision, Percy.superpower
+  end
+
+  def test_delegation_stops_for_nil
+    Mokopuna.some_attribute = nil
+    Child.some_attribute = "1"
+
+    assert_equal "1", Child.some_attribute
+    assert_nil Mokopuna.some_attribute
+  ensure
+    Child.some_attribute = nil
+  end
+
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: superclass_delegating_accessor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Akshay Vishnoi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-19 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.3.1
+description: A Ruby utility that defines both class and instance accessors for class
+  attributes. Creates private *_attr* and *_attr=* methods that can still be used
+  if the public methods are overridden.
+email:
+- akshay.vishnoi@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/superclass_delegating_accessor.rb
+- lib/superclass_delegating_accessor/class.rb
+- lib/superclass_delegating_accessor/class/delegating_attributes.rb
+- lib/superclass_delegating_accessor/class/remove_method.rb
+- lib/superclass_delegating_accessor/version.rb
+- superclass_delegating_accessor.gemspec
+- test/delegating_attributes_test.rb
+homepage: https://github.com/akshay-vishnoi/superclass_delegating_accessor
+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.25
+signing_key: 
+specification_version: 3
+summary: A Ruby utility that defines both class and instance accessors for class attributes.
+  Creates private *_attr* and *_attr=* methods that can still be used if the public
+  methods are overridden.
+test_files:
+- test/delegating_attributes_test.rb