util 0.4.0

data/test/unit/result.rb

@@ -0,0 +1,180 @@
+results = [:ok, 42, nil, :ok, nil, nil, :err, :nope, nil]
+results += [:err, nil, nil, :err, :nope, 'Temp#my_func']
+$test.register 'result-new', results do ||
+  require 'util/result'
+  res = []
+  success = Util::Result.ok 42
+  res << success.instance_variable_get('@type')
+  res << success.instance_variable_get('@content')
+  res << success.instance_variable_get('@where')
+
+  success = Util::Result.ok
+  res << success.instance_variable_get('@type')
+  res << success.instance_variable_get('@content')
+  res << success.instance_variable_get('@where')
+
+  failure = Util::Result.err :nope
+  res << failure.instance_variable_get('@type')
+  res << failure.instance_variable_get('@content')
+  res << failure.instance_variable_get('@where')
+
+  failure = Util::Result.err
+  res << failure.instance_variable_get('@type')
+  res << failure.instance_variable_get('@content')
+  res << failure.instance_variable_get('@where')
+
+  class Temp
+    def my_func
+      Util::Result.err :nope, self
+    end
+  end
+
+  failure = Temp.new.my_func
+  res << failure.instance_variable_get('@type')
+  res << failure.instance_variable_get('@content')
+  res << failure.instance_variable_get('@where')
+
+  res
+end
+
+results = [true, false, false, false, true, false, false, true]
+$test.register 'result-compare', results do ||
+  require 'util/result'
+  [ Util::Result.ok == Util::Result.ok,
+    Util::Result.ok == Util::Result.err,
+    Util::Result.ok == Util::Result.ok(42),
+    Util::Result.ok(42.0) == Util::Result.ok(42),
+    Util::Result.ok(42) == Util::Result.ok(42),
+    Util::Result.ok(42) == Util::Result.err(79),
+    Util::Result.ok(Object.new) == Util::Result.err(Object.new),
+    Util::Result.ok != Util::Result.err
+  ]
+end
+
+results = [true, false, false, true, false, true]
+$test.register 'result-type-determiner', results do ||
+  require 'util/result'
+  class Temp
+    def self.divide num, denom
+      return Util::Result.err :div0, self if denom == 0
+      Util::Result.ok num / denom
+    end
+  end
+  [ Util::Result.ok(42).ok?,
+    Util::Result.ok(42).err?,
+    Util::Result.err(:nope, self).ok?,
+    Util::Result.err(:nope, self).err?,
+    Temp.divide(42, 7).err?,
+    Temp.divide(42, 0).err?,
+  ]
+end
+
+results = [6, 6, :nope, :div0, :div0, :nope]
+$test.register 'result-retrieve-value', results do ||
+  require 'util/result'
+  class Temp
+    def self.divide num, denom
+      return Util::Result.err :div0, self if denom == 0
+      Util::Result.ok num / denom
+    end
+  end
+  [ Temp.divide(42, 7).value,
+    Temp.divide(42, 7).value_or(:nope),
+    Temp.divide(42, 0).value_or(:nope),
+    Temp.divide(42, 0).error,
+    Temp.divide(42, 0).error_or(:nope),
+    Temp.divide(42, 7).error_or(:nope),
+  ]
+end
+
+$test.register 'result-value-on-failure', ArgumentError do ||
+  require 'util/result'
+  class Temp
+    def self.divide num, denom
+      return Util::Result.err :div0, self if denom == 0
+      Util::Result.ok num / denom
+    end
+  end
+  Temp.divide(42, 0).value
+end
+
+$test.register 'result-error-on-success', ArgumentError do ||
+  require 'util/result'
+  class Temp
+    def self.divide num, denom
+      return Util::Result.err :div0, self if denom == 0
+      Util::Result.ok num / denom
+    end
+  end
+  Temp.divide(42, 7).error
+end
+
+results = ['[+] ', '[-] ', '[+] 6', '[- Temp.divide] div0']
+$test.register 'result-to_s', results do ||
+  require 'util/result'
+  class Temp
+    def self.divide num, denom
+      return Util::Result.err :div0, self if denom == 0
+      Util::Result.ok num / denom
+    end
+  end
+  [ Util::Result.ok.to_s,
+    Util::Result.err.to_s,
+    Temp.divide(42, 7).to_s,
+    Temp.divide(42, 0).to_s,
+  ]
+end
+
+def next_num num
+  num.content + 1
+end
+
+results = [121, 122, 133, 133, :div0, 'Num#divide', 91, :div0, 'Num#divide']
+results += [NameError, 'undefined method `substract\' for class `Num\'']
+results += ['Util::Result#bind_common']
+$test.register 'result-binding', results do ||
+  require 'util/result'
+
+  class Num
+    attr_reader :content
+    def initialize num
+      @content = num.to_f
+    end
+
+    def self.add first, second
+      Util::Result.ok Num.new(first.content + second.content)
+    end
+
+    def == num
+      return false unless num.respond_to?(:to_f)
+      @content.to_f == num.to_f
+    end
+
+    def add num
+      Util::Result.ok Num.new(@content + num.to_f)
+    end
+
+    def divide denom
+      return Util::Result.err :div0, self if denom == 0
+      Util::Result.ok Num.new(@content / denom.to_f)
+    end
+  end
+
+  base = Num.add(Num.new(42), Num.new(79))
+  [ base.value_or(:nope),
+    base.bind(:next_num).value_or(:nope), # Top-level method
+    base.bindm(:add, 12).value_or(:nope), # Instance method
+    base.bindcm(:add, Num.new(12)).value_or(:nope), # Class method
+    base.bindm(:divide, 0).error, # Failure
+    base.bindm(:divide, 0).where,
+    base.bindm(:add, 12).bindcm(:add, Num.new(-42)).value_or(:nope),
+      # Chain multiple binds
+    base.bindm(:add, 12).bindm(:divide, 0).bindcm(:add, Num.new(-42)).error,
+    base.bindm(:add, 12).bindm(:divide, 0).bindcm(:add, Num.new(-42)).where,
+      # Chain multiple binds with an error in between
+    base.bindm(:substract, 12).error.class,
+    base.bindm(:substract, 12).error.message,
+    base.bindm(:substract, 12).where,
+      # The method does not exist, hence raises an exception
+  ]
+end

