nrser 0.1.4 → 0.2.0.pre.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10930bb8b3998cc81f95333c8eb86a102262d84e
-  data.tar.gz: ff5057aead5992fe1d053e814afd120278b80a4c
+  metadata.gz: b51533291e377070a1f4cac954fc49eee602d178
+  data.tar.gz: 57c89f078878e050a01dfd8a1b1c00a345de7cb5
 SHA512:
-  metadata.gz: f64f47ddbbb195eb13f072aec1f0beb8ff8299dbf9bc40838a2dcb078fd401fc03509c6566f497041ca0b3d5fc95f4b0baee0e7cb390e7238182a0e14e51ee50
-  data.tar.gz: ba2da8fe57e5d3e9f2c1439fa978957327982624c1a536b1bbf950901783d66808c44042d0f01f4ce7c8ec4333a93fb29904878c3165bc010dd099eddd864265
+  metadata.gz: 6305b4adf84631b859377ed9c30d065b617b157299c066a0f8333f9133d979ccf37424cdc16ce3c6cef0219a95e769294cd19148b299f48358bb7934715b7003
+  data.tar.gz: 5cbf8bb41e319263a4eda303cdf0651080f628a566f723ca185136b198b3089e89b74b22b3b46f815b553ecb0a770eb48b28c09f935148dde7bd0338dc4201e6

data/lib/nrser.rb

@@ -77,3 +77,6 @@ require_relative './nrser/functions'
 require_relative './nrser/types'
 require_relative './nrser/meta'
 require_relative './nrser/mean_streak'
+
+# 5.  Stuff that *uses* the refinements *at require time* (usually defining
+#     constants or meta-programming)

data/lib/nrser/char.rb

@@ -18,6 +18,7 @@ module NRSER::Char; end
 # ============================================================================
 
 require_relative './char/special'
+require_relative './char/alpha_numeric_sub'
 
 
 # Definitions
@@ -141,9 +142,7 @@ module NRSER::Char
       from_i source
     else
       raise ArgumentError.new binding.erb <<-END
-        Expected hex String like '12AB' or Integer, got <%= source.class %>
-        
-        Found:
+        Expected hex String like '12AB' or Integer, got <%= source.class %>:
         
             <%= source.pretty_inspect %>
         

data/lib/nrser/char/alpha_numeric_sub.rb

