nrser 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a82b7acc13e484b54ab2d87d8d5062c0ce9d2df6
-  data.tar.gz: a552517767686380e2b992bfa05c1464dfdc742f
+  metadata.gz: f34385ea491972db4f43263773d9e9655ddabf85
+  data.tar.gz: af6e560b27729d1d16e8aa007515eb2d4eee354f
 SHA512:
-  metadata.gz: 962bd3242210ac27e0adaffefaf8f147eb933aef2c03d9c302dc48cb3a03e80a7bf19b2f0a466b244e303d120ce219c9f050a4fb5feadcdcca3abd72a948a81d
-  data.tar.gz: 4c2ef1b895ac39ad7882952ecc8761595a37860688ef456c2174f0fff48b9670a9f09f88a852c7a6a6d7351e3aa39c70177d41e1ee448647c9b372744128d798
+  metadata.gz: 8b9e68cefda2494539cd0f44efdee84ce70ddba6bbaccbe989e1cae0de30356cfbac0c5ede7df901489317a970cc3bec8dd38a720654344497e7dc3b47e66d3f
+  data.tar.gz: c400d4be2fed9d8120453f049dd86904c9bd8a2283525dee076318054d690f66b36f838453ef5a0c650f37323c57df86ee0acf33bf303893959f02d27c8342cc

data/lib/nrser/binding.rb

@@ -0,0 +1,14 @@
+require_relative './string'
+
+module NRSER
+  class << self
+
+    def erb bnd, str
+      require 'erb'
+      filter_repeated_blank_lines ERB.new(dedent(str)).result(bnd)
+    end # erb
+
+    alias_method :template, :erb
+    
+  end # class << self
+end # module NRSER

data/lib/nrser/enumerable.rb

@@ -2,7 +2,7 @@ module NRSER
   # Maps an enumerable object to a *new* hash with the same keys and values 
   # obtained by calling `block` with the current key and value.
   # 
-  # If `enumerable` *does not* sucessfully respond to `#to_h` then it's 
+  # If `enumerable` *does not* successfully respond to `#to_h` then it's 
   # treated as a hash where it's elements are the keys and all the values
   # are `nil`.
   # 
@@ -13,14 +13,14 @@ module NRSER
     # next step, it's going to probably be *the* most common argument type,
     # and there's no reason to do the tests and set up the exception 
     # handler if we already know what's up with it.
-    return NRSER.map_hash_values(enumerable) if enumerable.is_a? Hash
+    return NRSER.map_hash_values(enumerable, &block) if enumerable.is_a? Hash
     
     if enumerable.respond_to? :to_h
       begin
         hash = enumerable.to_h
       rescue TypeError => e
       else
-        return NRSER.map_hash_values hash
+        return NRSER.map_hash_values hash, &block
       end
     end
     

data/lib/nrser/exception.rb

@@ -0,0 +1,7 @@
+module NRSER 
+  class << self
+    def format_exception e
+      "#{ e.message } (#{ e.class }):\n  #{ e.backtrace.join("\n  ") }"
+    end
+  end # class << self
+end # module NRSER

data/lib/nrser/meta/class_attrs.rb

