n_1_finder 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e389a1727607242ce3f686e8db20fcdc33ca3ed
-  data.tar.gz: 49a22b9adf74c1c1f329e1b2970e647659cef94b
+  metadata.gz: ab7427d8a228787f6c0ec69a45911a03c2db8d88
+  data.tar.gz: e2466e6c7fe33f5e262938fd74e465eda7e91c6d
 SHA512:
-  metadata.gz: 1e240024894cf46304884f59d98d9396f33218f5069e6b468cc0104df9d75e5254472639ca7aa5856ce0e2a2a0f829f4852f89aafd82003aa079277cee58bd0c
-  data.tar.gz: 17266b8396fdcb2cbe1fe0d710364efee3154963cdaa9f4dbe19cb63a3c70a6af2f3c1aa87bc9d41124e03824908ae88eefb2262ef5263621440487cc221811d
+  metadata.gz: c45009c7542f01b595f26450c890e85b3904b1d4635d3df4043b66388f145dc2423c1226ea045cadeed2034b922a772775a937fedc0a676237c5bee510acbae6
+  data.tar.gz: d3037ad0f27c81ff23bfbc9458708cc8a28d9cba4d0e54384f581135d7f83a3492c93dc1d4a7ff9d26cb745013dd476772006860efedd610b5a4814203bab3f3

data/Readme.md

@@ -1,20 +1,22 @@
 # N+1 Finder