@@ -0,0 +1,233 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+
+
+# Refinements
+# =======================================================================
+
+using NRSER
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+# Lil' structure with useful info and methods for special characters.
+# 
+class NRSER::Char::AlphaNumericSub
+
+  # Attributes
+  # ======================================================================
+  
+  # The `a` character (as a length 1 {String}), the `#ord` of which is used
+  # to determine the target `#ord` of lower-case alpha (`a-z`) characters for
+  # substitution.
+  # 
+  # @return [String]
+  #   When the sub supports lower-case alpha substitution.
+  # 
+  # @return [nil]
+  #   When the sub does not support lower-case alpha substitution.
+  #     
+  attr_reader :sub_a
+  
+  
+  # The `A` character (as a length 1 {String}), the `#ord` of which is used
+  # to determine the target `#ord` upper-case alpha (`A-Z`) characters for
+  # substitution.
+  # 
+  # @return [String]
+  #   When the sub supports upper-case alpha substitution.
+  # 
+  # @return [nil]
+  #   When the sub does not support upper-case alpha substitution.
+  #     
+  attr_reader :sub_A
+  
+  
+  # The target set's `0` character (as a length 1 {String}), the `#ord` of
+  # which is used to determine the target `#ord` of numeric `0-9` characters
+  # for substitution.
+  # 
+  # @return [String]
+  #   When the sub supports numeric substitution.
+  # 
+  # @return [nil]
+  #   When the sub does not support numeric substitution.
+  #     
+  attr_reader :sub_0
+  
+  
+  # Map of source character to dest character substitutions to handle cases
+  # where a few of the destination alpha-numerics don't follow the "offest
+  # from `a`/`A`/`0`" rule.
+  # 
+  # @return [Hash<String, String>]
+  #   All length 1 UTF-8 strings. Deeply frozen.
+  #     
+  attr_reader :exceptions
+  
+  
+  # Class Methods
+  # ============================================================================
+  
+  # @!group On-Demand Built-In Instances (Class Methods)
+  # ----------------------------------------------------------------------------
+  # 
+  # Class functions that create "built-in" instances on demand. Doing it like
+  # this side-steps load-order issues with using the refinements.
+  # 
+  
+  # Instance to substitute alphas with their "Unicode Math Italic"
+  # counterpart.
+  # 
+  # @return [NRSER::Char::AlphaNumericSub]
+  # 
+  def self.unicode_math_italic
+    @@unicode_math_italic ||= new \
+     sub_a: '𝑎',
+     sub_A: '𝐴',
+     # Doesn't have italic numbers to just don't sub
+     exceptions: {
+       # The `h` is not in the run
+       'h' => 'ℎ'
+     }
+  end # .unicode_math_italic
+  
+  
+  # Instance to substitute alphas with their "Unicode Math Bold"
+  # counterpart.
+  # 
+  # @return [NRSER::Char::AlphaNumericSub]
+  # 
+  def self.unicode_math_bold
+    @@unicode_math_italic ||= new \
+     sub_a: '𝐚',
+     sub_A: '𝐀',
+     sub_0: '𝟬'
+  end # .unicode_math_italic
+  
+  
+  # Instance to substitute alphas with their "Unicode Math Bold Italic"
+  # counterpart.
+  # 
+  # @return [NRSER::Char::AlphaNumericSub]
+  # 
+  def self.unicode_math_bold_italic
+    @@unicode_math_italic ||= new \
+     sub_A: '𝑨',
+     sub_a: '𝒂',
+     # Just use the bold numbers since Unicode doesn't seem to have
+     # italic numbers
+     sub_0: '𝟬'
+  end # .unicode_math_italic
+  
+  
+  # Instance to substitute alphas with their "Unicode Math Bold Italic"
+  # counterpart.
+  # 
+  # @return [NRSER::Char::AlphaNumericSub]
+  # 
+  def self.unicode_math_monospace
+    @@unicode_math_italic ||= new \
+     sub_A: '𝙰',
+     sub_a: '𝚊',
+     sub_0: '𝟶'
+  end # .unicode_math_italic
+  
+  # @!endgroup On-Demand Built-In Instances (Class Methods)
+  
+  
+  # Constructor
+  # ======================================================================
+  
+  # Instantiate a new `Special`.
+  # 
+  # @param [String] char:
+  #   The actual character as a length 1 UTF-8 string.
+  # 
+  # @param [nil | String] caret:
+  #   Optional `^X` replacement for control characters, see {#caret} for
+  #   details.
+  # 
+  # @param [Array<#to_s>] names:
+  #   Optional names this character goes by.
+  # 
+  # @param [nil | String] symbol:
+  #   Optional printable unicode character replacement, see {#symbol} for
+  #   details.
+  # 
+  def initialize  sub_a: nil,
+                  sub_A: nil,
+                  sub_0: nil,
+                  exceptions: nil
+    binding.locals.tap do |args|
+      t.list( t.utf8_char? ).check \
+        args.slice( :sub_a, :sub_A, :sub_0 ).values
+      
+      t.hash_?( keys: t.utf8_char, values: t.utf8_char ).check exceptions
+      
+      if args.all?( &:nil? )
+        raise ArgumentError.new,
+          "All arguments can't be `nil` (sub couldn't do anything)"
+      end
+    end
+    
+    @sub_a = sub_a.freeze
+    @sub_A = sub_A.freeze
+    @sub_0 = sub_0.freeze
+    @exceptions = if exceptions
+      exceptions.each { |k, v| k.freeze; v.freeze }.freeze
+    end
+  end # #initialize
+  
+  
+  # Instance Methods
+  # ======================================================================
+  
+  # The first of {#names} (if any).
+  # 
+  # @return [nil]
+  #   When {#names} is empty.
+  # 
+  # @return [String]
+  #   When {#names} is not empty.
+  # 
+  def sub src
+    dest = src.dup
+    
+    if @exceptions
+      @exceptions.each do |src_char, dest_char|
+        dest.gsub! src_char, dest_char
+      end
+    end
+    
+    [
+      ['a', /[a-z]/],
+      ['A', /[A-Z]/],
+      ['0', /[0-9]/],
+    ].each do |src_char, regexp|
+      src_char_ord = src_char.ord
+      start_dest_char = instance_variable_get "@sub_#{ src_char }"
+      
+      unless start_dest_char.nil?
+        start_dest_char_ord = start_dest_char.ord
+        
+        dest.gsub!( regexp ) { |char|
+          NRSER::Char.from_i(
+            start_dest_char_ord + (char.ord - src_char_ord)
+          )
+        }
+      end
+    end
+    
+    dest
+  end
+  
+  
+  def demo
+    sub ['a'..'z', 'A'..'Z', '0'..'9'].map { |_| _.to_a.join }.join
+  end
+  
+end # class NRSER::Char::Special

data/lib/nrser/ext.rb

@@ -4,3 +4,4 @@ require_relative './ext/enumerable'
 require_relative './ext/tree'
 require_relative './ext/pathname'
 require_relative './ext/string'
