nrser 0.2.2 → 0.3.0

data/lib/nrser/functions/hash/except_keys.rb

@@ -1,44 +0,0 @@
-# Definitions
-# =======================================================================
-
-module NRSER
-  
-  # @!group Hash Functions
-  
-  # Removes the given keys from hash and returns it.
-  # 
-  # Lifted from ActiveSupport.
-  # 
-  # @see http://www.rubydoc.info/gems/activesupport/5.1.3/Hash:except!
-  # 
-  # @param [Hash] hash
-  #   Hash to mutate.
-  # 
-  # @return [Hash]
-  # 
-  def self.except_keys! hash, *keys
-    keys.each { |key| hash.delete(key) }
-    hash
-  end
-  
-  singleton_class.send :alias_method, :omit_keys!, :except_keys!
-  
-  
-  # Returns a new hash without `keys`.
-  # 
-  # Lifted from ActiveSupport.
-  # 
-  # @see http://www.rubydoc.info/gems/activesupport/5.1.3/Hash:except
-  # 
-  # @param [Hash] hash
-  #   Source hash.
-  # 
-  # @return [Hash]
-  # 
-  def self.except_keys hash, *keys
-    except_keys! hash.dup, *keys
-  end
-  
-  singleton_class.send :alias_method, :omit_keys, :except_keys
-
-end # module NRSER

data/lib/nrser/functions/hash/slice_keys.rb

@@ -1,43 +0,0 @@
-# Definitions
-# =======================================================================
-
-module NRSER
-  
-  # @!group Hash Functions
-
-  # Lifted from ActiveSupport.
-  # 
-  # @see http://www.rubydoc.info/gems/activesupport/5.1.3/Hash:slice
-  # 
-  # 
-  def self.slice_keys hash, *keys
-    # We're not using this, but, whatever, leave it in...
-    if hash.respond_to?(:convert_key, true)
-      keys.map! { |key| hash.send :convert_key, key }
-    end
-    
-    keys.each_with_object(hash.class.new) { |k, new_hash|
-      new_hash[k] = hash[k] if hash.has_key?(k)
-    }
-  end
-  
-  
-  # Meant to be a drop-in replacement for the ActiveSupport version, though
-  # I've changed the implementation a bit... because honestly I didn't
-  # understand why they were doing it the way they do :/
-  # 
-  # @see http://www.rubydoc.info/gems/activesupport/5.1.3/Hash:slice!
-  # 
-  # 
-  def self.slice_keys! hash, *keys
-    # We're not using this, but, whatever, leave it in...
-    if hash.respond_to?(:convert_key, true)
-      keys.map! { |key| hash.send :convert_key, key }
-    end
-    
-    slice_keys( hash, *keys ).tap { |slice|
-      except_keys! hash, *keys
-    }
-  end
-
-end # module NRSER

data/lib/nrser/functions/hash/stringify_keys.rb

@@ -1,55 +0,0 @@
-# Definitions
-# =======================================================================
-
-module NRSER
-  
-  # @!group Hash Functions
-  
-  # Converts all keys into strings by calling `#to_s` on them. **Mutates the
-  # hash.**
-  # 
-  # Lifted from ActiveSupport.
-  # 
-  # @param [Hash] hash
-  # 
-  # @return [Hash<String, *>]
-  # 
-  def self.stringify_keys! hash
-    transform_keys! hash, &:to_s
-  end
-  
-  singleton_class.send :alias_method, :to_s_keys!, :stringify_keys!
-  
-  
-  # Returns a new hash with all keys transformed to strings by calling `#to_s`
-  # on them.
-  # 
-  # Lifted from ActiveSupport.
-  # 
-  # @param [Hash] hash
-  # 
-  # @return [Hash<String, *>]
-  # 
-  def self.stringify_keys hash
-    transform_keys hash, &:to_s
-  end
-  
-  singleton_class.send :alias_method, :to_s_keys, :stringify_keys
-  
-  
-  # @todo Document deep_stringify_keys method.
-  # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
-  # 
-  # @return [return_type]
-  #   @todo Document return value.
-  # 
-  def self.deep_stringify_keys object
-    deep_transform_keys object, &:to_s
-  end # .deep_stringify_keys
-  
-  singleton_class.send :alias_method, :to_s_keys_r, :deep_stringify_keys
-  
-
-end # module NRSER

data/lib/nrser/functions/hash/symbolize_keys.rb

@@ -1,57 +0,0 @@
-# Definitions
-# =======================================================================
-
-module NRSER
-  
-  # @!group Hash Functions
-  
-  # Mutates `hash` by converting all keys that respond to `#to_sym` to symbols.
-  # 
-  # Lifted from ActiveSupport.
-  # 
-  # @see http://www.rubydoc.info/gems/activesupport/5.1.3/Hash:symbolize_keys!
-  # 
-  # @param [Hash] hash
-  # 
-  # @return [Hash]
-  # 
-  def self.symbolize_keys! hash
-    transform_keys!(hash) { |key| key.to_sym rescue key }
-  end # .symbolize_keys!
-  
-  singleton_class.send :alias_method, :to_sym_keys!, :symbolize_keys!
-  
-  
-  # Returns a new hash with all keys that respond to `#to_sym` converted to
-  # symbols.
-  # 
-  # Lifted from ActiveSupport.
-  # 
-  # @see http://www.rubydoc.info/gems/activesupport/5.1.3/Hash:symbolize_keys
-  # 
-  # @param [Hash] hash
-  # 
-  # @return [Hash]
-  # 
-  def self.symbolize_keys hash
-    # File 'lib/active_support/core_ext/hash/keys.rb', line 54
-    transform_keys(hash) { |key| key.to_sym rescue key }
-  end
-  
-  singleton_class.send :alias_method, :to_sym_keys, :symbolize_keys
-  
-  
-  # @todo Document deep_symbolize_keys method.
-  # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
-  # 
-  # @return [return_type]
-  #   @todo Document return value.
-  # 
-  def self.deep_symbolize_keys object, &block
-    deep_transform_keys( object ) { |key| key.to_sym rescue key }
-  end # .deep_symbolize_keys
-  
-
-end # module NRSER

data/lib/nrser/functions/hash/transform_keys.rb

@@ -1,140 +0,0 @@
-module NRSER
-  
-  # @!group Hash Functions
-  
-  # Lifted from ActiveSupport.
-  # 
-  # @see http://www.rubydoc.info/gems/activesupport/5.1.3/Hash:transform_keys!
-  # 
-  # @param [Hash] hash
-  #   Hash to mutate keys.
-  # 
-  # @return [Hash]
-  #   The mutated hash.
-  # 
-  def self.transform_keys! hash
-    # File 'lib/active_support/core_ext/hash/keys.rb', line 23
-    hash.keys.each do |key|
-      hash[yield(key)] = hash.delete(key)
-    end
-    hash
-  end
-  
-  
-  # Returns a new hash with each key transformed by the provided block.
-  # 
-  # Lifted from ActiveSupport.
-  # 
-  # @see http://www.rubydoc.info/gems/activesupport/5.1.3/Hash:transform_keys
-  # 
-  # @param [Hash] hash
-  # 
-  # @return [Hash]
-  #   New hash with transformed keys.
-  # 
-  def self.transform_keys hash, &block
-    # File 'lib/active_support/core_ext/hash/keys.rb', line 12
-    result = {}
-    hash.each_key do |key|
-      result[yield(key)] = hash[key]
-    end
-    result
-  end
-  
-  # My-style names
-  singleton_class.send :alias_method, :map_keys,  :transform_keys
-  singleton_class.send :alias_method, :rekey,     :transform_keys
-  
-  
-  # Deeply transform Hash keys that we can find by traversing Hash and Array
-  # instances that we can find from `object` and piping keys through `block`.
-  # 
-  # @example Hash top node
-  #   
-  #   NRSER.deep_transform_keys({
-  #     people: {
-  #       jane: {fav_color: 'red'},
-  #       joe:  {fav_color: 'blue'},
-  #     }
-  #   }) { |key| key.to_s.upcase }
-  #   # => {
-  #   # "PEOPLE" => {
-  #   #   "JANE" => {"FAV_COLOR" => 'red'},
-  #   #   "JOE"  => {"FAV_COLOR" => 'blue'},
-  #   # }
-  # 
-  # @example Array top node
-  #   
-  #   NRSER.deep_transform_keys(
-  #     [{x: 2}, {y: 'blue'}, 3]
-  #   ) { |key| key.to_s.upcase }
-  #   # => [{'X' => 2}, {'Y' => 'blue'}, 3]
-  # 
-  # 
-  # @example Non-array or hash value
-  #   
-  #   NRSER.deep_transform_keys 'blah'
-  #   # => 'blah'
-  # 
-  # From ActiveSupport.
-  # 
-  # @see http://www.rubydoc.info/gems/activesupport/5.1.3/Hash:deep_transform_keys
-  # 
-  # @todo Maybe this is a tree function?
-  # 
-  # @param [Object] object
-  #   Anything; see examples.
-  # 
-  # @param [Proc] &block
-  #   Proc that should accept each key as it's only argument and return the
-  #   new key to replace it with.
-  # 
-  def self.deep_transform_keys object, &block
-    case object
-    when Hash
-      object.each_with_object( {} ) do |(key, value), result|
-        result[block.call( key )] = deep_transform_keys value, &block
-      end
-    when Array
-      object.map { |entry| deep_transform_keys entry, &block }
-    else
-      object
-    end
-  end
-  
-  singleton_class.send :alias_method, :deep_map_keys, :deep_transform_keys
-  singleton_class.send :alias_method, :map_keys_r,    :deep_transform_keys
-  singleton_class.send :alias_method, :deep_rekey,    :deep_transform_keys
-  singleton_class.send :alias_method, :rekey_r,       :deep_transform_keys
-  
-  
-  # Like {NRSER.deep_transform_keys} but mutates the objects (works in place).
-  # 
-  # @param object (see NRSER.deep_transform_keys)
-  # @param &block (see NRSER.deep_transform_keys)
-  # 
-  # @return [Object]
-  #   The `object` that was passed in, post mutations.
-  # 
-  def self.deep_transform_keys! object, &block
-    case object
-    when Hash
-      object.keys.each do |key|
-        value = object.delete key
-        object[block.call( key )] = deep_transform_keys! value, &block
-      end
-      object
-    when Array
-      object.map! {|e| deep_transform_keys!(e, &block)}
-    else
-      object
-    end
-  end
-  
-  singleton_class.send :alias_method, :deep_map_keys!, :deep_transform_keys!
-  singleton_class.send :alias_method, :map_keys_r!,    :deep_transform_keys!
-  singleton_class.send :alias_method, :deep_rekey!,    :deep_transform_keys!
-  singleton_class.send :alias_method, :rekey_r!,       :deep_transform_keys!
-  
-
-end # module NRSER

data/lib/nrser/functions/module/methods.rb