-  This gem can help you to find N+1 queries.
+  [![Gem Version](https://badge.fury.io/rb/n_1_finder.svg)](https://badge.fury.io/rb/n_1_finder)
+  [![Build Status](https://api.travis-ci.org/aglushkov/n1_finder.svg?branch=master)](https://travis-ci.org/aglushkov/n1_finder)
+  [![Inline docs](http://inch-ci.org/github/aglushkov/n1_finder.svg?branch=master)](http://inch-ci.org/github/aglushkov/n1_finder)
+
+  This gem helps to find N+1 queries.
 
   It works with `ActiveRecord` and `Sequel`.
 
   And tested with `postgresql`, `mysql` and `sqlite`.
 
 ## Installation
-  With Gemfile: `gem 'n1_finder', group: :development`
-
-  Without Gemfile: `gem install n1_finder`
+  `gem 'n_1_finder', group: :development`
 
 ## Configuration
 ### Logger
 Default is `Logger.new(STDOUT)`
 
-`N+1 Finder` logger can be any instance of `Logger` class.
+Logger can be any instance of `Logger` class.
 
 ```ruby
   N1Finder.logger = Logger.new('log/n1.log')
@@ -25,14 +27,29 @@ Default is `:active_record` if you have activerecord gem installed.
 
 Default is `:sequel` if you have sequel gem installed.
 
-You can set ORM explicitly
+Allowed values are `:active_record` and `:sequel`
+
 ```ruby
   N1Finder.orm = :active_record
 ```
 
 ## Using
+Include middleware to your Rack app:
+```ruby
+# Rails
+class Application < Rails::Application
+  config.middleware.use(N1Finder::Middleware)
+  ...
+# Grape
+class YourAPI < Grape::API
+  use N1Finder::Middleware
+  ...
+# Padrino
+class YourAPP < Padrino::Application
+  use N1Finder::Middleware
+```
 
-### Directly
+Or use it directly:
 ```ruby
   N1Finder.find do
     User.all.map { |user| user.comments.to_a }
@@ -51,24 +68,18 @@ N+1 QUERY DETECTED:
     SELECT  "comments".* FROM "comments" WHERE "comments"."user_id" = $1, user_id = 947
 ```
 
-### Middleware
-`N+1 Finder` provides middleware that you can include to any rack application to find N+1 queries in your requests:
-
-#### Rails
-```ruby
-class Application < Rails::Application
-  config.middleware.use(N1Finder::Middleware)
+## Running tests
+- Copy `spec/.env.example` file to `spec/.env` and set database credentials.
+```bash
+cp spec/.env.example spec/.env
 ```
 
-#### Grape
-```ruby
-class YourAPI < Grape::API
-  use N1Finder::Middleware
-```
-
-#### Padrino
-```ruby
-class YourAPP < Padrino::Application
-  use N1Finder::Middleware
+- Load this variables into your system.
+```bash
+source spec/.env
 ```
 
+- Run tests.
+```bash
+rspec
+```

data/lib/n_1_finder/version.rb

@@ -1,4 +1,4 @@
 class N1Finder
   # Gem version
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.3'.freeze
 end

data/spec/.env.example

@@ -0,0 +1,7 @@
+export PG_USERNAME=
+export PG_PASSWORD=
+export PG_DATABASE=
+
+export MYSQL_USERNAME=
+export MYSQL_PASSWORD=
+export MYSQL_DATABASE=

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'pry-nav'
+require 'pry-nav' if RUBY_PLATFORM != 'java'
 require 'bundler/setup'
 Bundler.setup
 

data/spec/support/orm_helpers.rb

@@ -1,58 +1,40 @@
-require 'yaml'
+# rubocop:disable Metrics/LineLength
 
 module ORMHelpers
-  SECRETS = YAML.load(File.open('spec/secrets.yml'))
-
-  DB_PARAMS = {
-    active_record: {
-      sqlite: {
-        adapter: 'sqlite3',
-        database: ':memory:'
-      },
-      pg: {
-        adapter: 'postgresql',
-        host: 'localhost',
-        username: SECRETS[:pg][:username].to_s,
-        password: SECRETS[:pg][:password].to_s,
-        database: SECRETS[:pg][:database].to_s
+  DB_PARAMS = Hash.new { |hash, _key| hash['mri'] }.update(
+    'mri' => {
+      active_record: {
+        sqlite: 'sqlite3::memory:',
+        pg: "postgres://#{ENV['PG_USERNAME']}:#{ENV['PG_PASSWORD']}@localhost/#{ENV['PG_DATABASE']}",
+        mysql: "mysql2://#{ENV['MYSQL_USERNAME']}:#{ENV['MYSQL_PASSWORD']}@localhost/#{ENV['MYSQL_DATABASE']}"
       },
-      mysql: {
-        adapter: 'mysql',
-        host: 'localhost',
-        username: SECRETS[:mysql][:username].to_s,
-        password: SECRETS[:mysql][:password].to_s,
-        database: SECRETS[:mysql][:database].to_s
+      sequel: {
+        sqlite: 'sqlite::memory:',
+        pg: "postgres://#{ENV['PG_USERNAME']}:#{ENV['PG_PASSWORD']}@localhost/#{ENV['PG_DATABASE']}",
+        mysql: "mysql2://#{ENV['MYSQL_USERNAME']}:#{ENV['MYSQL_PASSWORD']}@localhost/#{ENV['MYSQL_DATABASE']}"
       }
     },
-    sequel: {
-      sqlite: {
-        adapter: 'sqlite',
-        database: ':memory:'
-      },
-      pg: {
-        adapter: 'postgres',
-        host: 'localhost',
-        username: SECRETS[:pg][:username].to_s,
-        password: SECRETS[:pg][:password].to_s,
-        database: SECRETS[:pg][:database].to_s
+    'java' => {
+      active_record: {
+        sqlite: 'sqlite3::memory:',
+        pg: "postgresql://#{ENV['PG_USERNAME']}:#{ENV['PG_PASSWORD']}@localhost/#{ENV['PG_DATABASE']}",
+        mysql: "mysql2://#{ENV['MYSQL_USERNAME']}:#{ENV['MYSQL_PASSWORD']}@localhost/#{ENV['MYSQL_DATABASE']}"
       },
-      mysql: {
-        adapter: 'mysql',
-        host: 'localhost',
-        username: SECRETS[:mysql][:username].to_s,
-        password: SECRETS[:mysql][:password].to_s,
-        database: SECRETS[:mysql][:database].to_s
+      sequel: {
+        sqlite: 'jdbc:sqlite::memory:',
+        pg: "jdbc:postgresql://localhost/#{ENV['PG_DATABASE']}?user=#{ENV['PG_USERNAME']}&password=#{ENV['PG_PASSWORD']}",
+        mysql: "jdbc:mysql://localhost/#{ENV['MYSQL_DATABASE']}?user=#{ENV['MYSQL_USERNAME']}&password=#{ENV['MYSQL_PASSWORD']}"
       }
     }
-  }.freeze
+  )
 
   def connect_sequel(adapter)
-    Sequel::Model.db = Sequel.connect(DB_PARAMS[:sequel][adapter])
+    Sequel::Model.db = Sequel.connect(DB_PARAMS[RUBY_PLATFORM][:sequel][adapter])
     TestSequelMigration.up
   end
 
   def connect_active_record(adapter)
-    ActiveRecord::Base.establish_connection(DB_PARAMS[:active_record][adapter])
+    ActiveRecord::Base.establish_connection(DB_PARAMS[RUBY_PLATFORM][:active_record][adapter])
     silence_stream(STDOUT) { TestActiveRecordMigration.up }
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: n_1_finder
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Andrey Glushkov
@@ -28,6 +28,7 @@ files:
 - lib/n_1_finder/query.rb
 - lib/n_1_finder/storage.rb
 - lib/n_1_finder/version.rb
+- spec/.env.example
 - spec/n_1_finder/adapters/active_record_adapter_spec.rb
 - spec/n_1_finder/adapters/null_adapter_spec.rb
 - spec/n_1_finder/adapters/sequel_adapter_spec.rb
@@ -43,7 +44,6 @@ files:
 - spec/n_1_finder/query_spec.rb
 - spec/n_1_finder/storage_spec.rb
 - spec/n_1_finder_spec.rb
-- spec/secrets.yml.example
 - spec/shared_examples/adapter.rb
 - spec/spec_helper.rb
 - spec/support/n_1_helpers.rb

data/spec/secrets.yml.example

@@ -1,9 +0,0 @@
-:pg:
-  :username: XXX
-  :password: XXX
-  :database: XXX
-
-:mysql:
-  :username: XXX
-  :password: XXX
-  :database: XXX