association_count 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1fcc68fe097ba408a4885766a0cd17102bbe5089
-  data.tar.gz: a96d3b8013465d5278b8f99d66344231f7bd7c0e
+SHA256:
+  metadata.gz: 42248c2a05d75c6ee5a6b9959fe8c5687210802a93163c7e984b8ee2415b87ec
+  data.tar.gz: 6ddaa4c21d1c0289e3199aa1fcdf1faec9236908ffb1ae7f171ba993450774da
 SHA512:
-  metadata.gz: 9fe60b5703414c9e644defc0eeab240d711028e24b43da349e6c0001699814f773108a6fb713085fb2a76f62e973995ca33e456f857404f9b1bd71b8e7cb0d6d
-  data.tar.gz: 550d3574989d39bce857f802bf75acbe0e9af9490e76a5da0c039a02bce7602122bfae8bad2c2262bdda8915ea31ce81b77b67e8691ce80d696c8e044f677447
+  metadata.gz: 99e29c73a3c6afc83a220bae9b67a2b842795595712ce80ef63ae8de5b99a52499f1624d24314e0b1e8983068f961d777c3fa58e33cef98918730cbf23a9321c
+  data.tar.gz: 55f58a8be27457398bf68ecaad839fb5508c48dcefc479b49d59ae2c398d0e78e83d9dadf9b874509a0f25ecac1575cf170cc5f68582c79a51a4c023fab48e1f

data/.gitignore

@@ -8,3 +8,6 @@
 /spec/reports/
 /tmp/
 *.gem
+
+# ignore test database
+spec/association_count.sqlite3

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
   - 2.2
+  - 2.5
 script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# HEAD
+
+## v1.1
+
+- :warning: _Breaking change/Bug fix_: Move from `joins` to `left_outer_joins` by default, see [PR#3](https://github.com/buren/association_count/pull/3)
+  + You can still configure it to use `joins` by default - see [README](README,md)
+- Configure options globally, per model or per method call
+
+---
+
+# v1.0
+
+..is history

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Albin Svensson
+Copyright (c) 2018 Jacob Burenstam Linder, Albin Svensson
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,5 +1,10 @@
 # AssociationCount [![Build Status](https://travis-ci.org/buren/association_count.svg?branch=master)](https://travis-ci.org/buren/association_count)
 
+Get ActiveRecord association count with ease and without worrying about N+1 queries:
+```ruby
+Author.all.include_post_count.map(&:post_count)
+```
+
 A small gem for ActiveRecord that allows association counts to be included in your base query.
 
 ## Installation
@@ -50,6 +55,7 @@ Rails 4, add it to `ActiveRecord::Base`
 ActiveRecord::Base.extend AssociationCount
 ```
 
+Full example
 ```ruby
 class Foo < ActiveRecord::Base
   has_many  :bars
@@ -69,12 +75,28 @@ foos = Foo.all.association_count(Bar)
 
 This works for any `has_many` relationship even if it uses non standard foreign keys or is a `has_many :x, through: y`.
 
-By default the count will be distinct, if this is not desired use:
+:information_source: By default we will use left outer join and __not__ distinct.
 
-```
+You can configure this on per model basis
+```ruby
 class Foo < ActiveRecord::Base
   has_many  :bars
-  can_count :bars, distinct: false
+  can_count :bars, distinct: true, join_type: :joins # can also be left_outer_joins
+end
+```
+
+or on a case by case basis
+
+```ruby
+Foo.all.include_bar_count(distinct: false, join_type: :left_outer_joins)
+```
+
+## Configuration
+
+```ruby
+AssociationCount.configure do |config|
+  config.distinct = false
+  config.join_type = :joins # or left_outer_joins
 end
 ```
 

data/association_count.gemspec

@@ -8,7 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = AssociationCount::VERSION
   spec.authors       = ['Albin Svensson', 'Jacob Burenstam']
   spec.email         = ['burenstam@gmail.com']
-  spec.summary       = 'A small gem for ActiveRecord that allows association counts to be included in your base query'
+  spec.summary       = 'Get an ActiveRecord association count with ease and without worrying about N+1 queries.'
+  spec.description   = 'Get an ActiveRecord association count with ease and without worrying about N+1 queries. A small gem for ActiveRecord that allows association counts to be included in your base query.'
   spec.homepage      = 'https://github.com/buren/association_count'
   spec.license       = 'MIT'
 

data/lib/association_count.rb

@@ -1,15 +1,17 @@
 require 'association_count/version'
 
 module AssociationCount
-  DEFAULT_DISTINCT = false
-
-  def association_count(counted_model, distinct: DEFAULT_DISTINCT)
+  def association_count(
+    counted_model,
+    distinct: AssociationCount.config.distinct,
+    join_type: AssociationCount.config.join_type
+  )
     table_name    = self.table_name
     counted_table = counted_model.table_name
     counted_name  = counted_table.singularize
     distinct_sql  = distinct ? 'DISTINCT' : ''
 
-    joins(counted_table.to_sym)
+    public_send(join_type, counted_table.to_sym)
       .select("#{table_name}.*, COUNT(#{distinct_sql} #{counted_table}.id) as #{counted_name}_count_raw")
       .group("#{table_name}.id")
   end
@@ -17,13 +19,16 @@ module AssociationCount
   def can_count(model_name, opts = {})
     model_name = model_name.to_s
     reflection = reflections[model_name]
-    fail "No such reflection: '#{model_name}'" unless reflection
+    raise ArgumentError, "No such reflection: '#{model_name}'" unless reflection
 
-    options       = { distinct: DEFAULT_DISTINCT }.merge!(opts)
+    options = {
+      distinct: AssociationCount.config.distinct,
+      join_type: AssociationCount.config.join_type
+    }.merge!(opts)
     singular_name = model_name.singularize
 
     define_association_count_method(model_name, singular_name)
-    define_count_scope(singular_name, reflection, options[:distinct])
+    define_count_scope(singular_name, reflection, options[:distinct], options[:join_type])
   end
 
   def define_association_count_method(model_name, singular_name)
@@ -34,12 +39,43 @@ module AssociationCount
     end
   end
 
-  def define_count_scope(singular_name, reflection, default_distinct)
+  def define_count_scope(singular_name, reflection, default_distinct, default_join_type)
     scope_name = "include_#{singular_name}_count"
     class_eval do
-      scope scope_name, ->(distinct: default_distinct) {
-        association_count(reflection.klass, distinct: distinct)
+      scope scope_name, ->(distinct: default_distinct, join_type: default_join_type) {
+        association_count(reflection.klass, distinct: distinct, join_type: join_type)
       }
     end
   end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.config
+    configuration
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+    configuration
+  end
+
+  class Configuration
+    attr_accessor :distinct
+    attr_reader :join_type
+
+    def initialize
+      @distinct = false
+      @join_type = :left_outer_joins
+    end
+
+    def join_type=(type)
+      type = type.to_sym
+      unless %i[left_outer_joins joins].include?(type)
+        raise(ArgumentError, "unknown join type '#{type}', must be one of left_outer_joins, joins")
+      end
+      @join_type = type.to_sym
+    end
+  end
 end

data/lib/association_count/version.rb

@@ -1,3 +1,3 @@
 module AssociationCount
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: association_count
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Albin Svensson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-13 00:00:00.000000000 Z
+date: 2018-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,7 +123,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-description: 
+description: Get an ActiveRecord association count with ease and without worrying
+  about N+1 queries. A small gem for ActiveRecord that allows association counts to
+  be included in your base query.
 email:
 - burenstam@gmail.com
 executables: []
@@ -133,6 +135,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -163,9 +166,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: A small gem for ActiveRecord that allows association counts to be included
-  in your base query
+summary: Get an ActiveRecord association count with ease and without worrying about
+  N+1 queries.
 test_files: []