esse-rspec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aeeba40267c5b5b1dbda8172ae71c3240fe5a1ffab9c7f9f7d0124d8a374aabe
+  data.tar.gz: 062bcb563387b34138a01286464093d32fa92dc6143170ed61b628d9e6d4b8f4
+SHA512:
+  metadata.gz: e8112a8b570dfec71fdba8328db731884aa1de77a3409fb220fccc8b42c8483f523f5feee5b840c1fd35a5f4ef898fe4e4b7f4ebae2f0e1d753f8d15d652b3e5
+  data.tar.gz: 01e7c324f337dd2d790f332f304bcdb6f23fcf663f5cf0658c1ac99f399f771c55b1b6baec1f7db2b3514e430ff163203ac3325d77dc209f6a9c711f748c12c1

data/.rubocop.yml

@@ -0,0 +1,26 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - standard/cop/block_single_line_braces
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+  Exclude:
+    - "db/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+  NewCops: enable
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.0.1 - 2023-11-15
+The first release of the Esse::RSpec
+* stub_esse_class helper
+* stub_esse_index helper
+* stub_esse_search helper

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "esse", "~> 0.2.4"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,99 @@
+PATH
+  remote: .
+  specs:
+    esse-rspec (0.0.1)
+      esse (>= 0.2.4)
+      rspec (~> 3.12)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    esse (0.2.4)
+      multi_json
+      thor (>= 0.19)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    method_source (1.0.0)
+    multi_json (1.15.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.19.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.25.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    standard (1.32.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.57.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.2)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.2.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.19.1)
+    thor (1.3.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  esse (~> 0.2.4)
+  esse-rspec!
+  pry
+  rubocop (~> 1.20)
+  rubocop-performance (~> 1.11, >= 1.11.5)
+  rubocop-rspec (~> 2.4)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.4.13

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Marcos G. Zimmermann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# esse-rspec
+
+RSpec and testing support for [esse](https://github.com/marcosgz/esse)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'esse-rspec'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Usage
+
+Require the `esse/rspec` file in your `spec_helper.rb` file:
+
+```ruby
+require 'esse/rspec'
+```
+
+### Stubbing Esse::Index classes
+
+```ruby
+before do
+  stub_esse_index('products') do
+    repository :product, const: true do
+      # ...
+    end
+  end
+end
+
+it 'defines the ProductsIndex class' do
+  expect(ProductsIndex).to be < Esse::Index
+  expect(ProductsIndex::Product).to be < Esse::Index::Repository
+end
+```
+
+### Stubbing search requests
+
+```ruby
+before do
+  stub_esse_search(:default, "geos_*", body: {query: {match_all: {}}, size: 10}) do
+    {
+      "hits" => {
+        "total" => {
+          "value" => 1000
+        },
+        "hits" => [{}] * 20
+      }
+    }
+  end
+end
+
+it 'returns a Query using the stubbed response' do
+  query = ProductsIndex.search('geos_*', body: {query: {match_all: {}}, size: 10})
+  expect(query.responsee.total).to eq(1000)
+end
+```

data/lib/esse/rspec/class_methods.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Helper methods to create Index classes
+module Esse
+  module RSpec
+    module ClassMethods
+      def stub_esse_index(name, superclass = nil, &block)
+        superclass ||= ::Esse::Index
+        klass_name = "#{::Esse::Hstring.new(name).camelize.sub(/Index$/, "")}Index"
+        klass = stub_esse_class(klass_name, superclass)
+        klass.class_eval(&block) if block
+        klass
+      end
+
+      def stub_esse_class(name, superclass = nil, &block)
+        klass = Class.new(superclass || Object, &block)
+        stub_const(Esse::Hstring.new(name).camelize.to_s, klass)
+      end
+
+      def stub_esse_search(cluster_name, *indexes, **definition)
+        cluster = Esse.cluster(cluster_name)
+        transport = cluster.api
+        definition[:index] ||= Esse::Search::Query.normalize_indices(*indexes)
+        response = yield
+        allow(cluster).to receive(:api).and_return(transport)
+        allow(transport).to receive(:search).with(**definition).and_return(response)
+      end
+    end
+  end
+end

data/lib/esse/rspec/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Esse
+  module RSpec
+    VERSION = "0.0.1"
+  end
+end

data/lib/esse/rspec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "esse"
+
+require_relative "rspec/version"
+require_relative "rspec/class_methods"
+
+module Esse
+  module RSpec
+  end
+end
+
+::RSpec.configure do |config|
+  config.include Esse::RSpec::ClassMethods
+end

data/lib/esse-rspec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "esse/rspec"

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: esse-rspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marcos G. Zimmermann
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: esse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.5
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: RSpec for Esse
+email:
+- mgzmaster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/esse-rspec.rb
+- lib/esse/rspec.rb
+- lib/esse/rspec/class_methods.rb
+- lib/esse/rspec/version.rb
+homepage: https://github.com/marcosgz/esse-rspec
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/marcosgz/esse-rspec
+  source_code_uri: https://github.com/marcosgz/esse-rspec
+  changelog_uri: https://github.com/marcosgz/esse-rspec/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: RSpec for Esse
+test_files: []