surus 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c16570a2c0344b5f4294041a7a6b6e0e5d03674
-  data.tar.gz: b28d6a4a328a01228cbaef0eb6d2024199e5cd64
+  metadata.gz: cd4bbbf8c57e01cfb2627d2b0a3913006f1432c7
+  data.tar.gz: 73504b7836c48ee52f43d62f91d93eeb0f52e733
 SHA512:
-  metadata.gz: d610452b370a09fa5ae3b3a131e17439d52b625b827924cc15cc17d226b6df86f2310feed010028dda5541c675e5e36b5eab196dcca0123a8a6411108f922916
-  data.tar.gz: 7ba624e05ff271e1b4587c16101adba2616b5e070ae35415dc96221a542eb33a67537f8492777049afed5d676cd6f6c8181ec020b31ed403031068ad29400d76
+  metadata.gz: ce79c2dabce1600a7a3503f992cd735e7eac90fd59c65ad557ee5a55e58cde0eb0eebfb91a8be97456479ca31c0efe88375b3cc0e8ae8f9ac7e699faf7b8cef0
+  data.tar.gz: 498d6d89a59f5c2d49d0119a94ec76429a7a589f398050ab3a22824264ada83c886017f7e7e9632188fd8f37eccda0f585eeca579610cea9f7a8ab87a00966fa

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.1.5
+  - 2.0.0
+gemfile:
+  - gemfiles/4.0.gemfile
+  - gemfiles/4.1.gemfile
+  - gemfiles/4.2.gemfile
+
+addons:
+  postgresql: "9.2"
+
+before_script:
+  - cp spec/database.yml.travis spec/database.yml
+  - psql -U postgres -c 'create database surus_test;'
+  - psql -U postgres -f spec/database_structure.sql surus_test

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.6.0 (May 15, 2015)
+
+* find_json and all_json support has_one associations (Mathieu Dumont)
+* find_json and all_json preserve "select" scope unless columns or include arguments are present
+
 # 0.5.1 (August 29, 2014)
 
 * Quote assocation column names

data/README.md

@@ -1,6 +1,8 @@
 Surus
 =====
 
