boltless 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8b7c4416097390006b201dcec4ce9beaa8190659d079da12af5e01689670aff
-  data.tar.gz: 434205668e628cb4b0d12a1451a83dac804cea38c1a045f3982f8157e9e25873
+  metadata.gz: c055f7c7d799ed3730576b41ab6f4e06b934b6474cc500dd129fa4d6b3e2aa03
+  data.tar.gz: 3af83a59d287e99c4003b623085381568848c41f78647efde5213c77c4f1e96f
 SHA512:
-  metadata.gz: d20881d61af51e69287d45b36358c8bd35f2709e16b43439b598c542fe92a09f33a182260a2cc19360ddf3586f6c918e79957d1bb3b20b3eb5dafedfdd12273a
-  data.tar.gz: 163eb7a5a639a046a2801ecc002772c0eac9f0b6fe9113f9c35c0271cf41e3aee75137fd17d3c6278957caa67a29e1919e0fd7fcdfac6feb5a4939b65ddf1b59
+  metadata.gz: 77621fe5e243f0101f36b83580ee53dc84798494baa935e2fa7a070d206600ce5950e5e9bcd3b3c5ae35052fdcbc7531b853bcd593a6160193c12fdbd599b70e
+  data.tar.gz: 4df2493fd8f6a89133fd25d5a27c06c4bfcadb44d82a2f5b818a3f97747125279cc51c5abfddfcf46245315aec4110855f93de331062ac3cb47f02b4e0087f11

data/Envfile

@@ -1,3 +1,4 @@
 LANG=en_US.UTF-8
 LANGUAGE=en_US.UTF-8
 LC_ALL=en_US.UTF-8
+RUBOCOP_CACHE_ROOT=/app/tmp

data/lib/boltless/configuration.rb

@@ -73,7 +73,7 @@ module Boltless
     # transmitting and response completion)
     config_accessor(:request_timeout) { 10.seconds }
 
-    # We allow the neo4j server to bootup for the configured time. This allows
+    # We allow the neo4j server to boot-up for the configured time. This allows
     # parallel starts of the user application and the neo4j server, without
     # glitching.
     config_accessor(:wait_for_upstream_server) { 30.seconds }

data/lib/boltless/extensions/connection_pool.rb

@@ -3,9 +3,6 @@
 module Boltless
   module Extensions
     # A top-level gem-module extension to add easy-to-use connection pool.
-    #
-    # rubocop:disable Metrics/BlockLength -- because this is how an
-    #   +ActiveSupport::Concern+ looks like
     module ConnectionPool
       extend ActiveSupport::Concern
 
@@ -22,7 +19,6 @@ module Boltless
         # @raise [HTTP::Error] in case the upstream server did not come up
         #
         # rubocop:disable Metrics/MethodLength -- because of the retry logic
-        # rubocop:disable Metrics/AbcSize -- ditto
         def wait_for_server!(connection)
           # Check if the server already accepted connections
           return connection if @upstream_is_ready
@@ -67,7 +63,6 @@ module Boltless
           retry
         end
         # rubocop:enable Metrics/MethodLength
-        # rubocop:enable Metrics/AbcSize
 
         # A memoized connection pool for our HTTP API clients.
         #
@@ -76,7 +71,6 @@ module Boltless
         #
         # rubocop:disable Metrics/MethodLength -- because of the connection
         #   configuration
-        # rubocop:disable Metrics/AbcSize -- ditto
         def connection_pool
           @connection_pool ||= begin
             conf = Boltless.configuration
@@ -102,14 +96,13 @@ module Boltless
                 )
                 .encoding('UTF-8')
                 .persistent(conf.base_url)
-                .yield_self do |connection|
+                .then do |connection|
                   conf.http_client_configure.call(connection)
                 end
             end
           end
         end
         # rubocop:enable Metrics/MethodLength
-        # rubocop:enable Metrics/AbcSize
       end
 
       included do
