bblib 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: debe993c7a7d4324816c660a01fb9befab19a636aaf16ee403924051a12cd838
-  data.tar.gz: 9e8f4aa2c6f6705ae982b086d536c93073e11725ccc8bf137f581c22a355fde5
+  metadata.gz: f2470d8a875c6066b41bcb55d580db671e5569cfe69c13241f46a7015a4f87d5
+  data.tar.gz: 797a23d1cc99ec3bab8d6945cd03137c1889b96a1ff5279feb07c3e4e445f4a1
 SHA512:
-  metadata.gz: ee2dff5db783cc66d30f0f9254a538014f41fbb58f81d2ec21c721d6900b6a5aa1bc8aee06b45cc3630b6e4d304c635c754a2cb6cc152ed42db61c9298db1f4f
-  data.tar.gz: a24156d985bded501a00d8e4e35764508dcc0a509c638c3fa9f31c528e3befe1d43014b549b4cbeb1ae5a3fbe1de6ad553ce8f489e246dc58f698f143abc7661
+  metadata.gz: bdbf6f7993ad6eea502e05d30d4d97a7997d815459b5816164d2d080d6292f7c3b80c31a04916785ea3afd29e92c45a797dcb728dbbe00c7fa62d26436220149
+  data.tar.gz: 27bfbbc391b6bd4dc92c6681fc239b7350848be6d1c0f6731a384bab266335058909fe19e9463e8c528eb77d24359580652e5f7182e232d2c51467c43ab848c4

data/lib/bblib/cli/option.rb

@@ -19,7 +19,6 @@ module BBLib
       attr_of [Integer, Range], :position, default: nil, allow_nil: true
       attr_hash :sub_commands, keys: String, values: OptsParser, aliases: [:sub_cmds, :subcommands], default: nil, allow_nil: true, pre_proc: proc { |hash| hash.is_a?(Hash) ? hash.keys_to_s : hash }
 
-
       def to_s
         (flags.sort_by(&:size).join(', ') + " #{placeholder}").strip.ljust(40, ' ') + "\t#{description}"
       end
@@ -29,35 +28,36 @@ module BBLib
       end
 
       def retrieve(args, parsed)
-        result = singular? ? nil : []
+        result = multi_value? ? [] : nil
         index = 0
         until index >= args.size
           begin
-            unless flag_match?(args[index].to_s, index)
+            if args[index].nil? || !flag_match?(args[index].to_s, index)
               index += 1
               next
             end
             values = split(extract(index, args))
             values.each do |value|
               valid!(value)
-              if singular?
-                result = value
-                index = args.size
-              else
+              if multi_value?
                 result << value
+              else
+                result = value
               end
+              index = args.size if singular?
             end
           rescue OptsParserException => e
             raise e if raise_errors?
           end
+          index += 1
         end
         raise MissingArgumentException, "A required argument is missing: #{name}" if required? && result.nil?
         result = processor.call(result) if !result.nil? && processor
         process_result(result.nil? ? default : result, args, parsed)
       end
 
-      def singular?
-        singular && !delimiter
+      def multi_value?
+        !singular || delimiter
       end
 
       def flag_match?(str, index = 0)

data/lib/bblib/cli/options/basic_option.rb

@@ -3,9 +3,9 @@ module BBLib
     class BasicOption < Option
 
       def extract(index, args)
-        args.delete_at(index)
-        raise MissingArgumentException, "No argument was provided for #{name}" if args[index].nil?
-        format_value(args.delete_at(index).to_s)
+        args[index] = nil
+        raise MissingArgumentException, "No argument was provided for #{name}" if args[index + 1].nil?
+        format_value(args[index + 1].tap { args[index + 1] = nil })
       end
 
       protected

data/lib/bblib/cli/options/command.rb

@@ -8,7 +8,7 @@ module BBLib
       end
 
       def extract(index, args)
-        args.delete_at(index).to_s
+        args[index].tap { args[index] = nil }
       end
 
     end

data/lib/bblib/cli/options/element_of.rb

