private_attr 0.1.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/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jacob Swanner
+
+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,88 @@
+# PrivateAttr [![Build Status](https://secure.travis-ci.org/jswanner/private_attr.png?branch=master)](https://travis-ci.org/jswanner/private_attr)
+
+Perhaps it's just personal preference, but I don't like to use instance
+variables througout my Ruby classes. At the same time, I don't
+necessarily want public attribute readers and writers. This causes me to
+tend to use something like the following:
+
+```ruby
+class Foo
+  def initialize bar
+    self.bar = bar
+  end
+
+  private
+
+  attr_accessor :bar
+end
+```
+
+But, I really like to declare my attribute readers and writers near the
+top of my classes, which means I sometimes use something like:
+
+```ruby
+class Bar
+  attr_accessor :foo
+  private :foo, :foo=
+
+  def initialize foo
+    self.foo = foo
+  end
+end
+```
+
+This library is meant to be a convenient solution to that verbosity.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'private_attr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install private_attr
+
+## Usage
+
+```ruby
+class Bar
+  extend PrivateAttr
+
+  private_attr_accessor :foo
+  private_attr_reader :baz
+  private_attr_writer :bat
+
+  def initialize foo
+    self.foo = foo
+  end
+end
+```
+
+It even does protected attributes:
+
+```ruby
+class Bar
+  extend PrivateAttr
+
+  protected_attr_accessor :foo
+  protected_attr_reader :baz
+  protected_attr_writer :bat
+
+  def initialize foo
+    self.foo = foo
+  end
+end
+```
+
+## 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,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.name = 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task default: :spec

data/lib/private_attr/version.rb

@@ -0,0 +1,3 @@
+module PrivateAttr
+  VERSION = "0.1.0"
+end

data/lib/private_attr.rb

@@ -0,0 +1,33 @@
+require "private_attr/version"
+
+module PrivateAttr
+  def private_attr_accessor *attr
+    private_attr_reader *attr
+    private_attr_writer *attr
+  end
+
+  def private_attr_reader *attr
+    attr_reader *attr
+    private *attr
+  end
+
+  def private_attr_writer *attr
+    attr_writer *attr
+    private *attr.map { |a| "#{a}=" }
+  end
+
+  def protected_attr_accessor *attr
+    protected_attr_reader *attr
+    protected_attr_writer *attr
+  end
+
+  def protected_attr_reader *attr
+    attr_reader *attr
+    protected *attr
+  end
+
+  def protected_attr_writer *attr
+    attr_writer *attr
+    protected *attr.map { |a| "#{a}=" }
+  end
+end

data/private_attr.gemspec

@@ -0,0 +1,19 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'private_attr/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "private_attr"
+  gem.version       = PrivateAttr::VERSION
+  gem.authors       = ["Jacob Swanner"]
+  gem.email         = ["jacob@jacobswanner.com"]
+  gem.description   = %q{Easily create private/protected attribute readers/writers}
+  gem.summary       = %q{Easily create private/protected attribute readers/writers}
+  gem.homepage      = "https://github.com/jswanner/private_attr"
+
+  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/spec/private_attr_spec.rb

