diffend 0.2.16 → 0.2.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d23a558405ac69141d76368e9a642d153300c2a9bb01fd67b9c8f3c949a9225b
-  data.tar.gz: 5d74b929a8debf7c7a32aa0cb8d01e9f51c373b0859468a3936e40a1bccc1004
+  metadata.gz: c6a7edc516bd408637e9a48744eaa24aef9aaec48eb31c975d2640e3a222f672
+  data.tar.gz: ced39bedfb9898395d49657e416b09e15d0bf9f9c15dab4f042c619004bb04df
 SHA512:
-  metadata.gz: 8fe13be65aad9dda4c8a4cf3341851d691f253e4dc2d3d4a31e1da2bba92bffb2902e69ea08f78a5d3a9c6a5fb3f233abf72dd569d732df317aa5f0d8748830b
-  data.tar.gz: 86929a3b0259f8de839edfdd2901c203ed0e69d35a733d31860d6628c71a5874097efd3a08fb4203e4fa4768f110d5d36ec192f064b144b1a99c8c208111be0f
+  metadata.gz: 891292dea2577d6b6b0b3b28d96589354bb73e7ca71beba535781c5bbc2388ffa897510d9a0d1ee68643076845600715c786320f32e6ed11eb5a03807c7ec9ff
+  data.tar.gz: 0f84201f7550bbfa9a84e2be1c4c423087271d3b7a40b76ea9a4f0d80f50f350915dfd6500df8186a8e68861bf23f9c68d94ec3879261daa0bb8ddf0d3870b17

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    diffend (0.2.16)
+    diffend (0.2.17)
 
 GEM
   remote: https://rubygems.org/

data/lib/diffend.rb

@@ -5,10 +5,11 @@
 ].each(&method(:require))
 
 %w[
+  errors
   config/fetcher
   config/file_finder
+  config/validator
   commands
-  errors
   voting
 ].each { |file| require "diffend/#{file}" }
 
@@ -21,7 +22,7 @@
 # Diffend main namespace
 module Diffend
   # Current plugin version
-  VERSION = '0.2.16'
+  VERSION = '0.2.17'
   # Diffend homepage
   HOMEPAGE = 'https://diffend.io'
 

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/voting/versions/remote.rb

@@ -164,8 +164,6 @@ module Diffend
             Config::Fetcher.call(
               File.expand_path('..', Bundler.bin_path)
             )
-          rescue Errors::MissingConfigurationFile
-            nil
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diffend
 version: !ruby/object:Gem::Version
-  version: 0.2.16
+  version: 0.2.17
 platform: ruby
 authors:
 - Tomasz Pajor
@@ -34,7 +34,7 @@ cert_chain:
   9MmF6uCQa1EjK2p8tYT0MnbHrFkoehxdX4VO9y99GAkhZyJNKPYPtyAUFV27sT2V
   LfCJRk4ifKIN/FUCwDSn8Cz0m6oH265q0p6wdzI6qrWOjP8tGOMBTA==
   -----END CERTIFICATE-----
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,7 @@ files:
 - lib/diffend/commands.rb
 - lib/diffend/config/fetcher.rb
 - lib/diffend/config/file_finder.rb
+- lib/diffend/config/validator.rb
 - lib/diffend/errors.rb
 - lib/diffend/voting.rb
 - lib/diffend/voting/request.rb