nrser 0.0.29 → 0.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2273f6424356766a1849b35fc437b13942f15af1
-  data.tar.gz: 901f479555218cc42909235832f2271ca8f61579
+  metadata.gz: e894a45a17099589d7b23f53b7b2c416d448b6d3
+  data.tar.gz: 9e66a57ccee2dba38b1bf16e45a55197fa80ccac
 SHA512:
-  metadata.gz: 87482595ba0e8a8fec1b3e7c3b3c368432a5edbef62a2704d721e61199177446a6d0e28ca4c2f1119db5d7adb8da8666ded661f3c79f20f44dbccee48b756e80
-  data.tar.gz: 412d7fdbe26337164955f5a52e6bc70370f2bd5c1282797e66c91b794fa2b8471e2dc9865e9210b822490799194a90102242466967e233a23630f773ac6cf33b
+  metadata.gz: 1132214b192658affc169b261f8d9840cbae0d2f3c33e2a7f48c64e2bfb6876411b50e5a3aa0b22a5245d82aa5dae5b48ef3c16fee9fa4b1ab295793b9ff7413
+  data.tar.gz: 1676e9d23b8182bc24447008410498aeace1b57a5c0400f02da39cb1e2e64cb2f24099253dc0ad3815c9fb00e9de24e899ee5a5c6389cffc219aa1e711211a6e

data/lib/nrser/enumerable.rb

@@ -204,5 +204,85 @@ module NRSER
     end # #enumerate_as_values
     
     
+    # Count entries in an {Enumerable} by the value returned when they are 
+    # passed to the block.
+    # 
+    # @example Count array entries by class
+    #   
+    #   [1, 2, :three, 'four', 5, :six].count_by &:class
+    #   # => {Fixnum=>3, Symbol=>2, String=>1}
+    # 
+    # @param [Enumerable<E>] enum
+    #   {Enumerable} (or other object with compatible `#each_with_object` and 
+    #   `#to_enum` methods) you want to count.
+    # 
+    # @param [Proc<(E)=>C>] &block
+    #   Block mapping entries in `enum` to the group to count them in.
+    # 
+    # @return [Hash{C=>Integer}]
+    #   Hash mapping groups to positive integer counts.
+    # 
+    def count_by enum, &block
+      enum.each_with_object( Hash.new 0 ) do |entry, hash|
+        hash[block.call entry] += 1
+      end
+    end
+    
+    
+    # Like `Enumerable#find`, but wraps each call to `&block` in a
+    # `begin` / `rescue`, returning the result of the first call that doesn't
+    # raise an error.
+    # 
+    # If no calls succeed, raises a {NRSER::MultipleErrors} containing the 
+    # errors from the block calls.
+    # 
+    # @param [Enumerable<E>] enum
+    #   Values to call `&block` with.
+    # 
+    # @param [Proc<E=>V>] &block
+    #   Block to call, which is expected to raise an error if it fails.
+    # 
+    # @return [V]
+    #   Result of first call to `&block` that doesn't raise.
+    # 
+    # @raise [ArgumentError]
+    #   If `enum` was empty (`enum#each` never yielded).
+    # 
+    # @raise [NRSER::MultipleErrors]
+    #   If all calls to `&block` failed.
+    # 
+    def try_find enum, &block
+      errors = []
+      
+      enum.each do |*args|
+        begin
+          result = block.call *args
+        rescue Exception => error
+          errors << error
+        else
+          return result
+        end
+      end
+      
+      if errors.empty?
+        raise ArgumentError,
+          "Appears that enumerable was empty: #{ enum.inspect }"
+      else
+        raise NRSER::MultipleErrors.new errors
+      end
+    end
+    
+    
+    # TODO It would be nice for this to work...
+    # 
+    # def to_enum object, meth, *args
+    #   unless object.respond_to?( meth )
+    #     object = NRSER::Enumerable.new object
+    #   end
+    # 
+    #   object.to_enum meth, *args
+    # end
+    
+    
   end # class << self (Eigenclass)
 end # module NRSER

data/lib/nrser/errors.rb

@@ -55,5 +55,52 @@ module NRSER
     end # #initialize
     
   end # class AbstractMethodError
+  
+  
+  # A wrapper error around a list of other errors.
+  # 
+  class MultipleErrors < StandardError
+    
+    # Attributes
+    # ======================================================================
+    
+    # The individual errors that occurred.
+    # 
+    # @return [Array<Exception>]
+    #     
+    attr_reader :errors
+    
+    
+    # Constructor
+    # ======================================================================
+    
+    # Instantiate a new `MultipleErrors`.
+    def initialize errors, headline: nil
+      @errors = errors
+      
+      if headline.nil?
+        class_counts = NRSER.count_by( errors, &:class ).
+          map { |klass, count| "#{ klass } (#{ count })" }.
+          join( ', ' )
+        
+        headline = "#{ errors.count } error(s) occurred - #{ class_counts }"
+      end
+      
+      message = NRSER.erb binding, <<-END
+        <%= headline %>
+        
+        <% errors.each_with_index do |error, index| %>
+        <%= (index.succ.to_s + ".").ljust( 3 ) %> <%= error.message %> (<%= error.class %>):
+            <%= error.backtrace.join( $/ ) %>
+        <% end %>
+        
+      END
+      
+      super message
+    end # #initialize
+    
+    
+  end # class MultipleErrors
+  
 
 end # module NRSER

data/lib/nrser/refinements/enumerable.rb

@@ -32,20 +32,34 @@ module NRSER::Refinements::Enumerable
     NRSER.to_h_by self, &block
   end
   
+  
   # See {NRSER.enumerate_as_values}
   def enumerate_as_values
     NRSER.enumerate_as_values self
   end
   
+  
   # Calls {NRSER.only} on `self`.
   def only **options
     NRSER.only self, **options
   end
   
+  
   # See {NRSER.only!}
   def only!
     NRSER.only! self
   end
   
+  
+  # See {NRSER.count_by}
+  def count_by &block
+    NRSER.count_by self, &block
+  end
+  
+  
+  # See {NRSER.try_find}
+  def try_find &block
+    NRSER.try_find self, &block
+  end
+  
 end # module NRSER::Refinements::Enumerable
-

data/lib/nrser/rspex.rb

@@ -272,7 +272,58 @@ module NRSER::RSpex
         module_exec &body
       end # description, 
       
-    end # #describe_x
+    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:,
+                            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})"
+      
+      describe desc, **metadata do
+        if bind_subject
+          subject { meth }
+        end
+        
+        module_exec &body
+      end
+      
+      nil
+    end # #describe_spec_file
     
     
     # @todo Document describe_instance method.
@@ -435,12 +486,17 @@ module NRSER::RSpex
     end
     
     
-    def describe_module mod, **metadata, &block
+    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
@@ -567,6 +623,8 @@ 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
 end
 
 # Make available at the top-level

data/lib/nrser/version.rb

@@ -1,5 +1,5 @@
 module NRSER
-  VERSION = "0.0.29"
+  VERSION = "0.0.30"
   
   module Version
     

data/spec/nrser/text/dedent/gotchas_spec.rb

@@ -0,0 +1,61 @@
+describe_spec_file(
+  description: "Gotchas",
+  spec_path: __FILE__,
+  module: NRSER,
+  method: :dedent,
+) do
+  
+  describe_section "Newline literals in HEREDOCs" do
+  # ========================================================================
+    
+    subject do
+      super().call input
+    end
+    
+    describe_group "when a HEREDOC has a with literal \\n" do
+    # ========================================================================
+      
+      let :input do
+        <<-END
+          <%= headline %>
+          
+          <% errors.each_with_index do |error, index| %>
+          <%= (index.succ.to_s + ".").ljust( 3 ) %> <%= error.message %> (<%= error.class %>):
+              <%= error.backtrace.join( "\n" ) %>
+          <% end %>
+          
+        END
+      end
+      
+      it "should NOT produce the desired dedent" do
+        expect( subject.lines.first ).not_to match /\A\S+/
+      end
+      
+    end
+    # ************************************************************************
+    
+    
+    describe_group "when the HEREDOC uses $/ instead of \\n" do
+      let :input do
+        <<-END
+          <%= headline %>
+          
+          <% errors.each_with_index do |error, index| %>
+          <%= (index.succ.to_s + ".").ljust( 3 ) %> <%= error.message %> (<%= error.class %>):
+              <%= error.backtrace.join( $/ ) %>
+          <% end %>
+          
+        END
+      end
+      
+      it "should produce the desired dedent" do
+        expect( subject.lines.first ).to match /\A\S+/
+      end
+      
+    end # Group "when the HEREDOC uses $/ instead of \\n" Description
+    
+  end # section Newline literals in HEREDOCs
+  # ************************************************************************
+  
+end # describe_spec_file
+  

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nrser
 version: !ruby/object:Gem::Version
-  version: 0.0.29
+  version: 0.0.30
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2018-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -254,6 +254,7 @@ files:
 - spec/nrser/string/common_prefix_spec.rb
 - spec/nrser/string/looks_like_spec.rb
 - spec/nrser/template_spec.rb
+- spec/nrser/text/dedent/gotchas_spec.rb
 - spec/nrser/text/dedent_spec.rb
 - spec/nrser/tree/each_branch_spec.rb
 - spec/nrser/tree/leaves_spec.rb
@@ -335,6 +336,7 @@ test_files:
 - spec/nrser/string/common_prefix_spec.rb
 - spec/nrser/string/looks_like_spec.rb
 - spec/nrser/template_spec.rb
+- spec/nrser/text/dedent/gotchas_spec.rb
 - spec/nrser/text/dedent_spec.rb
 - spec/nrser/tree/each_branch_spec.rb
 - spec/nrser/tree/leaves_spec.rb