traited 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Lee Jarvis, Michael Fellinger
+
+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,40 @@
+Traited
+=======
+
+Traited allows you to add traits to your classes allowing you to create
+a configuration similar to using class variables. Traited is based on a
+simple Hash where keys are objects and values are whatever you set.
+
+Traited also allows you to get all traits across an ancestral chain,
+where keys later in the ancestors will take precedence.
+
+This class was taken directly out of the core of the
+[Innate](https://github.com/Ramaze/innate), but I found it to be useful
+so I'm extracting it and maintaining it myself. It was written by
+[Michael Fellinger](https://github.com/manveru).
+
+Example
+-------
+
+    class Foo
+      include Traited
+      trait :hello => 'Hello'
+
+      def initialize
+        trait :hello => 'World!'
+      end
+
+      def show
+        [class_trait[:hello], trait[:hello], ancestral_trait[:hello]]
+      end
+    end
+
+    Foo.trait[:hello] # => "Hello"
+    foo = Foo.new
+    foo.trait[:hello] # => "World!"
+    foo.show          # => ["Hello", "World!", "World!"]
+
+Installation
+------------
+
+    gem install traited

data/lib/traited.rb

@@ -0,0 +1,88 @@
+# Traited helps you doing configuration similar to class variables.
+#
+# It's built on a simple Hash, where keys are objects and the values the
+# configuration.
+# By using {Traited#ancestral_trait} you will get nicely inherited
+# configuration, where keys later in the ancestors will take precedence.
+#
+# @example usage
+#
+#   class Foo
+#     include Traited
+#     trait :hello => 'Hello'
+#
+#     def initialize
+#       trait :hello => 'World!'
+#     end
+#
+#     def show
+#       [class_trait[:hello], trait[:hello], ancestral_trait[:hello]]
+#     end
+#   end
+#
+#   Foo.trait[:hello] # => "Hello"
+#   foo = Foo.new
+#   foo.trait[:hello] # => "World!"
+#   foo.show          # => ["Hello", "World!", "World!"]
+module Traited
+  TRAITS, ANCESTRAL_TRAITS, ANCESTRAL_VALUES = {}, {}, {}
+
+  def self.included(into)
+    into.extend(self)
+  end
+
+  def trait(hash = nil)
+    if hash
+      TRAITS[self] ||= {}
+      result = TRAITS[self].merge!(hash)
+      ANCESTRAL_VALUES.clear
+      ANCESTRAL_TRAITS.clear
+      result
+    else
+      TRAITS[self] || {}
+    end
+  end
+
+  # Builds a trait from all the ancestors, closer ancestors overwrite distant
+  # ancestors
+  #
+  # class Foo
+  #   include Innate::Traited
+  #   trait :one => :eins, :first => :erstes
+  # end
+  #
+  # class Bar < Foo
+  #   trait :two => :zwei
+  # end
+  #
+  # class Foobar < Bar
+  #   trait :three => :drei, :first => :overwritten
+  # end
+  #
+  # Foobar.ancestral_trait
+  # # => {:three => :drei, :two => :zwei, :one => :eins, :first => :overwritten}
+  def ancestral_trait
+    klass = self.kind_of?(Module) ? self : self.class
+    ANCESTRAL_TRAITS[klass] ||=
+    each_ancestral_trait({}){|hash, trait| hash.update(trait) }
+  end
+
+  def ancestral_trait_values(key)
+    klass = self.kind_of?(Module) ? self : self.class
+    cache = ANCESTRAL_VALUES[klass] ||= {}
+    cache[key] ||= each_ancestral_trait([]){|array, trait|
+      array << trait[key] if trait.key?(key) }
+  end
+
+  def each_ancestral_trait(obj)
+    ancs = respond_to?(:ancestors) ? ancestors : self.class.ancestors
+    ancs.unshift(self)
+    ancs.reverse_each{|anc| yield(obj, TRAITS[anc]) if TRAITS.key?(anc) }
+    obj
+  end
+
+  # trait for self.class if we are an instance
+  def class_trait
+    respond_to?(:ancestors) ? trait : self.class.trait
+  end
+end

data/spec/traited_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path('../../lib/traited', __FILE__)
+
+class Animal
+  include Traited
+end
+
+class Cat < Animal
+end
+
+class Tiger < Animal
+end
+
+describe Traited do
+  should 'set trait on superclass' do
+    Animal.trait :wild => :depends
+    Animal.trait[:wild].should == :depends
+  end
+
+  should 'reset trait on superclass' do
+    Animal.trait :wild => :naturally
+    Animal.trait[:wild].should == :naturally
+  end
+
+  should 'set trait on instance' do
+    animal = Animal.new
+    animal.trait[:wild].should == nil
+    animal.trait :wild => :depends
+    animal.trait[:wild].should == :depends
+  end
+
+  should 'get ancestral trait from instance' do
+    animal = Animal.new
+    animal.ancestral_trait[:wild].should == :naturally
+    animal.trait :wild => :depends
+    animal.ancestral_trait[:wild].should == :depends
+  end
+
+  should 'set trait on subclass' do
+    Cat.trait :sound => :meow
+    Cat.trait[:sound].should == :meow
+  end
+
+  should 'not modify traits of other classes' do
+    Animal.trait[:sound].should == nil
+    Tiger.trait[:sound].should == nil
+  end
+
+  should 'get ancestral trait from class in superclass' do
+    Cat.ancestral_trait[:wild].should == :naturally
+  end
+
+  should 'get ancestral trait from instance in superclass' do
+    Cat.new.ancestral_trait[:wild].should == :naturally
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: traited
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Lee Jarvis
+- Michael Fellinger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-19 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bacon
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :development
+  version_requirements: *id001
+description: Add traits to your classes and access them from children/ancestors
+email: 
+- lee@jarvis.co
+- m.fellinger@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.md
+- lib/traited.rb
+- spec/traited_spec.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 6
+      version: 1.8.6
+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: Add traits to your classes and access them from children/ancestors
+test_files: []
+