cardname 0.15.6 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c51eae71caf9ca4814d780b17f04cb94d4440c149d284615d6e19e8c6c38735f
-  data.tar.gz: 3bcf4b4ef3066dde10e66a659aa35c712200c3b1f4fb9f532984cce48d3358ec
+  metadata.gz: bfc02976284123b5cc7f7ecf02a312f506b617c0251521076c1f0c37ae12c9ff
+  data.tar.gz: 4a55923060dd3d7ef7c76535f76387701d41671e71df9169f4cbdf6f5ffcb900
 SHA512:
-  metadata.gz: eac0575f5b9c304ca89a5d5db2ac57fcdf3a0a251ab7306dc89547995edbeb2f8b56c785470fdf15f01a15762db0b781f1b388bbd8855741699c509315dcbbde
-  data.tar.gz: 032c0de18fca7546c980fc8a5df64ca13d53da5fb9819f84c1687f3077d9ce11d15fb224702c63e8e23d079e86935a0128d12d858d7ed2385c3af1faca392f47
+  metadata.gz: 40733a02910a2178c5192279f158d504654a5c1c1e7b241214dcbe63e3156b7e7d5f231c1a101b82875f3e2c5998019a3e45121b0e49763c160c95c5d15459f3
+  data.tar.gz: ad9350d7dc0e8f0ceec60471ae5a14bf6f04a729b0dc3e54eaf792d3a7200bd60ad73aa252a743dd9ded743120be63645ec9c4815df97d23bdb0af6b162e27a7

data/lib/cardname/contextual.rb

@@ -3,7 +3,8 @@ class Cardname
   module Contextual
     RELATIVE_REGEXP = /\b_(left|right|whole|self|user|main|\d+|L*R?)\b/
 
-    # @return [Boolean] true if name is left or right of context
+    # true if name is left or right of context
+    # @return [Boolean]
     def child_of? context
       return false unless compound?
 
@@ -28,18 +29,7 @@ class Cardname
       !relative?
     end
 
-    # contextual elements removed
     # @return [String]
-    def stripped
-      s.gsub RELATIVE_REGEXP, ""
-    end
-
-    # +X
-    # @return [Boolean]
-    def starts_with_joint?
-      compound? && parts.first.empty?
-    end
-
     def from *from
       name_from(*from).s
     end
@@ -47,6 +37,7 @@ class Cardname
     # if possible, relativize name into one beginning with a "+".
     # The new name must absolutize back to the correct
     # original name in the context of "from"
+    # @return [Cardname]
     def name_from *from
       return self unless (remaining = remove_context(*from))
 
@@ -54,6 +45,7 @@ class Cardname
       key == compressed.absolute_name(from).key ? compressed : self
     end
 
+    # interpret contextual name
     # @return [String]
     def absolute context
       context = (context || "").to_name
@@ -65,8 +57,8 @@ class Cardname
     end
 
     # @return [Cardname]
-    def absolute_name *args
-      absolute(*args).to_name
+    def absolute_name context
+      absolute(context).to_name
     end
 
     # 1 = left; 2= left of left; 3 = left of left of left....

data/lib/cardname/fields.rb

@@ -2,18 +2,22 @@ class Cardname
   # Name-based "Fields" are compound names in which the right name is treated
   # as an attribute of the left.  (Eg MyName+address is a field of MyName)
   module Fields
+    # @example
+    #   "A".cardname.field_name "B" -> "A+B"
     # @return [String]
     def field tag_name
       field_name(tag_name).s
     end
 
-    # @return [Card::Name]
+    # @example
+    #   "A".cardname.field_name "B" -> "A+B"
+    # @return [Cardname]
     def field_name tag
       tag = tag.to_s[1..-1] if !tag.is_a?(Symbol) && tag.to_s[0] == "+"
       [self, tag].to_name
     end
 
-    # @return [True/False]
+    # @return [Boolean]
     def field_of? context
       return false unless compound?
 
@@ -25,9 +29,9 @@ class Cardname
     end
 
     # name is relative name containing only the rightmost part