@@ -121,6 +114,5 @@ module Boltless
         end
       end
     end
-    # rubocop:enable Metrics/BlockLength
   end
 end

data/lib/boltless/extensions/operations.rb

@@ -3,9 +3,6 @@
 module Boltless
   module Extensions
     # A top-level gem-module extension for neo4j operations.
-    #
-    # rubocop:disable Metrics/BlockLength -- because this is how an
-    #   +ActiveSupport::Concern+ looks like
     module Operations
       extend ActiveSupport::Concern
 
@@ -15,12 +12,6 @@ module Boltless
         # database is completely empty and "unconfigured". (dist clean)
         #
         # @param database [String, Symbol] the neo4j database to use
-        #
-        # rubocop:disable Metrics/MethodLength -- because of multiple
-        #   transactions
-        # rubocop:disable Metrics/AbcSize -- because of the extra transaction
-        #   handlings (we cannot do multiple structural changes in
-        #   a single transaction)
         def clear_database!(database: Boltless.configuration.default_db)
           logger.warn('Clear neo4j database ..')
 
@@ -52,8 +43,6 @@ module Boltless
             " > Relationships deleted: #{stats[:relationship_deleted]}"
           )
         end
-        # rubocop:enable Metrics/MethodLength
-        # rubocop:enable Metrics/AbcSize
 
         # Check whenever the given name is already taken on the neo4j
         # database for a component (index or constraint).
@@ -170,6 +159,5 @@ module Boltless
         end
       end
     end
-    # rubocop:enable Metrics/BlockLength
   end
 end

data/lib/boltless/extensions/transactions.rb

@@ -4,10 +4,6 @@ module Boltless
   module Extensions
     # A top-level gem-module extension to add easy-to-use methods to use the
     # Cypher transactional API.
-    #
-    # rubocop:disable Metrics/BlockLength -- because this is how an
-    #   +ActiveSupport::Concern+ looks like
-    # rubocop:disable Metrics/ModuleLength -- ditto
     module Transactions
       extend ActiveSupport::Concern
 
@@ -148,9 +144,6 @@ module Boltless
         #   or +nil+ on errors
         #
         # @raise [Mixed] when an exception occurs inside the user given block
-        #
-        # rubocop:disable Metrics/MethodLength -- because of the extra error
-        #   handling
         def one_shot(access_mode = :write,
                      database: Boltless.configuration.default_db,
                      raw_results: false)
@@ -175,7 +168,6 @@ module Boltless
             end
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         # Start an new transaction and run Cypher statements inside it. When
         # anything within the user given block raises, we automatically
@@ -195,8 +187,6 @@ module Boltless
         #   found by neo4j
         # @raise [Mixed] when an exception occurs inside the user given
         #   block, we re-raise it
-        #
-        # rubocop:disable Metrics/MethodLength -- because this is the workflow
         def transaction!(access_mode = :write,
                          database: Boltless.configuration.default_db,
                          raw_results: false)
@@ -233,7 +223,6 @@ module Boltless
             tx.cleanup
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         # Start an new transaction and run Cypher statements inside it. When
         # anything within the user given block raises, we automatically
@@ -250,8 +239,6 @@ module Boltless
         #
         # @raise [Mixed] when an exception occurs inside the user given
         #   block, we re-raise it
-        #
-        # rubocop:disable Metrics/MethodLength -- because this is the workflow
         def transaction(access_mode = :write,
                         database: Boltless.configuration.default_db,
                         raw_results: false)
@@ -280,7 +267,7 @@ module Boltless
 
             # Try to commit after the user given block, when the transaction is
             # still open, and return the results of the user given block if the
-            # transaction is successfully commited
+            # transaction is successfully committed
             tx_committed = tx.state.open? ? tx.commit : true
             next res if tx_committed
 
@@ -292,10 +279,7 @@ module Boltless
             tx.cleanup
           end
         end
-        # rubocop:enable Metrics/MethodLength
       end
     end
