anise 0.6.0 → 0.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (53) hide show
  1. data/.ruby +59 -38
  2. data/.yardopts +7 -0
  3. data/DEMO.md +242 -0
  4. data/{HISTORY.rdoc → HISTORY.md} +28 -7
  5. data/LICENSE.txt +27 -0
  6. data/README.md +129 -0
  7. data/demo/01_annotations.md +81 -0
  8. data/demo/03_attributes.md +14 -0
  9. data/demo/04_methods.md +50 -0
  10. data/demo/05_variables.md +45 -0
  11. data/{qed → demo}/applique/ae.rb +0 -0
  12. data/demo/applique/anise.rb +1 -0
  13. data/{qed/toplevel/01_annotations.qed → demo/toplevel/01_annotations.md} +5 -9
  14. data/demo/toplevel/03_attributes.md +20 -0
  15. data/lib/anise.rb +28 -45
  16. data/lib/anise.yml +59 -38
  17. data/lib/anise/annotations.rb +132 -0
  18. data/lib/anise/annotations/store.rb +136 -0
  19. data/lib/anise/annotative.rb +7 -0
  20. data/lib/anise/annotative/attributes.rb +147 -0
  21. data/lib/anise/annotative/methods.rb +131 -0
  22. data/lib/anise/annotative/variables.rb +99 -0
  23. data/lib/anise/{module.rb → core_ext.rb} +30 -0
  24. data/lib/anise/universal.rb +6 -0
  25. data/lib/anise/version.rb +17 -0
  26. data/test/case_annotations.rb +173 -0
  27. data/test/case_attributes.rb +46 -0
  28. data/test/case_combined_usage.rb +341 -0
  29. data/test/case_methods.rb +36 -0
  30. data/test/case_variables.rb +22 -0
  31. data/test/helper.rb +2 -0
  32. metadata +99 -98
  33. data/APACHE2.txt +0 -204
  34. data/COPYING.rdoc +0 -17
  35. data/README.rdoc +0 -107
  36. data/lib/anise/annotation.rb +0 -175
  37. data/lib/anise/annotator.rb +0 -82
  38. data/lib/anise/attribute.rb +0 -138
  39. data/qed/01_annotations.qed +0 -26
  40. data/qed/02_annotation_added.rdoc +0 -60
  41. data/qed/03_attributes.rdoc +0 -16
  42. data/qed/04_annotator.rdoc +0 -49
  43. data/qed/toplevel/03_attributes.rdoc +0 -20
  44. data/test/suite.rb +0 -8
  45. data/test/test_anise.rb +0 -193
  46. data/test/test_anise_toplevel.rb +0 -194
  47. data/test/test_annotations.rb +0 -136
  48. data/test/test_annotations_module.rb +0 -132
  49. data/test/test_annotations_toplevel.rb +0 -131
  50. data/test/test_annotator.rb +0 -26
  51. data/test/test_annotator_toplevel.rb +0 -28
  52. data/test/test_attribute.rb +0 -37
  53. data/test/test_attribute_toplevel.rb +0 -65
metadata CHANGED
@@ -1,124 +1,125 @@
1
- --- !ruby/object:Gem::Specification
1
+ --- !ruby/object:Gem::Specification
2
2
  name: anise
3
- version: !ruby/object:Gem::Version
4
- hash: 7
5
- prerelease: false
6
- segments:
7
- - 0
8
- - 6
9
- - 0
10
- version: 0.6.0
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.7.0
5
+ prerelease:
11
6
  platform: ruby
12
- authors:
13
- - Thomas Sawyer
7
+ authors:
8
+ - trans
14
9
  autorequire:
15
10
  bindir: bin
16
11
  cert_chain: []
17
-
18
- date: 2011-05-16 00:00:00 -04:00
19
- default_executable:
20
- dependencies:
21
- - !ruby/object:Gem::Dependency
12
+ date: 2012-05-01 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
22
15
  name: qed
