cardname 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eccd39597d09bf9378cb085a18c37427f48c55997d4dd50c0d9d0d2bec80de11
-  data.tar.gz: ae0ba7ff34670d3ff231c37794b83cecdc04ff75601aeaa43af1a6ba60c1b58e
+  metadata.gz: d42f369012c637f78375a460e4814d841ed45fee9f4f3d7eb5f9dee84f725dd0
+  data.tar.gz: 5bbfbdfcaaf320fa1e0853e5ec781c54b38cd9a38e41bffdb12a52820fc768ed
 SHA512:
-  metadata.gz: ede5f7daeebd3e2ec114985adf6810a4e7778b1f61bbca4b6af397129a92fc4f1a737b9097e6da557b8297630b4a3d6eaa130d38fe5b09e63e2fec7b9e8d7191
-  data.tar.gz: 447d668197aeb81d58c44bbe9c43779eed643fe5728430603ed0ab2333903d2087309f866b2d5c8411aade0fdf2931b653a4d1c6042dde35bc4fb08e9c02868b
+  metadata.gz: a3376035abe1d69ed768e6f3eb040106a87985c6a20fb9dfb939d416589f804e6c820ff325e9e819ac43d3529513cdc6fd6a03e01fd50301c7b1d958a8ad4d2d
+  data.tar.gz: 0ec2da901b07b528bfe7ddaaecc50a4ff8e65533d4282e51f74e9595214ebfe012cccbdff2729d4b3fd0613f7fa24eac091b25444375745a038a93d6c8583c5a

data/lib/cardname/contextual.rb

@@ -34,7 +34,8 @@ class Cardname
       name_from(*from).s
     end
 
-    # if possible, relativize name into one beginning with a "+".  The new name must absolutize back to the correct
+    # 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"
     def name_from *from
       return self unless (remaining = remove_context(*from))

data/lib/cardname/manipulate.rb

@@ -38,6 +38,10 @@ class Cardname
       parts.length
     end
 
+    def [] *args
+      self.class.new part_names[*args]
+    end
+
     def prepend_joint
       joint = self.class.joint
       self =~ /^#{Regexp.escape joint}/ ? self : (joint + self)

data/lib/cardname/parts.rb

@@ -3,106 +3,92 @@ class Cardname
   # methods that end with _name return name objects
   # the same methods without _name return strings
   module Parts
-    attr_reader :parts, :part_keys, :simple
-    alias_method :to_a, :parts
+    # PARTS
+    def part_names
+      @part_names ||= generate_part_names
+    end
 
     def parts
-      @parts = Cardname.split_parts s
+      part_names.map(&:s)
     end
+    alias_method :to_a, :parts
 
     def part_keys
-      @part_keys ||= simple ? [simple_key] : parts.map { |p| p.to_name.simple_key }
+      part_names.map(&:key)
     end
 
-    def left
-      @left ||= simple? ? nil : parts[0..-2] * self.class.joint
-    end
-
-    def right
-      @right ||= simple? ? nil : parts[-1]
+    def trunk_name
+      simple? ? self : left_name
     end
 
-    def left_name
-      @left_name ||= left && self.class.new(left)
+    def trunk
+      trunk_name.s
     end
 
-    def right_name
-      @right_name ||= right && self.class.new(right)
+    def trunk_key
+      trunk_name.key
     end
 
-    def left_key
-      @left_key ||=  simple? ? nil : part_keys[0..-2] * self.class.joint
+    def tag_name
+      simple? ? self : right_name
     end
 
-    def right_key
-      @right_key ||= simple? ? nil : part_keys.last
+    def tag
+      tag_name.s
     end
 
-    def parents
-      @parents ||= compound? ? [left, right] : []
+    def tag_key
+      tag_name.key
     end
 
     def parent_names
-      @parent_names ||= compound? ? [left_name, right_name] : []
+      simple? ? [] : [left_name, right_name]
     end
 
-    def parent_keys
-      @parent_keys ||= compound? ? [left_key, right_key] : []
+    def parents
+      parent_names.map(&:s)
     end
 
-    # Note that all names have a trunk and tag,
-    # but only junctions have left and right
-
-    def trunk
-      @trunk ||= simple? ? s : left
+    def parent_keys
+      parent_names.map(&:key)
     end
 
-    def tag
-      @tag ||= simple? ? s : right
+    def left_name
+      simple? ? nil : self.class.new(part_names[0..-2])
     end
 
-    def trunk_name
-      @trunk_name ||= simple? ? self : left_name
+    def left
+      left_name&.s
     end
 
-    def tag_name
-      @tag_name ||= simple? ? self : right_name
+    def left_key
+      left_name&.key
     end
 
-    def part_names
-      @part_names ||= parts.map(&:to_name)
+    def right_name
+      simple? ? nil : part_names[-1]
     end
 
-    def piece_names
-      @piece_names ||= pieces.map(&:to_name)
+    def right
+      right_name&.s
     end
 
-    def ancestors
-      @ancestors ||= pieces.reject { |p| p == self }
+    def right_key
+      right_name&.key
     end
 
-    # def + other
-    #   self.class.new(parts + other.to_name.parts)
-    # end
+    private
 
-    def [] *args
-      self.class.new parts[*args]
+    def generate_part_names
+      return blank_part_names if blank?
+      parts = Cardname.split_parts s
+      @simple = parts.size <= 1
+      @simple ? [self] : parts.map(&:to_name)
     end
 
-    # full support of array methods caused trouble with `flatten` calls
-    # It splits the parts of names in arrays
-    # # name parts can be accessed and manipulated like an array
-    # def method_missing method, *args, &block
-    #   if ARRAY_METHODS.include? method # parts.respond_to?(method)
-    #     self.class.new parts.send(method, *args, &block)
-    #   else
-    #     super
-    #   end
-    # end
-    #
-    # def respond_to? method, include_private=false
-    #   return true if ARRAY_METHODS.include? method
-    #   super || parts.respond_to?(method, include_private)
-    # end
+    def blank_part_names
+      @simple = true
+      []
+    end
   end
 end

data/lib/cardname/pieces.rb

@@ -8,7 +8,15 @@ class Cardname
     #   "A+B+C+D".to_name.pieces
     #   # => ["A", "B", "C", "D", "A+B", "A+B+C", "A+B+C+D"]
     def pieces
-      @pieces ||= simple? ? [self] : (parts + junction_pieces)
+      simple? ? [self] : (parts + junction_pieces)
+    end
+
+    def piece_names
+      pieces.map(&:to_name)
+    end
+
+    def ancestors
+      pieces.reject { |p| p == self }
     end
 
     private

data/lib/cardname/predicates.rb

@@ -1,15 +1,15 @@
 class Cardname
   module Predicates
+    # @return true if name has only one part
     def simple?
-      @simple.nil? ? (@simple = parts.size <= 1) : @simple
+      part_names if @simple.nil?
+      @simple
     end
-    alias_method :simple, :simple? # @deprecated
 
     # @return true if name has more than one part
     def compound?
       !simple?
     end
-    alias_method :junction?, :compound? # @deprecated
 
     def valid?
       return true if self.class.nothing_banned?

data/lib/cardname/variants.rb

@@ -10,12 +10,12 @@ class Cardname
         .gsub(/[^#{OK4KEY_RE}]+/, "_")
         .split(/_+/)
         .reject(&:empty?)
-        .map { |key| self.class.stable_key(key) }
+        .map { |key| stable_key(key) }
         .join("_")
     end
 
     def url_key
-      @url_key ||= part_names.map do |part_name|
+      part_names.map do |part_name|
         stripped = part_name.decoded.gsub(/[^#{OK4KEY_RE}]+/, " ").strip
         stripped.gsub(/[\s_]+/, "_")
       end * self.class.joint
@@ -25,7 +25,7 @@ class Cardname
     # but the key is no longer unique.
     # For example "A-XB" and "A+*B" have the same safe_key
     def safe_key
-      @safe_key ||= key.tr("*", "X").tr self.class.joint, "-"
+      key.tr("*", "X").tr self.class.joint, "-"
     end
 
     def decoded
@@ -35,5 +35,30 @@ class Cardname
     def to_sym
       s.to_sym
     end
+
+    private
+
+    def uninflect_method
+      self.class.uninflect
+    end
+
+    def stabilize?
+      self.class.stabilize
+    end
+
+    # Sometimes the core rule "the key's key must be itself" (called "stable" below)
+    # is violated. For example,  it fails with singularize as uninflect method
+    # for Matthias -> Matthia -> Matthium
+    # Usually that means the name is a proper noun and not a plural.
+    # You can choose between two solutions:
+    # 1. don't uninflect if the uninflected key is not stable (stabilize = false)
+    # 2. uninflect until the key is stable (stabilize = true)
+    def stable_key name
+      key_one = name.send uninflect_method
+      key_two = key_one.send uninflect_method
+      return key_one unless key_one != key_two
+
+      stabilize? ? stable_key(key_two) : name
+    end
   end
 end

data/lib/cardname.rb

@@ -4,12 +4,12 @@ require "active_support/inflector"
 require "htmlentities"
 
 class Cardname < String
-  require_relative "cardname/parts"
-  require_relative "cardname/pieces"
-  require_relative "cardname/variants"
-  require_relative "cardname/contextual"
-  require_relative "cardname/predicates"
-  require_relative "cardname/manipulate"
+  require "cardname/parts"
+  require "cardname/pieces"
+  require "cardname/variants"
+  require "cardname/contextual"
+  require "cardname/predicates"
+  require "cardname/manipulate"
 
   include Parts
   include Pieces
@@ -31,31 +31,15 @@ class Cardname < String
   JOINT_RE = Regexp.escape joint
 
   class << self
-    def cache
-      @cache ||= {}
-    end
-
     def new obj
       return obj if obj.is_a? self.class
 
       str = stringify(obj)
-      cached_name(str) || super(str)
-    end
-
-    def cached_name str
-      cache[str]
-    end
-
-    def reset_cache str=nil
-      str ? cache.delete(str) : @cache = {}
+      cache[str] ||= super(str)
     end
 
-    def stringify obj
-      if obj.is_a?(Array)
-        obj.map(&:to_s) * joint
-      else
-        obj.to_s
-      end
+    def reset
+      @cache = {}
     end
 
     def nothing_banned?
@@ -68,27 +52,22 @@ class Cardname < String
       @banned_re ||= /[#{Regexp.escape((banned_array + [joint])).join}]/
     end
 
-    # Sometimes the core rule "the key's key must be itself" (called "stable" below) is violated
-    # eg. it fails with singularize as uninflect method for Matthias -> Matthia -> Matthium
-    # Usually that means the name is a proper noun and not a plural.
-    # You can choose between two solutions:
-    # 1. don't uninflect if the uninflected key is not stable (stabilize = false)
-    # 2. uninflect until the key is stable (stabilize = true)
-    def stable_key name
-      key_one = name.send(uninflect)
-      key_two = key_one.send(uninflect)
-      return key_one unless key_one != key_two
-
-      stabilize ? stable_key(key_two) : name
+    def split_parts str
+      str.split(/\s*#{JOINT_RE}\s*/, -1)
     end
 
-    def dangerous_methods
-      bang_methods = String.instance_methods.select { |m| m.to_s.end_with?("!") }
-      %i[replace concat clear].concat bang_methods
+    def cache
+      @cache ||= {}
     end
 
-    def split_parts str
-      str.split(/\s*#{JOINT_RE}\s*/, -1)
+    private
+
+    def stringify obj
+      if obj.is_a?(Array)
+        obj.map(&:to_s) * joint
+      else
+        obj.to_s
+      end
     end
   end
 
@@ -97,26 +76,26 @@ class Cardname < String
   attr_reader :key
 
   def initialize str
-    self.class.cache[str] = super str.strip.encode("UTF-8")
+    super str
+    strip!
+    encode! "UTF-8"
+    part_names # populates @part_names and @simple
+    decoded # populates @decoded
+    key # populates and freezes @key
+    freeze
   end
 
   def s
-    @s ||= String.new self
+    String.new self
   end
   alias_method :to_s, :s
   alias_method :to_str, :s
+  # alias_method :dup, :clone
 
   def to_name
     self
   end
 
-  dangerous_methods.each do |m|
-    define_method m do |*args, &block|
-      reset
-      super(*args, &block)
-    end
-  end
-
   def []= index, val
     p = parts
     p[index] = val
@@ -128,25 +107,21 @@ class Cardname < String
   end
 
   def key
-    @key ||= part_keys.join(self.class.joint)
+    @key ||= generate_key.freeze
   end
 
   def == other
-    other_key =
+    key ==
       case
       when other.respond_to?(:key)     then other.key
       when other.respond_to?(:to_name) then other.to_name.key
-      else                                  other.to_s
+      else                                  other.to_s.to_name.key
       end
-    other_key == key
   end
 
   private
 
-  def reset
-    self.class.reset_cache s
-    instance_variables.each do |var|
-      instance_variable_set var, nil
-    end
+  def generate_key
+    @simple ? simple_key : part_keys.join(self.class.joint)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cardname
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Ethan McCutchen
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-06 00:00:00.000000000 Z
+date: 2021-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Card names without all the cards