-    # rubocop:enable Metrics/BlockLength
-    # rubocop:enable Metrics/ModuleLength
   end
 end

data/lib/boltless/extensions/utilities.rb

@@ -2,10 +2,7 @@
 
 module Boltless
   module Extensions
-    # A top-level gem-module extension add helpers and utilites.
-    #
-    # rubocop:disable Metrics/BlockLength -- because this is how an
-    #   +ActiveSupport::Concern+ looks like
+    # A top-level gem-module extension add helpers and utilities.
     module Utilities
       extend ActiveSupport::Concern
 
@@ -38,10 +35,6 @@ module Boltless
         # @yield the given block result will be used as Cypher string
         #   template
         # @return [String] the built Cypher query
-        #
-        # rubocop:disable Metrics/MethodLength -- because of the various
-        #   replacement strategies
-        # rubocop:disable Metrics/AbcSize -- ditto
         def build_cypher(**replacements)
           # Process the given replacements in order to prevent Cypher
           # injections from user given values
@@ -57,13 +50,11 @@ module Boltless
           # Then evaluate the given block to get the Cypher template
           # which should be interpolated with the replacements
           format(yield.to_s, replacements).lines.map do |line|
-            line.split('//').first.rstrip.yield_self do |processed|
+            line.split('//').first.rstrip.then do |processed|
               processed.empty? ? nil : processed
             end
           end.compact.join("\n")
         end
-        # rubocop:enable Metrics/MethodLength
-        # rubocop:enable Metrics/AbcSize
 
         # Prepare the given input(s) as node label for injection-free Cypher.
         #
@@ -80,7 +71,7 @@ module Boltless
           end.sort.uniq.join(':')
         end
 
-        # Prepare the given input as relationship tyep for
+        # Prepare the given input as relationship type for
         # injection-free Cypher.
         #
         # @param inputs [Array<#to_s>] the input object(s) to prepare as type
@@ -156,9 +147,6 @@ module Boltless
         #
         # @param cypher [String] the Cypher query to check
         # @return [Symbol] the ANSI color name
-        #
-        # rubocop:disable Metrics/CyclomaticComplexity -- because of the
-        #   various conditions
         def cypher_logging_color(cypher)
           cypher = cypher.to_s.downcase.lines.map(&:strip)
 
@@ -179,9 +167,7 @@ module Boltless
           # Everything else, like matches
           :light_blue
         end
-        # rubocop:enable Metrics/CyclomaticComplexity
       end
     end
-    # rubocop:enable Metrics/BlockLength
   end
 end

data/lib/boltless/request.rb

@@ -4,9 +4,6 @@ module Boltless
   # A neo4j HTTP API request abstraction class, which consumes a single HTTP
   # persistent connection for its whole runtime. This connection is strictly
   # owned by a single request object. It is not safe to share it.
-  #
-  # rubocop:disable Metrics/ClassLength -- because of the isolated request
-  #   abstraction
   class Request
     class << self
       # Convert a multiple Cypher queries and +Hash+ arguments into multiple
@@ -72,7 +69,7 @@ module Boltless
 
     # Run one/multiple Cypher statements inside a one-shot transaction.
     # A new transaction is opened, the statements are run and the transaction
-    # is commited in a single HTTP request for efficiency.
+    # is committed in a single HTTP request for efficiency.
     #
     # @param statements [Array<Hash>] the Cypher statements to run
     # @return [Array<Hash{Symbol => Mixed}>] the raw neo4j results
@@ -101,10 +98,6 @@ module Boltless
     # @return [Integer] the neo4j transaction identifier
     # @raise [Errors::TransactionBeginError] when we fail to start a
     #   new transaction
-    #
-    # rubocop:disable Metrics/MethodLength -- because of the error handlings
-    #   and transaction identifier parsing
-    # rubocop:disable Metrics/AbcSize -- ditto
     def begin_transaction
       log_query(:begin, Request.statement_payload('BEGIN')) do
         handle_transport_errors do
