nazrin 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bfaa1a5511735ae1e5a0d3f5fad4248ffa2aacf
-  data.tar.gz: 190b427df48d68bc0433d62d62ce5395116eb21e
+  metadata.gz: 524d0d3e179dce958e889f80d845acca4c4f9eb3
+  data.tar.gz: ee8bf324ef3f1d2a6af74f8f52f7a7454fc70756
 SHA512:
-  metadata.gz: 19a71b2281e25acd4df909598b705cea8cc29ebcec76a56f42351d4c8cbe4395a94853df489cf7a400e177065ebbdc8f75b3af1b329e268096b3ef2596d9bc03
-  data.tar.gz: 95641e5817ce4ffaefd7db2aea3bd483967db8f9db20ed61359ccd19736704720341fa4f716a8d728339e33c5f5b7e3b3e3fc791ae9f770f1648042e4c9d574c
+  metadata.gz: d2d02c1413b55ba7face169e538fe71b069ee2f84f1f0da72cfaa0e38e9008f07d10f7db22d6bb888840c549ba010e962b4cc4a7680c9d02950008c165d33a79
+  data.tar.gz: 322b95b0772eb59c1c446e4bf9616d5d9bbb3052a69e5b80d4a683422ed8197157509ea85a751df78eb314d8c6fdc7c08ac54ea7c9f10e3474185298d64a4681

data/CHANGELOG.md

@@ -1,5 +1,23 @@
+## [2.1.0](https://github.com/tsuwatch/nazrin/compare/v2.0.0...v2.1.0)
+
+### Breaking changes:
+
+* Deprecated `Nazrin.config.debug_mode` [#11](https://github.com/tsuwatch/nazrin/pull/11)
+
+### Features:
+
+* Implement sandbox mode [#11](https://github.com/tsuwatch/nazrin/pull/11)
+
+## [2.0.0](https://github.com/tsuwatch/nazrin/compare/v2.0.0.rc1...v2.0.0)
+
+### Fixes:
+
+* Add activesupport to dependencies ([#9](https://github.com/tsuwatch/nazrin/pull/9))
+
 ## [2.0.0.rc1](https://github.com/tsuwatch/nazrin/compare/v1.0.1...v2.0.0.rc1)
 
+### Breaking changes:
+
 * Extracted Kaminari support to nazrin-kaminari gem ([#7](https://github.com/tsuwatch/nazrin/pull/7))
 
 * Extracted will_paginate support to nazrin-will_paginate gem ([#7](https://github.com/tsuwatch/nazrin/pull/7))

data/README.md

@@ -33,6 +33,7 @@ $ bundle exec rails g nazrin:config # execute before including nazrin to model
 
 Nazrin.configure do |config|
   config.debug_mode = false
+  config.mode = 'production'
   config.search_endpoint = ''
   config.document_endpoint = ''
   config.region = ''
@@ -61,6 +62,27 @@ Post.search(where: :foo, includes: :bar).size(1).start(0).query("(and 'content')
 => [#<Post id: 1, content: "content">]
 ```
 
+### Supported pagination libraries
+If you want to use other supported pagination libraries, for example, `nazrin-kaminari` generates `Kaminari::PaginatableArray` instead of `Nazrin::PaginatedArray`.
+
+```ruby
+gem 'nazrin-kaminari'
+```
+
+Currently supported libraries
+
+- kaminari: [nazrin-kaminari](https://github.com/tsuwatch/nazrin-kaminari)
+
+### Sandbox mode
+
+When there is no instance for development and you don't want to request to CloudSearch
+
+```ruby
+Nazrion.config.mode = 'sandbox'
+```
+
+"sandbox" mode where it does nothing with any requests and just returns an empty collection for any searches.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/generators/nazrin/templates/nazrin_config.rb

@@ -1,5 +1,5 @@
 Nazrin.configure do |config|
-  config.debug_mode = false
+  config.mode = :production # or sandbox (It does nothing with any requests to CloudSearch)
   config.search_endpoint = ''
   config.document_endpoint = ''
   config.region = ''

data/lib/nazrin/config.rb

@@ -12,6 +12,7 @@ module Nazrin
   class Configuration
     include ActiveSupport::Configurable
     config_accessor :debug_mode
+    config_accessor :mode
     config_accessor :search_endpoint
     config_accessor :document_endpoint
     config_accessor :region

data/lib/nazrin/document_client.rb

@@ -11,7 +11,8 @@ module Nazrin
     end
 
     def add_document(id, field_data)
-      return nil if Nazrin.config.debug_mode
+      ActiveSupport::Deprecation.warn 'config.debug_mode is deprecated. Use config.mode = \'sandbox\' instead.' and return nil if Nazrin.config.debug_mode
+      return nil if Nazrin.config.mode = 'sandbox'
       client.upload_documents(
         documents: [
           {
@@ -24,7 +25,8 @@ module Nazrin
     end
 
     def delete_document(id)
-      return nil if Nazrin.config.debug_mode
+      ActiveSupport::Deprecation.warn 'config.debug_mode is deprecated. Use config.mode = \'sandbox\' instead.' and return nil if Nazrin.config.debug_mode
+      return nil if Nazrin.config.mode = 'sandbox'
       client.upload_documents(
         documents: [
           {

data/lib/nazrin/search_client.rb

@@ -109,11 +109,13 @@ module Nazrin
     end
 
     def search
+      return fake_response if Nazrin.config.mode == 'sandbox'
       fail SearchClientError if deep_page?
       @client.search(@parameters)
     end
 
     def execute
+      return fake_response if Nazrin.config.mode == 'sandbox'
       if data_accessor
         data_accessor.results(self)
       else
@@ -133,5 +135,9 @@ module Nazrin
       end
       false
     end
+
+    def fake_response
+      Nazrin::PaginationGenerator.generate([], { current_page: 1, per_page: 1, total_count: 0 })
+    end
   end
 end

data/lib/nazrin/version.rb

@@ -1,3 +1,3 @@
 module Nazrin
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nazrin
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Tomohiro Suwa