bundler-gem_bytes 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd1c19bddd6ef1887fcae3ed68a346395ba811b781e2c1321140015a1403e5d1
-  data.tar.gz: d48849f9cf568c0dc3bd2f8b29cd8122b15993650d9bde3fbc41703931970fb7
+  metadata.gz: ad62897e0c19142e68da32d5cc2b63e1c2622beeaa9ecda235b48679f50ab3e2
+  data.tar.gz: e3a1340866ca56329fc9d03e4acae7dd1357ac288551ac6c196c79180d5818ff
 SHA512:
-  metadata.gz: 9a42c3cee7bd326a9564144e2d6029a273be1676eece61bcb9fce50fac5b33e2939e328bef28a5121acdef69352f351c0c251ff16e36b918804b5c1d4935cdf4
-  data.tar.gz: 95be78f3a9535dd2385425e231dae7de2e3bd4c186a9db24db53506eaae3843f293e89b6cf8c9642e14562f849060a1223f005e66286eeeabedc856df83afa83
+  metadata.gz: 64d2885ac473cea7a79cd7a48a04681ea9d60d0b3e027db73f64b622c827d49656aaf06c7c02b6f4bc46ff2c058b5b6b547f2545714a8d3886c55409a2b70f0e
+  data.tar.gz: 0f226e9914850042449dfd32b190f1f5f3b129ab16b334afa624489bf8633222ba18104017d4489fa820dcd12bb907ea3c89c8aeea80f7bc5a798d763e758fef

data/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.2.2"
+}

data/CHANGELOG.md

@@ -5,6 +5,44 @@ 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).
 
+## [0.2.2](https://github.com/main-branch/bundler-gem_bytes/compare/v0.2.1...v0.2.2) (2025-04-16)
+
+
+### Bug Fixes
+
+* Automate commit-to-publish workflow version file path wrong ([4220bd4](https://github.com/main-branch/bundler-gem_bytes/commit/4220bd4428cc4841d56c65fb86540d9237b0944b))
+
+## [0.2.1](https://github.com/main-branch/bundler-gem_bytes/compare/v0.2.0...v0.2.1) (2025-04-16)
+
+
+### Features
+
+* Add a gemspec action to make modification to a project gemspec ([d83d145](https://github.com/main-branch/bundler-gem_bytes/commit/d83d14598922fe8b54de12b92232e8cae6e6e668))
+* Add the remove_dependency sub-action to the gemspec action ([ba1ff7b](https://github.com/main-branch/bundler-gem_bytes/commit/ba1ff7b8401ff7dd29c37f457da14452ce55c8f2))
+
+
+### Bug Fixes
+
+* Allow dependencies to have multiple version constraints ([4217151](https://github.com/main-branch/bundler-gem_bytes/commit/421715118af964e5e53ae35cda445e5b2dfd4f48))
+* Automate commit-to-publish workflow ([3d018da](https://github.com/main-branch/bundler-gem_bytes/commit/3d018da4b2ac3caceaa81dd12a0b7771fc03db18))
+
+## 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

@@ -7,9 +7,6 @@ Version](https://badge.fury.io/rb/bundler-gem_bytes.svg)](https://badge.fury.io/
 Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/bundler-gem_bytes/file/CHANGELOG.md)
 [![Build
 Status](https://github.com/main-branch/bundler-gem_bytes/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/main-branch/bundler-gem_bytes/actions/workflows/continuous-integration.yml)
-[![Maintainability](https://api.codeclimate.com/v1/badges/2468fc247e5d66fc179f/maintainability)](https://codeclimate.com/github/main-branch/bundler-gem_bytes/maintainability)
-[![Test
-Coverage](https://api.codeclimate.com/v1/badges/2468fc247e5d66fc179f/test_coverage)](https://codeclimate.com/github/main-branch/bundler-gem_bytes/test_coverage)
 [![Conventional
 Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
 [![Slack](https://img.shields.io/badge/slack-main--branch/bundler--gem_bytes-yellow.svg?logo=slack)](https://main-branch.slack.com/archives/C07RKRKTLDT)
@@ -36,18 +33,21 @@ own script**
 
 * [Installation](#installation)
 * [Usage](#usage)
-  * [Example](#example)
-  * [Handling Errors](#handling-errors)
+    * [Example](#example)
+    * [Handling Errors](#handling-errors)
 * [Development](#development)
+    * [How this gem works](#how-this-gem-works)
+    * [Debugging](#debugging)
+    * [Releasing](#releasing)
 * [Contributing](#contributing)
-  * [Commit message guidelines](#commit-message-guidelines)
-  * [Pull request guidelines](#pull-request-guidelines)
+    * [Commit message guidelines](#commit-message-guidelines)
+    * [Pull request guidelines](#pull-request-guidelines)
 * [License](#license)
 * [Code of Conduct](#code-of-conduct)
 
 ## Installation
 
-Install this bundler plugin as follows:
+Install the `bundler gem-bytes` command as follows:
 
 ```shell
 bundle plugin install bunder-gem_bytes
@@ -79,42 +79,106 @@ 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).
+### How this gem works
 
-To install this bundler plugin from the source code, run the following command from
-the project's root directory:
+1. The user runs the `bundler gem-bytes` command from the command line, passing the
+   path or URL to a GemBytes script:
 
-```shell
-bundler plugin install --path . bundler-gem_bytes
-```
+   ```shell
+   bundler gem-bytes [SCRIPT]
+   ```
 
-and then run `bundler plugin list` to make sure it was installed correctly:
+2. The `plugins.rb` file (in the root directory of this project) defines
+   `Bundler::GemBytes::BundlerCommand` class as the handler for the `gem-bytes`
+   bundler command:
 
-```shell
-$ bundler plugin list
-bundler-gem_bytes
------
-  gem-bytes
+    ```ruby
+    require 'bundler/gem_bytes'
 
-$
-```
+    # Register Bundler::GemBytes::BundlerCommand as the handler for the `gem-bytes`
+    # bundler command
 
-Once installed, the bundler plugin can be run with the following command:
+    Bundler::Plugin::API.command('gem-bytes', Bundler::GemBytes::BundlerCommand)
+    ```
 
-```shell
-bundler gem-bytes
-```
+3. Bundler invokes the gem-bytes plugin by creating an instance of
+   `Bundler::GemBytes::BundlerCommand` and then calling `#exec(command, args)` on
+   that instance. Where:
+
+   * `command` is the bundler command given on the command line. It will always be
+     "gem-bytes".
+   * `args` is the array of any other arguments given on the command line after the
+     command. In this case, we expect the script path or URI.
+
+4. The `BundlerCommand` instance creates a `Bundler::GemBytes::ScriptExecutor`
+   instance and calls `#execute(path_or_uri)` on that instance. This method in turn
+   calls `Thor::Actions#apply(path_or_uri)` to load the external script and execute
+   it in the context of the `ScriptExecutor` instance.
 
-To uninstall the plugin, run:
+   The `#apply` method, part of the `Thor::Actions` module, loads and executes the
+   script within the context of the `ScriptExecutor` instance.
+
+   If an error occurs during script execution, `BundlerCommand` catches the error, outputs an error message to `stderr`, and exits with a status code of `1`.
+
+5. The `ScriptExecutor` class provides the environment/binding in which the GemBytes
+   script is executed, allowing the script to use instance methods and context from
+   `ScriptExecutor`. In addition to core Ruby and Active Support, the API available
+   to this script includes methods from both the
+   [`Thor::Actions`](https://github.com/rails/thor/wiki/Actions) and
+   `Bundler::GemBytes::Actions` modules, which provide utilities for file
+   manipulation, template generation, and other tasks essential for script execution.
+
+### Debugging
+
+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 uninstall bundler-gem_bytes
+# 1. Create a temp directory for testing (from the root directory of the project)
+mkdir temp
+cd temp
+
+# 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
+
+# 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
+gemspec do
+  add_development_dependency "rubocop", "~> 1.68"
+end
+SCRIPT
+
+# 5. Modify code, set breakpoints, or add binding.{irb|pry} calls to the source
+
+# 6. Run the plugin
+BUNDLE_IGNORE_CONFIG=TRUE bundle gem-bytes gem_bytes_script.rb
+
+# Repeat 4 - 6 until satisified :)
 ```
 
+### Releasing
+
+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
 
 Bug reports and pull requests are welcome on GitHub at
@@ -158,3 +222,36 @@ License](https://opensource.org/licenses/MIT).
 Everyone interacting in the Bundler::GemBytes project's codebases, issue trackers,
 chat rooms and mailing lists is expected to follow the [code of
 conduct](https://github.com/main-branch/bundler-gem_bytes/blob/main/CODE_OF_CONDUCT.md).
+
+gemspec path do |spec_var, spec|
+  add_dependency 'example', '~> 1.1'
+  add_runtime_dependency 'example', '~> 1.1', '>= 1.1.4'
+  add_development_dependency "rubocop", "~> 1.68"
+
+  remove_dependency "example"
+
+  attr "description", "#{spec.description}. Enhanced by GemBytes."
+  attr "author", ENV['USER']
+  attr "files", "Dir['lib/**/*.rb'] + Dir['bin/*']", quote: false
+  attr "authors", <% spec.authors %>.append('GemBytes').inspect, quote: false
+
+  remove_attr "license"
+
+  metadata "homepage_url", "https://github.com/example/"
+
+  remove_metadata "wiki_uri"
+
+  in_block("if RUBY_PLATFORM != 'java'", "end") do
+    development_dependency 'redcarpet', '~> 3.5'
+    development_dependency 'yard', '~> 0.9'
+    development_dependency 'yardstick', '~> 0.9'
+  end
+
+  code <<~CODE
+    if RUBY_PLATFORM != 'java'
+      <%= spec_var %>.add_development_dependency 'redcarpet', '~> 3.5'
+      <%= spec_var %>.add_development_dependency 'yard', '~> 0.9'
+      <%= spec_var %>.add_development_dependency 'yardstick', '~> 0.9'
+    end
+  CODE
+end

data/Rakefile

@@ -25,6 +25,13 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 
+# Make it so that calling `rake release` just calls `rake release:rubygems_push` to
+# avoid creating and pushing a new tag.
+
+Rake::Task['release'].clear
+desc 'Customized release task to avoid creating a new tag'
+task release: 'release:rubygem_push'
+
 CLEAN << 'pkg'
 CLOBBER << 'Gemfile.lock'
 
@@ -56,6 +63,7 @@ unless RUBY_PLATFORM == 'java'
 
     YARD::Rake::YardocTask.new(:build) do |t|
       t.files = %w[lib/**/*.rb examples/**/*]
+      t.options = ['--markup-provider', 'redcarpet', '--markup', 'markdown']
       t.stats_options = ['--list-undoc']
     end
 
@@ -85,3 +93,4 @@ end
 
 CLOBBER << 'package-lock.json'
 CLOBBER << 'node_modules'
+CLOBBER << '.bundle'

data/lib/bundler/gem_bytes/actions/gemspec/attribute.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'parser/current'
+require 'rubocop-ast'
+require 'active_support/core_ext/object'
+
+module Bundler
+  module GemBytes
+    module Actions
+      class Gemspec < Parser::TreeRewriter
+        # Holds the components of a attribute: a name and a value
+        #
+        # @api public
+        #
+        # Attributes in the gemspec look like the following:
+        #
+        # ```ruby
+        # Gem::Specification.new do |spec|
+        #   spec.name = 'test'
+        # end
+        # ```
+        #
+        # @!attribute [r] name
+        #   The name of the attribute
+        #   @example
+        #     attribute.name #=> "test"
+        #
+        #   @return [String]
+        #   @api public
+        #
+        # @!attribute [r] value
+        #   The value of the attribute expressed as an AST tree
+        #   @example
+        #     attribute.value.to_sexp #=> 's(:str, "my_description")'
+        #   @return [Parser::AST::Node]
+        #   @api public
+        #
+        # @!method to_a()
+        #   Converts the attribute into an array
+        #   @example
+        #     dependency.to_a #=> ["description", [:str, "my_description"]]
+        #   @return [Array]
+        #   @api public
+        #
+        Attribute = Struct.new(:name, :value) do
+          def to_a = [name, value.to_sexp_array]
+        end
+      end
+    end
+  end
+end

data/lib/bundler/gem_bytes/actions/gemspec/attribute_node.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'parser/current'
+require 'rubocop-ast'
+require 'active_support/core_ext/object'
+
+module Bundler
+  module GemBytes
+    module Actions
+      class Gemspec < Parser::TreeRewriter
+        # Maps a dependency declaration to the AST that represents it
+        # @api public
+        #
+        # @!attribute [r] node
+        #   The AST node for the attribute
+        #   @example
+        #     attribute_node.node #=> ...
+        #   @return [Parser::AST::Node]
+        #   @api public
+        #
+        # @!attribute [r] attribute
+        #   The components of the attribute from the AST node
+        #   @example
+        #     attribute_node.attribute.to_a #=> ["description", [:str, "My deescription"]]
+        #   @return [Dependency]
+        #   @api public
+        #
+        AttributeNode = Struct.new(:node, :attribute)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'parser/current'
+require 'rubocop-ast'
+require 'active_support/core_ext/object'
+
+module Bundler
+  module GemBytes
+    module Actions
+      class Gemspec < Parser::TreeRewriter
+        # Remove a dependency in a gemspec
+        #
+        # If a dependency on the given gem is not found, this action does nothing.
+        #
+        # If one or more dependencies are found on the same gem as gem_name,
+        # the are removed from the gemspec.
+        #
+        # The gemspec is updated via calls to the tree_rewriter object.
+        #
+        # @!attribute [r] tree_rewriter
+        #   The object that updates the source
+        #   @return [Parser::TreeRewriter]
+        #   @api private
+        #
+        # @!attribute [r] gemspec_block
+        #   The root AST node of the Gem::Specification block from the gemspec
+        #   @return [Parser::AST::Node]
+        #   @api private
+        #
+        # @!attribute [r] receiver_name
+        #   The name of the receiver for the Gem::Specification block
+        #   @return [Symbol]
+        #   @api private
+        #
+        # @!attribute [r] dependencies
+        #   The dependency declarations found in the gemspec file
+        #   @return [Array<DependencyNode>]
+        #   @api private
+        #
+        # @!attribute [r] gem_name
+        #   The name of the gem to remove dependency on
+        #   @return [String]
+        #   @api private
+        #
+        # @api public
+        class DeleteDependency
+          # Initializes the delete dependency action
+          # @param tree_rewriter [Parser::TreeRewriter] The object that updates the source
+          # @param gemspec_block [Parser::AST::Node] The Gem::Specification block
+          # @param receiver_name [Symbol] The name of the receiver for the Gem::Specification block
+          # @param dependencies [Array<DependencyNode>] The dependency declarations found in the gemspec file
+          # @api private
+          def initialize(tree_rewriter, gemspec_block, receiver_name, dependencies)
+            @tree_rewriter = tree_rewriter
+            @gemspec_block = gemspec_block
+            @receiver_name = receiver_name
+            @dependencies = dependencies
+          end
+
+          attr_reader :tree_rewriter, :gemspec_block, :receiver_name, :dependencies, :gem_name
+
+          # Adds or updates a dependency to the Gem::Specification block
+          #
+          # @example
+          #   delete_dependency = DeleteDependency.new(tree_rewriter, gemspec_block, receiver_name, dependencies)
+          #   gem_name = 'rubocop'
+          #   depete_dependency.call(gem_name)
+          # @param gem_name [String] The name of the gem to remove dependency on
+          # @return [void]
+          # @api public
+          def call(gem_name)
+            @gem_name = gem_name
+            matching_dependencies = dependencies.select { |d| d.dependency.gem_name == gem_name }
+
+            delete_dependencies(matching_dependencies) if matching_dependencies.any?
+          end
+
+          # Removes the matching dependencies from the gemspec
+          # @param matching_dependencies [Array<DependencyNode>] The existing dependencies that match gem_name
+          # @return [void]
+          # @api private
+          def delete_dependencies(matching_dependencies)
+            matching_dependencies.each do |found_dependency|
+              tree_rewriter.replace(full_line_range(found_dependency), '')
+            end
+          end
+
+          private
+
+          # Expand the range for a node to include any leading whitespace and newline
+          # @param dependency_node [DependencyNode] The node to remove
+          # @return [Parser::Source::Range] The range of the whole line including whitespace
+          # @api private
+          def full_line_range(dependency_node)
+            range = dependency_node.node.loc.expression
+            source_buffer = range.source_buffer
+            # The whole line including leading and trailing whitespace
+            line_range = source_buffer.line_range(range.line)
+            # Expand the range to include the leading newline
+            line_range.with(begin_pos: line_range.begin_pos - 1)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bundler/gem_bytes/actions/gemspec/dependency.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'parser/current'
+require 'rubocop-ast'
+require 'active_support/core_ext/object'
+
+module Bundler
+  module GemBytes
+    module Actions
+      class Gemspec < Parser::TreeRewriter
+        # Holds the components of a dependency declaration
+        #
+        # @api public
+        #
+        # A dependency declaration is a call to `add_dependency`,
+        # `add_runtime_dependency`, or `add_development_dependency` in the
+        # Gem::Specification block.
+        #
+        # For example, the following is a dependency declaration:
+        #
+        # ```ruby
+        # spec.add_dependency 'rubocop', '~> 1.0'
+        # ```
+        #
+        # Would be represented by a Dependency object with the following
+        # attributes:
+        #   * method_name: :add_dependency
+        #   * gem_name: 'rubocop'
+        #   * version_constraint: '~> 1.0'
+        #
+        # @!attribute [r] method_name
+        #   The name of the method called to add the dependency
+        #
+        #   Must be one of the following:
+        #
+        #   * :add_dependency
+        #   * :add_runtime_dependency
+        #   * :add_development_dependency
+        #
+        #   @example
+        #     dependency.method_name #=> :add_dependency
+        #
+        #   @return [Symbol]
+        #   @api public
+        #
+        # @!attribute [r] gem_name
+        #   The name of the gem being depended on
+        #   @example
+        #     dependency.gem_name #=> "rubocop"
+        #   @return [String]
+        #   @api public
+        #
+        # @!attribute [r] version_constraints
+        #   The version constraints for the dependency
+        #   @example
+        #     dependency.version_constraints #=> ["~> 1.68", ">= 1.68.3"]
+        #   @return [Array<String>]
+        #   @api public
+        #
+        # @!method to_a()
+        #   Converts the dependency into an array
+        #   @example
+        #     dependency.to_a #=> [:add_runtime_dependency, "rubocop", "~> 1.68"]
+        #   @return [Array]
+        #   @api public
+        #
+        Dependency = Struct.new(:method_name, :gem_name, :version_constraints) do
+          def to_a = [method_name, gem_name, *version_constraints]
+        end
+      end
+    end
+  end
+end

data/lib/bundler/gem_bytes/actions/gemspec/dependency_node.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'parser/current'
+require 'rubocop-ast'
+require 'active_support/core_ext/object'
+
+module Bundler
+  module GemBytes
+    module Actions
+      class Gemspec < Parser::TreeRewriter
+        # Maps a dependency declaration to the AST that represents it
+        # @api public
+        #
+        # @!attribute [r] node
+        #   The AST node for the dependency declaration
+        #   @example
+        #     dependency_node.node #=> ...
+        #   @return [Parser::AST::Node]
+        #   @api public
+        #
+        # @!attribute [r] dependency
+        #   The components of the dependency declaration from the AST node
+        #   @example
+        #     dependency_node.dependency.to_a #=> [:add_dependency, 'rubocop', '~> 1.68']
+        #   @return [Dependency]
+        #   @api public
+        #
+        DependencyNode = Struct.new(:node, :dependency)
+      end
+    end
+  end
+end