@@ -1,206 +0,0 @@
-# encoding: UTF-8
-# frozen_string_literal: true
-##
-# Functions to get {Method} and {UnboundMethod} instances for class and
-# instance methods (respectively) of a {Module}.
-# 
-# @note
-#   Methods added to {NRSER::Ext::Module} can't be named the same as they will
-#   be in the extension due to shadowing.
-# 
-## 
-
-
-# Definitions
-# =======================================================================
-
-module NRSER
-  
-  # @!group Module Functions
-  # ==========================================================================
-  
-  # Core private method that supports all the other "method getters".
-  # 
-  # @private
-  # 
-  # @param [Module] mod
-  #   Module in question.
-  # 
-  # @param [Boolean] include_super
-  #   When `true`, includes inherited class methods.
-  # 
-  # @param [:class | :instance] type:
-  #   Get class or instance methods.
-  # 
-  # @param [Boolean] sort:
-  #   If `true`, will sort the methods by name, which is usually
-  #   the useful way to look at and use them.
-  # 
-  # @return [Array<(Method | UnboundMethod)>]
-  #   List of method objects (all bound to `mod`).
-  # 
-  def self.method_objects_for mod,
-                              include_super,
-                              type:,
-                              sort:,
-                              include_initialize: false
-    initialize_method = nil
-    
-    get_names, get_method = case type
-    when :class
-      [:methods, :method]
-      
-    when :instance
-      if include_initialize
-        # Only way I can figure out to find out if it is defined it to try
-        # to get the object and handle the error
-        begin
-          initialize_method = mod.instance_method :initialize
-        rescue NameError => error
-        else
-          # Don't want to include it if we're not `include_super` and it's
-          # inherited from a different module
-          unless include_super || initialize_method.owner == mod
-            initialize_method = nil
-          end
-        end
-      end
-      
-      [:instance_methods, :instance_method]
-      
-    else
-      raise ArgumentError,
-        "`type:` must be `:class` or `:instance`, found #{ type.inspect }"
-      
-    end # case type
-    
-    methods = mod.send( get_names, include_super ).map { |name|
-      mod.send get_method, name
-    }
-    
-    methods << initialize_method unless initialize_method.nil?
-    
-    methods.sort! { |a, b| a.name <=> b.name } if sort
-    
-    methods
-  end # .method_objects_for
-  
-  private_class_method :method_objects_for
-  
-  
-  # Get class methods for a {Module} ({Class} are also {Module}, so works
-  # same for those).
-  # 
-  # @param mod            (see .method_objects_for)
-  # @param include_super  (see .method_objects_for)
-  # @param sort:          (see .method_objects_for)
-  # 
-  # @return [Array<Method>]
-  #   List of method objects (all bound to `mod`).
-  # 
-  def self.class_method_objects_for mod, include_super = true, sort: true
-    method_objects_for mod, include_super, type: :class, sort: sort
-  end # .class_method_objects_for
-  
-  # Much shorter name
-  # 
-  # @todo Not sure if I like this...
-  # 
-  singleton_class.send  :alias_method,
-                        :class_Methods_for, :class_method_objects_for
-  
-  
-  # Just get the class methods defined in `mod` itself, omitting inherited
-  # ones.
-  # 
-  # Equivalent to
-  # 
-  #     NRSER.class_method_objects_for false
-  # 
-  # @param mod    (see .class_method_objects_for)
-  # @param sort:  (see .class_method_objects_for)
-  # @return       (see .class_method_objects_for)
-  # 
-  def self.own_class_method_objects_for mod, sort: true
-    class_method_objects_for mod, false, sort: sort
-  end # .own_class_method_objects_for
-  
-  # Much shorter name
-  # 
-  # @todo Not sure if I like this...
-  # 
-  singleton_class.send  :alias_method,
-                        :own_class_Methods_for,
-                        :own_class_method_objects_for
-  
-  
-  # Get instance methods for a {Module} ({Class} are also {Module}, so works
-  # same for those).
-  # 
-  # @param mod            (see .method_objects_for)
-  # @param include_super  (see .method_objects_for)
-  # @param sort:          (see .method_objects_for)
-  # 
-  # @param [Boolean] include_initialize:
-  #   When `true`, include `#initialize` method if it's defined, which is
-  #   normally excluded from {Module#instance_methods}.
-  #   
-  #   Respects  `include_super` - won't include it if we are only looking for
-  #   own instance methods and it's inherited.
-  # 
-  # @return [Array<UnboundMethod>]
-  #   List of method objects (all unbound).
-  # 
-  def self.instance_method_objects_for  mod,
-                                        include_super = true,
-                                        sort: true,
-                                        include_initialize: false
-    method_objects_for \
-      mod,
-      include_super,
-      type: :instance,
-      sort: sort,
-      include_initialize: include_initialize
-  end # .instance_method_objects_for
-  
-  # Much shorter name
-  # 
-  # @todo Not sure if I like this...
-  # 
-  singleton_class.send  :alias_method,
-                        :instance_Methods_for, :instance_method_objects_for
-  
-  
-  # Just get the instance methods defined in `mod` itself, omitting inherited
-  # ones.
-  # 
-  # Equivalent to
-  # 
-  #     NRSER.instance_method_objects_for false
-  # 
-  # @param mod    (see .instance_method_objects_for)
-  # @param sort:  (see .instance_method_objects_for)
-  # @return       (see .instance_method_objects_for)
-  # 
-  def self.own_instance_method_objects_for  mod,
-                                            sort: true,
-                                            include_initialize: false
-    instance_method_objects_for \
-      mod,
-      false,
-      sort: sort,
-      include_initialize: include_initialize
-  end # .own_instance_method_objects_for
-  
-  # Much shorter name
-  # 
-  # @todo Not sure if I like this...
-  # 
-  singleton_class.send  :alias_method,
-                        :own_instance_Methods_for,
-                        :own_instance_method_objects_for
-  
-  
-  # @!endgroup Module Functions
-  
-end # module NRSER