easycompile 1.0.6

data/lib/easycompile.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'easycompile/requires/require_the_easycompile_project.rb'

data/lib/easycompile/base/change_directory.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'easycompile/base/change_directory.rb'
+# =========================================================================== #
+module Easycompile
+
+class Base
+
+  # ========================================================================= #
+  # === change_directory                                             (cd tag)
+  #
+  # Use this method when changing directories.
+  # ========================================================================= #
+  def change_directory(i)
+    if i
+      File.expand_path(i) if i.start_with? '.'
+      if File.exist?(i)
+        Dir.chdir(i)
+      else
+        show_namespace
+        e "Can not change into #{sdir(i)} as it does not exist."
+      end
+    end
+  end; alias cd change_directory # === cd
+
+end; end

data/lib/easycompile/base/cmake.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'easycompile/base/cmake.rb'
+# =========================================================================== #
+module Easycompile 
+
+class Base
+
+  # ========================================================================= #
+  # === cmake_file?
+  #
+  # This method wille ssentially refer to "CMakeLists.txt".
+  # ========================================================================= #
+  def cmake_file?
+    CMAKE_FILE
+  end
+
+  # ========================================================================= #
+  # === run_cmake_command                                         (cmake tag)
+  #
+  # Compiling via cmake can yield errors. We will try to capture such
+  # an error.
+  #
+  # Note that cmake-based projects typically require a dedicated build
+  # directory - this is why the method do_make_use_of_a_build_directory()
+  # is called within this method.
+  #
+  # cmake -DCMAKE_INSTALL_PREFIX=/usr
+  # ========================================================================= #
+  def run_cmake_command
+    do_make_use_of_a_build_directory
+    _ = 'cmake'.dup
+    # ======================================================================= #
+    # Next, we will use the install prefix.
+    # ======================================================================= #
+    _ << " -DCMAKE_INSTALL_PREFIX=#{prefix?}"
+    _ << ' .'
+    _ << '.' if shall_we_create_a_build_directory? # Append this.
+    if shall_we_create_a_build_directory?
+      use_this_name = name_of_build_directory?
+      unless File.directory?(use_this_name)
+        opn; e "Next creating the build directory called `"\
+               "#{sdir(use_this_name)}`."
+        mkdir(use_this_name)
+      end
+      cd use_this_name
+    end
+    esystem _
+  end; alias run_cmake run_cmake_command # === run_cmake
+
+end; end

data/lib/easycompile/base/colours.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# By default we will try to use colours, even if the default value
+# for the toplevel instance variable @can_we_use_colours is set to
+# false - it will typically become true at a later point, in this
+# file.
+# =========================================================================== #
+# require 'easycompile/base/colours.rb'
+# =========================================================================== #
+module Easycompile
+
+# =========================================================================== #
+# === @can_we_use_colours
+# =========================================================================== #
+@can_we_use_colours = false
+
+# =========================================================================== #
+# === Easycompile.set_can_we_use_colours
+# =========================================================================== #
+def self.set_can_we_use_colours(i = true)
+  @can_we_use_colours = i
+end; self.instance_eval { alias can_we_use_colours= set_can_we_use_colours } # === Easycompile.can_we_use_colours=
+
+# =========================================================================== #
+# === Easycompile.can_we_use_colours?
+# =========================================================================== # 
+def self.can_we_use_colours?
+  @can_we_use_colours
+end
+
+class Base # === Easycompile::Base
+
+  begin
+    require 'colours'
+    ::Easycompile.can_we_use_colours = true
+  rescue LoadError
+    ::Easycompile.can_we_use_colours = false
+  end
+
+  if ::Easycompile.can_we_use_colours?
+    include Colours
+  else
+    alias e puts
+  end
+
+  # ========================================================================= #
+  # === use_colours?
+  # ========================================================================= #
+  def use_colours?
+    ::Easycompile.can_we_use_colours?
+  end
+
+  # ========================================================================= #
+  # === rev
+  # ========================================================================= #
+  def rev
+    if use_colours?
+      ::Colours.rev
+    else
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === e_colourize
+  # ========================================================================= #
+  def e_colourize(i)
+    if use_colours?
+      e sfancy(i)
+    else
+      e i
+    end
+  end
+
+  # ========================================================================= #
+  # === ecomment
+  # ========================================================================= #
+  def ecomment(i)
+    if use_colours?
+      ::Colours.ecomment(i)
+    else
+      i
+    end
+  end
+
+end; end

data/lib/easycompile/base/commandline_arguments.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'easycompile/base/commandline_arguments.rb'
+# =========================================================================== #
+module Easycompile 
+
+class Base
+
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(i)
+    @commandline_arguments = [i].flatten.compact
+  end
+
+  # ========================================================================= #
+  # === return_all_arguments_with_hyphens
+  #
+  # This method will select all commandline arguments that begin with
+  # two -- hyphens.
+  # ========================================================================= #
+  def return_all_arguments_with_hyphens
+    @commandline_arguments.select {|entry|
+      entry.start_with? '--'
+    }
+  end
+
+end; end

