bundler-gem_bytes 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd1c19bddd6ef1887fcae3ed68a346395ba811b781e2c1321140015a1403e5d1
-  data.tar.gz: d48849f9cf568c0dc3bd2f8b29cd8122b15993650d9bde3fbc41703931970fb7
+  metadata.gz: e081d49425f6d1bb155e06f8a535da63de74ccdc28a694131a116c93dcf5bb18
+  data.tar.gz: 04a13ce95b1d620ca6897ff356718fc7886b13ccc087c2661d9101f31bb3aa5b
 SHA512:
-  metadata.gz: 9a42c3cee7bd326a9564144e2d6029a273be1676eece61bcb9fce50fac5b33e2939e328bef28a5121acdef69352f351c0c251ff16e36b918804b5c1d4935cdf4
-  data.tar.gz: 95be78f3a9535dd2385425e231dae7de2e3bd4c186a9db24db53506eaae3843f293e89b6cf8c9642e14562f849060a1223f005e66286eeeabedc856df83afa83
+  metadata.gz: 861709bf72507d147e63ff1c3cf8b34159ec3ecc8ec12a1a70172afcc1e23d569bc1995db97db14e2eb1c3c5a87a9859a29ea3b9fc366c3780766b64b148c276
+  data.tar.gz: ba3a92619c32912a7d4abb5aee9ab0c0f089a2d6d82e19b819641c7c0ed331b42e5b67f6b79b4e7c8b8374270174d8b2e6fd53ee9948751385cd0825c86fd33a

data/CHANGELOG.md

@@ -5,6 +5,23 @@ All notable changes to the process_executer gem 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).
 
+## v0.2.0 (2024-10-30)
+
+[Full Changelog](https://github.com/main-branch/bundler-gem_bytes/compare/v0.1.0..v0.2.0)
+
+Changes since v0.1.0:
+
+* 96829fd docs: update the releasing guidelines
+* 25c57f9 feat: make #remove_dependency available for gembytes scripts
+* b285af5 docs: add development debugging instructions in the README.md
+* ea05a44 fix: output an informative error when the gemspec parsed is not valid Ruby
+* 2147776 test: add fully integrated test that installs and runs gembytes via bundler
+* ab907b4 test: exclude lines from test coverage due to JRuby false positives
+* 03692ad feat: make #add_dependency available for gembytes scripts
+* 5d41e08 chore: add Bundler::GemBytes::Actions module to extend the API for gembytes scripts
+* 6f7be90 chore: add class to upsert a gem dependency into a gemspec
+* cf1ab4f chore: rake clobber should remove the .bundle directory
+
 ## v0.1.0 (2024-10-17)
 
 [Full Changelog](https://github.com/main-branch/bundler-gem_bytes/compare/ce13f25..v0.1.0)

data/README.md

@@ -39,6 +39,8 @@ own script**
   * [Example](#example)
   * [Handling Errors](#handling-errors)
 * [Development](#development)
+  * [Debugging](#debugging)
+  * [Releasing](#releasing)
 * [Contributing](#contributing)
   * [Commit message guidelines](#commit-message-guidelines)
   * [Pull request guidelines](#pull-request-guidelines)
@@ -47,7 +49,7 @@ own script**
 
 ## Installation
 
-Install this bundler plugin as follows:
+Install the `bundler gem-bytes` command as follows:
 
 ```shell
 bundle plugin install bunder-gem_bytes
@@ -79,41 +81,54 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 workflow. You can also run `bin/console` for an interactive prompt that will allow
 you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push git
-commits and the created tag, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
+### Debugging
 
-To install this bundler plugin from the source code, run the following command from
-the project's root directory:
+To debug this gem it is recommended that you create a test project and install
+this plugin with bundler from source code as follows:
 
 ```shell
-bundler plugin install --path . bundler-gem_bytes
-```
+# 1. Create a temp directory for testing (from the root directory of the project)
+mkdir temp
+cd temp
 
-and then run `bundler plugin list` to make sure it was installed correctly:
+# 2. Create an new, empty RubyGem project to test
+BUNDLE_IGNORE_CONFIG=TRUE bundle gem foo --no-test --no-ci --no-mit --no-coc --no-linter --no-changelog
+cd foo
 
-```shell
-$ bundler plugin list
-bundler-gem_bytes
------
-  gem-bytes
+# 3. Install the plugin from source
+BUNDLE_IGNORE_CONFIG=TRUE bundle plugin install --path ../.. bundler-gem_bytes
 
-$
-```
+# 4. Create a gembytes script to add a development dependency on rubocop
+cat <<SCRIPT > gem_bytes_script.rb
+add_dependency :development, "rubocop", "~> 1.6"
+SCRIPT
 
-Once installed, the bundler plugin can be run with the following command:
+# 5. Modify code, set breakpoints, or add binding.{irb|pry} calls to the source
 
-```shell
-bundler gem-bytes
+# 6. Run the plugin
+BUNDLE_IGNORE_CONFIG=TRUE bundle gem-bytes gem_bytes_script.rb
+
+# Repeat 4 - 6 until satisified :)
 ```
 
-To uninstall the plugin, run:
+### Releasing
 
-```shell
-bundler uninstall bundler-gem_bytes
-```
+To release a new version of this gem, run `create-github-release [TYPE]` where
+TYPE is MAJOR, MINOR, or PATCH according to SemVer based on the changes that
+have been made since the last release:
+
+* MAJOR: changes that break compatibility with previous versions, such as removing a
+  public method, changing a method signature, or modifying the expected behavior of a
+  method.
+* MINOR: changes that add new features, enhance existing features, or deprecate
+  features in a backward-compatible way, such as adding a new method or improving
+  performance without breaking existing functionality.
+* PATCH: changes that fix bugs or make other small modifications that do not affect
+  the API or alter existing functionality, such as fixing user-facing typos or
+  updating user documentation.
+
+This command must be run from the project root directory with a clean worktree on the
+default branch.
 
 ## Contributing
 

data/Rakefile

@@ -85,3 +85,4 @@ end
 
 CLOBBER << 'package-lock.json'
 CLOBBER << 'node_modules'
+CLOBBER << '.bundle'

data/lib/bundler/gem_bytes/actions.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_bytes'
+
+module Bundler
+  module GemBytes
+    # The API for GemBytes templates
+    # @api public
+    module Actions
+      # Adds (or updates) a dependency in the project's gemspec file
+      #
+      # @example
+      #   add_dependency(:development, 'rspec', '~> 3.13')
+      #   add_dependency(:runtime, 'activesupport', '>= 6.0.0')
+      #
+      # @param dependency_type [Symbol] the type of dependency to add (either :development or :runtime)
+      # @param gem_name [String] the name of the gem to add
+      # @param version_constraint [String] the version constraint for the gem
+      # @param force [Boolean] whether to overwrite the existing dependency
+      # @param gemspec [String] the path to the gemspec file
+      #
+      # @return [void]
+      #
+      # @api public
+      #
+      def add_dependency(dependency_type, gem_name, version_constraint, force: false, gemspec: Dir['*.gemspec'].first)
+        source = File.read(gemspec)
+        updated_source = Bundler::GemBytes::Gemspec::UpsertDependency.new(
+          dependency_type, gem_name, version_constraint, force: force
+        ).call(source, path: gemspec)
+        File.write(gemspec, updated_source)
+      end
+
+      # Removes a dependency from the project's gemspec file
+      #
+      # @example
+      #   remove_dependency('rspec')
+      #
+      # @param gem_name [String] the name of the gem to add
+      # @param gemspec [String] the path to the gemspec file
+      #
+      # @return [void]
+      #
+      # @api public
+      #
+      def remove_dependency(gem_name, gemspec: Dir['*.gemspec'].first)
+        source = File.read(gemspec)
+        updated_source = Bundler::GemBytes::Gemspec::DeleteDependency.new(gem_name).call(source, path: gemspec)
+        File.write(gemspec, updated_source)
+      end
+    end
+  end
+end

data/lib/bundler/gem_bytes/bundler_command.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'bundler'
+
 module Bundler
   module GemBytes
     # A bundler command that adds features to your existing Ruby Gems project

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

@@ -0,0 +1,216 @@
+# 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

@@ -0,0 +1,336 @@
+# 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

@@ -0,0 +1,11 @@
+# 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'

data/lib/bundler/gem_bytes/script_executor.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-# require 'pp'
 require 'thor'
-require 'uri'
+require_relative 'actions'
 
 module Bundler
   module GemBytes
@@ -13,8 +12,9 @@ module Bundler
     # @example Executing a script from a file or URI
     #   executor = Bundler::GemBytes::ScriptExecutor.new
     #   executor.execute('path_or_uri_to_script')
-    class ScriptExecutor < Thor::Group
-      include Thor::Actions
+    class ScriptExecutor < ::Thor::Group
+      include ::Thor::Actions
+      include Bundler::GemBytes::Actions
 
       # Set the source paths for Thor to use
       # @return [Array<String>] the source paths

data/lib/bundler/gem_bytes/version.rb

@@ -3,6 +3,6 @@
 module Bundler
   module GemBytes
     # The version of this gem
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/bundler/gem_bytes.rb

@@ -13,6 +13,10 @@ module Bundler
   end
 end
 
+require 'active_support'
+require 'thor'
+
 require_relative 'gem_bytes/bundler_command'
+require_relative 'gem_bytes/gemspec'
 require_relative 'gem_bytes/script_executor'
 require_relative 'gem_bytes/version'

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: bundler-gem_bytes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Couball
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-17 00:00:00.000000000 Z
+date: 2024-10-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: process_executer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: simplecov-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +192,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: turnip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -185,7 +269,11 @@ files:
 - README.md
 - Rakefile
 - lib/bundler/gem_bytes.rb
+- lib/bundler/gem_bytes/actions.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
@@ -197,8 +285,8 @@ 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.1.0
-  changelog_uri: https://rubydoc.info/gems/bundler-gem_bytes/0.1.0/file/CHANGELOG.md
+  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
   bug_tracker_uri: https://github.com/main-branch/bundler-gem_bytes/issues
   rubygems_mfa_required: 'true'
 post_install_message: