lapidary 0.2.0 → 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (7) hide show
  1. data/README.md +7 -1
  2. data/VERSION +1 -1
  3. data/lapidary.gemspec +4 -7
  4. data/lib/lapidary.rb +12 -0
  5. data/lib/lapidary/command/build.rb +6 -0
  6. data/lib/lapidary/templates/lib/project.rb.erb +8 -0
  7. metadata +136 -140
data/README.md CHANGED
@@ -27,7 +27,7 @@ You can install lapidary by gem.
27
27
  ## Usage
28
28
 
29
29
  ### scaffold new RubyGem project
30
- $ lapidary hello-gem
30
+ $ lapidary mygem
31
31
 
32
32
  ### run rspec
33
33
  $ rake spec
@@ -54,6 +54,12 @@ This task also measure the code coverage in Ruby 1.9.2/1.9.3.
54
54
  ### build gem
55
55
  $ rake build
56
56
 
57
+ ### create document using YARD
58
+ $ rake yard
59
+
60
+ ### create document using RDoc
61
+ $ rake rdoc
62
+
57
63
  ### release gem to RubyGems.org
58
64
  $ rake release
59
65
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.2.0
1
+ 0.2.1
data/lapidary.gemspec CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  Gem::Specification.new do |s|
7
7
  s.name = "lapidary"
8
- s.version = "0.2.0"
8
+ s.version = "0.2.1"
9
9
 
10
10
  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
11
  s.authors = ["Kenji Hara"]
@@ -60,8 +60,7 @@ Gem::Specification.new do |s|
60
60
  s.add_runtime_dependency(%q<rdoc>, ["~> 3.12"])
61
61
  s.add_runtime_dependency(%q<bundler>, ["~> 1.2.3"])
62
62
  s.add_runtime_dependency(%q<jeweler>, ["~> 1.8.4"])
63
- s.add_runtime_dependency(%q<simplecov>, ["~> 0.7.1"])
64
- s.add_runtime_dependency(%q<simplecov-rcov>, ["~> 0.2.3"])
63
+ s.add_runtime_dependency(%q<rcov>, ["~> 1.0.0"])
65
64
  s.add_runtime_dependency(%q<ci_reporter>, ["~> 1.8.3"])
66
65
  s.add_runtime_dependency(%q<flog>, ["~> 3.2.1"])
67
66
  else
@@ -71,8 +70,7 @@ Gem::Specification.new do |s|
71
70
  s.add_dependency(%q<rdoc>, ["~> 3.12"])
72
71
  s.add_dependency(%q<bundler>, ["~> 1.2.3"])
73
72
  s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
74
- s.add_dependency(%q<simplecov>, ["~> 0.7.1"])
75
- s.add_dependency(%q<simplecov-rcov>, ["~> 0.2.3"])
73
+ s.add_dependency(%q<rcov>, ["~> 1.0.0"])
76
74
  s.add_dependency(%q<ci_reporter>, ["~> 1.8.3"])
77
75
  s.add_dependency(%q<flog>, ["~> 3.2.1"])
78
76
  end
@@ -83,8 +81,7 @@ Gem::Specification.new do |s|
83
81
  s.add_dependency(%q<rdoc>, ["~> 3.12"])
84
82
  s.add_dependency(%q<bundler>, ["~> 1.2.3"])
85
83
  s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
86
- s.add_dependency(%q<simplecov>, ["~> 0.7.1"])
87
- s.add_dependency(%q<simplecov-rcov>, ["~> 0.2.3"])
84
+ s.add_dependency(%q<rcov>, ["~> 1.0.0"])
88
85
  s.add_dependency(%q<ci_reporter>, ["~> 1.8.3"])
89
86
  s.add_dependency(%q<flog>, ["~> 3.2.1"])
90
87
  end
data/lib/lapidary.rb CHANGED
@@ -2,13 +2,19 @@ require "logger"
2
2
  require "erb"
