active_record_temptable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9dd53e6cd28f2b48bc192fd59f36a268706f0f6b674414488a9043b636839154
+  data.tar.gz: b53b7343396c2c902fa8f95ecd8187b26426ca753f8c8eefffbb3657c26b202a
+SHA512:
+  metadata.gz: 006c7c9147c553eb50b6af984ec915ff9356f301ba760b7d964dc9118e807f0948b4eae91be9ec96a37467e4a141dae237eb1e4eb4b209800e7c9429cabe980f
+  data.tar.gz: ab1e589be360f3abff00ba189ebfa903ab563ccb8d7e2cc42145bcc2d04e270e371555a831eeac83ef527d20ada7fb380f04b459e1a175a5e26bae19b25fbe74

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,13 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+services:
+  - postgresql
+  - mysql
+rvm:
+  - 2.5.1
+before_install:
+  gem install bundler -v 1.16.5
+before_script:
+  bundle exec rake create_dbs

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in activerecord_temptable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    active_record_temptable (0.1.0)
+      activerecord (>= 4.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    concurrent-ruby (1.1.3)
+    diff-lcs (1.3)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    mysql2 (0.4.10)
+    pg (0.18.4)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_record_temptable!
+  bundler (~> 1.16)
+  mysql2 (~> 0.4.1)
+  pg (~> 0.18.4)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3 (~> 1.3)
+
+BUNDLED WITH
+   1.16.6

data/README.md

@@ -0,0 +1,44 @@
+# ActiverecordTemptable
+
+ActiveRecordTemptable provides with_temptable method to cache query results using temporary table.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord_temptable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord_temptable
+
+## Reasoning
+Creating temp tables to save time once querying big result set multiple times(different groupings, count etc) with a complex query.
+
+## Usage
+
+`ActiveRecordTemptable.with_temptable` can be used to cache complex query's result.
+
+For example using scheme from RailsTutorial
+```ruby
+ActiveRecordTemptable.with_temptable(current_user.feed, [:user_id]) do |microposts|
+  @most_microposts = microposts.group(:user_id).count
+  @not_own_microposts = microposts.where.not(user_id: current_user).to_a # note that to_a is needed to load records
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies and create databases. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/railwaymen/active_record_temptable.

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'yaml'
+
+CONFIG = YAML::load(File.open(File.join(__dir__, 'database.yml')))
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task create_dbs: %w[pg:build mysql:build]
+
+namespace :pg do
+  task :build do
+    %x( createdb -U #{CONFIG['postgres']['user']} -E UTF8 #{CONFIG['postgres']['database']} )
+  end
+end
+
+namespace :mysql do
+  task :build do
+    %x( mysql -e "create DATABASE #{CONFIG["mysql"]["database"]} DEFAULT CHARACTER SET utf8mb4" )
+  end
+end

data/active_record_temptable.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_record_temptable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record_temptable"
+  spec.version       = ActiveRecordTemptable::VERSION
+  spec.authors       = ["Marcin Henryk Bartkowiak"]
+  spec.email         = ["mhbartkowiak@gmail.com"]
+  spec.licenses      = ["MIT"]
+
+  spec.summary       = 'Temp Table for activerecord'
+  spec.homepage      = "https://git.railwaymen.org/marcin.bartkowiak/active_record_temptable"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord', '>= 4.2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_development_dependency 'pg', '~> 0.18.4'
+  spec.add_development_dependency 'mysql2', '~> 0.4.1'
+end

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+bundle exec rake create_dbs

data/database.yml

@@ -0,0 +1,10 @@
+postgres:
+  adapter: postgresql
+  database: active_record_temptable_test
+  user: postgres
+sqlite:
+  adapter: sqlite3
+  database: ":memory:"
+mysql:
+  adapter: mysql2
+  database: active_record_temptable_test

data/lib/active_record_temptable/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordTemptable
+  VERSION = "0.1.0"
+end

data/lib/active_record_temptable.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'active_record_temptable/version'
+require 'active_record'
+
+module ActiveRecordTemptable
+  extend self
+
+  DEFAULT_TABLE_NAME = 'activerecord_temptable_records'.freeze
+
+
+  # Yields provided relation loaded in temporary table
+  #
+  # @param relation [ActiveRecord::Relation]
+  # @param indexes [Array] add_index will be called for every element in indexes
+  # @param table_name [String] name of table
+  # @return [void]
+  def with_temptable(relation, indexes = [], table_name = DEFAULT_TABLE_NAME)
+    ActiveRecord::Base.connection_pool.with_connection do |connection|
+      connection.transaction do
+        begin
+          create_table(connection, relation, table_name)
+          create_indexes(connection, table_name, indexes) if indexes.any?
+          klass = relation.klass
+          yield klass.unscoped.from("#{table_name} AS #{klass.table_name}") if block_given?
+        ensure
+          connection.drop_table(table_name, if_exists: true)
+        end
+      end
+    end
+  end
+
+  # Creates temp table and loads provided relation into it
+  #
+  # @param connection [ActiveRecord::ConnectionAdapters]
+  # @param relation [ActiveRecord::Relation]
+  # @param table_name [String] name of table
+  # @return [void]
+  def create_table(connection, relation, table_name)
+    connection.execute(new_table_command(relation, table_name))
+  end
+
+  # Calls add_index for every element in array
+  #
+  # @param connection [ActiveRecord::ConnectionAdapters]
+  # @param table_name [String]
+  # @param indexes [Array]
+  # @return [void]
+  def create_indexes(connection, table_name, indexes)
+    indexes.each do |fields, options|
+      connection.add_index(table_name, fields, options || {})
+    end
+  end
+
+  private
+
+  def new_table_command(relation, table_name)
+    "CREATE TEMPORARY TABLE #{table_name} AS #{relation.to_sql}"
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: active_record_temptable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcin Henryk Bartkowiak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.4
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+description: 
+email:
+- mhbartkowiak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- active_record_temptable.gemspec
+- bin/setup
+- database.yml
+- lib/active_record_temptable.rb
+- lib/active_record_temptable/version.rb
+homepage: https://git.railwaymen.org/marcin.bartkowiak/active_record_temptable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Temp Table for activerecord
+test_files: []