data/tools/create-iso639-3.rb

@@ -0,0 +1,235 @@
+# Generates a YAML file containing all ISO 639-3 codes and information
+#   about them, from the lists distributed by the SIL.
+#
+# See `$0 --help` for command-line options.
+# See main `LICENSES` file for license information.
+# @author Guillaume Lestringant
+# @version 1.0
+# @note This program is supposed to not raise any exception, so that
+#   it can be called from a script (cf. `-q` option).
+require 'optparse'
+require 'yaml'
+
+def log type, msg
+  code = { :none => "\033[0m", :ok => "\033[32m",
+           :err => "\033[31m", :warn => "\033[33m" }
+  text = { :none => '', :ok => '', :err => '[ERROR] ', :warn => '[WARNING] ' }
+
+  unless $options[:quiet] then
+    $options[:stderr_log] \
+      ? $STDERR.puts("#{code[type]}#{text[type]}#{msg}#{code[:none]}")
+      : puts("#{code[type]}#{text[type]}#{msg}#{code[:none]}")
+  end
+
+  exit 1 if type == :err
+end
+
+    # Parse command-line options
+     ###########################
+
+$options = {
+  :dest => 'iso639-3.yml',
+  :force => false,
+  :quiet => false,
+  :src_b => 'iso639-3',
+  :src_d => 'iso639-3d',
+  :src_m => 'iso639-3m',
+  :stderr_log => false,
+}
+
+OptionParser.new do |opts|
+  DEPR_TEXT = "List of deprecated codes. [DEF: #{$options[:src_d]}(.txt)]"
+  DEST_TEXT = "The file that will be generated. [DEF: #{$options[:dest]}(.txt)]"
+  FORCE_TEXT = 'Write destination even if file already exists. [DEF: false]'
+  HELP_TEXT = 'Display this help message.'
+  MACRO_TEXT = "List of macrolanguage mappings. [DEF: #{$options[:src_m]}(.txt)]"
+  QUIET_TEXT = 'Do not diplay anything in terminal. [DEF: false]'
+  SRC_TEXT = "List of active codes. [DEF: #{$options[:src_b]}(.txt)]"
+  STDERR_TEXT = 'Log to STDERR instead of STDOUT. [DEF: false]'
+  VERSION_TEXT = 'Print program version.'
+  NAME = 'Create ISO 639-3'
+  VERSION = '1.0'
+
+  opts.banner = "Usage: #{$0} [options]"
+
+  opts.on("-d", "--depr FILE", String, DEPR_TEXT) do |f|
+    $options[:src_d] = f
+  end
+
+  opts.on("-f", "--force", FORCE_TEXT) do |f|
+    $options[:force] = true
+  end
+
+  opts.on("-h", "--help", HELP_TEXT) do |h|
+    puts opts
+    exit
+  end
+
+  opts.on("-l", "--log-to-stderr", STDERR_TEXT) do |f|
+    $options[:stderr_log] = true
+  end
+
+  opts.on("-m", "--macro FILE", String, MACRO_TEXT) do |f|
+    $options[:src_m] = f
+  end
+
+  opts.on("-o", "--output FILE", String, DEST_TEXT) do |f|
+    $options[:dest] = f
+  end
+
+  opts.on("-q", "--quiet", QUIET_TEXT) do |f|
+    $options[:quiet] = true
+  end
+
+  opts.on("-s", "--src FILE", String, SRC_TEXT) do |f|
+    $options[:src_b] = f
+  end
+
+  opts.on("-v", "--version", VERSION_TEXT) do |v|
+    puts "#{NAME} v. #{VERSION}"
+    exit
+  end
+end.parse!
+
+log :none, "#{NAME} v. #{VERSION}"
+
+    # Check all parameters
+     #####################
+
+def check_src idx, default
+  return if File.exist? $options[idx]
+
+  log :warn, "File not found `#{$options[idx]}`."
+  $options[idx] = File.extname($options[idx]) == '.txt' \
+    ? File.basename($options[idx], '.txt')
+    : $options[idx] + '.txt'
+  log :warn, "Trying `#{$options[idx]}` instead."
+  return if File.exist? $options[idx]
+
+  if $options[idx] == default or $options[idx] == (default + '.txt') then
+    log :err, 'File not found. No other possibility. Aborting.'
+  end
+
+  log :warn, "File not found. Reverting to default value `#{default}`."
+  $options[idx] = default
+  return if File.exist? $options[idx]
+
+  $options[idx] += '.txt'
+  log :warn, "File not found. Trying `#{$options[idx]}` instead."
+  return if File.exist? $options[idx]
+
+  log :err, 'File not found. No other possibility. Aborting.'
+end
+
+def mkdir_p dir
+  parent = File.dirname dir
+  log :err, "Root directory not found `#{dir}`." if dir == parent
+  mkdir_p parent unless File.exist? parent
+  log :err, "Not a directory `#{parent}`." unless File.directory? parent
+  Dir.mkdir dir
+end
+
+check_src :src_b, 'iso639-3'
+check_src :src_d, 'iso639-3d'
+check_src :src_m, 'iso639-3m'
+
+if File.exist? $options[:dest] then
+  message = "File already exists `#{$options[:dest]}`. Use `-f` to overwrite."
+  log :err, message unless $options[:force]
+else
+  dir = File.dirname $options[:dest]
+  mkdir_p dir unless File.exist? dir
+  log :err, "Not a directory `#{dir}`." unless File.directory? dir
+end
+
+log :ok, 'All parameters clear.'
+
+    # Extract the data
+     #################
+
+keys = []
+codes = {}
+result = {}
+
+active = File.read($options[:src_b]).lines[1..-1]
+active = [] if active.nil?
+active.each do |l|
+  id, part2b, part2t, part1, scope, type, name, comment = l.chomp.split "\t"
+
+  keys << id
+  id = id.to_sym
+  codes[id] = { :name => name }
+
+  case scope
+  when 'I' then codes[id][:scope] = :individual
+  when 'M' then codes[id][:scope] = :macro
+  when 'S' then codes[id][:scope] = :special
+  else puts "Unknown scope for #{id} : #{scope}."
+  end
+
+  case type
+  when 'A' then codes[id][:type] = :ancient
+  when 'C' then codes[id][:type] = :constructed
+  when 'E' then codes[id][:type] = :extinct
+  when 'H' then codes[id][:type] = :historical
+  when 'L' then codes[id][:type] = :living
+  when 'S' then codes[id][:type] = :special
+  else puts "Unknown type for #{id} : #{type}."
+  end
+
+  codes[id][:p1] = part1.to_sym unless part1.empty?
+  codes[id][:p2b] = part2b.to_sym unless part2b.empty?
+  codes[id][:p2t] = part2t.to_sym unless part2t.empty?
+  codes[id][:comment] = comment unless comment.nil? or comment.empty?
+end
+
+log :ok, 'Extracted active codes.'
+
+deprecated = File.read($options[:src_d]).lines[1..-1]
+deprecated = [] if deprecated.nil?
+deprecated.each do |l|
+  id, name, reason, new, comment, date = l.chomp.split "\t"
+
+  keys << id
+  id = id.to_sym
+  codes[id] = { :deprecated => true, :name => name }
+
+  case reason
+  when 'C' then codes[id][:reason] = :change
+  when 'D' then codes[id][:reason] = :duplicate
+  when 'N' then codes[id][:reason] = :non_existent
+  when 'S' then codes[id][:reason] = :split
+  when 'M' then codes[id][:reason] = :merge
+  else puts "Unknown deprecation reason for #{id} : #{reason}."
+  end
+
+  codes[id][:new] = new.to_sym unless new.empty?
+  codes[id][:comment] = comment unless comment.empty?
+  codes[id][:date] = date unless date.empty? or date.empty?
+end
+
+log :ok, 'Extracted deprecated codes.'
+
+macro = File.read($options[:src_m]).lines[1..-1]
+macro = [] if macro.nil?
+macro.each do |l|
+  macro, member, status = l.chomp.split "\t"
+
+  macro, member = macro.to_sym, member.to_sym
+  codes[macro][:members] = [] if codes[macro][:members].nil?
+  codes[macro][:members] << member
+  codes[member][:macro] = macro
+end
+
+log :ok, 'Extracted macrolanguage mappings.'
+
+    # Export
+     #######
+
+keys.sort.each do |k|
+  result[k.to_sym] = codes[k.to_sym]
+end
+
+File.write $options[:dest], result.to_yaml
+
+log :ok, 'Full success.'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: util
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Guillaume Lestringant
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-12 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      A collection of diverse simple utilities without much anything to do
+      with one another. The main rationale is to reduce the time spent on
+      boilerplate like checking whether the arguments have the right type,
+      or introducing some basic internationalization. More detail in the README.
+email: 5582173-guillel@users.noreply.gitlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CECILL-C.EN
+- CECILL-C.FR
+- LICENSES.md
+- README.md
+- lib/util.rb
+- lib/util/args.rb
+- lib/util/communia.rb
+- lib/util/console_logger.rb
+- lib/util/downloader.rb
+- lib/util/i18n.rb
+- lib/util/lists.rb
+- lib/util/lists/iso639.rb
+- lib/util/result.rb
+- lib/util/test.rb
+- lib/util/yaml.rb
+- share/lists/iso639-3.yml
+- test/unit.rb
+- test/unit/args.rb
+- test/unit/downloader.rb
+- test/unit/downloader/orig/simple.html
+- test/unit/i18n.rb
+- test/unit/i18n/CamelCase/eng.yml
+- test/unit/i18n/CamelCase/fra.yml
+- test/unit/i18n/aaj.yml
+- test/unit/i18n/en.yml
+- test/unit/i18n/fra.yml
+- test/unit/i18n/i18n
+- test/unit/i18n/prv.yml
+- test/unit/i18n/void/fra.yml/Yes-git-I-need-this-folder-even-if-it-is-empty
+- test/unit/i18n/αλιας/fra.yml
+- test/unit/lists/iso639.rb
+- test/unit/result.rb
+- tools/create-iso639-3.rb
+homepage: https://gitlab.com/guillel/util-gem
+licenses:
+- CECILL-C
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Collection of simple utilities to reduce boilerplate
+test_files: []