esse-active_record 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eeb304ba4915091f1b51addb850fc9161b1c415dcf61fdd9f0b189b43b7b4ac2
-  data.tar.gz: 52182a2e70cdb56f4658ef4ba515a86267ccc4b48a5e1ef5f2895ca192aca6be
+  metadata.gz: 78a881c4b488d3a39ae25270bde1fc26444ba3369779257c385237933314e9c6
+  data.tar.gz: 25e90b2d8820ab109a23812449b4fbd076081c843b3891ea1373977b48a85df6
 SHA512:
-  metadata.gz: 24eb997cfdb498b4f8725e405aef700c22dd0a31c5d08b8092a923022543e06d9235f63c75a0d8099f06d1cd69fd00a6ecd4a7d8326bd807fe609fb0b295ad93
-  data.tar.gz: e770dcd174126061bd938979ea4d36f9c761a3b4efb6f8360a73642cc423efa57c9c22a9ac637b5453ac4ab497f7cb5e09509b0e60608989b9114ab03099bd5e
+  metadata.gz: f9fba8e83ea38bae6667071fd9f416326af17227dc11061d41ae28305b35101d60babddd2ad8c02169876f673cf6cb712f68832f08d8b39dadbc448e2a0ae332
+  data.tar.gz: 654fac3ac8f2eb1e52d977ee576a5565a0b3d9ce45ba239ab1fd0dd7a5c876ce42936f8270becfcbac6a7d12d82544bfcd7a7708f125bf76c9159ac9fc8ec6cd

data/.rubocop.yml

@@ -17,6 +17,22 @@ AllCops:
     - "db/**/*"
     - "tmp/**/*"
     - "vendor/**/*"
+  NewCops: enable
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/SpecFilePathFormat:
+  Enabled: false
 
 Layout/SpaceInsideHashLiteralBraces:
   Enabled: false

data/Gemfile

@@ -2,9 +2,11 @@
 
 source 'https://rubygems.org'
 
-gem 'esse', github: 'marcosgz/esse', branch: 'master'
+gem 'esse', '~> 0.2.4'
 gem 'sqlite3', '~> 1.3.6'
 gem 'activerecord', '~> 5.2'
+gem 'esse-rspec', '~> 0.0.6'
+gem 'elasticsearch', '~> 7.17', '>= 7.17.10'
 
 # Specify your gem's dependencies in esse-active_record.gemspec
 gemspec

data/Gemfile.lock

@@ -1,18 +1,9 @@
-GIT
-  remote: https://github.com/marcosgz/esse.git
-  revision: fa4eb4d8c54aae89c388415585b4b27c75b31198
-  branch: master
-  specs:
-    esse (0.2.1)
-      multi_json
-      thor (>= 0.19)
-
 PATH
   remote: .
   specs:
-    esse-active_record (0.1.1)
+    esse-active_record (0.2.0)
       activerecord (>= 4.2, < 8)
-      esse
+      esse (>= 0.2.3)
 
 GEM
   remote: https://rubygems.org/
@@ -28,80 +19,119 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
     arel (9.0.0)
     ast (2.4.2)
     awesome_print (1.9.2)
+    base64 (0.2.0)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.3)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
-    dotenv (2.7.6)
-    hashdiff (1.0.1)
-    i18n (1.12.0)
+    dotenv (2.8.1)
+    elasticsearch (7.17.10)
+      elasticsearch-api (= 7.17.10)
+      elasticsearch-transport (= 7.17.10)
+    elasticsearch-api (7.17.10)
+      multi_json
+    elasticsearch-transport (7.17.10)
+      faraday (>= 1, < 3)
+      multi_json
+    esse (0.2.6)
+      multi_json
+      thor (>= 0.19)
+    esse-rspec (0.0.6)
+      esse (>= 0.2.4)
+      rspec (>= 3)
+    factory_bot (6.2.0)
+      activesupport (>= 5.0.0)
+    faraday (2.8.1)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    hashdiff (1.1.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
     method_source (1.0.0)
-    minitest (5.16.2)
+    minitest (5.21.2)
     multi_json (1.15.0)
-    parallel (1.22.1)
-    parser (3.1.2.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
-    pry (0.14.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.7)
+    public_suffix (5.0.4)
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (12.3.3)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    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.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.29.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.50.2)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
-      parser (>= 3.1.1.0)
-    rubocop-performance (1.13.3)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-performance (1.16.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.11.1)
-      rubocop (~> 1.19)
-    ruby-progressbar (1.11.0)
+    rubocop-rspec (2.20.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
     sqlite3 (1.3.13)
-    standard (1.12.1)
-      rubocop (= 1.29.1)
-      rubocop-performance (= 1.13.3)
-    thor (1.2.1)
+    standard (1.28.5)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.0.1)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.0.1)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.16.0)
+    thor (1.3.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.10)
+    tzinfo (1.2.11)
       thread_safe (~> 0.1)
