Class: GLI::Commands::Scaffold

Inherits:
Object
  • Object
show all
Defined in:
lib/gli/commands/scaffold.rb

Overview

:nodoc:

Class Method Summary collapse

Class Method Details

.create_scaffold(root_dir, create_test_dir, create_ext_dir, project_name, commands, force = false, dry_run = false, create_rvmrc = false) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/gli/commands/scaffold.rb', line 8

def self.create_scaffold(root_dir,
                         create_test_dir,
                         create_ext_dir,
                         project_name,
                         commands,
                         force=false,
                         dry_run=false,
                         create_rvmrc=false)
  dirs = [File.join(root_dir,project_name,'lib')]
  dirs << File.join(root_dir,project_name,'bin')
  dirs << File.join(root_dir,project_name,'test') if create_test_dir
  dirs << File.join(root_dir,project_name,'ext') if create_ext_dir

  if mkdirs(dirs,force,dry_run)
    mk_binfile(root_dir,create_ext_dir,force,dry_run,project_name,commands)
    mk_readme(root_dir,dry_run,project_name)
    mk_gemspec(root_dir,dry_run,project_name)
    mk_rakefile(root_dir,dry_run,project_name,create_test_dir)
    mk_lib_files(root_dir,dry_run,project_name)
    if create_rvmrc
      rvmrc = File.join(root_dir,project_name,".rvmrc")
      File.open(rvmrc,'w') do |file|
        file.puts "rvm use #{ENV['rvm_ruby_string']}@#{project_name} --create"
      end
      puts "Created #{rvmrc}"
    end
    init_git(root_dir, project_name)
  end
end

.init_git(root_dir, project_name) ⇒ Object 



289
290
291
292
293
294
295
 
# File 'lib/gli/commands/scaffold.rb', line 289

def self.init_git(root_dir, project_name)
  project_dir = "#{root_dir}/#{project_name}"

  unless system("git", "init", "--quiet", project_dir)
    puts "There was a problem initializing Git. Your gemspec may not work until you have done a successful `git init`"
  end
end

.mk_binfile(root_dir, create_ext_dir, force, dry_run, project_name, commands) ⇒ Object 



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/gli/commands/scaffold.rb', line 179

def self.mk_binfile(root_dir,create_ext_dir,force,dry_run,project_name,commands)
  bin_file = File.join(root_dir,project_name,'bin',project_name)
  if !File.exist?(bin_file) || force
    if !dry_run
      File.open(bin_file,'w') do |file|
        file.chmod(0755)
        file.puts '#!/usr/bin/env ruby'
        file.puts <<EOS
require 'gli'
begin # XXX: Remove this begin/rescue before distributing your app
require '#{project_name}'
rescue LoadError
  STDERR.puts "In development, you need to use `bundle exec bin/#{project_name}` to run your app"
  STDERR.puts "At install-time, RubyGems will make sure lib, etc. are in the load path"
  STDERR.puts "Feel free to remove this message from bin/#{project_name} now"
  exit 64
end

class App
  extend GLI::App

  program_desc 'Describe your application here'

  version #{project_name_as_module_name(project_name)}::VERSION

  subcommand_option_handling :normal
  arguments :strict

  desc 'Describe some switch here'
  switch [:s,:switch]

  desc 'Describe some flag here'
  default_value 'the default'
  arg_name 'The name of the argument'
  flag [:f,:flagname]
EOS
        first = true
        commands.each do |command|
          file.puts <<EOS

  desc 'Describe #{command} here'
  arg_name 'Describe arguments to #{command} here'
EOS
          if first
            file.puts <<EOS
  command :#{command} do |c|
c.desc 'Describe a switch to #{command}'
c.switch :s

c.desc 'Describe a flag to #{command}'
c.default_value 'default'
c.flag :f
c.action do |global_options,options,args|

  # Your command logic here

  # If you have any errors, just raise them
  # raise "that command made no sense"

  puts "#{command} command ran"
end
  end
EOS
          else
            file.puts <<EOS
  command :#{command} do |c|
c.action do |global_options,options,args|
  puts "#{command} command ran"
end
  end
EOS
          end
          first = false
        end
        file.puts <<EOS

  pre do |global,command,options,args|
# Pre logic here
# Return true to proceed; false to abort and not call the
# chosen command
# Use skips_pre before a command to skip this block
# on that command only
true
  end

  post do |global,command,options,args|
# Post logic here
# Use skips_post before a command to skip this
# block on that command only
  end

  on_error do |exception|
# Error logic here
# return false to skip default error handling
true
  end
end

exit App.run(ARGV)
EOS
        puts "Created #{bin_file}"
      end
    end
  else
    puts bin_file + " exists; use --force to override"
    return false
  end
  true
end

.mk_gemspec(root_dir, dry_run, project_name) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/gli/commands/scaffold.rb', line 53

def self.mk_gemspec(root_dir,dry_run,project_name)
  return if dry_run
  File.open("#{root_dir}/#{project_name}/#{project_name}.gemspec",'w') do |file|
    file.puts <<EOS
