anise 0.4.0 → 0.5.0

data/.ruby

@@ -0,0 +1,41 @@
+--- 
+spec_version: 1.0.0
+replaces: []
+
+loadpath: 
+- lib
+name: anise
+repositories: {}
+
+conflicts: []
+
+engine_check: []
+
+title: Anise
+contact: trans <transfire@gmail.com>
+resources: 
+  code: http://github.com/rubyworks/anise
+  mail: http://groups.google.com/group/rubyworks-mailinglist
+  home: http://rubyworks.github.com/anise
+maintainers: []
+
+requires: 
+- group: 
+  - test
+  name: qed
+  version: 0+
+- group: 
+  - build
+  name: syckle
+  version: 0+
+manifest: MANIFEST
+version: 0.5.0
+licenses: 
+- Apache 2.0
+copyright: Copyright (c) 2008 Thomas Sawyer
+authors: 
+- Thomas Sawyer
+organization: Rubyworks
+description: Anise is an Annotation System for the Ruby programming language. Unlike most other annotations systems it is not a comment-based or macro-based system that sits over-and-above the rest of the code. Rather, Anise is a dynamic annotations system operating at runtime.
+summary: Dynamic Annotation System
+created: "2008-02-21"

data/APACHE2.txt

@@ -0,0 +1,204 @@
+.
+                             Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+

data/COPYING.rdoc

@@ -0,0 +1,17 @@
+= COPYRIGHT NOTICES
+
+== Anise
+
+Copyright (c) 2008,2011 Thomas Sawyer
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/HISTORY.rdoc

@@ -0,0 +1,37 @@
+= RELEASE HISTORY
+
+
+== 0.4.0 / 2009-05-28
+
+This version adds a callback method called #annotation_added
+--a striaght-forward callback method patterned after Ruby's 
+other built-in callback methods. The callback should be enough
+to allow for the creation of "active" annotations.
+
+Changes:
+
+* 1 Major Enhancement:
+
+    * Added annotation_added callback
+
+
+== 0.2.1 / 2008-10-31
+
+Changes:
+
+    * renamed some lib files
+
+
+== 0.2.0 / 2008-10-28
+
+Changes:
+
+    * Annotations is a module rather than a core extenstion to Module
+
+
+== 0.1.1 / 2008-10-17
+
+Changes:
+
+    * initial release
+

data/{README → README.rdoc}

@@ -1,18 +1,25 @@
 = Anise
 
-   http://anise.rubyforge.org
-
 == INTRODUCTION
 
-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.
+Anise is an Annotation System for the Ruby programming language.
+Unlike most other annotations systems it is not a comment-based or
+macro-based system that sits over-and-above the rest of the code.
+Rather, Anise is a dynamic annotations system operating at runtime.
+
 
 == RELEASE NOTES
 
 Please see the RELEASE file.
 
+
+== RESOURCES
+
+* home: http://rubyworks.github.com/anise
+* code: http://github.com/rubyworks/anise
+* mail: http://groups.google.com/group/rubyworks-mailinglist
+
+
 == INSTALLATION
 
 To install with RubyGems simply open a console and type:
@@ -26,6 +33,7 @@ Then download the tarball package and do:
    $ cd anise-0.2.0
    $ sudo setup.rb all
 
+
 == USAGE
 
 The following example briefly demonstrates all three major features.
@@ -40,6 +48,10 @@ The following example briefly demonstrates all three major features.
 
      ann :grape, :class=>String
 
+     # Annotated Attributes
+
+     attr :baz, Integer, :max => 10
+
      # Annotators
 
      annotator :doc
@@ -50,10 +62,6 @@ The following example briefly demonstrates all three major features.
        # ...
      end
 
-     # Annotated Attributes
-
-     attr :baz, Integer, :max => 10
-
    end
 
 Looking at the resulting annotations:
@@ -66,9 +74,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 is the recommended way to run Anise's test suite (http://codeforpeople.rubyforge.org/turn/).
 
   $ turn test/test_*
 
@@ -81,11 +90,18 @@ or with Ruby alone:
 
   $ ruby -Ilib -rtest/unit test/suite.rb
 
-== LICENSE
+Anise also includes QED tests. These can be run via:
+
+  $ qed -Ilib qed/
+
+See the {QED homepage}[http://rubyworks.github.com/qed] for more informaiton
+about QED.
 
-Copyright (c) 2008 TigerOps
 
-This program is distributed under the terms of the LGPL License.
+== LICENSE
+
+Copyright (c) 2008 Thomas Sawyer
 
-Please see COPYING file for details.
+This program is distributed under the terms of the Apache 2.0 license.
 
+Please see COPYING.rdoc file for details.

data/VERSION

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

data/lib/anise.rb

@@ -1,40 +1,62 @@
-require 'anise/annotator'
+require 'anise/annotation'
 require 'anise/attribute'
+require 'anise/annotator'
 
 # = Anise
 #
-# Dynamic Annotations system for Ruby.
+# Dynamic Annotations for Ruby.
 #
 #   require 'anise'
 #
 #   class X
-#
 #     include Anise
 #
-#     # Provides annotations:
-#
+#     # Provides annotations
 #     ann :foo, :class=>String
 #
-#     # Provides annotators:
+#     # Provides annotated attributes
+#     attr :bar, Integer, :max=>10
 #
+#     # Provides method annotators.
 #     annotator :doc
-#     doc "Underdog is here!"
-#     def underdog
-#       UnderDog.new
+#     doc "foo is cool"
+#     def foo
+#       # ...
 #     end
-#
-#     # Provides annotated attributes:
-#
-#     attr :bar, Integer, :max => 10
-#
 #   end
 #
 module Anise
+  extend self 
 
-  def self.append_features(base)
+  def append_features(base)
+    #super(base)
     Attribute.append_features(base)
     Annotator.append_features(base)
+    base.extend Anise #ClassMethods
+  end
+
+  #module ClassMethods
+  #  def append_features(base)
+  #    super(base)
+  #    Attribute.append_features(base)
+  #    Annotator.append_features(base)
+  #    base.extend ClassMethods
+  #  end
+  #end
+
+  #
+  def self.metadata
+    @metadata ||= (
+      require 'yaml'
+      YAML.load(File.new(File.dirname(__FILE__) + '/anise.yml'))
+    )
+  end
+
+  #
+  def self.const_missing(name)
+    metadata[name.to_s.downcase] || super(name)
   end
 
+  VERSION = metadata['version']  # becuase Ruby 1.8~ gets in the way :(
 end