blerg 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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.
@@ -0,0 +1,59 @@
1
+ # Blerg
2
+
3
+ Blerg is designed to take the headache out of boilerplate code.
4
+ Just write up an ERB template for the boilerplate and pass variables into it on the command line.
5
+
6
+ ## Using
7
+
8
+ Blerg can be used directly from from the command line, or can be invoked by your own ruby scripts.
9
+ The first step is to install the gem:
10
+
11
+ gem install blerg
12
+
13
+ ### Command line
14
+
15
+ Create an ERB template file for the boilerplate you'd like to generate, like the following:
16
+
17
+ class <%= @foo %> {
18
+ public int id;
19
+ public String name;
20
+
21
+ public <% @foo %>(int id, String name) {
22
+ this.id = id;
23
+ this.name = name;
24
+ }
25
+ }
26
+
27
+ Now run the blerg against your template, specifying the value you'd like to use for @foo (where mytemplate.erb is the file you created above)
28
+
29
+ blerg mytemplate.erb foo Bar
30
+
31
+ Blerg will execute the template with the substitutions made, and you would get the following
32
+
33
+ class Bar {
34
+ public int id;
35
+ public String name;
36
+
37
+ public Bar(int id, String name) {
38
+ this.id = id;
39
+ this.name = name;
40
+ }
41
+ }
42
+
43
+ ### In your ruby script
44
+
45
+ You can also invoke Blerg in your own ruby scripts, as in the following examples:
46
+
47
+ require 'rubygems'
48
+ require 'blerg'
49
+
50
+ generator = Blerg::Generator.new(:name => "Pat")
51
+ outputs = generator.generate(["Hello, my name is <%= @name %>"])
52
+
53
+ Calling Blerg in this way provides a bit more flexibility. You can invoke multiple templates using the same set of variables, and your templates don't need to be defined in a file.
54
+
55
+ ## Advanced Usage
56
+
57
+ Blerg depends on ActiveSupport, so you can use inflection methods like camelcase and underscore to handle common differences between naming conventions in DBs and those in programming languages, eg <%= @foo.underscore %>. For a list of all these methods, see: http://as.rubyonrails.org/classes/ActiveSupport/CoreExtensions/String/Inflections.html
58
+
59
+ In ERB you can define variables, or even methods to make your templates as sophisticated as you'd like. You can read more about ERB here: http://www.ruby-doc.org/stdlib-1.9.3/libdoc/erb/rdoc/ERB.html
@@ -0,0 +1,9 @@
1
+ #!/usr/bin/env ruby
2
+ # The command line blerg generator
3
+
4
+ $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
5
+ require 'blerg'
6
+
7
+ template = IO.read(ARGV.shift) #ARGF.read
8
+ generator = Blerg::Generator.new Hash[*ARGV]
9
+ puts(generator.generate([template])[0]) #IO.read(template)
@@ -0,0 +1,8 @@
1
+ dir = File.dirname(__FILE__)
2
+ $LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
3
+
4
+ require 'rubygems'
5
+ require 'erb'
6
+ require 'active_support'
7
+ require 'active_support/core_ext'
8
+ require 'blerg/generator'
@@ -0,0 +1,7 @@
1
+ require 'erb'
2
+
3
+ x = 42
4
+ template = ERB.new <<-EOF
5
+ The value of x is: <%= x %>
6
+ EOF
7
+ puts template.result(binding)
@@ -0,0 +1,18 @@
1
+ module Blerg
2
+ class Generator
3
+ def initialize(vars)
4
+ @vars = vars
5
+ end
6
+
7
+ def generate(templates)
8
+ templates.map do |template_text|
9
+ @vars.each do |var_name, var_value|
10
+ instance_variable_set "@#{var_name}", var_value
11
+ end
12
+
13
+ template = ERB.new template_text
14
+ template.result(binding)
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,21 @@
1
+ module Blerg
2
+ class Generator
3
+ def initialize(vars)
4
+ @vars = vars
5
+ end
6
+
7
+ def generate(template_text)
8
+ @vars.each do |var_name, var_value|
9
+ instance_variable_set "@#{var_name}", var_value
10
+ end
11
+
12
+ template = ERB.new template_text
13
+
14
+ template.result(binding)
15
+ end
16
+ end
17
+ end
18
+
19
+ puts "A"
20
+ puts "B: #{Blerg::Generator}"
21
+ puts "C"
@@ -0,0 +1,17 @@
1
+ module Blerg
2
+ class Generator
3
+ def initialize(vars)
4
+ @vars = vars
5
+ end
6
+
7
+ def generate(template_text)
8
+ @vars.each do |var_name, var_value|
9
+ instance_variable_set "@#{var_name}", var_value
10
+ end
11
+
12
+ template = ERB.new template_text
13
+
14
+ template.result(binding)
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,16 @@
1
+ require 'lib/blerg'
2
+
3
+ describe Blerg::Generator do
4
+ subject { Blerg::Generator.new(@arguments) }
5
+
6
+ it "executes a template using arguments" do
7
+ @arguments = {:a => "Pat", :b => "awesome"}
8
+ subject.generate("clearly <%= @a %> is <%= @b %>")[0].should == "clearly Pat is awesome"
9
+ end
10
+
11
+ it "can process multiple templates with the same arguments" do
12
+ @arguments = {:entity => "Wrench"}
13
+ templates = ["<%= @entity %>Presenter", "<%= @entity %>Handler"]
14
+ outputs = subject.generate(templates).should == ["WrenchPresenter", "WrenchHandler"]
15
+ end
16
+ end
@@ -0,0 +1,5 @@
1
+ require 'lib/generator'
2
+
3
+ describe Blerg::Generator do
4
+ it "executes template using arguments"
5
+ end
metadata ADDED
@@ -0,0 +1,116 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: blerg
3
+ version: !ruby/object:Gem::Version
4
+ hash: 23
5
+ prerelease:
6
+ segments:
7
+ - 1
8
+ - 0
9
+ - 0
10
+ version: 1.0.0
11
+ platform: ruby
12
+ authors:
13
+ - Pat Gannon
14
+ autorequire:
15
+ bindir: bin
16
+ cert_chain: []
17
+
18
+ date: 2011-12-17 00:00:00 Z
19
+ dependencies:
20
+ - !ruby/object:Gem::Dependency
21
+ name: activesupport
22
+ prerelease: false
23
+ requirement: &id001 !ruby/object:Gem::Requirement
24
+ none: false
25
+ requirements:
26
+ - - ">="
27
+ - !ruby/object:Gem::Version
28
+ hash: 3
29
+ segments:
30
+ - 0
31
+ version: "0"
32
+ type: :runtime
33
+ version_requirements: *id001
34
+ - !ruby/object:Gem::Dependency
35
+ name: i18n
36
+ prerelease: false
37
+ requirement: &id002 !ruby/object:Gem::Requirement
38
+ none: false
39
+ requirements:
40
+ - - ">="
41
+ - !ruby/object:Gem::Version
42
+ hash: 3
43
+ segments:
44
+ - 0
45
+ version: "0"
46
+ type: :runtime
47
+ version_requirements: *id002
48
+ - !ruby/object:Gem::Dependency
49
+ name: rspec
50
+ prerelease: false
51
+ requirement: &id003 !ruby/object:Gem::Requirement
52
+ none: false
53
+ requirements:
54
+ - - ">="
55
+ - !ruby/object:Gem::Version
56
+ hash: 3
57
+ segments:
58
+ - 0
59
+ version: "0"
60
+ type: :development
61
+ version_requirements: *id003
62
+ description: " Blerg is designed to take the headache out of boilerplate code.\n Just write up an eRB template for the boilerplate and pass variables into it on the command line.\n"
63
+ email: gannon@bizo.com
64
+ executables:
65
+ - blerg
66
+ extensions: []
67
+
68
+ extra_rdoc_files: []
69
+
70
+ files:
71
+ - lib/blerg/generator.rb
72
+ - lib/blerg/generator.rb~
73
+ - lib/blerg.rb
74
+ - lib/blerg.rb~
75
+ - lib/generator.rb~
76
+ - README.md
77
+ - LICENSE.txt
78
+ - spec/generator_spec.rb
79
+ - spec/generator_spec.rb~
80
+ - bin/blerg
81
+ homepage:
82
+ licenses: []
83
+
84
+ post_install_message:
85
+ rdoc_options: []
86
+
87
+ require_paths:
88
+ - lib
89
+ required_ruby_version: !ruby/object:Gem::Requirement
90
+ none: false
91
+ requirements:
92
+ - - ">="
93
+ - !ruby/object:Gem::Version
94
+ hash: 3
95
+ segments:
96
+ - 0
97
+ version: "0"
98
+ required_rubygems_version: !ruby/object:Gem::Requirement
99
+ none: false
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ hash: 3
104
+ segments:
105
+ - 0
106
+ version: "0"
107
+ requirements: []
108
+
109
+ rubyforge_project:
110
+ rubygems_version: 1.8.6
111
+ signing_key:
112
+ specification_version: 3
113
+ summary: Simple code generation using eRB
114
+ test_files:
115
+ - spec/generator_spec.rb
116
+ - spec/generator_spec.rb~