+require_relative './ext/binding'

data/lib/nrser/ext/binding.rb

@@ -0,0 +1,36 @@
+# Extension methods for {Binding}
+# 
+module NRSER::Ext::Binding
+  
+  # Calls {NRSER.template} with `self` prepended to `*args`
+  # 
+  # @param (see NRSER.erb)
+  # @return (see NRSER.erb)
+  # 
+  def template *args
+    NRSER.template self, *args
+  end
+  
+  alias_method :erb, :template
+  
+  
+  # Calls {NRSER.locals} with `self` prepended to `*args`
+  # 
+  # @param (see NRSER.locals)
+  # @return (see NRSER.locals)
+  # 
+  def locals *args
+    NRSER.locals self, *args
+  end
+  
+  
+  # Calls {NRSER.local_values} with `self` prepended to `*args`
+  # 
+  # @param (see NRSER.local_values)
+  # @return (see NRSER.local_values)
+  # 
+  def local_values *args
+    NRSER.local_values self, *args
+  end
+  
+end # module NRSER::Ext::Binding

data/lib/nrser/ext/string.rb

@@ -59,4 +59,33 @@ module NRSER::Ext::String
     NRSER::words self, *args, &block
   end
   
+  
+  # @!group Unicode Stylization
+  # ==========================================================================
+  
+  # Calls {NRSER.u_italic} on `self`
+  def u_italic
+    NRSER.u_italic self
+  end
+  
+  
+  # Calls {NRSER.u_bold} on `self`
+  def u_bold
+    NRSER.u_bold self
+  end
+  
+  
+  # Calls {NRSER.u_bold_italic} on `self`
+  def u_bold_italic
+    NRSER.u_bold_italic self
+  end
+  
+  
+  # Calls {NRSER.u_mono} on `self`
+  def u_mono
+    NRSER.u_mono self
+  end
+  
+  # @!endgroup Unicode Stylization
+  
 end # module NRSER::Ext::String

data/lib/nrser/functions/binding.rb

@@ -1,18 +1,43 @@
 module NRSER
-  class << self
-
-    def erb bnd, str
-      require 'erb'
-      
-      filter_repeated_blank_lines(
-        with_indent_tagged( dedent( str ) ) { |tagged_str|
-          ERB.new( tagged_str ).result( bnd )
-        },
-        remove_leading: true
-      )
-    end # erb
-
-    alias_method :template, :erb
+  def self.erb bnd, str
+    require 'erb'
     
-  end # class << self
+    filter_repeated_blank_lines(
+      with_indent_tagged( dedent( str ) ) { |tagged_str|
+        ERB.new( tagged_str ).result( bnd )
+      },
+      remove_leading: true
+    )
+  end # erb
+  
+  singleton_class.send :alias_method, :template, :erb
+  
+  
+  # Get a {Hash} of all local variable names (as {Symbol}) to values.
+  # 
+  # @param [Binding] bnd
+  #   Binding to get locals from.
+  # 
+  # @return [Hash<Symbol, Object>]
+  # 
+  def self.locals bnd
+    NRSER.map_values( bnd.local_variables ) { |symbol, _|
+      bnd.local_variable_get symbol
+    }
+  end # .locals
+  
+  
+  # Get a {Array} of all local variable values.
+  # 
+  # Written to facilitate checks like "all argument values are not `nil`".
+  # 
+  # @param [Binding] bnd
+  #   Binding to get locals from.
+  # 
+  # @return [Array<Object>]
+  # 
+  def self.local_values bnd
+    bnd.local_variables.map { |symbol| bnd.local_variable_get symbol }
+  end # .locals
+  
 end # module NRSER

data/lib/nrser/functions/string.rb

@@ -1,16 +1,30 @@
 # frozen_string_literal: true
 
 require_relative './string/looks_like'
+require_relative './string/style'
 
 module NRSER
   
-  # @!group String Functions
+  # Constants
+  # ==========================================================================
   
+  # Regular expression used to match whitespace.
+  # 
+  # @return [Regexp]
+  # 
   WHITESPACE_RE = /\A[[:space:]]*\z/
   
+  
+  # Unicode ellipsis character.
+  # 
+  # @return [String]
+  # 
   UNICODE_ELLIPSIS = '…'
   
   
+  # @!group String Functions
+  # ==========================================================================
+  
   def self.whitespace? string
     string =~ WHITESPACE_RE
   end
@@ -311,4 +325,6 @@ module NRSER
   
   singleton_class.send :alias_method, :to_const, :constantize
   
+  # @!endgroup String Functions
+  
 end # module NRSER