Class: GemHadar

Inherits:
Object
  • Object
show all
Extended by:
DSLKit::DSLAccessor
Includes:
Config, Rake::DSL, RbConfig, Tins::SecureWrite
Defined in:
lib/gem_hadar.rb,
lib/gem_hadar/version.rb

Defined Under Namespace

Classes: RvmConfig, TemplateCompiler

Constant Summary collapse

VERSION =

GemHadar version

'1.1.1'
VERSION_ARRAY =

:nodoc:

VERSION.split('.').map(&:to_i)
VERSION_MAJOR =

:nodoc:

VERSION_ARRAY[0]
VERSION_MINOR =

:nodoc:

VERSION_ARRAY[1]
VERSION_BUILD =

:nodoc:

VERSION_ARRAY[2]

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(&block) ⇒ GemHadar

Returns a new instance of GemHadar.



37
38
39
40
41
 
# File 'lib/gem_hadar.rb', line 37

def initialize(&block)
  @dependencies = []
  @development_dependencies = []
  block and instance_eval(&block)
end

Class Method Details

.start_simplecov ⇒ Object 



379
380
381
382
383
384
385
386
 
# File 'lib/gem_hadar.rb', line 379

def self.start_simplecov
  filter = "#{File.basename(File.dirname(caller.first))}/"
  require_maybe 'simplecov'
  defined?(SimpleCov) and
    SimpleCov.start do
      add_filter filter
    end
end

Instance Method Details

#ask?(prompt, pattern) ⇒ Boolean

Returns:

  • (Boolean) 


502
503
504
505
506
507
508
 
# File 'lib/gem_hadar.rb', line 502

def ask?(prompt, pattern)
  STDOUT.print prompt
  answer = STDIN.gets.chomp
  if answer =~ pattern
    $~
  end
end

#build_task ⇒ Object 



181
182
183
184
 
# File 'lib/gem_hadar.rb', line 181

def build_task
  desc 'Build task (builds all packages for a release)'
  task :build => build_task_dependencies
end

#clean(*args) ⇒ Object 



193
194
195
196
197
198
199
 
# File 'lib/gem_hadar.rb', line 193

def clean(*args)
  if args.empty?
    CLEAN
  else
    CLEAN.include(*args)
  end
end

#clobber(*args) ⇒ Object 



201
202
203
204
205
206
207
 
# File 'lib/gem_hadar.rb', line 201

def clobber(*args)
  if args.empty?
    CLOBBER
  else
    CLOBBER.include(*args)
  end
end

#compile_task ⇒ Object 



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/gem_hadar.rb', line 472

def compile_task
  for file in extensions
    dir = File.dirname(file)
    clean File.join(dir, 'Makefile'), File.join(dir, '*.{bundle,o,so}')
  end
  desc "Compile extensions: #{extensions * ', '}"
  task :compile do
    for file in extensions
      dir, file = File.split(file)
      cd dir do
        ruby file
        sh make
      end
    end
  end
end

#create_all_tasks ⇒ Object 



510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/gem_hadar.rb', line 510

def create_all_tasks
  default_task
  build_task
  rvm_task
  version_task
  gemspec_task
  gems_install_task
  doc_task
  if test_dir
    test_task
    rcov_task
  end
  spec_task
  package_task
  install_library_task
  version_tag_task
  version_push_task
  master_push_task
  write_ignore_file
  write_gemfile
  gem_push_task
  if extensions.full?
    compile_task
    task :prepare_install => :compile
  else
    task :prepare_install
  end
  self
end

#default_task ⇒ Object 



174
175
176
177
 
# File 'lib/gem_hadar.rb', line 174

def default_task
  desc 'Default task'
  task :default => default_task_dependencies
end

#dependency(*args) ⇒ Object 



217
218
219
 
# File 'lib/gem_hadar.rb', line 217

def dependency(*args)
  @dependencies << args
end

#development_dependency(*args) ⇒ Object 



221
222
223
 
# File 'lib/gem_hadar.rb', line 221

def development_dependency(*args)
  @development_dependencies << args
end

#doc_task ⇒ Object 



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/gem_hadar.rb', line 314

def doc_task
  clean 'doc'
  desc "Creating documentation"
  task :doc do
    cmd = 'sdoc'
    if readme
      cmd << " --main '#{readme}'"
    end
    if title
      cmd << " --title '#{title}'"
    else
      cmd << " --title '#{name.camelize} - #{summary}'"
    end
    cmd << ' ' << doc_files * ' '
    if readme
      cmd << " #{readme}"
    end
    sh cmd
  end
end

#gem_push_task ⇒ Object 



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/gem_hadar.rb', line 451

