nrser 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea96a298163ec6b20a0437bc7ab7c8ea9200fd99
-  data.tar.gz: c6aabc018e890bfa791e20925b2c32240c4110d7
+  metadata.gz: 20a9f5822833e3797ebf2ec2ba0b6e430ad7346e
+  data.tar.gz: 0dc5e6c87d30f0d9ed99692b33da84a4f2584db9
 SHA512:
-  metadata.gz: 29d05d08cc6d63ee707ad4ce1bf34b4b148a132ee669749ad1a01eb392ba1ef6d842c1be240cbf0ec2d514e3acd320c70e2f84e86376d93ad54a688ffa428244
-  data.tar.gz: 4dc97cdc270fc79692b1a7ffcba3c569ae3649247f78e16b128603933c40ebb05c925fe934b53a5c082f23788cde3444ba4cf7f082143b27274c53104647cac5
+  metadata.gz: 374129784c79fe2897c078beed6e4d7c168e9b2e79027bf293df15403eac73a505176db6238f2c9b14ba8d2ecbda399e61c5f2a57cce4b8ec79a0c7a12ec031e
+  data.tar.gz: ae5a9bb34f77b6d35976fbed02fa85b8267a34b9cfb0a0ec0b4db6b39bae1d38ed08c3c994f27439f437580ebc9023c6d23c19ef827b58691a5aca0969f4e17a

data/lib/nrser/core_ext/pathname.rb

@@ -92,6 +92,16 @@ class Pathname
   end
   
   
+  # Shortcut to call {#to_rel} with `dot_slash=true`.
+  # 
+  # @param base_dir: (see .to_rel)
+  # @return (see .to_rel)
+  # 
+  def to_dot_rel **kwds
+    to_rel **kwds, dot_slash: true
+  end # #to_dot_rel
+  
+  
   # Just a quick cut for `.to_rel.to_s`, since I seem to use that sort of form
   # a lot.
   # 
@@ -99,8 +109,18 @@ class Pathname
   # 
   # @return [String]
   # 
-  def to_rel_s *args
-    to_rel( *args ).to_s
+  def to_rel_s **kwds
+    to_rel( **kwds ).to_s
+  end
+  
+  
+  # Shortcut to call {#to_rel_s} with `dot_slash=true`.
+  # 
+  # @param base_dir: (see .to_rel_s)
+  # @return (see .to_rel_s)
+  # 
+  def to_dot_rel_s **kwds
+    to_rel_s( **kwds, dot_slash: true ).to_s
   end
   
 end # class Pathname

data/lib/nrser/ext/tree.rb

@@ -1,10 +1,27 @@
-module NRSER::Ext; end
+# frozen_string_literal: true
+# encoding: UTF-8
+
+
+# Requirements
+# ========================================================================
+
+# Project / Package
+# ------------------------------------------------------------------------
+
+require 'nrser/functions/tree'
+
+
+# Namespace
+# ========================================================================
+
+module NRSER
+module Ext
 
 
 # Instance methods that are refined in to the Ruby built-ins that we consider
 # trees: {Array}, {Hash} and {OpenStruct}.
 # 
-module NRSER::Ext::Tree
+module Tree
   
   # Sends `self` to {NRSER.leaves}.
   def leaves
@@ -39,4 +56,11 @@ module NRSER::Ext::Tree
     NRSER.map_tree self, **options, &block
   end
   
-end # module NRSER::Ext::Tree
+end # module Tree
+
+
+# /Namespace
+# ========================================================================
+
+end # module Ext
+end # module NRSER

data/lib/nrser/gem_ext/hamster/hash.rb

@@ -0,0 +1,53 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Deps
+# -----------------------------------------------------------------------
+
+require 'hamster'
+
+require 'nrser/ext/tree'
+
+
+# Namespace
+# =======================================================================
+
+module  Hamster
+
+
+# Definitions
+# =======================================================================
+
+class Hash
+  
+  include NRSER::Ext::Tree
+  
+  # Instance Methods
+  # ========================================================================
+  
+  def to_mutable
+    each_with_object( {} ) { |(key, value), hash|
+      hash[ Hamster.to_mutable key ] = Hamster.to_mutable value
+    }
+  end
+  
+  
+  def as_json options = nil
+    to_h.as_json options
+  end
+  
+  
+  def to_yaml *args, &block
+    to_mutable.to_yaml *args, &block
+  end
+  
+end # class Hash
+
+
+# /Namespace
+# =======================================================================
+
+end # module Hamster

data/lib/nrser/gem_ext/hamster/set.rb

@@ -0,0 +1,69 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# ----------------------------------------------------------------------------
+
+require 'set'
+
+# Deps
+# -----------------------------------------------------------------------
+
+require 'hamster'
+
+require 'nrser/ext/tree'
+
+
+# Namespace
+# =======================================================================
+
+module  Hamster
+
+
+# Definitions
+# =======================================================================
+
+class Set
+  
+  # Instance Methods
+  # ========================================================================
+  
+  def to_mutable
+    each_with_object( ::Set[] ) { |member, set|
+      set << Hamster.to_mutable( member )
+    }
+  end
+  
+  
+  def to_mutable_array
+    each_with_object( [] ) { |member, array|
+      array << Hamster.to_mutable( member )
+    }
+  end
+  
+  
+  def to_h
+    each_with_object( {} ) { |member, hash| hash[member] = true }
+  end
+  
+  
+  def as_json options = nil
+    to_mutable_array.to_json options
+    # { '$set' => to_h.as_json( options ) }
+  end
+  
+  
+  def to_yaml *args, &block
+    to_mutable.to_yaml *args, &block
+  end
+  
+end # class Hash
+
+
+# /Namespace
+# =======================================================================
+
+end # module Hamster

data/lib/nrser/gem_ext/hamster/sorted_set.rb

@@ -0,0 +1,69 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# ----------------------------------------------------------------------------
+
+require 'set'
+
+# Deps
+# -----------------------------------------------------------------------
+
+require 'hamster'
+
+require 'nrser/ext/tree'
+
+
+# Namespace
+# =======================================================================
+
+module  Hamster
+
+
+# Definitions
+# =======================================================================
+
+class SortedSet
+  
+  # Instance Methods
+  # ========================================================================
+  
+  def to_mutable
+    each_with_object( ::SortedSet[] ) { |member, set|
+      set << Hamster.to_mutable( member )
+    }
+  end
+  
+  
+  def to_mutable_array
+    each_with_object( [] ) { |member, array|
+      array << Hamster.to_mutable( member )
+    }
+  end
+  
+  
+  def to_h
+    each_with_object( {} ) { |member, hash| hash[member] = true }
+  end
+  
+  
+  def as_json options = nil
+    to_mutable_array.to_json options
+    # { '$set' => to_h.as_json( options ) }
+  end
+  
+  
+  def to_yaml *args, &block
+    to_mutable.to_yaml *args, &block
+  end
+  
+end # class Hash
+
+
+# /Namespace
+# =======================================================================
+
+end # module Hamster

data/lib/nrser/gem_ext/hamster/vector.rb

@@ -0,0 +1,53 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Deps
+# -----------------------------------------------------------------------
+
+require 'hamster'
+
+require 'nrser/ext/tree'
+
+
+# Namespace
+# =======================================================================
+
+module  Hamster
+
+
+# Definitions
+# =======================================================================
+
+class Vector
+  
+  include NRSER::Ext::Tree
+  
+  # Instance Methods
+  # ========================================================================
+  
+  def to_mutable
+    each_with_object( [] ) { |entry, array|
+      array << Hamster.to_mutable( entry )
+    }
+  end
+  
+  
+  def as_json options = nil
+    to_mutable.as_json options
+  end
+  
+  
+  def to_yaml *args, &block
+    to_mutable.to_yaml *args, &block
+  end
+  
+end # class Hash
+
+
+# /Namespace
+# =======================================================================
+
+end # module Hamster

data/lib/nrser/gem_ext/hamster.rb

@@ -0,0 +1,36 @@
+require 'set'
+
+require 'hamster'
+require_relative './hamster/hash'
+require_relative './hamster/vector'
+require_relative './hamster/set'
+require_relative './hamster/sorted_set'
+
+module Hamster
+  # def self.regrow each_pair: ::Hash, each_index: ::Array, each:
+  
+  def self.to_mutable obj
+    if obj.respond_to? :to_mutable
+      obj.to_mutable
+      
+    elsif ::Array === obj
+      obj.map { |e| to_mutable e }
+      
+    elsif ::Hash === obj
+      obj.each_with_object( {} ) { |(k, v), h|
+        h[ to_mutable k ] = to_mutable v
+      }
+      
+    elsif ::SortedSet === obj
+      ::SortedSet.new obj.map { |m| to_mutable m }
+      
+    elsif ::Set === obj
+      ::Set.new obj.map { |m| to_mutable m }
+      
+    else
+      obj
+      
+    end
+  end # .to_mutable
+  
+end

data/lib/nrser/labs/i8.rb

@@ -0,0 +1,233 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+require 'set'
+
+# Deps
+# -----------------------------------------------------------------------
+require 'hamster'
+
+# Project / Package
+# -----------------------------------------------------------------------
+require 'nrser/errors/type_error'
+require 'nrser/props/immutable/hash'
+require 'nrser/props/immutable/vector'
+
+require 'nrser/refinements/types'
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+# Sick of typing "Hamster::Hash"...
+# 
+# Experimental Hamster sugary sweet builder shortcut things.
+# 
+module I8
+  
+  # Easy way to get the class names shorter..?
+  class Vector < Hamster::Vector; end
+  class Hash < Hamster::Hash; end
+  class Set < Hamster::Set; end
+  class SortedSet < Hamster::SortedSet; end
+  # class List < Hamster::List; end # Not a class! Ugh...
+  
+  
+  module Struct
+    
+    def self.check_new_args! vector_prop_defs, hash_prop_defs
+      
+      unless  (vector_prop_defs.empty? && !hash_prop_defs.empty?) ||
+              (!vector_prop_defs.empty? && hash_prop_defs.empty?)
+        
+        raise NRSER::ArgumentError.new \
+          "Exactly one of *args or **kwds must be empty",
+          
+          args: vector_prop_defs,
+          
+          kwds: hash_prop_defs,
+          
+          details: -> {%{
+            {I8::Struct.define} proxies to either
+            
+            1.  {I8::Struct::Vector.define}
+            2.  {I8::Struct::Hash.define}
+            
+            depending on *where* the property definitions are passed:
+            
+            1.  Positionally in `*args` -> {I8::Struct::Vector.new}
+            2.  By name in `**kwds` -> {I8::Struct::Hash.new}
+            
+            Examples:
+            
+            1.  Create a Point struct backed by an {I8::Vector}:
+                
+                    Point = I8::Struct.define [x: t.int], [y: t.int]
+                
+            2.  Create a Point struct backed by an {I8::Hash}:
+                
+                    Point = I8::Struct.define x: t.int, y: t.int
+            
+          }}
+        
+      end # unless vector_prop_defs.empty? XOR hash_prop_defs.empty?
+      
+    end # .check_new_args!
+    
+    private_class_method :check_new_args!
+    
+    
+    def self.define *vector_prop_defs, **hash_prop_defs, &body
+      check_new_args! vector_prop_defs, hash_prop_defs
+      
+      if !vector_prop_defs.empty?
+        raise "not implemented"
+        # I8::Struct::Vector.new
+      else
+        I8::Struct::Hash.new **hash_prop_defs, &body
+      end
+    end
+    
+    singleton_class.send :alias_method, :new, :define
+    
+    
+  end # module Struct
+  
+  
+  class Struct::Hash < I8::Hash
+    include I8::Struct
+    include NRSER::Props::Immutable::Hash
+    
+    def self.define **prop_defs, &body
+      Class.new( I8::Struct::Hash ) do
+        prop_defs.each do |name, settings|
+          kwds = t.match settings,
+            t.type, ->( type ) {{ type: type }},
+            t.hash_, settings
+          
+          prop name, **kwds
+        end
+        
+        class_exec &body if body
+      end
+    end
+    
+    def self.new *args, **kwds, &block
+      if self == I8::Struct::Hash
+        define *args, **kwds, &block
+      else
+        # See NOTE in {I8::Struct::Vector.new}
+        if kwds.empty?
+          super( *args, &block )
+        else
+          super( *args, **kwds, &block )
+        end
+      end
+    end
+  end
+  
+  
+  class Struct::Vector < I8::Vector
+    include I8::Struct
+    include NRSER::Props::Immutable::Vector
+    
+    def self.define *prop_defs, &body
+      # Unwrap `[name: type]` format
+      prop_defs.map! { |prop_def|
+        if  ::Array === prop_def &&
+            prop_def.length == 1 &&
+            ::Hash === prop_def[0]
+          prop_def[0]
+        else
+          prop_def
+        end
+      }
+      
+      # Check we have a list of pairs with label keys
+      t.array( t.pair( key: t.label ) ).check! prop_defs
+      
+      Class.new( I8::Struct::Vector ) do
+        prop_defs.each_with_index do |pair, index|
+          name, settings = pair.first
+          
+          kwds = t.match settings,
+            t.type, ->( type ) {{ type: type }},
+            t.hash_, settings
+          
+          prop name, **kwds, index: index
+        end
+        
+        class_exec &body if body
+      end
+    end
+    
+    
+    def self.new *args, **kwds, &block
+      if self == I8::Struct::Vector
+        unless kwds.empty?
+          raise NRSER::ArgumentError.new \
+            "Can not supply keyword args",
+            args: args,
+            kwds: kwds
+        end
+    
+        define *args, &block
+      else
+        # NOTE  This is... weird. Just doing the normal
+        #       
+        #           super( *args, **kwds, &block )
+        #       
+        #       results in `*args` becoming `[*args, {}]` up the super chain
+        #       when `kwds` is empty.
+        #       
+        #       I can't say I can understand it, but I seem to be able to fix
+        #       it.
+        # 
+        if kwds.empty?
+          super( *args, &block )
+        else
+          super( *args, **kwds, &block )
+        end
+      end
+    end
+    
+  end # class Struct::Vector
+  
+  
+  def self.[] value
+    case value
+    when  Hamster::Hash,
+          Hamster::Vector,
+          Hamster::Set,
+          Hamster::SortedSet,
+          Hamster::List
+      value
+    when ::Hash
+      I8::Hash[value]
+    when ::Array
+      I8::Vector.new value
+    when ::Set
+      I8::Set.new value
+    when ::SortedSet
+      I8::SortedSet.new value
+    else
+      raise NRSER::TypeError.new \
+        "Value must be Hash, Array, Set or SortedSet",
+        found: value
+    end
+  end # .[]
+  
+end # module I8
+
+
+# Method proxy to {I8.[]} allowing for different syntaxes.
+# 
+def I8 value = nil
+  I8[ value || yield ]
+end

data/lib/nrser/log/types.rb

@@ -0,0 +1,82 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Need {SemanticLogger::LEVELS}
+require 'semantic_logger'
+
+
+# Refinements
+# =======================================================================
+
+require 'nrser/refinements/types'
+using NRSER::Types
+
+
+# Namespace
+# =======================================================================
+
+module  NRSER
+module  Log
+
+
+# Definitions
+# =======================================================================
+
+# Types for logging type things.
+# 
+# @note
+#   This module is **NOT** required when loading {NRSER::Log}, and it **NEVER**
+#   should be! It is here for *other* gems and apps that depend on {NRSER}
+#   to use.
+#   
+#   Core logging should have the absolute minimal dependencies, because it's
+#   pretty much always going to be loaded and nothing it depends on can use
+#   it when loading up.
+#   
+module Types
+  extend NRSER::Types::Factory
+  
+  def_factory :level do |
+    name: 'LogLevel',
+    from_s: ->( string ) { string.to_sym },
+    **options
+  |
+    t.in SemanticLogger::LEVELS, from_s: from_s, name: name, **options
+  end
+  
+  
+  def_factory :stdio do |
+    name: 'StdIO',
+    
+    from_s: ->( string ) {
+      case string
+      when '$stdout'
+        $stdout
+      when '$stderr'
+        $stderr
+      when 'STDOUT'
+        STDOUT
+      when 'STDERR'
+        STDERR
+      end
+    },
+    
+    **options
+  |
+    t.is_a IO, name: name, from_s: from_s, **options
+  end
+  
+end # module Types
+
+
+# /Namespace
+# =======================================================================
+
+end # module Log
+end # module NRSER

data/lib/nrser/log.rb

@@ -19,6 +19,8 @@ require "concurrent/map"
 # Project / Package
 # -----------------------------------------------------------------------
 
+# Using {NRSER.truthy?} for ENV var values.
+require 'nrser/functions/object/truthy'
 
 # Definitions
 # =======================================================================
@@ -38,10 +40,6 @@ module NRSER::Log
   require_relative './log/appender'
   
   
-  # Constants
-  # ========================================================================
-  
-  
   # Mixins
   # ========================================================================
   
@@ -359,14 +357,14 @@ module NRSER::Log
   # @param  (see .setup!)
   # @return (see .setup!)
   # 
-  def self.setup_for_CLI! dest: $stderr,
+  def self.setup_for_cli! dest: $stderr,
                           sync: true,
                           **kwds
     setup! dest: dest, sync: sync, **kwds
-  end # .setup_for_CLI!
+  end # .setup_for_cli!
   
-  # Old name
-  singleton_class.send :alias_method, :setup_for_cli!, :setup_for_CLI!
+  # Was the new name, then realized it was dumb and switched back :D
+  singleton_class.send :alias_method, :setup_for_CLI!, :setup_for_cli!
   
   
   # Call {.setup!} with some default keywords that are nice for interactive
@@ -696,6 +694,9 @@ module NRSER::Log
     old_appender = @appender
     
     @appender = case dest
+    when false
+      # Used to remove the appender and set {.appender} to `nil`.
+      nil
     when SemanticLogger::Subscriber, Hash
       # Can be handled directly
       SemanticLogger.add_appender dest

data/lib/nrser/rspex/example_group/describe_called_with.rb

@@ -18,7 +18,7 @@ module NRSER::RSpex::ExampleGroup
   # @param [Array] *args
   #   Arguments to call `subject` with to produce the new subject.
   # 
-  # @param [#call] &block
+  # @param [#call] &body
   #   Block to execute in the context of the example group after refining
   #   the subject.
   # 
@@ -34,4 +34,25 @@ module NRSER::RSpex::ExampleGroup
   # Short / old name
   alias_method :called_with, :describe_called_with
   
+  
+  # Version of {#describe_called_with} for when you have no arguments.
+  # 
+  # @param [#call] &body
+  #   Block to execute in the context of the example group after refining
+  #   the subject.
+  # 
+  # @return [void]
+  # 
+  def describe_called &body
+    describe_x Args(),
+      type: :called_with,
+      subject_block: -> { super().call },
+      &body
+  end
+  
+  alias_method :called, :describe_called
+  alias_method :when_called, :describe_called
+  
+  
+  
 end # module NRSER::RSpex::ExampleGroup

data/lib/nrser/rspex/example_group/describe_instance.rb

@@ -2,13 +2,13 @@
 
 module NRSER::RSpex::ExampleGroup
   
-  # @todo Document describe_instance method.
+  # Describe an instance of the described class by providing arguments for
+  # it's construction.
   # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
+  # @param [Array] *constructor_args
+  #   Arguments to pass to `.new` on {#described_class} to create instances.
   # 
-  # @return [return_type]
-  #   @todo Document return value.
+  # @return [void]
   # 
   def describe_instance *constructor_args, &body
     describe_x ".new", Args(*constructor_args),

data/lib/nrser/types/combinators.rb

@@ -119,7 +119,7 @@ module NRSER::Types
         if type.has_from_data?
           begin
             return check!( type.from_data data )
-          rescue Exception => error
+          rescue StandardError => error
             errors << error
           end
         end

data/lib/nrser/types/factory.rb

@@ -78,7 +78,9 @@ module NRSER::Types::Factory
         maybe_options = options.slice *maybe_option_keys
         factory_options = options.except *maybe_option_keys
         
-        maybe public_send( name, *args, **factory_options ), **maybe_options
+        NRSER::Types.maybe \
+          public_send( name, *args, **factory_options ),
+          **maybe_options
       end
       
       aliases.each do |alias_name|

data/lib/nrser/types/is_a.rb

@@ -89,4 +89,10 @@ module NRSER::Types
   def_factory :is_a do |mod, **options|
     IsA.new mod, **options
   end
+  
+  
+  def_factory :type do |**options|
+    is_a NRSER::Types::Type
+  end
+  
 end # NRSER::Types

data/lib/nrser/types/maybe.rb

@@ -1,18 +1,91 @@
-require_relative './combinators'
-require_relative './nil'
+# Requirements
+# ========================================================================
 
-module NRSER::Types
-    
-  # Type satisfied by `nil` or the parametrized type.
+# Project / Package
+# ------------------------------------------------------------------------
+
+require_relative './is_a'
+
+
+# Namespace
+# ========================================================================
+
+module NRSER
+module Types
+
+
+# Definitions
+# ========================================================================
+  
+class Maybe < Type
+  
+  # Attributes
+  # ========================================================================
+  
+  # The type of all members besides `nil`.
   # 
-  def_factory(
-    :maybe,
-  ) do |type, **options|
-    union \
-      self.nil,
-      type,
-      name: (options[:name] || "#{ type.name }?"),
-      **options
+  # @return [Type]
+  #     
+  attr_reader :type
+  
+    
+  # Constructor
+  # ======================================================================
+  
+  # Instantiate a new `NRSER::Types::Maybe`.
+  def initialize type, **options
+    super **options
+    @type = NRSER::Types.make type
+  end # #initialize
+  
+  
+  # Instance Methods
+  # ========================================================================
+  
+  def test? value
+    value.nil? || @type.test?( value )
   end
   
-end # NRSER::Types
+  
+  def explain
+    "#{ @type.name }?"
+  end
+  
+  
+  def has_from_s?
+    !@from_s.nil? || type.has_from_s?
+  end
+  
+  
+  def custom_from_s string
+    type.from_s string
+  end
+  
+end # class Maybe
+
+
+# @!group Type Factory Functions
+# ----------------------------------------------------------------------------
+
+# @!method
+#   Type satisfied by `nil` or the parametrized type.
+#   
+#   @param [Type] type
+#     The type values must be if they are not `nil`.
+#   
+#   @param **options (see Type.initialize)
+# 
+#   @return [Type]
+# 
+def_factory :maybe do |type, **options|
+  Maybe.new type, **options
+end
+
+# @!endgroup Type Factory Functions # ****************************************
+
+
+# /Namespace
+# ========================================================================
+
+end # module Types
+end # module NRSER

data/lib/nrser/types/paths.rb

@@ -44,11 +44,12 @@ module NRSER::Types
   end
   
   
-  # A path is a non-empty {String} or {Pathname}.
-  # 
-  # @param **options see NRSER::Types::Type#initialize
-  # 
-  # @return [NRSER::Types::Type]
+  # @!method
+  #   A path is a non-empty {String} or {Pathname}.
+  #   
+  #   @param **options see NRSER::Types::Type#initialize
+  #   
+  #   @return [NRSER::Types::Type]
   # 
   def_factory :path do |name: 'Path', **options|
     one_of \

data/lib/nrser/version.rb

@@ -18,7 +18,7 @@ module NRSER
   # 
   # @return [String]
   # 
-  VERSION = '0.3.7'
+  VERSION = '0.3.8'
   
   
   module Version

data/lib/nrser.rb

@@ -69,6 +69,8 @@ require_relative './nrser/core_ext/binding'
 # Then everything else...
 require_relative './nrser/char'
 require_relative './nrser/errors'
+require 'nrser/gem_ext/hamster'
+
 require_relative './nrser/no_arg'
 require_relative './nrser/message'
 require_relative './nrser/collection'

data/spec/lib/nrser/gem_ext/hamster/to_mutable_spec.rb

@@ -0,0 +1,114 @@
+require 'nrser/labs/i8'
+
+describe_spec_file(
+  spec_path:        __FILE__,
+  module:           Hamster,
+) do
+  
+  describe_setup %{
+    Converting Hamsters to regular structures with their `#to_mutable`
+  }.squish do
+    
+    it %{ gets immutable objects nested inside mutable ones } do
+      
+      # Because `I8({ x: 1 }) == { x: 1 }` (which is usually probably very nice
+      # to have) we have to do more than just compare with `==`.
+      # 
+      # I *think* this accomplishes what we want...
+      # 
+      def class_match actual, expected
+        return false unless actual == expected &&
+                            actual.class == expected.class &&
+                            actual.eql?( expected ) # This alone is prob
+                                                    # enough...
+        
+        case expected
+        when ::Hash, ::Array
+          expected.each_branch do |key, expected_value|
+            return false unless class_match( expected_value, actual[key] )
+          end
+        when ::Set
+          expected.each do |expected_value|
+            return false unless actual.include?( expected_value )
+          end
+        end
+        
+        true
+      end
+      
+      expect(
+        class_match(
+          I8({ x: { y: I8({ z: 1 }) } }).to_mutable,
+          { x: { y: { z: 1 } } }
+        )
+      ).to be true
+      
+      expect(
+        class_match(
+          I8({ x: { y: I8({ z: 1 }) } }).to_mutable,
+          { x: { y: { z: 1 } } },
+        )
+      ).to be true
+      
+      expect(
+        class_match(
+          I8({ items: [ I8({ id: 1 }), I8({ id: 2 }) ] }).to_mutable,
+          { items: [ { id: 1 }, {id: 2 } ] },
+        )
+      ).to be true
+      
+      expect(
+        class_match(
+          I8({ items: Set[ I8({ id: 1 }), I8({ id: 2 }) ] }).to_mutable,
+          { items: Set[ { id: 1 }, {id: 2 } ] },
+        )
+      ).to be true
+    end
+  
+  end # setup
+  
+  
+  describe_class Hamster::Hash do
+    describe_instance x: 1, y: 2, z: 3 do
+      describe_method :to_mutable do
+        when_called do
+          it { is_expected.to be_a( ::Hash ).and eq( {x: 1, y: 2, z: 3} ) }
+        end
+      end
+    end
+  end
+  
+  
+  describe_class Hamster::Vector do
+    describe_instance [1, 2, 3] do
+      describe_method :to_mutable do
+      when_called do
+          it { is_expected.to be_a( ::Array ).and eq [1, 2, 3] }
+        end
+      end
+    end
+  end
+  
+  
+  describe_class Hamster::Set do
+    describe_instance [1, 2, 3] do
+      describe_instance_method :to_mutable do
+        when_called {
+          it { is_expected.to be_a( ::Set ).and eq ::Set[1, 2, 3] }
+        }
+      end
+    end
+  end
+  
+  
+  describe_class Hamster::SortedSet do
+    describe_instance [1, 2, 3] do
+      describe_instance_method :to_mutable do
+        when_called {
+          it { is_expected.to be_a( ::SortedSet ).and eq ::SortedSet[1, 2, 3] }
+        }
+      end
+    end
+  end
+  
+end # Spec File Description

data/spec/lib/nrser/props/immutable/vector_spec.rb

@@ -57,7 +57,7 @@ describe NRSER::Props::Immutable::Vector do
         # defined classes.
         def self.name; 'Point2DInt'; end
         
-        # It's vital that we include the `key:` keyword argument, and that the
+        # It's vital that we include the `index:` keyword argument, and that the
         # values are non-negative integer indexes for the vector.
         prop :x, type: t.int, index: 0
         prop :y, type: t.int, index: 1

data/spec/spec_helper.rb

@@ -32,6 +32,13 @@ RSpec.configure do |config|
   
   config.example_status_persistence_file_path = \
     NRSER::ROOT / 'tmp' / ".rspec_status"
+    
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nrser
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-23 00:00:00.000000000 Z
+date: 2018-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hamster
@@ -317,10 +317,16 @@ files:
 - lib/nrser/functions/tree/map_leaves.rb
 - lib/nrser/functions/tree/map_tree.rb
 - lib/nrser/functions/tree/transform.rb
+- lib/nrser/gem_ext/hamster.rb
+- lib/nrser/gem_ext/hamster/hash.rb
+- lib/nrser/gem_ext/hamster/set.rb
+- lib/nrser/gem_ext/hamster/sorted_set.rb
+- lib/nrser/gem_ext/hamster/vector.rb
 - lib/nrser/graph/tsorter.rb
 - lib/nrser/labs.rb
 - lib/nrser/labs/core_ext/binding.rb
 - lib/nrser/labs/globlin.rb
+- lib/nrser/labs/i8.rb
 - lib/nrser/labs/index.rb
 - lib/nrser/labs/stash.rb
 - lib/nrser/log.rb
@@ -332,6 +338,7 @@ files:
 - lib/nrser/log/logger.rb
 - lib/nrser/log/mixin.rb
 - lib/nrser/log/plugin.rb
+- lib/nrser/log/types.rb
 - lib/nrser/mean_streak.rb
 - lib/nrser/mean_streak/document.rb
 - lib/nrser/message.rb
@@ -443,11 +450,12 @@ files:
 - spec/lib/nrser/functions/text/words_spec.rb
 - spec/lib/nrser/functions/tree/each_branch_spec.rb
 - spec/lib/nrser/functions/tree/leaves_spec.rb
-- spec/lib/nrser/functions/tree/map_branch_spec.rb
+- spec/lib/nrser/functions/tree/map_branches_spec.rb
 - spec/lib/nrser/functions/tree/map_tree_spec.rb
 - spec/lib/nrser/functions/tree/transform_spec.rb
 - spec/lib/nrser/functions/tree/transformer_spec.rb
 - spec/lib/nrser/gem_ext/hamster/json_spec.rb
+- spec/lib/nrser/gem_ext/hamster/to_mutable_spec.rb
 - spec/lib/nrser/labs/globlin_spec.rb
 - spec/lib/nrser/labs/index_spec.rb
 - spec/lib/nrser/mean_streak/design_spec.rb
@@ -535,11 +543,12 @@ test_files:
 - spec/lib/nrser/functions/text/words_spec.rb
 - spec/lib/nrser/functions/tree/each_branch_spec.rb
 - spec/lib/nrser/functions/tree/leaves_spec.rb
-- spec/lib/nrser/functions/tree/map_branch_spec.rb
+- spec/lib/nrser/functions/tree/map_branches_spec.rb
 - spec/lib/nrser/functions/tree/map_tree_spec.rb
 - spec/lib/nrser/functions/tree/transform_spec.rb
 - spec/lib/nrser/functions/tree/transformer_spec.rb
 - spec/lib/nrser/gem_ext/hamster/json_spec.rb
+- spec/lib/nrser/gem_ext/hamster/to_mutable_spec.rb
 - spec/lib/nrser/labs/globlin_spec.rb
 - spec/lib/nrser/labs/index_spec.rb
 - spec/lib/nrser/mean_streak/design_spec.rb