relation_to_struct 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da24825b1afe7727be14670b9c455cb3e37787e8
+  data.tar.gz: 45d4ee2f132f955835ef6ccd06b313df2e063fd8
+SHA512:
+  metadata.gz: 37ec70d13d54eff799e4a0f270c2ed940323b014a029a9c3c28c1a9034190e773b9495cef5d6f097d5c00319daf6b255c55a2dc9a42a9e573930cdf7443763ba
+  data.tar.gz: a8b3b83a0460f846dca55d202aae7735db3fd16f3fe5ba58e2288bcdba21a2adc03d6086741e9246df774ee24d807dfe1199c7a4e8ad861efb26c98f9456c834

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 James Coleman
+
+MIT License
+
+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,33 @@
+# RelationToStruct
+
+When one needs to use ActiveRecord to fetch specific values (whether subset columns of a model or arbitrary calculated columns), it's desirable to avoid the overhead of model instances and any associated callbacks.
+
+ActiveRecord::Relation#pluck solves a similar problem but returns tuples; I wanted to be able to return Ruby structs to benefit from named instance methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'relation_to_struct'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install relation_to_struct
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/relation_to_struct/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/relation_to_struct/active_record_relation_extension.rb

@@ -0,0 +1,17 @@
+module RelationToStruct::ActiveRecordRelationExtension
+  extend ::ActiveSupport::Concern
+
+  def to_structs(struct_class)
+    raise '' unless self.select_values.present?
+
+    relation = spawn
+    result = klass.connection.select_all(relation.arel, nil, relation.arel.bind_values + bind_values)
+    result.cast_values(klass.column_types)
+
+    result.cast_values(klass.column_types).map do |tuple|
+      struct_class.new(*tuple)
+    end
+  end
+end
+
+::ActiveRecord::Relation.send(:include, RelationToStruct::ActiveRecordRelationExtension)

data/lib/relation_to_struct/version.rb

@@ -0,0 +1,3 @@
+module RelationToStruct
+  VERSION = "0.0.1"
+end

data/lib/relation_to_struct.rb

@@ -0,0 +1,5 @@
+require "relation_to_struct/version"
+require "relation_to_struct/active_record_relation_extension"
+
+module RelationToStruct
+end

data/relation_to_struct.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'relation_to_struct/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "relation_to_struct"
+  spec.version       = RelationToStruct::VERSION
+  spec.authors       = ["James Coleman"]
+  spec.email         = ["jtc331@gmail.com"]
+  spec.summary       = %q{Return struct results from ActiveRecord relation queries}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "pg"
+
+  spec.add_dependency "activerecord", "~> 4.0"
+  spec.add_dependency "activesupport", "~> 4.0"
+end

data/spec/active_record_helper/economic_school.rb

@@ -0,0 +1,3 @@
+class EconomicSchool < ActiveRecord::Base
+  has_many :economists
+end

data/spec/active_record_helper/economist.rb

@@ -0,0 +1,3 @@
+class Economist < ActiveRecord::Base
+  belongs_to :economic_school
+end

data/spec/active_record_helper/schema.rb

@@ -0,0 +1,12 @@
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :economic_schools do |t|
+    t.string :name
+  end
+
+  create_table :economists do |t|
+    t.string :name
+    t.references :economic_school
+  end
+end

data/spec/active_record_helper/setup.rb

@@ -0,0 +1,33 @@
+ActiveRecord::Base.configurations = {
+  "postgresql" => {
+    "adapter" => 'postgresql',
+    "host" => 'localhost',
+    "database" => 'relation_to_struct_tests',
+    "encoding" => 'utf8',
+    "username" => 'jcoleman',
+  },
+  "sqlite" => {
+    "adapter"  => "sqlite3",
+    "database" => ":memory:",
+  },
+}
+
+env = ENV['DATABASE'] ||= 'sqlite'
+case env
+when 'postgresql'
+  ActiveRecord::Tasks::DatabaseTasks.instance_variable_set('@env', env)
+  config = ActiveRecord::Base.configurations[env]
+
+  ActiveRecord::Tasks::DatabaseTasks.drop_current
+  ActiveRecord::Tasks::DatabaseTasks.create_current
+  ActiveRecord::Tasks::DatabaseTasks.load_schema_current(:ruby, File.expand_path('../schema.rb', __FILE__))
+  ActiveRecord::Base.establish_connection(env)
+when 'sqlite'
+  ActiveRecord::Base.establish_connection(env)
+  require_relative 'schema'
+else
+  raise ArgumentError, 'Unrecognized ENV["DATABASE"] argument.'
+end
+
+require_relative 'economic_school'
+require_relative 'economist'

