discordrb 3.7.1 → 3.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37eb4e59f086dadcceaf68d4e3cc53497b861f69ec1dc0354b129de0493f5f71
-  data.tar.gz: ca21402938a89d49242cf5a39d7c21fb4640a4284583822972fcecd6482a1585
+  metadata.gz: 2229818c42fe455f937dceb0463ddb7489cd79058d6d617f0483ad8c287309ac
+  data.tar.gz: a0e966d6f85306b413cd8d7aad14f7746517fe4f241621c7ee84c0ac676e66f1
 SHA512:
-  metadata.gz: 2d2d46d7a7699e30c12f10df0f1a143cb6f85c84a1cfd759653a9a00eb16111f50b15691fc7858e9d95c594fb31b9b27b06107f02a9bdf8259c6cd08a3483208
-  data.tar.gz: 5ca1c937476f2a56fbb9b0a8cbf27d74bf25be3727779772d5809216a75bfbf79ed77ab85ee4f7b824b8378a18812f0112ff44cd0b8d9c6252f29e2c4379a649
+  metadata.gz: c535560deb7c130f75292caa6dd31cbfeefcf553ac2b584de7e6346a1e6d84a09252990a4a46e21162e4fc6600eb31402abaea8985ecdfc317b700b819aa72b8
+  data.tar.gz: 2ba9ec20ad47028f5137fe025f443e6dd6b64d36ed85a996de499372179897ce75cf8c446c3eb7d5a6181d645dc948285606ef133a55e5d33ea7ad667d963848

data/.rubocop.yml

@@ -109,7 +109,7 @@ Style/RedundantReturn:
 Style/RedundantParentheses:
   Enabled: false
 
-Style:/EndOfLine:
+Layout/EndOfLine:
   Enabled: true
   EnforcedStyle: lf
 

data/CHANGELOG.md

