scoped_attr_accessor 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/.rvmrc

@@ -0,0 +1 @@
+rvm gemset use scoped_attr_accessor --create

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 David Brady
+
+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,127 @@
+# ScopedAttrAccessor
+
+Adds scoped accessors to ruby. You can create writers, readers and
+accessors in either private or protected scope. Does not affect the
+scope of code that comes afterward. You can extend a single class (and
+its subclasses) with scoped accessors, or you can extend ruby's entire
+class hierarchy.
+
+## Why Oh Why Does This Exist?!?
+
+At the time of this writing (April 2013), the ruby community in
+general is somewhat divided on the meaning of the concept of privacy
+in ruby. For some, especially those who come from Java, C++, VB, or
+some other language that enforces encapsulation with privacy, ruby's
+ability to get around privacy means that encapsulation cannot be
+enforced. Most of us (I count myself in this camp) have discarded the
+use of privacy in ruby altogether, as if it were nothing more than a
+half-hearted nod to other languages' encapsulation practices. Make
+everything public, since everything's ultimately public anyway, we
+say; using the private keyword is merely a speedbump which adds no
+security but does add hassle and headache.
+
+I am becoming more and more aware of a number of rubyists who consider
+the use of private and protected methods in ruby to be a useful way to
+communicate to the reader that the code is highly volatile, under
+question, subject to change or outright removal, etc., and that for
+these reasons the code should not be surfaced to the public API of the
+class. They ALSO consider the private keyword to be merely a
+speedbump, but one which communicates that maybe you should slow down
+a bit before trying to access these portions of code. Furthermore,
+making these methods private or protected makes them "exemplary" to
+maintainers of the code, meaning that a maintainer will understand the
+intent of the privacy, and be less likely to *accidentally* create an
+external dependency on on a method that should have been kept private.
+
+I am becoming more and more swayed by this second way of thinking, but
+I find that it falls short in one key area: accessors. It is easy to
+create a private method in ruby, but creating a private accessor
+method is actually a bit tortuous. As a result, I see programmers who
+strongly believe in using privacy to communicate undependable
+interfaces frequently making use of either instance variables or
+public accessors for their private variables. These variables are not
+dependable, at least from a "stable interface" standpoint, so both
+solutions offer an unfavorable tradeoff. While instance variables
+communicate privacy, they force the object to depend on its own
+undependable internal interface. Meanwhile, public accessors allow the
+class to isolate itself from its undependable interface, but by making
+it public the communication to the maintainer is that other classes
+can and should depend on that undependable interface.
+
+The reason programmers make this tradeoff is that there doesn't seem
+to be an easy, clean, *elegant* way to create private and protected
+accessors in ruby. My goal with this gem, then, is to create such a
+way, so that those who wish to communicate "this variable is
+undependable and it should be kept isolated for now" can do so easily.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'scoped_attr_accessor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scoped_attr_accessor
+
+## Usage
+
+You can add scoped accessors to a single class (and its children) by
+directly extending `ScopedAttrAccessor` in your class:
+
+    require 'scoped_attr_accessor'
+
+    class Primate
+      extend ScopedAttrAccessor
+      private_attr_accessor :some_weird_primate_only_counter
+      protected_attr_reader :some_weird_counter
+    end
+
+    class Monkey < Primate
+      # Monkey can define its own scoped accessors because Primate
+      # extended the module.
+      private_attr_reader :get_weird_monkey_only_stuff_here
+      private_attr_writer :put_weird_monkey_only_stuff_here
+
+      # use our inherited, protected reader
+      def sufficiently_weird?
+        some_weird_counter > 42
+      end
+    end
+
+Alternately, if you require `scoped_attr_accessor/include`, ruby's
+`Object` class will be extended with `ScopedAttrAccessor` making all
+classes able to have protected and private accessors.
+
+    require 'scoped_attr_accessor/include'
+
+    class Primate
+      private_attr_accessor :private_primate_counter
+    end
+
+## Avoid Dependency Infection
+
+The '/include' form of this gem is a ruby-wide monkeypatch. Please
+remember that it's perfectly fine to use it this way in your own
+applications, but quite rude to use it this way in a library.
+
+If you use scoped accessors in a gem or library of your own, please
+consider using the non-include version, or, in Ruby 2.0, use
+refinements to confine the include patch to your library.
+
+## Ruby Versions
+
+Tested to work on Ruby 1.9.3 and 2.0.
+
+## Contributing
+
+1. Fork it
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Write tests for your feature or bug fix
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/**/test_*.rb']
+  t.verbose = true
+end
+
+task :default => [:test]

data/lib/scoped_attr_accessor/include.rb

