anise 0.3.0 → 0.4.0

data/HISTORY

@@ -1,3 +1,7 @@
+2009-05-28   trans <transfire@gmail.com>
+
+	*  added annotation_added callback
+
 2008-10-23   trans <transfire@gmail.com>
 
         * cleaned up work directory

data/MANIFEST

@@ -30,4 +30,6 @@ test/test_attribute_toplevel.rb
 test/test_anise.rb
 test/test_annotations_module.rb
 test/test_anise_toplevel.rb
-test/test_annotations_toplevel.rb
+test/test_annotations_toplevel.rb
+spec/04_callbacks.rd
+spec/01_annotations.rd

data/VERSION

@@ -1 +1 @@
-anise 0.3.0 beta (2009-02-15)
+anise 0.4.0 beta (2009-02-15)

data/lib/anise/annotation.rb

@@ -134,6 +134,8 @@ module Anise
         keys = keys.inject({}){ |h,(k,v)| h[k.to_sym] = v; h} #rekey
         annotations[ref] ||= {}
         annotations[ref].update(keys)
+        # callback
+        annotation_added(ref)
       else
         key = keys.to_sym
         annotation(ref)[key]
@@ -162,6 +164,8 @@ module Anise
         keys = keys.inject({}){ |h,(k,v)| h[k.to_sym] = v; h} #rekey
         annotations[ref] ||= {}
         annotations[ref].update(keys)
+        # callback
+        annotation_added(ref) if method_defined?(:annotation_added)
       else
         key = keys.to_sym
         annotations[ref] ||= {}
@@ -173,6 +177,11 @@ module Anise
       end
     end
 
+    # callback method
+    def annotation_added(name)
+      super if defined?(super)
+    end
+
   end
 
 end

data/spec/01_annotations.rd

@@ -0,0 +1,25 @@
+= Creating and Reading Annotations
+
+Load the primary annotations library.
+
+  require 'anise/annotation'
+
+Given a example class X we can apply annotations to it using the #ann method. 
+
+  class X
+    include Anise::Annotation
+    ann :x1, :a=>1
+    ann :x1, :b=>2
+  end
+
+We can then use #ann to lookup the set annotations.
+
+  X.ann(:x1,:a).should == 1
+
+The #ann method is a public interface, so we can define annotation externally as well.
+
+   X.ann :x1, :a => 2
+   X.ann(:x1, :a).should == 2
+
+QED.
+

data/spec/04_callbacks.rd

@@ -0,0 +1,60 @@
+= Callbacks
+
+Load the annotations, which supports callbacks out of the box.
+
+  require 'anise/annotation'
+
+Given a sample class X, we can use a standard callback method #annotation_added().
+
+  class X
+    include Anise::Annotation
+
+    class << self
+      attr :last_callback
+
+      def annotation_added(name)
+        @last_callback = [name, ann(name)]
+      end
+    end
+  end
+
+Now if we add an annotation, we will see the callback catches it.
+
+  X.ann :x1, :a=>1
+  X.last_callback.should == [:x1, {:a => 1}]
+
+We'll do it again to be sure.
+
+  X.ann :x1, :b=>2
+  X.last_callback.should == [:x1, {:a => 1, :b => 2}]
+
+== Using Callbacks for Attribute Defaults
+
+  class ::Module
+    def annotation_added(key)
+      base = self
+      if value = ann(key, :default)
+        define_method(key) do
+          instance_variable_set("@#{key}", value) unless instance_variable_defined?("@#{key}")
+          base.module_eval{ attr key }
+          instance_variable_get("@#{key}")
+        end 
+      end
+    end
+  end
+
+Try it out.
+
+  class Y
+    include Anise::Annotation
+
+    attr :a
+    ann :a, :default => 10
+  end
+
+  x = Y.new
+  x.a.should == 10
+  x.a.should == 10
+
+QED.
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: anise
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - tigerops-community@rubyforge.org
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-15 00:00:00 -05:00
+date: 2009-05-28 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -70,6 +70,8 @@ files:
 - test/test_annotations_module.rb
 - test/test_anise_toplevel.rb
 - test/test_annotations_toplevel.rb
+- spec/04_callbacks.rd
+- spec/01_annotations.rd
 has_rdoc: true
 homepage: http://
 post_install_message: