cardname 0.11.2 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c260221350ba09829667df4d721ee9a80892bc22cbbf054357b360d19ab676b
-  data.tar.gz: 1d811e8a8db4ecb0b3896c93cd81a717b4c47f4961fb73a3684ca512d50be9c0
+  metadata.gz: 812ca647556b0ad54259e6725537591d7ce88bf36a1c8d2ffc4a664e6db9be73
+  data.tar.gz: 543e2aaeeb99557a86f9dee55e7324f7a9547266fa3bb66d313bc7e8328b5755
 SHA512:
-  metadata.gz: dc4e1b0659a3678656ae53cc9e025b4ab62cbd210481d61bd2a64da373e00d19691545f641694d424cfb14f921a5d6e3f4bd79675f662706799d2fe95f825222
-  data.tar.gz: 2b55f8b9ea340952e7d1f190e9d18b0c66ff300fd1f47bb89a0ec047a8d3b2156bbb912220fd30ce54ece77b75760e3fb0a4fc91e3c7669392d83503c5939594
+  metadata.gz: 88794a5f65b569572307c180646cb5ad33642ae6044e52eee42bab238022aedc66bdce53f8a6c70b5781349e60f63aea91f3119cc7a987a7b980ae569fcd2d6a
+  data.tar.gz: 54b7da9b970b17f8dcf72f6f7d4b995ee7e969755fca980a5bc5851c98392a9cb75bcb2767ac42afec1de459e9626dbeb4f2b25ba8f9d5a8598f81cfa65debe4

data/Rakefile

@@ -1,39 +1,37 @@
+# -*- encoding : utf-8 -*-
 
-# encoding: utf-8
+require "rubygems"
+require "bundler"
 
-require 'rubygems'
-require 'bundler'
-
-VERSION = File.exist?('VERSION') ? File.read('VERSION') : ""
+VERSION = File.exist?("VERSION") ? File.read("VERSION") : ""
 
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  warn e.message
+  warn "Run `bundle install` to install missing gems"
   exit e.status_code
 end
 
-require 'rake'
+require "rake"
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
+require "rspec/core"
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.pattern = FileList["spec/**/*_spec.rb"]
 end
 
 RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
+  spec.pattern = "spec/**/*_spec.rb"
   spec.rcov = true
 end
 
-task :default => :spec
+task default: :spec
 
-require 'rdoc/task'
+require "rdoc/task"
 Rake::RDocTask.new do |rdoc|
-
-  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_dir = "rdoc"
   rdoc.title = "cardname #{VERSION}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end

data/lib/cardname.rb

@@ -5,12 +5,14 @@ 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"
 
   include Parts
+  include Pieces
   include Variants
   include Contextual
   include Predicates
@@ -18,12 +20,11 @@ class Cardname < String
 
   OK4KEY_RE = '\p{Word}\*'
 
-  cattr_accessor :joint, :banned_array, :var_re, :uninflect, :params,
-                 :session, :stabilize
+  cattr_accessor :joint, :banned_array, :var_re, :uninflect, :params, :session, :stabilize
 
   self.joint          = "+"
   self.banned_array   = []
-  self.var_re         = /\{([^\}]*\})\}/
+  self.var_re         = /\{([^}]*\})\}/
   self.uninflect      = :singularize
   self.stabilize      = false
 
@@ -116,7 +117,6 @@ class Cardname < String
     end
   end
 
-  # dangerous, too
   def []= index, val
     p = parts
     p[index] = val

data/lib/cardname/contextual.rb

@@ -4,7 +4,8 @@ class Cardname
 
     # @return true if name is left or right of context
     def child_of? context
-      return false unless junction?
+      return false unless compound?
+
       context_key = context.to_name.key
       absolute_name(context).parent_keys.include? context_key
     end
@@ -26,7 +27,7 @@ class Cardname
     end
 
     def starts_with_joint?
-      junction? && parts.first.empty?
+      compound? && parts.first.empty?
     end
 
     def from *from
@@ -36,16 +37,19 @@ 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"
     def name_from *from
-      return self unless (remaining = remove_context *from)
+      return self unless (remaining = remove_context(*from))
+
       compressed = remaining.compact.unshift(nil).to_name  # exactly one nil at beginning
       key == compressed.absolute_name(from).key ? compressed : self
     end
 
     def remove_context *from
       return false unless from.compact.present?
-      remaining = parts_excluding *from
+
+      remaining = parts_excluding(*from)
       return false if remaining.compact.empty? || # all name parts in context
                       remaining == parts          # no name parts in context
+
       remaining
     end
 
@@ -60,6 +64,7 @@ class Cardname
         next if part.empty?
         next if part =~ /^_/ # this removes relative parts.  why?
         next if keys_to_ignore.member? part.to_name.key
+
         part
       end
     end
@@ -68,6 +73,7 @@ class Cardname
       context = (context || "").to_name
       new_parts = absolutize_contextual_parts context
       return "" if new_parts.empty?
+
       absolutize_extremes new_parts, context.s
       new_parts.join self.class.joint
     end
@@ -90,10 +96,10 @@ class Cardname
         when /^_main$/i            then self.class.params[:main_name]
         when /^(_self|_whole|_)$/i then context.s
         when /^_left$/i            then context.trunk
-        # note - inconsistent use of left v. trunk
+        # NOTE: - inconsistent use of left v. trunk
         when /^_right$/i           then context.tag
-        when /^_(\d+)$/i           then ordinal_part $~[1].to_i, context
-        when /^_(L*)(R?)$/i        then partmap_part $~, context
+        when /^_(\d+)$/i           then ordinal_part $LAST_MATCH_INFO[1].to_i, context
+        when /^_(L*)(R?)$/i        then partmap_part $LAST_MATCH_INFO, context
         else                            part
         end.to_s.strip
       end
@@ -109,7 +115,8 @@ class Cardname
     end
 
     def partmap_part match, context
-      l_s, r_s = match[1].size, !match[2].empty?
+      l_s = match[1].size
+      r_s = !match[2].empty?
       l_part = context.nth_left l_s
       r_s ? l_part.tag : l_part.s
     end
@@ -122,9 +129,10 @@ class Cardname
 
     def absolutize_extreme? new_parts, context, index
       return false if new_parts[index].present?
+
       # following avoids recontextualizing with relative contexts.
       # Eg, `+A+B+.absolute('+A')` should be +A+B, not +A+A+B.
-      !new_parts.to_name.send "#{[ :start, :end ][index]}s_with_parts?", context
+      !new_parts.to_name.send "#{%i[start end][index]}s_with_parts?", context
     end
   end
 end

data/lib/cardname/manipulate.rb

@@ -8,6 +8,7 @@ class Cardname
       return self if old_name.num_parts > num_parts
       return swap_part(old_name, new_name) if old_name.simple?
       return self unless include? old_name
+
       swap_all_subsequences(old_name, new_name).to_name
     end
 
@@ -29,6 +30,7 @@ class Cardname
       return swap_part oldpiece, newpiece if oldpiece.simple?
       return self unless starts_with_parts?(oldpiece)
       return newpiece if oldpiece.num_parts == num_parts
+
       self.class.new [newpiece, self[oldpiece.num_parts..-1]].flatten
     end
 
@@ -72,6 +74,7 @@ class Cardname
 
     def ensure_simpleness part, msg=nil
       return if part.to_name.simple?
+
       raise StandardError, "'#{part}' has to be simple. #{msg}"
     end
   end

data/lib/cardname/parts.rb

@@ -4,24 +4,12 @@ class Cardname
   # the same methods without _name return strings
   module Parts
     attr_reader :parts, :part_keys, :simple
-
     alias_method :to_a, :parts
 
     def parts
       @parts = Cardname.split_parts s
     end
 
-    def simple
-      @simple = parts.size <= 1
-    end
-    alias simple? simple
-
-    # @return true if name has more than one part
-    def compound?
-      !simple?
-    end
-    alias junction? compound?
-
     def part_keys
       @part_keys ||= simple ? [simple_key] : parts.map { |p| p.to_name.simple_key }
     end
@@ -51,15 +39,15 @@ class Cardname
     end
 
     def parents
-      @parents ||= junction? ? [left, right] : []
+      @parents ||= compound? ? [left, right] : []
     end
 
     def parent_names
-      @parent_names ||= junction? ? [left_name, right_name] : []
+      @parent_names ||= compound? ? [left_name, right_name] : []
     end
 
     def parent_keys
-      @parent_keys ||= junction? ? [left_key, right_key] : []
+      @parent_keys ||= compound? ? [left_key, right_key] : []
     end
 
     # Note that all names have a trunk and tag,
@@ -89,27 +77,8 @@ class Cardname
       @piece_names ||= pieces.map(&:to_name)
     end
 
-    # self and all ancestors (= parts and recursive lefts)
-    # @example
-    #   "A+B+C+D".to_name.pieces
-    #   # => ["A", "B", "C", "D", "A+B", "A+B+C", "A+B+C+D"]
-    def pieces
-      @pieces ||=
-        if simple?
-          [self]
-        else
-          junction_pieces = []
-          parts[1..-1].inject parts[0] do |left, right|
-            piece = [left, right] * self.class.joint
-            junction_pieces << piece
-            piece
-          end
-          parts + junction_pieces
-        end
-    end
-
     def ancestors
-      @ancestors ||= pieces.reject { |p| p == self}
+      @ancestors ||= pieces.reject { |p| p == self }
     end
 
     # def + other

data/lib/cardname/pieces.rb

@@ -0,0 +1,26 @@
+class Cardname
+  # Cards never have more than two "parts" (left and right), but they can have many
+  # "pieces".  A card's pieces are all the other cards whose existence its existence
+  # implies. For example if A+B+C exists, that implies that A, B, C, and A+B do too.
+  module Pieces
+    # self and all ancestors (= parts and recursive lefts)
+    # @example
+    #   "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)
+    end
+
+    private
+
+    def junction_pieces
+      [].tap do |pieces|
+        parts[1..-1].inject parts[0] do |left, right|
+          piece = [left, right] * self.class.joint
+          pieces << piece
+          piece
+        end
+      end
+    end
+  end
+end

data/lib/cardname/predicates.rb

@@ -1,7 +1,19 @@
 class Cardname
   module Predicates
+    def simple?
+      @simple.nil? ? (@simple = parts.size <= 1) : @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?
+
       !parts.find do |pt|
         pt.match self.class.banned_re
       end

data/lib/cardname/variants.rb

@@ -1,20 +1,23 @@
+require "htmlentities"
+
 class Cardname
   module Variants
     def simple_key
       return "" if empty?
+
       decoded
         .underscore
-        .gsub(/[^#{OK4KEY_RE}]+/, '_')
+        .gsub(/[^#{OK4KEY_RE}]+/, "_")
         .split(/_+/)
         .reject(&:empty?)
         .map { |key| self.class.stable_key(key) }
-        .join('_')
+        .join("_")
     end
 
     def url_key
       @url_key ||= part_names.map do |part_name|
-        stripped = part_name.decoded.gsub(/[^#{OK4KEY_RE}]+/, ' ').strip
-        stripped.gsub(/[\s\_]+/, '_')
+        stripped = part_name.decoded.gsub(/[^#{OK4KEY_RE}]+/, " ").strip
+        stripped.gsub(/[\s_]+/, "_")
       end * self.class.joint
     end
 
@@ -22,11 +25,11 @@ 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, '-'
+      @safe_key ||= key.tr("*", "X").tr self.class.joint, "-"
     end
 
     def decoded
-      @decoded ||= s.index('&') ? HTMLEntities.new.decode(s) : s
+      @decoded ||= s.index("&") ? HTMLEntities.new.decode(s) : s
     end
 
     def to_sym

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cardname
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.0
 platform: ruby
 authors:
 - Ethan McCutchen
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-15 00:00:00.000000000 Z
+date: 2021-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
@@ -53,6 +53,7 @@ files:
 - lib/cardname/contextual.rb
 - lib/cardname/manipulate.rb
 - lib/cardname/parts.rb
+- lib/cardname/pieces.rb
 - lib/cardname/predicates.rb
 - lib/cardname/variants.rb
 - lib/core_ext.rb
@@ -80,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Card names without all the cards