attr_plus 0.2.2 → 0.3.0

data/README.md

@@ -5,6 +5,8 @@
 Adds `#class_attr_accessor` (and reader/writer) and `#inheritable_class_attr_accessor` (and
 reader/writer of course) to Class.
 
+    require 'attr_plus'
+
     class Polygon
       class_attr_accessor :sides
     end
@@ -33,6 +35,8 @@ You can provide default values using a hash with :default set for the last value
 creating one accessor/reader/writer add `=> defaultvalue` to the end, this example should
 make it more clear:
 
+    require 'attr_plus/class'
+    
     class Person
       class_attr_accessor :name => 'John Doe'
       inheritable_class_attr_accessor :arms, :legs, :default => 2
@@ -52,10 +56,12 @@ make it more clear:
 
 ## ModuleAttr
 
-Almost exactly the same as `class_*` but for modules. __Note__ there is no module inheritence
+Almost exactly the same as `class_*` but for modules. __Note__ there is no module inheritance
 so `inheritable_module_*` will not work, I am thinking of adding `includable_module_*` later
 but they aren't in yet so can't be used!
 
+    require 'attr_plus/module'
+
     module MyHouse
       module_attr_accessor :width, :height, :default => 200
       module_attr_accessor :rooms => []
@@ -67,6 +73,44 @@ but they aren't in yet so can't be used!
     House.rooms.first #=> :living_room
     
 
+## Instance Extensions
+
+I've also added extensions to the methods for creating accessors on instances. These create
+private versions, working exactly the same in every other way.
+
+    require 'attr_plus/instance'
+    
+    class SecretBox
+      attr_writer :stuff
+      private_attr_reader :stuff
+      
+      def initialize
+        @stuff = []
+      end
+      
+      def <<(val)
+        stuff << val
+      end
+      
+      def shake
+        stuff[rand(stuff.size)]
+      end
+    end
+    
+    box = SecretBox.new
+    box << "giraffe"
+    box << "elephant"
+    box << "camel"
+    box << "cat"
+    p box.shake #=> "giraffe"
+    p box.stuff # NoMethodError: private method 'stuff' called
+    box.stuff = %w(dog hamster fish)
+    p box.shake #=> "fish"
+
+And then as usual there are `private_attr_accessor` and `private_attr_writer` which work
+as expected.
+    
+
 ## Install
 
     (sudo) gem install attr_plus
@@ -79,13 +123,13 @@ but they aren't in yet so can't be used!
     # or for specific methods
     require 'attr_plus/class' # for only class_*
     require 'attr_plus/module' # for only module_*
+    require 'attr_plus/instance' # for only private_attr_*
         
 
 ### Important!
 
-If in a class you define the `self.inherited` method, make sure to call super at the end (or beginning)
-otherwise default values will not be set for the subclass. But I'm guessing you already called super
-anyway in a method like that.
+If in a class you define the `self.inherited` method, make sure to call super 
+somewhere otherwise default values will not be set for the subclass.
     
 
 ## Thanks

data/lib/attr_plus/instance.rb

@@ -1,19 +1,18 @@
-# At the moment attr_* is very fast, but very inflexible. It is not possible
-# to create :something? methods, which would be much easier than
-#
-#   attr_accessor :alive
-#   alias_method :alive?, :alive
-#
-# Also it is not possible to set defaults, these things could be remedied,
-# but should be done in the most efficient ways possible, ie. don't rely on
-# eval.
-#
-#   attr_accessor :alive?
-#
-# Could become...
-#
-#   attr_accessor :alive
-#   alias_method :alive?, :alive
-#
-# Or something similar.
-#   
+class Module
+
+  def private_attr_accessor(*args)
+    private_attr_writer(*args)
+    private_attr_reader(*args)
+  end
+  
+  def private_attr_writer(*args)
+    attr_writer(*args)
+    private(*args.map {|i| "#{i.to_s}=".to_sym })
+  end
+  
+  def private_attr_reader(*args)
+    attr_reader(*args)
+    private(*args)
+  end
+
+end

data/spec/attr_plus/class_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Class do
 
-  describe "#class_attr_reader" do
+  describe ".class_attr_reader" do
     subject { Class.new { class_attr_reader :test } }
   
     it "defines a read method for the class" do 
@@ -14,7 +14,7 @@ describe Class do
     end
   end
   
-  describe "#class_attr_writer" do
+  describe ".class_attr_writer" do
     subject { Class.new { class_attr_writer :test } }
   
     it "defines a write method for the class" do