@@ -131,8 +124,6 @@ module Boltless
         end
       end
     end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/AbcSize
 
     # Run one/multiple Cypher statements inside an open transaction.
     #
@@ -236,7 +227,6 @@ module Boltless
     #
     # rubocop:disable Metrics/MethodLength -- because of the result handling
     #   (error, raw result, restructured result)
-    # rubocop:disable Metrics/AbcSize -- ditto
     def handle_response_body(res, tx_id: nil)
       # Parse the response body as a whole, which is returned by
       # the configured raw response handler
@@ -271,7 +261,6 @@ module Boltless
       raise Errors::InvalidJsonError.new(e.message, response: res)
     end
     # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/AbcSize
 
     # Serialize the given object to a JSON string.
     #
@@ -287,7 +276,7 @@ module Boltless
     # @yield the given block
     # @return [Mixed] the result of the given block
     #
-    # @raise [Errors::RequestError] when a low-level error occured
+    # @raise [Errors::RequestError] when a low-level error occurred
     def handle_transport_errors
       yield
     rescue HTTP::Error => e
@@ -316,7 +305,7 @@ module Boltless
       # Add a new request to the counter
       @requests_done += 1
 
-      # When the +query_debug_log_enabled+ config flag is set, we prodce a
+      # When the +query_debug_log_enabled+ config flag is set, we produce a
       # logging output before the actual request is sent, in order to help
       # while debugging slow/never-ending Cypher statements
       if enabled == :debug
@@ -356,10 +345,6 @@ module Boltless
     # @param duration [Numeric, nil] the duration (ms) of the query
     # @param statements [Array<Hash>] the Cypher statements to run
     # @return [String] the assembled logging string
-    #
-    # rubocop:disable Metrics/MethodLength -- because of the complex logging
-    #   string assembling/formatting
-    # rubocop:disable Metrics/AbcSize -- ditto
     def generate_log_str(tx_id, duration, *statements)
       dur = "(#{duration}ms)".colorize(color: :magenta, mode: :bold) \
         if duration
@@ -382,8 +367,5 @@ module Boltless
         "#{prefix} #{cypher}"
       end.join("\n")
     end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/AbcSize
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/boltless/result.rb

@@ -64,10 +64,6 @@ module Boltless
     # Pretty print the result structure in a meaningful way.
     #
     # @param pp [PP] a pretty printer instance to use
-    #
-    # rubocop:disable Metrics/MethodLength -- because of the pretty printing
-    #   logic
-    # rubocop:disable Metrics/AbcSize -- ditto
     def pretty_print(pp)
       pp.object_group(self) do
         pp.breakable
@@ -91,8 +87,6 @@ module Boltless
         pp.pp(stats)
       end
     end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/AbcSize
     alias_method :inspect, :pretty_inspect
   end
 end

data/lib/boltless/result_row.rb

@@ -17,7 +17,7 @@ module Boltless
     # @return [Mixed] the value for the given key
     def [](key)
       # When the requested key was not found, we return +nil+, no need to
-      # perfom the actual lookup
+      # perform the actual lookup
       return unless (idx = columns.index(key.to_sym))
 
       # Otherwise return the value from the slot

data/lib/boltless/statement_collector.rb

@@ -2,7 +2,7 @@
 
 module Boltless
   # A shallow interface object to collect multiple Cypher statements. We have
-  # an explicit different interface (+#add+ instead ot +#run+) from a regular
+  # an explicit different interface (+#add+ instead or +#run+) from a regular
   # transaction to clarify that we just collect statements without running them
   # directly. As a result no subsequent statement can access the results of a
   # previous statement within this collection.
@@ -15,7 +15,7 @@ module Boltless
     # We allow to read our collected details
     attr_reader :statements
 