@@ -0,0 +1,245 @@
+require 'minitest/autorun'
+require 'private_attr'
+
+class Dummy
+  def read_accessor
+    accessor
+  end
+
+  def read_accessor_other other
+    other.accessor
+  end
+
+  def write_accessor value
+    self.accessor = value
+  end
+
+  def write_accessor_other other, value
+    other.accessor = value
+  end
+
+  def read_reader
+    reader
+  end
+
+  def read_reader_other other
+    other.reader
+  end
+
+  def write_writer value
+    self.writer = value
+  end
+
+  def write_writer_other other, value
+    other.writer = value
+  end
+end
+
+class PrivateDummy < Dummy
+  extend PrivateAttr
+  private_attr_accessor :accessor
+  private_attr_reader :reader
+  private_attr_writer :writer
+end
+
+class ProtectedDummy < Dummy
+  extend PrivateAttr
+  protected_attr_accessor :accessor
+  protected_attr_reader :reader
+  protected_attr_writer :writer
+end
+
+describe PrivateAttr do
+  let(:dummy) { dummy_class.new }
+  let(:other) { dummy_class.new }
+  let(:old_value) { 'old value' }
+  let(:value) { 'value' }
+
+  describe 'private_attr_accessor' do
+    let(:dummy_class) { PrivateDummy }
+
+    before { dummy.instance_variable_set '@accessor', old_value }
+
+    it 'allows attribute to be read internally' do
+      dummy.read_accessor.must_equal old_value
+    end
+
+    it 'allows attribute to be written internally' do
+      dummy.write_accessor value
+      dummy.instance_variable_get('@accessor').must_equal value
+    end
+
+    it 'raises Error when read externally' do
+      -> { dummy.accessor }.must_raise NoMethodError
+    end
+
+    it 'raises Error when written externally' do
+      -> { dummy.accessor = value }.must_raise NoMethodError
+    end
+
+    it 'raises Error when read by other' do
+      -> { dummy.read_accessor_other other }.must_raise NoMethodError
+    end
+
+    it 'raises Error when written by other' do
+      -> { dummy.write_accessor_other other, value }.must_raise NoMethodError
+    end
+  end
+
+  describe 'private_attr_reader' do
+    let(:dummy_class) { PrivateDummy }
+
+    before { dummy.instance_variable_set '@reader', old_value }
+
+    it 'allows attribute to be read internally' do
+      dummy.read_reader.must_equal old_value
+    end
+
+    it 'raises Error when written internally' do
+      -> { dummy.write_reader value }.must_raise NoMethodError
+    end
+
+    it 'raises Error when read externally' do
+      -> { dummy.reader }.must_raise NoMethodError
+    end
+
+    it 'raises Error when written externally' do
+      -> { dummy.reader = value }.must_raise NoMethodError
+    end
+
+    it 'raises Error when read by other' do
+      -> { dummy.read_reader_other other }.must_raise NoMethodError
+    end
+
+    it 'raises Error when written by other' do
+      -> { dummy.write_reader_other other, value }.must_raise NoMethodError
+    end
+  end
+
+  describe 'private_attr_writer' do
+    let(:dummy_class) { PrivateDummy }
+
+    before { dummy.instance_variable_set '@writer', old_value }
+
+    it 'raises Error when read internally' do
+      -> { dummy.read_writer }.must_raise NoMethodError
+    end
+
+    it 'allows attribute to be written internally' do
+      dummy.write_writer value
+      dummy.instance_variable_get('@writer').must_equal value
+    end
+
+    it 'raises Error when read externally' do
+      -> { dummy.writer }.must_raise NoMethodError
+    end
+
+    it 'raises Error when written externally' do
+      -> { dummy.writer = value }.must_raise NoMethodError
+    end
+
+    it 'raises Error when read by other' do
+      -> { dummy.read_writer_other other }.must_raise NoMethodError
+    end
+
+    it 'raises Error when written by other' do
+      -> { dummy.write_writer_other other, value }.must_raise NoMethodError
+    end
+  end
+
+  describe 'protected_attr_accessor' do
+    let(:dummy_class) { ProtectedDummy }
+
+    before { dummy.instance_variable_set '@accessor', old_value }
+
+    it 'allows attribute to be read internally' do
+      dummy.read_accessor.must_equal old_value
+    end
+
+    it 'allows attribute to be written internally' do
+      dummy.write_accessor value
+      dummy.instance_variable_get('@accessor').must_equal value
+    end
+
+    it 'raises Error when read externally' do
+      -> { dummy.accessor }.must_raise NoMethodError
+    end
+
+    it 'raises Error when written externally' do
+      -> { dummy.accessor = value }.must_raise NoMethodError
+    end
+
+    it 'allows attribute to be read by other' do
+      other.instance_variable_set '@accessor', value
+      dummy.read_accessor_other(other).must_equal value
+    end
+
+    it 'allows attribute to be written by other' do
+      dummy.write_accessor_other other, value
+      other.instance_variable_get('@accessor').must_equal value
+    end
+  end
+
+  describe 'protected_attr_reader' do
+    let(:dummy_class) { ProtectedDummy }
+
+    before { dummy.instance_variable_set '@reader', old_value }
+
+    it 'allows attribute to be read internally' do
+      dummy.read_reader.must_equal old_value
+    end
+
+    it 'raises Error when written internally' do
+      -> { dummy.write_reader value }.must_raise NoMethodError
+    end
+
+    it 'raises Error when read externally' do
+      -> { dummy.reader }.must_raise NoMethodError
+    end
+
+    it 'raises Error when written externally' do
+      -> { dummy.reader = value }.must_raise NoMethodError
+    end
+
+    it 'allows attribute to be read by other' do
+      other.instance_variable_set '@reader', value
+      dummy.read_reader_other(other).must_equal value
+    end
+
+    it 'raises Error when written by other' do
+      -> { dummy.write_reader_other other, value }.must_raise NoMethodError
+    end
+  end
+
+  describe 'protected_attr_writer' do
+    let(:dummy_class) { ProtectedDummy }
+
+    before { dummy.instance_variable_set '@writer', old_value }
+
+    it 'raises Error when read internally' do
+      -> { dummy.read_writer }.must_raise NoMethodError
+    end
+
+    it 'allows attribute to be written internally' do
+      dummy.write_writer value
+      dummy.instance_variable_get('@writer').must_equal value
+    end
+
+    it 'raises Error when read externally' do
+      -> { dummy.writer }.must_raise NoMethodError
+    end
+
+    it 'raises Error when written externally' do
+      -> { dummy.writer = value }.must_raise NoMethodError
+    end
+
+    it 'raises Error when read by other' do
+      -> { dummy.read_writer_other other }.must_raise NoMethodError
+    end
+
+    it 'allows attribute to be written by other' do
+      dummy.write_writer_other other, value
+      other.instance_variable_get('@writer').must_equal value
+    end
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: private_attr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jacob Swanner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-29 00:00:00.000000000 Z
+dependencies: []
+description: Easily create private/protected attribute readers/writers
+email:
+- jacob@jacobswanner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/private_attr.rb
+- lib/private_attr/version.rb
+- private_attr.gemspec
+- spec/private_attr_spec.rb
+homepage: https://github.com/jswanner/private_attr
+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'
+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: Easily create private/protected attribute readers/writers
+test_files:
+- spec/private_attr_spec.rb