nrser 0.3.9 → 0.3.10

data/lib/nrser/props/metadata.rb

@@ -47,14 +47,6 @@ class NRSER::Props::Metadata
   # Class Methods
   # ======================================================================
   
-  # @todo Document has_metadata? method.
-  # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
-  # 
-  # @return [return_type]
-  #   @todo Document return value.
-  # 
   def self.has_metadata? klass
     klass.instance_variable_defined? VARIABLE_NAME
   end # .has_metadata?
@@ -119,10 +111,10 @@ class NRSER::Props::Metadata
   
   # Get a map of property names to property instances.
   # 
-  # @param [Boolean] only_own:
+  # @param [Boolean] only_own
   #   Don't include super-class properties.
   # 
-  # @param [Boolean] only_primary:
+  # @param [Boolean] only_primary
   #   Don't include properties that have a {NRSER::Props::Prop#source}.
   # 
   # @return [Hash{ Symbol => NRSER::Props::Prop }]
@@ -151,7 +143,7 @@ class NRSER::Props::Metadata
   # @param [Symbol] name
   #   The name of the property.
   # 
-  # @param [Hash{ Symbol => Object }] **opts
+  # @param [Hash{ Symbol => Object }] opts
   #   Constructor options for {NRSER::Props::Prop}.
   # 
   # @return [NRSER::Props::Prop]
@@ -203,7 +195,7 @@ class NRSER::Props::Metadata
   #   Collection of prop values iterable by key/value pairs or by indexed
   #   entries.
   # 
-  # @param [Proc<(NRSER::Props::Prop, VALUE)>] &block
+  # @param [Proc<(NRSER::Props::Prop, VALUE)>] block
   #   Block that will receive primary prop and value pairs.
   # 
   # @raise [TypeError]

data/lib/nrser/props/mutable/stash.rb

@@ -1,6 +1,9 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
+# TODO  I don't know if this ever worked...? Looks like it was supposed to be 
+#       mutable prop'd object support backed by an {NRSER::Stash} instance.
+
 # Requirements
 # =======================================================================
 
@@ -106,13 +109,13 @@ module NRSER::Props::Mutable::Stash
     # Override {NRSER::Props::InstanceMethods#to_data} to handle non-prop
     # values in the {NRSER::Stash}.
     # 
-    # @param [Boolean] only_props:
+    # @param [Boolean] only_props
     #   When `true` only prop values will be added to the data hash.
     #   
     #   Otherwise, any non-prop keys and vales will be added as well
     #   (default behavior).
     # 
-    # @param **kwds
+    # @param [Hash] kwds
     #   See {NRSER::Props::InstanceMethods#to_data}.
     # 
     # @return (see NRSER::Props::InstanceMethods#to_data)

data/lib/nrser/props/prop.rb

@@ -120,13 +120,13 @@ class Prop
   # `.prop` "macro" defined at {NRSER::Props::Props::ClassMethods#prop}
   # that is extended in to classes including {NRSER::Props::Props}.
   # 
-  # @param [nil | Proc | Object] default:
+  # @param [nil | Proc | Object] default
   #   A default value or a {Proc} used to get default values for *primary*
   #   props. *Dervied* props (those that have a {#source}) may not
   # 
   #   At least one of `default:` and `source:` must be `nil`.
   # 
-  # @param [nil | Symbol | String | Proc] source:
+  # @param [nil | Symbol | String | Proc] source
   #   Source that provides the prop's value. See details for how each type is
   #   handled in {#source}. Strings are converted to symbols.
   #   
@@ -390,13 +390,9 @@ class Prop
   end # #full_name
   
   
-  # Test if this prop is configured to provide default values -
+  # Test if this prop is configured to provide default values.
   # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
-  # 
-  # @return [return_type]
-  #   @todo Document return value.
+  # @return [Boolean]
   # 
   def has_default?
     @has_default
@@ -451,26 +447,21 @@ class Prop
   end # #source?
   
   
-  # @todo Document instance_variable_source? method.
-  # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
+  # Is the value of this prop coming from an instance variable?
   # 
-  # @return [return_type]
-  #   @todo Document return value.
+  # @return [Boolean]
   # 
   def instance_variable_source?
     @instance_variable_source
   end # #instance_variable_source?
   
   
-  # @todo Document primary? method.
+  # Does this property represent and independent value (**not** sourced)?
   # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
+  # Primary properties are important because they're the ones you need to
+  # store and transport to reconstruct the instance.
   # 
-  # @return [return_type]
-  #   @todo Document return value.
+  # @return [Boolean]
   # 
   def primary?
     !source?