def gem_push_task
  namespace :gem do
    path = "pkg/#{name_version}.gem"
    desc "Push gem file #{File.basename(path)} to rubygems"
    task :push do
      if File.exist?(path)
        if ask?("Do you really want to push #{path.inspect} to rubygems? "\
          "(yes/NO) ", /\Ayes\z/i)
        then
          sh "gem push #{path}"
        else
          exit 1
        end
      else
        warn "Cannot push gem to rubygems: #{path.inspect} doesn't exist."
        exit 1
      end
    end
  end
end

#gems_install_task(&block) ⇒ Object 



225
226
227
228
229
230
231
 
# File 'lib/gem_hadar.rb', line 225

def gems_install_task(&block)
  block ||= proc {  sh 'bundle install' }
  desc 'Install all gems from the Gemfile'
  namespace :gems do
    task :install => :gemspec , &block
  end
end

#gemspec ⇒ Object 



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
 
# File 'lib/gem_hadar.rb', line 233

def gemspec
  Gem::Specification.new do |s|
    s.name        = name
    s.version     = ::Gem::Version.new(version)
    s.author      = author
    s.email       = email
    s.homepage    = homepage
    s.summary     = summary
    s.description = description
    files.full? { |f| s.files = Array(f) }
    test_files.full? { |t| s.test_files = Array(t) }
    extensions.full? { |e| s.extensions = Array(e) }
    bindir.full? { |b| s.bindir = b }
    executables.full? { |e| s.executables = Array(e) }
    licenses.full? { |l| s.licenses = Array(licenses) }
    post_install_message.full? { |m| s.post_install_message = m }

    s.add_development_dependency('gem_hadar', "~>#{VERSION}")
    for d in @development_dependencies
      s.add_development_dependency(*d)
    end
    for d in @dependencies
      s.add_dependency(*d)
    end

    require_paths.full? { |r| s.require_paths = Array(r) }

    if title
      s.rdoc_options << '--title' << title
    else
      s.rdoc_options << '--title' << "#{name.camelize} - #{summary}"
    end
    if readme
      s.rdoc_options << '--main' << readme
      s.extra_rdoc_files << readme
    end
    doc_files.full? { |df| s.extra_rdoc_files.concat Array(df) }
  end
end

#gemspec_task ⇒ Object 



294
295
296
297
298
299
300
301
 
# File 'lib/gem_hadar.rb', line 294

def gemspec_task
  desc 'Create a gemspec file'
  task :gemspec => :version do
    filename = "#{name}.gemspec"
    warn "Writing to #{filename.inspect} for #{version}"
    secure_write(filename, gemspec.to_ruby)
  end
end

#git_remote ⇒ Object 



429
430
431
 
# File 'lib/gem_hadar.rb', line 429

def git_remote
  ENV['GIT_REMOTE'] || 'origin'
end

#has_to_be_set(name) ⇒ Object 



43
44
45
 
# File 'lib/gem_hadar.rb', line 43

def has_to_be_set(name)
  fail "#{self.class}: #{name} has to be set for gem"
end

#ignore(*args) ⇒ Object 



209
210
211
212
213
214
215
 
# File 'lib/gem_hadar.rb', line 209

def ignore(*args)
  if args.empty?
    ignore_files
  else
    args.each { |a| ignore_files << a }
  end
end

#install_library(&block) ⇒ Object 



186
187
188
189
190
191
 
# File 'lib/gem_hadar.rb', line 186

def install_library(&block)
  @install_library_block = lambda do
    desc 'Install executable/library into site_ruby directories'
    task :install => :prepare_install, &block
  end
end

#install_library_task ⇒ Object 



310
311
312
 
# File 'lib/gem_hadar.rb', line 310

def install_library_task
  @install_library_block.full?(:call)
end

#master_push_task ⇒ Object 



442
443
444
445
446
447
448
449
 
# File 'lib/gem_hadar.rb', line 442

def master_push_task
  namespace :master do
    desc "Push master to git remote"
    task :push do
      sh "git push #{git_remote} master"
    end
  end
end

#package_task ⇒ Object 



303
304
305
306
307
308
 
# File 'lib/gem_hadar.rb', line 303

def package_task
  Gem::PackageTask.new(gemspec) do |pkg|
    pkg.need_tar      = true
    pkg.package_files += files
  end
end

#rcov_task ⇒ Object 



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/gem_hadar.rb', line 358