@@ -0,0 +1,24 @@
+module BBLib
+  class OptsParser
+    class ElementOf < BasicOption
+
+      attr_ary :options, aliases: :opts
+      attr_of Proc, :comparitor, default: proc { |opt, val| opt == val }
+
+      def valid?(value)
+        return false unless options.any? { |opt| comparitor.call(opt, value) }
+        return true if validators.empty?
+        validators.all? do |validator|
+          validator.call(value)
+        end
+      end
+
+      protected
+
+      def format_value(value)
+        value.to_s
+      end
+
+    end
+  end
+end

data/lib/bblib/cli/options/toggle.rb

@@ -4,8 +4,8 @@ module BBLib
 
       def extract(index, args)
         value = args[index].to_s
-        if value =~ /^\-[\w\d]$/ || flags.include?(value)
-          args.delete_at(index)
+        if value =~ /^\-[\w\d]$|^\-{2}/ || flags.include?(value)
+          args[index] = nil
         elsif value =~ /^\-[\w\d]+$/
           flag = flags.find do |flag|
             next unless flag =~ /^\-[\w\d]$/

data/lib/bblib/cli/opts_parser.rb

@@ -13,6 +13,7 @@ require_relative 'options/regexp'
 require_relative 'options/symbol'
 require_relative 'options/toggle'
 require_relative 'options/untoggle'
+require_relative 'options/element_of'
 
 module BBLib
   class OptsParser
@@ -49,7 +50,7 @@ module BBLib
         options.sort_by { |opt| opt.position || 10**100 }.each do |option|
           option.retrieve(args, hash)
         end
-      end.merge(arguments: args)
+      end.merge(arguments: args.compact)
     end
 
     def help

data/lib/bblib/core.rb

@@ -28,6 +28,8 @@ require_relative 'core/util/array'
 require_relative 'core/util/logging'
 require_relative 'core/util/os'
 
+require_relative 'core/mixins/numeric_enhancements'
+
 require_relative 'core/classes/hash_struct'
 require_relative 'core/classes/task_timer'
 require_relative 'core/classes/tree_hash'

data/lib/bblib/core/classes/hash_struct.rb

@@ -35,7 +35,8 @@ module BBLib
 end
 
 class Hash
-  def to_hash_struct
-    BBLib::HashStruct.new.merge(self)
+  def to_hash_struct(recursive = true)
+    hash = recursive ? self.hmap { |k, v| [k, v.respond_to?(:to_hash_struct) ? v.to_hash_struct(recursive) : v] } : self
+    BBLib::HashStruct.new.merge(hash)
   end
 end

data/lib/bblib/core/hash_path/hash_path.rb

@@ -44,7 +44,7 @@ end
 
 module BBLib
   def self.hash_path(hash, *paths, multi_path: false, multi_join: false, multi_join_hash: false)
-    tree = TreeHash.new(hash.to_h)
+    tree = TreeHash.new(hash)
     if multi_path
       tree.find_multi(*paths).map  { |r| r.map { |sr| sr.value } }
     elsif multi_join

data/lib/bblib/core/hash_path/part.rb

@@ -47,6 +47,14 @@ class HashPath
           matches << v if key_match?(k, object) && evaluates?(v)
           matches += matches(v) if recursive? && v.children?
         end
+      else
+        casted = case
+        when !object.value.is_a?(Hash) && !object.value.is_a?(Array) && object.value.respond_to?(:to_tree_hash) && object.method(:to_tree_hash).arity <= 0
+          object.value.to_tree_hash
+        when object.value.is_a?(BBLib::Effortless)
+          object.value.serialize.to_tree_hash
+        end
+        matches += matches(casted) if casted
       end
       matches
     end

data/lib/bblib/core/mixins/numeric_enhancements.rb

@@ -0,0 +1,42 @@
+module BBLib
+  # This module contains methods that are intended to be mixed in to
+  # Integer and Float classes. They mostly provide convenience methods.
+  module NumericEnhancements
+
+    # Create a method for all types of times. Makes it easy
+    # to convert to any range of seconds. e.g. 5.hours returns 3600
+    TIME_EXPS.each do |name, data|
+      [name, name.to_s.pluralize].each do |method|
+        define_method(method) {
+          (self * data[:mult]) / 1000
+        }
+      end
+    end
+
+    # Converts a number to english (only language supported currently)
+    # For example, 501.spell_out returns 'five hundred and one'
+    def spell_out(include_and: true)
+      BBLib.number_spelled_out(self, include_and: include_and)
+    end
+
+    # Convert this integer into a string with every three digits separated by a delimiter
+    # on the left side of the decimal
+    def to_delimited_s(delim = ',')
+      split = self.to_s.split('.')
+      split[0] = split.first.reverse.gsub(/(\d{3})/, "\\1#{delim}").reverse
+      split.join('.').uncapsulate(',')
+    end
+
+    # Returns the time x seconds ago from now (x == this number)
+    def ago
+      Time.now - self
+    end
+
+    # Returns the time x seconds ago from now (x == this number)
+    def from_now
+      Time.now + self
+    end
+  end
+
+  Numeric.send(:include, NumericEnhancements)
+end

data/lib/bblib/core/util/number.rb

@@ -57,6 +57,7 @@ module BBLib
     ]
   }
 
+  # TODO: Support floats eventually?
   def self.number_spelled_out(number, range = 0, include_and: true)
     number = number.to_i
     negative = number.negative?
@@ -73,7 +74,7 @@ module BBLib
     when 100..999
       str << NUMBER_WORDS[:special][three_digit.to_s[0].to_i]
       str << 'hundred'
-      str << 'and' if include_and
+      str << 'and' if include_and && !three_digit.to_s.end_with?('00')
       if three_digit.to_s[-2].to_i == 1
         str << NUMBER_WORDS[:special][three_digit.to_s[-2..-1].to_i]
       else
@@ -87,24 +88,3 @@ module BBLib
     str.compact.join(' ')).gsub(/\s+/, ' ')
   end
 end
-
-class Integer
-  # Convert this integer into a string with every three digits separated by a delimiter
-  def to_delimited_s(delim = ',')
-    self.to_s.reverse.gsub(/(\d{3})/, "\\1#{delim}").reverse.uncapsulate(',')
-  end
-
-  def spell_out
-    BBLib.number_spelled_out(self)
-  end
-end
-
-class Float
-  # Convert this integer into a string with every three digits separated by a delimiter
-  # on the left side of the decimal
-  def to_delimited_s(delim = ',')
-    split = self.to_s.split('.')
-    split[0] = split.first.reverse.gsub(/(\d{3})/, "\\1#{delim}").reverse
-    split.join('.').uncapsulate(',')
-  end
-end

data/lib/bblib/core/util/object.rb

@@ -1,10 +1,17 @@
 module BBLib
-  def self.are_all?(klass, *vars)
-    vars.all? { |var| var.is_a?(klass) }
+  # Easy way to see if all objects in an array are of a given class.
+  def self.are_all?(klass, *objects)
+    objects.all? { |object| object.is_a?(klass) }
   end
 
-  def self.is_any?(obj, *klasses)
-    klasses.any? { |klass| obj.is_a?(klass) }
+  # Easy way to see if any of the passed objects are of the given class.
+  def self.are_any?(klass, *objects)
+    objects.any? { |object| object.is_a?(klass) }
+  end
+
+  # Checks to see if an object is of any of the given classes.
+  def self.is_any?(object, *klasses)
+    klasses.any? { |klass| object.is_a?(klass) }
   end
 
   # Takes any type of object and converts it into a hash based on its instance
@@ -34,10 +41,14 @@ module BBLib
     hash
   end
 
+  # Extracts all hash based arguments from an ary of arguments. Only hash pairs with
+  # a symbol as the key are returned. Use hash_args if you also want to treat
+  # String keys as named arguments.
   def self.named_args(*args)
     args.last.is_a?(Hash) && args.last.keys.all? { |k| k.is_a?(Symbol) } ? args.last : {}
   end
 
+  # Same as standard named_args but removes the named arguments from the array.
   def self.named_args!(*args)
     if args.last.is_a?(Hash) && args.last.keys.all? { |k| k.is_a?(Symbol) }
       args.delete_at(-1)
@@ -46,10 +57,12 @@ module BBLib
     end
   end
 
+  # Similar to named_args but also treats String keys as named arguments.
   def self.hash_args(*args)
     args.find_all { |a| a.is_a?(Hash) }.each_with_object({}) { |a, h| h.merge!(a) }
   end
 
+  # Send a chain of methods to an object and each result of the previous method.
   def self.recursive_send(obj, *methods)
     methods.each do |args|
       obj = obj.send(*args)
@@ -57,13 +70,52 @@ module BBLib
     obj
   end
 
+  # Returns the encapsulating object space of a given class.
+  # Ex: For a class called BBLib::String, this method will return BBLib as the namespace.
+  # Ex2: For a class BBLib::String::Char, this method will return BBLib::String as the namespace.
   def self.namespace_of(klass)
     split = klass.to_s.split('::')
     return klass if split.size == 1
     Object.const_get(split[0..-2].join('::'))
   end
 
+  # Returns the root namespace of a given class if it is nested.
   def self.root_namespace_of(klass)
     Object.const_get(klass.to_s.gsub(/::.*/, ''))
   end
+
+  # Create a new class or module recursively within a provided namespace. If a
+  # constant matching the requested one already exist it is returned. Any
+  # block passed to this method will be evaled in the created/found constant.
+  def self.const_create(name, value, strict: true, base: Object, type_of_missing: nil, &block)
+    namespace = base
+    unless base.const_defined?(name)
+      type_of_missing = Module unless type_of_missing
+      name = name.uncapsulate('::')
+      if name.include?('::')
+        namespaces = name.split('::')
+        name = namespaces.pop
+        namespaces.each do |constant|
+          unless namespace.const_defined?(constant)
+            match = namespace.const_set(constant, type_of_missing.new)
+          end
+          namespace = namespace.const_get(constant)
+        end
+      end
+      namespace.const_set(name, value)
+    end
+    object = namespace.const_get(name)
+    raise TypeError, "Expected a #{value.class} but #{namespace}::#{name} is a #{object.class}" if strict && object.class != value.class
+    object.tap do |constant|
+      constant.send(:class_exec, &block) if block
+    end
+  end
+
+  def self.class_create(name, *args, **opts, &block)
+    const_create(name, Class.new(*args), **opts, &block)
+  end
+
+  def self.module_create(name, *args, **opts, &block)
+    const_create(name, Module.new(*args), **opts, &block)
+  end
 end

data/lib/bblib/core/util/time.rb

@@ -71,7 +71,7 @@ module BBLib
     atto: {
       mult: 0.000000000000001,
       styles: { long: ' attosecond', medium: ' atto', short: 'as' },
-      exp: %w(attoseconds atto attoseconds attos as)
+      exp: %w(attosecond atto attoseconds attos as)
     },
     femto: {
       mult: 0.000000000001,

data/lib/bblib/version.rb

@@ -1,3 +1,3 @@
 module BBLib
-  VERSION = '2.0.3'.freeze
+  VERSION = '2.0.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bblib
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Brandon Black
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-21 00:00:00.000000000 Z
+date: 2018-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,6 +99,7 @@ files:
 - lib/bblib/cli/options/bool.rb
 - lib/bblib/cli/options/command.rb
 - lib/bblib/cli/options/date.rb
+- lib/bblib/cli/options/element_of.rb
 - lib/bblib/cli/options/float.rb
 - lib/bblib/cli/options/integer.rb
 - lib/bblib/cli/options/json.rb
@@ -127,6 +128,7 @@ files:
 - lib/bblib/core/mixins/family_tree.rb
 - lib/bblib/core/mixins/hooks.rb
 - lib/bblib/core/mixins/logger.rb
+- lib/bblib/core/mixins/numeric_enhancements.rb
 - lib/bblib/core/mixins/prototype.rb
 - lib/bblib/core/mixins/serializer.rb
 - lib/bblib/core/mixins/simple_init.rb