data/lib/nrser/rspex.rb

@@ -44,10 +44,7 @@ using NRSER
 
 # Merge "expectation" hashes by appending all clauses for each state.
 # 
-# @example
-#   
-# 
-# @param [Array<Hash>] *expectations
+# @param [Array<Hash>] expectations
 #   Splat of "expectation" hashes - see the examples.
 # 
 def merge_expectations *expectations
@@ -152,27 +149,11 @@ module NRSER::RSpex
   # =====================================================================
   
   
-  # @todo Document short_s method.
-  # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
-  # 
-  # @return [return_type]
-  #   @todo Document return value.
-  # 
   def self.short_s value, max = 64
     NRSER.smart_ellipsis value.inspect, max
   end # .short_s
   
   
-  # @todo Document format method.
-  # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
-  # 
-  # @return [return_type]
-  #   @todo Document return value.
-  # 
   def self.format *args
     NRSER::RSpex::Format.description *args
   end # .format

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

@@ -20,5 +20,8 @@ module NRSER::RSpex::ExampleGroup
 
   # Shorter name
   alias_method :describe_attr, :describe_attribute
+
+  # BOLDER name
+  alias_method :ATTRIBUTE, :describe_attribute
   
 end # module NRSER::RSpex::ExampleGroup

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

@@ -15,10 +15,10 @@ module NRSER::RSpex::ExampleGroup
   #     end
   #   end
   # 
-  # @param [Array] *args
+  # @param [Array] args
   #   Arguments to call `subject` with to produce the new subject.
   # 
-  # @param [#call] &body
+  # @param [#call] body
   #   Block to execute in the context of the example group after refining
   #   the subject.
   # 
@@ -33,11 +33,14 @@ module NRSER::RSpex::ExampleGroup
   
   # Short / old name
   alias_method :called_with, :describe_called_with
+
+  # New / bold name
+  alias_method :CALLED_WITH, :describe_called_with
   
   
   # Version of {#describe_called_with} for when you have no arguments.
   # 
-  # @param [#call] &body
+  # @param [#call] body
   #   Block to execute in the context of the example group after refining
   #   the subject.
   # 
@@ -52,7 +55,9 @@ module NRSER::RSpex::ExampleGroup
   
   alias_method :called, :describe_called
   alias_method :when_called, :describe_called
-  
+
+  # new / bold name
+  alias_method :CALLED, :describe_called
   
   
 end # module NRSER::RSpex::ExampleGroup

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

@@ -16,6 +16,7 @@ module NRSER::RSpex::ExampleGroup
   end # #describe_case
 
   alias_method :use_case, :describe_case
+  alias_method :CASE, :describe_case
   
   # Older name
   alias_method :describe_use_case, :describe_case

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

@@ -29,4 +29,6 @@ module NRSER::RSpex::ExampleGroup
       &body
   end # #describe_class
   
+  alias_method :CLASS, :describe_class
+  
 end # module NRSER::RSpex::ExampleGroup

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

@@ -8,7 +8,7 @@ module NRSER::RSpex::ExampleGroup
   # 
   # @param *description (see #describe_x)
   # 
-  # @param [Hash<Symbol, Object>] **metadata
+  # @param [Hash<Symbol, Object>] metadata
   #   RSpec metadata to set for the example group.
   #   
   #   See the `metadata` keyword argument to {#describe_x}.

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

@@ -5,7 +5,7 @@ module NRSER::RSpex::ExampleGroup
   # Describe an instance of the described class by providing arguments for
   # it's construction.
   # 
-  # @param [Array] *constructor_args
+  # @param [Array] constructor_args
   #   Arguments to pass to `.new` on {#described_class} to create instances.
   # 
   # @return [void]
@@ -21,5 +21,7 @@ module NRSER::RSpex::ExampleGroup
       },
       &body
   end # #describe_instance
+
+  alias_method :INSTANCE, :describe_instance
   
 end # module NRSER::RSpex::ExampleGroup

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

@@ -13,7 +13,7 @@ module NRSER::RSpex::ExampleGroup
   # 
   # @see #describe_x
   #
-  # @param [Array] *args
+  # @param [Array] args
   #   Passed to {NRSER::Message.from} to get or create the message instance.
   # 
   # @param &body (see #describe_x)

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

@@ -5,44 +5,75 @@ module NRSER::RSpex::ExampleGroup
   
   # Describe a method of the parent subject.
   # 
+  # @param [Method | Symbol | String] method
+  #   The method being described:
+  #   
+  #   1.  {Method} instance - used directly.
+  #       
+  #   2.  {Symbol}, {String} - 
+  # 
   # @return [void]
   # 