def rcov_task
  if defined?(::Rcov)
    rt = ::Rcov::RcovTask.new(:run_rcov) do |t|
      t.libs << test_dir
      t.libs.concat require_paths.to_a
      t.libs.uniq!
      t.test_files = test_files
      t.verbose    = true
      t.rcov_opts  = %W[-x '\\b#{test_dir}\/' -x '\\bgems\/']
    end
    desc 'Run the rcov code coverage tests'
    task :rcov => [ (:compile if extensions.full?), rt.name ].compact
    clobber 'coverage'
  else
    desc 'Run the rcov code coverage tests'
    task :rcov do
      warn "rcov doesn't work for some reason, have you tried 'gem install rcov'?"
    end
  end
end

#require_path(path = nil) ⇒ Object 



79
80
81
82
83
84
85
 
# File 'lib/gem_hadar.rb', line 79

def require_path(path = nil)
  if path
    self.require_paths = Set[path]
  else
    require_paths.first
  end
end

#rvm(&block) ⇒ Object 



163
164
165
166
167
168
169
170
 
# File 'lib/gem_hadar.rb', line 163

def rvm(&block)
  if block
    @rvm = RvmConfig.new(&block)
  elsif !@rvm
    @rvm = RvmConfig.new { }
  end
  @rvm
end

#rvm_task ⇒ Object 



489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/gem_hadar.rb', line 489

def rvm_task
  desc 'Create .rvmrc file'
  task :rvm do
    secure_write('.rvmrc') do |output|
      output.write <<EOT
rvm use #{rvm.use}
rvm gemset create #{rvm.gemset}
rvm gemset use #{rvm.gemset}
EOT
    end
  end
end

#spec_task ⇒ Object 



346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/gem_hadar.rb', line 346

def spec_task
  if defined?(::RSpec::Core::RakeTask)
    st =  RSpec::Core::RakeTask.new(:run_specs) do |t|
      t.ruby_opts ||= ''
      t.ruby_opts << ' -I' << ([ spec_dir ] + require_paths.to_a).uniq * ':'
      t.pattern = spec_pattern
      t.verbose = true
    end
    task :spec => [ (:compile if extensions.full?), st.name ].compact
  end
end

#test_task ⇒ Object 



335
336
337
338
339
340
341
342
343
344
 
# File 'lib/gem_hadar.rb', line 335

def test_task
  tt =  Rake::TestTask.new(:run_tests) do |t|
    t.libs << test_dir
    t.libs.concat require_paths.to_a
    t.test_files = test_files
    t.verbose    = true
  end
  desc 'Run the tests'
  task :test => [ (:compile if extensions.full?), tt.name ].compact
end

#version_push_task ⇒ Object 



433
434
435
436
437
438
439
440
 
# File 'lib/gem_hadar.rb', line 433

def version_push_task
  namespace :version do
    desc "Push all versions to GIT_REMOTE=#{git_remote}"
    task :push do
      sh "git push #{git_remote} --tags"
    end
  end
end

#version_tag_task ⇒ Object 



415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/gem_hadar.rb', line 415

def version_tag_task
  namespace :version do
    desc "Tag this commit as version #{version}"
    task :tag do
      begin
        sh "git tag -a -m 'Version #{version}' #{'-f' if ENV['FORCE']} v#{version}"
      rescue RuntimeError
        warn "Call rake with FORCE=1 to overwrite version tag #{version}"
        exit 1
      end
    end
  end
end

#version_task ⇒ Object 



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/gem_hadar.rb', line 273

def version_task
  desc m = "Writing version information for #{name}-#{version}"
  task :version do
    puts m
    mkdir_p dir = File.join('lib', path_name)
    secure_write(File.join(dir, 'version.rb')) do |v|
      v.puts <<EOT
#{module_type} #{path_module}
# #{path_module} version
VERSION         = '#{version}'
VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:
VERSION_BUILD   = VERSION_ARRAY[2] # :nodoc:
end
EOT
      version_epilogue.full? { |ve| v.puts ve }
    end
  end
end

#write_gemfile ⇒ Object 



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/gem_hadar.rb', line 394

def write_gemfile
   default_gemfile =<<EOT
# vim: set filetype=ruby et sw=2 ts=2:

source 'https://rubygems.org'

gemspec
EOT
  current_gemfile = File.exist?('Gemfile') && File.read('Gemfile')
  case current_gemfile
  when false
    secure_write('Gemfile') do |output|
      output.write default_gemfile
    end
  when default_gemfile
    ;;
  else
    warn "INFO: Current Gemfile differs from default Gemfile."
  end
end

#write_ignore_file ⇒ Object 



388
389
390
391
392
 
# File 'lib/gem_hadar.rb', line 388

def write_ignore_file
  secure_write('.gitignore') do |output|
    output.puts(ignore.sort)
  end
end