nrser 0.1.1 → 0.1.2

data/lib/nrser/rspex.rb

@@ -19,10 +19,20 @@
 
 # Deps
 # -----------------------------------------------------------------------
+require 'rspec'
+require 'commonmarker'
 
 # Project / Package
 # -----------------------------------------------------------------------
+require 'nrser'
 require_relative './rspex/shared_examples'
+require_relative './rspex/format'
+
+
+# Refinements
+# =======================================================================
+
+using NRSER
 
 
 # Helpers
@@ -122,7 +132,6 @@ module NRSER::RSpex
   # Constants
   # =====================================================================
   
-  
   # Symbols
   # ---------------------------------------------------------------------
   # 
@@ -163,6 +172,10 @@ module NRSER::RSpex
   
   PREFIXES = PREFIXES_MATH_ITALIC
   
+  # PREFIXES = PREFIXES_MATH_ITALIC.map_values { |k, v|
+  #   RSpec::Core::Formatters::ConsoleCodes.wrap( v, :cyan )
+  # }
+  
   
   # Module (Class) Functions
   # =====================================================================
@@ -181,8 +194,7 @@ module NRSER::RSpex
   end # .short_s
   
   
-  
-  # @todo Document format_type method.
+  # @todo Document format method.
   # 
   # @param [type] arg_name
   #   @todo Add name param description.
@@ -190,39 +202,21 @@ module NRSER::RSpex
   # @return [return_type]
   #   @todo Document return value.
   # 
-  def self.format_type type, description
-    prefixes = RSpec.configuration.x_type_prefixes
-    
-    return description if type.nil? || !prefixes.key?( type )
-    
-    "#{ prefixes[type] } #{ description }"
-  end # .format_type
-  
+  def self.format *args
+    NRSER::RSpex::Format.description *args
+  end # .format
   
   
-  # @todo Document format method.
+  # Get the relative path from the working directory with the `./` in front.
   # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
+  # @param [String | Pathname] dest
+  #   Destination file path.
   # 
-  # @return [return_type]
-  #   @todo Document return value.
+  # @return [String]
   # 
-  def self.format *parts, type: nil
-    format_type \
-      type,
-      parts.
-        map { |part|
-          if part.respond_to? :to_desc
-            part.to_desc
-          elsif part.is_a? String
-            part
-          else
-            short_s part
-          end
-        }.
-        join( ' ' )
-  end # .format
+  def self.dot_rel_path dest
+    File.join '.', dest.to_pn.relative_path_from( Pathname.getwd )
+  end # .dot_rel_path
   
   
   class List < Array
@@ -251,7 +245,7 @@ module NRSER::RSpex
   end
   
   