# Ensure we require the local version and not one we might have installed already
require File.join([File.dirname(__FILE__),'lib','#{project_name}','version.rb'])
spec = Gem::Specification.new do |s|
  s.name = '#{project_name}'
  s.version = #{project_name_as_module_name(project_name)}::VERSION
  s.author = 'Your Name Here'
  s.email = '[email protected]'
  s.homepage = 'http://your.website.com'
  s.platform = Gem::Platform::RUBY
  s.summary = 'A description of your project'
  s.files = `git ls-files`.split("\n")
  s.require_paths << 'lib'
  s.extra_rdoc_files = ['README.rdoc','#{project_name}.rdoc']
  s.rdoc_options << '--title' << '#{project_name}' << '--main' << 'README.rdoc' << '-ri'
  s.bindir = 'bin'
  s.executables << '#{project_name}'
  s.add_development_dependency('rake')
  s.add_development_dependency('rdoc')
  s.add_development_dependency('minitest')
  s.add_runtime_dependency('gli','~> #{GLI::VERSION}')
end
EOS
  end
  puts "Created #{root_dir}/#{project_name}/#{project_name}.gemspec"
end

.mk_lib_files(root_dir, dry_run, project_name) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/gli/commands/scaffold.rb', line 87

def self.mk_lib_files(root_dir,dry_run,project_name)
  return if dry_run
  FileUtils.mkdir("#{root_dir}/#{project_name}/lib/#{project_name}")
  File.open("#{root_dir}/#{project_name}/lib/#{project_name}/version.rb",'w') do |file|
    file.puts <<EOS
module #{project_name_as_module_name(project_name)}
  VERSION = '0.0.1'
end
EOS
  end
  puts "Created #{root_dir}/#{project_name}/lib/#{project_name}/version.rb"
  File.open("#{root_dir}/#{project_name}/lib/#{project_name}.rb",'w') do |file|
    file.puts <<EOS
require '#{project_name}/version.rb'

# Add requires for other files you add to your project here, so
# you just need to require this one file in your bin file
EOS
  end
  puts "Created #{root_dir}/#{project_name}/lib/#{project_name}.rb"
end

.mk_rakefile(root_dir, dry_run, project_name, create_test_dir) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/gli/commands/scaffold.rb', line 108

def self.mk_rakefile(root_dir,dry_run,project_name,create_test_dir)
  return if dry_run
  File.open("#{root_dir}/#{project_name}/Rakefile",'w') do |file|
    file.puts <<EOS
require 'rake/clean'
require 'rubygems'
require 'rubygems/package_task'
require 'rdoc/task'
EOS
    file.puts <<EOS
Rake::RDocTask.new do |rd|
  rd.main = "README.rdoc"
  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
  rd.title = 'Your application title'
end

spec = Gem::Specification.load("#{project_name}.gemspec")

Gem::PackageTask.new(spec) do |pkg|
end
EOS
    if create_test_dir
      file.puts <<EOS
require 'rake/testtask'
Rake::TestTask.new do |t|
  t.libs << "test"
  t.test_files = FileList['test/*_test.rb']
end

task :default => :test
EOS
      File.open("#{root_dir}/#{project_name}/test/default_test.rb",'w') do |test_file|
        test_file.puts <<EOS
require_relative "test_helper"

class DefaultTest < Minitest::Test

  def setup
  end

  def teardown
  end

  def test_the_truth
assert true
  end
end
EOS
      end
      puts "Created #{root_dir}/#{project_name}/test/default_test.rb"
      File.open("#{root_dir}/#{project_name}/test/test_helper.rb",'w') do |test_file|
        test_file.puts <<EOS
require "minitest/autorun"

# Add test libraries you want to use here, e.g. mocha
# Add helper classes or methods here, too
EOS
      end
      puts "Created #{root_dir}/#{project_name}/test/test_helper.rb"
    else
      file.puts "task :default => :package\n"
    end
  end
  puts "Created #{root_dir}/#{project_name}/Rakefile"
  File.open("#{root_dir}/#{project_name}/Gemfile",'w') do |bundler_file|
    bundler_file.puts "source 'https://rubygems.org'"
    bundler_file.puts "gemspec"
  end
  puts "Created #{root_dir}/#{project_name}/Gemfile"
end

.mk_readme(root_dir, dry_run, project_name) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/gli/commands/scaffold.rb', line 38

def self.mk_readme(root_dir,dry_run,project_name)
  return if dry_run
  File.open("#{root_dir}/#{project_name}/README.rdoc",'w') do |file|
    file << "= #{project_name}\n\n"
    file << "Describe your project here\n\n"
    file << ":include:#{project_name}.rdoc\n\n"
  end
  puts "Created #{root_dir}/#{project_name}/README.rdoc"
  File.open("#{root_dir}/#{project_name}/#{project_name}.rdoc",'w') do |file|
    file << "= #{project_name}\n\n"
    file << "Generate this with\n    #{project_name} _doc\nAfter you have described your command line interface"
  end
  puts "Created #{root_dir}/#{project_name}/#{project_name}.rdoc"
end

.mkdirs(dirs, force, dry_run) ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/gli/commands/scaffold.rb', line 297

def self.mkdirs(dirs,force,dry_run)
  exists = false
  if !force
    dirs.each do |dir|
      if File.exist? dir
        raise "#{dir} exists; use --force to override"
        exists = true
      end
    end
  end
  if !exists
    dirs.each do |dir|
      puts "Creating dir #{dir}..."
      if dry_run
        puts "dry-run; #{dir} not created"
      else
        FileUtils.mkdir_p dir
      end
    end
  else
    puts "Exiting..."
    return false
  end
  true
end

.project_name_as_module_name(project_name) ⇒ Object 



83
84
85
 
# File 'lib/gli/commands/scaffold.rb', line 83

def self.project_name_as_module_name(project_name)
  project_name.split(/[_-]/).map { |part| part[0..0].upcase + part[1..-1] }.join('')
end