3
3
  require "lapidary/command/build"
4
4
 
5
+ # RubyGem project support library
5
6
  module Lapidary
6
7
  TEMPLATES_DIR = File.expand_path(File.join(File.dirname(__FILE__), "lapidary", "templates"))
7
8
 
9
+ # Converter method from snake case string like 'foo_bar_baz' to camel case string like 'FooBarBaz'
10
+ # @param str [String] Snake case string like 'foo_bar_baz'
11
+ # @return [String] Camel case string like 'FooBarBaz'
8
12
  def self.to_camel_case(str)
9
13
  return str.split('_').map{|word| word.capitalize}.join
10
14
  end
11
15
 
16
+ # Reader method for the logger of Lapidary
17
+ # @return [Logger] Logger object
12
18
  def self.logger
13
19
  if @logger.nil?
14
20
  @logger = (rails_logger || default_logger)
@@ -19,17 +25,23 @@ module Lapidary
19
25
  return @logger
20
26
  end
21
27
 
28
+ # Reader method for the rails logger of Lapidary
29
+ # @return [Logger] Logger object
22
30
  def self.rails_logger
23
31
  (defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger) ||
24
32
  (defined?(RAILS_DEFAULT_LOGGER) && RAILS_DEFAULT_LOGGER.respond_to?(:debug) && RAILS_DEFAULT_LOGGER)
25
33
  end
26
34
 
35
+ # Reader method for the default logger of Lapidary
36
+ # @return [Logger] Logger object
27
37
  def self.default_logger
28
38
  l = Logger.new(STDERR)
29
39
  l.level = Logger::INFO
30
40
  l
31
41
  end
32
42
 
43
+ # Writer method for the logger of Lapidary
44
+ # @param logger [Logger]
33
45
  def self.logger=(logger)
34
46
  @logger = logger
35
47
  end
data/lib/lapidary/command/build.rb CHANGED
@@ -1,6 +1,12 @@
1
1
  module Lapidary
2
+ # Lapidary sub-commands
2
3
  module Command
4
+ # Rubygem builder command
3
5
  module Build
6
+ # Rubygem generator method
7
+ #
8
+ # This method generates a new Rubygem project
9
+ # @param argv [Array] command-line arguments
4
10
  def self.run(argv)
5
11
  @user_name = `/usr/bin/env git config --get user.name`.chomp
6
12
  @user_email = `/usr/bin/env git config --get user.email`.chomp
data/lib/lapidary/templates/lib/project.rb.erb CHANGED
@@ -1,6 +1,8 @@
1
1
  require "logger"
2
2
 
3
3
  module <%=@module_name%>
4
+ # Reader method for the logger of Lapidary
5
+ # @return [Logger] Logger object
4
6
  def self.logger
5
7
  if @logger.nil?
6
8
  @logger = (rails_logger || default_logger)
@@ -11,17 +13,23 @@ module <%=@module_name%>
11
13
  return @logger
12
14
  end
13
15
 
16
+ # Reader method for the rails logger of Lapidary
17
+ # @return [Logger] Logger object
14
18
  def self.rails_logger
15
19
  (defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger) ||
16
20
  (defined?(RAILS_DEFAULT_LOGGER) && RAILS_DEFAULT_LOGGER.respond_to?(:debug) && RAILS_DEFAULT_LOGGER)
17
21
  end
18
22
 
23
+ # Reader method for the default logger of Lapidary
24
+ # @return [Logger] Logger object
19
25
  def self.default_logger
20
26
  l = Logger.new(STDERR)
21
27
  l.level = Logger::INFO
22
28
  l
23
29
  end
24
30
 
31
+ # Writer method for the logger of Lapidary
32
+ # @param logger [Logger]
25
33
  def self.logger=(logger)
26
34
  @logger = logger
27
35
  end
