nrser 0.0.23 → 0.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bce188e694cb5fd687f3085a43602dc303a1c1ab
-  data.tar.gz: affc25e12e51d899523c3a5fe5db6c498a997d8b
+  metadata.gz: ad84454dbdd85a4a86dbb940a0901cafe0effaef
+  data.tar.gz: 9992915527ce7f7749aac2d9bdf319a05507fd23
 SHA512:
-  metadata.gz: 1946f2af31a5f40a84533d114d02513729308eb7ba06d3a2fd2f57ed1d4326718432a9aff3e64bb8be1e38703ffe1663bacc0ba0beeb67b68018472b2c8ab941
-  data.tar.gz: '08ac5aff6d524538547eef3b00e07aa916301b83bb6812980af20d341c714a25dfcd0d1a8957cf939fd112becdac7b3182507c20c97913d56b08888d7639d60e'
+  metadata.gz: 995db23a4d353e6a54fec4480e3d17175b99efb75a0a08cc0583a3b166fa1153a26ce58b66d2b592306a17d495ca3544a805a06a03fb06516337f072ee22eb91
+  data.tar.gz: 47488b4ca3a7655f5264578a6e9283b04e2e1148093c72ec032cbc03720f098d6e7531cd44ccc1e20f9ec3e4ea063a905fb4f4699b6793042a816e0a7f5d6ca7

data/lib/nrser/enumerable.rb

@@ -115,7 +115,7 @@ module NRSER
           key = block.call element
           
           if result.key? key
-            raise NRSER::ConflictError.dedented <<-END
+            raise NRSER::ConflictError.new NRSER.dedent <<-END
               Key #{ key.inspect } is already in results with value:
               
               #{ result[key].pretty_inspect }

data/lib/nrser/refinements/array.rb

@@ -13,5 +13,33 @@ module NRSER
       NRSER.rest self
     end # #rest
     
+    
+    # Returns a lambda that calls accepts a single arg and calls `#dig` on it
+    # with the elements of *this* array as arguments.
+    # 
+    # @example
+    #   list = [{id: 1, name: "Neil"}, {id: 2, name: "Mica"}]
+    #   list.to_h_by &[:id].digger
+    #   # =>  {
+    #   #       1 => {id: 1, name: "Neil"},
+    #   #       2 => {id: 2, name: "Mica"},
+    #   #     }
+    # 
+    # @todo
+    #   I wanted to use `#to_proc` so that you could use `&[:id]`, but unary
+    #   `&` doesn't invoke refinements, and I don't really want to monkey-patch
+    #   anything, especially something as core as `#to_proc` and `Array`.
+    # 
+    # @return [Proc]
+    #   Lambda proc that accepts a single argument and calls `#dig` with this 
+    #   array's contents as the `#dig` arguments.
+    # 
+    def digger
+      ->(digable) {
+        digable.dig *self
+      }
+    end # #digable
+    
+    
   end # refine ::Array
 end # NRSER

data/lib/nrser/types/is_a.rb

@@ -21,7 +21,7 @@ module NRSER::Types
   end # IsA
   
   # class membership
-  def self.is_a klass
-    IsA.new klass
+  def self.is_a klass, **options
+    IsA.new klass, **options
   end
 end # NRSER::Types

data/lib/nrser/types/paths.rb

@@ -0,0 +1,83 @@
+# Requirements
+# =======================================================================
+
+# stdlib
+require 'pathname'
+
+# gems
+
+# package
+require_relative './is_a'
+require_relative './where'
+require_relative './combinators'
+
+
+# Refinements
+# =======================================================================
+
+require 'nrser/refinements'
+using NRSER
+
+
+# Declarations
+# =======================================================================
+
+module NRSER; end
+
+
+# Definitions
+# =======================================================================
+
+module NRSER::Types
+  
+  # A {Pathname} type that provides a `from_s` 
+  PATHNAME = is_a \
+    Pathname,
+    name: 'PathnameType',
+    from_s: ->(string) { Pathname.new string }
+  
+  
+  # A type satisfied by a {Pathname} instance that's not empty (meaning it's
+  # string representation is not empty).
+  NON_EMPTY_PATHNAME = intersection \
+    PATHNAME,
+    where { |value| value.to_s.length > 0 },
+    name: 'NonEmptyPathnameType'
+  
+  
+  PATH = union non_empty_str, NON_EMPTY_PATHNAME, name: 'Path'
+  
+  
+  # Eigenclass (Singleton Class)
+  # ========================================================================
+  # 
+  class << self
+    
+    def pathname **options
+      if options.empty?
+        PATHNAME
+      else
+        is_a \
+          Pathname,
+          name: 'PathnameType',
+          from_s: ->(string) { Pathname.new string },
+          **options
+      end
+    end
+    
+    # 
+    # 
+    # @return [NRSER::Types::Type]
+    # 
+    def path **options
+      if options.empty?
+        PATH
+      else
+        union non_empty_str, NON_EMPTY_PATHNAME, **options
+      end
+    end # #path
+    
+  end # class << self (Eigenclass)
+  
+end # module NRSER::Types
+

data/lib/nrser/types/type.rb

@@ -7,10 +7,29 @@ module NRSER::Types
       name.split('::').last
     end
     
-    def initialize **options
-      @name = options[:name]
-      @from_s = options[:from_s]
-    end
+    
+    # Constructor
+    # =====================================================================
+    
+    # Instantiate a new `NRSER::Types::Type`.
+    # 
+    # @param [nil | String] name:
+    #   Name that will be used when displaying the type, or `nil` to use a
+    #   default generated name.
+    # 
+    # @param [nil | #call] from_s:
+    #   Callable that will be passed a {String} and should return an object 
+    #   that satisfies the type if it possible to create one.
+    #   
+    #   The returned value *will* be checked against the type, so returning a 
+    #   value that doesn't satisfy will result in a {TypeError} being raised
+    #   by {#from_s}.
+    # 
+    def initialize name: nil, from_s: nil
+      @name = name
+      @from_s = from_s
+    end # #initialize
+    
     
     def name
       @name || default_name
@@ -52,7 +71,7 @@ module NRSER::Types
         raise NoMethodError, "#from_s not defined"
       end
       
-      check @from_s.(s)
+      check @from_s.call( s )
     end
     
     def has_from_s?

data/lib/nrser/types.rb

@@ -1,19 +1,68 @@
+# Requirements
+# =======================================================================
+
+# Stdlib
+# ---------------------------------------------------------------------
+
+# TODO Not sure if this needs to be here... can't find any usage of it in 
+#       quick searches, but I don't want to remove it now.
 require 'pp'
 
-require 'nrser/refinements'
-require 'nrser/types/type'
-require 'nrser/types/is'
-require 'nrser/types/is_a'
-require 'nrser/types/where'
-require 'nrser/types/combinators'
-require 'nrser/types/maybe'
-require 'nrser/types/attrs'
-require 'nrser/types/responds'
+# Deps
+# ---------------------------------------------------------------------
+
+# Package
+# ---------------------------------------------------------------------
+
+# Abstract infrastructure for type creation - stuff that doesn't define any
+# concrete type instances.
+# 
+# Files that define concrete type instances on load (usually as module 
+# constants, which I'm still questioning a bit as a design because of the
+# uncontrollable mutability of Ruby and the importance of type checks)
+# need to be required in the "Post-Processing" section at the bottom.
+# 
+require_relative './types/type'
+require_relative './types/is'
+require_relative './types/is_a'
+require_relative './types/where'
+require_relative './types/combinators'
+require_relative './types/maybe'
+require_relative './types/attrs'
+require_relative './types/responds'
+
 
+# Refinements
+# =======================================================================
+
+require 'nrser/refinements'
 using NRSER
-  
+
+
+# Stuff to help you define, test, check and match types in Ruby.
+# 
 module NRSER::Types