16
+ requirement: &23336160 !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ! '>='
20
+ - !ruby/object:Gem::Version
21
+ version: '0'
22
+ type: :development
23
23
  prerelease: false
24
- requirement: &id001 !ruby/object:Gem::Requirement
24
+ version_requirements: *23336160
25
+ - !ruby/object:Gem::Dependency
26
+ name: ae
27
+ requirement: &23332340 !ruby/object:Gem::Requirement
25
28
  none: false
26
- requirements:
27
- - - ">="
28
- - !ruby/object:Gem::Version
29
- hash: 3
30
- segments:
31
- - 0
32
- version: "0"
29
+ requirements:
30
+ - - ! '>='
31
+ - !ruby/object:Gem::Version
32
+ version: '0'
33
33
  type: :development
34
- version_requirements: *id001
35
- - !ruby/object:Gem::Dependency
36
- name: redline
37
34
  prerelease: false
38
- requirement: &id002 !ruby/object:Gem::Requirement
35
+ version_requirements: *23332340
36
+ - !ruby/object:Gem::Dependency
37
+ name: citron
38
+ requirement: &23316360 !ruby/object:Gem::Requirement
39
39
  none: false
40
- requirements:
41
- - - ">="
42
- - !ruby/object:Gem::Version
43
- hash: 3
44
- segments:
45
- - 0
46
- version: "0"
40
+ requirements:
41
+ - - ! '>='
42
+ - !ruby/object:Gem::Version
43
+ version: '0'
47
44
  type: :development
48
- version_requirements: *id002
49
- 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.
50
- email: transfire@gmail.com
45
+ prerelease: false
46
+ version_requirements: *23316360
47
+ - !ruby/object:Gem::Dependency
48
+ name: detroit
49
+ requirement: &23300140 !ruby/object:Gem::Requirement
50
+ none: false
51
+ requirements:
52
+ - - ! '>='
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ type: :development
56
+ prerelease: false
57
+ version_requirements: *23300140
58
+ description: Anise is an annotations systems for the Ruby programming lanaguage.
59
+ email:
60
+ - transfire@gmail.com
51
61
  executables: []
52
-
53
62
  extensions: []
54
-
55
- extra_rdoc_files:
56
- - README.rdoc
57
- files:
63
+ extra_rdoc_files:
64
+ - LICENSE.txt
65
+ - HISTORY.md
66
+ - README.md
67
+ - DEMO.md
68
+ files:
58
69
  - .ruby
59
- - lib/anise/annotation.rb
60
- - lib/anise/annotator.rb
61
- - lib/anise/attribute.rb
62
- - lib/anise/module.rb
70
+ - .yardopts
71
+ - demo/01_annotations.md
72
+ - demo/03_attributes.md
73
+ - demo/04_methods.md
74
+ - demo/05_variables.md
75
+ - demo/applique/ae.rb
76
+ - demo/applique/anise.rb
77
+ - demo/toplevel/01_annotations.md
78
+ - demo/toplevel/03_attributes.md
79
+ - lib/anise/annotations/store.rb
80
+ - lib/anise/annotations.rb
81
+ - lib/anise/annotative/attributes.rb
82
+ - lib/anise/annotative/methods.rb
83
+ - lib/anise/annotative/variables.rb
84
+ - lib/anise/annotative.rb
85
+ - lib/anise/core_ext.rb
86
+ - lib/anise/universal.rb
87
+ - lib/anise/version.rb
63
88
  - lib/anise.rb
64
89
  - lib/anise.yml