metadata CHANGED
@@ -1,185 +1,175 @@
1
- --- !ruby/object:Gem::Specification
1
+ --- !ruby/object:Gem::Specification
2
2
  name: lapidary
3
- version: !ruby/object:Gem::Version
4
- version: 0.2.0
3
+ version: !ruby/object:Gem::Version
4
+ hash: 21
5
5
  prerelease:
6
+ segments:
7
+ - 0
8
+ - 2
9
+ - 1
10
+ version: 0.2.1
6
11
  platform: ruby
7
- authors:
12
+ authors:
8
13
  - Kenji Hara
9
14
  autorequire:
10
15
  bindir: bin
11
16
  cert_chain: []
12
- date: 2013-01-12 00:00:00.000000000 Z
13
- dependencies:
14
- - !ruby/object:Gem::Dependency
15
- name: rspec
16
- requirement: !ruby/object:Gem::Requirement
17
- none: false
18
- requirements:
19
- - - ~>
20
- - !ruby/object:Gem::Version
21
- version: 2.12.0
22
- type: :runtime
17
+
18
+ date: 2013-01-12 00:00:00 Z
19
+ dependencies:
20
+ - !ruby/object:Gem::Dependency
23
21
  prerelease: false
24
- version_requirements: !ruby/object:Gem::Requirement
22
+ requirement: &id001 !ruby/object:Gem::Requirement
25
23
  none: false
26
- requirements:
24
+ requirements:
27
25
  - - ~>
28
- - !ruby/object:Gem::Version
26
+ - !ruby/object:Gem::Version
27
+ hash: 63
28
+ segments:
29
+ - 2
30
+ - 12
31
+ - 0
29
32
  version: 2.12.0
30
- - !ruby/object:Gem::Dependency
31
- name: yard
32
- requirement: !ruby/object:Gem::Requirement
33
- none: false
34
- requirements:
35
- - - ~>
36
- - !ruby/object:Gem::Version
37
- version: 0.8.3
38
33
  type: :runtime
34
+ name: rspec
35
+ version_requirements: *id001
36
+ - !ruby/object:Gem::Dependency
39
37
  prerelease: false
40
- version_requirements: !ruby/object:Gem::Requirement
38
+ requirement: &id002 !ruby/object:Gem::Requirement
41
39
  none: false
42
- requirements:
40
+ requirements:
43
41
  - - ~>
44
- - !ruby/object:Gem::Version
42
+ - !ruby/object:Gem::Version
43
+ hash: 57
44
+ segments:
45
+ - 0
46
+ - 8
47
+ - 3
45
48
  version: 0.8.3
46
- - !ruby/object:Gem::Dependency
47
- name: redcarpet
48
- requirement: !ruby/object:Gem::Requirement
49
- none: false
50
- requirements:
51
- - - ~>
52
- - !ruby/object:Gem::Version
53
- version: 2.2.2
54
49
  type: :runtime
50
+ name: yard
51
+ version_requirements: *id002
52
+ - !ruby/object:Gem::Dependency
55
53
  prerelease: false
56
- version_requirements: !ruby/object:Gem::Requirement
54
+ requirement: &id003 !ruby/object:Gem::Requirement
57
55
  none: false
58
- requirements:
56
+ requirements:
59
57
  - - ~>
60
- - !ruby/object:Gem::Version
58
+ - !ruby/object:Gem::Version
59
+ hash: 3
60
+ segments:
61
+ - 2
62
+ - 2
63
+ - 2
61
64
  version: 2.2.2
62
- - !ruby/object:Gem::Dependency
63
- name: rdoc
64
- requirement: !ruby/object:Gem::Requirement
65
- none: false
66
- requirements:
67
- - - ~>
68
- - !ruby/object:Gem::Version
69
- version: '3.12'
70
65
  type: :runtime
66
+ name: redcarpet
67
+ version_requirements: *id003
68
+ - !ruby/object:Gem::Dependency
71
69
  prerelease: false
