precedences 1.5.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69c48ce2d4dd7a75e39e091581e48c02475ad26e4715a70ef99f705fd1d95ab8
-  data.tar.gz: 621913cb7d2b49741586fbdb0cccac0c0487b830c63b67d59330d8b3f3c68cd3
+  metadata.gz: 1a735e7b8f40a271f4259c8a4c3057d6a2836f2db06ab4ca89e094a8ced4b6f8
+  data.tar.gz: 7ebd0aafee4fa270219b8f46c83ca2e3fc0ad3870997277ba91ac4dcdd45f1aa
 SHA512:
-  metadata.gz: ea0d0643888097323ebe4cfe4c2c44c5593f5256bf292e3a6da7c0a79e0a56c8737ef33c7747be29f49178b0168a7db668f99f1b9dd6052d1c7a0d9c98c1f465
-  data.tar.gz: 9f8759e3f0583e4c8184268de8884bac91864e738457e3029d205e26d9fdedb1bad35ca1d8029ef766d7a403d84a9411045a35528724ebedce4194230451e445
+  metadata.gz: 8518f9fd7c03c3204c4930cd6faa99feb28d48e34d7d44d8fb1681fdc4d18407ef9649a4873784e1554d97d33b333f0fb2943c13d1eb98e049e8442c6ebc5f04
+  data.tar.gz: d0c399a24bf4178581e8c0573dd515f3b8ef9d1fa31b0ed09fc9cce013abe61476e7e2d224d26fccd865f322938f115cb26052ea632c5d35763544fd2a033a43

data/CHANGELOG

@@ -1,3 +1,15 @@
+# 1.7.0
+  
+  - Possiblité d’ajouter des menus hors classement à l’aide
+    de la méthode block #add (ou son alias #add_choice)
+
+# 1.6.1
+
+  - Correction du bug quand classement par index et suppression
+    d’un item (trou)
+  - Ajout de la possibilité de définir une autre clé pour le
+    classement (`per_other_key`).
+
 # 1.5.1
 
   - Ajout de l’option `:cycle` pour `Q.select`

data/Manual/Manuel-fr.md

@@ -86,7 +86,27 @@ choix = precedencize(choices, file) do |q|
 end
 ~~~
 
+On peut aussi définir une autre clé que `:value` pour le tri, avec la propriété `per_other_key`
 
+~~~ruby
+require 'precedences'
+
+#
+# Des choix avec des valeurs spéciales
+#
+choices = [
+  {name:"La classe Integer"   , pkey: :entier, value: Integer},
+  {name:"La classe Array"     , pkey: :liste   ,value: Array},
+  {name:"La classe Hash"      , pkey: :table , value: Hash},
+]
+
+choix = precedencize(choices, file) do |q|
+  q.question "Choisis une classe"
+  q.per_other_key :pkey  # <=== autre clé
+end
+~~~
+
+<a name="options"></a>
 
 ## Options possibles
 
@@ -142,6 +162,14 @@ choix = precedencize(choices, precfile) do |q|
   q.default = "premier"
   # ou q.default "premier"
   # => Sélectionnera le choix "Choix premier"
+  
+  # Ajout de menus à la fin, jamais classés
+  q.add "Dernier menu", :last
+  q.add_choice "Tout dernier", :very_last
+  
+  # Ajout de menus au début, jamais classés
+  q.add_choice "Tout premier".bleu, :very_first, **{at_top:true}
+  q.add("Premier", :first, {at_top: true})
 
 end
 
@@ -168,3 +196,9 @@ end
 ~~~
 
 > 😃 Noter qu’on peut en fait se servir de ce menu pour ajouter n’importe quel autre menu que “Renoncer”.
+
+
+
+#### Ajouter un menu quelconque
+
+Utiliser les méthodes `#add` ou `#add_choice` (alias). Cf. ci-dessus [Options possibles](#options).

data/Rakefile

@@ -4,7 +4,8 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  # t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = FileList["test/**/precedences_test.rb"]
 end
 
 task :default => :test

data/lib/precedences/precedence.rb

@@ -21,6 +21,7 @@ class Precedence
     @per_page   = nil
     @default    = 1
     @precedences_per_index  = false
+    @per_other_key          = nil
     @add_choice_cancel      = nil
   end
 
@@ -89,6 +90,10 @@ class Precedence
     @precedences_per_index === true
   end
 
+  def per_other_key?
+    not(@per_other_key.nil?)
+  end
+
   def add_choice_cancel?
     not(@add_choice_cancel.nil?)
   end
@@ -135,6 +140,17 @@ class Precedence
   end
   def precedences_per_index=(value) ; precedences_per_index(value) end
 
+  def per_other_key(value = :__no_value)
+    if value == :__no_value
+      return @per_other_key
+    elsif not(value)
+      @per_other_key = nil
+    else
+      @per_other_key = value
+    end
+  end
+  def per_other_key=(value) ; per_other_key(value) end
+
   ##
   # To add the cancel choice
   # 
@@ -153,16 +169,42 @@ class Precedence
     @add_choice_cancel = params
   end
 
+  ##
+  # To add any choice not precedencized
+  # 
+  # @param name   [String] The menu name
+  # @param value  [Any]    Then value of the menu
+  # @param params [Hash]
+  #   :at_top     If true, add the item at the top
+  #               Else (default) add at the bottom
+  #
+  attr_reader :added_choices_before
+  attr_reader :added_choices_after
+  def add(name, value, **params)
+    @added_choices_before = []
+    @added_choices_after  = []
+    name.is_a?(String) || raise(ArgumentError.new("First argument should be a String."))
+    lechoix = {name: name, value: value}
+    if params[:at_top]
+      @added_choices_before << lechoix
+    else
+      @added_choices_after << lechoix
+    end
+  end
+  alias :add_choice :add
+
   private
 
     ##
     # = main =
+    # @private
     #
     def prepare_choices(choices)
       # 
       # Classement des choix par précédence
       # 
       choices = sort_items(choices)
+      
       # 
       # Faut-il ajouter un choix cancel ?
       # 
@@ -170,6 +212,17 @@ class Precedence
         add_method = (@add_choice_cancel[:position] == :down) ? :push : :unshift
         choices.send(add_method, @add_choice_cancel)
       end
+
+      #
+      # Y a-t-il des menus à ajouter ?
+      # 
+      if added_choices_before && not(added_choices_before.empty?)
+        choices = added_choices_before + choices
+      end
+      if added_choices_after && not(added_choices_after.empty?)
+        choices = choices + added_choices_after
+      end
+
       # 
       # On retourne les choix préparés
       # 
@@ -178,16 +231,17 @@ class Precedence
     #
     # Main method whose sort items
     # 
-    # @api private
+    # @private
     def sort_items(choices)
       return choices unless File.exist?(filepath)
       prec_ids = get_precedences_ids
       if precedences_per_index?
         choices_copy = choices.dup
-        choices = prec_ids.map do |id| 
-          item = choices_copy[id.to_i - 1]
+        choices = []
+        prec_ids.each do |id| 
+          item = choices_copy[id.to_i - 1] || next
           choices_copy[id.to_i - 1] = nil
-          item
+          choices << item
         end
         # On ajoute les choix restants
         choices += choices_copy.compact
@@ -195,8 +249,9 @@ class Precedence
         # 
         # Cas normal
         # 
+        key_prec = per_other_key? ? per_other_key : :value
         choices.sort!{|a, b|
-          (prec_ids.index(a[:value].to_s)||10000) <=> (prec_ids.index(b[:value].to_s)||10000)
+          (prec_ids.index(a[key_prec].to_s)||10000) <=> (prec_ids.index(b[key_prec].to_s)||10000)
         }
       end
       return choices
@@ -219,7 +274,7 @@ class Precedence
 
     # Save the values order in filepath file
     # 
-    # @api private
+    # @private
     def set_precedences_ids(value)
       if precedences_per_index?
         # 
@@ -245,7 +300,7 @@ class Precedence
 
     # Get the values sorted if filepath exists.
     # 
-    # @api private
+    # @private
     def get_precedences_ids
       @get_precedences_ids ||= begin
         File.exist?(filepath) ? File.read(filepath).split("\n") : [] 
@@ -257,7 +312,7 @@ class Precedence
     # Raise an argument error otherwise.
     # If it's a folder, set to .precedences file
     # 
-    # @api private
+    # @private
     def filepath_validize_or_raises
       File.exist?(File.dirname(filepath)) || raise(ArgumentError.new("Precedences incorrect file: its folder should exist."))
       if File.exist?(filepath) && File.directory?(filepath)
@@ -270,7 +325,7 @@ class Precedence
     ##
     # Check if given choices are valid. Raise an ArgumentError otherwise
     # 
-    # @api private
+    # @private
     def choices_valid_or_raises(choices)
       # 
       # On en aura besoin

data/lib/precedences/version.rb

@@ -1,3 +1,3 @@
 module Precedences
-  VERSION = "1.5.1"
+  VERSION = "1.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: precedences
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.7.0
 platform: ruby
 authors:
 - PhilippePerret
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-23 00:00:00.000000000 Z
+date: 2024-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clir