-    unicode-display_width (2.2.0)
-    webmock (3.14.0)
+    unicode-display_width (2.5.0)
+    webmock (3.19.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
+    yard (0.9.34)
 
 PLATFORMS
   x86_64-darwin-19
@@ -111,18 +141,21 @@ DEPENDENCIES
   activerecord (~> 5.2)
   awesome_print
   dotenv
-  esse!
+  elasticsearch (~> 7.17, >= 7.17.10)
+  esse (~> 0.2.4)
   esse-active_record!
+  esse-rspec (~> 0.0.6)
+  factory_bot
   pry
-  rake (~> 12.3)
-  rspec (~> 3.0)
-  rubocop (~> 1.20)
-  rubocop-performance (~> 1.11, >= 1.11.5)
-  rubocop-rspec (~> 2.4)
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
   sqlite3 (~> 1.3.6)
-  standard (~> 1.3)
-  webmock (~> 3.14)
-  yard (~> 0.9.20)
+  standard
+  webmock
+  yard
 
 BUNDLED WITH
-   2.3.21
+   2.3.22

data/README.md

@@ -28,7 +28,7 @@ class UsersIndex < Esse::Index
 
   repository :user do
     collection ::User
-    serializer # ...
+    document # ...
   end
 end
 ```
@@ -41,12 +41,12 @@ class UsersIndex < Esse::Index
 
   repository :account do
     collection ::Account
-    serializer # ...
+    document # ...
   end
 
   repository :admin do
     collection ::User.where(admin: true)
-    serializer # ...
+    document # ...
   end
 end
 ```
@@ -63,12 +63,12 @@ class UsersIndex < Esse::Index
       scope :active, -> { where(active: true) }
       scope :role, ->(role) { where(role: role) }
     end
-    serializer # ...
+    document # ...
   end
 end
 
 # Import data using the scopes
-#   > UsersIndex.elasticsearch.import(context: { active: true, role: 'admin' })
+#   > UsersIndex.import(context: { active: true, role: 'admin' })
 #
 # Streaming data using the scopes
 #   > UsersIndex.documents(active: true, role: 'admin').first
@@ -76,7 +76,7 @@ end
 
 ## Collection Batch Context
 
-Assume that you have a collection of orders and you want to also include the customer data that lives in a external system. To avoid making a request for each order, you can use the `batch_context` to fetch the data in batches and make it available in the serializer context.
+Assume that you have a collection of orders and you want to also include the customer data that lives in a external system. To avoid making a request for each order, you can use the `batch_context` to fetch the data in batches and make it available in the document context.
 
 ```ruby
 class OrdersIndex < Esse::Index
@@ -85,12 +85,12 @@ class OrdersIndex < Esse::Index
   repository :order do
     collection ::Order do
       batch_context :customers do |orders, **_existing_context|
-        # The return value will be available in the serializer context
+        # The return value will be available in the document context
         # { customers: <value returned from this block> }
         ExternalSystem::Customer.find_all_by_ids(orders.map(&:customer_id)).index_by(&:id) # => { 1 => <Customer>, 2 => <Customer> }
       end
     end
-    serializer do |order, customers: [], **_|
+    document do |order, customers: {}, **_|
       customer = customers[order.customer_id]
       {
         id: order.id,
@@ -113,7 +113,7 @@ class OrdersIndex < Esse::Index
 
   repository :order do
     collection ::Order.includes(:customer)
-    serializer do |order, **_|
+    document do |order, **_|
       {
         id: order.id,
         customer: {
@@ -126,7 +126,7 @@ class OrdersIndex < Esse::Index
 end
 ```
 
-### Data Streaming Optionsou
+### Data Streaming Options
 
 As default the active record support 3 streaming options:
 * `batch_size`: the number of documents to be streamed in each batch. Default is 1000;
@@ -136,7 +136,7 @@ As default the active record support 3 streaming options:
 This is useful when you want to import simultaneous data. You can make one process import all records between 1 and 10,000, and another from 10,000 and beyond
 
 ```ruby
-UsersIndex.elasticsearch.import(context: { start: 1, finish: 10000, batch_size: 500 })
+UsersIndex.import(context: { start: 1, finish: 10000, batch_size: 500 })
 ```
 
 The default valueof `batch_size` can be also defined in the `collection` configuration:
@@ -147,7 +147,7 @@ class UsersIndex < Esse::Index
 
   repository :user do
     collection ::User, batch_size: 500
-    serializer # ...
+    document # ...
   end
 end
 ```
@@ -162,7 +162,7 @@ class UsersIndex < Esse::Index
 
   repository :user, const: true do
     collection ::User
-    serializer # ...
+    document # ...
   end
 
 end
@@ -182,9 +182,9 @@ end
 Callbacks can also be disabled/enabled globally:
 
 ```ruby
-Esse::ActiveRecord::Hoods.disable!
-Esse::ActiveRecord::Hoods.enable!
-Esse::ActiveRecord::Hoods.without_indexing do
+Esse::ActiveRecord::Hooks.disable!
+Esse::ActiveRecord::Hooks.enable!
+Esse::ActiveRecord::Hooks.without_indexing do
   10.times { User.create! }
 end
 ```
@@ -192,9 +192,9 @@ end
 or by some specific list of index or index's repository
 
 ```ruby
-Esse::ActiveRecord::Hoods.disable!(UsersIndex.repo)
-Esse::ActiveRecord::Hoods.enable!(UsersIndex.repo)
-Esse::ActiveRecord::Hoods.without_indexing(AccountsIndex UsersIndex.repo, ) do
+Esse::ActiveRecord::Hooks.disable!(UsersIndex.repo)
+Esse::ActiveRecord::Hooks.enable!(UsersIndex.repo)
+Esse::ActiveRecord::Hooks.without_indexing(AccountsIndex UsersIndex.repo, ) do
   10.times { User.create! }
 end
 ```

data/ci/Gemfile.rails-5.2

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem 'sqlite3', '~> 1.3.6'
+gem 'activerecord', '~> 5.2'
+gem 'esse-rspec', '~> 0.0.6'
+gem 'elasticsearch', '~> 7.17', '>= 7.17.10'
+
+gemspec path: ".."

data/ci/Gemfile.rails-5.2.lock

@@ -0,0 +1,160 @@
+PATH
+  remote: ..
+  specs:
+    esse-active_record (0.2.0)
+      activerecord (>= 4.2, < 8)
+      esse (>= 0.2.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.8.1)
+      activesupport (= 5.2.8.1)
+    activerecord (5.2.8.1)
+      activemodel (= 5.2.8.1)
+      activesupport (= 5.2.8.1)
+      arel (>= 9.0)
+    activesupport (5.2.8.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    arel (9.0.0)
+    ast (2.4.2)
+    awesome_print (1.9.2)
+    base64 (0.2.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    dotenv (2.8.1)
+    elasticsearch (7.17.10)
+      elasticsearch-api (= 7.17.10)
+      elasticsearch-transport (= 7.17.10)
+    elasticsearch-api (7.17.10)
+      multi_json
+    elasticsearch-transport (7.17.10)
+      faraday (>= 1, < 3)
+      multi_json
+    esse (0.2.6)
+      multi_json
+      thor (>= 0.19)
+    esse-rspec (0.0.6)
+      esse (>= 0.2.4)
+      rspec (>= 3)
+    faraday (2.8.1)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    hashdiff (1.1.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    method_source (1.0.0)
+    minitest (5.21.2)
+    multi_json (1.15.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    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.59.0)
+      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.30.0, < 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.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    rubocop-rspec (2.26.1)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    sqlite3 (1.3.13)
+    standard (1.33.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.59.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.3)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.3.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.20.2)
+    thor (1.3.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.11)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.5.0)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.34)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  activerecord (~> 5.2)
+  awesome_print
+  dotenv
+  elasticsearch (~> 7.17, >= 7.17.10)
+  esse-active_record!
+  esse-rspec (~> 0.0.6)
+  pry
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  sqlite3 (~> 1.3.6)
+  standard
+  webmock
+  yard
+
+BUNDLED WITH
+   2.3.21

data/ci/Gemfile.rails-6.0

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem 'sqlite3'
+gem 'activerecord', '~> 6.0'
+gem 'esse-rspec', '~> 0.0.6'
+gem 'elasticsearch', '~> 7.17', '>= 7.17.10'
+
+gemspec path: ".."