raspy 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a261395ba84065314346c2470df292b85f5af4df
+  data.tar.gz: 448abdef9fbddaec6619d5c7c758b49eec1dc772
+SHA512:
+  metadata.gz: 45ece0cd47ae3077d16a15907d6cd74e7caf9abc7a9c5348016c96493c592da53bd1a54e9a11c18a4d3c13b87cf1884514e708da5505a0c6ff923b90eb5a95a4
+  data.tar.gz: 2e83a4a8c0aaf04f09c8f43242694b53d50fea485a3ee35244ec73b14f779649e41a23a747ad0655249b65a77203ef6139c654076716023b1077e11dbab38ad8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at csy0013@googlemail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in raspy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ajith Hussain
+
+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,35 @@
+# Raspy
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/raspy`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'raspy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install raspy
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sparkymat/raspy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "raspy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/raspy/error.rb

@@ -0,0 +1,4 @@
+module Raspy
+  class Error < Exception
+  end
+end

data/lib/raspy/version.rb

@@ -0,0 +1,3 @@
+module Raspy
+  VERSION = "1.0.0"
+end

data/lib/raspy.rb

@@ -0,0 +1,249 @@
+require "raspy/version"
+require "raspy/error"
+
+class ActiveRecord::Base
+  def self.as_rusql_table
+    t = Rusql::Table.new
+    t.name = self.table_name.to_sym
+
+    t
+  end
+
+  def self.[](ind)
+    Rusql::Column.new( self.as_rusql_table, ind )
+  end
+end
+
+class Array
+  def prefetch(args)
+    return if args.keys.length == 0
+
+    raise Raspy::Error.new("Cannot run prefetch on a non-uniform list") unless self.map(&:class).uniq.length == 1
+  end
+end
+
+module Raspy
+  extend Rusql
+
+
+  def self.preload_habtm(list:, name:, association_klass:, foreign_key:, association_foreign_key:, inner_associations:, join_table:, association_condition:)
+    return if list.nil? || list.length == 0
+
+    klass = list.first.class
+    klass.send :attr_reader, name.to_sym
+
+    join_t = table(join_table.to_sym)
+
+    join_query = select(
+      join_t[foreign_key.to_sym],
+      join_t[association_foreign_key.to_sym]
+    ).
+    from( join_t ).
+    where(
+      join_t[foreign_key.to_sym].in( list.map{ |e| e[klass.primary_key.to_sym] }.compact )
+    )
+
+    join_objects = ActiveRecord::Base.connection.execute(join_query.to_s).to_a
+
+    association_table  = association_klass.as_rusql_table
+
+    condition = join_t[foreign_key.to_sym].in( list.map{ |e| e[klass.primary_key.to_sym] }.compact )
+    if association_condition.present?
+      condition = condition.and( association_condition )
+    end
+
+    query = select(
+      association_table[:*]
+    ).
+    from( association_table ).
+    inner_join( join_t, join_t[association_foreign_key.to_sym].equals(association_table[association_klass.primary_key.to_sym]) ).
+    where(
+      condition
+    )
+
+    associated_objects = association_klass.find_by_sql(query.to_s).to_a
+
+    if inner_associations.present?
+      associated_objects.prefetch(inner_associations)
+    end
+
+    associated_objects_hash = {}
+
+    associated_objects_hash = associated_objects.map{ |e| [e[association_klass.primary_key.to_sym], e] }.to_h
+
+    list.each do |ele|
+      set = []
+
+      join_objects.select{ |e| e[0] == ele[klass.primary_key.to_sym] }.map(&:last).each do |association_pk|
+        if associated_objects_hash[association_pk].present?
+          set << associated_objects_hash[association_pk]
+        end
+      end
+
+      ele.instance_variable_set(:"@#{name}", set)
+    end
+  end
+
+  def self.preload_has_many(list:, name:, association_klass:, foreign_key:, inner_associations: nil, association_condition: nil, reverse_association: nil)
+    return if list.nil? || list.length == 0
+
+    klass = list.first.class
+    klass.send :attr_reader, name.to_sym
+
+    if reverse_association.present?
+      association_klass.send :attr_reader, reverse_association.to_sym
+    end
+
+    association_table = association_klass.as_rusql_table
+
+    condition = association_table[foreign_key.to_sym].in( list.map{ |e| e[klass.primary_key.to_sym] }.compact )
+    if association_condition.present?
+      condition = condition.and( association_condition )
+    end
+
+    query = select(
+      association_table[:*]
+    ).
+    from( association_table ).
+    where(
+      condition
+    )
+
+    associated_objects = association_klass.find_by_sql(query.to_s).to_a
+    if inner_associations.present?
+      associated_objects.prefetch(inner_associations)
+    end
+
+    associated_objects_hash = {}
+    associated_objects.each do |ao|
+      associated_objects_hash[ao[foreign_key.to_sym]] ||= []
+      associated_objects_hash[ao[foreign_key.to_sym]] << ao
+    end
+
+    list.each do |ele|
+      set = []
+
+      if associated_objects_hash[ele[klass.primary_key.to_sym]].present?
+        set = associated_objects_hash[ele[klass.primary_key.to_sym]]
+      end
+
+      if reverse_association.present?
+        set.each do |ao|
+          ao.instance_variable_set(:"@#{reverse_association}", ele)
+        end
+      end
+
+      ele.instance_variable_set(:"@#{name}", set)
+    end
+  end
+
+  def self.preload_has_one(list:, name:, association_klass:, foreign_key:, order_type:, order_field:, inner_associations: nil, association_condition: nil, reverse_association: nil)
+    return if list.nil? || list.length == 0
+
+    klass = list.first.class
+    klass.send :attr_reader, name.to_sym
+
+    if reverse_association.present?
+      association_klass.send :attr_reader, reverse_association.to_sym
+    end
+
+    query = <<-EOS.squish
+
+    SELECT
+      #{ association_klass.table_name }.*
+    FROM #{ association_klass.table_name }
+    INNER JOIN (
+      SELECT #{ association_klass.table_name }.#{ foreign_key }, #{ order_type }(#{ association_klass.table_name }.#{ order_field }) max_#{ order_field }
+      FROM #{ association_klass.table_name }
+      WHERE #{ association_klass.table_name }.#{ foreign_key } IN (#{ list.map{ |e| e[klass.primary_key.to_sym] }.compact.map(&:to_s).join(", ") })
+        #{ association_condition.present? ? " AND #{ association_condition }" : "" }
+      GROUP BY #{ association_klass.table_name }.#{ foreign_key }
+    ) _association ON _association.#{ foreign_key } = #{ association_klass.table_name }.#{ foreign_key } AND _association.max_#{ order_field } = #{ association_klass.table_name }.#{ order_field }
+    WHERE #{ association_klass.table_name }.#{ foreign_key } IN (#{ list.map{ |e| e[klass.primary_key.to_sym] }.compact.map(&:to_s).join(", ") })
+      #{ association_condition.present? ? " AND #{ association_condition }" : "" }
+
+    EOS
+
+    associated_objects = association_klass.find_by_sql(query).to_a
+    if inner_associations.present?
+      associated_objects.prefetch(inner_associations)
+    end
+
+    associated_objects_hash = associated_objects.map{ |e| [e[foreign_key.to_sym], e] }.to_h
+
+    list.each do |ele|
+      if associated_objects_hash[ele[klass.primary_key.to_sym]].present?
+        associated_object = associated_objects_hash[ele[klass.primary_key.to_sym]]
+        if reverse_association.present?
+          associated_object.instance_variable_set(:"@#{reverse_association}", ele)
+        end
+        ele.instance_variable_set(:"@#{name}", associated_object)
+      end
+    end
+  end
+
+  def self.preload_belongs_to(list:, name:, association_klass:, foreign_key:, inner_associations: nil, association_condition: nil, additional_selects: [], additional_joins: [])
+    return if list.nil? || list.length == 0
+
+    klass = list.first.class
+    klass.send :attr_reader, name.to_sym
+
+    return if list.map{ |e| e[foreign_key.to_sym] }.compact.length == 0
+
+    association_table = association_klass.as_rusql_table
+
+    selects = [association_table[:*]]
+    selects += additional_selects
+
+    condition = association_table[association_klass.primary_key.to_sym].in( list.map{ |e| e[foreign_key.to_sym] }.compact )
+
+    unless association_condition.nil?
+      condition = condition.and( association_condition )
+    end
+
+    query = select( *selects ).
+      from( association_table ).
+      where( condition )
+
+    additional_joins.each do |j|
+      query = query.join(j)
+    end
+
+    unless additional_selects.length == 0 && additional_joins.length == 0
+      query = query.group_by( association_table[association_klass.primary_key.to_sym] )
+    end
+
+    associated_objects = association_klass.find_by_sql(query.to_s).to_a
+    if inner_associations.present?
+      associated_objects.prefetch(inner_associations)
+    end
+
+    associated_objects_hash = associated_objects.map{ |e| [e[association_klass.primary_key.to_sym], e] }.to_h
+
+    list.each do |ele|
+      if associated_objects_hash[ele[foreign_key.to_sym]].present?
+        ele.instance_variable_set(:"@#{name}", associated_objects_hash[ele[foreign_key.to_sym]])
+      end
+    end
+  end
+
+  def self.preload_polymorphic_belongs_to(list:, name:, polymorphic_key_field:, polymorphic_type_field:, polymorphic_type_map:)
+    return if list.nil? || list.length == 0
+
+    return if polymorphic_key_field.nil? || polymorphic_type_field.nil? || polymorphic_type_map.nil? || (polymorphic_type_map.keys.length == 0)
+
+    klass = list.first.class
+    klass.send :attr_reader, name.to_sym
+
+    polymorphic_type_map.keys.each do |polymorphic_type|
+      matching_list = list.select{ |e| e[polymorphic_type_field.to_sym] == polymorphic_type }
+      association_klass = polymorphic_type_map[polymorphic_type]
+      Raspy.preload_belongs_to(
+        list:              matching_list,
+        name:              name,
+        association_klass: association_klass,
+        foreign_key:       polymorphic_key_field
+      )
+    end
+  end
+end

data/raspy.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'raspy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "raspy"
+  spec.version       = Raspy::VERSION
+  spec.authors       = ["Ajith Hussain"]
+  spec.email         = ["csy0013@googlemail.com"]
+
+  spec.summary       = %q{raspy adds a prefetch mechanism to ActiveRecord which is parallel to the ActiveRecord associations.}
+  spec.homepage      = "https://github.com/sparkymat/raspy"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activerecord', '~> 4.0', '>= 4.0.0'
+  spec.add_runtime_dependency 'rusql', '~> 1.0', '>= 1.0.5'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: raspy
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ajith Hussain
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rusql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: 
+email:
+- csy0013@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/raspy.rb
+- lib/raspy/error.rb
+- lib/raspy/version.rb
+- raspy.gemspec
+homepage: https://github.com/sparkymat/raspy
+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.5.1
+signing_key: 
+specification_version: 4
+summary: raspy adds a prefetch mechanism to ActiveRecord which is parallel to the
+  ActiveRecord associations.
+test_files: []