nrser 0.2.2 → 0.3.0

data/lib/nrser/rspex/example_group.rb

@@ -6,261 +6,29 @@
 # =======================================================================
 
 module NRSER::RSpex; end
+module NRSER::RSpex::ExampleGroup; end
 
 
-# Definitions
-# =======================================================================
-
-# Instance methods to extend examples groups with. Also included globally so
-# they're available at the top-level in files.
-# 
-module NRSER::RSpex::ExampleGroup
-  
-  # HACK HACK HACK-ITY HACK - Allow for overriding RSpec methods
-  # 
-  # Yeah, it has to do with mixin mixing-in ordering - seems to be that when
-  # 
-  #     config.extend NRSER::RSpex::ExampleGroup
-  # 
-  # {NRSER::RSpex::ExampleGroup} gets mixed in *very early* in the chain,
-  # before {RSpec::Core::ExampleGroup}... why you would provide an explicit
-  # extension mechanism and not give those extensions priority I'm not sure,
-  # but I'm sure I shouldn't be looking into it right now, so here we are:
-  # 
-  # It turns out that {NRSER::RSpex::Example}, which gets mixed with
-  # 
-  #     config.include NRSER::RSpex::Example
-  # 
-  # gets mixed *last*, so by using it's {NRSER::RSpex::Example.included}
-  # hook we can use
-  # 
-  #   base#extend NRSER::RSpex::ExampleGroup::Overrides
-  # 
-  # to mix these guys over the top of RSpec's methods.
-  # 
-  # Seems like we could just mix all of {NRSER::RSpex::ExampleGroup} there
-  # to get the behavior I would have expected all along, but maybe it's better
-  # to have these explicit notes for the moment and not change much else until
-  # I get the chance to really check out what's going on.
-  # 
-  # And really it's all to override `.described_class` to pick up our
-  # metadata if it's there, but that approach is in quite a bit of use at
-  # this point, and, no, I have no idea how it seemed to work up until this
-  # point :/
-  # 
-  module Overrides
-    
-    # Override {RSpec::Core::ExampleGroup.described_class} to use RSpex's
-    # `:class` metadata if it's present.
-    # 
-    # Because I can't figure out how to feed RSpec the described class
-    # without it being the description, and we want better descriptions.
-    # 
-    # Some hackery could def do it, this is RUBY after all, but whatever this
-    # works for now and may even be less fragile.
-    # 
-    # @return [Class]
-    #   If there's a `:class` in the metadata, or if RSpec has on through the
-    #   standard means (`describe MyClass do ...`).
-    # 
-    # @return [nil]
-    #   If we don't have a class context around.
-    # 
-    def described_class
-      metadata[:class] || super()
-    end
-    
-  end
-  
-  
-  def describe_message symbol, *args, &body
-    description = \
-      "message #{ [symbol, *args].map( &NRSER::RSpex.method( :short_s ) ).join( ', ' ) }"
-    
-    describe description, type: :message do
-      subject { NRSER::Message.new symbol, *args }
-      module_exec &body
-    end
-  end
-  
-  
-  # For use when `subject` is a {NRSER::Message}. Create a new context for
-  # the `receiver` where the subject is the result of sending that message
-  # to the receiver.
-  # 
-  # @param [Object] receiver
-  #   Object that will receive the message to create the new subject.
-  # 
-  # @param [Boolean] publicly:
-  #   Send message publicly via {Object#public_send} (default) or privately
-  #   via {Object.send}.
-  # 
-  # @return
-  #   Whatever the `context` call returns.
-  # 
-  def describe_sent_to receiver, publicly: true, &block
-    mode = if publicly
-      "publicly"
-    else
-      "privately"
-    end
-    
-    describe "sent to #{ receiver } (#{ mode })" do
-      subject { super().send_to unwrap( receiver, context: self ) }
-      module_exec &block
-    end
-  end # #describe_sent_to
-  
-  # Aliases to other names I was using at first... not preferring their use
-  # at the moment.
-  # 
-  # The `when_` one sucks because Atom de-dents the line, and `describe_`
-  # is just clearer what the block is doing for people reading it.
-  alias_method :sent_to, :describe_sent_to
-  alias_method :when_sent_to, :describe_sent_to
-  
-  
-  def describe_return_value *args, &body
-    msg = NRSER::Message.from *args
-    
-    describe "return value from #{ msg }" do
-      subject { msg.send_to super() }
-      module_exec &body
-    end # "return value from #{ msg }"
-  end
-  
-  
-  # Describe a "section". Just like {RSpec.describe} except it:
-  # 
-  # 1.  Expects a string title.
-  #     
-  # 2.  Prepends a little section squiggle `§` to the title so sections are
-  #     easier to pick out visually.
-  #     
-  # 3.  Adds `type: :section` metadata.
-  # 
-  # @param [String] title
-  #   String title for the section.
-  # 
-  # @param [Hash<Symbol, Object>] **metadata
-  #   Additional [RSpec metadata][] for the example group.
-  #   
-  #   [RSpec metadata]: https://relishapp.com/rspec/rspec-core/docs/metadata/user-defined-metadata
-  # 
-  # @return
-  #   Whatever {RSpec.describe} returns.
-  # 
-  def describe_section title, **metadata, &block
-    describe(
-      "#{ NRSER::RSpex::PREFIXES[:section] } #{ title }",
-      type: :section,
-      **metadata
-    ) do
-      module_exec &block
-    end
-  end # #describe_section
-  
-  # Old name
-  alias_method :describe_topic, :describe_section
-  
-  
-  def describe_file path, **metadata, &body
-    title = path
-    
-    describe(
-      "#{ NRSER::RSpex::PREFIXES[:file] } #{ title }",
-      type: :file,
-      file: path,
-      **metadata
-    ) do
-      module_exec &body
-    end
-  end
-  
-  
-  def describe_module mod, bind_subject: true, **metadata, &block
-    describe(
-      "#{ NRSER::RSpex::PREFIXES[:module] } #{ mod.name }",
-      type: :module,
-      module: mod,
-      **metadata
-    ) do
-      if bind_subject
-        subject { mod }
-      end
-      
-      module_exec &block
-    end
-  end # #describe_module
-  
-  
-  def describe_group title, **metadata, &block
-    describe(
-      "#{ NRSER::RSpex::PREFIXES[:group] } #{ title }",
-      type: :group,
-      **metadata
-    ) do
-      module_exec &block
-    end
-  end # #describe_class
-  
-  
-  def describe_attribute symbol, **metadata, &block
-    describe(
-      "#{ NRSER::RSpex::PREFIXES[:attribute] } ##{ symbol }",
-      type: :attribute,
-      **metadata
-    ) do
-      subject { super().public_send symbol }
-      module_exec &block
-    end
-  end # #describe_attribute
-  
-  # Shorter name
-  alias_method :describe_attr, :describe_attribute
-  
-  
-  # Define a `context` block with `let` bindings and evaluate the `body`
-  # block in it.
-  # 
-  # @param [Hash<Symbol, Object>] **bindings
-  #   Map of symbol names to value to bind using `let`.
-  # 
-  # @param [#call] &body
-  #   Body block to evaluate in the context.
-  # 
-  # @return
-  #   Whatever `context` returns.
-  # 
-  def context_where description = nil, **bindings, &body
-    
-    if description.nil?
-      description = bindings.map { |name, value|
-        "#{ name }: #{ NRSER::RSpex.short_s value }"
-      }.join( ", " )
-    end
-    
-    context "△ #{ description }", type: :where do
-      bindings.each { |name, value|
-        let( name ) { unwrap value, context: self }
-      }
-      
-      module_exec &body
-    end
-  end
-  
-end # module NRSER:RSpex::ExampleGroup
+# Sub-Tree
+# ============================================================================
 
+require_relative './example_group/overrides'
 
-# Post-Processing
-# =======================================================================
-
-require_relative './example_group/describe_x'
-require_relative './example_group/describe_spec_file'
-require_relative './example_group/describe_when'
-require_relative './example_group/describe_setup'
-require_relative './example_group/describe_use_case'
-require_relative './example_group/describe_instance'
+require_relative './example_group/describe_attribute'
 require_relative './example_group/describe_called_with'
-require_relative './example_group/describe_method'
+require_relative './example_group/describe_case'
 require_relative './example_group/describe_class'
+require_relative './example_group/describe_group'
+require_relative './example_group/describe_instance_method'
+require_relative './example_group/describe_instance'
+require_relative './example_group/describe_message'
+require_relative './example_group/describe_method'
+require_relative './example_group/describe_module'
+require_relative './example_group/describe_response_to'
+require_relative './example_group/describe_section'
+require_relative './example_group/describe_sent_to'
+require_relative './example_group/describe_setup'
+require_relative './example_group/describe_source_file'
+require_relative './example_group/describe_spec_file'
+require_relative './example_group/describe_when'
+require_relative './example_group/describe_x'

data/lib/nrser/rspex/format.rb

@@ -1,6 +1,5 @@
 require 'pastel'
 
-using NRSER
 
 # Definitions
 # =======================================================================
@@ -82,8 +81,26 @@ module NRSER::RSpex::Format
   end
   
   
+  def self.method_name? string
+    # Must start with `#` or `.`
+    return false unless ['#', '.'].any? { |c| string[0] == c }
+    
+    name = string[1..-1]
+    
+    case name
+    when  '!', '~', '+', '**', '-', '*', '/', '%', '+', '-', '<<', '>>', '&',
+          '|', '^', '<', '<=', '>=', '>', '==', '===', '!=', '=~', '!~', '<=>',
+          '[]',
+          /\A[a-zA-Z_][a-zA-Z0-9_]*(?:\?|\!|=)?/
+      true
+    else
+      false
+    end
+  end
+  
+  
   def self.code string
-    if string =~ /\A\#[a-zA-Z][a-zA-Z0-9_]*(?:\?|\!)?/
+    if method_name? string
       pastel.bold.blue string
     else
       rspec_syntax_highlighter.highlight string.lines
@@ -108,18 +125,41 @@ module NRSER::RSpex::Format
   def self.prepend_type type, description
     return description if type.nil?
     
-    # prefixes = RSpec.configuration.x_type_prefixes
-    # 
-    # prefix = prefixes[type] ||
-    #           pastel.magenta( i( type.to_s.upcase.gsub('_', ' ') ) )
+    prefixes = RSpec.configuration.x_type_prefixes
     
-    # prefix = "*" + type.to_s.upcase.gsub('_', ' ') + "*"
-    prefix = pastel.magenta( i( type.to_s.upcase.gsub('_', ' ') ) )
+    prefix = pastel.magenta(
+      prefixes[type] || i( type.to_s.upcase.gsub('_', ' ') )
+    )
     
     "#{ prefix } #{ description }"
   end # .format_type
   
   
+  def self.pathname pn
+    if pn.absolute?
+      rel = pn.relative_path_from Pathname.getwd
+      
+      if rel.split( File::SEPARATOR ).first == '..'
+        File.join '.', rel
+      else
+        pn.to_s
+      end
+    else
+      if pn.exist?
+        File.join '.', pn
+      else
+        lib_pn = Pathname.getwd / 'lib' / pn
+        
+        if lib_pn.exist?
+          File.join '.', lib_pn.relative_path_from( Pathname.getwd )
+        else
+          pn.to_s
+        end
+      end
+    end
+  end
+  
+  
   # @todo Document format method.
   # 
   # @param [type] arg_name
@@ -129,18 +169,48 @@ module NRSER::RSpex::Format
   # 
   def self.description *parts, type: nil
     parts.
-      map { |part|
+      flat_map { |part|
         if part.respond_to? :to_desc
           desc = part.to_desc
           if desc.empty?
             ''
           else
-            md_code_quote part.to_desc
+            md_code_quote desc
           end
-        elsif part.is_a? String
-          part
         else
-          NRSER::RSpex.short_s part
+          case part
+          when Module
+            mod = part
+            
+            name_desc = if mod.anonymous?
+              "(anonymous #{ part.class })"
+            else
+              md_code_quote mod.name
+            end
+            
+            [name_desc, description( mod.source_location )]
+            
+          when NRSER::Meta::Source::Location
+            if part.valid?
+              "(#{ NRSER::RSpex.dot_rel_path( part.file ) }:#{ part.line })"
+            else
+              ''
+            end
+            
+          when String
+            part
+          
+          when Pathname
+            pathname part
+          
+          when NRSER::Message
+            [part.symbol, part.args].
+              map( &NRSER::RSpex.method( :short_s ) ).join( ', ' )
+            
+          else
+            NRSER::RSpex.short_s part
+            
+          end
         end
       }.
       join( ' ' ).
@@ -151,7 +221,3 @@ module NRSER::RSpex::Format
   end # .description
   
 end # module NRSER::RSpex::Format
-
-
-# Post-Processing
-# =======================================================================

data/lib/nrser/rspex.rb

@@ -25,6 +25,8 @@ require 'commonmarker'
 # Project / Package
 # -----------------------------------------------------------------------
 require 'nrser'
+require 'nrser/core_ext'
+
 require_relative './rspex/example'
 require_relative './rspex/example_group'
 require_relative './rspex/shared_examples'
@@ -133,50 +135,18 @@ module NRSER::RSpex
   # Constants
   # =====================================================================
   
-  # Symbols
-  # ---------------------------------------------------------------------
+  # Symbol characters for specific example group types.
   # 
   # Sources:
   # 
   # -   https://en.wikipedia.org/wiki/Mathematical_operators_and_symbols_in_Unicode
   # 
-  
-  PREFIXES_BASE = {
+  PREFIXES = {
     section: '§',
     group: '•',
     invocation: '𝑓⟮𝑥⟯',
   }
   
-  PREFIXES_MATH_ITALIC = PREFIXES_BASE.merge(
-    module:       '𝑀',
-    method:       '𝑚',
-    class:        '𝐶',
-    attribute:    '𝑎',
-    file:         '𝐹',
-  )
-  
-  PREFIXES_MATH_CURSIVE_WORDS = PREFIXES_BASE.merge(
-    module:       '𝓜 𝓸𝓭𝓾𝓵𝓮',
-    method:       '𝓶𝓮𝓽',
-    class:        '𝐶',
-    attribute:    '𝑎',
-    file:         '𝐹',
-  )
-  
-  # PREFIXES_MATH_GREEK = PREFIXES_BASE.merge(
-  #   # module: "𝓜 𝓸𝓭𝓾𝓵𝓮",
-  #   module:       '𝛭',
-  #   method:       '𝜆',
-  #   class:        '𝛤',
-  #   attribute:    '𝛼',
-  # )
-  
-  PREFIXES = PREFIXES_MATH_ITALIC
-  
-  # PREFIXES = PREFIXES_MATH_ITALIC.map_values { |k, v|
-  #   RSpec::Core::Formatters::ConsoleCodes.wrap( v, :cyan )
-  # }
-  
   
   # Module (Class) Functions
   # =====================================================================

data/lib/nrser/sugar/method_missing_forwarder.rb

@@ -0,0 +1,50 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Declarations
+# =======================================================================
+
+module NRSER; end
+
+
+# Definitions
+# ========================================================================
+
+# A very simple class that forwards all method calls to the block it was
+# initialized with (via {#method_missing}).
+# 
+class NRSER::MethodMissingForwarder < BasicObject
+  
+  # Constructor
+  # ========================================================================
+  
+  # Instantiate a new `NRSER::MethodMissingForwarder` holding the forwarding
+  # block.
+  # 
+  # @param [Proc<(symbol:Symbol, *args, &block)>] &forwarder
+  #   Block that will receive all calls to {#method_missing}.
+  # 
+  def initialize &forwarder
+    @forwarder = forwarder
+  end # #initialize
+  
+  
+  # Instance Methods
+  # ========================================================================
+  
+  # Forwards all params to the `@forwarder` proc.
+  # 
+  # @param [Symbol] symbol
+  #   The name of the method that was called.
+  # 
+  # @param [Array] *args
+  #   Any parameters the missing method was called with.
+  # 
+  # @param [Proc?] &block
+  #   The block the method was called with, if any.
+  # 
+  def method_missing symbol, *args, &block
+    @forwarder.call symbol, *args, &block
+  end
+  
+end # class NRSER::MethodMisser

data/lib/nrser/{env → sys/env}/path.rb

@@ -27,9 +27,8 @@ using NRSER
 # =======================================================================
 
 # @todo document NRSER::Env::Path class.
-class NRSER::Env::Path
+class NRSER::Sys::Env::Path
   include Enumerable
-  include NRSER::Ext::Enumerable
   
   # Constants
   # ======================================================================

data/lib/nrser/{env.rb → sys/env.rb}

@@ -3,7 +3,8 @@
 # Declarations
 # =======================================================================
 
-module NRSER::Env; end
+module NRSER::Sys; end
+module NRSER::Sys::Env; end
 
 
 # Post-Processing

data/lib/nrser/sys.rb

@@ -0,0 +1,5 @@
+# Object wrappers and utilities for system interfaces and information.
+# 
+module NRSER::Sys; end
+
+require_relative './sys/env'

data/lib/nrser/types/any.rb

@@ -1,12 +1,41 @@
-require 'nrser/refinements'
-require 'nrser/types/where'
-
+# encoding: UTF-8
+# frozen_string_literal: true
   
 module NRSER::Types
-  ANY = where(name: 'AnyType', from_s: ->(s) { s }) { true }.freeze
   
-  # anything
-  def self.any
-    ANY
+  # A type for anything - {#test?} always returns `true`.
+  # 
+  class AnyType < NRSER::Types::Type
+    
+    def test? value; true; end
+    def explain; '*'; end
+    def custom_from_s string; string; end
+    
+    # {AnyType} instances are all equal.
+    # 
+    # @note
+    #   `other`'s class must be {AnyType} exactly - we make no assumptions
+    #   about anything that has subclasses {AnyType}.
+    # 
+    # @param [*] other
+    #   Object to compare to.
+    # 
+    # @return [Boolean]
+    #   `true` if `other#class` equals {AnyType}.
+    # 
+    def == other
+      other.class == AnyType
+    end
+    
+  end # class Any
+  
+  # Anything at all...
+  # 
+  def_factory(
+    :any,
+    aliases: [ :all ],
+  ) do
+    @_any_type_instance ||= AnyType.new
   end
+  
 end # NRSER::Types