attr_plus 0.2.0

data/LICENSE

@@ -0,0 +1,17 @@
+Copyright (c) 2011 Joshua Hawxwell
+
+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, there are
+no conditions to fulfill.
+
+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,81 @@
+# ClassAttr
+
+Adds `#class_attr_accessor` (and reader/writer) and `#inheritable_class_attr_accessor` (and
+reader/writer of course) to Class.
+
+    class Polygon
+      class_attr_accessor :sides
+    end
+    
+    Polygon.sides = 5
+    Polygon.sides #=> 5
+    
+    class Square < Polygon
+    end
+    
+    Square.sides #=> nil
+    
+    
+    class InheritablePolygon
+      inheritable_class_attr_accessor :sides
+    end
+    
+    Polygon.sides = 4
+    
+    class NewSquare < Polygon
+    end
+    
+    Square.sides #=> 4
+
+You can provide default values using a hash with :default set for the last value, or if just
+creating one accessor/reader/writer add `=> defaultvalue` to the end, this example should
+make it more clear:
+
+    class Person
+      class_attr_accessor :name => 'John Doe'
+      inheritable_class_attr_accessor :arms, :legs, :default => 2
+      inheritable_class_attr_accessor :fingers, :toes, :default => 5
+    end
+    
+    class Agent < Person
+      @name = "James Bond"
+    end  
+    
+    Person.name #=> "John Doe"
+    Person.arms #=> 2
+    Person.toes #=> 5
+    Agent.name  #=> "James Bond"
+    Agent.legs  #=> 2
+    
+
+## Install
+
+    (sudo) gem install class_attr
+    
+
+## Use
+
+    require 'class_attr'
+
+Or, as in some cases this may be overkill, copy the parts you need over (you will need to modify it,
+but that should be easy to work out.)
+    
+
+### 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.
+    
+
+## Thanks
+
+- <http://railstips.org/blog/archives/2006/11/18/class-and-instance-variables-in-ruby/>
+  For originally demystifying the class instance variable thing.
+- <http://www.raulparolari.com/Rails/class_inheritable> For ideas on how to implement 
+  class level attribute accessors which inherit values.
+
+
+## Copyright
+
+Copyright (c) 2010 Joshua Hawxwell. See LICENSE for details.

data/lib/attr_plus.rb

@@ -0,0 +1,3 @@
+require 'attr_plus/class'
+require 'attr_plus/instance'
+require 'attr_plus/module'

data/lib/attr_plus/class.rb

@@ -0,0 +1,222 @@
+require 'attr_plus/ext'
+
+class Class
+  
+  # Defines a method that allows you to read an instance variable set at the
+  # class level. Also defines an _instance_ method that reads the same thing.
+  # Comparable to #attr_reader for the class level.
+  #
+  # So in summary defines: .var (which gets @var) and 
+  #                        #var (which gets self.class.var)
+  # 
+  # @example
+  #
+  #   class Polygon
+  #     class_attr_reader :sides
+  #
+  #     def self.is_a=(shape)
+  #       case shape
+  #         when 'triangle' then @sides = 3
+  #         when 'square' then @sides = 4
+  #       end
+  #     end
+  #   end
+  #
+  #   Polygon.sides #=> nil
+  #   Polygon.is_a 'triangle'
+  #   Polygon.sides #=> 3
+  #   t = Polygon.new
+  #   t.sides #=> 3
+  #
+  def class_attr_reader(*args)
+    names, default = separate_arguments_and_set_defaults(args)
+    names.each do |name|
+      class_eval <<-EOS        
+        def self.#{name}
+          @#{name}
+        end
+
+        def #{name}
+          self.class.send(:#{name})
+        end
+      EOS
+      self.instance_variable_set("@#{name}", (default.dup rescue default))
+    end
+  end
+  
+  # Defines a method for to write to an instance varaible set at the class
+  # level. Comparable to #attr_writer for the class level.
+  #
+  # So in summary defines: .var= (which sets @var)
+  #
+  # @example
+  #
+  #   class Polygon
+  #     class_attr_writer :sides
+  #
+  #     def self.rectangle?; @sides == 4; end
+  #     def self.triangle?; @sides == 3; end
+  #   end
+  #
+  #   Polygon.rectangle? #=> false
+  #   Polygon.sides = 4
+  #   Polygon.rectangle? #=> true
+  #   Polygon.sides = 3
+  #   Polygon.triangle? #=> true
+  #
+  def class_attr_writer(*args)
+    names, default = separate_arguments_and_set_defaults(args)
+    names.each do |name|
+      class_eval <<-EOS        
+        def self.#{name}=(obj)
+          @#{name} = obj
+        end
+      EOS
+    end
+  end
+  
+  # Executes #class_attr_reader and #class_attr_writer.
+  #
+  # @see #class_attr_reader
+  # @see #class_attr_writer
+  #
+  # @example
+  #
+  #   class Polygon
+  #     class_attr_accessor :sides
+  #   end
+  #
+  #   Polygon.sides #=> nil
+  #   Polygon.sides = 5
+  #   Polygon.sides #=> 5
+  #   pentagon = Polygon.new
+  #   pentagon.sides #=> 5
+  #
+  def class_attr_accessor(*names)
+    class_attr_reader(*names)
+    class_attr_writer(*names)
+  end
+  
+  # Creates a class and instance method to read the class level variable(s)
+  # with the name(s) provided. If no value has been set it attempts to use
+  # the value of the superclass.
+  #
+  # @see #class_attr_reader
+  #
+  def inheritable_class_attr_reader(*args)
+    names, default = separate_arguments_and_set_defaults(args)
+    names.each do |name|
+      class_eval <<-EOS        
+        def self.#{name}
+          if @#{name}
+            @#{name}
+          elsif superclass.respond_to? :#{name}
+            @#{name} ||= superclass.#{name}
+          end
+        end
+
+        def #{name}
+          self.class.send(:#{name})
+        end
+      EOS
+      self.instance_variable_set("@#{name}", (default.dup rescue default))
+    end
+  end
+  
+  # The same as #class_attr_writer.
+  def inheritable_class_attr_writer(*args)
+    class_attr_writer(*args)
+  end
+  
+  # Executes #inheritable_class_attr_reader and #inheritable_class_attr_writer.
+  # 
+  # @see #inheritable_class_attr_reader
+  # @see #inheritable_class_attr_writer
+  #
+  # @example
+  #
+  #   class Polygon
+  #     inheritable_class_attr_accessor :sides, :angles
+  #     self.angles = [90]
+  #   end
+  #   
+  #   class Triangle < Polygon
+  #     self.sides = 3
+  #     self.angles = [100, 35, 45]
+  #   end
+  #   
+  #   class Rectangle < Polygon
+  #     self.sides = 4
+  #     self.angles << 60 << 100 << 110
+  #   end
+  #   
+  #   class Square < Rectangle
+  #     # should get 4 sides from rectange
+  #     self.angles = [90] * 4
+  #   end
+  #   
+  #   Polygon.sides    #=> nil
+  #   Triangle.sides   #=> 3
+  #   Rectangle.sides  #=> 4
+  #   Rectangle.angles #=> [90, 60, 100, 110]
+  #   Square.sides     #=> 4
+  #   Square.angles    #=> [90, 90, 90, 90]
+  #
+  def inheritable_class_attr_accessor(*names)
+    inheritable_class_attr_reader(*names)
+    inheritable_class_attr_writer(*names)
+  end
+  
+  
+  private
+  
+  # Non-inheritable attrs won't get any starting value, even if it has been set
+  # on a superclass so we need to save the value and set them when the class is 
+  # inherited.
+  #
+  # @param key [Symbol]
+  # @param value [Object]
+  #
+  def register_default(key, value)
+     registered_defaults[key] = value
+  end
+  
+  def registered_defaults
+    @registered_defaults ||= {}
+  end
+  
+  def inherited_with_attrs(klass)    
+    inherited_without_attrs(klass) if respond_to?(:inherited_without_attrs)
+    if registered_defaults
+      new_attrs = registered_defaults.inject({}) do |a, (k, v)|
+        a.update(k => (v.dup rescue v))
+      end
+    else
+      new_attrs = {}
+    end
+    
+    new_attrs.each do |k, v|
+      klass.instance_variable_set("@#{k}", v)
+    end
+    klass.instance_variable_set("@registered_defaults", new_attrs)
+  end
+  alias inherited_without_attrs inherited
+  alias inherited inherited_with_attrs
+  
+  # Need to use this instead of AttrPlus.separate_arguments so that any defaults
+  # are properly set, but that is only with Class as this is to allow subclasses
+  # to inherit the default values, Modules can't be inherited.
+  #
+  # BUT they can be included so I will have to look into this!
+  def separate_arguments_and_set_defaults(args)
+    args, default = AttrPlus.separate_arguments(args)
+    if default
+      args.each do |arg|
+        register_default(arg, default)
+      end
+    end
+    
+    [args, default]
+  end
+
+end

data/lib/attr_plus/ext.rb

@@ -0,0 +1,20 @@
+# Place extra methods in here to avoid polluting Class and Module.
+#
+module AttrPlus
+
+  # @param args [Array]
+  # @return [Array[Array, Object]]
+  #   An array where the first item is a list of arguments that were passed
+  #   and the second (last) item is a default value that was given or nil.
+  #
+  def self.separate_arguments(args)
+    if args.size == 1 && args.first.is_a?(Hash)
+      [[args.first.keys[0]], args.first.values[0]]
+    elsif args.last.is_a?(Hash)
+      [args[0..-2], args.last[:default]]
+    else
+      [args, nil]
+    end
+  end
+
+end

data/lib/attr_plus/module.rb

@@ -0,0 +1,33 @@
+require 'attr_plus/ext'
+
+class Module
+  
+  def module_attr_reader(*args)
+    names, default = AttrPlus.separate_arguments(args)
+    names.each do |name|
+      module_eval <<-EOS
+        def self.#{name}
+          @#{name}
+        end
+      EOS
+      self.instance_variable_set("@#{name}", (default.dup rescue default))
+    end
+  end
+  
+  def module_attr_writer(*args)
+    names, default = AttrPlus.separate_arguments(args)
+    names.each do |name|
+      module_eval <<-EOS
+        def self.#{name}=(obj)
+          @#{name} = obj
+        end
+      EOS
+    end
+  end
+  
+  def module_attr_accessor(*args)
+    module_attr_reader(*args)
+    module_attr_writer(*args)
+  end
+  
+end

data/lib/class_attr.rb

@@ -0,0 +1,3 @@
+require 'attr_plus/class'
+
+puts "'class_attr' is being deprecated in favour of 'attr_plus/class', please update your code!"

data/spec/attr_plus/class_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+
+describe Class do
+
+  describe "#class_attr_reader" do
+    subject { Class.new { class_attr_reader :test } }
+  
+    it "defines a read method for the class" do 
+      subject.should respond_to :test
+    end
+    
+    it "defines a read method for instances of the class" do
+      subject.new.should respond_to :test
+    end
+  end
+  
+  describe "#class_attr_writer" do
+    subject { Class.new { class_attr_writer :test } }
+  
+    it "defines a write method for the class" do
+      subject.should respond_to :test=
+    end
+  end
+  
+  describe "#class_attr_accessor" do
+    subject { Class.new { class_attr_accessor :test } }
+  
+    it "defines a read method for the class" do
+      subject.should respond_to :test
+    end
+    
+    it "defines a write method for the class" do
+      subject.should respond_to :test=
+    end
+    
+    it "defines a read method for instances of the class" do
+      subject.new.should respond_to :test
+    end
+  end
+  
+  # The subclass thing was starting to annoy me...
+  context "When there is a subclass of a class with class_attrs" do
+
+    let(:sup) { Class.new { class_attr_accessor :test } }
+    let(:sub) { Class.new(sup) }
+
+    it "has the methods of the superclass" do
+      sub.should respond_to :test
+      sub.should respond_to :test=
+    end
+    
+    describe "calling the writer method on the subclass" do
+      it "should not alter the value on the superclass" do
+        sub.test = "changed"
+        sub.test.should == "changed"
+        sup.test.should_not == "changed"
+      end
+    end
+    
+    describe "calling the writer method on the superclass" do
+      it "should not alter the value on the subclass" do
+        sup.test = "changed again"
+        sup.test.should == "changed again"
+        sub.test.should_not == "changed again"
+      end
+    end
+  end
+    
+    
+  # Inheritable class attributes
+  
+  describe "#inheritable_class_attr_reader" do
+    subject { Class.new { inheritable_class_attr_reader :test } }
+    
+    it "defines a read method for the class" do
+      subject.should respond_to :test
+    end
+    
+    it "defines a read method for instances of the class" do
+      subject.new.should respond_to :test
+    end
+  end
+  
+  describe "#inheritable_class_attr_writer" do
+    subject { Class.new { inheritable_class_attr_writer :test } }
+    
+    it "defines a write method for the class" do
+      subject.should respond_to :test=
+    end
+  end
+  
+  describe "#inheritable_class_attr_accessor" do
+    subject { Class.new { inheritable_class_attr_accessor :test } }
+  
+    it "defines a read method for the class" do
+      subject.should respond_to :test
+    end
+    
+    it "defines a write method for the class" do
+      subject.should respond_to :test=
+    end
+    
+    it "defines a read method for instances of the class" do
+      subject.new.should respond_to :test
+    end
+  end
+  
+  context "When there is a subclass of a class with inheritable_class_attrs" do
+  
+    let(:sup) { Class.new { inheritable_class_attr_accessor :test } }
+    let(:sub) { Class.new(sup) }
+
+    it "has the methods of the superclass" do
+      sub.should respond_to :test
+      sub.should respond_to :test=
+    end
+    
+    describe "calling the writer method on the subclass" do
+      it "should not alter the value on the superclass" do
+        sub.test = "changed"
+        sub.test.should == "changed"
+        sup.test.should_not == "changed"
+      end
+    end
+    
+    describe "calling the writer method on the superclass" do
+      it "should alter the value on the subclass if not set" do
+        sup.test = "changed it"
+        sup.test.should == "changed it"
+        sub.test.should == "changed it"
+      end
+      
+      it "should not alter the value on the subclass if set" do
+        sub.test = "already set"
+        sup.test = "change it"
+        sup.test.should == "change it"
+        sub.test.should == "already set"
+      end
+    end
+  end
+  
+  context "When given a default value" do
+    
+    subject { Class.new { class_attr_accessor :test => "hi" } }
+    
+    it "returns the default value before it is changed" do
+      subject.test.should == "hi"
+    end
+    
+    it "returns the new value if it is changed" do
+      subject.test = nil
+      subject.test.should be_nil
+    end
+    
+    context "When this class is inherited" do
+      let(:sub) { Class.new(subject) }
+      
+      it "returns the default value as well" do
+        sub.test.should == "hi"
+      end
+    end
+    
+  end
+  
+end

data/spec/attr_plus/module_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Module do
+  
+  describe "#module_attr_reader" do
+    subject { Module.new { module_attr_reader :test } }
+    
+    it "defines a read method for the module" do
+      subject.should respond_to :test
+    end
+  end
+  
+  describe "#module_attr_writer" do
+    subject { Module.new { module_attr_writer :test } }
+    
+    it "defines a write method for the module" do
+      subject.should respond_to :test=
+    end
+  end
+  
+  describe "#module_attr_accessor" do
+    subject { Module.new { module_attr_accessor :test } }
+    
+    it "defines a read method for the module" do
+      subject.should respond_to :test
+    end
+    
+    it "defines a write method for the module" do
+      subject.should respond_to :test=
+    end
+  end
+  
+  context "When given a default value" do
+    subject { Module.new { module_attr_accessor :test => "hi" } }
+    
+    it "returns the default value before being changed" do
+      subject.test.should == "hi"
+    end
+    
+    it "returns the new value if it is changed" do
+      subject.test = nil
+      subject.test.should be_nil
+    end
+    
+    context "when this module is included" do
+      subject { Class.new { include Module.new { module_attr_accessor :test => "hi" } } }
+      
+      it "returns the default value as well" do
+        subject.test.should == "hi"
+      end
+    end
+    
+  end
+  
+end

data/spec/class_attr_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe AttrPlus do
+
+  describe "#separate_argument_list_and_default" do
+    def call_it(*args)
+      AttrPlus.separate_arguments(*args)
+    end
+    
+    context "when given a list of arguments with a default" do
+      it "returns an array with the arguments and a default value" do
+        call_it([:one, :two, :three, {:default => 0}]).should == [[:one, :two, :three], 0]
+      end
+    end
+    
+    context "when given an argument and a default" do
+      it "returns an array with the arguments and a default value" do
+        call_it([{:one => 1}]).should == [[:one], 1]
+      end
+    end
+    
+    context "when given just arguments" do
+      it "returns and array with the arguments and nil" do
+        call_it([:one, :two, :three]).should == [[:one, :two, :three], nil]
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+if RUBY_VERSION >= "1.9"
+  require 'duvet'
+  Duvet.start :filter => 'class_attr/lib'
+end
+
+require 'rspec'
+require 'attr_plus'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: attr_plus
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Joshua Hawxwell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-12 00:00:00 +00: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"
+email: m@hawx.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- LICENSE
+- lib/attr_plus/class.rb
+- lib/attr_plus/ext.rb
+- lib/attr_plus/instance.rb
+- lib/attr_plus/module.rb
+- lib/attr_plus.rb
+- lib/class_attr.rb
+- spec/attr_plus/class_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: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: attr_accessor for class and module level instance variables.
+test_files: 
+- spec/attr_plus/class_spec.rb
+- spec/attr_plus/module_spec.rb
+- spec/class_attr_spec.rb
+- spec/spec_helper.rb