ivar_encapsulation 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e27c01c709744322ad9be05e9d46c298d2376de1
+  data.tar.gz: 2f2cc88793517a526d8dea47e9717243ebacc9c1
+SHA512:
+  metadata.gz: f39b7cd0ec457e7893a154ba1ac904b49d379044c6c9a06f22175ba5f318f9091413ba276d0307a04252e34d65ce2f63e7e83361e753b87049b78665977c92dc
+  data.tar.gz: e3da4c1c2aeda5bb874503d27d022b6725a3fe0f0d1d962cc64b6943594e5d969ed07af831e285eb297ed9bed279fac0dd214e546de7f4e1113b0c9bea1a1772

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2013 Michael Kohl
+
+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/lib/ivar_encapsulation.rb

@@ -0,0 +1,26 @@
+class Module
+  # Similar to <tt>attr_*</tt> but can also generate private
+  # getter/setter methods for class internal use only. Useful
+  # for enforcing Smalltalk-style internal encapsulation.
+  def attribute(*attributes, getter: false, setter: false)
+    attributes.each do |attribute|
+      instance_var_name = "@#{attribute}"
+      setter_name = "#{attribute}="
+
+      define_method(attribute) do
+        instance_variable_get(instance_var_name)
+      end
+
+      define_method(setter_name) do |value|
+        instance_variable_set(instance_var_name, value)
+      end
+
+      self.send(:private, attribute) unless getter
+      self.send(:private, setter_name) unless setter
+    end
+    nil # like attr_accessor
+  end
+
+  alias_method :attributes, :attribute
+  private :attributes, :attribute
+end

data/test/test_ivar_encapsulation.rb

@@ -0,0 +1,55 @@
+require 'minitest/autorun'
+require 'ivar_encapsulation'
+
+class TestIvarEncapsulation < MiniTest::Unit::TestCase
+  class Foo
+    attribute :private
+    attribute :public_reader, getter: true
+    attribute :public_writer, setter: true
+    attribute :public_reader_writer, getter: true, setter: true
+    attributes :foo, :bar, :baz
+
+    def initialize
+      self.private = :priv
+      self.public_reader = :pr
+      self.public_writer = :pw
+      self.public_reader_writer = :prw
+    end
+  end
+
+  def setup
+    @f = Foo.new
+  end
+
+  def test_private
+    assert @f.private_methods.include? :private
+    assert @f.private_methods.include? :private=
+  end
+
+  def test_public_reader
+    assert @f.methods.include? :public_reader
+    assert @f.private_methods.include? :public_reader=
+    assert @f.public_reader == :pr
+  end
+
+  def test_public_writer
+    assert @f.private_methods.include? :public_writer
+    assert @f.methods.include? :public_writer=
+    @f.public_writer = :changed
+    assert @f.instance_variable_get("@public_writer") == :changed
+  end
+
+  def test_public_reader_writer
+    assert @f.methods.include? :public_reader_writer
+    assert @f.methods.include? :public_reader_writer=
+    assert @f.public_reader_writer == :prw
+    assert @f.public_reader_writer = :changed
+    assert @f.public_reader_writer == :changed
+  end
+
+  def test_aliased_method_name
+    assert (@f.private_methods & [:foo, :bar, :baz]).size == 3
+    assert (@f.private_methods & [:foo=, :bar=, :baz=]).size == 3
+  end
+
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: ivar_encapsulation
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Kohl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-23 00:00:00.000000000 Z
+dependencies: []
+description: Provides similar functionality to the attr_* methods, but can also generate
+  private getter/setter methods for class internal use.
+email: citizen428@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/ivar_encapsulation.rb
+- test/test_ivar_encapsulation.rb
+homepage: https://github.com/citizen428/ivar_encapsulation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Better encapsulation for instance variables
+test_files: []