pg_flash_json 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23bf70c17789f86129e82dc3c0c8a1dff5d211c4
+  data.tar.gz: ea3f4682399bb792ecd0ae93105aeb91f5b3a441
+SHA512:
+  metadata.gz: 8efe31dfe5076160270fd47144a3cb61a12fbc186ccace3900a6cd688f263cb9f7c1fa0ba19f62fa731438648d9db8d3148e9c4938cee3722b7ebd683745da42
+  data.tar.gz: add04407c27a4dfcea86b07ac99e682de36fa2bbdc048477f52b82ded579f239b7e610e6c95b18cc17d868a83749e732914a593d092f482dba40e28f8d843f68

data/.gitignore

@@ -0,0 +1,2 @@
+.idea/
+pkg/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    pg_flash_json (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+    activerecord (4.2.4)
+      activemodel (= 4.2.4)
+      activesupport (= 4.2.4)
+      arel (~> 6.0)
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    benchmark-ips (2.3.0)
+    builder (3.2.2)
+    byebug (6.0.2)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.1)
+    pg (0.18.3)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 4.2)
+  benchmark-ips
+  bundler
+  byebug
+  pg
+  pg_flash_json!
+  rake (~> 10.0)
+  rspec (~> 3.0)

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 dandlezzz
+
+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,77 @@
+# PgFlashJson
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg_flash_json'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg_flash_json
+
+## Usage
+
+PGFlashJSON turns your ActiveRecord relations into json using the power of postgres' json support.
+It works by using the attributes of the model to build the proper postgres json query.
+
+```ruby
+	class Post < ActiveRecord::Base
+		# attributes :id, :title, :content
+	end
+
+	Post.where(id: 1).to_pg_json
+		# SELECT json_agg(
+		#	json_build_object(
+		#		'id', t582.id,
+		#		'title', t582.title,
+		#		'content', t582.content
+		#	))
+		#	as json
+		#   FROM(SELECT "posts".* FROM "posts" WHERE "posts"."id" = 1)t582
+```
+This query is run and the aliases in the above example will be generated on the fly to ensure uniqueness.
+
+To use simply call #to_pg_json on any active record association.
+
+## Benchmarks
+
+Since the json is generated by postgres, we can skip object instantiation, accordingly PgFlashJson is faster when used to serialize a large number of records. 
+Consider the following benchmarks. These ips benchmarks call the separate json methods on 100 Post models, each one has an id, title, and content. The json they produce is identical.
+
+```
+PgFlashJson#to_pg_json
+                       179.000  i/100ms
+ActiveRecord#to_json    20.000  i/100ms
+-------------------------------------------------
+PgFlashJson#to_pg_json
+                          1.819k (± 3.9%) i/s -      9.129k
+ActiveRecord#to_json    208.296  (± 4.3%) i/s -      1.040k
+
+Comparison:
+PgFlashJson#to_pg_json:     1819.5 i/s
+ActiveRecord#to_json:      208.3 i/s - 8.73x slower
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Additionally,
+the bin/benchmarks task will allow you to run the benchmarks locally.
+
+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/[USERNAME]/pg_flash_json.
+
+
+## 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/benchmarks

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+require 'benchmark/ips'
+require "bundler/setup"
+require "pg_flash_json"
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: :postgresql, database: 'pg_flash_json_test', username: ENV['PG_DB_USERNAME'], password: ENV['PG_DB_PASSWORD']
+
+  class Post < ActiveRecord::Base
+    has_many :comments
+  end
+
+  class Comment < ActiveRecord::Base
+    belongs_to :post
+  end
+
+  def seed_data
+    create_post_table  unless ActiveRecord::Migration.table_exists?(:posts)
+    create_comment_table unless ActiveRecord::Migration.table_exists?(:comments)
+    200.times do |i|
+      post = Post.create!(title: "Post ##{i}", content: "some post content #{(i+2).to_s}")
+      1.times {|ci| Comment.create(content: "comment content #{ci}", post_id: post.id)}
+    end
+  end
+
+  def create_post_table
+    ActiveRecord::Migration.create_table :posts do |t|
+      t.string :title
+      t.text :content
+    end
+  end
+
+  def create_comment_table
+    ActiveRecord::Migration.create_table :comments do |t|
+      t.string :content
+      t.integer :post_id
+    end
+  end
+
+  seed_data
+
+# ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+  Benchmark.ips do |x|
+
+    x.report("PgFlashJson#to_pg_json") do
+      Post.limit(100).offset(100).to_pg_json
+    end
+
+    x.report("ActiveRecord#to_json") do
+      Post.limit(100).to_json
+    end
+
+    x.compare!
+  end
+

data/bin/setup

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

data/coverage/.last_run.json

@@ -0,0 +1,5 @@
+{
+  "result": {
+    "covered_percent": 92.14
+  }
+}

data/lib/pg_flash_json.rb

@@ -0,0 +1,4 @@
+require "pg_flash_json/version"
+require "pg_flash_json/pg_json_builder"
+require "pg_flash_json/sql_alias"
+require "pg_flash_json/pg_json_extension"

data/lib/pg_flash_json/pg_json_builder.rb

@@ -0,0 +1,40 @@
+class PGJsonBuilder
+
+  attr_accessor :attrs, :relation, :_alias
+
+  def initialize(relation, opts={})
+    @relation = relation
+    raise ArgumentError unless @relation.is_a?(ActiveRecord::Relation) || @relation.is_a?(ActiveRecord::AssociationRelation)
+    @_alias = SqlAlias.new.sql_alias
+    @attrs = opts.fetch(:attrs, @relation.column_names)
+    SqlAlias.clear
+    self
+  end
+
+  def attr_pairs_string
+    aps = ""
+     @attrs.each do |a|
+      a = a.to_s
+      value = "#{@_alias}.#{a}"
+      aps << "'#{a}', #{value},"
+    end
+    aps[0..-2]
+  end
+
+  def to_sql
+    build_json_object_query + query_end
+  end
+
+  def build_json_object_query(from_sub=false, relation_aps=attr_pairs_string)
+    first_char = from_sub ? "(" : ""
+    "#{first_char}SELECT json_agg( json_build_object(#{relation_aps}))"
+  end
+
+  def query_end
+    " as json FROM(#{@relation.to_sql})#{@_alias}"
+  end
+
+  def json
+    @relation.connection.execute(to_sql).first["json"]
+  end
+end

data/lib/pg_flash_json/pg_json_extension.rb

@@ -0,0 +1,14 @@
+require 'active_record'
+
+module ActiveRecord
+  module PgJsonExtension
+
+    def to_pg_json
+      PGJsonBuilder.new(self).json
+    end
+
+
+  end
+end
+
+ActiveRecord::Relation.include ActiveRecord::PgJsonExtension

data/lib/pg_flash_json/sql_alias.rb

@@ -0,0 +1,27 @@
+class SqlAlias
+  @used = []
+
+  attr_accessor :sql_alias
+
+  def self.used
+    @used
+  end
+
+  def self.clear
+    @used = []
+  end
+
+  def initialize
+    @sql_alias = new_alias
+    self.class.used << @sql_alias
+  end
+
+  def new_alias
+    alias_needed = true
+    while alias_needed do
+      potential_alias = "t#{rand(100000)}"
+      alias_needed = self.class.used.include?(potential_alias)
+    end
+    potential_alias
+  end
+end

data/lib/pg_flash_json/version.rb

@@ -0,0 +1,3 @@
+module PgFlashJson
+  VERSION = "0.1.1"
+end

data/pg_flash_json.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pg_flash_json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pg_flash_json"
+  spec.version       = PgFlashJson::VERSION
+  spec.authors       = ["dandlezzz"]
+  spec.email         = ["danm@workwithopal.com"]
+
+  spec.summary       = %{Use postgres to generate json from active record relations.}
+  spec.description   = %q{This gem allows you to rapidly generate large amount of json in an activerecord application. By relying on postgres' native functionality,
+                          we can skip object instantiation and turn active record queries directly into json.}
+  spec.homepage      = "https://github.com/dandlezzz/pg_flash_json"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|pkg)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = ["benchmarks"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "activerecord", "~> 4.2"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "benchmark-ips"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: pg_flash_json
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- dandlezzz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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: 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: benchmark-ips
+  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: |-
+  This gem allows you to rapidly generate large amount of json in an activerecord application. By relying on postgres' native functionality,
+                            we can skip object instantiation and turn active record queries directly into json.
+email:
+- danm@workwithopal.com
+executables:
+- benchmarks
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/benchmarks
+- bin/setup
+- coverage/.last_run.json
+- coverage/.resultset.json.lock
+- lib/pg_flash_json.rb
+- lib/pg_flash_json/pg_json_builder.rb
+- lib/pg_flash_json/pg_json_extension.rb
+- lib/pg_flash_json/sql_alias.rb
+- lib/pg_flash_json/version.rb
+- pg_flash_json.gemspec
+homepage: https://github.com/dandlezzz/pg_flash_json
+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.8
+signing_key: 
+specification_version: 4
+summary: Use postgres to generate json from active record relations.
+test_files: []