@@ -0,0 +1,76 @@
+module NRSER 
+module Meta
+  
+# Mixin to provide methods to define and access class attributes - variables
+# that act like instance variables with regards to inheritance but for the
+# class itself.
+# 
+# The motivation is to create a easy-to-use class instance variables that 
+# resolve like regular instance variables by looking up the inheritance
+# hierarchy - meaning that:
+# 
+# 1.  When the value is set, it is set on the class in which the operation
+#     happens.
+#     
+# 2.  That value is read for that class and any subclasses.
+#     -   Class 'self' attr_accessor values are not visible to subclasses.
+#     
+# 3.  But that value is not visible to any classes further up the inheritance
+#     chain.
+#     -   Class variables (`@@` variables) are global to the *entire class
+#         hierarchy* rooted at the definition point.
+# 
+# The tests in `spec/nrser/class_attrs_spec.rb` provide detailed walk-through
+# of usage and differences from other approaches.
+# 
+module ClassAttrs 
+  
+  # Class methods to extend the receiver with when {NRSER::Meta::ClassAttrs}
+  # is included.
+  module ClassMethods
+    def instance_variable_lookup name
+      instance_variable_get(name) || if (
+        superclass.respond_to? :instance_variable_lookup
+      )
+        superclass.instance_variable_lookup name
+      else
+        raise NoMethodError.new NRSER.squish <<-END
+          #{ name.inspect } is not defined anywhere in the class hierarchy
+        END
+      end
+    end
+
+    def class_attr_accessor attr
+      var_name = "@#{ attr }".to_sym
+      
+      singleton_class.class_eval do
+        define_method(attr) do |*args|
+          case args.length
+          when 0
+            instance_variable_lookup var_name
+          when 1
+            instance_variable_set var_name, args[0]
+          else
+            raise ArgumentError.new NRSER.squish <<-END
+              wrong number of arguments
+              (given #{ args.length }, expected 0 or 1)
+            END
+          end
+        end
+        
+        define_method("#{ attr }=") do |value|
+          instance_variable_set var_name, value
+        end
+      end
+    end
+  end # module ClassMethods
+  
+  # Extend the including class with {NRSER::Meta::ClassAttrs::ClassMethods}
+  def self.included base
+    base.extend ClassMethods
+  end
+  
+end # module ClassAttrs
+
+end # module Meta
+end # module NRSER

data/lib/nrser/meta/props/base.rb

@@ -0,0 +1,15 @@
+module NRSER
+module Meta 
+module Props 
+
+class Base
+  include NRSER::Meta::Props
+  
+  def initialize **values
+    initialize_props values
+  end
+end # class Base
+
+end # module Props
+end # module Meta
+end # module NRSER

data/lib/nrser/meta/props.rb

@@ -0,0 +1,363 @@
+module NRSER 
+module Meta 
+
+T = NRSER::Types
+
+# 
+module Props
+  PROPS_VARIABLE_NAME = :@__NRSER_props
+  PROP_VALUES_VARIABLE_NAME = :@__NRSER_prop_values
+  
+  class Prop
+    attr_accessor :defined_in,
+                  :name,
+                  :type,
+                  :source
+    
+    
+    def initialize  defined_in,
+                    name,
+                    type: T.any,
+                    default: NRSER::NO_ARG,
+                    source: nil
+      
+      @defined_in = defined_in
+      @name = name
+      @type = NRSER::Types.make type
+      @source = source
+      @default = default
+      
+      if @source.nil?
+        @instance_variable_source = false
+      else
+        source_str = source.to_s
+        @instance_variable_source = source_str[0] == '@'
+      end
+    end
+    
+    
+    # @todo Document default? method.
+    # 
+    # @param [type] arg_name
+    #   @todo Add name param description.
+    # 
+    # @return [return_type]
+    #   @todo Document return value.
+    # 
+    def default?
+      @default != NRSER::NO_ARG
+    end # #default?
+    
+    
+    def default
+      if default?
+        @default
+      else
+        raise NameError.new NRSER.squish <<-END
+          Prop #{ self } has no default value.
+        END
+      end
+    end
+    
+    
+    # @todo Document source? method.
+    # 
+    # @param [type] arg_name
+    #   @todo Add name param description.
+    # 
+    # @return [return_type]
+    #   @todo Document return value.
+    # 
+    def source?
+      !@source.nil?
+    end # #source?
+    
+    
+    # @todo Document instance_variable_source? method.
+    # 
+    # @param [type] arg_name
+    #   @todo Add name param description.
+    # 
+    # @return [return_type]
+    #   @todo Document return value.
+    # 
+    def instance_variable_source?
+      @instance_variable_source
+    end # #instance_variable_source?
+    
+    
+    # @todo Document primary? method.
+    # 
+    # @param [type] arg_name
+    #   @todo Add name param description.
+    # 
+    # @return [return_type]
+    #   @todo Document return value.
+    # 
+    def primary?
+      !source?
+    end # #primary?
+    
+    
+    # @todo Document get method.
+    # 
+    # @param [type] arg_name
+    #   @todo Add name param description.
+    # 
+    # @return [return_type]
+    #   @todo Document return value.
+    # 
+    def get instance
+      if source?
+        if instance_variable_source?
+          instance.instance_variable_get source
+        else
+          instance.send source
+        end
+      else
+        values(instance)[name]
+      end
+    end # #get
+    
+    
+    # @todo Document set method.
+    # 
+    # @param [type] arg_name
+    #   @todo Add name param description.
+    # 
+    # @return [return_type]
+    #   @todo Document return value.
+    # 
+    def set instance, value
+      unless type.test value
+        raise TypeError.new NRSER.squish <<-END
+          #{ defined_in }##{ name } must be of type #{ type };
+          found #{ value.inspect }
+        END
+      end
+      
+      values(instance)[name] = value
+    end # #set
+    
+    
+    
+    # @todo Document set_from_hash method.
+    # 
+    # @param [type] arg_name
+    #   @todo Add name param description.
+    # 
+    # @return [return_type]
+    #   @todo Document return value.
+    # 
+    def set_from_values_hash instance, **values
+      if values.key? name
+        set instance, values[name]
+      else
+        if default?
+          set instance, default.dup
+        else
+          raise TypeError.new NRSER.squish <<-END
+            Prop #{ name } has no default value and no value was provided in
+            values #{ values.inspect }.
+          END
+        end
+      end
+    end # #set_from_hash
+    
+    
+    private
+      
+      # @todo Document values method.
+      # 
+      # @param [type] arg_name
+      #   @todo Add name param description.
+      # 
+      # @return [return_type]
+      #   @todo Document return value.
+      # 
+      def values instance
+        unless instance.instance_variable_defined? PROP_VALUES_VARIABLE_NAME
+          instance.instance_variable_set PROP_VALUES_VARIABLE_NAME, {}
+        end
+        
+        instance.instance_variable_get PROP_VALUES_VARIABLE_NAME
+      end # #value
+    
+  end # class Prop
+  
+  
+  # @todo Document get_props_ref method.
+  # 
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  # 
+  # @return [return_type]
+  #   @todo Document return value.
+  # 
+  def self.get_props_ref klass
+    unless klass.instance_variable_defined? PROPS_VARIABLE_NAME
+      klass.instance_variable_set PROPS_VARIABLE_NAME, {}
+    end
+    
+    klass.instance_variable_get PROPS_VARIABLE_NAME
+  end # .get_props_ref
+  
+  
+  module ClassMethods
+    
+    
+    # @todo Document props method.
+    # 
+    # @param [type] arg_name
+    #   @todo Add name param description.
+    # 
+    # @return [return_type]
+    #   @todo Document return value.
+    # 
+    def props own: false, primary: false
+      result = if !own && superclass.respond_to?(:props)
+        superclass.props own: own, primary: primary
+      else
+        {}
+      end
+      
+      own_props = NRSER::Meta::Props.get_props_ref self
+      
+      if primary
+        own_props.each {|name, prop|
+          if prop.primary?
+            result[name] = prop
+          end
+        }
+      else
+        result.merge! own_props
+      end
+      
+      result
+    end # #own_props
+    
+    
+    # @todo Document prop method.
+    # 
+    # @param [type] arg_name
+    #   @todo Add name param description.
+    # 
+    # @return [return_type]
+    #   @todo Document return value.
+    # 
+    def prop name, **opts
+      ref = NRSER::Meta::Props.get_props_ref self
+      
+      T.sym.check name
+      
+      if ref.key? name
+        raise ArgumentError.new NRSER.squish <<-END
+          Prop #{ name.inspect } already set for #{ self }:
+          #{ ref[name].inspect }
+        END
+      end
+      
+      prop = Prop.new self, name, **opts
+      ref[name] = prop
+      
+      unless prop.source?
+        class_eval do
+          define_method(name) do
+            prop.get self
+          end
+          
+          # protected
+          #   define_method("#{ name }=") do |value|
+          #     prop.set self, value
+          #   end
+        end
+      end
+    end # #prop
+    
+    
+    
+    # @todo Document from_h method.
+    # 
+    # @param [type] arg_name
+    #   @todo Add name param description.
+    # 
+    # @return [return_type]
+    #   @todo Document return value.
+    # 
+    def from_h hash
+      self.new(
+        NRSER.slice_keys(
+          NRSER.symbolize_keys(hash),
+          *self.props(primary: true).keys
+        )
+      )
+    end # #from_h
+    
+      
+  end # module ClassMethods
+  
+  
+  # Extend the including class with {NRSER::Meta::Props:ClassMethods}
+  def self.included base
+    base.extend ClassMethods
+  end
+  
+  
+  # Instance Methods
+  # =====================================================================
+  
+  
+  # @todo Document initialize_props method.
+  # 
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  # 
+  # @return [return_type]
+  #   @todo Document return value.
+  # 
+  def initialize_props values
+    self.class.props(primary: true).each { |name, prop|
+      prop.set_from_values_hash self, values
+    }
+  end # #initialize_props
+  
+  
+  # @todo Document to_h method.
+  # 
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  # 
+  # @return [return_type]
+  #   @todo Document return value.
+  # 
+  def to_h primary: false, own: false
+    NRSER.map_values(
+      self.class.props own: own, primary: primary
+    ) { |name, prop| prop.get self }
+  end # #to_h
+  
+  
+  # @todo Document to_json method.
+  # 
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  # 
+  # @return [return_type]
+  #   @todo Document return value.
+  # 
+  def to_json *args
+    to_h.to_json *args
+  end # #to_json
+  
+  
+  def to_yaml *args
+    to_h.to_yaml *args
+  end
+  
+  
+end # module Props
+
+end # module Meta
+end # module NRSER
+
+require_relative './props/base'

data/lib/nrser/meta.rb

@@ -0,0 +1,2 @@
+require_relative './meta/class_attrs'
+require_relative './meta/props'

data/lib/nrser/no_arg.rb

@@ -0,0 +1,15 @@
+require 'singleton'
+
+module NRSER
+  # A singleton class who's instance is used to denote the lack of value 
+  # for an argument when used as the default.
+  # 
+  # For situations where an argument is optional and `nil` is a legitimate
+  # value.
+  # 
+  class NoArg
+    include Singleton
+  end
+  
+  NO_ARG = NoArg.instance
+end # module NRSER

data/lib/nrser/refinements/binding.rb

@@ -0,0 +1,7 @@
+module NRSER
+  refine Binding do
+    def erb str
+      NRSER.template self, str
+    end
+  end  
+end # NRSER

data/lib/nrser/refinements/exception.rb

@@ -0,0 +1,7 @@
+module NRSER
+  refine Exception do
+    def format
+      NRSER.format_exception self
+    end
+  end
+end # NRSER

data/lib/nrser/refinements/types.rb

@@ -0,0 +1,9 @@
+module NRSER 
+  module Types 
+    refine Object do
+      def t
+        NRSER::Types
+      end
+    end
+  end # module Types
+end # module NRSER

data/lib/nrser/refinements.rb

@@ -3,17 +3,5 @@ require_relative './refinements/string'
 require_relative './refinements/array'
 require_relative './refinements/hash'
 require_relative './refinements/pathname'
-
-module NRSER
-  refine Exception do
-    def format
-      NRSER.format_exception self
-    end
-  end
-  
-  refine Binding do
-    def erb str
-      NRSER.template self, str
-    end
-  end  
-end # NRSER
+require_relative './refinements/exception'
+require_relative './refinements/binding'

data/lib/nrser/string.rb

@@ -0,0 +1,109 @@
+module NRSER
+  class << self
+    # Functions the operate on strings.
+    
+    # turn a multi-line string into a single line, collapsing whitespace
+    # to a single space.
+    # 
+    # same as ActiveSupport's String.squish, adapted from there.
+    def squish str
+      str.gsub(/[[:space:]]+/, ' ').strip
+    end # squish
+    
+    alias_method :unblock, :squish
+    
+    
+    def common_prefix strings
+      raise ArgumentError.new("argument can't be empty") if strings.empty?
+      sorted = strings.sort.reject {|line| line == "\n"}
+      i = 0
+      while sorted.first[i] == sorted.last[i] &&
+            i < [sorted.first.length, sorted.last.length].min
+        i = i + 1
+      end
+      strings.first[0...i]
+    end # common_prefix
+    
+    
+    def dedent str
+      return str if str.empty?
+      lines = str.lines
+      indent = common_prefix(lines).match(/^\s*/)[0]
+      return str if indent.empty?
+      lines.map {|line|
+        line = line[indent.length..line.length] if line.start_with? indent
+      }.join
+    end # dedent
+    
+    # I like dedent better, but other libs seems to call it deindent
+    alias_method :deindent, :dedent
+    
+    
+    def filter_repeated_blank_lines str
+      out = []
+      lines = str.lines
+      skipping = false
+      str.lines.each do |line|
+        if line =~ /^\s*$/
+          unless skipping
+            out << line
+          end
+          skipping = true
+        else
+          skipping = false
+          out << line
+        end
+      end
+      out.join
+    end # filter_repeated_blank_lines
+    
+    
+    # adapted from acrive_support 4.2.0
+    # 
+    # <https://github.com/rails/rails/blob/7847a19f476fb9bee287681586d872ea43785e53/activesupport/lib/active_support/core_ext/string/indent.rb>
+    #
+    def indent str, amount = 2, indent_string=nil, indent_empty_lines=false
+      indent_string = indent_string || str[/^[ \t]/] || ' '
+      re = indent_empty_lines ? /^/ : /^(?!$)/
+      str.gsub(re, indent_string * amount)
+    end
+    
+    # Truncates a given +text+ after a given <tt>length</tt> if +text+ is longer than <tt>length</tt>:
+    #
+    #   'Once upon a time in a world far far away'.truncate(27)
+    #   # => "Once upon a time in a wo..."
+    #
+    # Pass a string or regexp <tt>:separator</tt> to truncate +text+ at a natural break:
+    #
+    #   'Once upon a time in a world far far away'.truncate(27, separator: ' ')
+    #   # => "Once upon a time in a..."
+    #
+    #   'Once upon a time in a world far far away'.truncate(27, separator: /\s/)
+    #   # => "Once upon a time in a..."
+    #
+    # The last characters will be replaced with the <tt>:omission</tt> string (defaults to "...")
+    # for a total length not exceeding <tt>length</tt>:
+    #
+    #   'And they found that many people were sleeping better.'.truncate(25, omission: '... (continued)')
+    #   # => "And they f... (continued)"
+    # 
+    # adapted from 
+    # 
+    # <https://github.com/rails/rails/blob/7847a19f476fb9bee287681586d872ea43785e53/activesupport/lib/active_support/core_ext/string/filters.rb#L46>
+    # 
+    def truncate(str, truncate_at, options = {})
+      return str.dup unless str.length > truncate_at
+
+      omission = options[:omission] || '...'
+      length_with_room_for_omission = truncate_at - omission.length
+      stop = \
+        if options[:separator]
+          str.rindex(options[:separator], length_with_room_for_omission) || length_with_room_for_omission
+        else
+          length_with_room_for_omission
+        end
+
+      "#{str[0, stop]}#{omission}"
+    end
+  end # class << self
+end # module NRSER

data/lib/nrser/types/any.rb

@@ -4,7 +4,7 @@ require 'nrser/types/where'
 using NRSER
   
 module NRSER::Types
-  ANY = where(name: 'Any', from_s: ->(s) { s }) { true }
+  ANY = where(name: 'Any', from_s: ->(s) { s }) { true }.freeze
   
   # anything
   def self.any

data/lib/nrser/types/array.rb

@@ -10,13 +10,13 @@ module NRSER::Types
     
     attr_reader :item_type
     
-    def initialize item_type = NRSER::Types.any, **options
+    def initialize item_type = NRSER::Types::ANY, **options
       super ::Array, **options
       @item_type = NRSER::Types.make item_type
     end
     
     def test value
-      super(value) && if @item_type == NRSER::Types.any
+      super(value) && if @item_type == NRSER::Types::ANY
         true
       else
         value.all? {|v| @item_type.test v}
@@ -55,7 +55,6 @@ module NRSER::Types
     Array.new *args
   end
   
-  def self.list
-    array
-  end
+  singleton_class.send :alias_method, :list, :array
+  
 end # NRSER::Types

data/lib/nrser/types/combinators.rb

@@ -63,10 +63,7 @@ module NRSER::Types
     NRSER::Types::Union.new *types, **options
   end
   
-  # match any of the types
-  def self.one_of *types, **options
-    union *types, **options
-  end
+  singleton_class.send :alias_method, :one_of, :union
   
   class Intersection < Combinator      
     def test value
@@ -79,8 +76,6 @@ module NRSER::Types
     Intersection.new *types, **options
   end
   
-  # match all of the types
-  def self.all_of *types, **options
-    intersection *types, **options
-  end
+  singleton_class.send :alias_method, :all_of, :intersection
+  
 end # NRSER::Types

data/lib/nrser/types/hash.rb

@@ -5,11 +5,41 @@ using NRSER
   
 module NRSER::Types
 
-  class Hash < NRSER::Types::Type
-    attr_reader :keys, :values, :including, :exactly, :min, :max
+  class HashType < IsA
+    attr_reader :keys, :values #, :including, :exactly, :min, :max
     
-    def initialize options = {}
+    def initialize  keys: NRSER::Types::ANY,
+                    values: NRSER::Types::ANY,
+                    **options
+      super ::Hash, **options
       
+      @keys = NRSER::Types.make keys
+      @values = NRSER::Types.make keys
+      
+    end
+    
+    def test value
+      return false unless super(value)
+      
+      if keys == NRSER::Types::ALL && values == NRSER::Types::ALL
+        return true
+      end
+      
+      value.all? { |k, v|
+        keys.test(k) && values.test(v)
+      }
     end
-  end # Hash
+  end # HashType
+  
+  HASH = HashType.new.freeze
+  
+  def self.hash_ *args
+    if args.empty?
+      HASH
+    else
+      HashType.new *args
+    end
+  end
+  
+  singleton_class.send :alias_method, :dict, :hash_
 end

data/lib/nrser/types/symbol.rb

@@ -0,0 +1,23 @@
+require 'nrser/refinements'
+require 'nrser/types/is'
+require 'nrser/types/is_a'
+
+using NRSER
+  
+module NRSER::Types
+  SYM = IsA.new Symbol, name: 'Sym', from_s: ->(s) { s.to_sym }
+  
+  def self.sym **options
+    if options.empty?
+      # if there are no options can point to the constant for efficiency
+      SYM
+    else
+      raise "Not Implemented"
+    end
+  end # string
+  
+  def self.symbol *args
+    sym *args
+  end
+  
+end # NRSER::Types

data/lib/nrser/types.rb

@@ -72,4 +72,6 @@ require 'nrser/types/any'
 require 'nrser/types/booleans'
 require 'nrser/types/numbers'
 require 'nrser/types/strings'
-require 'nrser/types/array'
+require 'nrser/types/symbol'
+require 'nrser/types/array'
+require 'nrser/types/hash'

data/lib/nrser/version.rb

@@ -1,3 +1,3 @@
 module NRSER
-  VERSION = "0.0.18"
+  VERSION = "0.0.19"
 end

data/lib/nrser.rb

@@ -1,122 +1,14 @@
+module NRSER; end
+
 require_relative './nrser/version'
+require_relative './nrser/no_arg'
 require_relative './nrser/collection'
 require_relative './nrser/truthy'
-
-module NRSER
-  class << self
-    
-    # turn a multi-line string into a single line, collapsing whitespace
-    # to a single space.
-    # 
-    # same as ActiveSupport's String.squish, adapted from there.
-    def squish str
-      str.gsub(/[[:space:]]+/, ' ').strip
-    end # squish
-
-    alias_method :unblock, :squish
-
-    def common_prefix strings
-      raise ArgumentError.new("argument can't be empty") if strings.empty?
-      sorted = strings.sort.reject {|line| line == "\n"}
-      i = 0
-      while sorted.first[i] == sorted.last[i] &&
-            i < [sorted.first.length, sorted.last.length].min
-        i = i + 1
-      end
-      strings.first[0...i]
-    end # common_prefix
-
-    def dedent str
-      return str if str.empty?
-      lines = str.lines
-      indent = common_prefix(lines).match(/^\s*/)[0]
-      return str if indent.empty?
-      lines.map {|line|
-        line = line[indent.length..line.length] if line.start_with? indent
-      }.join
-    end # dedent
-
-    def filter_repeated_blank_lines str
-      out = []
-      lines = str.lines
-      skipping = false
-      str.lines.each do |line|
-        if line =~ /^\s*$/
-          unless skipping
-            out << line
-          end
-          skipping = true
-        else
-          skipping = false
-          out << line
-        end
-      end
-      out.join
-    end # filter_repeated_blank_lines
-
-    def erb bnd, str
-      require 'erb'
-      filter_repeated_blank_lines ERB.new(dedent(str)).result(bnd)
-    end # erb
-
-    alias_method :template, :erb
-
-    def format_exception e
-      "#{ e.message } (#{ e.class }):\n  #{ e.backtrace.join("\n  ") }"
-    end
-
-    # adapted from acrive_support 4.2.0
-    # 
-    # <https://github.com/rails/rails/blob/7847a19f476fb9bee287681586d872ea43785e53/activesupport/lib/active_support/core_ext/string/indent.rb>
-    #
-    def indent str, amount = 2, indent_string=nil, indent_empty_lines=false
-      indent_string = indent_string || str[/^[ \t]/] || ' '
-      re = indent_empty_lines ? /^/ : /^(?!$)/
-      str.gsub(re, indent_string * amount)
-    end
-
-    # Truncates a given +text+ after a given <tt>length</tt> if +text+ is longer than <tt>length</tt>:
-    #
-    #   'Once upon a time in a world far far away'.truncate(27)
-    #   # => "Once upon a time in a wo..."
-    #
-    # Pass a string or regexp <tt>:separator</tt> to truncate +text+ at a natural break:
-    #
-    #   'Once upon a time in a world far far away'.truncate(27, separator: ' ')
-    #   # => "Once upon a time in a..."
-    #
-    #   'Once upon a time in a world far far away'.truncate(27, separator: /\s/)
-    #   # => "Once upon a time in a..."
-    #
-    # The last characters will be replaced with the <tt>:omission</tt> string (defaults to "...")
-    # for a total length not exceeding <tt>length</tt>:
-    #
-    #   'And they found that many people were sleeping better.'.truncate(25, omission: '... (continued)')
-    #   # => "And they f... (continued)"
-    # 
-    # adapted from 
-    # 
-    # <https://github.com/rails/rails/blob/7847a19f476fb9bee287681586d872ea43785e53/activesupport/lib/active_support/core_ext/string/filters.rb#L46>
-    # 
-    def truncate(str, truncate_at, options = {})
-      return str.dup unless str.length > truncate_at
-
-      omission = options[:omission] || '...'
-      length_with_room_for_omission = truncate_at - omission.length
-      stop = \
-        if options[:separator]
-          str.rindex(options[:separator], length_with_room_for_omission) || length_with_room_for_omission
-        else
-          length_with_room_for_omission
-        end
-
-      "#{str[0, stop]}#{omission}"
-    end
-
-  end # class << self
-end
-
+require_relative './nrser/string'
+require_relative './nrser/binding'
+require_relative './nrser/exception'
 require_relative './nrser/enumerable'
 require_relative './nrser/hash'
 require_relative './nrser/array'
-require_relative "./nrser/types"
+require_relative './nrser/types'
+require_relative './nrser/meta'

data/spec/nrser/meta/class_attrs_spec.rb

@@ -0,0 +1,241 @@
+require 'spec_helper'
+
+describe NRSER::Meta::ClassAttrs do
+  # I'm writing this as I'm developing the module, so I'm going to walk through
+  # some of the motivation, features and differences from other approaches
+  # as notes to self/others...
+  # 
+  
+  
+  # Setup
+  # =====================================================================
+  # 
+  # Because any changes would global and RSpec seems to do things some-what
+  # asynchronously we need to use dynamic class creation, which is sub-optimal
+  # because it has subtle difference with normal definitions (@@ variable
+  # declaration being the major one I've hit do far), but it seems like the 
+  # most reasonable way to go about it at the moment.
+  # 
+  
+  let (:base) {
+    Class.new do
+      include NRSER::Meta::ClassAttrs
+      
+      # To compare, I'll also work with standard '@@' class variables and 
+      # an standard attr_accessors added to the classes themselves.
+      
+      # Normally this would be
+      # 
+      # @@base_class_var = :base_class_var_value
+      # 
+      # but that is different for dynamic classes, to we use
+      class_variable_set :@@base_class_var, :base_class_var_value
+      
+      class << self
+        attr_accessor :base_self_attr_accessor
+      end
+      
+      # Set the self attr_accessor value
+      self.base_self_attr_accessor = :base_self_attr_accessor_value
+      
+      # And now some variables using the mixin.
+      
+      # I won't ever set this
+      class_attr_accessor :never_set
+      
+      # I'll define this here, but won't set it from base 
+      class_attr_accessor :def_in_base
+      
+      # These will be set from here
+      class_attr_accessor :set_in_base_1
+      class_attr_accessor :set_in_base_2
+      
+      # There are two ways of setting values:
+      # 
+      # 1.  self assignment:
+      
+      self.set_in_base_1 = :set_in_base_1_value
+      
+      #     Not that `x = value` will not work - the `self` is required.
+      #     I haven't found any way to get `x = value` to trigger the setter
+      #     methods.
+      #     
+      # 2.  "DSL-style":
+      
+      set_in_base_2 :set_in_base_2_value
+      
+      #     This is the style i started with, because it made it really easy
+      #     to have nice-feeling DSL-like functionality with minimal work.
+      #     
+      #     I'm unsure at the moment if it's something I want to keep (probably),
+      #     and if so if it should be optional via a flag on
+      #     `class_attr_accessor` (seems like a good idea).
+      #     
+      #     It's "nice", but it's perhaps kind-of counter-intuitive in the Ruby
+      #     world?
+      # 
+      
+    end
+  }
+  
+  let(:child_1) {
+    Class.new(base) do
+    end
+  }
+  
+  let(:child_1_1) {
+    Class.new(child_1) do
+    end
+  }
+  
+  let(:child_2) {  
+    Class.new(base) do
+    end
+  }
+  
+  let(:child_2_1) {
+    Class.new(child_2) do
+    end
+  }
+  
+  
+  # Tests
+  # =====================================================================
+  
+  describe "Class (@@) Variables and Their Problems" do
+  # ---------------------------------------------------------------------
+  # 
+  # Examples of the desired features that work (OK examples) and those that
+  # don't (PROBLEM! examples) for class (@@) variables.
+  # 
+  
+    it "can access @@ variables from base and any subclass (OK)" do    
+      [base, child_1, child_1_1, child_2, child_2_1].each do |klass|
+        expect(
+          klass.class_variable_get :@@base_class_var
+        ).to be :base_class_var_value
+      end
+    end
+    
+    
+    context "@@ variable changed in base" do
+      let(:new_value) { :new_base_class_var_value }
+      
+      before {
+        base.class_variable_set :@@base_class_var, new_value
+      }
+      
+      it "can access new value from base and any subclass (OK)" do    
+        [base, child_1, child_1_1, child_2, child_2_1].each do |klass|
+          expect(
+            klass.class_variable_get :@@base_class_var
+          ).to be new_value
+        end
+      end
+    end # @@ variable changed in base
+    
+    
+    context "@@ variable changed in subclass" do
+      let(:new_value) { :new_child_1_class_var_value }
+      
+      before {
+        child_1.class_variable_set :@@base_class_var, new_value
+      }
+      
+      # This is the problem: changes to the value anywhere in the hierarchy 
+      # are global to the hierarchy 
+      it "reads that value from all classes (PROBLEM!)" do    
+        [base, child_1, child_1_1, child_2, child_2_1].each do |klass|
+          expect(
+            klass.class_variable_get :@@base_class_var
+          ).to be new_value
+        end
+      end
+    end # @@ variable changed in base
+    
+  end # Class (@@) Variables and Their Problems
+  
+  
+  describe "Class 'Self' attr_accessor and Their Problems" do
+  # ---------------------------------------------------------------------
+    
+    it "can access from base (OK)" do
+      expect(base.base_self_attr_accessor).to be :base_self_attr_accessor_value
+    end
+    
+    it "can't access from any subclasses (PROBLEM!)" do
+      [child_1, child_1_1, child_2, child_2_1].each do |klass|
+        expect(klass.base_self_attr_accessor).to be nil
+      end
+    end
+    
+  end # Class 'Self' Attribute Accessors and Their Problems
+  
+  
+  
+  describe "NRSER::ClassAttrs Solution" do
+  # ---------------------------------------------------------------------
+  # 
+  # Examples of the desired features that work (OK examples) and those that
+  # don't (PROBLEM! examples) for class 'self' attr_accessor.
+  # 
+  
+    it "raises NoMethodError when accessing unset class attrs" do
+      expect { base.never_set }.to raise_error NoMethodError
+      expect { base.def_in_base }.to raise_error NoMethodError
+    end
+    
+    
+    it "reads values set in base from base and any subclass" do
+      [base, child_1, child_1_1, child_2, child_2_1].each do |klass|
+        expect(klass.set_in_base_1).to be :set_in_base_1_value
+        expect(klass.set_in_base_2).to be :set_in_base_2_value
+      end
+    end
+    
+    
+    context "class_attr_accessor value changed in base" do
+      # With class_attr_accessor, the new value will be visible to base and
+      # all subclasses.
+      
+      let(:new_value) { :new_set_in_base_1_value }
+      
+      before {
+        base.set_in_base_1 = new_value
+      }
+      
+      it "can access new value from base and any subclass" do    
+        [base, child_1, child_1_1, child_2, child_2_1].each do |klass|
+          expect(klass.set_in_base_1).to be new_value
+        end
+      end
+    end # class_attr_accessor value changed in base
+    
+    
+    context "class_attr_accessor value changed in subclass" do
+      # With class_attr_accessor, the new value will be visible to the class
+      # it is set in and any subclasses without affecting any others.
+      
+      let(:new_value) { :set_in_child_1 }
+      
+      before {
+        child_1.set_in_base_1 = new_value
+      }
+      
+      it "reads the new value from that class and any subclasses" do    
+        [child_1, child_1_1].each do |klass|
+          expect(klass.set_in_base_1).to be new_value
+        end
+      end
+      
+      it "reads the old value from any other classes" do    
+        [base, child_2, child_2_1].each do |klass|
+          expect(klass.set_in_base_1).to be :set_in_base_1_value
+        end
+      end
+      
+    end # class_attr_accessor value changed in subclass
+    
+  end # NRSER::ClassAttrs Solution
+  
+end # NRSER::ClassAttrs

data/spec/nrser/meta/props_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+T = NRSER::Types
+
+describe NRSER::Meta::Props do
+  
+  # Setup
+  # =====================================================================
+  
+  let(:point) {
+    Class.new(NRSER::Meta::Props::Base) do
+      # include NRSER::Meta::Props
+      
+      prop :x, type: T.int
+      prop :y, type: T.int
+      prop :blah, type: T.str, source: :blah
+      
+      def blah
+        "blah!"
+      end
+    end
+  }
+  
+  it "has the props" do
+    props = point.props
+    
+    expect(props).to be_a Hash
+    
+    [:x, :y, :blah].each do |name|
+      expect(props[name]).to be_a NRSER::Meta::Props::Prop
+    end
+    
+    [:x, :y].each do |name|
+      expect(props[name].source?).to be false
+      expect(props[name].primary?).to be true
+    end
+    
+    expect(props[:blah].source?).to be true
+    expect(props[:blah].primary?).to be false
+    
+    primary_props = point.props primary: true
+    
+    expect(primary_props.key? :blah).to be false
+    
+    p = point.new x: 1, y: 2
+    
+    expect(p.x).to be 1
+    expect(p.y).to be 2
+    
+    expect(p.to_h).to eq({x: 1, y: 2, blah: "blah!"})
+    expect(p.to_h(primary: true)).to eq({x: 1, y: 2})
+    
+    expect { point.new x: 1, y: 'why?' }.to raise_error TypeError
+    expect { p.x = 3 }.to raise_error NoMethodError
+    
+    p_hash = p.to_h
+    
+    p2 = point.from_h p_hash
+    
+    expect(p2.x).to be 1
+    expect(p2.y).to be 2
+    
+    expect(p2.to_h).to eq({x: 1, y: 2, blah: "blah!"})
+  end
+  
+end # NRSER::Meta::Props
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nrser
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,16 +91,27 @@ files:
 - README.md
 - lib/nrser.rb
 - lib/nrser/array.rb
+- lib/nrser/binding.rb
 - lib/nrser/collection.rb
 - lib/nrser/enumerable.rb
+- lib/nrser/exception.rb
 - lib/nrser/hash.rb
 - lib/nrser/logger.rb
+- lib/nrser/meta.rb
+- lib/nrser/meta/class_attrs.rb
+- lib/nrser/meta/props.rb
+- lib/nrser/meta/props/base.rb
+- lib/nrser/no_arg.rb
 - lib/nrser/refinements.rb
 - lib/nrser/refinements/array.rb
+- lib/nrser/refinements/binding.rb
+- lib/nrser/refinements/exception.rb
 - lib/nrser/refinements/hash.rb
 - lib/nrser/refinements/object.rb
 - lib/nrser/refinements/pathname.rb
 - lib/nrser/refinements/string.rb
+- lib/nrser/refinements/types.rb
+- lib/nrser/string.rb
 - lib/nrser/truthy.rb
 - lib/nrser/types.rb
 - lib/nrser/types/any.rb
@@ -115,6 +126,7 @@ files:
 - lib/nrser/types/maybe.rb
 - lib/nrser/types/numbers.rb
 - lib/nrser/types/strings.rb
+- lib/nrser/types/symbol.rb
 - lib/nrser/types/type.rb
 - lib/nrser/types/where.rb
 - lib/nrser/version.rb
@@ -133,6 +145,8 @@ files:
 - spec/nrser/logger/level_sym_spec.rb
 - spec/nrser/logger/send_log_spec.rb
 - spec/nrser/logger/use_spec.rb
+- spec/nrser/meta/class_attrs_spec.rb
+- spec/nrser/meta/props_spec.rb
 - spec/nrser/refinements/array_spec.rb
 - spec/nrser/refinements/erb_spec.rb
 - spec/nrser/refinements/format_exception_spec.rb
@@ -189,6 +203,8 @@ test_files:
 - spec/nrser/logger/level_sym_spec.rb
 - spec/nrser/logger/send_log_spec.rb
 - spec/nrser/logger/use_spec.rb
+- spec/nrser/meta/class_attrs_spec.rb
+- spec/nrser/meta/props_spec.rb
 - spec/nrser/refinements/array_spec.rb
 - spec/nrser/refinements/erb_spec.rb
 - spec/nrser/refinements/format_exception_spec.rb