65
- - qed/01_annotations.qed
66
- - qed/02_annotation_added.rdoc
67
- - qed/03_attributes.rdoc
68
- - qed/04_annotator.rdoc
69
- - qed/applique/ae.rb
70
- - qed/toplevel/01_annotations.qed
71
- - qed/toplevel/03_attributes.rdoc
72
- - test/suite.rb
73
- - test/test_anise.rb
74
- - test/test_anise_toplevel.rb
75
- - test/test_annotations.rb
76
- - test/test_annotations_module.rb
77
- - test/test_annotations_toplevel.rb
78
- - test/test_annotator.rb
79
- - test/test_annotator_toplevel.rb
80
- - test/test_attribute.rb
81
- - test/test_attribute_toplevel.rb
82
- - HISTORY.rdoc
83
- - README.rdoc
84
- - COPYING.rdoc
85
- - APACHE2.txt
86
- has_rdoc: true
87
- homepage: http://rubyworks.github.com/anise
88
- licenses:
89
- - Apache 2.0
90
+ - test/case_annotations.rb
91
+ - test/case_attributes.rb
92
+ - test/case_combined_usage.rb
93
+ - test/case_methods.rb
94
+ - test/case_variables.rb
95
+ - test/helper.rb
96
+ - HISTORY.md
97
+ - README.md
98
+ - DEMO.md
99
+ - LICENSE.txt
100
+ homepage: http://rubyworks.githuib.com/anise
101
+ licenses:
102
+ - BSD-2-Clause
90
103
  post_install_message:
91
- rdoc_options:
92
- - --title
93
- - Anise API
94
- - --main
95
- - README.rdoc
96
- require_paths:
104
+ rdoc_options: []
105
+ require_paths:
97
106
  - lib
98
- required_ruby_version: !ruby/object:Gem::Requirement
107
+ required_ruby_version: !ruby/object:Gem::Requirement
99
108
  none: false
100
- requirements:
101
- - - ">="
102
- - !ruby/object:Gem::Version
103
- hash: 3
104
- segments:
105
- - 0
106
- version: "0"
107
- required_rubygems_version: !ruby/object:Gem::Requirement
109
+ requirements:
110
+ - - ! '>='
111
+ - !ruby/object:Gem::Version
112
+ version: '0'
113
+ required_rubygems_version: !ruby/object:Gem::Requirement
108
114
  none: false
109
- requirements:
110
- - - ">="
111
- - !ruby/object:Gem::Version
112
- hash: 3
113
- segments:
114
- - 0
115
- version: "0"
115
+ requirements:
116
+ - - ! '>='
117
+ - !ruby/object:Gem::Version
118
+ version: '0'
116
119
  requirements: []
117
-
118
- rubyforge_project: anise
119
- rubygems_version: 1.3.7
120
+ rubyforge_project:
121
+ rubygems_version: 1.8.11
120
122
  signing_key:
121
123
  specification_version: 3
122
124
  summary: Dynamic Annotation System
123
125
  test_files: []
124
-
@@ -1,204 +0,0 @@
1
- .
2
- Apache License
3
- Version 2.0, January 2004
4
- http://www.apache.org/licenses/
5
-
6
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
-
8
- 1. Definitions.
9
-
10
- "License" shall mean the terms and conditions for use, reproduction,
11
- and distribution as defined by Sections 1 through 9 of this document.
12
-
13
- "Licensor" shall mean the copyright owner or entity authorized by
14
- the copyright owner that is granting the License.
15
-
16
- "Legal Entity" shall mean the union of the acting entity and all
17
- other entities that control, are controlled by, or are under common
18
- control with that entity. For the purposes of this definition,
19
- "control" means (i) the power, direct or indirect, to cause the
20
- direction or management of such entity, whether by contract or
21
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
- outstanding shares, or (iii) beneficial ownership of such entity.
23
-
24
- "You" (or "Your") shall mean an individual or Legal Entity
25
- exercising permissions granted by this License.
26
-
27
- "Source" form shall mean the preferred form for making modifications,
28
- including but not limited to software source code, documentation
29
- source, and configuration files.
30
-
31
- "Object" form shall mean any form resulting from mechanical
32
- transformation or translation of a Source form, including but
33
- not limited to compiled object code, generated documentation,
34
- and conversions to other media types.
35
-
36
- "Work" shall mean the work of authorship, whether in Source or
37
- Object form, made available under the License, as indicated by a
38
- copyright notice that is included in or attached to the work
39
- (an example is provided in the Appendix below).
40
-
41
- "Derivative Works" shall mean any work, whether in Source or Object
42
- form, that is based on (or derived from) the Work and for which the
43
- editorial revisions, annotations, elaborations, or other modifications
44
- represent, as a whole, an original work of authorship. For the purposes
45
- of this License, Derivative Works shall not include works that remain
46
- separable from, or merely link (or bind by name) to the interfaces of,
47
- the Work and Derivative Works thereof.
48
-
49
- "Contribution" shall mean any work of authorship, including
50
- the original version of the Work and any modifications or additions
51
- to that Work or Derivative Works thereof, that is intentionally
52
- submitted to Licensor for inclusion in the Work by the copyright owner
53
- or by an individual or Legal Entity authorized to submit on behalf of
54
- the copyright owner. For the purposes of this definition, "submitted"
55
- means any form of electronic, verbal, or written communication sent
56
- to the Licensor or its representatives, including but not limited to
57
- communication on electronic mailing lists, source code control systems,
58
- and issue tracking systems that are managed by, or on behalf of, the
59
- Licensor for the purpose of discussing and improving the Work, but
60
- excluding communication that is conspicuously marked or otherwise
61
- designated in writing by the copyright owner as "Not a Contribution."
62
-
63
- "Contributor" shall mean Licensor and any individual or Legal Entity
64
- on behalf of whom a Contribution has been received by Licensor and
65
- subsequently incorporated within the Work.
66
-
67
- 2. Grant of Copyright License. Subject to the terms and conditions of
68
- this License, each Contributor hereby grants to You a perpetual,
69
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
- copyright license to reproduce, prepare Derivative Works of,
71
- publicly display, publicly perform, sublicense, and distribute the
72
- Work and such Derivative Works in Source or Object form.
73
-
74
- 3. Grant of Patent License. Subject to the terms and conditions of
75
- this License, each Contributor hereby grants to You a perpetual,
76
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
- (except as stated in this section) patent license to make, have made,
78
- use, offer to sell, sell, import, and otherwise transfer the Work,
79
- where such license applies only to those patent claims licensable
80
- by such Contributor that are necessarily infringed by their
81
- Contribution(s) alone or by combination of their Contribution(s)
82
- with the Work to which such Contribution(s) was submitted. If You
83
- institute patent litigation against any entity (including a
84
- cross-claim or counterclaim in a lawsuit) alleging that the Work
85
- or a Contribution incorporated within the Work constitutes direct
86
- or contributory patent infringement, then any patent licenses
87
- granted to You under this License for that Work shall terminate
88
- as of the date such litigation is filed.
89
-
90
- 4. Redistribution. You may reproduce and distribute copies of the
91
- Work or Derivative Works thereof in any medium, with or without
92
- modifications, and in Source or Object form, provided that You
93
- meet the following conditions:
94
-
95
- (a) You must give any other recipients of the Work or
96
- Derivative Works a copy of this License; and
97
-
98
- (b) You must cause any modified files to carry prominent notices
99
- stating that You changed the files; and
100
-
101
- (c) You must retain, in the Source form of any Derivative Works
102
- that You distribute, all copyright, patent, trademark, and
103
- attribution notices from the Source form of the Work,
104
- excluding those notices that do not pertain to any part of
105
- the Derivative Works; and
106
-
107
- (d) If the Work includes a "NOTICE" text file as part of its
108
- distribution, then any Derivative Works that You distribute must
109
- include a readable copy of the attribution notices contained
110
- within such NOTICE file, excluding those notices that do not
111
- pertain to any part of the Derivative Works, in at least one
112
- of the following places: within a NOTICE text file distributed
113
- as part of the Derivative Works; within the Source form or
114
- documentation, if provided along with the Derivative Works; or,
115
- within a display generated by the Derivative Works, if and
116
- wherever such third-party notices normally appear. The contents
117
- of the NOTICE file are for informational purposes only and
118
- do not modify the License. You may add Your own attribution
119
- notices within Derivative Works that You distribute, alongside
120
- or as an addendum to the NOTICE text from the Work, provided
121
- that such additional attribution notices cannot be construed
122
- as modifying the License.
123
-
124
- You may add Your own copyright statement to Your modifications and
125
- may provide additional or different license terms and conditions
126
- for use, reproduction, or distribution of Your modifications, or
127
- for any such Derivative Works as a whole, provided Your use,
128
- reproduction, and distribution of the Work otherwise complies with
129
- the conditions stated in this License.
130
-
131
- 5. Submission of Contributions. Unless You explicitly state otherwise,
132
- any Contribution intentionally submitted for inclusion in the Work
133
- by You to the Licensor shall be under the terms and conditions of
134
- this License, without any additional terms or conditions.
135
- Notwithstanding the above, nothing herein shall supersede or modify
136
- the terms of any separate license agreement you may have executed
137
- with Licensor regarding such Contributions.
138
-
139
- 6. Trademarks. This License does not grant permission to use the trade
140
- names, trademarks, service marks, or product names of the Licensor,
141
- except as required for reasonable and customary use in describing the
142
- origin of the Work and reproducing the content of the NOTICE file.
143
-
144
- 7. Disclaimer of Warranty. Unless required by applicable law or
145
- agreed to in writing, Licensor provides the Work (and each
146
- Contributor provides its Contributions) on an "AS IS" BASIS,
147
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
- implied, including, without limitation, any warranties or conditions
149
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
- PARTICULAR PURPOSE. You are solely responsible for determining the
151
- appropriateness of using or redistributing the Work and assume any
152
- risks associated with Your exercise of permissions under this License.
153
-
154
- 8. Limitation of Liability. In no event and under no legal theory,
155
- whether in tort (including negligence), contract, or otherwise,
156
- unless required by applicable law (such as deliberate and grossly
157
- negligent acts) or agreed to in writing, shall any Contributor be
158
- liable to You for damages, including any direct, indirect, special,
159
- incidental, or consequential damages of any character arising as a
160
- result of this License or out of the use or inability to use the
161
- Work (including but not limited to damages for loss of goodwill,
162
- work stoppage, computer failure or malfunction, or any and all
163
- other commercial damages or losses), even if such Contributor
164
- has been advised of the possibility of such damages.
165
-
166
- 9. Accepting Warranty or Additional Liability. While redistributing
167
- the Work or Derivative Works thereof, You may choose to offer,
168
- and charge a fee for, acceptance of support, warranty, indemnity,
169
- or other liability obligations and/or rights consistent with this
170
- License. However, in accepting such obligations, You may act only
171
- on Your own behalf and on Your sole responsibility, not on behalf
172
- of any other Contributor, and only if You agree to indemnify,
173
- defend, and hold each Contributor harmless for any liability
174
- incurred by, or claims asserted against, such Contributor by reason
175
- of your accepting any such warranty or additional liability.
176
-
177
- END OF TERMS AND CONDITIONS
178
-
179
- APPENDIX: How to apply the Apache License to your work.
180
-
181
- To apply the Apache License to your work, attach the following
182
- boilerplate notice, with the fields enclosed by brackets "[]"
183
- replaced with your own identifying information. (Don't include
184
- the brackets!) The text should be enclosed in the appropriate
185
- comment syntax for the file format. We also recommend that a
186
- file or class name and description of purpose be included on the
187
- same "printed page" as the copyright notice for easier
188
- identification within third-party archives.
189
-
190
- Copyright [yyyy] [name of copyright owner]
191
-
192
- Licensed under the Apache License, Version 2.0 (the "License");
193
- you may not use this file except in compliance with the License.
194
- You may obtain a copy of the License at
195
-
196
- http://www.apache.org/licenses/LICENSE-2.0
197
-
198
- Unless required by applicable law or agreed to in writing, software
199
- distributed under the License is distributed on an "AS IS" BASIS,
200
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
- See the License for the specific language governing permissions and
202
- limitations under the License.
203
-
204
-
@@ -1,17 +0,0 @@
1
- = COPYRIGHT NOTICES
2
-
3
- == Anise
4
-
5
- Copyright (c) 2008,2011 Thomas Sawyer
6
-
7
- Licensed under the Apache License, Version 2.0 (the "License");
8
- you may not use this file except in compliance with the License.
9
- You may obtain a copy of the License at
10
-
11
- http://www.apache.org/licenses/LICENSE-2.0
12
-
13
- Unless required by applicable law or agreed to in writing, software
14
- distributed under the License is distributed on an "AS IS" BASIS,
15
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
- See the License for the specific language governing permissions and
17
- limitations under the License.
@@ -1,107 +0,0 @@
1
- = Anise
2
-
3
- == INTRODUCTION
4
-
5
- Anise is an Annotation System for the Ruby programming language.
6
- Unlike most other annotations systems it is not a comment-based or
7
- macro-based system that sits over-and-above the rest of the code.
8
- Rather, Anise is a dynamic annotations system operating at runtime.
9
-
10
-
11
- == RELEASE NOTES
12
-
13
- Please see the RELEASE file.
14
-
15
-
16
- == RESOURCES
17
-
18
- * home: http://rubyworks.github.com/anise
19
- * code: http://github.com/rubyworks/anise
20
- * mail: http://groups.google.com/group/rubyworks-mailinglist
21
-
22
-
23
- == INSTALLATION
24
-
25
- To install with RubyGems simply open a console and type:
26
-
27
- gem install anise
28
-
29
- To manually install you will need Setup.rb (see http://setup.rubyforge.org).
30
- Then download the tarball package and do:
31
-
32
- $ tar -xvzf anise-0.2.0.tgz
33
- $ cd anise-0.2.0
34
- $ sudo setup.rb all
35
-
36
-
37
- == USAGE
38
-
39
- The following example briefly demonstrates all three major features.
40
-
41
- require 'anise'
42
-
43
- class X
44
-
45
- include Anise
46
-
47
- # Annotations
48
-
49
- ann :grape, :class=>String
50
-
51
- # Annotated Attributes
52
-
53
- attr :baz, Integer, :max => 10
54
-
55
- # Annotators
56
-
57
- annotator :doc
58
-
59
- doc "This is an entry."
60
-
61
- def bar
62
- # ...
63
- end
64
-
65
- end
66
-
67
- Looking at the resulting annotations:
68
-
69
- X.ann(:foo) #=> {:class=>String}
70
- X.ann(:bar) #=> {:doc=>"This is an entry."}
71
- X.ann(:baz) #=> {:class=>Integer, :max=>10}
72
-
73
- The Anise library can be used as a whole, per the example above, or these
74
- features can be used separately. For more details see the RDoc API
75
- documentation.
76
-
77
-
78
- == TESTING
79
-
80
- Turn is the recommended way to run Anise's test suite (http://codeforpeople.rubyforge.org/turn/).
81
-
82
- $ turn test/test_*
83
-
84
- But a script +test/suite.rb+ script is include so you can easily run
85
- the unit tests with the testrb command:
86
-
87
- $ testrb -Ilib test/suite.rb
88
-
89
- or with Ruby alone:
90
-
91
- $ ruby -Ilib -rtest/unit test/suite.rb
92
-
93
- Anise also includes QED tests. These can be run via:
94
-
95
- $ qed -Ilib qed/
96
-
97
- See the {QED homepage}[http://rubyworks.github.com/qed] for more informaiton
98
- about QED.
99
-
100
-
101
- == LICENSE
102
-
103
- Copyright (c) 2008 Thomas Sawyer
104
-
105
- This program is distributed under the terms of the Apache 2.0 license.
106
-
107
- Please see COPYING.rdoc file for details.