data/lib/easycompile/base/constants.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'easycompile/base/constants.rb'
+# =========================================================================== #
+require 'easycompile/constants/constants.rb'
+
+module Easycompile
+
+class Base # === Easycompile::Base
+
+  include ::Easycompile::Constants
+
+  # ========================================================================= #
+  # === THIS_FILE
+  #
+  # This constant refers to the main .rb file for class Easycompile::Base,
+  # that is the file that contains most of the ruby code for the Base
+  # class.
+  # ========================================================================= #
+  THIS_FILE = "#{PROJECT_BASE_DIR}base/misc.rb"
+
+end; end

data/lib/easycompile/base/easycompile.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Easycompile::Base
+#
+# This file will handle the installation of gems, which is the
+# ruby-addon stuff.
+# =========================================================================== #
+# require 'easycompile/base/easycompile.rb'
+# =========================================================================== #
+require 'easycompile/base/change_directory.rb'
+require 'easycompile/base/cmake.rb'
+require 'easycompile/base/constants.rb'
+require 'easycompile/base/initialize.rb'
+require 'easycompile/base/gem.rb'
+require 'easycompile/base/menu.rb'
+require 'easycompile/base/meson_and_ninja.rb'
+require 'easycompile/base/misc.rb'
+require 'easycompile/base/opn.rb'
+require 'easycompile/base/reset.rb'
+require 'easycompile/base/run.rb'

data/lib/easycompile/base/esystem.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'easycompile/base/esystem.rb'
+# =========================================================================== #
+module Easycompile
+
+class Base
+
+  require 'easycompile/constants/misc.rb'
+  # ========================================================================= #
+  # === esystem
+  #
+  # Run a colourized system() command here.
+  #
+  # This can either be through oldschool system(), or as of August 2017,
+  # preferentially via IO.popen().
+  # ========================================================================= #
+  def esystem(i)
+    e_colourize(i) # Output it here already.
+    i = i.dup if i.frozen?
+    i << ERROR_LINE
+    @result = i # Not in use right now.
+    internal_system(i) # Defined in this file here.
+  end; alias _ esystem # === _
+
+  # ========================================================================= #
+  # === cparser_is_available?
+  #
+  # Determine whether we can use the ColourizeParser from the RBT
+  # project.
+  # ========================================================================= #
+  def cparser_is_available?
+    Object.const_defined?(:RBT) and
+    RBT.const_defined?(:ColourizeParser)
+  end
+
+  # ========================================================================= #
+  # === internal_system
+  #
+  # The key idea for this method is to handle system()-related calls
+  # via IO.popen(). This gives us more control over as to what to
+  # do with the given input and output.
+  # ========================================================================= #
+  def internal_system(i)
+    cparser_is_available = cparser_is_available?
+    cparser = @colourize_parser if cparser_is_available
+    io_object = IO.popen(i, :err => [:child, :out]).each { |line|
+      if cparser_is_available
+        cparser.grab_this_line(line) # The cparser object will deal with colours.
+        line = cparser.line?
+      end
+      e line # Output here.
+    }
+    io_object.close # Close it here.
+  end
+
+end; end

data/lib/easycompile/base/gem.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file will handle the installation of gems, which is the
+# ruby-addon stuff.
+# =========================================================================== #
+# require 'easycompile/base/gem.rb'
+# =========================================================================== #
+module Easycompile
+
+class Base
+
+  require 'easycompile/base/esystem.rb'
+  # ========================================================================= #
+  # === install_this_gem
+  #
+  # Consistently use this method when trying to install a gem.
+  #
+  # We will ignore the dependencies, though, to speed up the
+  # installation process.
+  # ========================================================================= #
+  def install_this_gem(i)
+    _ = "gem install --ignore-dependencies #{i}"
+    esystem(_)
+  end
+
+  # ========================================================================= #
+  # === is_a_gem?
+  # ========================================================================= #
+  def is_a_gem?(i)
+    i.end_with? '.gem'
+  end
+
+end; end

data/lib/easycompile/base/help.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'easycompile/base/help.rb'
+# =========================================================================== #
+module Easycompile
+
+class Base
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  # ========================================================================= #
+  def show_help(optional_shall_we_exit = false)
+    if optional_shall_we_exit == :then_exit
+      optional_shall_we_exit = true
+    end
+    e
+    opn_namespace; e 'Documented help options are these here:'
+    opn_namespace; e
+    opn_namespace; ecomment '  --appdir                   # Compile as Appdir, into '\
+                   'its own prefix.'
+    opn_namespace; ecomment '  --remove-all-after-compile # Remove '\
+                   'the archive after compilation is done.'
+    opn_namespace; ecomment '  --with-deps                '\
+                   '# Compile with dependencies.'
+    opn_namespace; ecomment '  --extract-to=/Depot/opt/  '\
+                   '# extract to that particular directory.'
+    opn_namespace; ecomment '  --homedir                  # '\
+                            'Compile into the home-directory as prefix'
+    opn_namespace; e
+    exit if optional_shall_we_exit
+  end
+
+end; end