@@ -5,17 +5,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [3.7.1] - 2025-11-24
+## [3.7.2] 2025-12-24
+
+[View diff for this release](https://github.com/shardlab/discordrb/compare/v3.7.1...v3.7.2)
+
+### Summary
 
-[3.7.1]: https://github.com/shardlab/discordrb/releases/tag/v3.7.1
+#### What's Changed
+
+- feat: role move interface by @Droid00000 in https://github.com/shardlab/discordrb/pull/377
+- fix: condition to check components presence by @Droid00000 in https://github.com/shardlab/discordrb/pull/391
+- fix: handle pre-existing thread-ids in WH URLs by @Droid00000 in https://github.com/shardlab/discordrb/pull/406
+- fix: handle existing params in webhook urls by @swarley in https://github.com/shardlab/discordrb/pull/396
+
+## [3.7.1] - 2025-11-24
 
-[View diff for this release.](https://github.com/shardlab/discordrb/compare/v3.7.0..v3.7.1)
+[View diff for this release](https://github.com/shardlab/discordrb/compare/v3.7.0...v3.7.1)
 
 ### Summary
 
 #### What's Changed
 
--  fix: condition to check components presence by @Droid00000 in https://github.com/shardlab/discordrb/pull/391 
+- fix: condition to check components presence by @Droid00000 #391
 
 ## [3.7.0] - 2025-10-22
 

data/lib/discordrb/api/server.rb

@@ -280,7 +280,7 @@ module Discordrb::API::Server
 
   # Update role positions
   # https://discord.com/developers/docs/resources/guild#modify-guild-role-positions
-  def update_role_positions(token, server_id, roles)
+  def update_role_positions(token, server_id, roles, reason = nil)
     Discordrb::API.request(
       :guilds_sid_roles,
       server_id,
@@ -288,7 +288,8 @@ module Discordrb::API::Server
       "#{Discordrb::API.api_base}/guilds/#{server_id}/roles",
       roles.to_json,
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 

data/lib/discordrb/data/role.rb

@@ -165,6 +165,8 @@ module Discordrb
       @unicode_emoji = other.unicode_emoji
       @secondary_colour = other.secondary_colour
       @tertiary_colour = other.tertiary_colour
+      @mentionable = other.mentionable?
+      @tags = other.tags
     end
 
     # Updates the data cache from a hash containing data
@@ -179,14 +181,16 @@ module Discordrb
       @mentionable = new_data['mentionable']
       @flags = new_data['flags']
       colours = new_data['colors']
+      @managed = new_data['managed']
       @permissions.bits = new_data['permissions'].to_i
       @colour = ColourRGB.new(colours['primary_color'])
+      @tags = Tags.new(new_data['tags']) if new_data['tags']
       @secondary_color = ColourRGB.new(colours['secondary_color']) if colours['secondary_color']
       @tertiary_colour = ColourRGB.new(colours['tertiary_color']) if colours['tertiary_color']
     end
 
     # Sets the role name to something new
-    # @param name [String] The name that should be set
+    # @param name [String, nil] The name that should be set.
     def name=(name)
       update_role_data(name: name)
     end
@@ -206,7 +210,7 @@ module Discordrb
     # Sets the primary role colour to something new.
     # @param colour [ColourRGB, Integer, nil] The new colour.
     def colour=(colour)
-      update_colors(primary: colour)
+      update_colours(primary: colour)
     end
 
     # Sets the secondary role colour to something new.
@@ -293,7 +297,7 @@ module Discordrb
     # https://discord.com/developers/docs/topics/permissions.
     # @example Remove all permissions from a role
     #   role.packed = 0
-    # @param packed [Integer] A bitfield with the desired permissions value.
+    # @param packed [Integer, nil] A bitfield with the desired permissions value.
     # @param update_perms [true, false] Whether the internal data should also be updated. This should always be true
     #   when calling externally.
     def packed=(packed, update_perms = true)
@@ -305,17 +309,9 @@ module Discordrb
     # @param other [Role, String, Integer, nil] The role, or its ID, above which this role should be moved. If it is `nil`,
     #   the role will be moved above the @everyone role.
     # @return [Integer] the new position of this role
+    # @deprecated Please migrate to using {#move} with the `above` or `below` KWARGS.
     def sort_above(other = nil)
-      other = @server.role(other.resolve_id) if other
-      roles = @server.roles.sort_by(&:position)
-      roles.delete_at(@position)
-
-      index = other ? roles.index { |role| role.id == other.id } + 1 : 1
-      roles.insert(index, self)
-
-      updated_roles = roles.map.with_index { |role, position| { id: role.id, position: position } }
-      @server.update_role_positions(updated_roles)
-      index
+      other ? move(above: other) : move(bottom: true)
     end
 
     alias_method :move_above, :sort_above
@@ -327,13 +323,69 @@ module Discordrb
       @server.delete_role(@id)
     end
 
+    # Move the position of this role in the roles list.
+    # @example This will move the role 2 places above the `@everyone` role.
+    #   role.move(bottom: true, offset: 2)
+    # @example This will move the role above the `@muted` role.
+    #   role.move(above: 257017090932867072)
+    # @example This will move the role 3 spots below the `No Images` role.
+    #   roles.move(below: 254077236989132800, offset: -3)
+    # @param bottom [true, false, nil] Whether to move the roles to the bottom of the role list.
+    # @param above [Integer, String, Role, nil] The role that this role should be moved above.
+    # @param below [Integer, String, Role, nil] The role that this role should be moved below.
+    # @param offset [Integer, nil] The number of roles to offset the new position by. A positive number will
+    #   move the role above, and a negative number will move the role below. This parameter is relative and
+    #   calculated after the `bottom`, `above`, and `below` parameters.
+    # @param reason [String, nil] The audit log reason to show for moving the role.
+    # @return [Integer] the new position of the role.
+    def move(bottom: nil, above: nil, below: nil, offset: 0, reason: nil)
+      # rubocop:disable Style/IfUnlessModifier
+      if [bottom, above, below].count(&:itself) > 1
+        raise ArgumentError, "'bottom', 'above', and 'below' are mutually exclusive"
+      end
+
+      if (above || below) && !(target = @server.role(above || below))
+        raise ArgumentError, "The given 'above' or 'below' options are not valid"
+      end
+
+      if (below && target&.id == @server.id) || (@id == target&.id)
+        raise ArgumentError, 'The target role that was provded is not valid'
+      end
+
+      # rubocop:enable Style/IfUnlessModifier
+      roles = @server.roles.uniq.sort_by { |role| [role.position, role.id] }
+
+      # Make sure we remove the current role.
+      myself = roles.rindex(self).tap { |index| roles.delete_at(index) }
+
+      index = if bottom
+                1
+              elsif below
+                roles.rindex(target)
+              elsif above
+                roles.rindex(target) + 1
+              else
+                myself
+              end
+
+      roles.insert([index + (offset || 0), 1].max, self)
+
+      roles = roles.map.with_index do |role, new_position|
+        { id: role.resolve_id, position: new_position }
+      end
+
+      @server.update_role_positions(roles, reason: reason)
+      @position
+    end
+
     # A rich interface designed to make working with role colours simple.
     # @param primary [ColourRGB, Integer, nil] The new primary/base colour of this role, or nil to clear the primary colour.
     # @param secondary [ColourRGB, Integer, nil] The new secondary colour of this role, or nil to clear the secondary colour.
     # @param tertiary [ColourRGB, Integer,nil] The new tertiary colour of this role, or nil to clear the tertiary colour.
     # @param holographic [true, false] Whether to apply or remove the holographic style to the role colour, overriding any other
     #   arguments that were passed. Using this argument is recommended over passing individual colours.
-    def update_colours(primary: :undef, secondary: :undef, tertiary: :undef, holographic: :undef)
+    # @param reason [String, nil] The audit log reason to show for updating the role's colours.
+    def update_colours(primary: :undef, secondary: :undef, tertiary: :undef, holographic: :undef, reason: nil)
       colours = {
         primary_color: (primary == :undef ? @colour : primary)&.to_i,
         tertiary_color: (tertiary == :undef ? @tertiary_colour : tertiary)&.to_i,
@@ -347,9 +399,9 @@ module Discordrb
       }
 
       # Only set the tertiary_color to `nil` if holographic is explicitly set to false.
-      colours[:tertiary_color] = nil if holographic.is_a?(FalseClass) && holographic?
+      (colours[:tertiary_color] = nil) if holographic.is_a?(FalseClass)
 
-      update_role_data(colours: holographic == true ? holographic_colours : colours)
+      update_role_data(colours: holographic == true ? holographic_colours : colours, reason: reason)
     end
 
     alias_method :update_colors, :update_colours
@@ -361,14 +413,15 @@ module Discordrb
 
     private
 
+    # @!visibility private
     def update_role_data(new_data)
       update_data(JSON.parse(API::Server.update_role(@bot.token, @server.id, @id,
-                                                     new_data[:name] || @name,
+                                                     new_data.key?(:name) ? new_data[:name] : :undef,
                                                      :undef,
                                                      new_data.key?(:hoist) ? new_data[:hoist] : :undef,
                                                      new_data.key?(:mentionable) ? new_data[:mentionable] : :undef,
-                                                     new_data[:permissions] || @permissions.bits,
-                                                     nil,
+                                                     new_data.key?(:permissions) ? new_data[:permissions] : :undef,
+                                                     new_data[:reason],
                                                      new_data.key?(:icon) ? new_data[:icon] : :undef,
                                                      new_data.key?(:unicode_emoji) ? new_data[:unicode_emoji] : :undef,
                                                      new_data.key?(:colours) ? new_data[:colours] : :undef)))

data/lib/discordrb/data/server.rb

@@ -412,11 +412,11 @@ module Discordrb
     # Updates the positions of all roles on the server
     # @note For internal use only
     # @!visibility private
-    def update_role_positions(role_positions)
-      response = JSON.parse(API::Server.update_role_positions(@bot.token, @id, role_positions))
+    def update_role_positions(role_positions, reason: nil)
+      response = JSON.parse(API::Server.update_role_positions(@bot.token, @id, role_positions, reason))
       response.each do |data|
         updated_role = Role.new(data, @bot, self)
-        role(updated_role.id).update_from(updated_role)
+        role(updated_role.id)&.update_from(updated_role)
       end
     end
 

data/lib/discordrb/version.rb

@@ -3,5 +3,5 @@
 # Discordrb and all its functionality, in this case only the version.
 module Discordrb
   # The current version of discordrb.
-  VERSION = '3.7.1'
+  VERSION = '3.7.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discordrb
 version: !ruby/object:Gem::Version
-  version: 3.7.1
+  version: 3.7.2
 platform: ruby
 authors:
 - meew0
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.1
+        version: 3.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.1
+        version: 3.7.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement