diffend 0.2.19 → 0.2.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f18edf14b16e7f2ec3ce0c574ade976e78e3eac84f8395e45fc53595a8e3f91
-  data.tar.gz: 292e755dac0d191787b77fb8556b5e2f90f9e040ee9e28486de90601b2c2a67c
+  metadata.gz: f6539b727e33d38eb0b3fb6f38f25c3fd2abda05f337f50af2db1fe135575510
+  data.tar.gz: c6808082290c195a846117fd4c16a4fa4cb20f65cc289cbadbd71532f8ae5713
 SHA512:
-  metadata.gz: 73326da64425debc8c27ad1dd216df34313a45795a2c6f555d0e5df067dfc17977ae9ee6e8307ab1df33af58a87ca23511ed3920eaa9c0bcec566fef602c30c3
-  data.tar.gz: eabf666e6c1ef7a08afaadf519011edac2416f0a2fa13152a9112b898b94dde1f598f23866a9823220be308aa091d9dab6b6d03e95191f3d22ba43509d3933fa
+  metadata.gz: 9eb4e7749b9a9a0824770921d150e180ed5b40ba19a7f22d1f65154474347110221dc96049c2b4b5d7136c850c5775c07bc4e840b005dda13043742ac74238d2
+  data.tar.gz: 427d6b00c913174e535de300020f8fe715bda9b3f946f1fbe25906dfa734bb4dd3c349735470fbacb9740c287dd5252bcf6b481e40120daba3138afda6f334e9

checksums.yaml.gz.sig

@@ -1,2 +1,2 @@
-�4��
--���s?�<>�sQ�W��fAR�� ��Y�|��
-?�4n�o}s�Y��m��J��Y���r*L>6J��8�\��~[�Ş�5Y��ՃF4��0'�e��cG�����0�Ӆ��l��Ć�*���*�mx9d�l���+
+�Ęk�oش�_��Ip��B�GZ�hήO���D�[���S�;��o��x�"Q�������#I�	�ir�h����H��o����E��R^��[Ñ~����fg*��ᢩ{H-�s'�:��2cI�NX��r]w˛�	�qo���$��_�5�9��.G�H�P�
+������2��LE>��=�L$6�;Y��{���`{�=��G���_�JĬ��V{#jB-G!b��*{�T9=	��_cC��7��̂̈́V�9>m*Fs����0���0�$�X�:u4�����"
�5�D��{K9CIz`�K�1��O�P��Py��Ѱ�3����\���_����S:��<;�vA�
���9�;�@�+#�&�

data/.github/workflows/ci.yml

@@ -9,6 +9,9 @@ jobs:
       matrix:
         ruby:
           - '2.7'
+          - '2.6'
+          - '2.5'
+          - 'jruby'
         include:
           - ruby: '2.7'
             coverage: 'true'
@@ -31,6 +34,8 @@ jobs:
         run: |
           gem install bundler --no-document
       - name: Bundle install
+        env:
+          DIFFEND_DEVELOPMENT: true
         run: |
           bundle config path vendor/bundle
           bundle install --jobs 4 --retry 3

data/CHANGELOG.md

@@ -2,6 +2,44 @@
 
 ## [Unreleased][master]
 
+## [0.2.27] (2020-09-16)
+- introduce `Diffend::RequestObject` ([#40](https://github.com/diffend-io/diffend-ruby/pull/40))
+- clean up error codes and introduce `DIFFEND_INGORE_EXCEPTIONS` ([#41](https://github.com/diffend-io/diffend-ruby/pull/41))
+- introduce `Diffend::Monitor` and `Diffend::Track` ([#15](https://github.com/diffend-io/diffend-ruby/pull/15))
+
+## [0.2.26] (2020-09-10)
+- introduce `DIFFEND_DEVELOPMENT` environment variable ([#36](https://github.com/diffend-io/diffend-ruby/pull/36))
+- adjust message for allow verdict ([#37](https://github.com/diffend-io/diffend-ruby/pull/37))
+- do not run the plugin when it is not enabled ([#38](https://github.com/diffend-io/diffend-ruby/pull/38))
+
+## [0.2.25] (2020-09-09)
+- add support for a warn verdict ([#34](https://github.com/diffend-io/diffend-ruby/pull/34))
+
+## [0.2.24] (2020-09-08)
+- better error handling of response ([#28](https://github.com/diffend-io/diffend-ruby/pull/28))
+- fix jruby specs ([#29](https://github.com/diffend-io/diffend-ruby/pull/29))
+- handle request server errors ([#30](https://github.com/diffend-io/diffend-ruby/pull/30))
+- better detection of gem source ([#31](https://github.com/diffend-io/diffend-ruby/pull/31))
+- detect if we are running outdated version of the plugin ([#32](https://github.com/diffend-io/diffend-ruby/pull/32))
+
+## [0.2.23] (2020-09-06)
+- fix how we build gem platform ([#26](https://github.com/diffend-io/diffend-ruby/pull/26))
+- test against jruby, ruby-2.5 and ruby-2.6 ([#25](https://github.com/diffend-io/diffend-ruby/pull/25))
+
+## [0.2.22] (2020-09-03)
+- fix how we build host command
+
+## [0.2.21] (2020-09-03)
+- bring back support for ruby 2.5.x
+
+## [0.2.20] (2020-09-03)
+- expose host command ([#21](https://github.com/diffend-io/diffend-ruby/pull/21))
+- expose host pid ([#20](https://github.com/diffend-io/diffend-ruby/pull/20))
+- use `Bundler.feature_flag.default_cli_command` which is used as the default task if no command provided, instead of `Diffend::Commands::INSTALL` ([#19](https://github.com/diffend-io/diffend-ruby/pull/19))
+- better error handling ([#18](https://github.com/diffend-io/diffend-ruby/pull/18))
+- better detection of gem versions ([#17](https://github.com/diffend-io/diffend-ruby/pull/17))
+- introduce `Diffend::BuildBundlerDefinition` ([#16](https://github.com/diffend-io/diffend-ruby/pull/16))
+
 ## [0.2.19] (2020-08-18)
 
 - better detection of gem sources ([#13](https://github.com/diffend-io/diffend-ruby/pull/13))
@@ -22,7 +60,15 @@
 
 - initial release
 
-[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.19...HEAD
+[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.27...HEAD
+[0.2.27]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.26...v0.2.27
+[0.2.26]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.25...v0.2.26
+[0.2.25]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.24...v0.2.25
+[0.2.24]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.23...v0.2.24
+[0.2.23]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.22...v0.2.23
+[0.2.22]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.21...v0.2.22
+[0.2.21]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.20...v0.2.21
+[0.2.20]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.19...v0.2.20
 [0.2.19]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.18...v0.2.19
 [0.2.18]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.17...v0.2.18
 [0.2.17]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.16...v0.2.17

data/Gemfile

@@ -7,6 +7,7 @@ plugin 'diffend'
 gemspec
 
 group :development, :test do
-  gem 'byebug'
+  gem 'byebug', platform: :ruby
+  gem 'pry', platform: :jruby
   gem 'rspec'
 end

data/Gemfile.lock

@@ -1,13 +1,20 @@
 PATH
   remote: .
   specs:
-    diffend (0.2.19)
+    diffend (0.2.27)
 
 GEM
   remote: https://rubygems.org/
   specs:
     byebug (11.1.3)
+    coderay (1.1.3)
     diff-lcs (1.4.4)
+    ffi (1.13.1-java)
+    method_source (1.0.0)
+    pry (0.13.1-java)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+      spoon (~> 0.0)
     rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -22,14 +29,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    spoon (0.0.6)
+      ffi
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES
   bundler
   byebug
   diffend!
+  pry
   rake
   rspec
 

data/lib/diffend.rb

@@ -5,16 +5,23 @@
 ].each(&method(:require))
 
 %w[
+  build_bundler_definition
   errors
   config/fetcher
   config/file_finder
   config/validator
   commands
+  handle_errors/messages
+  handle_errors/build_exception_payload
+  handle_errors/display_to_stdout
+  handle_errors/report
+  request_object
+  request
   voting
+  track
 ].each { |file| require "diffend/#{file}" }
 
 %w[
-  request
   versions/local
   versions/remote
 ].each { |file| require "diffend/voting/#{file}" }
@@ -22,7 +29,7 @@
 # Diffend main namespace
 module Diffend
   # Current plugin version
-  VERSION = '0.2.19'
+  VERSION = '0.2.27'
   # Diffend homepage
   HOMEPAGE = 'https://diffend.io'
 
@@ -30,35 +37,106 @@ module Diffend
     # Registers the plugin and add before install all hook
     def register
       Bundler::Plugin.add_hook('before-install-all') do |_|
-        Diffend::Voting.call(
-          command,
-          build_definition(command)
-        )
+        execute
       end
     end
 
-    # Build clean instance of bundler definition, as we don't want to pollute the main one
-    #
-    # @param command [String] bundler command that we are executing
-    #
-    # @return [Bundler::Definition]
-    def build_definition(command)
-      unlock = command == 'update' ? true : nil
+    # Execute diffend plugin
+    def execute
+      return unless enabled?
+
+      verify_version
+
+      config = fetch_config
 
-      Bundler.configure
+      Diffend::Voting.call(
+        command,
+        config,
+        Diffend::BuildBundlerDefinition.call(
+          command,
+          Bundler.default_gemfile,
+          Bundler.default_lockfile
+        )
+      )
+    rescue Diffend::Errors::HandledException
+      return if ENV['DIFFEND_IGNORE_ERRORS'] == 'true'
 
-      Bundler::Definition.build(
-        Bundler.default_gemfile,
-        Bundler.default_lockfile,
-        unlock
+      exit 255
+    rescue StandardError => e
+      Diffend::HandleErrors::Report.call(
+        exception: e,
+        config: config,
+        message: :unhandled_exception,
+        report: true,
+        raise_exception: false
       )
+
+      return if ENV['DIFFEND_IGNORE_ERRORS'] == 'true'
+
+      exit 255
+    end
+
+    def verify_version
+      return if ENV['DIFFEND_DEVELOPMENT'] == 'true'
+      return if installed_version == VERSION
+
+      build_outdated_version_message(installed_version)
+        .tap(&Bundler.ui.method(:error))
+
+      exit 2
+    end
+
+    # @return [String] installed plugin version
+    def installed_version
+      Bundler::Plugin
+        .index
+        .plugin_path('diffend')
+        .basename
+        .to_s
+        .split('-')
+        .last
+    end
+
+    # Checks if plugin is enabled
+    #
+    # @return [Boolean] true if enabled, false otherwise
+    def enabled?
+      Bundler
+        .default_gemfile
+        .read
+        .split("\n")
+        .reject(&:empty?)
+        .map(&:strip)
+        .select { |line| line.start_with?('plugin') }
+        .any? { |line| line.include?('diffend') }
+    end
+
+    # @param version [Hash] installed version
+    #
+    # @return [String]
+    def build_outdated_version_message(version)
+      <<~MSG
+        \nYou are running an outdated version (#{version}) of the plugin, which will lead to issues.
+        \nPlease upgrade to the latest one (#{VERSION}) by executing "rm -rf .bundle/plugin".\n
+      MSG
     end
 
     # Command that was run with bundle
     #
     # @return [String]
     def command
-      ARGV.first || Diffend::Commands::INSTALL
+      ARGV.first || Bundler.feature_flag.default_cli_command.to_s
+    end
+
+    # Fetch diffend config file
+    #
+    # @return [OpenStruct, nil] configuration object
+    #
+    # @raise [Errors::MissingConfigurationFile] when no config file
+    def fetch_config
+      Config::Fetcher.call(
+        File.expand_path('..', Bundler.bin_path)
+      )
     end
   end
 end

data/lib/diffend/build_bundler_definition.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Builds bundler definition used within the plugin
+  module BuildBundlerDefinition
+    class << self
+      # Build clean instance of bundler definition, as we don't want to pollute the main one
+      #
+      # @param command [String] bundler command that we are executing
+      # @param gemfile [String] path to Gemfile
+      # @param lockfile [String] path to Gemfile.lock
+      #
+      # @return [Bundler::Definition]
+      def call(command, gemfile, lockfile)
+        unlock = command == 'update' ? true : nil
+
+        Bundler.configure
+        Bundler::Fetcher.disable_endpoint = nil
+
+        Bundler::Definition
+          .build(gemfile, lockfile, unlock)
+          .tap(&:validate_runtime!)
+      end
+    end
+  end
+end

data/lib/diffend/commands.rb

@@ -3,9 +3,11 @@
 module Diffend
   # Modules grouping supported bundler commands
   module Commands
-    # Install bundler command
+    # Bundler install command
     INSTALL = 'install'
-    # Update bundler command
+    # Bundler update command
     UPDATE = 'update'
+    # Bundler exec command
+    EXEC = 'exec'
   end
 end

data/lib/diffend/config/fetcher.rb

@@ -27,16 +27,20 @@ module Diffend
           build(build_path)
         rescue Errors::MissingConfigurationFile
           Bundler.ui.error(build_missing_error_message(build_path))
-          exit 1
+
+          raise Diffend::Errors::HandledException
         rescue Errors::EmptyConfigurationFile
           Bundler.ui.error(build_empty_error_message(build_path))
-          exit 1
+
+          raise Diffend::Errors::HandledException
         rescue Errors::MalformedConfigurationFile
           Bundler.ui.error(build_malformed_error_message(build_path))
-          exit 1
+
+          raise Diffend::Errors::HandledException
         rescue *MISSING_KEY_ERRORS => e
           Bundler.ui.error(build_missing_key_error_message(e))
-          exit 1
+
+          raise Diffend::Errors::HandledException
         end
 
         private

data/lib/diffend/errors.rb

@@ -19,9 +19,9 @@ module Diffend
     ShareableKeyMissingInConfigurationFile = Class.new(BaseError)
     # Raised when build_path is missing in configuration file
     BuildPathMissingInConfigurationFile = Class.new(BaseError)
-    # When unsupported response returned from the endpoint
-    UnsupportedResponse = Class.new(BaseError)
-    # When unsupported action returned from the endpoint
-    UnsupportedAction = Class.new(BaseError)
+    # Raised when server-side error occurs
+    RequestServerError = Class.new(BaseError)
+    # Raised when we had an exception that we know how to handle
+    HandledException = Class.new(BaseError)
   end
 end

data/lib/diffend/handle_errors/build_exception_payload.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module Diffend
+  module HandleErrors
+    # Module responsible for building exception payload
+    module BuildExceptionPayload
+      class << self
+        # Build exception payload
+        #
+        # @param exception [Exception, NilClass] expection that was raised
+        # @param payload [Hash] with versions to check
+        #
+        # @return [Hash]
+        def call(exception, payload)
+          {
+            request_id: SecureRandom.uuid,
+            payload: payload,
+            exception: {
+              class: exception&.class,
+              message: exception&.message,
+              backtrace: exception&.backtrace
+            }
+          }.freeze
+        end
+      end
+    end
+  end
+end

data/lib/diffend/handle_errors/display_to_stdout.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Diffend
+  module HandleErrors
+    # Module responsible for displaying exception payload to stdout
+    module DisplayToStdout
+      class << self
+        # Display exception payload to stdout
+        #
+        # @param exception_payload [Hash]
+        def call(exception_payload)
+          puts exception_payload.to_json
+        end
+      end
+    end
+  end
+end

data/lib/diffend/handle_errors/messages.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Diffend
+  module HandleErrors
+    module Messages
+      PAYLOAD_DUMP = '^^^ Above is the dump of your request ^^^'
+      UNHANDLED_EXCEPTION = <<~MSG
+        \nSomething went really wrong. We recorded this incident in our system and will review it.\n
+        This is a bug, don't hesitate.\n
+        Create an issue at https://github.com/diffend-io/diffend-ruby/issues\n
+      MSG
+      UNSUPPORTED_RESPONSE = <<~MSG
+        \nAPI returned an unsupported response. We recorded this incident in our system and will review it.\n
+        This is a bug, don't hesitate.\n
+        Create an issue at https://github.com/diffend-io/diffend-ruby/issues\n
+      MSG
+      UNSUPPORTED_VERDICT = <<~MSG
+        \nAPI returned an unsupported verdict. We recorded this incident in our system and will review it.\n
+        This is a bug, don't hesitate.\n
+        Create an issue at https://github.com/diffend-io/diffend-ruby/issues\n
+      MSG
+      REQUEST_ERROR = <<~MSG
+        \nWe were unable to process your request at this time. We recorded this incident in our system and will review it.\n
+        If you think that this is a bug, don't hesitate.\n
+        Create an issue at https://github.com/diffend-io/diffend-ruby/issues\n
+      MSG
+    end
+  end
+end