sql_attributes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6fda02cea7a7746bb74220df0ba4e08a7d6010af032ac846c7940e5e4350aed7
+  data.tar.gz: 283e7ddeb199f24a612a7da5986b432c3f6624150cc111ebbba4a18530f892e3
+SHA512:
+  metadata.gz: 271b57dc2390c00e5fa7bd640e6c7ccedd70cb52a597fcaf97f51869d4df5632e88cef41dcc72f7ef0877fc170d8b80fa2b177fc7d01bd8516be168c843ccc96
+  data.tar.gz: 02d117721e8110f08e0caa96b1fdcc10443540d46d498805b3c7e191fe8444eeecf84f7032af098f107689189052310be77efda22ff9482fb554399a298881bb

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Stef Schenkelaars
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+# SQL Attributes
+This gem is here to help you with fetching record specific data from the database using subqueries. You could also use this gem as an alternative for counter caches but of course you should think about this carefully since it can be read heavy.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sql_attributes'
+```
+   
+The of course run `bundle install`. 
+
+## Usage
+It starts by defining an SQL attribute on a class:
+
+```ruby
+class Author < ApplicationRecord
+  sql_attribute :books_count, <<~SQL
+    SELECT COUNT(*)
+    FROM books
+    WHERE books.author_id = books.id
+  SQL
+  
+  sql_attribute :total_pages, <<~SQL
+    SELECT SUM(books.pages)
+    FROM books
+    WHERE books.author_id = books.id
+  SQL
+
+  # Note that this aggregation method `GROUP_CONCAT` is different for other databases like Postgres 
+  sql_attribute :publisher_names, <<~SQL
+    SELECT DISTINCT GROUP_CONCAT(publishers.name, ' - ')
+    FROM publishers
+    INNER JOIN books ON books.publisher_id = publishers.id
+    WHERE books.author_id = authors.id
+    GROUP BY books.author_id
+  SQL
+end
+```
+
+Before you can access the attribute, you have to include it to the SQL query. An error will be raised if you dont: 
+```ruby
+authors = Author.all
+authors.map(&:books_count) # => raises SqlAttributes::NotLoaded
+authors.map(&:total_pages) # => raises SqlAttributes::NotLoaded
+```
+
+You can tell ActiveRecord / Arel to include a specific attribute by using the `with_<NAME>` helpers: 
+```ruby
+authors = Author.with_books_count.all
+authors.map(&:books_count) # => [1, 2]
+authors.map(&:total_pages) # => raises SqlAttributes::NotLoaded
+```
+
+These methods are chainable and can be combined with normal scopes:
+```ruby
+authors = Author.where(publisher_id: 42).with_books_count.with_total_pages.all
+authors.map(&:books_count) # => [1, 2]
+authors.map(&:total_pages) # => [300, 500]
+```
+
+You can also load the attributes with the `with_sql_attributes` helper:
+```ruby
+authors = Author.with_sql_attributes(:books_count, :publisher_names)
+authors.map(&:books_count) # => [1, 2]
+authors.map(&:total_pages) # => raises SqlAttributes::NotLoaded
+```
+
+If you don't pass any argument, it will load all SQL attributes:
+```ruby
+authors = Author.with_sql_attributes
+authors.map(&:books_count) # => [1, 2]
+authors.map(&:total_pages) # => [300, 500]
+```
+
+## Releasing new version
+Publishing a new version is handled by the publish workflow. This workflow publishes a GitHub release to rubygems and GitHub package registry with the version defined in the release.
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/Drieam/sql_attributes.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+A big inspration is [this blog](https://medium.com/@eric.programmer/the-sql-alternative-to-counter-caches-59e2098b7d7) about `The SQL Alternative To Counter Caches`.
+ 
+The most important example from this blog:
+
+```ruby
+class Author < ApplicationRecord
+  scope :with_counts, -> {
+   select <<~SQL
+     authors.*,
+     (
+       SELECT COUNT(books.id) FROM books
+       WHERE author_id = authors.id
+     ) AS books_count
+   SQL
+  }
+end
+```
+
+With this gem, this can be rewritten to
+
+```ruby
+class Author < ApplicationRecord
+  sql_attribute :books_count, <<~SQL
+    SELECT COUNT(books.id) 
+    FROM books
+    WHERE author_id = authors.id
+  SQL
+end
+```
+
+Also some ideas where 'stolen' from [this blog](https://engineering.culturehq.com/posts/2019-01-18-dynamic-activerecord-columns) about `Dynamic ActiveRecord columns`.

data/lib/sql_attributes.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module SqlAttributes
+  class NotLoaded < StandardError; end
+
+  class NotDefined < StandardError; end
+
+  def sql_attributes
+    @sql_attributes ||= HashWithIndifferentAccess.new
+  end
+
+  def with_sql_attributes(*attributes)
+    requested_attributes =
+      if attributes.length.positive?
+        Array.wrap(attributes).flatten.reject(&:nil?)
+      else
+        sql_attributes.keys
+      end
+
+    requested_attributes.inject(all) do |scope, name|
+      unless sql_attributes.key?(name)
+        raise NotDefined, "You want to load dynamic SQL attribute `#{name}` but it is not defined."
+      end
+
+      scope.public_send("with_#{name}")
+    end
+  end
+
+  def sql_attribute(name, subquery)
+    sql_attributes[name] = subquery.squish
+
+    scope "with_#{name}".to_sym, lambda {
+      select(
+        arel.projections,
+        "(#{subquery.squish}) as #{name}"
+      )
+    }
+
+    define_method(name) do
+      return read_attribute(name) if has_attribute?(name)
+
+      raise NotLoaded, <<~MESSAGE
+        Dynamic SQL attribute `#{name}` not loaded from the database.
+
+          Use the `with_sql_attributes` scope to load the attribute.
+
+      MESSAGE
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  extend SqlAttributes
+end

data/lib/sql_attributes/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SqlAttributes
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: sql_attributes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Stef Schenkelaars
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-github
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add virtual attributes to an ActiveRecord model based on an SQL query.
+email:
+- stef.schenkelaars@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/sql_attributes.rb
+- lib/sql_attributes/version.rb
+homepage: https://drieam.github.io/sql_attributes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://drieam.github.io/sql_attributes
+  source_code_uri: https://github.com/Drieam/sql_attributes
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Add virtual attributes to an ActiveRecord model based on an SQL query.
+test_files: []