rails_select_on_includes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 760c7ce5db03df38f8ad642bc0b72f71be1a1ec0
+  data.tar.gz: 71806ae57830758f1bda4ed45e3df7c92ebd2eae
+SHA512:
+  metadata.gz: be0c07732e03e4a573948a00dbe1215d019e31ddf4eb4357a767f5c1cf984807471f218d66db5beda73f4d839792c15583335c71a58678e79072b9b3ea600639
+  data.tar.gz: 4a7c5c76780c6f7a8dc70b0a9b77975c948c1b9a459ba04badcf030428399e406c53413510eeda622a04143788c7b71f6d28df78d258560407667688b7aad75f

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 alekseyl
+
+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,57 @@
+# RailsSelectOnIncludes
+
+This gem solves issue in rails: https://github.com/rails/rails/issues/15185 for base_class.
+
+It was impossible to select virtual attributes to object from its relations or any other way 
+when using includes and where. 
+
+Example from upper rails issue: 
+
+```ruby
+post = Post.includes(:comments).select("posts.*, 1 as testval").where( SOME_CONDITION ).first
+post.testval # Undefined method!
+```
+
+This gem solves problem for base class i.e. 
+
+```ruby
+post = Post.includes(:comments).select("posts.*, 1 as testval").where( SOME_CONDITION ).first
+post.testval # 1
+```
+
+but of course it doesn't include virtual attributes in included relations
+
+```ruby
+post = Post.includes(:comments).select("posts.*, 1 as testval").where( SOME_CONDITION ).first
+post.comments.first.testval # Undefined method!
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_select_on_includes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_select_on_includes
+
+## Usage
+
+Works out of the box, gently monkey-patching base-class alias columns. It not affecting query creation, since query already contains all columns.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_select_on_includes.
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_select_on_includes"
+
+# 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/rails_select_on_includes.rb

@@ -0,0 +1,95 @@
+require 'active_support/deprecation'
+require 'active_support/core_ext/string/filters'
+
+module ActiveRecord
+  module Associations
+    class JoinDependency # :nodoc:
+
+      class Aliases # :nodoc:
+        def initialize(tables)
+          @tables = tables
+          @alias_cache = tables.each_with_object({}) { |table,h|
+            h[table.node] = table.columns.each_with_object({}) { |column,i|
+              i[column.name] = column.alias
+            }
+          }
+          @name_and_alias_cache = tables.each_with_object({}) { |table,h|
+            h[table.node] = table.columns.map { |column|
+              [column.name, column.alias]
+            }
+            @base_class_node_aliases ||= h[table.node] if table.node.is_a?(ActiveRecord::Associations::JoinDependency::JoinBase)
+          }
+        end
+        # valid formats are:
+        # 1 'table_name.column' or 'table_name.column as column_1' will be parsed! distinct on can be used also
+        # 2 {table_name: column} or { table_name: [column1, column2] }
+        # 3 table_name: 2
+        def update_aliases_to_select_values( select_values )
+          return if select_values.blank?
+          select_values.each do |sv|
+            # if sv is symbol that we assume that its a base table column and it will be aliased and added as usual
+            # all we need is some specials joins+select from related tables
+            if sv.is_a?(Hash)
+              flatten_hash_values(sv).each{|sub_sv| @base_class_node_aliases << [sub_sv, sub_sv] }
+            elsif sv.is_a?(String)
+              # this is the case of long raw select
+              sv.split( ", " ).each do |sub_sv|
+                if sub_sv[/.+ as .+/]
+                  selected_column = sub_sv[/ as .+/][4..-1]
+                  @base_class_node_aliases << [selected_column, selected_column]
+                elsif sub_sv[/.+\.[^\*]+/]
+                  selected_column = sub_sv[/\..+/][1..-1]
+                  @base_class_node_aliases << [selected_column, selected_column]
+                end
+              end
+            end
+          end
+        end
+
+        private
+        def flatten_hash_values( some_hash )
+          some_hash.values.map{ |value| value.is_a?(Hash) ? all_hash_values( value ) : value }.flatten!
+        end
+      end
+    end
+  end
+end
+module ActiveRecord
+  module FinderMethods
+
+    def find_with_associations
+      # NOTE: the JoinDependency constructed here needs to know about
+      #       any joins already present in `self`, so pass them in
+      #
+      # failing to do so means that in cases like activerecord/test/cases/associations/inner_join_association_test.rb:136
+      # incorrect SQL is generated. In that case, the join dependency for
+      # SpecialCategorizations is constructed without knowledge of the
+      # preexisting join in joins_values to categorizations (by way of
+      # the `has_many :through` for categories).
+      #
+      join_dependency = construct_join_dependency(joins_values)
+
+      aliases  = join_dependency.aliases
+      relation = select aliases.columns
+      relation = apply_join_dependency(relation, join_dependency)
+
+      if block_given?
+        yield relation
+      else
+        if ActiveRecord::NullRelation === relation
+          []
+        else
+          arel = relation.arel
+          rows = connection.select_all(arel, 'SQL', arel.bind_values + relation.bind_values)
+          #DISTINCTION IS HERE:
+          # now we gently mokey-patching existing column aliases with select values
+          aliases.update_aliases_to_select_values(values[:select]) unless values[:select].blank?
+
+          join_dependency.instantiate(rows, aliases)
+        end
+      end
+    end
+
+  end
+end
+

data/lib/rails_select_on_includes/version.rb

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

data/rails_select_on_includes.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_select_on_includes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_select_on_includes"
+  spec.version       = RailsSelectOnIncludes::VERSION
+  spec.authors       = ["alekseyl"]
+  spec.email         = ["leshchuk@gmail.com"]
+
+  spec.summary       = %q{Patching rails include/select/virtual attributes issue}
+  spec.description   = %q{Patching rails include/select/virtual attributes issue ( https://github.com/rails/rails/issues/15185 )}
+  spec.homepage      = "https://github.com/alekseyl/rails_select_on_includes"
+  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.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.1"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: rails_select_on_includes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- alekseyl
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: Patching rails include/select/virtual attributes issue ( https://github.com/rails/rails/issues/15185
+  )
+email:
+- leshchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/.name"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/rails_select_on_includes.iml"
+- ".idea/vcs.xml"
+- ".idea/workspace.xml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_select_on_includes.rb
+- lib/rails_select_on_includes/version.rb
+- rails_select_on_includes.gemspec
+homepage: https://github.com/alekseyl/rails_select_on_includes
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Patching rails include/select/virtual attributes issue
+test_files: []