@@ -22,7 +22,7 @@ describe Class do
     end
   end
   
-  describe "#class_attr_accessor" do
+  describe ".class_attr_accessor" do
     subject { Class.new { class_attr_accessor :test } }
   
     it "defines a read method for the class" do
@@ -69,7 +69,7 @@ describe Class do
     
   # Inheritable class attributes
   
-  describe "#inheritable_class_attr_reader" do
+  describe ".inheritable_class_attr_reader" do
     subject { Class.new { inheritable_class_attr_reader :test } }
     
     it "defines a read method for the class" do
@@ -81,7 +81,7 @@ describe Class do
     end
   end
   
-  describe "#inheritable_class_attr_writer" do
+  describe ".inheritable_class_attr_writer" do
     subject { Class.new { inheritable_class_attr_writer :test } }
     
     it "defines a write method for the class" do
@@ -89,7 +89,7 @@ describe Class do
     end
   end
   
-  describe "#inheritable_class_attr_accessor" do
+  describe ".inheritable_class_attr_accessor" do
     subject { Class.new { inheritable_class_attr_accessor :test } }
   
     it "defines a read method for the class" do
@@ -162,4 +162,11 @@ describe Class do
     
   end
   
+  
+  # Class Variables
+  
+  describe ".cattr_accessor" do
+  
+  end
+  
 end

data/spec/attr_plus/instance_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Module do
+
+  describe ".private_attr_reader" do
+    subject { 
+      Class.new { 
+        private_attr_reader :test
+        attr_writer :test
+        def read; test; end
+      }.new 
+    }
+    
+    it "defines a private reader method" do
+      subject.should_not respond_to :test
+      subject.respond_to?(:test, true).should be_true
+    end
+    
+    it "allows the class to call it" do
+      subject.test = "hi"
+      subject.instance_eval("test").should == "hi"
+    end
+  end
+  
+  describe ".private_attr_writer" do
+    subject { 
+      Class.new { 
+        private_attr_writer :test
+        attr_reader :test
+      }.new
+    }
+    
+    it "defines a private reader method" do
+      subject.should_not respond_to :test=
+      subject.respond_to?(:test=, true).should be_true
+    end
+    
+    it "allows the class to call it" do
+      subject.instance_eval("self.test = 'hi'")
+      subject.test.should == "hi"
+    end
+  end
+  
+  describe ".private_attr_accessor" do
+    subject {
+      Class.new {
+        private_attr_accessor :test
+        def read; test; end
+      }.new
+    }
+    
+    it "defines private writer and reader methods" do
+      subject.should_not respond_to :test
+      subject.respond_to?(:test, true).should be_true
+      
+      subject.should_not respond_to :test=
+      subject.respond_to?(:test=, true).should be_true
+    end
+    
+    it "allows the class to write to it" do
+      subject.instance_eval("self.test = 'hi'")
+      subject.read.should == "hi"
+    end
+    
+    it "allows the class to read it" do
+      subject.send(:test=, "hi")
+      subject.instance_eval("test").should == "hi"
+    end
+  end
+  
+end

metadata

@@ -1,32 +1,25 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: attr_plus
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 2
-  version: 0.2.2
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Joshua Hawxwell
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-22 00:00:00 +00:00
+date: 2011-04-27 00:00:00.000000000 +01:00
 default_executable: 
 dependencies: []
-
-description: "    Provides attr_accessor style methods for easily creating methods for\n    working with class level instance variables and module level instance\n    variables. Variables can be inherited and have default values.\n"
+description: ! "    Provides attr_accessor style methods for easily creating methods
+  for\n    working with class level instance variables and module level instance\n
+  \   variables. Variables can be inherited and have default values.\n"
 email: m@hawx.me
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.md
 - LICENSE
 - lib/attr_plus/class.rb
@@ -36,43 +29,38 @@ files:
 - lib/attr_plus.rb
 - lib/class_attr.rb
 - spec/attr_plus/class_spec.rb
+- spec/attr_plus/instance_spec.rb
 - spec/attr_plus/module_spec.rb
 - spec/class_attr_spec.rb
 - spec/spec_helper.rb
 has_rdoc: false
 homepage: http://github.com/hawx/attr_plus
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: attr_accessor for class and module level instance variables.
-test_files: 
+test_files:
 - spec/attr_plus/class_spec.rb
+- spec/attr_plus/instance_spec.rb
 - spec/attr_plus/module_spec.rb
 - spec/class_attr_spec.rb
 - spec/spec_helper.rb