sequel-asterisk-hunter 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6807749242bc3d6940d7dc0b90bab947edcd38b0c57970425e4a4344315a08ac
-  data.tar.gz: 5c1e25f1d3cfd7ec84fa63e3539dd012f5a2d11d23481a42033a1869ebd08a0f
+  metadata.gz: 184314bd889776102faf9c036f3bf27971a6c223eb58149a81d4c059dba9abb7
+  data.tar.gz: f983c5d3722513396327fcb19881a2a3cbb7b155e5c51670ec2a5f359d9dddec
 SHA512:
-  metadata.gz: f328246f6744a3131e9a1e1e004ba2ad3313df9aba5af3569fa6a4956e23720c2b744b60ff89b185f9e8ae13fcfdaf4cbd9c04cd18960d96c9e1fabe2c835bc1
-  data.tar.gz: 74485357975f0c0ceb8df9ab40027b555bd81923835b534e6d150c5d5a4db61528ec053d046900465374b29329a992fa73dca5d227321af00984a259f13ebd30
+  metadata.gz: ad5a7cf4369c55267de29faf95b522fb0b7c337d57c38a1d166dab94898a8660606b151b66c2823e8692c45b8a7f3276ba21509ef7efe46fcd52935d2582acf8
+  data.tar.gz: 56a829e908a4ae83021d79499af11281ef7b18b6b194d48b36197bb95f321e3ce29bd0de6ce97f4ab51de8862d9a379f62d3bab5859171a715ec4d00aef867ad

data/README.md

@@ -1,6 +1,6 @@
 # SequelAsteriskHunter
 
-This extension adds the `Sequel::Dataset#hunt` method, which...
+This extension hooks into `Sequel::Dataset#all` method, doing some predefined action when an `SELECT *` statement is found.
 
 ## Installation
 
@@ -16,7 +16,9 @@ Or install it yourself as:
 
     $ gem install sequel-asterisk-hunter
 
-The plugin needs to be initialized by the Sequel extension interface. The simplest way to configure plugin globally is adding this line to the initializer:
+## Usage
+
+The extension needs to be initialized by the Sequel extension interface. The simplest way to configure it globally is adding this line to the initializer:
 
 ```ruby
 Sequel.extension :asterisk_hunter
@@ -26,20 +28,42 @@ or
 Sequel::Database.extension :asterisk_hunter
 ```
 
-But anyway I recommend reading more about [Sequel extensions system](https://github.com/jeremyevans/sequel/blob/master/doc/extensions.rdoc#sequel-extensions).
+However, if you are using any framework (like Rails) where your Sequel::Database instance already exists, you should use `DB.extension :asterisk_hunter`, where `DB` is a reference to your Sequel::Database, like this:
 
-## Usage
+```ruby
+Sequel::Model.db.extension :asterisk_hunter
+```
+
+You could define an action to be executed when any `SELECT *` statement is found. It must be any callable object.
 
+### Examples
+
+With the default action:
 ```ruby
-dataset.hunt
+DB[:my_table].all
+  #=> "Find 'SELECT *' in query!"
+  #=> [<All your objects and its attributes/columns>]
 ```
 
-## Usage examples
+With some custom actions defined:
+- Raising an error:
+```ruby
+action = -> { raise StandardError, "Find 'SELECT *' in query!" }
+Sequel::Extensions::AsteriskHunter.define_action(action)
 
-### Hunting 'SELECT * ...'
+DB[:my_table].all
+  #=> StandardError("Find 'SELECT *' in query!")
+  # (Your query is not executed...)
+```
+
+- Logging:
 ```ruby
-DB[:my_table].hunt
-  #=> #<Sequel::YourAdapter::Dataset: "SELECT * FROM \"my_table\"">
+action = -> { Rails.logger.warn("Find 'SELECT *' in query!") }
+Sequel::Extensions::AsteriskHunter.define_action(action)
+
+DB[:my_table].all
+  #=> "Find 'SELECT *' in query!"
+  #=> [<All your objects and its attributes/columns>]
 ```
 
 ## Contributing

data/lib/sequel-asterisk-hunter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SequelAsteriskHunter
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/sequel/extensions/asterisk_hunter.rb

@@ -5,8 +5,22 @@ require "sequel"
 module Sequel
   module Extensions
     module AsteriskHunter
-      def hunt(action: :log)
-        return 'Find it!' if self.inspect.include?('SELECT *')
+      @@action = -> { puts "Find 'SELECT *' in query!" }
+
+      def all
+        hunt
+        super
+      end
+
+      def self.define_action(action)
+        raise TypeError, 'Action parameter must be a callable object!' unless action.respond_to?(:call)
+        @@action = action
+      end
+
+      private
+
+      def hunt
+        @@action.call if self.inspect.include?('SELECT *')
         self
       end
     end

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: sequel-asterisk-hunter
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Danilo Barion Nogueira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-21 00:00:00.000000000 Z
+date: 2018-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.48.0
+        version: '5.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.48.0
-description: The Sequel extension which allow you to find all your 'SELECT * FROM
-  ...' queries.
+        version: '5.10'
+description: This extension hooks into `Sequel::Dataset#all` method, doing some predefined
+  action when an `SELECT *` statement is found.
 email: danilo.barion@gmail.com
 executables: []
 extensions: []
@@ -47,9 +47,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -60,6 +60,6 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: The Sequel extension which allow you to find all your 'SELECT * FROM ...'
-  queries.
+summary: Sequel extension which allow you to do some action when find any 'SELECT
+  *' queries.
 test_files: []