72
- version_requirements: !ruby/object:Gem::Requirement
73
- none: false
74
- requirements:
75
- - - ~>
76
- - !ruby/object:Gem::Version
77
- version: '3.12'
78
- - !ruby/object:Gem::Dependency
79
- name: bundler
80
- requirement: !ruby/object:Gem::Requirement
70
+ requirement: &id004 !ruby/object:Gem::Requirement
81
71
  none: false
82
- requirements:
72
+ requirements:
83
73
  - - ~>
84
- - !ruby/object:Gem::Version
85
- version: 1.2.3
74
+ - !ruby/object:Gem::Version
75
+ hash: 31
76
+ segments:
77
+ - 3
78
+ - 12
79
+ version: "3.12"
86
80
  type: :runtime
81
+ name: rdoc
82
+ version_requirements: *id004
83
+ - !ruby/object:Gem::Dependency
87
84
  prerelease: false
88
- version_requirements: !ruby/object:Gem::Requirement
85
+ requirement: &id005 !ruby/object:Gem::Requirement
89
86
  none: false
90
- requirements:
87
+ requirements:
91
88
  - - ~>
92
- - !ruby/object:Gem::Version
89
+ - !ruby/object:Gem::Version
90
+ hash: 25
91
+ segments:
92
+ - 1
93
+ - 2
94
+ - 3
93
95
  version: 1.2.3
94
- - !ruby/object:Gem::Dependency
95
- name: jeweler
96
- requirement: !ruby/object:Gem::Requirement
97
- none: false
98
- requirements:
99
- - - ~>
100
- - !ruby/object:Gem::Version
101
- version: 1.8.4
102
96
  type: :runtime
97
+ name: bundler
98
+ version_requirements: *id005
99
+ - !ruby/object:Gem::Dependency
103
100
  prerelease: false
104
- version_requirements: !ruby/object:Gem::Requirement
101
+ requirement: &id006 !ruby/object:Gem::Requirement
105
102
  none: false
106
- requirements:
103
+ requirements:
107
104
  - - ~>
108
- - !ruby/object:Gem::Version
105
+ - !ruby/object:Gem::Version
106
+ hash: 63
107
+ segments:
108
+ - 1
109
+ - 8
110
+ - 4
109
111
  version: 1.8.4
110
- - !ruby/object:Gem::Dependency
111
- name: simplecov
112
- requirement: !ruby/object:Gem::Requirement
113
- none: false
114
- requirements:
115
- - - ~>
116
- - !ruby/object:Gem::Version
117
- version: 0.7.1
118
112
  type: :runtime
113
+ name: jeweler
114
+ version_requirements: *id006
115
+ - !ruby/object:Gem::Dependency
119
116
  prerelease: false
120
- version_requirements: !ruby/object:Gem::Requirement
121
- none: false
122
- requirements:
123
- - - ~>
124
- - !ruby/object:Gem::Version
125
- version: 0.7.1
126
- - !ruby/object:Gem::Dependency
127
- name: simplecov-rcov
128
- requirement: !ruby/object:Gem::Requirement
117
+ requirement: &id007 !ruby/object:Gem::Requirement
129
118
  none: false
130
- requirements:
119
+ requirements:
131
120
  - - ~>
132
- - !ruby/object:Gem::Version
133
- version: 0.2.3
121
+ - !ruby/object:Gem::Version
122
+ hash: 23
123
+ segments:
124
+ - 1
125
+ - 0
126
+ - 0
127
+ version: 1.0.0
134
128
  type: :runtime
129
+ name: rcov
130
+ version_requirements: *id007
131
+ - !ruby/object:Gem::Dependency
135
132
  prerelease: false
