n_1_finder 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53d31e40235f5510cee7b906ce2c83f76d681eb3
-  data.tar.gz: bc1cf15f6593999d87e9f4f10c9e1ab2fcc1cc54
+  metadata.gz: 961ceb11825e90ca10011fb5d9be594976e31d30
+  data.tar.gz: 2223479f079ca9e0c1e1384243e76ad249babf64
 SHA512:
-  metadata.gz: bf40aa00184ebd40ae71ad11e7d19d70af0a7dbd9d3795afe3f9c30cfd9c00246287bf7da75ab975493b839b5630595e83ffe95664542a97f043a9f2ac2b0e2d
-  data.tar.gz: 7ea778e457f4de2dc18d74e48c8d5755722254a76046682eeff1606324a577d4d74f66b70559e05639f5ab4f74332557f5ef3f9d6a5a02e47f82e41436452874
+  metadata.gz: a15d14a85b1293769a7f11b77ff2fd0009b15e43502c8b1bb3ca3393d4f8682bfe71eceab4a5064e7470879498d835b6c4d8a3da7d73556a06089f03d98e0930
+  data.tar.gz: d5814f4732a51d49a1fde41f3a2d5ef7b9125910aae695ea686a959d6b02e0d531a0d0bc572fa20e11998bbd2de6f552e6830a122a61ea7d4ef2fba1174cc2ce

data/Readme.md

@@ -2,6 +2,7 @@
   [![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)
+  [![Code Climate](https://codeclimate.com/github/aglushkov/n1_finder/badges/gpa.svg)](https://codeclimate.com/github/aglushkov/n1_finder)
 
   This gem helps to find N+1 queries.
 
@@ -12,27 +13,6 @@
 ## Installation
   `gem 'n_1_finder', group: :development`
 
-## Configuration
-### Logger
-Default is `Logger.new(STDOUT)`
-
-Logger can be any instance of `Logger` class.
-
-```ruby
-  N1Finder.logger = Logger.new('log/n1.log')
-```
-
-### ORM
-Default is `:active_record` if you have activerecord gem installed.
-
-Default is `:sequel` if you have sequel gem installed.
-
-Allowed values are `:active_record` and `:sequel`
-
-```ruby
-  N1Finder.orm = :active_record
-```
-
 ## Using
 Include middleware to your Rack app:
 ```ruby
@@ -68,6 +48,27 @@ N+1 QUERY DETECTED:
     SELECT  "comments".* FROM "comments" WHERE "comments"."user_id" = $1, user_id = 947
 ```
 
+## Configuration
+### Logger
+Default is `Logger.new(STDOUT)`
+
+Logger can be any instance of `Logger` class.
+
+```ruby
+  N1Finder.logger = Logger.new('log/n1.log')
+```
+
+### ORM
+Default is `:active_record` if you have activerecord gem installed.
+
+Default is `:sequel` if you have sequel gem installed.
+
+Allowed values are `:active_record` and `:sequel`
+
+```ruby
+  N1Finder.orm = :active_record
+```
+
 ## Running tests
 - Copy `spec/.env.example` file to `spec/.env` and set database credentials.
 ```bash

data/lib/n_1_finder.rb

@@ -1,32 +1,7 @@
-require 'n_1_finder/logger'
-require 'n_1_finder/middleware'
-require 'n_1_finder/query'
-require 'n_1_finder/n_1_query'
-require 'n_1_finder/storage'
-require 'n_1_finder/adapters/base_adapter'
-require 'n_1_finder/adapters/active_record_adapter'
-require 'n_1_finder/adapters/sequel_adapter'
-require 'n_1_finder/adapters/null_adapter'
-
 # Main class
 class N1Finder
-  # Base error
-  # @api private
-  class Invalid < StandardError; end
-
-  # Raised when specifying invalid ORM
-  # @api private
-  class InvalidORM < Invalid; end
-
-  # Raised when specifying invalid logger
-  # @api private
-  class InvalidLogger < Invalid; end
-
   # Supported ORM adapters
-  ORM_ADAPTERS = {
-    active_record: N1Finder::Adapters::ActiveRecordAdapter,
-    sequel: N1Finder::Adapters::SequelAdapter
-  }.freeze
+  ORM_ADAPTERS = [:active_record, :sequel].freeze
 
   class << self
     # Supported ORM adapters
@@ -37,10 +12,10 @@ class N1Finder
     #
     # @return [void] result of block call
     def find
-      storage = N1Finder::Storage.new
+      storage = Storage.new
       result = catch_queries(storage) { yield }
-      n1_queries = N1Finder::N1Query.generate_by(storage.queries)
-      N1Finder::Logger.new.log(n1_queries)
+      n1_queries = N1Query.generate_by(storage.queries)
+      Logger.new.log(n1_queries)
 
       result
     end
@@ -59,11 +34,11 @@ class N1Finder
     # @param [Logger] custom_logger
     #   Must be instance of `Logger`
     #
-    # @raise [N1Finder::InvalidLogger] If custom_logger is not an instance of `Logger`.
+    # @raise [N1Finder::Errors::InvalidLogger] If custom_logger is not an instance of `Logger`.
     #
     # @return [Logger]
     def logger=(custom_logger)
-      raise N1Finder::InvalidLogger unless custom_logger.is_a?(::Logger)
+      raise Errors::InvalidLogger unless custom_logger.is_a?(::Logger)
 
       @logger = custom_logger
     end
@@ -75,12 +50,11 @@ class N1Finder
     #
     # @return [Symbol, nil]
     def orm
-      @orm ||=
-        if defined?(ActiveRecord)
-          :active_record
-        elsif defined?(Sequel)
-          :sequel
-        end
+      @orm ||= if defined?(ActiveRecord)
+        :active_record
+      elsif defined?(Sequel)
+        :sequel
+      end
     end
 
     # Configure ORM
@@ -88,11 +62,11 @@ class N1Finder
     # @param [Symbol] custom_orm
     #   Must be `:active_record` or `:sequel`
     #
-    # @raise [N1Finder::InvalidORM] If custom_orm is not in allowed list.
+    # @raise [N1Finder::Errors::InvalidORM] If custom_orm is not in allowed list.
     #
     # @return [Symbol]
     def orm=(custom_orm)
-      raise N1Finder::InvalidORM unless ORM_ADAPTERS.keys.include?(custom_orm)
+      raise Errors::InvalidORM unless ORM_ADAPTERS.include?(custom_orm)
 
       @orm = custom_orm
     end
@@ -100,12 +74,22 @@ class N1Finder
     private
 
     def catch_queries(storage)
-      adapter = adapter_class.new(storage)
+      adapter = Adapters::Factory.get(orm, storage)
       adapter.exec(&Proc.new)
     end
-
-    def adapter_class
-      ORM_ADAPTERS[orm] || N1Finder::Adapters::NullAdapter
-    end
   end
 end
+
+require 'n_1_finder/logger'
+require 'n_1_finder/middleware'
+require 'n_1_finder/query'
+require 'n_1_finder/n_1_query'
+require 'n_1_finder/storage'
+require 'n_1_finder/adapters/factory'
+require 'n_1_finder/adapters/base_adapter'
+require 'n_1_finder/adapters/active_record_adapter'
+require 'n_1_finder/adapters/sequel_adapter'
+require 'n_1_finder/adapters/null_adapter'
+require 'n_1_finder/errors/base'
+require 'n_1_finder/errors/invalid_orm'
+require 'n_1_finder/errors/invalid_logger'

data/lib/n_1_finder/adapters/base_adapter.rb

@@ -1,46 +1,43 @@
 ##
-# Combine ORM adapters
+# Adds common functionality to other adapters
 #
-module N1Finder::Adapters
-  # Adds common functionality to other adapters
-  class BaseAdapter
-    # An alias that we create for MAIN_METHOD function
-    MAIN_METHOD_ALIAS = :main_method_alias
+class N1Finder::Adapters::BaseAdapter
+  # An alias that we create for MAIN_METHOD function
+  MAIN_METHOD_ALIAS = :main_method_alias
 
-    # @!attribute [r] storage
-    #   Storage that stores queries
-    attr_reader :storage
+  # @!attribute [r] storage
+  #   Storage that stores queries
+  attr_reader :storage
 
-    def initialize(storage)
-      @storage = storage
-    end
+  def initialize(storage)
+    @storage = storage
+  end
 
-    # Replaces original query execution function (defined in MAIN_METHOD)
-    # with our function that collects all queries and calls original function.
-    # After passed block yileds, replaces our function with origianal and
-    # removes our function.
-    #
-    # @yield passed block
-    #
-    # @return passed block execution result
-    def exec
-      set_trap
-      yield
-    ensure
-      remove_trap
-    end
+  # Replaces original query execution function (defined in MAIN_METHOD)
+  # with our function that collects all queries and calls original function.
+  # After passed block yileds, replaces our function with origianal and
+  # removes our function.
+  #
+  # @yield passed block
+  #
+  # @return passed block execution result
+  def exec
+    set_trap
+    yield
+  ensure
+    remove_trap
+  end
 
-    private
+  private
 
-    def remove_trap
-      main_query_method = self.class::MAIN_METHOD
-      main_method_alias = MAIN_METHOD_ALIAS
+  def remove_trap
+    main_query_method = self.class::MAIN_METHOD
+    main_method_alias = MAIN_METHOD_ALIAS
 
-      database_class.class_eval do
-        remove_method(main_query_method)
-        alias_method main_query_method, main_method_alias
-        remove_method(main_method_alias)
-      end
+    database_class.class_eval do
+      remove_method(main_query_method)
+      alias_method main_query_method, main_method_alias
+      remove_method(main_method_alias)
     end
   end
 end

data/lib/n_1_finder/adapters/factory.rb

@@ -0,0 +1,16 @@
+# Combine ORM adapters
+module N1Finder::Adapters
+  # Adapters factory
+  class Factory
+    # Constructs new instance of adapter
+    def self.get(key, storage)
+      adapter_class = case key
+        when :active_record then N1Finder::Adapters::ActiveRecordAdapter
+        when :sequel then N1Finder::Adapters::SequelAdapter
+        else N1Finder::Adapters::NullAdapter
+      end
+
+      adapter_class.new(storage)
+    end
+  end
+end

data/lib/n_1_finder/errors/base.rb

@@ -0,0 +1,7 @@
+# Errors module
+# @api private
+module N1Finder::Errors
+  # Base error class
+  class Base < StandardError
+  end
+end

data/lib/n_1_finder/errors/invalid_logger.rb

@@ -0,0 +1,4 @@
+# Raised when specifying invalid logger
+# @api private
+class N1Finder::Errors::InvalidLogger < N1Finder::Errors::Base
+end

data/lib/n_1_finder/errors/invalid_orm.rb

@@ -0,0 +1,4 @@
+# Raised when specifying invalid ORM
+# @api private
+class N1Finder::Errors::InvalidORM < N1Finder::Errors::Base
+end

data/lib/n_1_finder/version.rb

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

data/spec/n_1_finder/adapters/factory_spec.rb

@@ -0,0 +1,36 @@
+RSpec.describe N1Finder::Adapters::Factory do
+  describe '.get' do
+    let(:storage) { 'STORAGE' }
+    subject { described_class.get(key, storage) }
+
+    context 'getting active_record' do
+      let(:key) { :active_record }
+      it 'returns active_record adapter' do
+        expect(subject).to be_a(N1Finder::Adapters::ActiveRecordAdapter)
+      end
+      it 'sets storage' do
+        expect(subject.storage).to eq storage
+      end
+    end
+
+    context 'getting sequel' do
+      let(:key) { :sequel }
+      it 'returns sequel adapter' do
+        expect(subject).to be_a(N1Finder::Adapters::SequelAdapter)
+      end
+      it 'sets storage' do
+        expect(subject.storage).to eq storage
+      end
+    end
+
+    context 'getting other adapter' do
+      let(:key) { :other }
+      it 'returns sequel adapter' do
+        expect(subject).to be_a(N1Finder::Adapters::NullAdapter)
+      end
+      it 'sets storage' do
+        expect(subject.storage).to eq storage
+      end
+    end
+  end
+end

data/spec/n_1_finder_spec.rb

@@ -42,7 +42,7 @@ RSpec.describe N1Finder do
     context 'when logger is not a Logger' do
       let(:logger) { nil }
       it 'raises error' do
-        expect { subject }.to raise_error described_class::InvalidLogger
+        expect { subject }.to raise_error described_class::Errors::InvalidLogger
       end
     end
   end
@@ -50,7 +50,7 @@ RSpec.describe N1Finder do
   describe '#orm=' do
     subject { described_class.orm = orm }
     context 'when provided supported orm' do
-      let(:orm) { described_class::ORM_ADAPTERS.keys.sample }
+      let(:orm) { described_class::ORM_ADAPTERS.sample }
       it 'sets orm' do
         subject
         expect(described_class.orm).to eq orm
@@ -60,7 +60,7 @@ RSpec.describe N1Finder do
     context 'when orm is not supported' do
       let(:orm) { :mongo }
       it 'raises error' do
-        expect { subject }.to raise_error N1Finder::InvalidORM
+        expect { subject }.to raise_error described_class::Errors::InvalidORM
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n_1_finder
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Andrey Glushkov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
+date: 2016-07-01 00:00:00.000000000 Z
 dependencies: []
 description: Finds N+1 queries
 email: aglushkov@shakuro.com
@@ -20,8 +20,12 @@ files:
 - lib/n_1_finder.rb
 - lib/n_1_finder/adapters/active_record_adapter.rb
 - lib/n_1_finder/adapters/base_adapter.rb
+- lib/n_1_finder/adapters/factory.rb
 - lib/n_1_finder/adapters/null_adapter.rb
 - lib/n_1_finder/adapters/sequel_adapter.rb
+- lib/n_1_finder/errors/base.rb
+- lib/n_1_finder/errors/invalid_logger.rb
+- lib/n_1_finder/errors/invalid_orm.rb
 - lib/n_1_finder/logger.rb
 - lib/n_1_finder/middleware.rb
 - lib/n_1_finder/n_1_query.rb
@@ -30,6 +34,7 @@ files:
 - lib/n_1_finder/version.rb
 - spec/.env.example
 - spec/n_1_finder/adapters/active_record_adapter_spec.rb
+- spec/n_1_finder/adapters/factory_spec.rb
 - spec/n_1_finder/adapters/null_adapter_spec.rb
 - spec/n_1_finder/adapters/sequel_adapter_spec.rb
 - spec/n_1_finder/features/active_record_mysql_spec.rb