-  class Args < Array
+  class Args < List
     def to_desc max = nil
       if last.is_a?( Hash )
         [
@@ -264,366 +258,6 @@ module NRSER::RSpex
     end
   end
   
-  
-  # Instance methods to extend example groups with.
-  # 
-  module ExampleGroup
-    
-    
-    # @todo Document describe_x method.
-    # 
-    # @param [type] arg_name
-    #   @todo Add name param description.
-    # 
-    # @return [return_type]
-    #   @todo Document return value.
-    # 
-    def describe_x_type *description_parts,
-                        type:,
-                        metadata: {},
-                        subject_block: nil,
-                        &body
-      
-      description = NRSER::RSpex.format *description_parts, type: type
-      
-      describe description, **metadata, type: type do
-        subject( &subject_block ) if subject_block
-        module_exec &body
-      end # description,
-      
-    end # #describe_x_type
-    
-    
-    # **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
-
-      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 " "
-      
-      describe desc, **metadata do
-        if bind_subject
-          subject { meth }
-        end
-        
-        module_exec &body
-      end
-      
-      nil
-    end # #describe_spec_file
-    
-    
-    # @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
-    
-    
-    # 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.
-    # 
-    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
-    
-    
-    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_class klass, bind_subject: true, **metadata, &block
-      description = "#{ NRSER::RSpex::PREFIXES[:class] } #{ klass.name }"
-      
-      describe(
-        description,
-        type: :class,
-        class: klass,
-        **metadata
-      ) do
-        if bind_subject
-          subject { klass }
-        end
-        
-        module_exec &block
-      end
-    end # #describe_class
-    
-    
-    def described_class
-      metadata[:class] || super()
-    end
-    
-    
-    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_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
-    
-    
-    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 ExampleGroup
-  
-  
   # Extensions available in examples themselves via RSpec's `config.include`.
   # 
   module Example
@@ -639,6 +273,8 @@ module NRSER::RSpex
   
 end # module NRSER:RSpex
 
+require_relative './rspex/example_group'
+
 
 RSpec.configure do |config|
   config.extend NRSER::RSpex::ExampleGroup
@@ -646,9 +282,9 @@ RSpec.configure do |config|
   
   config.add_setting :x_type_prefixes
   config.x_type_prefixes = \
-    NRSER::RSpex::PREFIXES_BASE.merge( NRSER::RSpex::PREFIXES_MATH_ITALIC )
-    
-  config.add_setting :x_type_prefixes
+    NRSER::RSpex::PREFIXES
+  
+  config.add_setting :x_style, default: :unicode
 end
 
 # Make available at the top-level

data/lib/nrser/types/paths.rb

@@ -30,7 +30,7 @@ module NRSER; end
 
 module NRSER::Types
   
-  # A {Pathname} type that provides a `from_s` 
+  # A {Pathname} type that provides a `from_s`
   PATHNAME = is_a \
     Pathname,
     name: 'PathnameType',
@@ -102,7 +102,7 @@ module NRSER::Types
     def abs_path name: 'AbsPath', **options
       intersection \
         path,
-        where { |path| File.absolute? path },
+        where { |path| path.to_pn.absolute? },
         name: name,
         **options
     end
@@ -155,4 +155,3 @@ module NRSER::Types
   POSIX_PATH_SEGMENT = path_segment name: 'POSIXPathSegment'
   
 end # module NRSER::Types
-

data/lib/nrser/types.rb

@@ -104,7 +104,11 @@ module NRSER::Types
         # OK, we matched! Is the corresponding expression callable?
         if expression.respond_to? :call
           # It is; invoke and return result.
-          return expression.call value
+          if expression.arity == 0
+            return expression.call
+          else
+            return expression.call value
+          end
         else
           # It's not; assume it's a value and return it.
           return expression

data/lib/nrser/version.rb

@@ -1,5 +1,5 @@
 module NRSER
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
   
   module Version
     

data/lib/nrser.rb

@@ -20,7 +20,7 @@ require 'singleton'
 
 # Deps
 # -----------------------------------------------------------------------
-
+require 'hamster'
 
 # Hi there!
 # 
@@ -61,8 +61,10 @@ require_relative './nrser/errors'
 require_relative './nrser/version'
 require_relative './nrser/no_arg'
 require_relative './nrser/message'
+require_relative './nrser/env'
 require_relative './nrser/collection'
 require_relative './nrser/functions'
 require_relative './nrser/types'
 require_relative './nrser/refinements'
 require_relative './nrser/meta'
+require_relative './nrser/mean_streak'

data/spec/nrser/env/path/insert_spec.rb

@@ -0,0 +1,65 @@
+describe_spec_file(
+  spec_path:        __FILE__,
+  class:            NRSER::Env::Path,
+  instance_method:  :insert,
+) do
+  
+  describe_setup %{
+    Create a new instance from `source`, call `#insert` on `args` and compare
+    to the string result from `#to_s`
+  } do
+    
+    let( :path ) { NRSER::Env::Path.new source }
+    subject { path.insert( *args ).to_s }
+    
+    describe_use_case(
+      "insert `./test/bin` into PATH before any workdir paths",
+      where: {
+        args: ['./test/bin', before: %r{^./}],
+      }
+    ) do
+      
+      describe_when(
+        "`./bin` is the first path in source",
+        source: './bin:/Users/nrser/bin:/usr/local/bin',
+      ) do
+        it "should insert at the start" do
+          is_expected.
+            to eq "./test/bin:#{ source }"
+        end
+      end
+      
+      describe_when(
+        "`./bin` is in the middle of the source",
+        source: '/some/path:./bin:/Users/nrser/bin:/usr/local/bin',
+      ) do
+        it "should insert before `./bin`" do
+          is_expected.
+            to eq '/some/path:./test/bin:./bin:/Users/nrser/bin:/usr/local/bin'
+        end
+      end
+      
+      describe_when(
+        "`./bin` is at the end of the source",
+        source: '/some/path:/Users/nrser/bin:/usr/local/bin:./bin',
+      ) do
+        it "should insert before `./bin`" do
+          is_expected.
+            to eq '/some/path:/Users/nrser/bin:/usr/local/bin:./test/bin:./bin'
+        end
+      end
+      
+      describe_when(
+        "no `./` paths in source",
+        source: '/some/path:/Users/nrser/bin:/usr/local/bin',
+      ) do
+        it "should insert at the end" do
+          is_expected.
+            to eq '/some/path:/Users/nrser/bin:/usr/local/bin:./test/bin'
+        end
+      end
+    end # insert `./test/bin` into PATH before any workdir paths
+    
+  end # setup
+  
+end # spec

data/spec/nrser/env/path_spec.rb

@@ -0,0 +1,12 @@
+describe_spec_file(
+  spec_path: __FILE__,
+  class: NRSER::Env::Path,
+) do
+  
+  describe_method :from_ENV do
+    it "loads from ENV['PATH']" do
+      expect( subject.call :PATH ).to be_a( described_class )
+    end
+  end # Method :from_ENV Description  
+  
+end # spec