michaelmior / NoSE

lib/nose/util.rb

# frozen_string_literal: true

require 'date'
require 'formatador'
require 'parallel'
require 'pp'
require 'stringio'

# Reopen to add utility methods
module Enumerable
  # Enumerate all non-empty prefixes of the enumerable
  # @return [Enumerator]
  def prefixes
    Enumerator.new do |enum|
      prefix = []
      each do |elem|
        prefix = prefix.dup << elem
        enum.yield prefix
      end
    end
  end

  # Enumerate all partitionings of an enumerable
  # @return [Enumerator]
  def partitions(max_length = nil)
    max_length = length if max_length.nil?
    Enumerator.new do |enum|
      1.upto(max_length).map do |length|
        enum.yield partition.with_index { |_, i| i < length }

Parenthesize the param partition.with_index { |_, i| i < length } to make sure that the block will be associated with the partition.with_index method call.

      end
    end
  end

  # Take the sum of the result of calling the block on each item
  # @return [Object]
  def sum_by(initial = 0)
    reduce(initial) { |sum, item| sum + yield(item) }
  end

  # Take the product of the result of calling the block on each item
  # @return [Object]
  def product_by(initial = 1)
    reduce(initial) { |product, item| product * yield(item) }
  end
end

# Extend with some convenience methods
class Array
  # Find the longest common prefix of two arrays
  # @return [Array<Object>]
  def longest_common_prefix(other)
    fail TypeError unless other.is_a? Array

Add empty line after guard clause.

    (prefixes.to_a & other.prefixes.to_a).max_by(&:length) || []
  end
end

# Reopen to present as finite as with Float
class Integer
  # Convenience methods to allow integers to be considered finite
  # @return [Boolean]
  def finite?
    true
  end
end

# Extend Object to print coloured output
class Object
  def inspect
    Formatador.parse(respond_to?(:to_color) ? to_color : to_s)
  end

  # Get a colored representation of the object
  # @return [String]
  def to_color
    to_s
  end
end

# Allow a supertype to look up a class given the
# name of a subtype inheriting from this class
module Supertype
  # Add class methods when this module is included
  # @return [void]
  def self.included(base)
    base.extend ClassMethods
  end

  # Add a single method to get a class given the subtype name
  module ClassMethods
    # Get the class given the name of a subtype
    # @return [Class] the concrete class with the given subtype name
    def subtype_class(name)

The Assignment, Branch, Condition size for subtype_class is considered too high. [<6, 20, 2> 20.98/20]. The ABC size is based on assignments, branches (method calls), and conditions.

      class_name = self.name.split('::')[0..-2]
      class_name << name.split('_').map do |name_part|
        name_part = name_part[0].upcase + name_part[1..-1]

Prefer [1..] over [1..-1].

        name_part.sub 'Id', 'ID'
      end.join
      class_name[-1] = class_name[-1] + self.name.split('::').last

      class_name.reduce(Object) do |mod, name_part|
        mod.const_get(name_part)
      end
    end
  end
end

# Allow subclasses to return a string representing of the
# class, minus a common suffix also used in the superclass
module Subtype
  # Add instance and class methods when this module is included
  # @return [void]
  def self.included(base)
    base.send :include, InstanceMethods
    base.extend ClassMethods
  end

  # Mirror the subtype method on class instances
  module InstanceMethods
    # A mirror of {Subtype::ClassMethods#subtype_name}
    # @return [String]
    def subtype_name(**args)
      self.class.subtype_name(**args)
    end
  end

  # Add a single method to retrieve the subtype name
  module ClassMethods
    # Get a unique string identify this subclass amongst sibling classes
    # @return [String]
    def subtype_name(name_case: :snake)
      super_name = name_array superclass
      self_name = name_array self
      self_name = self_name.reverse.drop_while do |part|
        super_name.include? part
      end.reverse

      if name_case == :snake
        name = self_name.join('_').freeze
      elsif name_case == :camel
        name = self_name.map do |part|
          part[0].upcase + part[1..-1]

Prefer [1..] over [1..-1].

        end.join('').freeze
      end

      name
    end

    private

    # Convert camel case class names to an array
    # @return [Array<String>]
    def name_array(cls)
      frozen_name = cls.name.dup
      frozen_name.gsub!(/^.*::/, '')
      frozen_name.gsub!('ID', 'Id')
      frozen_name.freeze

      frozen_name.split(/(?=[A-Z]+)/).map(&:freeze) \
                 .map! do |s|
        s.downcase.freeze
      end
    end
  end
end