+[![Build Status](https://travis-ci.org/jackc/surus.svg?branch=master)](https://travis-ci.org/jackc/surus)
+
 # Description
 
 Surus adds PostgreSQL specific functionality to ActiveRecord. It adds
@@ -14,16 +16,33 @@ substantially faster than converting ActiveRecord objects to JSON.
 
     gem install surus
 
-Or add to your Gemfile.
+Or add to your Gemfile. This version of Surus only works on Rails 4.
 
     gem 'surus'
 
 ## Rails 3
 
-This version of Surus only works on Rails 4. Use the 0.4 line for Rails 3
+Use the 0.4 line for Rails 3
 
     gem 'surus', '~> 0.4.2'
 
+# JSON
+
+PostgreSQL 9.2 added `row_to_json` and `array_to_json` functions. These
+functions can be used to build JSON very quickly. Unfortunately, they are
+somewhat cumbersome to use. The `find_json` and `all_json` methods are easy to
+use wrappers around the lower level PostgreSQL functions that closely mimic
+the Rails `to_json` interface.
+
+    User.find_json 1
+    User.find_json 1, columns: [:id, :name, :email]
+    Post.find_json 1, include: :author
+    User.find_json(user.id, include: {posts: {columns: [:id, :subject]}})
+    User.all_json
+    User.where(admin: true).all_json
+    User.all_json(columns: [:id, :name, :email], include: {posts: {columns: [:id, :subject]}})
+    Post.all_json(include: [:forum, :post])
+
 # Hstore
 
 Hstores can be searched with helper scopes.
@@ -48,6 +67,22 @@ nested data structures can be serialized to an hstore. In other words, any
 hash that can be serialized with the normal Rails YAML serialization can be
 serialized with Surus.
 
+**Serialize example (Rails 3+)**:
+
+```ruby
+class User < ActiveRecord::Base
+  serialize :settings, Surus::Hstore::Serializer.new
+end
+```
+
+**Store example (Rails 4+)**:
+
+```ruby
+class User < ActiveRecord::Base
+  store :settings, accessors: [:session_timeout], coder: Surus::Hstore::Serializer.new
+end
+```
+
 # Array
 
 Arrays can be searched with helper scopes.
@@ -79,23 +114,6 @@ entire session or per transaction.
 
 Read more in the [PostgreSQL asynchronous commit documentation](http://www.postgresql.org/docs/9.1/interactive/wal-async-commit.html).
 
-# JSON
-
-PostgreSQL 9.2 added `row_to_json` and `array_to_json` functions. These
-functions can be used to build JSON very quickly. Unfortunately, they are
-somewhat cumbersome to use. The `find_json` and `all_json` methods are easy to
-use wrappers around the lower level PostgreSQL functions that closely mimic
-the Rails `to_json` interface.
-
-    User.find_json 1
-    User.find_json 1, columns: [:id, :name, :email]
-    Post.find_json 1, include: :author
-    User.find_json(user.id, include: {posts: {columns: [:id, :subject]}})
-    User.all_json
-    User.where(admin: true).all_json
-    User.all_json(columns: [:id, :name, :email], include: {posts: {columns: [:id, :subject]}})
-    Post.all_json(include: [:forum, :post])
-
 # Benchmarks
 
 JSON generation is with all_json and find_json is substantially faster than to_json.

data/Rakefile

@@ -1 +1,11 @@
 require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/gemfiles/4.0.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "4.0.0"
+
+gemspec :path=>"../"

data/gemfiles/4.1.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1.8"
+
+gemspec :path=>"../"

data/gemfiles/4.2.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2.0"
+
+gemspec :path=>"../"

data/lib/surus/json/query.rb

@@ -15,7 +15,11 @@ module Surus
       end
 
       def subquery_sql
-        select(columns.map(&:to_s).join(', ')).to_sql
+        if options.key?(:columns) || options.key?(:include)
+          select(columns.map(&:to_s).join(', ')).to_sql
+        else
+          original_scope.to_sql
+        end
       end
 
       def columns
@@ -39,10 +43,32 @@ module Surus
       def association_columns
         included_associations_name_and_options.map do |association_name, association_options|
           association = klass.reflect_on_association association_name
-          subquery = case association.source_macro
+
+          # The way to get the association type is different in Rails 4.2 vs 4.0-4.1
+          association_type = if defined? ActiveRecord::Reflection::BelongsToReflection
+            # Rails 4.2+
+            case association
+            when ActiveRecord::Reflection::HasOneReflection
+              :has_one
+            when ActiveRecord::Reflection::BelongsToReflection
+              :belongs_to
+            when ActiveRecord::Reflection::HasManyReflection
+              :has_many
+            when ActiveRecord::Reflection::HasAndBelongsToManyReflection
+              :has_and_belongs_to_many
+            end
+          else
+            # Rails 4.0-4.1
+            association.source_macro
+          end
+
+          subquery = case association_type
           when :belongs_to
             association_scope = BelongsToScopeBuilder.new(original_scope, association).scope
             RowQuery.new(association_scope, association_options).to_sql
+          when :has_one
+            association_scope = HasManyScopeBuilder.new(original_scope, association).scope
+            RowQuery.new(association_scope, association_options).to_sql
           when :has_many
             association_scope = HasManyScopeBuilder.new(original_scope, association).scope
             ArrayAggQuery.new(association_scope, association_options).to_sql

data/lib/surus/version.rb

@@ -1,3 +1,3 @@
 module Surus
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/spec/database.yml

@@ -2,3 +2,4 @@ test:
   adapter: postgresql
   encoding: unicode
   database: surus_test
+

data/spec/database.yml.travis

@@ -0,0 +1,5 @@
+test:
+  adapter: postgresql
+  encoding: unicode
+  username: postgres
+  database: surus_test

data/spec/database_structure.sql

@@ -62,6 +62,27 @@ CREATE TABLE users(
 
 
 
+DROP TABLE IF EXISTS bios CASCADE;
+
+CREATE TABLE bios(
+  id serial PRIMARY KEY,
+  body text NOT NULL,
+  website_url varchar NOT NULL,
+  author_id integer NOT NULL REFERENCES users
+);
+
+
+
+DROP TABLE IF EXISTS avatars CASCADE;
+
+CREATE TABLE avatars(
+  id serial PRIMARY KEY,
+  url varchar NOT NULL,
+  author_id integer NOT NULL REFERENCES users
+);
+
+
+
 DROP TABLE IF EXISTS forums CASCADE;
 
 CREATE TABLE forums(
@@ -98,4 +119,4 @@ CREATE TABLE posts_tags(
   post_id integer NOT NULL REFERENCES posts,
   tag_id integer NOT NULL REFERENCES tags,
   PRIMARY KEY (post_id, tag_id)
-);
+);

data/spec/factories.rb

@@ -17,5 +17,20 @@ FactoryGirl.define do
   factory :user, aliases: [:author] do
     name { Faker::Internet.user_name }
     email { Faker::Internet.email }
+    after(:build) do |user|
+      user.bio ||= FactoryGirl.build(:bio, author: user)
+      user.avatar ||= FactoryGirl.build(:avatar, author: user)
+    end
+  end
+
+  factory :bio do
+    author
+    body { Faker::Lorem.paragraph }
+    website_url { Faker::Internet.url }
+  end
+
+  factory :avatar do
+    author
+    url { Faker::Avatar.image }
   end
 end

data/spec/json/json_spec.rb

@@ -22,6 +22,15 @@ describe 'json' do
       end
     end
 
+    context 'when scope chain has select' do
+      it 'uses the select for json' do
+        user = FactoryGirl.create :user
+        to_json = Oj.load user.to_json only: [:id, :name]
+        find_json = Oj.load User.select("id, name").find_json(user.id)
+        expect(find_json).to eq(to_json)
+      end
+    end
+
     context 'when scope chain has a joins with ambiguous column names' do
       it 'works' do
         user = FactoryGirl.create :user
@@ -60,6 +69,33 @@ describe 'json' do
         expect(find_json).to eq(to_json)
       end
 
+      it 'includes entire has_one object' do
+        user = FactoryGirl.create :user
+        to_json = Oj.load user.to_json(include: :bio)
+        find_json = Oj.load User.find_json(user.id, include: :bio)
+        expect(find_json).to eq(to_json)
+      end
+
+      it 'filters by has_one conditions' do
+        user = FactoryGirl.create :user
+        find_json = Oj.load User.find_json(user.id, include: :bio_with_impossible_conditions)
+        expect(find_json.fetch('bio_with_impossible_conditions')).to be_nil
+      end
+
+      it 'includes multiple entire has_one objects' do
+        user = FactoryGirl.create :user
+        to_json = Oj.load user.to_json(include: [:bio, :avatar])
+        find_json = Oj.load User.find_json(user.id, include: [:bio, :avatar])
+        expect(find_json).to eq(to_json)
+      end
+
+      it 'includes only selected columns of has_one object' do
+        user = FactoryGirl.create :user
+        to_json = Oj.load user.to_json(include: {bio: {only: [:id, :body]}})
+        find_json = Oj.load User.find_json(user.id, include: {bio: {columns: [:id, :body]}})
+        expect(find_json).to eq(to_json)
+      end
+
       it 'includes entire has_many association' do
         user = FactoryGirl.create :user
         posts = FactoryGirl.create_list :post, 2, author: user
@@ -168,5 +204,14 @@ describe 'json' do
       all_json = Oj.load User.all_json
       expect(all_json).to eq(to_json)
     end
+
+    context 'when scope chain has select' do
+      it 'uses the select for json' do
+        users = FactoryGirl.create_list :user, 3
+        to_json = Oj.load users.to_json only: [:id, :name]
+        all_json = Oj.load User.select("id, name").all_json
+        expect(all_json).to eq(to_json)
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -30,6 +30,21 @@ class User < ActiveRecord::Base
 
   # association name is reserved word in PostgreSQL
   has_many :rows, foreign_key: :author_id, class_name: 'Post', table_name: 'posts'
+
+  has_one :bio, foreign_key: :author_id
+  has_one :avatar, foreign_key: :author_id
+  has_one :bio_with_impossible_conditions,
+    -> { where '1=2' },
+    foreign_key: :author_id,
+    class_name: 'Bio'
+end
+
+class Bio < ActiveRecord::Base
+  belongs_to :author, class_name: 'User'
+end
+
+class Avatar < ActiveRecord::Base
+  belongs_to :author, class_name: 'User'
 end
 
 class Forum < ActiveRecord::Base

data/spec/synchronous_commit/model_spec.rb

@@ -2,18 +2,18 @@ require 'spec_helper'
 
 describe Surus::SynchronousCommit::Model do
   let(:conn) { ActiveRecord::Base.connection }
-  
+
   describe "synchronous_commit" do
     it "is delegated to connection" do
-      conn.should_receive(:synchronous_commit)
+      expect(conn).to receive(:synchronous_commit)
       ActiveRecord::Base.synchronous_commit
     end
   end
-  
+
   describe "synchronous_commit=" do
     it "is delegated to connection" do
-      conn.should_receive(:synchronous_commit=)
+      expect(conn).to receive(:synchronous_commit=)
       ActiveRecord::Base.synchronous_commit = true
     end
-  end  
+  end
 end

data/surus.gemspec

@@ -34,5 +34,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'pg'
   s.add_development_dependency 'pry', '~> 0.9.11'
   s.add_development_dependency 'factory_girl', '~> 4.2.0'
-  s.add_development_dependency 'faker', '~> 1.1.2'
+  s.add_development_dependency 'faker', '~> 1.4.3'
+  s.add_development_dependency 'rake'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surus
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Jack Christensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-29 00:00:00.000000000 Z
+date: 2015-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -142,14 +142,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.4.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.4.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: "Surus accelerates ActiveRecord with PostgreSQL specific types and\n
   \                   functionality. It enables indexed searching of serialized arrays
   and hashes.\n                    It also can control PostgreSQL synchronous commit
@@ -163,6 +177,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -175,6 +190,9 @@ files:
 - bench/hstore_find.rb
 - bench/json_generation.rb
 - bench/synchronous_commit.rb
+- gemfiles/4.0.gemfile
+- gemfiles/4.1.gemfile
+- gemfiles/4.2.gemfile
 - lib/generators/surus/hstore/install_generator.rb
 - lib/generators/surus/hstore/templates/install_hstore.rb
 - lib/surus.rb
@@ -194,6 +212,7 @@ files:
 - lib/surus/version.rb
 - spec/array/scope_spec.rb
 - spec/database.yml
+- spec/database.yml.travis
 - spec/database_structure.sql
 - spec/factories.rb
 - spec/hstore/scope_spec.rb
@@ -224,13 +243,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ''
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: PostgreSQL Acceleration for ActiveRecord
 test_files:
 - spec/array/scope_spec.rb
 - spec/database.yml
+- spec/database.yml.travis
 - spec/database_structure.sql
 - spec/factories.rb
 - spec/hstore/scope_spec.rb