data/lib/easycompile/base/initialize.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'easycompile/base/initialize.rb'
+# =========================================================================== #
+module Easycompile
+
+class Base
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    case run_already
+    # ======================================================================= #
+    # === :dont_run_yet
+    # ======================================================================= #
+    when :dont_run_yet,
+         :do_not_run_yet
+      run_already = false
+    end
+    run if run_already
+  end
+
+end; end

data/lib/easycompile/base/menu.rb

@@ -0,0 +1,140 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'easycompile/base/menu.rb'
+# =========================================================================== #
+module Easycompile
+
+class Base
+
+  # ========================================================================= #
+  # === menu
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i
+      # ===================================================================== #
+      # === ecompile --home_dir
+      # ===================================================================== #
+      when /^-?-?home(_|-)?dir$/,
+           /^-?-?home(_|-)?directory$/,
+           /^-?-?home$/
+        set_prefix(:home_directory)
+      # ===================================================================== #
+      # === ecompile --help
+      #
+      # This option allows us to show the available help options, on
+      # the commandline.
+      # ===================================================================== #
+      when /^-?-?help$/i,
+           /^-?h$/i
+        show_help :then_exit
+      # ===================================================================== #
+      # === easycompile --homedir
+      # ===================================================================== #
+      when /^-?-?home(_|-)?dir$/i
+        use_the_home_directory_as_prefix
+      # ===================================================================== #
+      # === easycompile --OPEN_ITSELF
+      # ===================================================================== #
+      when /^-?-?OPEN(_|-)?ITSELF$/i,
+           /^-?-?OPEN$i/ # OPEN_SELF
+        open_this_file
+        exit
+      # ===================================================================== #
+      # === ALL
+      # ===================================================================== #
+      when /^-?-?all$/i,
+           /^-?-?everything$/i
+        set_compile_these_programs Dir['*']
+      # ===================================================================== #
+      # === --remove-all-after-compile
+      # ===================================================================== #
+      when /^-?-?remove(_|-| )?all(_|-| )?after(_|-| )?compile$/i
+        do_remove_all_after_compile
+      # ===================================================================== #
+      # === set_extract_to
+      #
+      # This entry allows us to define a custom temp-directory.
+      #
+      # Invocation example:
+      #
+      #   ecompile php* --extract-to=/Depot/opt/
+      #
+      # ===================================================================== #
+      when /^-?-?set(_|-| )?extract(_|-| )?to=(.+)$/i, # $3
+           /^-?-?extract(_|-| )?to=(.+)$/i  # $2
+        _ = $2
+        _ = $3.to_s.dup if $3
+        set_extract_to(_) { :be_verbose }
+      # ===================================================================== #
+      # === ecompile --sco
+      #
+      # Invocation example:
+      #
+      #   ecompile --sco php*xz
+      #
+      # ===================================================================== #
+      when /^-?-?sco$/i,
+           /^-?-?extended-configure-options$/i,
+           /^-?-?use-configure-options$/i
+        @try_to_use_extended_configure_options = true
+      # ===================================================================== #
+      # === --wdeps
+      # ===================================================================== #
+      when /^-?-?wdeps$/i,
+           /^-?-?with(_|-| )?deps$/i
+        do_compile_with_dependencies
+      # ===================================================================== #
+      # === --skipmakeinstall
+      # ===================================================================== #
+      when /^-?-?SKIP_?MAKE_?INSTALL/i,
+           'NO_MAKE_INSTALL',
+           'NOMAKEINSTALL',
+           'NOINSTALL',
+           'SKIPINSTALL'
+        enable_skip_make_install # Skip the "make install" step.
+      # ===================================================================== #
+      # === --dontcompile
+      # ===================================================================== #
+      when /^-?-?DONT(_|-| )?COMPILE$/i
+        enable_dont_compile
+      # ===================================================================== #
+      # === --skip_extracting
+      # ===================================================================== #
+      when 'SKIP_EXTRACT',
+           /^-?-?SKIP(_|-| )?EXTRACTING$/i,
+           'SKIPEXTRACTING'
+        skip_extracting
+      # ===================================================================== #
+      # === --appdir
+      # ===================================================================== #
+      when /^-?-?appdir$/i
+        set_prefix :appdir
+        opn; e 'Will compile as AppDir. The prefix now is '+simp(prefix?.to_s)
+      else # else tag
+        if File.exist?(i) or i.end_with?('.yml')
+          add_this_archive(i)
+        else
+          # ================================================================= #
+          # Next, we will attempt to find a valid entry. 
+          # ================================================================= #
+          i = attempt_to_find_a_valid_file(i)
+          if i.respond_to?(:select)
+            add_these_files(
+              i.select {|file|
+                File.exist? file.to_s
+              }
+            )
+          end
+        end
+      end
+    end
+  end
+
+end; end