data/spec/relation_to_struct_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe RelationToStruct do
+  before(:each) do
+    Economist.delete_all
+    EconomicSchool.delete_all
+  end
+
+  it 'has a version number' do
+    expect(RelationToStruct::VERSION).not_to be nil
+  end
+
+  describe 'relation' do
+    it 'should respond to :to_structs' do
+      expect(Economist.all.respond_to?(:to_structs)).to eq(true)
+    end
+
+    it 'should respond to :to_structs' do
+      pending 'next version'
+    end
+
+    it '#to_structs should raise an error when the relation has no select_values' do
+      expect do
+        Economist.all.to_structs(Struct.new(:test_struct))
+      end.to raise_error
+    end
+
+    it '#to_structs should return an empty array when no results are returned' do
+      expect(Economist.where('1 = 0').select(:id).to_structs(Struct.new(:test_struct))).to eq([])
+    end
+
+    it '#to_structs should return an array with struct instances' do
+      hayek = Economist.create!(name: 'F.A. Hayek')
+      id_struct = Struct.new(:id)
+      expect(Economist.all.select(:id).to_structs(id_struct)).to eq([id_struct.new(hayek.id)])
+    end
+
+    it '#to_structs should handle joined elements properly' do
+      austrian = EconomicSchool.create!(name: 'Austrian Economics')
+      hayek = Economist.create!(name: 'F.A. Hayek', economic_school: austrian)
+      test_struct = Struct.new(:name, :school)
+      expect(
+        Economist
+          .joins(:economic_school)
+          .select('economists.name', 'economic_schools.name')
+          .to_structs(test_struct)
+      ).to eq([test_struct.new(hayek.name, austrian.name)])
+    end
+
+    it '#to_structs should properly cast values from arbitrary calculated columns' do
+      hayek = Economist.create!(name: 'F.A. Hayek')
+      scope = Economist.all
+      pluck_results = scope.pluck("date('now')")
+      pluck_column_klass = pluck_results.first.class
+
+      date_struct = Struct.new(:date)
+      struct_scope = scope.select("date('now')")
+      structs_results = struct_scope.to_structs(date_struct)
+      struct_column_klass = structs_results.first.date.class
+      expect(pluck_column_klass).to eq(struct_column_klass)
+    end
+  end
+
+  describe 'non-model specific querying' do
+    it 'should allow querying from ActiveRecord' do
+      pending 'next version'
+    end
+
+    it 'should allow using find_by_sql directly' do
+      pending 'next version'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'active_record'
+require 'active_support'
+require 'relation_to_struct'
+require 'active_record_helper/setup'
+require 'pry-byebug'

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: relation_to_struct
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Coleman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: pg
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: ''
+email:
+- jtc331@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/relation_to_struct.rb
+- lib/relation_to_struct/active_record_relation_extension.rb
+- lib/relation_to_struct/version.rb
+- relation_to_struct.gemspec
+- spec/active_record_helper/economic_school.rb
+- spec/active_record_helper/economist.rb
+- spec/active_record_helper/schema.rb
+- spec/active_record_helper/setup.rb
+- spec/relation_to_struct_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Return struct results from ActiveRecord relation queries
+test_files:
+- spec/active_record_helper/economic_school.rb
+- spec/active_record_helper/economist.rb
+- spec/active_record_helper/schema.rb
+- spec/active_record_helper/setup.rb
+- spec/relation_to_struct_spec.rb
+- spec/spec_helper.rb