symlink 0.0.29

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9214d75d8fd31c8d6d1985d2cb442d333580337428cec19766db16c859b7722
+  data.tar.gz: dbe997101df9a182490baf53a26fc8c1f7c813ffa5897a340d44c9ede4478910
+SHA512:
+  metadata.gz: be40aa34226d315978dd1492092a8e3c885857c4e0071e229ddea7ddd5aa7a0a46b6583012726063fcaee3b1fdd2a64a8b841669c2a2f647f7d49c56a68a69f0
+  data.tar.gz: 4962b35584df6b22cc51abd694365246e8f2b03bdc8e204cea9746c01cfee9ed4fad61022a0973ea92ac6a1eaaeb659b56c8cd3fde7e315868bc3806dc57f033

data/lib/symlink/constants.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+class Symlink
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === USE_ABSOLUTE_SYMLINKING
+  # ========================================================================= #
+  USE_ABSOLUTE_SYMLINKING = false
+
+end

data/lib/symlink/symlink.rb

@@ -0,0 +1,345 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Symlink
+#
+# This general class will allow you to symlink one target to the other.
+#
+# Usage example:
+#
+#   Symlink.new
+#
+# =========================================================================== #
+# require 'symlink/symlink.rb'
+# =========================================================================== #
+class Symlink # === Symlink
+
+  require 'fileutils'
+  require 'opn'
+  # ========================================================================= #
+  # Add a few colours for support:
+  # ========================================================================= #
+  require 'colours/e/e.rb'
+  require 'colours/requires/require_the_colour_methods.rb'
+  # ========================================================================= #
+  # And next pull in .rb files that are specific for Symlink:
+  # ========================================================================= #
+  require 'symlink/version/version.rb'
+  require 'symlink/constants.rb'
+
+  include Colours::E
+  
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      old_existing_location,
+      new_location,
+      be_verbose  = true,
+      run_already = true
+    )
+    reset
+    set_existing_location(old_existing_location) # from
+    set_new_location(new_location)               # to
+    set_be_verbose(be_verbose) # Whether we are silent or not.
+    if block_given?
+      yielded = yield
+      if yielded.is_a? Hash
+        # === prepend_this_to_namespace
+        if yielded.has_key? :prepend_this_to_namespace
+          prepend_this_to_namespace(yielded.delete(:prepend_this_to_namespace))
+        end
+      end
+    end
+    case run_already
+    when :do_not_run_yet
+      run_already = false
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # === @use_absolute_symlinking
+    @use_absolute_symlinking = USE_ABSOLUTE_SYMLINKING
+    # === @use_opn
+    @use_opn     = true
+    # === @be_verbose
+    @be_verbose  = true
+    @use_colours = true
+    @namespace   = NAMESPACE # This can be changed.
+  end
+
+  # ========================================================================= #
+  # === prepend_this_to_namespace
+  # ========================================================================= #
+  def prepend_this_to_namespace(i)
+    @namespace.prepend(i.to_s.dup)
+  end
+
+  # ========================================================================= #
+  # === shall_we_use_colours?
+  #
+  # This method requires one mandatory argument.
+  # ========================================================================= #
+  def shall_we_use_colours?(true_or_false)
+    if true_or_false == false
+      disable_colours
+    else
+      enable_colours
+    end
+  end
+
+  # ========================================================================= #
+  # === disable_colours
+  # ========================================================================= #
+  def disable_colours
+    @use_colours = false
+  end
+
+  # ========================================================================= #
+  # === enable_colours
+  # ========================================================================= #
+  def enable_colours
+    @use_colours = true
+  end
+
+  # ========================================================================= #
+  # === use_colours?
+  # ========================================================================= #
+  def use_colours?
+    @use_colours
+  end
+
+  # ========================================================================= #
+  # === use_absolute_symlinking
+  # ========================================================================= #
+  def use_absolute_symlinking
+    @use_absolute_symlinking = true
+    # ======================================================================= #
+    # We must also sync @existing_location.
+    # ======================================================================= #
+    set_existing_location(existing?)
+  end
+
+  # ========================================================================= #
+  # === set_be_verbose
+  # ========================================================================= #
+  def set_be_verbose(i)
+    @be_verbose = i
+  end
+
+  # ========================================================================= #
+  # === use_absolute_symlinking?
+  # ========================================================================= #
+  def use_absolute_symlinking?
+    @use_absolute_symlinking
+  end
+
+  # ========================================================================= #
+  # === set_existing_location
+  #
+  # This must be an existing file.
+  # ========================================================================= #
+  def set_existing_location(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    i = rds(i)
+    if use_absolute_symlinking?
+      i = "../../../..#{i}"
+    end
+    @existing_location = i
+  end; alias set_old_target set_existing_location # === set_old_target
+    
+  # ========================================================================= #
+  # === delete
+  #
+  # This will only ever delete files, not directories.
+  # ========================================================================= #
+  def delete(i)
+    i = i.dup if i.frozen?
+    i.strip!
+    if (rds(i) == '/')
+      ewarn 'We can never delete /'
+    else
+      File.delete(i)
+    end
+  end; alias remove delete # === remove
+
+  # ========================================================================= #
+  # === be_verbose?
+  # ========================================================================= #
+  def be_verbose?
+    @be_verbose
+  end
+
+  # ========================================================================= #
+  # === rds
+  # ========================================================================= #
+  def rds(i)
+    i.squeeze('/')
+  end
+
+  # ========================================================================= #
+  # === set_new_location
+  # ========================================================================= #
+  def set_new_location(i = '')
+    i = i.to_s.dup
+    i = rds(i)
+    @new_location = i
+  end; alias set_new_target set_new_location # === set_new_target
+
+  # ========================================================================= #
+  # === old?
+  # ========================================================================= #
+  def old?
+    @existing_location
+  end; alias existing?   old? # === existing?
+       alias old_target? old? # === old_target?
+       alias from?       old? # === from?
+
+  # ========================================================================= #
+  # === new?
+  # ========================================================================= #
+  def new?
+    @new_location
+  end; alias new_target? new? # === new_target?
+       alias to?         new? # === to?
+
+  # ========================================================================= #
+  # === do_symlink
+  #
+  # This is the actual method that will perform the symlink-operation in
+  # question.
+  # ========================================================================= #
+  def do_symlink(
+      be_verbose = be_verbose?
+    )
+    new_target = new_target?
+    old_target = old_target?
+    # ======================================================================= #
+    # We must first check whether the target at new? exists or whether
+    # it does not.
+    # ======================================================================= #
+    if File.exist? new_target
+      # ===================================================================== #
+      # === Append a '/' if necessary
+      # ===================================================================== #
+      if File.directory?(new_target) and File.directory?(old_target) and
+        !old_target.end_with?('/')
+        set_old_target("#{old_target}/")
+        old_target = old_target?
+      end
+      old_target = old_target.dup
+      # if File.directory?(new_target) and File.directory?(old_target) and
+      #   !( File.basename(new_target) == File.basename(old_target) )
+      #   # =================================================================== #
+      #   # This is specifically used to change
+      #   # /home/Programs/Htslib/1.12/include/htslib/ and
+      #   # /usr/include/ into /usr/include/htslib/.
+      #   # =================================================================== #
+      #   new_target << rds("#{File.basename(old_target)}")
+      # end
+      #^^^ this does not work correctly... in April 2021.
+      if File.directory?(new_target) and File.file?(old_target) # Silent renaming then.
+        _ = new_target+File.basename(old_target)
+        set_new_target(_)
+      end
+      if File.symlink? new_target
+        delete(new_target)
+      end
+    end
+    if be_verbose
+      opnn if use_opn?
+      e "Symlinking #{sfile(existing?)}#{rev} into #{sfile(new_target)}#{rev}."
+    end
+    begin
+      File.symlink(existing?, new_target)
+    rescue Errno::ENOENT => error # No such file or directory
+      opnn if use_opn?
+      e "#{rev}Can not symlink - no such file exists, "\
+        "at `#{sfile(new_target)}#{rev}`."
+      pp error
+    rescue Errno::EEXIST => error # The file does not exist.
+      opnn if use_opn?
+      e "Can not symlink - the file at `#{sfile(new_target)}#{rev}` already exists."
+      pp error
+    end
+  end
+
+  # ========================================================================= #
+  # === do_not_use_opn
+  # ========================================================================= #
+  def do_not_use_opn
+    @use_opn = false
+  end; alias disable_opn do_not_use_opn # === disable_opn
+
+  # ========================================================================= #
+  # === use_opn?
+  # ========================================================================= #
+  def use_opn?
+    @use_opn
+  end
+
+  # ========================================================================= #
+  # === namespace?
+  # ========================================================================= #
+  def namespace?
+    @namespace
+  end
+
+  # ========================================================================= #
+  # === sfile
+  # ========================================================================= #
+  def sfile(i)
+    return Colours.sfile(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === sdir
+  # ========================================================================= #
+  def sdir(i)
+    return Colours.sdir(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn
+    Opn.opn(
+      namespace:   @namespace,
+      use_colours: use_colours?
+    )
+  end
+
+  # ========================================================================= #
+  # === rev
+  # ========================================================================= #
+  def rev
+    ::Colours.rev
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    do_symlink
+  end
+
+  # ========================================================================= #
+  # === Symlink[]
+  # ========================================================================= #
+  def self.[](old, new)
+    new(old, new)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Symlink.new(ARGV.first, ARGV[1])
+end # rubysymlink /Depot/j/foo.mp3 /Depot/j/bar.mp3

data/lib/symlink/version/version.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+class Symlink
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '0.0.29'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '17.02.2024'
+
+end

data/lib/symlink.rb

@@ -0,0 +1 @@
+require 'symlink/symlink.rb'

data/symlink.gemspec

@@ -0,0 +1,43 @@
+# =========================================================================== #
+# Gemspec for Project Symlink.
+# =========================================================================== #
+require 'symlink/version/version.rb'
+require 'roebe'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'symlink'
+  s.version = Symlink::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+
+  DESCRIPTION = <<-EOF                                                                                                                                                      
+
+  This library is called symlink. It can be used to symlink
+  files or directories, from within ruby.
+
+  General syntax is:
+
+    Symlink.new(from, to)
+
+EOF
+
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
+
+  s.authors  = ['Robert A. Heiler']
+  s.email    = Roebe.email?
+  s.files    = Dir['**/*']
+
+  s.license  = 'MIT'
+
+  s.required_ruby_version     = '>= '+Roebe.third_most_stable_version_of_ruby
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  # ========================================================================= #
+  # Dependencies for the project:
+  # ========================================================================= #
+  s.add_dependency 'colours'
+  s.add_dependency 'opn'
+
+}

data/test/testing_symlink.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'symlink'
+require 'colours/autoinclude'
+Symlink[
+  '/Programs/Applewmproto/1.4.2/',
+  '/Programs/Applewmproto/Current'
+] # $RSRC/symlink/test/testing_symlink.rb

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: symlink
+version: !ruby/object:Gem::Version
+  version: 0.0.29
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colours
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2+
+
+    This library is called symlink. It can be used to symlink
+    files or directories, from within ruby.
+
+    General syntax is:
+
+      Symlink.new(from, to)
+
+email: shevy@inbox.lt
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/symlink.rb
+- lib/symlink/constants.rb
+- lib/symlink/symlink.rb
+- lib/symlink/version/version.rb
+- symlink.gemspec
+- test/testing_symlink.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.5.3
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: 'This library is called symlink. It can be used to symlink files or directories,
+  from within ruby.  General syntax is:  Symlink.new(from, to)'
+test_files: []
+...