# Simple helper class to facilitate cardinality estimates
class Cardinality
  # Update the cardinality based on filtering implicit to the index
  # @return [Integer]
  def self.filter(cardinality, eq_filter, range_filter)
    filtered = (range_filter.nil? ? 1.0 : 0.1) * cardinality
    filtered *= eq_filter.map do |field|
      1.0 / field.cardinality
    end.inject(1.0, &:*)

    filtered
  end
end

# Add a simple function for pretty printing strings
module Kernel
  private

  # Pretty print to a string
  # @return [String]
  def pp_s(*objs)
    s = StringIO.new
    objs.each { |obj| PP.pp(obj, s) }
    s.rewind
    s.read
  end

  module_function :pp_s
end

# Add simple convenience methods
class Object
  # Convert all the keys of a hash to symbols
  # @return [Object]
  def deep_symbolize_keys
    return each_with_object({}) do |(k, v), memo|

Favor a normal if-statement over a modifier clause in a multiline statement.

      memo[k.to_sym] = v.deep_symbolize_keys
      memo
    end if is_a? Hash

    return each_with_object([]) do |v, memo|

Favor a normal if-statement over a modifier clause in a multiline statement.

      memo << v.deep_symbolize_keys
      memo
    end if is_a? Array

    self
  end
end

# Extend the kernel to allow warning suppression
module Kernel
  # Allow the suppression of warnings for a block of code
  # @return [void]
  def suppress_warnings
    original_verbosity = $VERBOSE
    $VERBOSE = nil
    result = yield
    $VERBOSE = original_verbosity

    result
  end
end

module NoSE
  # Helper functions for building DSLs
  module DSL
    # Add methods to the class which can be used to access entities and fields
    # @return [void]
    def mixin_fields(entities, cls)

The Assignment, Branch, Condition size for mixin_fields is considered too high. [<7, 19, 6> 21.12/20]. The ABC size is based on assignments, branches (method calls), and conditions.

      entities.each do |entity_name, entity|
        # Add fake entity object for the DSL
        fake = Object.new

        # Add a method named by the entity to allow field creation
        cls.send :define_method, entity_name.to_sym, (proc do
          metaclass = class << fake; self; end

          # Allow fields to be defined using [] access
          metaclass.send :define_method, :[] do |field_name|
            if field_name == '*'
              entity.fields.values
            else
              entity.fields[field_name] || entity.foreign_keys[field_name]
            end
          end

          # Define methods named for fields so things like 'user.id' work
          entity.fields.merge(entity.foreign_keys).each do |field_name, field|
            metaclass.send :define_method, field_name.to_sym, -> { field }
          end

          fake
        end)
      end
    end

    module_function :mixin_fields
  end

  # Add loading of class instances from the filesystem
  module Loader
    attr_reader :source_code

    def self.included(base)
      base.extend ClassMethods
    end

    # Add a class method to load class instances from file
    module ClassMethods
      # Load a class with the given name from a directory specified
      # by the LOAD_PATH class constant
      # @return [Object] an instance of the class which included this module
      def load(name)
        if File.exist? name
          filename = name
        else
          path = const_get(:LOAD_PATH)
          filename = File.expand_path "../../../#{path}/#{name}.rb", __FILE__
        end

        source_code = File.read(filename)
        instance = binding.eval source_code, filename

The use of eval is a serious security risk.

        instance.instance_variable_set :@source_code, source_code
        instance
      end
    end
  end
end

# Allow tracking of subclasses for plugin purposes
module Listing
  def self.included(base)
    base.extend ClassMethods
    base.class_variable_set :@@registry, {}

Replace class var :@@registry with a class instance var.

  end

  # Add a class method to track new subclasses
  module ClassMethods
    # Track this new subclass for later
    # @return [void]
    def inherited(subclass)

Call super to invoke callback defined in the parent class.

      class_variable_get(:@@registry)[subclass.name] = subclass
    end

    # List all of the encountered subclasses
    # @return [Hash<String, Class>]
    def subclasses
      class_variable_get(:@@registry)
    end
  end
end

# Extend Time to allow conversion to DateTime instances
class Time
  # Convert to a DateTime instance
  # http://stackoverflow.com/a/279785/123695
  # @return [DateTime]
  def to_datetime
    # Convert seconds + microseconds into a fractional number of seconds
    seconds = sec + Rational(usec, 10**6)

    # Convert a UTC offset measured in minutes to one measured in a
    # fraction of a day.
    offset = Rational(utc_offset, 60 * 60 * 24)
    DateTime.new(year, month, day, hour, min, seconds, offset)
  end
end