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.15.0'
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.



40
41
42
43
44
 
# File 'lib/gem_hadar.rb', line 40

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

Class Method Details

.start_simplecov ⇒ Object 



467
468
469
470
471
472
473
 
# File 'lib/gem_hadar.rb', line 467

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

Instance Method Details

#ask?(prompt, pattern) ⇒ Boolean

Returns:

  • (Boolean) 


728
729
730
731
732
733
734
 
# File 'lib/gem_hadar.rb', line 728

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

#assert_valid_link(name, orig_url) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/gem_hadar.rb', line 50

def assert_valid_link(name, orig_url)
  developing and return orig_url
  url = orig_url
  begin
    response = Net::HTTP.get_response(URI.parse(url))
    url = response['location']
  end while response.is_a?(Net::HTTPRedirection)
  response.is_a?(Net::HTTPOK) or
    fail "#{orig_url.inspect} for #{name} has to be a valid link"
  orig_url
end

#build_task ⇒ Object 



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

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

#clean(*args) ⇒ Object 



216
217
218
219
220
221
222
 
# File 'lib/gem_hadar.rb', line 216

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

#clobber(*args) ⇒ Object 



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

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

#compile_task ⇒ Object 



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/gem_hadar.rb', line 666

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 



736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'lib/gem_hadar.rb', line 736

def create_all_tasks
  default_task
  build_task
  rvm_task
  version_task
  version_show_task
  version_diff_task
  gem_hadar_update_task
  gemspec_task
  gems_install_task
  doc_task
  if test_dir
    test_task
    rcov_task
  end
  spec_task
  package_task
  yard_task
  install_library_task
  version_bump_task
  version_tag_task
  push_task
  write_ignore_file
  write_gemfile
  if extensions.full?
    compile_task
    task :prepare_install => :compile
  else
    task :prepare_install
  end
  self
end

#default_task ⇒ Object 



197
198
199
200
 
# File 'lib/gem_hadar.rb', line 197

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

#dependency(*args) ⇒ Object 



248
249
250
 
# File 'lib/gem_hadar.rb', line 248

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

#development_dependency(*args) ⇒ Object 



252
253
254
 
# File 'lib/gem_hadar.rb', line 252

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

#doc_task ⇒ Object 



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/gem_hadar.rb', line 410

def doc_task
  clean 'doc'
  desc "Creating documentation"
  task :doc do
    sh 'yard doc'
    cmd = 'yardoc'
    if readme
      cmd << " --readme '#{readme}'"
    end
    cmd << ' - ' << doc_files * ' '
    sh cmd
  end
end

#gem_files ⇒ Object 



264
265
266
 
# File 'lib/gem_hadar.rb', line 264

def gem_files
  (files.to_a - package_ignore_files.to_a)
end

#gem_hadar_update_task ⇒ Object 



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/gem_hadar.rb', line 362

def gem_hadar_update_task
  namespace :gem_hadar do
    desc 'Update gem_hadar a different version'
    task :update do
      answer = ask?("Which gem_hadar version? ", /^((?:\d+.){2}(?:\d+))$/)
      unless answer
        warn "Invalid version specification!"
        exit 1
      end
      gem_hadar_version = answer[0]
      filename = "#{name}.gemspec"
      old_data = File.read(filename)
      new_data = old_data.gsub(
        /(add_(?:development_)?dependency\(%q<gem_hadar>, \["~> )([\d.]+)("\])/
      ) { "#$1#{gem_hadar_version}#$3" }
      if old_data == new_data
        warn "#{filename.inspect} already depends on gem_hadar "\
          "#{gem_hadar_version} => Do nothing."
      else
        warn "Upgrading #{filename.inspect} to #{gem_hadar_version}."
        secure_write(filename) do |spec|
          spec.write new_data
        end
      end
    end
  end
end

#gem_push_task ⇒ Object 



612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
 
# File 'lib/gem_hadar.rb', line 612

def gem_push_task
  namespace :gem do
    path = "pkg/#{name_version}.gem"
    desc "Push gem file #{File.basename(path)} to rubygems"
    if developing
      task :push => :build do
        puts "Skipping push to rubygems while developing mode is enabled."
      end
    else
      task :push => :build do
        if File.exist?(path)
          if ask?("Do you really want to push #{path.inspect} to rubygems? "\
              "(yes/NO) ", /\Ayes\z/i)
            then
            key = ENV['GEM_API_KEY'].full? { |k| "--key #{k} " }
            sh "gem push #{key}#{path}"
          else
            exit 1
          end
        else
          warn "Cannot push gem to rubygems: #{path.inspect} doesn't exist."
          exit 1
        end
      end
    end
  end
end

#gems_install_task(&block) ⇒ Object 



256
257
258
259
260
261
262
 
# File 'lib/gem_hadar.rb', line 256

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 



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/gem_hadar.rb', line 268

def gemspec
  Gem::Specification.new do |s|
    s.name        = name
    s.version     = ::Gem::Version.new(version)
    s.author      = author
    s.email       = email
    s.homepage    = assert_valid_link(:homepage, homepage)
    s.summary     = summary
    s.description = description

    gem_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 }

    required_ruby_version.full? { |v| s.required_ruby_version = v }
    s.add_development_dependency('gem_hadar', "~>#{VERSION}")
    for d in @development_dependencies
      s.add_development_dependency(*d)
    end
    for d in @dependencies
      if s.respond_to?(:add_runtime_dependency)
        s.add_runtime_dependency(*d)
      else
        s.add_dependency(*d)
      end
    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 



390
391
392
393
394
395
396
397
 
# File 'lib/gem_hadar.rb', line 390

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 



553
554
555
 
# File 'lib/gem_hadar.rb', line 553

def git_remote
  ENV.fetch('GIT_REMOTE', 'origin').split(/\s+/).first
end

#git_remotes ⇒ Object 



557
558
559
560
561
 
# File 'lib/gem_hadar.rb', line 557

def git_remotes
  remotes = ENV['GIT_REMOTE'].full?(:split, /\s+/)
  remotes or remotes = `git remote`.lines.map(&:chomp)
  remotes
end

#git_remotes_task ⇒ Object 



640
641
642
643
644
645
646
647
 
# File 'lib/gem_hadar.rb', line 640

def git_remotes_task
  task :git_remotes do
    puts git_remotes.map { |r|
      url = `git remote get-url #{r.inspect}`.chomp
      "#{r} #{url}"
    }
  end
end

#has_to_be_set(name) ⇒ Object 



46
47
48
 
# File 'lib/gem_hadar.rb', line 46

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

#ignore(*args) ⇒ Object 



232
233
234
235
236
237
238
 
# File 'lib/gem_hadar.rb', line 232

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

#install_library(&block) ⇒ Object 



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

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 



406
407
408
 
# File 'lib/gem_hadar.rb', line 406

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

#master_prepare_task ⇒ Object 



563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/gem_hadar.rb', line 563

def master_prepare_task
  namespace :master do
    desc "Prepare a remote git repository for this project"
    task :prepare do
      puts "Create a new remote git repository for #{name.inspect}"
      remote_name = ask?('Name (default: origin) ? ', /^.+$/).
        full?(:[], 0) || 'origin'
      dir         = ask?("Directory (default: /git/#{name}.git)? ", /^.+$/).
        full?(:[], 0) || "/git/#{name}.git"
       = ask?('SSH account (format: login@host)? ', /^[^@]+@[^@]+/).
        full?(:[], 0) || exit(1)
      sh "ssh #{} 'git init --bare #{dir}'"
      sh "git remote add -m master #{remote_name} #{}:#{dir}"
    end
  end
end

#master_push_task ⇒ Object 



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
 
# File 'lib/gem_hadar.rb', line 596

def master_push_task
  namespace :master do
    git_remotes.each do |gr|
      namespace gr.to_sym do
        desc "Push master to git remote #{gr}"
        task :push do
          sh "git push #{gr} master"
        end
      end
    end

    desc "Push master #{version} to all git remotes: #{git_remotes * ' '}"
    task :push => git_remotes.map { |gr| :"master:#{gr}:push" }
  end
end

#package_ignore(*args) ⇒ Object 



240
241
242
243
244
245
246
 
# File 'lib/gem_hadar.rb', line 240

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

#package_task ⇒ Object 



399
400
401
402
403
404
 
# File 'lib/gem_hadar.rb', line 399

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

#push_task ⇒ Object 



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/gem_hadar.rb', line 649

def push_task
  master_prepare_task
  version_push_task
  master_push_task
  gem_push_task
  git_remotes_task
  task :modified do
    changed_files = `git status --porcelain`.gsub(/^\s*\S\s+/, '').lines
    unless changed_files.empty?
      warn "There are still modified files:\n#{changed_files * ''}"
      exit 1
    end
  end
  desc "Push master and version #{version} all git remotes: #{git_remotes * ' '}"
  task :push => %i[ modified build master:push version:push gem:push ]
end

#rcov_task ⇒ Object 



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/gem_hadar.rb', line 446

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 



96
97
98
99
100
101
102
 
# File 'lib/gem_hadar.rb', line 96

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

#rvm(&block) ⇒ Object 



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

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

#rvm_task ⇒ Object 



683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/gem_hadar.rb', line 683

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 



435
436
437
438
439
440
441
442
443
444
 
# File 'lib/gem_hadar.rb', line 435

def spec_task
  defined? ::RSpec::Core::RakeTask or return
  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

#test_task ⇒ Object 



424
425
426
427
428
429
430
431
432
433
 
# File 'lib/gem_hadar.rb', line 424

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_bump_task ⇒ Object 



502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/gem_hadar.rb', line 502

def version_bump_task
  namespace :version do
    namespace :bump do
      desc 'Bump major version'
      task :major do
        version = File.read('VERSION').chomp.version
        version.bump(:major)
        secure_write('VERSION') { |v| v.puts version }
      end

      desc 'Bump minor version'
      task :minor do
        version = File.read('VERSION').chomp.version
        version.bump(:minor)
        secure_write('VERSION') { |v| v.puts version }
      end

      desc 'Bump build version'
      task :build do
        version = File.read('VERSION').chomp.version
        version.bump(:build)
        secure_write('VERSION') { |v| v.puts version }
      end
    end
  end
end

#version_diff_task ⇒ Object 



353
354
355
356
357
358
359
360
 
# File 'lib/gem_hadar.rb', line 353

def version_diff_task
  namespace :version do
    desc m = "Displaying the diff from HEAD to the last version tag"
    task :diff do
      puts `git diff v#{version}..HEAD`
    end
  end
end

#version_push_task ⇒ Object 



580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/gem_hadar.rb', line 580

def version_push_task
  namespace :version do
    git_remotes.each do |gr|
      namespace gr.to_sym do
        desc "Push version #{version} to git remote #{gr}"
        task :push do
          sh "git push #{gr} v#{version}"
        end
      end
    end

    desc "Push version #{version} to all git remotes: #{git_remotes * ' '}"
    task :push => git_remotes.map { |gr| :"version:#{gr}:push" }
  end
end

#version_show_task ⇒ Object 



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/gem_hadar.rb', line 335

def version_show_task
  namespace :version do
    desc m = "Displaying the current version"
    task :show do
      require path_name
      dir = File.join('lib', path_name)
      version_file = File.join(dir, 'version.rb')
      m = Module.new
      m.instance_eval File.read(version_file)
      version_rb   = m.const_get(
        [ path_module, 'VERSION' ] * '::'
      )
      equal        = version == version_rb ? '==' : '!='
      puts "version.rb=#{version_rb} #{equal} VERSION=#{version}"
    end
  end
end

#version_tag_task ⇒ Object 



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
 
# File 'lib/gem_hadar.rb', line 529

def version_tag_task
  namespace :version do
    desc "Tag this commit as version #{version}"
    task :tag do
      force = ENV['FORCE'].to_i == 1
      begin
        sh "git tag -a -m 'Version #{version}' #{'-f' if force} v#{version}"
      rescue RuntimeError
        if `git diff v#{version}..HEAD`.empty?
          puts "Version #{version} is already tagged, but it's no different"
        else
          if ask?("Different version tag #{version} already exists. Overwrite with "\
              "force? (yes/NO) ", /\Ayes\z/i)
            force = true
            retry
          else
            exit 1
          end
        end
      end
    end
  end
end

#version_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 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 



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/gem_hadar.rb', line 481

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 



475
476
477
478
479
 
# File 'lib/gem_hadar.rb', line 475

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

#yard_task ⇒ Object 



696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/gem_hadar.rb', line 696

def yard_task
  defined? YARD or return
  namespace :yard do
    yard_dir = Pathname.new('yard')

    desc 'Create yard documentation (including private)'
    task :private do
      sh "yardoc -o #{yard_dir}"
    end

    desc 'View the yard documentation'
    task :view do
      index_file = yard_dir + 'index.html'
      File.exist?(index_file)
      sh "open #{index_file}"
    end

    desc 'Clean the yard documentation'
    task :clean do
      rm_rf yard_dir
    end

    desc 'List all undocumented classes/modules/methods'
    task :'list-undoc' do
      sh "yard stats --list-undoc"
    end
  end

  desc 'Create the yard documentation and view it'
  task :yard => %i[ yard:private yard:view ]
end