diffend 0.2.16 → 0.2.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d23a558405ac69141d76368e9a642d153300c2a9bb01fd67b9c8f3c949a9225b
-  data.tar.gz: 5d74b929a8debf7c7a32aa0cb8d01e9f51c373b0859468a3936e40a1bccc1004
+  metadata.gz: 5ce266f8f72de49360adc1e6e1f79c8bf5fa08727ffc990292877c015e1040ee
+  data.tar.gz: 1a71a4a519b1f2afb9bc993726c045b4db5b87833459ba8f7192c2a2f4232aa6
 SHA512:
-  metadata.gz: 8fe13be65aad9dda4c8a4cf3341851d691f253e4dc2d3d4a31e1da2bba92bffb2902e69ea08f78a5d3a9c6a5fb3f233abf72dd569d732df317aa5f0d8748830b
-  data.tar.gz: 86929a3b0259f8de839edfdd2901c203ed0e69d35a733d31860d6628c71a5874097efd3a08fb4203e4fa4768f110d5d36ec192f064b144b1a99c8c208111be0f
+  metadata.gz: '08dd6da1d3984200d9ac07fd9fd1f9a0adf6b7746f86a77ab560b77b356dc6fad819513adea6fe2d714b1f06ed8cf5441d796681fd507b64247a2db3560d3138'
+  data.tar.gz: 2155bbba6da089606b38d36fcec4259054f6cac053bf56eefb303d6d3aa223ba4253ca771249a2543696c636e8c509aa75ceb3ab50f055dd18a2ba9715e5cb9f

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,9 @@ jobs:
       - name: Install latest bundler
         run: |
           gem install bundler --no-document
-          bundle config set without 'tools benchmarks docs'
       - name: Bundle install
         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

@@ -0,0 +1,48 @@
+# Changelog
+
+## [Unreleased][master]
+- 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))
+
+## [0.2.17] (2020-08-05)
+
+- introduce config validation ([#9](https://github.com/diffend-io/diffend-ruby/pull/9))
+
+## [0.2.16] (2020-07-28)
+
+- report unexpected errors ([#8](https://github.com/diffend-io/diffend-ruby/pull/8))
+
+## 0.2.15 (2020-06-07)
+
+- initial release
+
+[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.22...HEAD
+[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.16)
+    diffend (0.2.23)
 
 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,15 +5,21 @@
 ].each(&method(:require))
 
 %w[
+  build_bundler_definition
+  errors
   config/fetcher
   config/file_finder
+  config/validator
   commands
-  errors
+  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}" }
@@ -21,7 +27,7 @@
 # Diffend main namespace
 module Diffend
   # Current plugin version
-  VERSION = '0.2.16'
+  VERSION = '0.2.23'
   # Diffend homepage
   HOMEPAGE = 'https://diffend.io'
 
@@ -29,27 +35,28 @@ 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
-
-      Bundler.configure
+    # Execute diffend plugin
+    def execute
+      config = fetch_config
 
-      Bundler::Definition.build(
-        Bundler.default_gemfile,
-        Bundler.default_lockfile,
-        unlock
+      Diffend::Voting.call(
+        command,
+        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
 
@@ -57,7 +64,18 @@ module Diffend
     #
     # @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/config/fetcher.rb

@@ -7,22 +7,105 @@ module Diffend
   module Config
     # Class responsible for fetching the config from .diffend.yml
     module Fetcher
+      # All the errors for missing keys in the configuration file
+      MISSING_KEY_ERRORS = [
+        Errors::ProjectIdMissingInConfigurationFile,
+        Errors::ShareableIdMissingInConfigurationFile,
+        Errors::ShareableKeyMissingInConfigurationFile,
+        Errors::BuildPathMissingInConfigurationFile
+      ].freeze
+
       class << self
         # @param build_path [String] path of the current build
+        #
         # @return [OpenStruct] open struct with config details
+        #
         # @example
         #   details = Fetcher.new.call('./')
         #   details.build_path #=> './'
         def call(build_path)
-          OpenStruct.new(
-            YAML.safe_load(
-              ERB.new(
-                File.read(
-                  FileFinder.call(build_path)
-                )
-              ).result
-            ).merge(build_path: build_path)
-          )
+          build(build_path)
+        rescue Errors::MissingConfigurationFile
+          Bundler.ui.error(build_missing_error_message(build_path))
+          exit 1
+        rescue Errors::EmptyConfigurationFile
+          Bundler.ui.error(build_empty_error_message(build_path))
+          exit 1
+        rescue Errors::MalformedConfigurationFile
+          Bundler.ui.error(build_malformed_error_message(build_path))
+          exit 1
+        rescue *MISSING_KEY_ERRORS => e
+          Bundler.ui.error(build_missing_key_error_message(e))
+          exit 1
+        end
+
+        private
+
+        # @param build_path [String] path of the current build
+        #
+        # @return [OpenStruct] open struct with config details
+        def build(build_path)
+          content = ERB.new(
+            File.read(
+              FileFinder.call(build_path)
+            )
+          ).result
+
+          raise Errors::EmptyConfigurationFile if content.empty?
+
+          OpenStruct.new(parse_file(content).merge(build_path: build_path))
+            .tap(&Validator.method(:call))
+        end
+
+        def parse_file(content)
+          YAML.safe_load(content)
+        rescue Psych::SyntaxError
+          raise Errors::MalformedConfigurationFile
+        end
+
+        # @param build_path [String] path of the current build
+        #
+        # @return [String] missing configuration file message
+        def build_missing_error_message(build_path)
+          <<~MSG
+            \nWe were unable to locate Diffend configuration file.\n
+            Please make sure that .diffend.yml is present in #{build_path} folder.\n
+          MSG
+        end
+
+        # @return [String] empty configuration file message
+        def build_empty_error_message
+          <<~MSG
+            \nYour Diffend configuration file is empty.\n
+            Please re-setup.\n
+          MSG
+        end
+
+        # @return [String] malformed configuration file message
+        def build_malformed_error_message
+          <<~MSG
+            \nYour Diffend configuration file is malformed.\n
+            Please re-setup.\n
+          MSG
+        end
+
+        # @return [String] malformed configuration file message
+        def build_missing_key_error_message(exception)
+          missing_key = missing_key_from_exception(exception)
+
+          <<~MSG
+            \nYour Diffend configuration file is missing #{missing_key} key.\n
+            Please re-setup.\n
+          MSG
+        end
+
+        def missing_key_from_exception(exception)
+          case exception
+          when Errors::ProjectIdMissingInConfigurationFile then 'project_id'
+          when Errors::ShareableIdMissingInConfigurationFile then 'shareable_id'
+          when Errors::ShareableKeyMissingInConfigurationFile then 'shareable_key'
+          when Errors::BuildPathMissingInConfigurationFile then 'build_path'
+          end
         end
       end
     end

data/lib/diffend/config/validator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Module for all the components related to setting up the config
+  module Config
+    # Class responsible for validating the config from .diffend.yml
+    module Validator
+      class << self
+        # @param config [OpenStruct] path of the current build
+        def call(config)
+          raise Errors::ProjectIdMissingInConfigurationFile if missing?(config, 'project_id')
+          raise Errors::ShareableIdMissingInConfigurationFile if missing?(config, 'shareable_id')
+          raise Errors::ShareableKeyMissingInConfigurationFile if missing?(config, 'shareable_key')
+          raise Errors::BuildPathMissingInConfigurationFile if missing?(config, 'build_path')
+        end
+
+        private
+
+        def missing?(config, key)
+          config.public_send(key).nil? || config.public_send(key).empty?
+        end
+      end
+    end
+  end
+end

data/lib/diffend/errors.rb

@@ -7,6 +7,18 @@ module Diffend
     BaseError = Class.new(StandardError)
     # Raised when we couldn't find a valid configuration file
     MissingConfigurationFile = Class.new(BaseError)
+    # Raised when configuration file is empty
+    EmptyConfigurationFile = Class.new(BaseError)
+    # Raised when configuration file is malformed
+    MalformedConfigurationFile = Class.new(BaseError)
+    # Raised when project_id is missing in configuration file
+    ProjectIdMissingInConfigurationFile = Class.new(BaseError)
+    # Raised when shareable_id is missing in configuration file
+    ShareableIdMissingInConfigurationFile = Class.new(BaseError)
+    # Raised when shareable_key is missing in configuration file
+    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

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] 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