easycompile 1.0.6

data/lib/easycompile/constants/constants.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file gets included into base.rb of module Easycompile.
+# =========================================================================== #
+# require 'easycompile/constants/constants.rb'
+# include Easycompile::Constants
+# =========================================================================== #
+require 'easycompile/project/project.rb'
+require 'easycompile/constants/array_possible_archives.rb'
+require 'easycompile/constants/file_and_directory_constants.rb'
+require 'easycompile/constants/misc.rb'
+require 'easycompile/constants/namespace.rb'
+require 'easycompile/constants/programs_directory.rb'
+
+module Easycompile
+
+module Constants # === Easycompile::Constants
+
+end; end

data/lib/easycompile/constants/file_and_directory_constants.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'easycompile/constants/file_and_directory_constants.rb'
+# =========================================================================== #
+require 'easycompile/project/project.rb'
+
+module Easycompile
+
+module Constants # === Easycompile::Constants
+
+  # ========================================================================= #
+  # === MESON_BUILD_FILE
+  #
+  # Refer to the name of the default meson-build file, which is
+  # meson.build.
+  # ========================================================================= #
+  MESON_BUILD_FILE = 'meson.build'
+
+  # ========================================================================= #
+  # === CMAKE_FILE
+  #
+  # Refer to the name of the default cmake-file, which is called
+  # CMakeLists.txt.
+  # ========================================================================= #
+  CMAKE_FILE = 'CMakeLists.txt'
+
+  # ========================================================================= #
+  # === FILE_NAME_OF_THE_BUILD_DIRECTORY
+  # ========================================================================= #
+  FILE_NAME_OF_THE_BUILD_DIRECTORY =
+    "#{PROJECT_BASE_DIRECTORY}yaml/name_of_the_build_directory.yml"
+
+  # ========================================================================= #
+  # === LAST_DOWNLOADED_FILE
+  # ========================================================================= #
+  LAST_DOWNLOADED_FILE = "#{ENV['HOME']}/LAST_DOWNLOADED_FILE.md"
+
+  # ========================================================================= #
+  # === INDIVIDUAL_COOKBOOKS
+  #
+  # This will currently use a hardcoded path, which is only useful on
+  # my home setup..
+  # ========================================================================= #
+  INDIVIDUAL_COOKBOOKS =
+    '/home/x/DATA/PROGRAMMING_LANGUAGES/RUBY/src/'\
+    'rbt/lib/rbt/yaml/cookbooks/'
+
+  # ========================================================================= #
+  # === RUBY_SRC
+  #
+  # This constant is guaranteed to have the last character a '/'. It is
+  # only useful on my home setup, though - other users won't need this
+  # constant.
+  # ========================================================================= #
+  if ENV['RUBY_SRC']
+    RUBY_SRC = ENV['RUBY_SRC'].to_s+'/'
+  else
+    RUBY_SRC = '/home/x/DATA/PROGRAMMING_LANGUAGES/RUBY/src/'
+  end
+
+  # ========================================================================= #
+  # === ruby_src?
+  # ========================================================================= #
+  def ruby_src?
+    RUBY_SRC
+  end
+
+  # ========================================================================= #
+  # === LOCATION_OF_SETUP_RB
+  #
+  # We can simply make use of the RUBY_SRC constant here.
+  # ========================================================================= #
+  LOCATION_OF_SETUP_RB =
+    "#{RUBY_SRC}roebe/lib/roebe/setup/setup.rb"
+
+  # ========================================================================= #
+  # === SRC_DIR
+  #
+  # This constant is guaranteed to have the last character a '/'.
+  # ========================================================================= #
+  if ENV['SRC_DIR']
+    SRC_DIR = ENV['SRC_DIR'].to_s+'/'
+  else
+    SRC_DIR = '/home/x/src/'
+  end
+
+  # ========================================================================= #
+  # === source_dir?
+  # ========================================================================= #
+  def source_dir?
+    SRC_DIR
+  end; alias src_dir? source_dir? # === src_dir?
+
+  # ========================================================================= #
+  # === TEMP_DIR
+  # ========================================================================= #
+  if ENV['MY_TEMP']
+    TEMP_DIR = ENV['MY_TEMP'].to_s.dup+'/'
+  elsif Dir.exist? '/home/Temp'
+    TEMP_DIR = '/home/Temp/'
+  else
+    TEMP_DIR = '/tmp/'
+  end
+
+  # ========================================================================= #
+  # === temp_dir?
+  # ========================================================================= #
+  def self.temp_dir?
+    TEMP_DIR
+  end; self.instance_eval { alias temp_directory? temp_dir? } # === Easycompile::Constants.temp_directory?
+
+end
+
+# =========================================================================== #
+# === Easycompile.temp_dir?
+# =========================================================================== #
+def self.temp_dir?
+  Constants::TEMP_DIR
+end; self.instance_eval { alias temp_directory? temp_dir? } # === Easycompile.temp_directory?
+
+# =========================================================================== #
+# === Easycompile.source_dir?
+# =========================================================================== #
+def self.source_dir?
+  Constants::SRC_DIR
+end; self.instance_eval { alias src_dir? source_dir? } # === Easycompile.src_dir?
+
+# =========================================================================== #
+# === Easycompile.ruby_src_dir?
+# =========================================================================== #
+def self.ruby_src_dir?
+  Constants::RUBY_SRC
+end; self.instance_eval { alias ruby_src? ruby_src_dir? } # === Easycompile.ruby_src?
+
+end

data/lib/easycompile/constants/misc.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'easycompile/constants/misc.rb'
+# =========================================================================== #
+module Easycompile
+
+module Constants # === Easycompile::Constants
+
+  # ========================================================================= #
+  # === ERROR_LINE
+  # ========================================================================= #
+  ERROR_LINE = ' 2>&1'.freeze
+
+  # ========================================================================= #
+  # === SHALL_WE_CREATE_A_BUILD_DIRECTORY
+  #
+  # If true then we will create a build directory called "BUILD".
+  # ========================================================================= #
+  SHALL_WE_CREATE_A_BUILD_DIRECTORY = false
+
+end; end

data/lib/easycompile/constants/namespace.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'easycompile/constants/namespace.rb'
+# =========================================================================== #
+module Easycompile
+
+module Constants # === Easycompile::Constants
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = 'Easycompile' # The toplevel namespace. Easycompile::Constants::NAMESPACE
+
+end; end

data/lib/easycompile/constants/programs_directory.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'easycompile/constants/programs_directory.rb'
+# =========================================================================== #
+module Easycompile
+
+module Constants # === Easycompile::Constants
+
+  # ========================================================================= #
+  # === PROGRAMS_DIRECTORY
+  # ========================================================================= #
+  if ENV['MY_PROGRAMS']
+    PROGRAMS_DIRECTORY = ENV['MY_PROGRAMS'].to_s+'/'
+  else
+    PROGRAMS_DIRECTORY = '/home/Programs/'
+  end
+
+end
+
+# =========================================================================== #
+# === @programs_directory
+#
+# This toplevel instance variable keeps track of the programs directory
+# in use for easycompile.
+# =========================================================================== #
+@programs_directory = Constants::PROGRAMS_DIRECTORY
+
+# =========================================================================== #
+# === Easycompile.set_programs_directory
+# =========================================================================== #
+def self.set_programs_directory(i)
+  i = i.dup if i.frozen?
+  i << '/' unless i.end_with? '/'
+  @programs_directory = i
+end
+
+# =========================================================================== #
+# === Easycompile.programs_directory?
+# =========================================================================== #
+def self.programs_directory?
+  @programs_directory
+end; self.instance_eval { alias programs_dir? programs_directory? } # === Easycompile.programs_dir?
+
+end

data/lib/easycompile/easycompile/easycompile.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Easycompile::Easycompile
+#
+# This will extract an archive, then compile into the given prefix,
+# which defaults to /usr/ for this class.
+# =========================================================================== #
+require 'easycompile/base/easycompile.rb'
+
+module Easycompile # === Easycompile::Easycompile
+
+class Easycompile < Base
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # We can use more advanced compile instructions such as:
+  #
+  #   Easycompile::Easycompile.new(i, extract_to: EXTRACT_TO)
+  #
+  # The first argument is the name of the program in question.
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true,
+      &block
+    )
+    set_prefix '/usr' # This is the default prefix anyway.
+    super(i, :dont_run_yet)
+    if run_already.is_a? Hash
+      set_hash(run_already) # Here the prefix can be overruled.
+      run_already = true
+    end
+    if i.is_a? Array
+      i = i.first
+    end
+    if i.end_with? '.yml'
+      i = return_yaml_file(i)
+      set_original_input(i)
+    end
+    # ======================================================================= #
+    # === Handle blocks next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      # ===================================================================== #
+      # === Handle Hashes next
+      # ===================================================================== #
+      if yielded.is_a? Hash
+        # =================================================================== #
+        # === { :prefix => :appdir }
+        #
+        # This is the default entry point for programs that are compiled
+        # via an AppDir prefix.
+        # =================================================================== #
+        if yielded.has_key? :prefix
+          set_prefix(
+            yielded[:prefix]
+          )
+        end
+      end
+    end
+    set_original_input(i)
+    run if run_already # Call the parent method.
+  end
+
+  # ========================================================================= #
+  # === Easycompile[]
+  # ========================================================================= #
+  def self.[](i)
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Easycompile::Easycompile.new(ARGV)
+end # ecompile

data/lib/easycompile/project/project.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'easycompile/project/project.rb'
+# =========================================================================== #
+module Easycompile
+
+  # ========================================================================= #
+  # === Easycompile::PROJECT_BASE_DIRECTORY
+  # ========================================================================= #
+  PROJECT_BASE_DIRECTORY = 
+    File.absolute_path("#{__dir__}/..")+'/'
+
+  # ========================================================================= #
+  # === Easycompile::PROJECT_BASE_DIR
+  #
+  # This is simply an "alias" to the above constant.
+  # ========================================================================= #
+  PROJECT_BASE_DIR = PROJECT_BASE_DIRECTORY
+  
+  # ========================================================================= #
+  # === Easycompile.project_base_dir?
+  # ========================================================================= #
+  def self.project_base_dir?
+    PROJECT_BASE_DIRECTORY
+  end
+
+end

data/lib/easycompile/requires/require_the_easycompile_project.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'easycompile/requires/require_the_easycompile_project.rb'
+# =========================================================================== #
+require 'easycompile/constants/constants.rb'
+require 'easycompile/project/project.rb'
+require 'easycompile/version/version.rb'
+require 'easycompile/base/easycompile.rb'
+require 'easycompile/requires/require_the_toplevel_methods.rb'
+require 'easycompile/easycompile/easycompile.rb'
+require 'easycompile/compile_as_appdir/compile_as_appdir.rb'

data/lib/easycompile/requires/require_the_toplevel_methods.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'easycompile/requires/require_the_toplevel_methods.rb'
+# =========================================================================== #
+require 'easycompile/project/project.rb'
+
+Dir["#{Easycompile.project_base_dir?}toplevel_methods/*.rb"].each {|this_file|
+  require "easycompile/toplevel_methods/#{File.basename(this_file)}"
+}

data/lib/easycompile/toplevel_methods/copy_file.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'easycompile/toplevel_methods/copy_file.rb'
+# =========================================================================== #
+module Easycompile
+
+  require 'fileutils'
+
+  # ========================================================================= #
+  # === Easycompile.copy_file
+  #
+  # The second argument to this method specifies the target-location
+  # where the file should be copied onto.
+  # ========================================================================= #
+  def self.copy_file(
+      from, to = Dir.pwd
+    )
+    FileUtils.cp(from, to)
+  end
+
+end

data/lib/easycompile/toplevel_methods/misc.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Here we collect methods which are directly available on the module
+# level of the project.
+# =========================================================================== #
+# require 'easycompile/toplevel_methods/misc.rb'
+# =========================================================================== #
+module Easycompile
+
+  require 'easycompile/constants/constants.rb'
+  # ========================================================================= #
+  # We wish to include these constants onto the toplevel module next.
+  # ========================================================================= #
+  include Easycompile::Constants
+
+  require 'easycompile/easycompile/easycompile.rb'
+  require 'easycompile/compile_as_appdir/compile_as_appdir.rb'
+  # ========================================================================= #
+  # === Easycompile.compile
+  #
+  # This method must be able to tap into CompileAsAppdir, as well
+  # as invoke Easycompile, so both .rb files are required here.
+  #
+  # If no input is given then a random entry will be fetched.
+  #
+  # Invocation example:
+  #
+  #   Easycompile.compile('wv.yml', :appdir)
+  #
+  # ========================================================================= #
+  def self.compile(
+      i = nil, optional_compile_as_appdir = false
+    )
+    if i.nil?
+      i = try_to_randomly_fetch_an_archive_from_the_current_directory
+    end
+    case optional_compile_as_appdir
+    when :appdir
+      # ===================================================================== #
+      # Make it more explicit in this case.
+      # ===================================================================== #
+      optional_compile_as_appdir = true
+    end
+    if optional_compile_as_appdir
+      ::Easycompile::CompileAsAppdir[i]
+    else
+      ::Easycompile::Easycompile.new(i)
+    end
+  end; self.instance_eval { alias easycompile compile } # === Easycompile.easycompile
+       self.instance_eval { alias []          compile } # === Easycompile[]
+
+end