spqr 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ README.rdoc
2
+ lib/**/*.rb
3
+ bin/*
4
+ features/**/*.feature
5
+ LICENSE
data/.gitignore ADDED
@@ -0,0 +1,21 @@
1
+ ## MAC OS
2
+ .DS_Store
3
+
4
+ ## TEXTMATE
5
+ *.tmproj
6
+ tmtags
7
+
8
+ ## EMACS
9
+ *~
10
+ \#*
11
+ .\#*
12
+
13
+ ## VIM
14
+ *.swp
15
+
16
+ ## PROJECT::GENERAL
17
+ coverage
18
+ rdoc
19
+ pkg
20
+
21
+ ## PROJECT::SPECIFIC
data/LICENSE ADDED
@@ -0,0 +1,202 @@
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.
data/README.rdoc ADDED
@@ -0,0 +1,28 @@
1
+ = spqr
2
+
3
+ SPQR is a tool to automatically generate QMF applications from Ruby
4
+ classes, and to automatically generate Ruby classes from QMF schema
5
+ descriptions. See the examples directory in the source distribution
6
+ for examples.
7
+
8
+ Rhubarb, which is included with SPQR, is a simple versioned
9
+ object-graph persistence layer that stores instances of specially-
10
+ declared Ruby classes in a SQLite3 database.
11
+
12
+ == Maintainer
13
+
14
+ Will Benton (willb@redhat.com)
15
+
16
+ == Patches and pull requests
17
+
18
+ * Please add tests for any new features you add.
19
+ * Send me a pull request; ideally, your functionality is on a topic branch forked from my master.
20
+
21
+ == Credits
22
+
23
+ * Thanks to William Henry for suggesting the "rhubarb" name
24
+ * Gem support by technicalpickles' jeweler
25
+
26
+ == Copyright
27
+
28
+ Copyright (c) 2009 Red Hat, Inc. See LICENSE for details.
data/Rakefile ADDED
@@ -0,0 +1,105 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ gem.name = "spqr"
8
+ gem.summary = %Q{SPQR: {Schema Processor|Straightforward Publishing} for QMF agents in Ruby}
9
+ gem.description = %Q{SPQR makes it very simple to expose methods on Ruby objects over QMF. You must install ruby-qmf in order to use SPQR.}
10
+ gem.email = "willb@redhat.com"
11
+ gem.homepage = "http://git.fedorahosted.org/git/grid/spqr.git"
12
+ gem.authors = ["William Benton"]
13
+ gem.add_development_dependency "rspec", ">= 1.2.9"
14
+ # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
15
+ end
16
+ Jeweler::GemcutterTasks.new
17
+ rescue LoadError
18
+ puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
19
+ end
20
+
21
+ desc "create an RPM spec file"
22
+ task :rpmspec => :release do
23
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
24
+ sh "gem2rpm -t spqr.spec.in -o spqr.spec pkg/spqr-#{version}.gem"
25
+ end
26
+
27
+ desc "create a source RPM"
28
+ task :srpm => :release do
29
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
30
+ sh "gem2rpm -t spqr.spec.in -s pkg/spqr-#{version}.gem"
31
+ end
32
+
33
+ require 'spec/rake/spectask'
34
+ Spec::Rake::SpecTask.new(:spec) do |spec|
35
+ spec.libs << 'lib' << 'spec'
36
+ spec.spec_files = FileList['spec/**/*_spec.rb']
37
+ end
38
+
39
+ Spec::Rake::SpecTask.new(:rcov) do |spec|
40
+ spec.libs << 'lib' << 'spec'
41
+ spec.pattern = 'spec/**/*_spec.rb'
42
+ spec.rcov = true
43
+ end
44
+
45
+ task :spec => :check_dependencies
46
+
47
+
48
+ require 'rake/testtask'
49
+ Rake::TestTask.new(:test) do |test|
50
+ test.libs << 'lib' << 'test'
51
+ test.pattern = 'test/**/test_*.rb'
52
+ test.verbose = true
53
+ end
54
+
55
+ begin
56
+ require 'rcov/rcovtask'
57
+ Rcov::RcovTask.new do |test|
58
+ test.libs << 'test'
59
+ test.pattern = 'test/**/test_*.rb'
60
+ test.verbose = true
61
+ end
62
+ rescue LoadError
63
+ task :rcov do
64
+ abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
65
+ end
66
+ end
67
+
68
+ task :test => :check_dependencies
69
+
70
+ begin
71
+ require 'reek/adapters/rake_task'
72
+ Reek::RakeTask.new do |t|
73
+ t.fail_on_error = true
74
+ t.verbose = false
75
+ t.source_files = 'lib/**/*.rb'
76
+ end
77
+ rescue LoadError
78
+ task :reek do
79
+ abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
80
+ end
81
+ end
82
+
83
+ begin
84
+ require 'roodi'
85
+ require 'roodi_task'
86
+ RoodiTask.new do |t|
87
+ t.verbose = false
88
+ end
89
+ rescue LoadError
90
+ task :roodi do
91
+ abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
92
+ end
93
+ end
94
+
95
+ task :default => :spec
96
+
97
+ require 'rake/rdoctask'
98
+ Rake::RDocTask.new do |rdoc|
99
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
100
+
101
+ rdoc.rdoc_dir = 'rdoc'
102
+ rdoc.title = "spqr #{version}"
103
+ rdoc.rdoc_files.include('README*')
104
+ rdoc.rdoc_files.include('lib/**/*.rb')
105
+ end
data/TODO ADDED
@@ -0,0 +1,33 @@
1
+ To do, overall:
2
+
3
+ * packaging
4
+
5
+
6
+ To do for spqr:
7
+
8
+ ! Event support
9
+ * Broader query support (partially done)
10
+ * Documentation
11
+ * Test suite
12
+ - Automatic generation of smoke tests for services (either from schema or manageable class)
13
+ - Automatic schema generation from agent apps
14
+ - Usability improvements:
15
+ - Fewer required annotations
16
+ - Eliminate requirement for kwargs-style methods
17
+ - Automatic decoration of certain methods
18
+
19
+
20
+
21
+ To do for rhubarb:
22
+
23
+ * Bring code coverage up to 100%
24
+ * Documentation
25
+ * Standalone examples (i.e. not just "please see the test suite")
26
+
27
+
28
+
29
+ Legend:
30
+
31
+ ! --> highest priority
32
+ * --> standard priority
33
+ - --> low priority
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.0.1
data/bin/spqr-gen.rb ADDED
@@ -0,0 +1,60 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ # SPQR: Schema Processor for QMF/Ruby agents
4
+ # spqr-gen generates a skeleton QMF agent application from a schema file.
5
+ #
6
+ # Copyright (c) 2009 Red Hat, Inc.
7
+ #
8
+ # Author: William Benton (willb@redhat.com)
9
+ #
10
+ # Licensed under the Apache License, Version 2.0 (the "License");
11
+ # you may not use this file except in compliance with the License.
12
+ # You may obtain a copy of the License at
13
+ #
14
+ # http://www.apache.org/licenses/LICENSE-2.0
15
+
16
+ $: << File.expand_path(File.dirname(__FILE__))
17
+
18
+ require 'spqr/spqr'
19
+
20
+ def main
21
+ $WRITEMODE
22
+ $OUTDIR = "."
23
+
24
+ op = OptionParser.new do |opts|
25
+ opts.banner = "Usage spqr.rb [options] schema-file"
26
+
27
+ opts.on("-n", "--noclobber", "don't overwrite pre-existing output files") do |noclob|
28
+ $PP_WRITEMODE = File::WRONLY|File::EXCL|File::CREAT
29
+ end
30
+
31
+ opts.on("-d", "--output-dir DIR", "directory in which to place generated app and controllers") do |dir|
32
+ $OUTDIR = dir
33
+ end
34
+ end
35
+
36
+ begin
37
+ op.parse!
38
+ rescue OptionParser::InvalidOption
39
+ puts op
40
+ exit
41
+ end
42
+
43
+
44
+ begin
45
+ SPQR::QmfSchemaProcessor.new(ARGV[0]).main
46
+ rescue SystemCallError => sce
47
+ if sce.errno == Errno::EEXIST::Errno
48
+ fn = sce.message.split(" ")[-1] # XXX: won't work for filenames with spaces
49
+ puts "Not overwriting #{fn}; don't use --noclobber if you don't want this behavior"
50
+ elsif sce.errno == Errno::ENOENT::Errno
51
+ fn = sce.message.split(" ")[-1] # XXX: won't work for filenames with spaces
52
+ puts "File or directory \"#{fn}\" not found"
53
+ puts sce.backtrace
54
+ else
55
+ puts "Failed due to #{sce.inspect}"
56
+ end
57
+ end
58
+ end
59
+
60
+ main