-    # We allow to access helpful utilities straigth from here
+    # We allow to access helpful utilities straight from here
     delegate :build_cypher, :prepare_label, :prepare_type, :prepare_string,
              :to_options, :resolve_cypher,
              to: Boltless

data/lib/boltless/transaction.rb

@@ -4,7 +4,7 @@ module Boltless
   # A single neo4j transaction representation.
   #
   # When passing Cypher statements you can tweak some HTTP API result options
-  # while passing the following keys to the Cypher parameters (they wont be
+  # while passing the following keys to the Cypher parameters (they won't be
   # sent to neo4j):
   #
   #   * +with_stats: true|false+: whenever to include statement
@@ -21,7 +21,7 @@ module Boltless
     # We allow to read some internal configurations
     attr_reader :access_mode, :id, :raw_state
 
-    # We allow to access helpful utilities straigth from here
+    # We allow to access helpful utilities straight from here
     delegate :build_cypher, :prepare_label, :prepare_type, :prepare_string,
              :to_options, :resolve_cypher,
              to: Boltless
@@ -219,7 +219,7 @@ module Boltless
       yield
     rescue Errors::RequestError, Errors::ResponseError,
            Errors::TransactionInBadStateError => e
-      # When an error occured, the transaction is automatically rolled back by
+      # When an error occurred, the transaction is automatically rolled back by
       # neo4j, so we cannot handle any further interaction
       cleanup
       @raw_state = :closed

data/lib/boltless/version.rb

@@ -3,7 +3,7 @@
 # The gem version details.
 module Boltless
   # The version of the +boltless+ gem
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 
   class << self
     # Returns the version of gem as a string.

data/spec/boltless/extensions/connection_pool_spec.rb

@@ -41,7 +41,7 @@ RSpec.describe Boltless::Extensions::ConnectionPool do
       expect(action.size).to be(1)
     end
 
-    it 'returns a configured HTTP client (connection aquire timeout)' do
+    it 'returns a configured HTTP client (connection acquire timeout)' do
       Boltless.configuration.connection_pool_timeout = 1
       reload.call
       expect(action.instance_variable_get(:@timeout)).to be(1)

data/spec/boltless/request_spec.rb

@@ -2,7 +2,6 @@
 
 require 'spec_helper'
 
-# rubocop:disable RSpec/NestedGroups -- because nesting makes sense here
 RSpec.describe Boltless::Request do
   let(:new_instance) { ->(**args) { described_class.new(connection, **args) } }
   let(:instance) { new_instance.call }
@@ -447,12 +446,12 @@ RSpec.describe Boltless::Request do
 
     context 'with an unsuccessful status code' do
       let(:http_status_code) { 500 }
-      let(:body) { 'Unknown error happend' }
+      let(:body) { 'Unknown error happened' }
 
       it 'raises a Boltless::Errors::TransactionRollbackError' do
         expect { action.call }.to \
           raise_error(Boltless::Errors::TransactionRollbackError,
-                      /Unknown error happend/)
+                      /Unknown error happened/)
       end
     end
 
@@ -971,4 +970,3 @@ RSpec.describe Boltless::Request do
     end
   end
 end
-# rubocop:enable RSpec/NestedGroups

data/spec/boltless/transaction_spec.rb

@@ -112,7 +112,7 @@ RSpec.describe Boltless::Transaction do
   describe '#access_mode' do
     let(:action) { instance.access_mode }
 
-    context 'when not explictly configured' do
+    context 'when not explicitly configured' do
       it 'returns write' do
         expect(action).to be(:write)
       end

data/spec/support/helpers.rb

@@ -25,7 +25,7 @@ def file_fixture(path)
                                           "../fixtures/files/#{path}")))
 end
 
-# Return a neo4j raw result from a file fixture. It looks excatly like produced
+# Return a neo4j raw result from a file fixture. It looks exactly like produced
 # by +Boltless::Request#handle_response_body+.
 #
 # @param suffixes [Array<String, Symbol>] additional file suffixes, check the

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boltless
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Hermann Mayer