Rakefile

# -*- mode: ruby; -*-
#
# Rakefile - This file is part of the RubyTree package.
#
# Copyright (c) 2006-2022  Anupam Sengupta
#
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# - Redistributions of source code must retain the above copyright notice, this
#   list of conditions and the following disclaimer.
#
# - Redistributions in binary form must reproduce the above copyright notice,
#   this list of conditions and the following disclaimer in the documentation
#   and/or other materials provided with the distribution.
#
# - Neither the name of the organization nor the names of its contributors may
#   be used to endorse or promote products derived from this software without
#   specific prior written permission.
#
#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
#
# frozen_string_literal: true

require 'rubygems'

# @todo: Check if Bundler needs to be `require`d.
GEM_SPEC = Bundler.load_gemspec(File.join(__dir__, 'rubytree.gemspec'))

PKG_NAME = GEM_SPEC.name
PKG_VER  = GEM_SPEC.version
GEM_NAME = "#{PKG_NAME}-#{PKG_VER}.gem"

desc 'Default Task (Run the tests)'
task :default do
  if ENV['COVERAGE']
    Rake::Task['test:coverage'].invoke
  else
    Rake::Task['test:unit'].invoke
    Rake::Task['spec'].invoke
  end
end

desc 'Display the current gem version'
task :version do
  puts "Current Version: #{GEM_NAME}"
end

require 'rake/clean'
desc 'Remove all generated files.'
task clean: 'gem:clobber_package'
CLEAN.include('coverage')
task clobber: [:clean, 'doc:clobber_rdoc', 'doc:clobber_yard']

desc 'Open an irb session preloaded with this library'
task :console do
  sh 'irb -rubygems -r ./lib/tree.rb'
end

namespace :doc do # ................................ Documentation
  begin
    gem 'rdoc', '>= 6.4.0' # To get around a stupid bug in Ruby 1.9.2 Rake.
    require 'rdoc/task'
    Rake::RDocTask.new do |rdoc|
      rdoc.rdoc_dir = 'rdoc'
      rdoc.title    = "RubyTree Documenation: #{PKG_NAME}-#{PKG_VER}"
      rdoc.main     = 'README.md'
      rdoc.rdoc_files.include(GEM_SPEC.extra_rdoc_files)
      rdoc.rdoc_files.include('./lib/**/*.rb')
    end
  rescue LoadError
    # Oh well.
  end

  begin
    require 'yard'
    YARD::Rake::YardocTask.new do |t|
      t.files   = ['lib/**/*.rb', '-', GEM_SPEC.extra_rdoc_files]
      t.options = %w[--no-private --embed-mixins]
    end
  rescue LoadError
    # Oh well.
  end

  desc 'Remove YARD Documentation'
  task :clobber_yard do
    rm_rf 'doc'
  end
end

desc 'Run the unit tests'
task test: %w[test:unit]

# ................................ Test related
namespace :test do
  desc 'Run all the tests'
  task all: %w[test:unit test:spec test:examples]

  require 'rake/testtask'
  Rake::TestTask.new(:unit) do |test|
    test.libs << 'lib' << 'test'
    test.pattern = 'test/**/test_*.rb'
    test.verbose = false
  end

  # ................................ rspec tests
  begin
    require 'rspec/core/rake_task'

    RSpec::Core::RakeTask.new(:spec) do |t|
      t.fail_on_error = false
      t.rspec_opts = ['--color', '--format doc']
    end
  rescue LoadError
    # Cannot load rspec.
  end

  desc 'Run the examples'
  Rake::TestTask.new(:examples) do |example|
    example.libs << 'lib' << 'examples'
    example.pattern = 'examples/**/example_*.rb'
    example.verbose = true
    example.warning = false
  end

  desc 'Run the code coverage'
  task :coverage do
    ruby 'test/run_test.rb'
  end
end

# ................................ Emacs Tags
namespace :tag do
  require 'rtagstask'
  RTagsTask.new(:tags) do |rd|
    rd.vi = false
    CLEAN.include('TAGS')
  end
rescue LoadError
  # Oh well. Can't have everything.
end

# ................................ Gem related
namespace :gem do
  require 'rubygems/package_task'
  Gem::PackageTask.new(GEM_SPEC) do |pkg|
    pkg.need_zip = true
    pkg.need_tar = true
  end

  desc 'Push the gem into the Rubygems repository'
  task push: :gem do
    sh "gem push pkg/#{GEM_NAME}"
  end
end

# ................................ Ruby linting
require 'rubocop/rake_task'

RuboCop::RakeTask.new(:rubocop) do |t|
  t.options = ['--display-cop-names']
  t.requires << 'rubocop-rake'
  t.requires << 'rubocop-rspec'
end