diffend 0.2.18 → 0.2.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0a5718a6d7b90225e8a9d3dd8aff55c3bc8e84dced09b84f6a575a4decf002f
-  data.tar.gz: '006843f27693e587008b3bf25676203050329460814e9f94ffd6f4af1cc4a8df'
+  metadata.gz: f22ef308037176744a8795a6371eb3340f01d597b706c66e45b8355dbf2d41a9
+  data.tar.gz: 1e5734925c51663f20e804ecef8d329f7b24a05dfce891b33366f1e867edbf78
 SHA512:
-  metadata.gz: 6040014adc4dac35c1f42fd663c5ad95a96a5b68e5b4591387c9be4d91840312ed1b8c4fe9fab17f6c410b225b11c31236f66bb131986c09d0f28538ac2e6ea7
-  data.tar.gz: bf93737d117bc09a8fc9698b9b431459f6805dd4c4a35757d3a1c8e1a02c442cf53a2a782008349342a09faa6cf8659e7ceddcd128ba73c4c9665cfb41f13c42
+  metadata.gz: 8930d5dfc0e3c8438515069ab5c472ae93aaf934c6d16c595c70b9167384347d7c0358c4c50fc49d18b1a4024ed959be4fff00485731c9e622b8c8e89f7c1a98
+  data.tar.gz: e9741f2fe2db83a7650dd2272b9f79cfa7e5bc4b3c2989cae0d8390215459a386a545f23eb0163e350e6e32a7dca7963c9a9bfcdb65496dfa062051a2c023aad

data/.github/workflows/ci.yml

@@ -3,16 +3,27 @@ name: ci
 jobs:
   specs:
     runs-on: ubuntu-latest
+
     strategy:
       fail-fast: false
       matrix:
         ruby:
           - '2.7'
+          - '2.6'
+          - '2.5'
+          - 'jruby'
         include:
           - ruby: '2.7'
             coverage: 'true'
+
     steps:
       - uses: actions/checkout@v2
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
       - name: Install package dependencies
         run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
       - name: Set up Ruby
@@ -22,10 +33,11 @@ jobs:
       - name: Install latest bundler
         run: |
           gem install bundler --no-document
-          bundle config set without 'tools benchmarks docs'
       - name: Bundle install
+        env:
+          DIFFEND_DEVELOPMENT: true
         run: |
-          bundle config set without development
+          bundle config path vendor/bundle
           bundle install --jobs 4 --retry 3
       - name: Run all tests
         env:

data/CHANGELOG.md

@@ -2,6 +2,43 @@
 
 ## [Unreleased][master]
 
+## [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))
+
 ## [0.2.18] (2020-08-05)
 
 - use `Etc.getpwuid` instead of `Etc.getlogin` for fetching host user ([#11](https://github.com/diffend-io/diffend-ruby/pull/11))
@@ -18,6 +55,15 @@
 
 - initial release
 
-[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.17...HEAD
+[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.26...HEAD
+[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
 [0.2.16]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.15...v0.2.16

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.18)
+    diffend (0.2.26)
 
 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,21 @@
 ].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
   voting
 ].each { |file| require "diffend/#{file}" }
 
 %w[
-  request
   versions/local
   versions/remote
 ].each { |file| require "diffend/voting/#{file}" }
@@ -22,7 +27,7 @@
 # Diffend main namespace
 module Diffend
   # Current plugin version
-  VERSION = '0.2.18'
+  VERSION = '0.2.26'
   # Diffend homepage
   HOMEPAGE = 'https://diffend.io'
 
@@ -30,35 +35,97 @@ 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
 
-      Bundler.configure
+      config = fetch_config
 
-      Bundler::Definition.build(
-        Bundler.default_gemfile,
-        Bundler.default_lockfile,
-        unlock
+      Diffend::Voting.call(
+        command,
+        config,
+        Diffend::BuildBundlerDefinition.call(
+          command,
+          Bundler.default_gemfile,
+          Bundler.default_lockfile
+        )
       )
+    rescue StandardError => e
+      Diffend::HandleErrors::Report.call(
+        exception: e,
+        config: config,
+        message: :unhandled_exception,
+        report: true
+      )
+    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 1
+    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/errors.rb

@@ -19,9 +19,7 @@ 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)
   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

data/lib/diffend/handle_errors/report.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Diffend
+  module HandleErrors
+    # Module responsible for reporting errors to diffend
+    module Report
+      class << self
+        # Execute request to Diffend
+        #
+        # @param exception [Exception] expection that was raised
+        # @param payload [Hash] with versions to check
+        # @param config [OpenStruct] Diffend config
+        # @param message [Symbol] message that we want to display
+        # @param report [Boolean] if true we will report the issue to diffend
+        #
+        # @return [Net::HTTPResponse] response from Diffend
+        def call(config:, message:, exception: nil, payload: {}, report: false)
+          exception_payload = prepare_exception_payload(exception, payload)
+
+          Bundler.ui.error(Diffend::HandleErrors::Messages::PAYLOAD_DUMP)
+          Bundler.ui.error(Diffend::HandleErrors::Messages.const_get(message.to_s.upcase))
+
+          if report
+            Diffend::Request.call(
+              config,
+              errors_url(config.project_id),
+              exception_payload
+            )
+          end
+
+          exit 1
+        end
+
+        # Prepare exception payload and display it to stdout
+        #
+        # @param exception [Exception] expection that was raised
+        # @param payload [Hash] with versions to check
+        #
+        # @return [Hash]
+        def prepare_exception_payload(exception, payload)
+          Diffend::HandleErrors::BuildExceptionPayload
+            .call(exception, payload)
+            .tap(&Diffend::HandleErrors::DisplayToStdout.method(:call))
+        end
+
+        # Provides diffend errors endpoint url
+        #
+        # @param project_id [String] diffend project_id
+        #
+        # @return [String] diffend endpoint
+        def errors_url(project_id)
+          return ENV['DIFFEND_ERROR_URL'] if ENV.key?('DIFFEND_ERROR_URL')
+
+          "https://my.diffend.io/api/projects/#{project_id}/errors"
+        end
+      end
+    end
+  end
+end