anise 0.2.0 → 0.2.1

data/MANIFEST

@@ -1,3 +1,4 @@
+MANIFEST
 test
 test/test_attribute.rb
 test/test_annotator.rb

data/README

@@ -1,62 +1,91 @@
 = Anise
 
-  http://anise.rubyforge.org
-
+   http://anise.rubyforge.org
 
 == INTRODUCTION
 
-Anise is an Annotations Systems for the Ruby programming lanaguage.
+Anise is an Annotations Systems for the Ruby programming language.
 Unlike most other annotations systems it is not a comment-based
 system, or a "macro" system that sits over-and-above the rest of the 
 code. Rather, Anise is a dynamic annotations system operating at runtime.
 
-
-== RELEASE NOTES & RECENT CHANGES
+== RELEASE NOTES
 
 Please see the RELEASE file.
 
-
 == INSTALLATION
 
 To install with RubyGems simply open a console and type:
 
-  gem install anise
+   gem install anise
 
 To manually install you will need Setup.rb (see http://setup.rubyforge.org).
 Then download the tarball package and do:
 
-  $ tar -xvzf anise-0.4.0.tgz
-  $ cd annotated-0.4.0
-  $ sudo setup.rb all
+   $ tar -xvzf anise-0.2.0.tgz
+   $ cd anise-0.2.0
+   $ sudo setup.rb all
 
+== USAGE
 
-== TESTING
+The following example briefly demonstrates all three major features.
 
-We recommend using Turn (http://turn.rubyforge.org) to run Anise's
-unit tests.
+   require 'anise'
 
-  $ turn test/test_*
+   class X
 
-But we have include a script +test/suite.rb+ so you can easily run the
-unit tests with the testrb command:
+     include Anise
 
-  $ testrb test/suite.rb
+     # Annotations
 
-or with Ruby alone:
+     ann :grape, :class=>String
 
-  $ ruby -rtest/unit test/suite.rb
+     # Annotators
 
+     annotator :doc
 
-== USAGE
+     doc "This is an entry."
+
+     def bar
+       # ...
+     end
+
+     # Annotated Attributes
+
+     attr :baz, Integer, :max => 10
+
+   end
 
-For the moment please see the API documentation to learn how to use the library.
+Looking at the resulting annotations:
+
+   X.ann(:foo)  #=> {:class=>String}
+   X.ann(:bar)  #=> {:doc=>"This is an entry."}
+   X.ann(:baz)  #=> {:class=>Integer, :max=>10}
+
+The Anise library can be used as a whole, per the example above, or these
+features can be used separately. For more details see the RDoc API
+documentation.
+
+== TESTING
+
+Turn is the recommended way to run Anise's test suite (http://turn.rubyforge.org).
+
+  $ turn test/test_*
+
+But a script +test/suite.rb+ script is include so you can easily run
+the unit tests with the testrb command:
+
+  $ testrb -Ilib test/suite.rb
+
+or with Ruby alone:
 
+  $ ruby -Ilib -rtest/unit test/suite.rb
 
 == LICENSE
 
 Copyright (c) 2008 TigerOps
 
-This program is ditributed under the terms of the LGPL License.
+This program is distributed under the terms of the LGPL License.
 
 Please see COPYING file for details.
 

data/RELEASE

@@ -1,16 +1,12 @@
 = Anise 0.2.0 hits the streets.
 
-  http://anise.rubyforge.org
-
-This is the initial public release of Anise.
+This is the first public release of Anise.
 
 Anise is a spin off the the Facets annotations.rb library.
 It includes the Annotations functionality, and adds
 a mixin, Annotator, that makes it easy to add new
 annotations on the fly.
 
----
-
 ### 0.2.0 // 2008-09-23
 
 2 Major Enhancments

data/VERSION

@@ -1 +1 @@
-anise 0.2.0 beta (2008-09-27)
+anise 0.2.1 beta (2008-09-27)

data/lib/anise/annotation.rb

@@ -12,6 +12,8 @@ module Anise
   #
   # == Synopsis
   #
+  #   require 'anise/annotation'
+  #
   #   class X
   #     include Anise::Annotation
   #
@@ -72,19 +74,14 @@ module Anise
       base.extend self
     end
 
-    # Stores this classes or modules annotations.
-    #
-    def annotations
-      #$annotations[self]
-      @annotations ||= {}
-    end
-
     # Lookup an annotation. Unlike +annotations[ref]+
     # this provides a complete annotation <i>heritage</i>,
-    # pulling annotations of the same reference name 
+    # pulling annotations of the same reference name
     # from ancestor classes and modules.
     #
-    def annotation(ref)
+    def annotation(ref=nil)
+      return(@annotations ||= {}) if ref.nil?
+
       ref = ref.to_sym
       ann = {}
       ancestors.reverse_each do |anc|
@@ -102,6 +99,16 @@ module Anise
       #end
     end
 
+    # Plural alias for #annotation.
+    alias_method :annotations, :annotation
+
+    # Stores this class' or module's annotations.
+    #
+    #def annotations
+    #  #$annotations[self]
+    #  @annotations ||= {}
+    #end
+
     # Set or read annotations.
     #
     def ann( ref, keys_or_class=nil, keys=nil )
@@ -156,5 +163,4 @@ module Anise
 end
 
 # 2006-11-07 trans  Created this ultra-concise version of annotations.
-# Copyright (c) 2005, 2008 TigerOps
-
+# Copyright (c) 2005, 2008 TigerOps

data/lib/anise/annotator.rb

@@ -6,6 +6,8 @@ module Anise
   # Annotator allows for the creation of dynamic method
   # annotations which attach to the next method defined.
   #
+  #   require 'anise/annotator'
+  #
   #   class X
   #     include Anise::Annotator
   #

data/lib/anise/attribute.rb

@@ -11,6 +11,8 @@ module Anise
   # annotations to added to them directly rather than requireing a
   # separate #ann statement.
   #
+  #   require 'anise/attribute'
+  #
   #   class X
   #     include Anise::Attribute
   #

data/lib/anise.rb

@@ -5,27 +5,29 @@ require 'anise/attribute'
 #
 # Dynamic Annotations system for Ruby.
 #
-#  class X
+#   require 'anise'
 #
-#    include Anise
+#   class X
 #
-#    # Provides annotations:
+#     include Anise
 #
-#    ann :foo, :class=>String
+#     # Provides annotations:
 #
-#    # Provides annotators:
+#     ann :foo, :class=>String
 #
-#    annotator :doc
-#    doc "Underdog is here!"
-#    def underdog
-#      UnderDog.new
-#    end
+#     # Provides annotators:
 #
-#    # Provides annotated attributes:
+#     annotator :doc
+#     doc "Underdog is here!"
+#     def underdog
+#       UnderDog.new
+#     end
 #
-#    attr :bar, Integer, :max => 10
+#     # Provides annotated attributes:
 #
-#  end
+#     attr :bar, Integer, :max => 10
+#
+#   end
 #
 module Anise
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: anise
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - tigerops-community@rubyforge.org
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-28 00:00:00 -04:00
+date: 2008-10-31 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,6 +40,7 @@ files:
 - lib
 - meta
 - test
+- MANIFEST
 - RELEASE
 - README
 - HISTORY
@@ -67,7 +68,6 @@ files:
 - test/test_anise.rb
 - test/test_anise_toplevel.rb
 - test/test_annotations_toplevel.rb
-- MANIFEST
 has_rdoc: true
 homepage: http://
 post_install_message: