nrser 0.1.4 → 0.2.0.pre.0

data/lib/nrser/refinements/binding.rb

@@ -1,7 +1,6 @@
 module NRSER
+  # Harness to include {NRSER::Ext::Binding} in {Binding}
   refine Binding do
-    def erb str
-      NRSER.template self, str
-    end
-  end  
+    include NRSER::Ext::Binding
+  end
 end # NRSER

data/lib/nrser/rspex.rb

@@ -25,6 +25,8 @@ require 'commonmarker'
 # Project / Package
 # -----------------------------------------------------------------------
 require 'nrser'
+require_relative './rspex/example'
+require_relative './rspex/example_group'
 require_relative './rspex/shared_examples'
 require_relative './rspex/format'
 
@@ -122,11 +124,10 @@ def Args *args
   NRSER::RSpex::Args.new args
 end
 
+
 # Extensions
 # =====================================================================
 
-module NRSER; end
-
 module NRSER::RSpex
   
   # Constants
@@ -258,23 +259,8 @@ module NRSER::RSpex
     end
   end
   
-  # Extensions available in examples themselves via RSpec's `config.include`.
-  # 
-  module Example
-    def described_class
-      self.class.metadata[:class] || super
-    end
-    
-    def described_constructor_args
-      self.class.metadata[:constructor_args]
-    end
-    
-  end
-  
 end # module NRSER:RSpex
 
-require_relative './rspex/example_group'
-
 
 RSpec.configure do |config|
   config.extend NRSER::RSpex::ExampleGroup

data/lib/nrser/rspex/example.rb

@@ -0,0 +1,49 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+
+# Refinements
+# =======================================================================
+
+using NRSER
+
+
+# Declarations
+# =======================================================================
+
+module NRSER::RSpex; end
+
+
+# Definitions
+# =======================================================================
+
+# Extensions available in examples themselves via RSpec's `config.include`.
+# 
+module NRSER::RSpex::Example
+  
+  def described_class
+    self.class.metadata[:class] || super
+  end
+  
+  
+  def described_constructor_args
+    self.class.metadata[:constructor_args]
+  end
+  
+  
+  # HACK HACK HACK-ITY HACK
+  # 
+  # Hook used to `#extend` `base` with
+  # {NRSER::RSpex::ExampleGroup::Overrides}, see discussion/confession
+  # over there.
+  # 
+  # @param [Class] base
+  #   The class this mixin got included in.
+  # 
+  # @return [void]
+  # 
+  def self.included base
+    base.extend NRSER::RSpex::ExampleGroup::Overrides
+  end
+  
+end # module NRSER::RSpex::Example

data/lib/nrser/rspex/example_group.rb

@@ -1,44 +1,76 @@
 # frozen_string_literal: true
 # encoding: utf-8
 
+
+# Declarations
+# =======================================================================
+
+module NRSER::RSpex; 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
   
-  # Create a new {RSpec.describe} section where the subject is set by
-  # calling the parent subject with `args` and evaluate `block` in it.
+  # HACK HACK HACK-ITY HACK - Allow for overriding RSpec methods
   # 
-  # @example
-  #   describe "hi sayer" do
-  #     subject{ ->( name ) { "Hi #{ name }!" } }
-  #     
-  #     describe_called_with 'Mom' do
-  #       it { is_expected.to eq 'Hi Mom!' }
-  #     end
-  #   end
+  # Yeah, it has to do with mixin mixing-in ordering - seems to be that when
   # 
-  # @param [Array] *args
-  #   Arguments to call `subject` with to produce the new subject.
+  #     config.extend NRSER::RSpex::ExampleGroup
   # 
-  # @param [#call] &block
-  #   Block to execute in the context of the example group after refining
-  #   the subject.
+  # {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:
   # 
-  def describe_called_with *args, &body
-    describe_x_type  "called with", List(*args),
-      type: :invocation,
-      subject_block: -> { super().call *args },
-      &body
-  end # #describe_called_with
-  
-  # Aliases to other names I was using at first... not preferring their use
-  # at the moment.
+  # It turns out that {NRSER::RSpex::Example}, which gets mixed with
   # 
-  # 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 :called_with, :describe_called_with
-  alias_method :when_called_with, :describe_called_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
@@ -180,11 +212,6 @@ module NRSER::RSpex::ExampleGroup
   end # #describe_class
   
   
-  def described_class
-    metadata[:class] || super()
-  end
-  
-  
   def describe_group title, **metadata, &block
     describe(
       "#{ NRSER::RSpex::PREFIXES[:group] } #{ title }",
@@ -268,3 +295,4 @@ 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_called_with'

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

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module NRSER::RSpex::ExampleGroup
+  
+  # Create a new {RSpec.describe} section where the subject is set by
+  # calling the parent subject with `args` and evaluate `block` in it.
+  # 
+  # @example
+  #   describe "hi sayer" do
+  #     subject{ ->( name ) { "Hi #{ name }!" } }
+  #     
+  #     describe_called_with 'Mom' do
+  #       it { is_expected.to eq 'Hi Mom!' }
+  #     end
+  #   end
+  # 
+  # @param [Array] *args
+  #   Arguments to call `subject` with to produce the new subject.
+  # 
+  # @param [#call] &block
+  #   Block to execute in the context of the example group after refining
+  #   the subject.
+  # 
+  # @return [void]
+  # 
+  def describe_called_with *args, &body
+    describe_x_type  "called with", List(*args),
+      type: :invocation,
+      subject_block: -> { super().call *args },
+      &body
+  end # #describe_called_with
+  
+  # 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 :called_with, :describe_called_with
+  alias_method :when_called_with, :describe_called_with
+  
+end # module NRSER::RSpex::ExampleGroup

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

@@ -96,6 +96,8 @@ module NRSER::RSpex::ExampleGroup
           compact.
           # Get the source locations
           map( &:source_location ).
+          # Get rid of `[nil, nil]` results, which seems to come from C exts
+          reject { |(path, line)| path.nil? || line.nil? }.
           # Get the first line in the shortest path
           min_by { |(path, line)| [path.length, line] }
           

data/lib/nrser/rspex/format.rb

@@ -10,34 +10,40 @@ using NRSER
 module NRSER::RSpex::Format
 
   
-  PASTEL = Pastel.new
+  def self.pastel
+    @pastel ||= Pastel.new
+  end
   
-  def self.transpose_A_z string, lower_a:, upper_a:
-    string
-      .gsub( /[A-Z]/ ) { |char|
-        [upper_a.ord + (char.ord - 'A'.ord)].pack 'U*'
-      }
-      .gsub( /[a-z]/ ) { |char|
-        [lower_a.ord + (char.ord - 'a'.ord)].pack 'U*'
-      }
+  
+  def self.mean_streak
+    @mean_streak ||= NRSER::MeanStreak.new do |ms|
+      ms.render_type :emph do |doc, node|
+        italic doc.render_children( node )
+      end
+      
+      ms.render_type :strong do |doc, node|
+        bold doc.render_children( node )
+      end
+      
+      ms.render_type :code do |doc, node|
+        code node.string_content
+      end
+    end
   end
   
   
-  # Italicize a string
+  # Italicize a string via "Unicode Math Italic" substitution.
   # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
-  # 
-  # @return [return_type]
-  #   @todo Document return value.
+  # @param [String] string
+  # @return [String]
   # 
   def self.unicode_italic string
-    transpose_A_z string, lower_a: '𝑎', upper_a: '𝐴'
+    NRSER.u_italic string
   end # .italic
   
   
   def self.esc_seq_italic string
-    PASTEL.italic string
+    pastel.italic string
   end
   
   
@@ -48,77 +54,36 @@ module NRSER::RSpex::Format
   singleton_class.send :alias_method, :i, :italic
   
   
-  def self.fix_esc_seq commonmark
-    commonmark.gsub( "\e\\[", "\e[" )
+  def self.esc_seq_bold string
+    pastel.bold string
   end
   
   
-  # @todo Document render_commonmark method.
+  # Bold a string via "Unicode Math Bold" substitution.
   # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
-  # 
-  # @return [return_type]
-  #   @todo Document return value.
+  # @param [String] string
+  # @return [String]
   # 
-  def self.render_shelldown *render_doc_args
-    doc = CommonMarker.render_doc *render_doc_args
-    
-    transformed = transform_node( doc ).only!
-    commonmark = transformed.to_commonmark
-    ansi = fix_esc_seq commonmark
-    ansi
-  end # .render_commonmark
+  def self.unicode_bold string
+    NRSER.u_bold string
+  end
   
   
-  def self.text_node string_content
-    CommonMarker::Node.new( :text ).tap { |node|
-      node.string_content = string_content
-    }
+  def self.bold string
+    public_send "#{ RSpec.configuration.x_style }_#{ __method__ }", string
   end
   
+  singleton_class.send :alias_method, :b, :bold
+  
   
-  def self.pastel_node name
-    text_node PASTEL.lookup( name )
+  def self.code string
+    pastel.yellow string
   end
   
   
-  def self.transform_node node
-    case node.type
-    when :emph
-      [
-        pastel_node( :italic ),
-        node.map { |child| transform_node child },
-        pastel_node( :clear ),
-      ].flatten
-    when :strong
-      [
-        pastel_node( :bold ),
-        node.map { |child| transform_node child},
-        pastel_node( :clear ),
-      ].flatten
-    when :text
-      [node]
-    when :code
-      [
-        pastel_node( :magenta ),
-        text_node( node.string_content ),
-        pastel_node( :clear ),
-      ]
-    else
-      new_node = CommonMarker::Node.new node.type
-      
-      # new_node.string_content = node.string_content
-      
-      node.
-        each { |child|
-          transform_node( child ).each { |new_child|
-            new_node.append_child new_child
-          }
-        }
-      
-      [new_node]
-    end
+  def self.md_code_quote string
+    quote = '`' * ((string.scan( /`+/ ).map( &:length ).max || 0) + 1)
+    "#{ quote }#{ string }#{ quote }"
   end
   
   
@@ -136,7 +101,7 @@ module NRSER::RSpex::Format
     prefixes = RSpec.configuration.x_type_prefixes
     
     prefix = prefixes[type] ||
-              PASTEL.magenta( i( type.to_s.upcase.gsub('_', ' ') ) )
+              pastel.magenta( i( type.to_s.upcase.gsub('_', ' ') ) )
     
     "#{ prefix } #{ description }"
   end # .format_type
@@ -153,7 +118,12 @@ module NRSER::RSpex::Format
     parts.
       map { |part|
         if part.respond_to? :to_desc
-          part.to_desc
+          desc = part.to_desc
+          if desc.empty?
+            ''
+          else
+            md_code_quote part.to_desc
+          end
         elsif part.is_a? String
           part
         else
@@ -163,7 +133,7 @@ module NRSER::RSpex::Format
       join( ' ' ).
       squish.
       thru { |description|
-        render_shelldown prepend_type( type, description )
+        mean_streak.render prepend_type( type, description )
       }
   end # .description