136
- version_requirements: !ruby/object:Gem::Requirement
137
- none: false
138
- requirements:
139
- - - ~>
140
- - !ruby/object:Gem::Version
141
- version: 0.2.3
142
- - !ruby/object:Gem::Dependency
143
- name: ci_reporter
144
- requirement: !ruby/object:Gem::Requirement
133
+ requirement: &id008 !ruby/object:Gem::Requirement
145
134
  none: false
146
- requirements:
135
+ requirements:
147
136
  - - ~>
148
- - !ruby/object:Gem::Version
137
+ - !ruby/object:Gem::Version
138
+ hash: 49
139
+ segments:
140
+ - 1
141
+ - 8
142
+ - 3
149
143
  version: 1.8.3
150
144
  type: :runtime
145
+ name: ci_reporter
146
+ version_requirements: *id008
147
+ - !ruby/object:Gem::Dependency
151
148
  prerelease: false
152
- version_requirements: !ruby/object:Gem::Requirement
153
- none: false
154
- requirements:
155
- - - ~>
156
- - !ruby/object:Gem::Version
157
- version: 1.8.3
158
- - !ruby/object:Gem::Dependency
159
- name: flog
160
- requirement: !ruby/object:Gem::Requirement
149
+ requirement: &id009 !ruby/object:Gem::Requirement
161
150
  none: false
162
- requirements:
151
+ requirements:
163
152
  - - ~>
164
- - !ruby/object:Gem::Version
153
+ - !ruby/object:Gem::Version
154
+ hash: 13
155
+ segments:
156
+ - 3
157
+ - 2
158
+ - 1
165
159
  version: 3.2.1
166
160
  type: :runtime
167
- prerelease: false
168
- version_requirements: !ruby/object:Gem::Requirement
169
- none: false
170
- requirements:
171
- - - ~>
172
- - !ruby/object:Gem::Version
173
- version: 3.2.1
161
+ name: flog
162
+ version_requirements: *id009
174
163
  description: Helper for creating RubyGem project
175
164
  email: haracane@gmail.com
176
- executables:
165
+ executables:
177
166
  - lapidary
178
167
  extensions: []
179
- extra_rdoc_files:
168
+
169
+ extra_rdoc_files:
180
170
  - LICENSE.txt
181
171
  - README.md
182
- files:
172
+ files:
183
173
  - .document
184
174
  - .rspec
185
175
  - Gemfile
@@ -206,31 +196,37 @@ files:
206
196
  - spec/lib/lapidary_spec.rb
207
197
  - spec/spec_helper.rb
208
198
  homepage: http://github.com/haracane/lapidary
209
- licenses:
199
+ licenses:
210
200
  - MIT
211
201
  post_install_message:
212
202
  rdoc_options: []
213
- require_paths:
203
+
204
+ require_paths:
214
205
  - lib
215
- required_ruby_version: !ruby/object:Gem::Requirement
206
+ required_ruby_version: !ruby/object:Gem::Requirement
216
207
  none: false
217
- requirements:
218
- - - ! '>='
219
- - !ruby/object:Gem::Version
220
- version: '0'
221
- segments:
208
+ requirements:
209
+ - - ">="
210
+ - !ruby/object:Gem::Version
211
+ hash: 3
212
+ segments:
222
213
  - 0
223
- hash: -4078103501762392493
224
- required_rubygems_version: !ruby/object:Gem::Requirement
214
+ version: "0"
215
+ required_rubygems_version: !ruby/object:Gem::Requirement
225
216
  none: false
226
- requirements:
227
- - - ! '>='
228
- - !ruby/object:Gem::Version
229
- version: '0'
217
+ requirements:
218
+ - - ">="
219
+ - !ruby/object:Gem::Version
220
+ hash: 3
221
+ segments:
222
+ - 0
223
+ version: "0"
230
224
  requirements: []
225
+
231
226
  rubyforge_project:
232
227
  rubygems_version: 1.8.24
233
228
  signing_key:
234
229
  specification_version: 3
235
230
  summary: Helper for creating RubyGem project
236
231
  test_files: []
232
+