-  # make a type.
+  
+  # Make a {NRSER::Types::Type} from a value.
+  # 
+  # If the `value` argument is...
+  # 
+  # -   a {NRSER::Types::Type}, it is returned.
+  #     
+  # -   a {Class}, a new {NRSER::Types::IsA} matching that class is returned.
+  #     
+  #     This allows things like
+  #     
+  #         NRSER::Types.check 's', String
+  #         NRSER::Types.match 's', String, ->(s) { ... }
+  # 
+  # -   anything else, a new {NRSER::Types::Is} matching that value is
+  #     returned.
+  # 
+  # @param [Object] value
+  # 
+  # @return [NRSER::Types::Type]
+  # 
   def self.make value
     if value.is_a? NRSER::Types::Type
       value
@@ -24,15 +73,18 @@ module NRSER::Types
     end
   end
   
+  
   # raise an error if value doesn't match type.
   def self.check value, type
     make(type).check value
   end
   
+  
   def self.test value, type
     make(type).test value
   end
   
+  
   def self.match value, *clauses
     if clauses.empty?
       raise ArgumentError.new NRSER.dedent <<-END
@@ -84,7 +136,8 @@ module NRSER::Types
           #{ enum.map {|type, expression| "\n    #{ type.inspect }"} }
       
     END
-  end
+  end # .match
+  
   
   # make a type instance from a object representation that can come from 
   # a YAML or JSON declaration.
@@ -98,15 +151,22 @@ module NRSER::Types
         
       },
     }
-  end
+  end # .from_repr
+  
 end # NRSER::Types
 
-# things that define values, which may need to call the functions defined
-# above
-require 'nrser/types/any'
-require 'nrser/types/booleans'
-require 'nrser/types/numbers'
-require 'nrser/types/strings'
-require 'nrser/types/symbol'
-require 'nrser/types/array'
-require 'nrser/types/hash'
+
+# Post-Processing
+# =======================================================================
+# 
+# Files that define constants that need the proceeding infrastructure.
+# 
+
+require_relative './types/any'
+require_relative './types/booleans'
+require_relative './types/numbers'
+require_relative './types/strings'
+require_relative './types/symbol'
+require_relative './types/array'
+require_relative './types/hash'
+require_relative './types/paths'

data/lib/nrser/version.rb

@@ -1,5 +1,5 @@
 module NRSER
-  VERSION = "0.0.23"
+  VERSION = "0.0.24"
   
   module Version
     

data/spec/nrser/enumerable_spec.rb

@@ -93,5 +93,19 @@ describe "NRSER Enumerable Methods" do
   end # NRSER.method(:find_only)
   
   
+  describe NRSER.method(:to_h_by) do
+    
+    context "Duplicate keys" do
+      it "raises NRSER::ConflictError" do
+        expect {
+          NRSER.to_h_by([1, 2, 3]) { |i| i % 2 }
+        }.to raise_error NRSER::ConflictError
+      end
+    end # Duplicate keys
+    
+    
+  end # NRSER.to_h_by
+  
+  
 end # NRSER Enumerable Methods
 

data/spec/nrser/types_spec.rb

@@ -149,6 +149,28 @@ describe NRSER::Types do
         fail: [ [] ],
       },
       
+      t.path => {
+        pass: [
+          '.',
+          Pathname.getwd,
+        ],
+        
+        fail: [
+          '',
+          123,
+        ],
+        
+        from_s: {
+          pass: [
+            '.',
+          ],
+          
+          fail: [
+            '',
+          ],
+        },
+      }, # t.path
+      
     }.each do |type, tests|
       if tests[:pass]
         tests[:pass].each do |value|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nrser
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.0.24
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-17 00:00:00.000000000 Z
+date: 2017-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -174,6 +174,7 @@ files:
 - lib/nrser/types/is_a.rb
 - lib/nrser/types/maybe.rb
 - lib/nrser/types/numbers.rb
+- lib/nrser/types/paths.rb
 - lib/nrser/types/responds.rb
 - lib/nrser/types/strings.rb
 - lib/nrser/types/symbol.rb