-    # @return [True/False]
+    # @return [Boolean]
     def field_only?
-      relative? && stripped.to_name.parts.reject(&:blank?).first == parts.last
+      relative? && stripped.parts.reject(&:blank?).first == parts.last
     end
 
     def relative_field_name tag_name

data/lib/cardname/predicates.rb

@@ -1,18 +1,21 @@
 class Cardname
   # name methods returning true/false
   module Predicates
-    # @return [Boolean] true if name has only one part
+    # true if name has only one part
+    # @return [Boolean]
     def simple?
       part_names if @simple.nil?
       @simple
     end
 
-    # @return [Boolean] true if name has more than one part
+    # true if name has more than one part
+    # @return [Boolean]
     def compound?
       !simple?
     end
 
-    # @return [Boolean] true unless name contains banned characters
+    # true unless name contains banned characters
+    # @return [Boolean]
     def valid?
       return true if self.class.nothing_banned?
 
@@ -21,21 +24,30 @@ class Cardname
       end
     end
 
-    # @return [Boolean] true if name starts with the same parts as `prefix`
+    # +X
+    # @return [Boolean]
+    def starts_with_joint?
+      compound? && parts.first.empty?
+    end
+
+    # true if name starts with the same parts as `prefix`
+    # @return [Boolean]
     def starts_with_parts? *prefix
       start_name = prefix.to_name
       start_name == self[0, start_name.num_parts]
     end
     alias_method :start_with_parts?, :starts_with_parts?
 
-    # @return [Boolean] true if name ends with the same parts as `prefix`
+    # true if name ends with the same parts as `prefix`
+    # @return [Boolean]
     def ends_with_parts? *suffix
       end_name = suffix.to_name
       end_name == self[-end_name.num_parts..-1]
     end
     alias_method :end_with_parts?, :ends_with_parts?
 
-    # @return [Boolean] true if name has a chain of parts that equals `subname`
+    # true if name has a chain of parts that equals `subname`
+    # @return [Boolean]
     def include? subname
       subkey = subname.to_name.key
       key =~ /(^|#{JOINT_RE})#{Regexp.quote subkey}($|#{JOINT_RE})/

data/lib/cardname/variants.rb

@@ -2,19 +2,6 @@ require "htmlentities"
 
 class Cardname
   module Variants
-    # @return [String]
-    def simple_key
-      return "" if empty?
-
-      decoded
-        .underscore
-        .gsub(/[^#{OK4KEY_RE}]+/, "_")
-        .split(/_+/)
-        .reject(&:empty?)
-        .map { |key| stable_key(key) }
-        .join("_")
-    end
-
     # URI-friendly version of name. retains case, underscores for space
     # @return [String]
     def url_key
@@ -32,11 +19,22 @@ class Cardname
       key.tr("*", "X").tr self.class.joint, "-"
     end
 
+    # HTML Entities decoded
     # @return [String]
     def decoded
       @decoded ||= s.index("&") ? HTMLEntities.new.decode(s) : s
     end
 
+    # contextual elements removed
+    # @return [String]
+    def stripped
+      s.gsub(Contextual::RELATIVE_REGEXP, "").to_name
+    end
+
+    def fully_stripped
+      stripped.parts.reject(&:blank?).cardname
+    end
+
     private
 
     def uninflect_method

data/lib/cardname.rb

@@ -103,4 +103,17 @@ class Cardname < String
   def generate_key
     @simple ? simple_key : part_keys.join(self.class.joint)
   end
+
+  # @return [String]
+  def simple_key
+    return "" if empty?
+
+    decoded
+      .underscore
+      .gsub(/[^#{OK4KEY_RE}]+/, "_")
+      .split(/_+/)
+      .reject(&:empty?)
+      .map { |key| stable_key(key) }
+      .join("_")
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cardname
 version: !ruby/object:Gem::Version
-  version: 0.15.6
+  version: 0.16.0
 platform: ruby
 authors:
 - Ethan McCutchen
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Card names without all the cards