@@ -0,0 +1,7 @@
+# By requiring 'scoped_attr_accessor/include', scoped_attr_accessor
+# will be injected into every Object automatically.
+require_relative '../scoped_attr_accessor'
+
+class Object
+  extend ScopedAttrAccessor
+end

data/lib/scoped_attr_accessor/version.rb

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

data/lib/scoped_attr_accessor.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+# This module adds scoped accessor methods to a Ruby Class. For
+# example:
+#
+#   class Foo
+#     extend ScopedAttrAccessor
+#     private_attr_reader :thing1, :thing2, :thing3
+#     protected_attr_writer :counter
+#     protected_attr_accessor :flagbag
+#   end
+#
+# They work exactly the same as the regular ruby attr_accessor
+# methods, except they are placed in the appropriate public or
+# private scope as desired.
+module ScopedAttrAccessor
+  def private_attr_reader(*names)
+    attr_reader(*names)
+    names.each {|name| private name}
+  end
+
+  def private_attr_writer(*names)
+    attr_writer(*names)
+    names.each {|name| private "#{name}=" }
+  end
+
+  def private_attr_accessor(*names)
+    attr_accessor(*names)
+    names.each {|name| private name; private "#{name}=" }
+  end
+
+  def protected_attr_reader(*names)
+    protected
+    attr_reader(*names)
+  end
+
+  def protected_attr_writer(*names)
+    protected
+    attr_writer(*names)
+  end
+
+  def protected_attr_accessor(*names)
+    protected
+    attr_accessor(*names)
+  end
+end

data/scoped_attr_accessor.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scoped_attr_accessor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scoped_attr_accessor"
+  spec.version       = ScopedAttrAccessor::VERSION
+  spec.authors       = ["David Brady"]
+  spec.email         = ["dbrady@shinybit.com"]
+  spec.description   = %q{Adds private_attr_reader, private_attr_writer, private_attr_accessor, protected_attr_reader, protected_attr_writer, protected_attr_accessor class macros}
+  spec.summary       = %q{Adds private_* and protected_* attr_reader, attr_writer, and attr_accessor}
+  spec.homepage      = "https://github.com/dbrady/scoped_attr_accessor.git"
+  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 "debugger", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 4.0"
+end

data/test/lib/test_scoped_attr_accessor.rb

@@ -0,0 +1,17 @@
+require 'minitest/autorun'
+require_relative '../../lib/scoped_attr_accessor'
+
+# Directly extend Foo with ScopedAttrAccessor
+module ScopedAttrAccessorTests
+  class Foo
+    extend ScopedAttrAccessor
+  end
+end
+
+# Load the common test suite
+require_relative '../scoped_attr_accessor_test_module'
+
+# Create a Test* class so it will run
+class TestFoo < MiniTest::Unit::TestCase
+  include ScopedAttrAccessorTests
+end

data/test/lib/test_scoped_attr_accessor_include.rb

@@ -0,0 +1,12 @@
+require 'debugger'
+require 'minitest/autorun'
+# Implicitly extend Foo with ScopedAttrAccessor by extending Object
+require_relative '../../lib/scoped_attr_accessor/include'
+
+# Load the common test suite
+require_relative '../scoped_attr_accessor_test_module'
+
+# Create a Test* class so it will run
+class TestFooInclude < MiniTest::Unit::TestCase
+  include ScopedAttrAccessorTests
+end

data/test/scoped_attr_accessor_test_module.rb

@@ -0,0 +1,217 @@
+module ScopedAttrAccessorTests
+  # Foo uses all the accessor types, and also has a set of public
+  # attr_readers mixed in after the readers and another set after the
+  # writers and accessors. This is so the test suite can check to make
+  # sure that we stayed in public scope afterwards. A set of explicit
+  # poke and peek public accessor methods allow the test suite to modify
+  # and examine the contents of these private attributes.
+  class Foo
+    attr_reader :pub_read1, :pub_read2
+    private_attr_reader :priv_read1, :priv_read2
+    protected_attr_reader :prot_read1, :prot_read2
+
+    attr_reader :pub_read3, :pub_read4
+
+    private_attr_writer :priv_write1, :priv_write2
+    protected_attr_writer :prot_write1, :prot_write2
+
+    private_attr_accessor :priv_access1, :priv_access2
+    protected_attr_accessor :prot_access1, :prot_access2
+
+    attr_reader :pub_read5, :pub_read6
+
+    private
+    # this is a REALLY weird edge case, it's probably a bad idea to ever
+    # do this intentionally but I want to prove that, from this private
+    # scope, the prot_read3 accessor is created in protected scope AND
+    # that we bounce back not to public scope, but to private
+    protected_attr_reader :prot_read3
+
+    # We'll test this for privacy down below
+    attr_reader :priv_read3
+
+    public
+
+    def initialize
+      @pub_read1 = "pub_read1"
+      @pub_read2 = "pub_read2"
+      @pub_read3 = "pub_read3"
+      @pub_read4 = "pub_read4"
+      @pub_read5 = "pub_read5"
+      @pub_read6 = "pub_read6"
+
+      @prot_read1 = "prot_read1"
+      @prot_read2 = "prot_read2"
+      @prot_read3 = "prot_read3"
+      @prot_write1 = "prot_write1"
+      @prot_write2 = "prot_write2"
+      @prot_access1 = "prot_access1"
+      @prot_access2 = "prot_access2"
+
+      @priv_read1 = "priv_read1"
+      @priv_read2 = "priv_read2"
+      @priv_read3 = "priv_read3"
+      @priv_write1 = "priv_write1"
+      @priv_write2 = "priv_write2"
+      @priv_access1 = "priv_access1"
+      @priv_access2 = "priv_access2"
+    end
+
+    # Allow tests to peek and poke the private accessors
+    def peek_at_priv_read1; priv_read1; end
+    def peek_at_priv_read2; priv_read2; end
+    def peek_at_priv_read3; priv_read3; end
+
+    def peek_at_priv_write1; @priv_write1; end
+    def peek_at_priv_write2; @priv_write2; end
+
+    def peek_at_priv_access1; priv_access1; end
+    def peek_at_priv_access2; priv_access2; end
+
+    def poke_at_priv_write1(s); self.priv_write1 = s; end
+    def poke_at_priv_write2(s); self.priv_write2 = s; end
+
+    def poke_at_priv_access1(s); self.priv_access1 = s; end
+    def poke_at_priv_access2(s); self.priv_access2 = s; end
+
+    # Test only -- This method must not work!
+    def peek_at_priv_read3_via_protected_access_BAD; self.priv_read3; end
+  end
+
+  # Bar inherits from Foo and is primarily here to test that protected
+  # members do in fact inherit correctly. There are no poke/peek methods
+  # in Foo for protected attributes, for example; we want to make sure
+  # the poke and peek--and their internal accessor calls--are defined
+  # here instead of up in Foo.
+  class Bar < Foo
+    def initialize
+      super
+    end
+
+    # peek at our inherited readers
+    def peek_at_prot_read1; prot_read1; end
+    def peek_at_prot_read2; prot_read2; end
+    def peek_at_prot_read3; prot_read3; end
+
+    # peek at the writers
+    def peek_at_prot_access1; prot_access1; end
+    def peek_at_prot_access2; prot_access2; end
+    def peek_at_prot_write1; @prot_write1; end
+    def peek_at_prot_write2; @prot_write2; end
+
+    def poke_at_prot_write1(s); self.prot_write1 = s; end
+    def poke_at_prot_write2(s); self.prot_write2 = s; end
+
+    def poke_at_prot_access1(s); self.prot_access1 = s; end
+    def poke_at_prot_access2(s); self.prot_access2 = s; end
+  end
+
+  def setup
+    @foo = Foo.new
+    @bar = Bar.new
+  end
+
+  # This is just a sanity check; if it fails start chewing the straps
+  def test_unaltered_public_accessors_still_work_normally
+    @foo.pub_read1.must_equal "pub_read1"
+    @foo.pub_read2.must_equal "pub_read2"
+  end
+
+  # Happy path test 1. If priv_read1-3 are private, they should be
+  # inaccessible
+  def test_private_readers_are_in_fact_private
+    lambda { @foo.priv_read1 }.must_raise NoMethodError
+    lambda { @foo.priv_read2 }.must_raise NoMethodError
+    lambda { @foo.priv_read3 }.must_raise NoMethodError
+  end
+
+  def test_private_writers_are_in_fact_private
+    lambda { @foo.priv_write1 = "OH NOES" }.must_raise NoMethodError
+    lambda { @foo.priv_write2 = "OH NOES" }.must_raise NoMethodError
+  end
+
+  def test_private_accessors_are_in_fact_private
+    lambda { @foo.priv_access1 = "OH NOES" }.must_raise NoMethodError
+    lambda { @foo.priv_access2 = "OH NOES" }.must_raise NoMethodError
+  end
+
+  # Happy path test 2. priv_read1 and priv_read2 may be inaccessible, but are they
+  # in fact present? Use the public peek_at_* methods to check them
+  def test_private_readers_do_in_fact_exist
+    @foo.peek_at_priv_read1.must_equal "priv_read1"
+    @foo.peek_at_priv_read2.must_equal "priv_read2"
+    @foo.peek_at_priv_read3.must_equal "priv_read3"
+  end
+
+  def test_private_writers_do_in_fact_work_as_writers
+    @foo.poke_at_priv_write1 "OOH NEAT1"
+    @foo.poke_at_priv_write2 "OOH NEAT2"
+    @foo.peek_at_priv_write1.must_equal "OOH NEAT1"
+    @foo.peek_at_priv_write2.must_equal "OOH NEAT2"
+  end
+
+  def test_private_accessors_do_in_fact_work_as_accessors
+    @foo.poke_at_priv_access1 "OOH WOW1"
+    @foo.poke_at_priv_access2 "OOH WOW2"
+    @foo.peek_at_priv_access1.must_equal "OOH WOW1"
+    @foo.peek_at_priv_access2.must_equal "OOH WOW2"
+  end
+
+  # Happy path test 3. If prot_read1-3 are protected, they should be
+  # inaccessible
+  def test_protected_readers_are_in_fact_private
+    lambda { @foo.prot_read1 }.must_raise NoMethodError
+    lambda { @foo.prot_read2 }.must_raise NoMethodError
+    lambda { @foo.prot_read3 }.must_raise NoMethodError
+  end
+
+  # Happy path test 4. prot_read1 and prot_read2 may be inaccessible, but are they
+  # in fact present? Use the public peek_at_* methods to check them
+  def test_protected_readers_do_in_fact_exist
+    @bar.peek_at_prot_read1.must_equal "prot_read1"
+    @bar.peek_at_prot_read2.must_equal "prot_read2"
+    @bar.peek_at_prot_read3.must_equal "prot_read3"
+  end
+
+  # And now the million dollar question: private_attr_accessor changes
+  # the scoping to private. When we come back out of this accessor, is
+  # Ruby still in private scope? Or does it revert to the scope it had
+  # beforehand?
+  def test_public_readers_AFTER_private_accessors_still_work_normally
+    @foo.pub_read3.must_equal "pub_read3"
+    @foo.pub_read4.must_equal "pub_read4"
+    @foo.pub_read5.must_equal "pub_read5"
+    @foo.pub_read6.must_equal "pub_read6"
+  end
+
+  # And the million-and-one-dollar question: Inside the explicitly
+  # private scope, after we created protected reader 3, did
+  # attr_accessor priv_read3 still get created privately?
+  def test_private_readers_AFTER_protected_accessors_are_STILL_private
+    lambda { @foo.peek_at_priv_read3_via_protected_access_BAD }.must_raise NoMethodError
+  end
+
+  def test_protected_writers_are_in_fact_protected
+    lambda { @bar.prot_write1 = "OH NOES" }.must_raise NoMethodError
+    lambda { @bar.prot_write2 = "OH NOES" }.must_raise NoMethodError
+  end
+
+  def test_protected_accessors_are_in_fact_protected
+    lambda { @bar.prot_access1 = "OH NOES" }.must_raise NoMethodError
+    lambda { @bar.prot_access2 = "OH NOES" }.must_raise NoMethodError
+  end
+
+  def test_protected_writers_do_in_fact_work_as_writers
+    @bar.poke_at_prot_write1 "AWW YEAH1"
+    @bar.poke_at_prot_write2 "AWW YEAH2"
+    @bar.peek_at_prot_write1.must_equal "AWW YEAH1"
+    @bar.peek_at_prot_write2.must_equal "AWW YEAH2"
+  end
+
+  def test_protected_accessors_do_in_fact_work_as_accessors
+    @bar.poke_at_prot_access1 "OH SNAP1"
+    @bar.poke_at_prot_access2 "OH SNAP2"
+    @bar.peek_at_prot_access1.must_equal "OH SNAP1"
+    @bar.peek_at_prot_access2.must_equal "OH SNAP2"
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: scoped_attr_accessor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- David Brady
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-29 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: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Adds private_attr_reader, private_attr_writer, private_attr_accessor,
+  protected_attr_reader, protected_attr_writer, protected_attr_accessor class macros
+email:
+- dbrady@shinybit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/scoped_attr_accessor.rb
+- lib/scoped_attr_accessor/include.rb
+- lib/scoped_attr_accessor/version.rb
+- scoped_attr_accessor.gemspec
+- test/lib/test_scoped_attr_accessor.rb
+- test/lib/test_scoped_attr_accessor_include.rb
+- test/scoped_attr_accessor_test_module.rb
+homepage: https://github.com/dbrady/scoped_attr_accessor.git
+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'
+      segments:
+      - 0
+      hash: 4018385502197385766
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4018385502197385766
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Adds private_* and protected_* attr_reader, attr_writer, and attr_accessor
+test_files:
+- test/lib/test_scoped_attr_accessor.rb
+- test/lib/test_scoped_attr_accessor_include.rb
+- test/scoped_attr_accessor_test_module.rb