nrser 0.1.1 → 0.1.2

data/lib/nrser/functions/path.rb

@@ -116,8 +116,10 @@ module NRSER
         Pathname.glob( path ).find { |match_path|
           match_path.public_send test
         }
+      elsif path.public_send( test )
+        path
       else
-        path.public_send test
+        nil
       end
       
       unless found_path.nil?

data/lib/nrser/functions/string.rb

@@ -121,10 +121,18 @@ module NRSER
   end # .truncate
   
   
-  # Cut the middle out of a string and stick an ellipsis in there instead.
+  # Cut the middle out of a sliceable object with length and stick an ellipsis
+  # in there instead.
   # 
-  # @param [String] string
-  #   Source string.
+  # Categorized with {String} functions 'cause that's where it started, and
+  # that's probably how it will primarily continue to be used, but tested to
+  # work on {Array} and should for other classes that satisfy the same
+  # slice and  interface.
+  # 
+  # @param [V & #length & #slice & #<< & #+] source
+  #   Source object. In practice, {String} and {Array} work. In theory,
+  #   anything that responds to `#length`, `#slice`, `#<<` and `#+` with the
+  #   same semantics will work.
   # 
   # @param [Fixnum] max
   #   Max length to allow for the output string.
@@ -134,18 +142,27 @@ module NRSER
   #   removed. Defaults to the unicode ellipsis since I'm targeting the CLI
   #   at the moment and it saves precious characters.
   # 
-  # @return [String]
-  #   String of at most `max` length with the middle chopped out if needed
-  #   to do so.
-  def self.ellipsis string, max, omission: UNICODE_ELLIPSIS
-    return string unless string.length > max
+  # @return [V]
+  #   Object of the same type as `source` of at most `max` length with the
+  #   middle chopped out if needed to do so.\*
+  #   
+  #   \* Really, it has to do with how all the used methods are implemented,
+  #   but we hope that conforming classes will return instances of their own
+  #   class like {String} and {Array} do.
+  # 
+  def self.ellipsis source, max, omission: UNICODE_ELLIPSIS
+    return source unless source.length > max
     
     trim_to = max - omission.length
+    middle = trim_to / 2
+    remainder = trim_to % 2
     
-    start = string[0, (trim_to / 2) + (trim_to % 2)]
-    finish = string[-( (trim_to / 2) - (trim_to % 2) )..-1]
+    start = source.slice( 0, middle + remainder )
+    start << omission
     
-    start + omission + finish
+    finish = source.slice( -( middle - remainder )..-1 )
+    
+    start + finish
   end # .ellipsis
   
   

data/lib/nrser/functions/text/indentation.rb

@@ -52,10 +52,16 @@ module NRSER
   end
   
   
-  def self.dedent text, ignore_whitespace_lines: true
+  def self.dedent text,
+                  ignore_whitespace_lines: true,
+                  return_lines: false
     return text if text.empty?
     
-    all_lines = text.lines
+    all_lines = if text.is_a?( Array )
+      text
+    else
+      text.lines
+    end
     
     indent_significant_lines = if ignore_whitespace_lines
       all_lines.reject { |line| whitespace? line }
@@ -67,7 +73,7 @@ module NRSER
     
     return text if indent.empty?
     
-    all_lines.map { |line|
+    dedented_lines = all_lines.map { |line|
       if line.start_with? indent
         line[indent.length..-1]
       elsif line.end_with? "\n"
@@ -75,7 +81,13 @@ module NRSER
       else
         ""
       end
-    }.join
+    }
+    
+    if return_lines
+      dedented_lines
+    else
+      dedented_lines.join
+    end
   end # .dedent
   
   # I like dedent better, but other libs seems to call it deindent

data/lib/nrser/mean_streak/document.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+
+# Declarations
+# =======================================================================
+
+
+# Definitions
+# =======================================================================
+
+
+# @todo document NRSER::MeanStreak::Document class.
+class NRSER::MeanStreak::Document
+  
+  # Constants
+  # ======================================================================
+  
+  
+  # Class Methods
+  # ======================================================================
+  
+  # @todo Document from method.
+  # 
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  # 
+  # @return [NRSER::MeanStreak::Document]
+  #   @todo Document return value.
+  # 
+  def self.parse  source,
+                  mean_streak:,
+                  cm_options: :DEFAULT,
+                  cm_extensions: []
+    new mean_streak: mean_streak,
+        source: source,
+        doc: CommonMarker.render_doc( source, options, extensions )
+  end # .parse
+  
+  singleton_class.send :alias_method, :from_string, :parse
+  singleton_class.send :alias_method, :from_s, :parse
+  
+  
+  
+  # Attributes
+  # ======================================================================
+  
+  # The {NRSER::MeanStreak} instance associated with this document, which
+  # contains the rendering configuration.
+  # 
+  # @return [NRSER::MeanStreak]
+  #     
+  attr_reader :mean_streak
+
+
+  # The source string.
+  # 
+  # @return [String]
+  #     
+  attr_reader :source
+
+
+  # The root {CommonMarker::Node} (with {CommonMarker::Node#type}=`:document`).
+  # 
+  # @return [CommonMarker::Node]
+  #     
+  attr_reader :doc
+  
+  
+  # Constructor
+  # ======================================================================
+  
+  # Instantiate a new `NRSER::MeanStreak::Document`.
+  # 
+  # @param mean_streak
+  #   See {NRSER::MeanStreak::Document#mean_streak}
+  # 
+  def initialize mean_streak:, source:, doc:
+    @mean_streak = mean_streak
+    @source = source.dup.freeze
+    @doc = doc
+  end
+  
+  
+  # Instance Methods
+  # ======================================================================
+
+  # The lines in {#source} as a {Hamster::Vector} of frozen strings.
+  # 
+  # @return [Hamster::Vector<String>]
+  # 
+  def source_lines
+    @source_lines = Hamster::Vector.new source.lines.map( &:freeze )
+  end
+
+
+  # Get the substring of the source that a node came from (via its
+  # `#sourcepos`).
+  # 
+  # @return [String]
+  # 
+  def source_for_node node
+    pos = node.sourcepos
+    
+    if pos[:start_line] == pos[:end_line]
+      source_lines[pos[:start_line] - 1][
+        (pos[:start_column] - 1)...pos[:end_column]
+      ]
+    else
+      lines = source_lines[(pos[:start_line] - 1)...pos[:end_line]]
+      
+      # Trim the start off the first line, unless the start column is 1
+      unless pos[:start_column] == 1
+        lines[0] = lines[0][(pos[:start_column] - 1)..-1]
+      end
+      
+      # Trim the end off the first line, unless the end column is the last
+      # line's length
+      unless pos[:end_column] == lines[-1].length
+        lines[-1] = lines[-1][0...pos[:end_column]]
+      end
+      
+      lines.join
+    end
+  end
+
+
+  def render_node node, output = ''
+    
+  end
+  
+end # class NRSER::MeanStreak::Document
+
+
+# Post-Processing
+# =======================================================================

data/lib/nrser/mean_streak.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+require 'commonmarker'
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+# Refinements
+# =======================================================================
+
+
+# Declarations
+# =======================================================================
+
+
+# Definitions
+# =======================================================================
+
+
+# Tag up terminals with color and style. Uses {CommonMarker} for the parsing
+# (Markdown / CommonMark / GFM syntax).
+# 
+# {NRSER::MeanStreak} instances hold configuration and provide functionality
+# through instance methods, making it easy to use multiple configurations or
+# subclass {NRSER::MeanStreak} to further customize functionality.
+# 
+# An instance with default configuration is available via the {.default}
+# class method, and additional class methods are provided that proxy to the
+# default's instance methods, providing convenient use of the default config.
+# 
+class NRSER::MeanStreak
+  
+  # Class Methods
+  # ======================================================================
+  
+  # Get the default instance, which has the default configuration and is
+  # used by the class methods.
+  # 
+  # @return [NRSER::MeanStreak]
+  # 
+  def self.default
+    # TODO cache?
+    new
+  end # .default
+  
+  
+  # Public: Parses a Markdown string into a `document` node.
+  #
+  # string - {String} to be parsed
+  # option - A {Symbol} or {Array of Symbol}s indicating the parse options
+  # extensions - An {Array of Symbol}s indicating the extensions to use
+  #
+  # @return [CommonMarker::Node]
+  #   The `document` node.
+  # 
+  def self.parse text, options = :DEFAULT, extensions = []
+    
+  end
+  
+  
+  # Instance Methods
+  # ============================================================================
+  
+  
+  # @todo Document parse method.
+  # 
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  # 
+  # @return [return_type]
+  #   @todo Document return value.
+  # 
+  def parse source, **options
+    NRSER::MeanStreak::Document.parse \
+      source,
+      **options,
+      mean_streak: self
+  end # #parse
+  
+  
+end # class NRSER::ShellDown
+
+
+# Post-Processing
+# =======================================================================
+
+require_relative './mean_streak/document'

data/lib/nrser/refinements/array.rb

@@ -18,6 +18,12 @@ module NRSER
     end
     
     
+    # Calls {NRSER.ellipsis} on `self`.
+    def ellipsis *args
+      NRSER.ellipsis self, *args
+    end
+    
+    
     # `to_*` Converters
     # =====================================================================
     

data/lib/nrser/refinements/string.rb

@@ -50,5 +50,11 @@ module NRSER
       NRSER.whitespace? self
     end
     
+    
+    # Calls {NRSER.ellipsis} on `self`.
+    def ellipsis *args
+      NRSER.ellipsis self, *args
+    end
+    
   end # refine String
 end # NRSER

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module NRSER::RSpex::ExampleGroup
+  
+  # @todo Document describe_instance method.
+  # 
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  # 
+  # @return [return_type]
+  #   @todo Document return value.
+  # 
+  def describe_instance *constructor_args, &body
+    describe_x_type ".new(", Args(*constructor_args), ")",
+      type: :instance,
+      metadata: {
+        constructor_args: constructor_args,
+      },
+      # subject_block: -> { super().new *described_args },
+      subject_block: -> { super().new *described_constructor_args },
+      &body
+  end # #describe_instance
+  
+end # module NRSER::RSpex::ExampleGroup

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module NRSER::RSpex::ExampleGroup
+  
+  def describe_instance_method name, **metadata, &block
+    describe(
+      "#{ NRSER::RSpex::PREFIXES[:method] } #{ name }",
+      type: :method,
+      method_name: name,
+      **metadata
+    ) do
+      if name.is_a? Symbol
+        subject { super().method name }
+      end
+      
+      module_exec &block
+    end
+  end # #describe_method
+  
+end # module NRSER::RSpex::ExampleGroup

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module NRSER::RSpex::ExampleGroup
+  
+  # Setup describes what's going to be *done* in all child examples.
+  # 
+  # It's where you setup your `subject`, usually depending on `let`
+  # bindings that are provided in the children.
+  # 
+  # @return [void]
+  # 
+  def describe_setup *description, **metadata, &body
+    describe_x \
+      *description,
+      type: :setup,
+      metadata: metadata,
+      &body
+  end # #describe_setup
+  
+  alias_method :setup, :describe_setup
+  
+end # module NRSER::RSpex::ExampleGroup

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

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module NRSER::RSpex::ExampleGroup
+  
+  # **EXPERIMENTAL**
+  # 
+  # Example group helper for use at the top level of each spec file to
+  # set a bunch of stuff up and build a helpful description.
+  # 
+  # @todo
+  #   This is totally just a one-off right now... would need to be
+  #   generalized quite a bit...
+  #   
+  #   1.  Extraction of module, class, etc from metadata should be flexible
+  #       
+  #   2.  Built description would need to be conditional on what metadata
+  #       was found.
+  # 
+  # @param [String] description:
+  #   A description of the spec file to add to the RSpec description.
+  # 
+  # @param [String] spec_path:
+  #   The path to the spec file (just feed it `__FILE__`).
+  #   
+  #   Probably possible to extract this somehow without having to provide it?
+  # 
+  # @return [nil]
+  # 
+  def describe_spec_file  description: nil,
+                          spec_path:,
+                          bind_subject: true,
+                          **metadata,
+                          &body
+    
+    if metadata[:module] && metadata[:method]
+      meth = metadata[:module].method metadata[:method]
+      file, line = meth.source_location
+      path = Pathname.new file
+      loc = "./#{ path.relative_path_from Pathname.getwd }:#{ line }"
+      
+      spec_rel_path = \
+        "./#{ Pathname.new( spec_path ).relative_path_from Pathname.getwd }"
+      
+      desc = [
+        "#{ metadata[:module].name }.#{ metadata[:method] }",
+        "(#{ loc })",
+        description,
+        "Spec (#{ spec_rel_path})"
+      ].compact.join " "
+      
+      subj = meth
+    
+    elsif metadata[:class]
+      klass = metadata[:class]
+      
+      if metadata[:instance_method]
+        instance_method = klass.instance_method metadata[:instance_method]
+        
+        file, line = instance_method.source_location
+        
+        name = "#{ klass.name }##{ metadata[:instance_method] }"
+      else
+        name = klass.name
+        
+        # Get a reasonable file and line for the class
+        file, line = klass.
+          # Get an array of all instance methods, excluding inherited ones
+          # (the `false` arg)
+          instance_methods( false ).
+          # Add `#initialize` since it isn't in `#instance_methods` for some
+          # reason
+          <<( :initialize ).
+          # Map those to their {UnboundMethod} objects
+          map { |sym| klass.instance_method sym }.
+          # Toss any `nil` values
+          compact.
+          # Get the source locations
+          map( &:source_location ).
+          # Get the first line in the shortest path
+          min_by { |(path, line)| [path.length, line] }
+          
+          # Another approach I thought of... (untested)
+          # 
+          # Get the path
+          # # Get frequency of the paths
+          # count_by { |(path, line)| path }.
+          # # Get the one with the most occurrences
+          # max_by { |path, count| count }.
+          # # Get just the path (not the count)
+          # first
+      end
+      
+      location = if file
+        "(#{ NRSER::RSpex.dot_rel_path file }:#{ line })"
+      end
+      
+      desc = [
+        "𝑆𝑃𝐸𝐶 𝐹𝐼𝐿𝐸 `#{ NRSER::RSpex.dot_rel_path spec_path }` 𝐹𝑂𝑅",
+        name,
+        location,
+        description,
+      ].compact.join " "
+      
+      subj = klass
+      
+    else
+      # TODO  Make this work!
+      raise ArgumentError.new binding.erb <<-END
+        Not yet able to handle metadata:
+        
+            <%= metadata.pretty_inspect %>
+        
+      END
+    end
+    
+    describe desc, **metadata do
+      if bind_subject
+        subject { subj }
+      end
+      
+      module_exec &body
+    end
+    
+    nil
+  end # #describe_spec_file
+  
+end # module NRSER::RSpex::ExampleGroup

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module NRSER::RSpex::ExampleGroup
+  
+  # @todo Document describe_use_case method.
+  # 
+  # @return [void]
+  # 
+  def describe_use_case *description, where: {}, **metadata, &body
+    describe_x \
+      *description,
+      type: :use_case,
+      bindings: where,
+      metadata: metadata,
+      &body
+  end # #describe_use_case
+  
+end # module NRSER::RSpex::ExampleGroup

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module NRSER::RSpex::ExampleGroup
+  
+  # Define a example group 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 describe_when *description, **bindings, &body
+    describe_x \
+      *description,
+      type: :when,
+      bindings: bindings,
+      &body
+  end
+  
+end # module NRSER::RSpex::ExampleGroup