bundler-gem_bytes 0.2.0 → 0.2.2

data/release-please-config.json

@@ -0,0 +1,22 @@
+{
+  "bootstrap-sha": "28bcb17c41c9f9888c79c353731f557478f400f6",
+  "packages": {
+    ".": {
+      "release-type": "ruby",
+      "package-name": "bundler-gem_bytes",
+      "changelog-path": "CHANGELOG.md",
+      "version-file": "lib/bundler/gem_bytes/version.rb",
+      "bump-minor-pre-major": true,
+      "bump-patch-for-minor-pre-major": true,
+      "draft": false,
+      "prerelease": false,
+      "include-component-in-tag": false
+    }
+  },
+  "plugins": [
+    {
+      "type": "sentence-case"
+    }
+  ],
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bundler-gem_bytes
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - James Couball
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -261,6 +260,7 @@ extra_rdoc_files: []
 files:
 - ".commitlintrc.yml"
 - ".husky/commit-msg"
+- ".release-please-manifest.json"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -270,14 +270,20 @@ files:
 - Rakefile
 - lib/bundler/gem_bytes.rb
 - lib/bundler/gem_bytes/actions.rb
+- lib/bundler/gem_bytes/actions/gemspec.rb
+- lib/bundler/gem_bytes/actions/gemspec/attribute.rb
+- lib/bundler/gem_bytes/actions/gemspec/attribute_node.rb
+- lib/bundler/gem_bytes/actions/gemspec/delete_dependency.rb
+- lib/bundler/gem_bytes/actions/gemspec/dependency.rb
+- lib/bundler/gem_bytes/actions/gemspec/dependency_node.rb
+- lib/bundler/gem_bytes/actions/gemspec/gem_specification.rb
+- lib/bundler/gem_bytes/actions/gemspec/upsert_dependency.rb
 - lib/bundler/gem_bytes/bundler_command.rb
-- lib/bundler/gem_bytes/gemspec.rb
-- lib/bundler/gem_bytes/gemspec/delete_dependency.rb
-- lib/bundler/gem_bytes/gemspec/upsert_dependency.rb
 - lib/bundler/gem_bytes/script_executor.rb
 - lib/bundler/gem_bytes/version.rb
 - package.json
 - plugins.rb
+- release-please-config.json
 homepage: https://github.com/main-branch/bundler-gem_bytes
 licenses:
 - MIT
@@ -285,11 +291,10 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/main-branch/bundler-gem_bytes
   source_code_uri: https://github.com/main-branch/bundler-gem_bytes
-  documentation_uri: https://rubydoc.info/gems/bundler-gem_bytes/0.2.0
-  changelog_uri: https://rubydoc.info/gems/bundler-gem_bytes/0.2.0/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/bundler-gem_bytes/0.2.2
+  changelog_uri: https://rubydoc.info/gems/bundler-gem_bytes/0.2.2/file/CHANGELOG.md
   bug_tracker_uri: https://github.com/main-branch/bundler-gem_bytes/issues
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -304,8 +309,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A bundler plugin that adds features to your existing Ruby Gems project
 test_files: []

data/lib/bundler/gem_bytes/gemspec/delete_dependency.rb

@@ -1,216 +0,0 @@
-# frozen_string_literal: true
-
-require 'parser/current'
-require 'rubocop-ast'
-require 'active_support/core_ext/object'
-
-module Bundler
-  module GemBytes
-    module Gemspec
-      # Delete a dependency in a gemspec file
-      #
-      # This class works by parsing the gemspec file into an AST and then walking the
-      # AST to find the Gem::Specification block (via #on_block). Once the block is
-      # found, AST within that block is walked to locate the dependency declarations
-      # (via #on_send). Any dependency declaration that matches the given gem name is
-      # collected into the found_dependencies array.
-      #
-      # Once the Gem::Specification block is fully processed, any dependencies on the
-      # given gem are deleted from the gemspec source.
-      #
-      # If the dependency is not found, the gemspec source is returned unmodified.
-      #
-      # @example
-      #   require 'bundler/gem_bytes'
-      #
-      #   delete_dependency = Bundler::GemBytes::Gemspec::DeleteDependency.new('test_tool')
-      #
-      #   gemspec_file = 'foo.gemspec'
-      #   gemspec = File.read(gemspec_file)
-      #   updated_gemspec = delete_dependency.call(gemspec, path: gemspec_file)
-      #   File.write(gemspec_file, updated_gemspec)
-      #
-      # @!attribute [r] gem_name
-      #   The name of the gem to add a dependency on (i.e. 'rubocop')
-      #   @return [String]
-      #   @api private
-      #
-      # @!attribute [r] receiver_name
-      #   The name of the receiver for the Gem::Specification block
-      #
-      #    i.e. 'spec' in `spec.add_dependency 'rubocop', '~> 1.0'`
-      #
-      #   @return [Symbol]
-      #   @api private
-      #
-      # @!attribute [r] found_gemspec_block
-      #   Whether the Gem::Specification block was found in the gemspec file
-      #
-      #   Only valid after calling `#call`.
-      #   @return [Boolean]
-      #   @api private
-      #
-      # @!attribute [r] found_dependencies
-      #   The dependencies found in the gemspec file
-      #
-      #   Only valid after calling `#call`.
-      #   @return [Array<Hash>]
-      #   @api private
-      #
-      # @api public
-      class DeleteDependency < Parser::TreeRewriter
-        # Create a new instance of a dependency upserter
-        # @example
-        #   command = Bundler::GemBytes::Gemspec::DeleteDependency.new('my_gem')
-        # @param gem_name [String] The name of the gem to add a dependency on
-        def initialize(gem_name)
-          super()
-
-          @gem_name = gem_name
-
-          @found_dependencies = []
-        end
-
-        # Returns the content of the gemspec file with the dependency deleted
-        #
-        # @param code [String] The content of the gemspec file
-        # @param path [String] This should be the path to the gemspspec file
-        #
-        #   path is used to generate error messages only
-        #
-        # @return [String] The updated gemspec content with the dependency deleted
-        #
-        # @raise [ArgumentError] if the Gem Specification block is not found in the given gemspec
-        #
-        # @example
-        #   code = File.read('project.gemspec')
-        #   command = Bundler::GemBytes::DeleteDependency.new('my_gem')
-        #   updated_code = command.call(code)
-        #   puts updated_code
-        #
-        def call(code, path: '(string)')
-          @found_gemspec_block = false
-          rewrite(*parse(code, path)).tap do |_result|
-            raise ArgumentError, 'Gem::Specification block not found' unless found_gemspec_block
-          end
-        end
-
-        attr_reader :gem_name, :receiver_name, :found_gemspec_block, :found_dependencies
-
-        # Handles block nodes within the AST to locate the Gem Specification block
-        #
-        # @param node [Parser::AST::Node] The block node within the AST
-        # @return [void]
-        # @api private
-        def on_block(node)
-          return if receiver_name # already processing the Gem Specification block
-
-          @found_gemspec_block = true
-          @receiver_name = gem_specification_pattern.match(node)
-
-          return unless receiver_name
-
-          super # process the children of this node to find the existing dependencies
-
-          delete_dependencies
-
-          @receiver_name = nil
-        end
-
-        # Handles `send` nodes within the AST to locate dependency calls
-        #
-        # If receiver_name is not present then we are not in a Gem Specification block.
-        #
-        # @param node [Parser::AST::Node] The `send` node to check for dependency patterns
-        # @return [void]
-        # @api private
-        def on_send(node)
-          return unless receiver_name.present?
-          return unless (match = dependency_pattern.match(node))
-
-          found_dependencies << { node:, match: }
-        end
-
-        private
-
-        # Parses the given code into an AST
-        # @param code [String] The code to parse
-        # @param path [String] The path to the file being parsed (used for error messages only)
-        # @return [Array<Parser::AST::Node, Parser::Source::Buffer>] The AST and buffer
-        # @api private
-        def parse(code, path)
-          buffer = Parser::Source::Buffer.new(path, source: code)
-          processed_source = RuboCop::AST::ProcessedSource.new(code, ruby_version, path)
-          unless processed_source.valid_syntax?
-            raise "Invalid syntax in #{path}\n#{processed_source.diagnostics.map(&:render).join("\n")}"
-          end
-
-          ast = processed_source.ast
-          [buffer, ast]
-        end
-
-        # Deletes any dependency on the given gem within the Gem::Specification block
-        # @param node [Parser::AST::Node] The block node within the AST
-        # @return [void]
-        # @api private
-        def delete_dependencies
-          found_dependencies.each do |found_dependency|
-            dependency_node = found_dependency[:node]
-            remove(range_including_leading_spaces(dependency_node))
-          end
-        end
-
-        # Returns the range of the dependency node including any leading spaces & newline
-        # @param node [Parser::AST::Node] The node
-        # @return [Parser::Source::Range] The range of the dependency node
-        # @api private
-        def range_including_leading_spaces(node)
-          leading_spaces = leading_whitespace_count(node)
-          range = node.loc.expression
-          range.with(begin_pos: range.begin_pos - leading_spaces - 1, end_pos: range.end_pos)
-        end
-
-        # Returns the # of leading whitespace chars in the source line before the node
-        # @param node [Parser::AST::Node] The node
-        # @return [Integer] The number of leading whitespace characters
-        # @api private
-        def leading_whitespace_count(node)
-          match_data = node.loc.expression.source_line.match(/^\s*/)
-          match_data ? match_data[0].size : 0
-        end
-
-        # Returns the Ruby version in use as a float (MAJOR.MINOR only)
-        # @return [Float] The Ruby version number, e.g., 3.0
-        # @api private
-        def ruby_version = RUBY_VERSION.match(/^(?<version>\d+\.\d+)/)['version'].to_f
-
-        # The pattern to match a dependency declaration in the AST
-        # @return [RuboCop::AST::NodePattern] The dependency pattern
-        # @api private
-        def dependency_pattern
-          # :nocov: JRuby give false positive for this line being uncovered by tests
-          @dependency_pattern ||=
-            RuboCop::AST::NodePattern.new(<<~PATTERN)
-              (send
-                { (send _ :#{receiver_name}) | (lvar :#{receiver_name}) }
-                ${ :add_dependency :add_runtime_dependency :add_development_dependency }
-                (str #{gem_name ? "$\"#{gem_name}\"" : '$_gem_name'})
-                <(str $_version_constraint) ...>
-              )
-            PATTERN
-          # :nocov:
-        end
-
-        # The pattern to match the Gem::Specification block in the AST
-        # @return [RuboCop::AST::NodePattern] The Gem::Specification pattern
-        # @api private
-        def gem_specification_pattern
-          @gem_specification_pattern ||=
-            RuboCop::AST::NodePattern.new(<<~PATTERN)
-              (block (send (const (const nil? :Gem) :Specification) :new)(args (arg $_)) ...)
-            PATTERN
-        end
-      end
-    end
-  end
-end

data/lib/bundler/gem_bytes/gemspec/upsert_dependency.rb

@@ -1,336 +0,0 @@
-# frozen_string_literal: true
-
-require 'parser/current'
-require 'rubocop-ast'
-require 'active_support/core_ext/object'
-
-module Bundler
-  module GemBytes
-    module Gemspec
-      # Add or update a dependency in a gemspec file
-      #
-      # This class allows the addition of a new dependency or the updating of an
-      # existing dependency in a gemspec file.
-      #
-      # This class works by parsing the gemspec file into an AST and then walking the
-      # AST to find the Gem::Specification block (via #on_block). Once the block is
-      # found, AST within that block is walked to locate the dependency declarations
-      # (via #on_send). Any dependency declaration that matches the given gem name is
-      # collected into the found_dependencies array.
-      #
-      # Once the Gem::Specification block is fully processed, if a dependency on the
-      # given gem is not found, a new dependency is added to the end of the
-      # Gem::Specification block.
-      #
-      # If one or more dependencies are found, the version constraint is updated to
-      # the given version constraint. If the dependency type is different from the
-      # existing dependency, an error is raised unless the `force` option is set to
-      # true.
-      #
-      # @example
-      #   require 'bundler/gem_bytes'
-      #
-      #   add_dependency = Bundler::GemBytes::Gemspec::UpsertDependency.new(:dependency, 'test_tool', '~> 2.1')
-      #
-      #   gemspec = File.read('bundler-gem_bytes.gemspec')
-      #   updated_gemspec = add_dependency.call(gemspec)
-      #   File.write('project.gemspec', updated_gemspec)
-      #
-      # @!attribute [r] dependency_type
-      #   The type of dependency to add
-      #   @return [:runtime, :depenncy]
-      #   @api private
-      #
-      # @!attribute [r] gem_name
-      #   The name of the gem to add a dependency on (i.e. 'rubocop')
-      #   @return [String]
-      #   @api private
-      #
-      # @!attribute [r] version_constraint
-      #   The version constraint for the gem (i.e. '~> 2.1')
-      #   @return [String]
-      #   @api private
-      #
-      # @!attribute [r] force
-      #   Whether to update the dependency even if the type is different
-      #   @return [Boolean]
-      #   @api private
-      #
-      # @!attribute [r] receiver_name
-      #   The name of the receiver for the Gem::Specification block
-      #
-      #    i.e. 'spec' in `spec.add_dependency 'rubocop', '~> 1.0'`
-      #
-      #   @return [Symbol]
-      #   @api private
-      #
-      # @!attribute [r] found_gemspec_block
-      #   Whether the Gem::Specification block was found in the gemspec file
-      #
-      #   Only valid after calling `#call`.
-      #   @return [Boolean]
-      #   @api private
-      #
-      # @!attribute [r] found_dependencies
-      #   The dependencies found in the gemspec file
-      #
-      #   Only valid after calling `#call`.
-      #   @return [Array<Hash>]
-      #   @api private
-      #
-      # @api public
-      class UpsertDependency < Parser::TreeRewriter # rubocop:disable Metrics/ClassLength
-        # Create a new instance of a dependency upserter
-        # @example
-        #   add_dependency = Bundler::GemBytes::Gemspec::UpsertDependency.new(:runtime, 'my_gem', '~> 1.0')
-        # @param dependency_type [Symbol] The type of dependency to add
-        # @param gem_name [String] The name of the gem to add a dependency on
-        # @param version_constraint [String] The version constraint for the gem
-        # @param force [Boolean] Whether to update the dependency even if the type is different
-        def initialize(dependency_type, gem_name, version_constraint, force: false)
-          super()
-
-          self.dependency_type = dependency_type
-          @gem_name = gem_name
-          self.version_constraint = version_constraint
-          @force = force
-
-          @found_dependencies = []
-        end
-
-        # Returns the content of the gemspec file with the new/updated dependency
-        #
-        # @param code [String] The content of the gemspec file
-        # @param path [String] This should be the path to the gemspspec file
-        #
-        #   path is used to generate error messages only
-        #
-        # @return [String] The updated gemspec content with the new/added dependency
-        #
-        # @raise [ArgumentError] if the Gem Specification block is not found in the given gemspec
-        #
-        # @example
-        #   code = File.read('project.gemspec')
-        #   add_dependency = Bundler::GemBytes::AddDependency.new(:runtime, 'my_gem', '~> 1.0')
-        #   updated_code = add_dependency.call(code)
-        #   puts updated_code
-        #
-        def call(code, path: '(string)')
-          @found_gemspec_block = false
-          rewrite(*parse(code, path)).tap do |_result|
-            raise ArgumentError, 'Gem::Specification block not found' unless found_gemspec_block
-          end
-        end
-
-        attr_reader :dependency_type, :gem_name, :version_constraint, :force,
-                    :receiver_name, :found_gemspec_block, :found_dependencies
-
-        # Handles block nodes within the AST to locate the Gem Specification block
-        #
-        # @param node [Parser::AST::Node] The block node within the AST
-        # @return [void]
-        # @api private
-        def on_block(node)
-          return if receiver_name # already processing the Gem Specification block
-
-          @found_gemspec_block = true
-          @receiver_name = gem_specification_pattern.match(node)
-
-          return unless receiver_name
-
-          super # process the children of this node to find the existing dependencies
-
-          upsert_dependency(node)
-
-          @receiver_name = nil
-        end
-
-        # Handles `send` nodes within the AST to locate dependency calls
-        #
-        # If receiver_name is not present then we are not in a Gem Specification block.
-        #
-        # @param node [Parser::AST::Node] The `send` node to check for dependency patterns
-        # @return [void]
-        # @api private
-        def on_send(node)
-          return unless receiver_name.present?
-          return unless (match = dependency_pattern.match(node))
-
-          found_dependencies << { node:, match: }
-        end
-
-        private
-
-        # Parses the given code into an AST
-        # @param code [String] The code to parse
-        # @param path [String] The path to the file being parsed (used for error messages only)
-        # @return [Array<Parser::AST::Node, Parser::Source::Buffer>] The AST and buffer
-        # @api private
-        def parse(code, path)
-          buffer = Parser::Source::Buffer.new(path, source: code)
-          processed_source = RuboCop::AST::ProcessedSource.new(code, ruby_version, path)
-          unless processed_source.valid_syntax?
-            raise "Invalid syntax in #{path}\n#{processed_source.diagnostics.map(&:render).join("\n")}"
-          end
-
-          ast = processed_source.ast
-          [buffer, ast]
-        end
-
-        # Adds or updates the given dependency in the Gem::Specification block
-        # @param node [Parser::AST::Node] The block node within the AST
-        # @return [void]
-        # @api private
-        def upsert_dependency(node)
-          if found_dependencies.empty?
-            add_dependency(node)
-          else
-            update_dependency
-          end
-        end
-
-        # Adds a new dependency to the Gem::Specification block
-        # @param node [Parser::AST::Node] The Gem::Specification block node within the AST
-        # @return [void]
-        # @api private
-        def add_dependency(node)
-          insert_after(node.children[2].children.last.loc.expression, "\n  #{dependency_source_code}")
-        end
-
-        # The dependency type (:runtime or :development) based on a given method name
-        # @param method [Symbol] The method name to convert to a dependency type
-        # @return [Symbol] The dependency type
-        # @api private
-        def dependency_method_to_type(method)
-          method == :add_development_dependency ? :development : :runtime
-        end
-
-        # Error message for a dependency type conflict
-        # @param node [Parser::AST::Node] The existing dependency node
-        # @return [String] The error message
-        # @api private
-        def dependency_type_conflict_error(node)
-          # :nocov: JRuby give false positive for this line being uncovered by tests
-          <<~MESSAGE.chomp.gsub("\n", ' ')
-            Trying to add a
-            #{dependency_method_to_type(dependency_type_method).upcase}
-            dependency on "#{gem_name}" which conflicts with the existing
-            #{dependency_method_to_type(node.children[1]).upcase}
-            dependency.
-            Pass force: true to update dependencies where the
-            dependency type is different.
-          MESSAGE
-          # :nocov:
-        end
-
-        # Checks if the given dependency type conflicts with the existing dependency type
-        #
-        # Returns false if {#force} is true.
-        #
-        # @param dependency_node [Parser::AST::Node] The existing dependency node
-        # @return [Boolean] Whether the dependency type conflicts
-        # @api private
-        def dependency_type_conflict?(dependency_node)
-          dependency_node.children[1] != dependency_type_method && !force
-        end
-
-        # The source code for the updated dependency declaration
-        # @param existing_dependency_node [Parser::AST::Node] The existing dependency node
-        # @return [String] The source code for the dependency declaration
-        # @api private
-        def dependency_source_code(existing_dependency_node = nil)
-          # Use existing quote character for string literals
-          q = existing_dependency_node ? existing_dependency_node.children[3].loc.expression.source[0] : "'"
-          "#{receiver_name}.#{dependency_type_method} #{q}#{gem_name}#{q}, #{q}#{version_constraint}#{q}"
-        end
-
-        # Replaces the existing dependency node with the updated dependency declaration
-        # @param dependency_node [Parser::AST::Node] The existing dependency node
-        # @return [void]
-        # @api private
-        def replace_dependency_node(dependency_node)
-          replace(dependency_node.loc.expression, dependency_source_code(dependency_node))
-        end
-
-        # Updates the found_dependencies from the Gem::Specification block
-        # @return [void]
-        # @api private
-        def update_dependency
-          found_dependencies.each do |found_dependency|
-            dependency_node = found_dependency[:node]
-            raise(dependency_type_conflict_error(dependency_node)) if dependency_type_conflict?(dependency_node)
-
-            replace_dependency_node(dependency_node)
-          end
-        end
-
-        # Validates and sets the dependency type
-        # @param dependency_type [Symbol] The type of dependency to add (must be :runtime or :development)
-        # @raise [ArgumentError] if the dependency type is not :runtime or :development
-        # @return [Symbol] The dependency type
-        # @api private
-        def dependency_type=(dependency_type)
-          unless %i[runtime development].include?(dependency_type)
-            message = "Invalid dependency type: #{dependency_type.inspect}"
-            raise(ArgumentError, message)
-          end
-          @dependency_type = dependency_type
-        end
-
-        # Validates and sets the version constraint
-        # @param version_constraint [String] The version constraint to set
-        # @raise [ArgumentError] if the version constraint is invalid
-        # @return [String] The version constraint
-        # @api private
-        def version_constraint=(version_constraint)
-          begin
-            Gem::Requirement.new(version_constraint)
-            true
-          rescue Gem::Requirement::BadRequirementError
-            raise ArgumentError, "Invalid version constraint: #{version_constraint.inspect}"
-          end
-          @version_constraint = version_constraint
-        end
-
-        # Returns the Ruby version in use as a float (MAJOR.MINOR only)
-        # @return [Float] The Ruby version number, e.g., 3.0
-        # @api private
-        def ruby_version = RUBY_VERSION.match(/^(?<version>\d+\.\d+)/)['version'].to_f
-
-        # Determines the dependency method based on the dependency type
-        # @return [Symbol] Either :add_development_dependency or :add_dependency
-        # @api private
-        def dependency_type_method
-          dependency_type == :development ? :add_development_dependency : :add_dependency
-        end
-
-        # The pattern to match a dependency declaration in the AST
-        # @return [RuboCop::AST::NodePattern] The dependency pattern
-        # @api private
-        def dependency_pattern
-          # :nocov: JRuby give false positive for this line being uncovered by tests
-          @dependency_pattern ||=
-            RuboCop::AST::NodePattern.new(<<~PATTERN)
-              (send
-                { (send _ :#{receiver_name}) | (lvar :#{receiver_name}) }
-                ${ :add_dependency :add_runtime_dependency :add_development_dependency }
-                (str #{gem_name ? "$\"#{gem_name}\"" : '$_gem_name'})
-                <(str $_version_constraint) ...>
-              )
-            PATTERN
-          # :nocov:
-        end
-
-        # The pattern to match the Gem::Specification block in the AST
-        # @return [RuboCop::AST::NodePattern] The Gem::Specification pattern
-        # @api private
-        def gem_specification_pattern
-          @gem_specification_pattern ||=
-            RuboCop::AST::NodePattern.new(<<~PATTERN)
-              (block (send (const (const nil? :Gem) :Specification) :new)(args (arg $_)) ...)
-            PATTERN
-        end
-      end
-    end
-  end
-end

data/lib/bundler/gem_bytes/gemspec.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Bundler
-  module GemBytes
-    # The namespec for classes that modify the gemspec file
-    module Gemspec; end
-  end
-end
-
-require_relative 'gemspec/delete_dependency'
-require_relative 'gemspec/upsert_dependency'