[Feature] bundle change by agrim123 · Pull Request #6597 · rubygems/bundler

agrim123 · 2018-06-22T13:05:24Z

Currently, this command uses remove and add internally (reason for so many commits, though only last five, are related to this command).

Closes #6581

segiddins · 2018-06-27T04:07:35Z

Can you change the target branch of this to agr-bundler-remove so it's possible to leave comments on just these changes?

agrim123 · 2018-06-27T07:25:26Z

agr-bundler-remove is on my remote, so I think we will have to wait till it gets merged.

agrim123 · 2018-07-02T05:33:34Z

@segiddins Now this is reviewable 😄

segiddins · 2018-07-03T03:45:43Z

lib/bundler/cli/change.rb

+        require "bundler/cli/add"
+        CLI::Add.new(@pass_options, [@gem_name]).run
+      rescue StandardError => e
+        Bundler.ui.error e


should the error be re-raised instead, after restoring the initial gemfile?

It is shown as error do we need to raise an exception?

yes, we should let the FriendlyErrors module handle showing the error to the user, and ensure we exit with the proper exit code

segiddins · 2018-07-03T03:46:27Z

lib/bundler/cli/change.rb

+
+  private
+
+    def set_version_options


can you add a comment explaining what this method is trying to do ?

segiddins · 2018-07-03T03:47:07Z

lib/bundler/shared_helpers.rb


+    # @param [Pathname] gemfile_path  The Gemfile from which to remove dependencies.
+    # @param [String]  contents       Content to written to Gemfile.
    def write_to_gemfile(gemfile_path, contents)


this should probably just be write_file

segiddins · 2018-07-03T03:47:23Z

spec/commands/change_spec.rb

+    it "throws error" do
+      bundle "change rack"
+
+      expect(out).to include("Please supply atleast one option to change.")


segiddins · 2018-07-03T03:52:27Z

lib/bundler/cli/change.rb

+
+      set_version_options
+
+      @pass_options["source"] = @options[:source] if @options[:source]


should this also handle path/git ?

Should they be editable? We would have to do something to persist them 🤔 as add does not take these flags

Also @segiddins , these are valid keys we also need to persist them! I think we may have to change our approach? Maybe we can use this?

yeah we definitely need to persist all keys

segiddins · 2018-07-11T03:40:43Z

lib/bundler/cli.rb

      "Adds gem to the Gemfile but does not install it"
    method_option "optimistic", :type => :boolean, :banner => "Adds optimistic declaration of version to gem"
    method_option "strict", :type => :boolean, :banner => "Adds strict declaration of version to gem"
+    method_option "pessimistic", :type => :boolean, :banner => "Adds pessimistic declaration of version to gem"


this option needs to be tested

segiddins · 2018-07-11T03:41:03Z

lib/bundler/cli.rb

+      Provide flexibilty of editing gemfile from command line by providing option to change gem properties.
+    D
+    method_option "version", :aliases => "-v", :type => :string
+    method_option "group", :aliases => "-g", :type => :string


let's not add this aliases for now

segiddins · 2018-07-11T03:41:51Z

lib/bundler/cli/change.rb

+        CLI::Add.new(@pass_options, [@gem_name]).run
+      rescue StandardError => e
+        SharedHelpers.write_file(Bundler.default_gemfile, initial_gemfile)
+        FriendlyErrors.log_error(e)


I think instead of this, we should just raise

After rescue then again we should raise error?

yes -- the rescue here is only to restore the initial gemfile

segiddins · 2018-07-11T03:43:35Z

lib/bundler/cli/change.rb

+
+      raise InvalidOption, "`#{@gem_name}` could not be found in the Gemfile." unless @dep
+
+      @pass_options = {}


maybe call this add_options, and instead of making it an ivar, pass it into set_group_options / set_version_options

segiddins · 2018-07-11T03:43:55Z

lib/bundler/cli/change.rb

+
+      definition = Bundler.definition
+
+      @dep = definition.dependencies.find {|d| d.name == @gem_name }


same as below, shouldn't be an ivar

segiddins · 2018-07-11T03:45:20Z

man/bundle-change.ronn

+## DESCRIPTION
+Provide flexibilty of editing gemfile from command line by providing option to change gem properties.
+
+Example:


this example should show the before & after gemfiles

segiddins · 2018-07-11T03:46:21Z

spec/commands/change_spec.rb

+            gem "rspec"
+          end
+
+          gem "rack", "~> 1.0", :group => [:dev1]


this should either be :group => :dev1 or :groups => [:dev1]

We will have to change the injector https://github.com/bundler/bundler/blob/master/spec/commands/add_spec.rb#L72

Handled here

segiddins · 2018-07-11T03:47:06Z

spec/commands/change_spec.rb

+      source "file://#{gem_repo1}"
+
+      gem "rack", "~> 1.0", :group => [:dev]
+      gem "weakling", ">=  0.0.1"


please add a test that changes both of these 2 gems into the test group

segiddins · 2018-07-11T03:47:27Z

spec/commands/change_spec.rb

+      it "changes version of the gem" do
+        bundle! "change rack --version 0.9.1"
+
+        expect(bundled_app("Gemfile").read).to include("gem \"rack\", \"~> 0.9.1\", :group => [:dev]")


use single quotes to avoid having to escape the double quotes

segiddins · 2018-07-11T03:49:35Z

spec/commands/change_spec.rb

+    it "throws error" do
+      bundle "change rake --group dev1"
+
+      expect(out).to include("`rake` could not be found in the Gemfile.")


please test that failure does not change the gemfile

expect { bundle ... }.not_to change { gemfile }

No operation is done on gemfile until this.

right but we should test that that's the case :)

segiddins · 2018-07-17T03:14:25Z

This looks like a great 1st implementation of the bundle change feature to me! Well done @agrim123 !

@colby-swandale @deivid-rodriguez review would be appreciated 🙏

agrim123 · 2018-07-23T07:55:47Z

lib/bundler/cli/change.rb


      raise InvalidOption, "`#{@gem_name}` could not be found in the Gemfile." unless dep

+      check_for_unsupported_options(dep)


I am in process of writing test for this function. Still to figure out how to skip before hook for one test.

Fix for unique groups and specs for mutiple groups

agrim123 · 2019-01-04T18:37:59Z

@segiddins @colby-swandale The milestone seems to be have passed 😅

fatkodima · 2019-11-01T13:40:16Z

Is it just me, but I don't see any benefits of adding and using this? It is much easier to make changes directly in Gemfile and run bundle install/bundle update gemname, than remembering that there is yet another change command and how to use it, what are the arguments.

agrim123 force-pushed the agr-bundle-change branch 3 times, most recently from d4b7f20 to 4831906 Compare June 26, 2018 09:45

agrim123 force-pushed the agr-bundle-change branch 3 times, most recently from 668acd3 to 831214f Compare July 2, 2018 05:32

segiddins reviewed Jul 3, 2018

View reviewed changes

agrim123 force-pushed the agr-bundle-change branch 2 times, most recently from a612020 to d6faf03 Compare July 3, 2018 08:41

segiddins reviewed Jul 11, 2018

View reviewed changes

segiddins requested review from colby-swandale and indirect July 11, 2018 03:49

agrim123 force-pushed the agr-bundle-change branch from dcc43e9 to ec7d142 Compare July 11, 2018 09:36

agrim123 commented Jul 23, 2018

View reviewed changes

agrim123 force-pushed the agr-bundle-change branch from 5c38781 to 4660a3e Compare July 27, 2018 12:02

segiddins approved these changes Jul 29, 2018

View reviewed changes

agrim123 force-pushed the agr-bundle-change branch from 4660a3e to f3a30c5 Compare July 31, 2018 05:04

agrim123 force-pushed the agr-bundle-change branch from f3a30c5 to 8eaa22f Compare August 31, 2018 08:17

agrim123 added 8 commits August 31, 2018 13:47

Add heredoc string to expected_gemfile

8328098

Add specs for inital draft

9af434b

Add remove and add command to change

b0a25a1

Keep version intact when changing other options

9bf8a5f

Keep groups intact when changing other options

b8044f0

add rescue block to prevent undesirable gemfile changes

c35ba32

Add specs for empty options

8161fd6

Fix failing specs

80475a4

agrim123 added 15 commits August 31, 2018 13:47

fix resolver crash when version is >= 0

e20e0eb

Add documentation for bundle change

ef4ca84

Add support for mutiple groups

267ef98

Fix for unique groups and specs for mutiple groups

Add specs for --source

f522377

Add specs to retain optimistic version prefix

63019ca

Change write_to_gemfile to write_file

c18e70a

Use FriendlyErrors to exit with proper code

4543aad

Remove aliases for options

cc6fee8

Add spec for --pessimistic option for add command

0111d05

Remove unnecessary ivars

e795c01

Update documentation

b750e26

Add test for no change in gemfile

adcec42

Add check for unsupported options

352d6e0

Add method to support source option

74ddac3

Fix groups in specs

8eaa22f

colby-swandale modified the milestone: 1.17.0 Oct 9, 2018

deivid-rodriguez mentioned this pull request Dec 13, 2019

removing multiline gem specifications correctly #7454

Closed

hsbt closed this Apr 14, 2021

deivid-rodriguez mentioned this pull request Jul 9, 2021

Provide a way to programmatically update dependency version constraints in the Gemfile ruby/rubygems#3364

Closed


		set_version_options

		@pass_options["source"] = @options[:source] if @options[:source]


		raise InvalidOption, "`#{@gem_name}` could not be found in the Gemfile." unless @dep

		@pass_options = {}


		definition = Bundler.definition

		@dep = definition.dependencies.find {\|d\| d.name == @gem_name }


		raise InvalidOption, "`#{@gem_name}` could not be found in the Gemfile." unless dep

		check_for_unsupported_options(dep)

Uh oh!

Conversation

agrim123 commented Jun 22, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

segiddins commented Jun 27, 2018

Uh oh!

agrim123 commented Jun 27, 2018

Uh oh!

agrim123 commented Jul 2, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

agrim123 Jul 3, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

agrim123 Jul 4, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

agrim123 Jul 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

segiddins commented Jul 17, 2018

Uh oh!

agrim123 Jul 23, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

agrim123 commented Jan 4, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fatkodima commented Nov 1, 2019

Uh oh!

agrim123 commented Jun 22, 2018 •

edited

Loading

agrim123 Jul 3, 2018 •

edited

Loading

agrim123 Jul 4, 2018 •

edited

Loading

agrim123 Jul 11, 2018 •

edited

Loading

agrim123 Jul 23, 2018 •

edited

Loading

agrim123 commented Jan 4, 2019 •

edited

Loading