-  def describe_method method_name, *description, **metadata, &body
-    # Due to legacy, we only auto-bind if the name is a symbol
-    # 
-    # TODO  Get rid of this
-    # 
-    subject_block = if method_name.is_a? Symbol
-      -> { super().method method_name }
-    end
-    
-    name_prefix = if  self.respond_to?( :metadata ) &&
-                      self.metadata.key?( :constructor_args )
-      '#'
-    else
-      '.'
-    end
+  def describe_method method,
+                      *description,
+                      bind_subject: nil,
+                      **metadata,
+                      &body
+    case method
+    when Method
+      method_name = method.name
+      subject_block = -> { method }
+      bind_subject = true
+      name_string = NRSER::RSpex::Format.md_code_quote \
+        "#{ method.receiver }.#{ method.name }"
     
-    method = if self.try( :metadata )
-      getter = if self.metadata.key?( :constructor_args )
-        :instance_method
+    when Symbol, String
+      method_name = method
+
+      # Due to legacy, we only auto-bind if the name is a symbol
+      # 
+      # TODO  Get rid of this
+      # 
+      bind_subject = method_name.is_a?( Symbol ) if bind_subject.nil?
+
+      subject_block = if bind_subject
+        -> { super().method method_name }
+      end
+
+      name_prefix = if  self.respond_to?( :metadata ) &&
+                        self.metadata.key?( :constructor_args )
+        '#'
       else
-        :method
+        '.'
       end
-      
-      target = self.metadata[:class] || self.metadata[:module]
-      
-      if target
-        begin
-          target.public_send getter, method_name
-        rescue
-          nil
+    
+      method = if self.try( :metadata )
+        getter = if self.metadata.key?( :constructor_args )
+          :instance_method
+        else
+          :method
+        end
+        
+        target = self.metadata[:class] || self.metadata[:module]
+        
+        if target
+          begin
+            target.public_send getter, method_name
+          rescue
+            nil
+          end
         end
       end
-    end
     
-    name_string = NRSER::RSpex::Format.md_code_quote \
-      "#{ name_prefix }#{ method_name }"
+      name_string = NRSER::RSpex::Format.md_code_quote \
+        "#{ name_prefix }#{ method_name }"
+    
+    else
+      raise NRSER::TypeError.new \
+        "Expected Method, Symbol or String for `method_name`, found",
+        method_name
+      
+    end # case method_arg
     
     # Create the RSpec example group context
     describe_x \
@@ -54,8 +85,11 @@ module NRSER::RSpex::ExampleGroup
         **metadata,
         method_name: method_name,
       },
+      bind_subject: bind_subject,
       subject_block: subject_block,
       &body
   end # #describe_method
+
+  alias_method :METHOD, :describe_method
   
 end # module NRSER::RSpex::ExampleGroup

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

@@ -8,7 +8,7 @@ module NRSER::RSpex::ExampleGroup
   # Pretty much a short-cut for nesting {#describe_method} /
   # {#describe_called_with}. Meh.
   # 
-  # @param [Array] *args
+  # @param [Array] args
   #   Passed to {NRSER::Message.from} to get or create the message instance.
   # 
   # @param &body          (see #describe_x)

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

@@ -14,7 +14,7 @@ module NRSER::RSpex::ExampleGroup
   # 
   # @param *description (see #describe_x)
   # 
-  # @param [Hash<Symbol, Object>] **metadata
+  # @param [Hash<Symbol, Object>] metadata
   #   RSpec metadata to set for the example group.
   #   
   #   See the `metadata` keyword argument to {#describe_x}.
@@ -34,5 +34,8 @@ module NRSER::RSpex::ExampleGroup
   
   # Old name
   alias_method :describe_topic, :describe_section
+
+  # BOLD NAME!
+  alias_method :SECTION, :describe_section
   
 end # module NRSER::RSpex::ExampleGroup

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

@@ -13,7 +13,7 @@ module NRSER::RSpex::ExampleGroup
   #   If it's a {Wrapper} it will be unwrapped in example contexts of the
   #   new example group.
   # 
-  # @param [Boolean] publicly:
+  # @param [Boolean] publicly
   #   Send message publicly via {Object#public_send} (default) or privately
   #   via {Object.send}.
   # 

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

@@ -18,5 +18,6 @@ module NRSER::RSpex::ExampleGroup
   end # #describe_setup
   
   alias_method :setup, :describe_setup
+  alias_method :SETUP, :describe_setup
   
 end # module NRSER::RSpex::ExampleGroup