pg_jbuilder 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +22 -0
- data/.rspec +2 -0
- data/Gemfile +4 -0
- data/Guardfile +10 -0
- data/LICENSE.txt +22 -0
- data/README.md +468 -0
- data/Rakefile +7 -0
- data/config/database.yml +3 -0
- data/lib/pg_jbuilder.rb +108 -0
- data/lib/pg_jbuilder/railtie.rb +44 -0
- data/lib/pg_jbuilder/version.rb +3 -0
- data/pg_jbuilder.gemspec +30 -0
- data/queries/test1.sql +1 -0
- data/spec/dummy/README.rdoc +28 -0
- data/spec/dummy/Rakefile +6 -0
- data/spec/dummy/app/assets/images/.keep +0 -0
- data/spec/dummy/app/assets/javascripts/application.js +13 -0
- data/spec/dummy/app/assets/stylesheets/application.css +15 -0
- data/spec/dummy/app/controllers/application_controller.rb +5 -0
- data/spec/dummy/app/controllers/concerns/.keep +0 -0
- data/spec/dummy/app/helpers/application_helper.rb +2 -0
- data/spec/dummy/app/mailers/.keep +0 -0
- data/spec/dummy/app/models/.keep +0 -0
- data/spec/dummy/app/models/concerns/.keep +0 -0
- data/spec/dummy/app/models/test_model.rb +2 -0
- data/spec/dummy/app/queries/test.sql +1 -0
- data/spec/dummy/app/views/layouts/application.html.erb +14 -0
- data/spec/dummy/bin/bundle +3 -0
- data/spec/dummy/bin/rails +4 -0
- data/spec/dummy/bin/rake +4 -0
- data/spec/dummy/bin/setup +29 -0
- data/spec/dummy/config.ru +4 -0
- data/spec/dummy/config/application.rb +26 -0
- data/spec/dummy/config/boot.rb +5 -0
- data/spec/dummy/config/database.yml +26 -0
- data/spec/dummy/config/environment.rb +5 -0
- data/spec/dummy/config/environments/development.rb +41 -0
- data/spec/dummy/config/environments/production.rb +79 -0
- data/spec/dummy/config/environments/test.rb +42 -0
- data/spec/dummy/config/initializers/assets.rb +11 -0
- data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/spec/dummy/config/initializers/cookies_serializer.rb +3 -0
- data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
- data/spec/dummy/config/initializers/inflections.rb +16 -0
- data/spec/dummy/config/initializers/mime_types.rb +4 -0
- data/spec/dummy/config/initializers/session_store.rb +3 -0
- data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/spec/dummy/config/locales/en.yml +23 -0
- data/spec/dummy/config/routes.rb +56 -0
- data/spec/dummy/config/secrets.yml +22 -0
- data/spec/dummy/db/development.sqlite3 +0 -0
- data/spec/dummy/db/migrate/20150210004140_add_test_model.rb +11 -0
- data/spec/dummy/db/schema.rb +25 -0
- data/spec/dummy/db/test.sqlite3 +0 -0
- data/spec/dummy/lib/assets/.keep +0 -0
- data/spec/dummy/log/.keep +0 -0
- data/spec/dummy/log/development.log +303 -0
- data/spec/dummy/log/test.log +354 -0
- data/spec/dummy/public/404.html +67 -0
- data/spec/dummy/public/422.html +67 -0
- data/spec/dummy/public/500.html +66 -0
- data/spec/dummy/public/favicon.ico +0 -0
- data/spec/pg_jbuilder/pg_jbuilder_spec.rb +182 -0
- data/spec/pg_jbuilder/railtie_spec.rb +88 -0
- data/spec/queries/test2.sql +1 -0
- data/spec/spec_helper.rb +29 -0
- metadata +298 -0
data/Rakefile
ADDED
data/config/database.yml
ADDED
data/lib/pg_jbuilder.rb
ADDED
@@ -0,0 +1,108 @@
|
|
1
|
+
require 'pg_jbuilder/version'
|
2
|
+
require 'handlebars'
|
3
|
+
require 'pg_jbuilder/railtie' if defined?(Rails)
|
4
|
+
|
5
|
+
module PgJbuilder
|
6
|
+
@paths = [
|
7
|
+
File.join(File.dirname(__FILE__),'..','queries')
|
8
|
+
]
|
9
|
+
class TemplateNotFound < ::Exception; end
|
10
|
+
|
11
|
+
def self.render_object *args
|
12
|
+
result = render(*args)
|
13
|
+
"SELECT COALESCE(row_to_json(object_row),'{}'::json)\nFROM (\n#{result}\n) object_row"
|
14
|
+
end
|
15
|
+
|
16
|
+
def self.render_array *args
|
17
|
+
result = render(*args)
|
18
|
+
"SELECT COALESCE(array_to_json(array_agg(row_to_json(array_row))),'[]'::json)\nFROM (\n#{result}\n) array_row"
|
19
|
+
end
|
20
|
+
|
21
|
+
|
22
|
+
def self.render query, variables={}, options={}
|
23
|
+
contents = get_query_contents(query)
|
24
|
+
compiled = handlebars.compile(contents, noEscape: true)
|
25
|
+
compiled.call(variables)
|
26
|
+
end
|
27
|
+
|
28
|
+
def self.paths
|
29
|
+
@paths
|
30
|
+
end
|
31
|
+
|
32
|
+
def self.connection= value
|
33
|
+
@connection = value
|
34
|
+
end
|
35
|
+
|
36
|
+
def self.connection
|
37
|
+
if @connection.is_a?(Proc)
|
38
|
+
@connection.call
|
39
|
+
else
|
40
|
+
@connection
|
41
|
+
end
|
42
|
+
end
|
43
|
+
|
44
|
+
private
|
45
|
+
|
46
|
+
def self.get_query_contents query
|
47
|
+
File.read path_name(query)
|
48
|
+
end
|
49
|
+
|
50
|
+
def self.path_name *args
|
51
|
+
last_arg = args.pop
|
52
|
+
query_name = last_arg
|
53
|
+
last_arg += '.sql'
|
54
|
+
args.push last_arg
|
55
|
+
@paths.each do |path|
|
56
|
+
file = File.join(path,*args)
|
57
|
+
if File.exists?(file) && File.file?(file)
|
58
|
+
return file
|
59
|
+
end
|
60
|
+
end
|
61
|
+
raise TemplateNotFound.new("Template #{query_name} was not found in any source paths")
|
62
|
+
end
|
63
|
+
|
64
|
+
def self.render_helper context, value, options
|
65
|
+
variables = Hash[context.collect{|k,v|[k,v]}]
|
66
|
+
options['hash'].each{|k,v| variables[k] = v} if options
|
67
|
+
PgJbuilder.render value, variables
|
68
|
+
end
|
69
|
+
|
70
|
+
def self.handlebars
|
71
|
+
unless @handlebars
|
72
|
+
@handlebars = Handlebars::Context.new
|
73
|
+
@handlebars.register_helper :include do |context,value,options|
|
74
|
+
render_helper context, value, options
|
75
|
+
end
|
76
|
+
|
77
|
+
@handlebars.register_helper :quote do |context,value,options|
|
78
|
+
connection.quote value
|
79
|
+
end
|
80
|
+
|
81
|
+
@handlebars.register_helper :object do |context,value,options|
|
82
|
+
if value.is_a?(String)
|
83
|
+
content = render_helper(context,value,options)
|
84
|
+
content = "\n#{content}\n"
|
85
|
+
else
|
86
|
+
content = value.fn(context)
|
87
|
+
end
|
88
|
+
"(SELECT COALESCE(row_to_json(object_row),'{}'::json) FROM (" +
|
89
|
+
content +
|
90
|
+
")object_row)"
|
91
|
+
end
|
92
|
+
|
93
|
+
@handlebars.register_helper :array do |context,value,options|
|
94
|
+
if value.is_a?(String)
|
95
|
+
content = render_helper(context,value,options)
|
96
|
+
content = "\n#{content}\n"
|
97
|
+
else
|
98
|
+
content = value.fn(context)
|
99
|
+
end
|
100
|
+
"(SELECT COALESCE(array_to_json(array_agg(row_to_json(array_row))),'[]'::json) FROM (" +
|
101
|
+
content +
|
102
|
+
")array_row)"
|
103
|
+
end
|
104
|
+
end
|
105
|
+
@handlebars
|
106
|
+
end
|
107
|
+
end
|
108
|
+
|
@@ -0,0 +1,44 @@
|
|
1
|
+
module PgJbuilder
|
2
|
+
class Railtie < Rails::Railtie
|
3
|
+
initializer 'pg_jbuilder_rails_railtie.configure_rails_initialization' do
|
4
|
+
::PgJbuilder.paths.unshift Rails.root.join('app','queries')
|
5
|
+
ActiveRecord::Base.send(:include, ActiveRecordExtension)
|
6
|
+
PgJbuilder.connection = lambda { ActiveRecord::Base.connection }
|
7
|
+
end
|
8
|
+
end
|
9
|
+
|
10
|
+
module ActiveRecordExtension
|
11
|
+
extend ActiveSupport::Concern
|
12
|
+
|
13
|
+
def select_array *args
|
14
|
+
self.class.select_array(*args)
|
15
|
+
end
|
16
|
+
|
17
|
+
def select_object *args
|
18
|
+
self.class.select_object(*args)
|
19
|
+
end
|
20
|
+
|
21
|
+
def select_value *args
|
22
|
+
self.class.select_value(*args)
|
23
|
+
end
|
24
|
+
|
25
|
+
module ClassMethods
|
26
|
+
|
27
|
+
def select_array name, variables={}
|
28
|
+
sql = PgJbuilder.render_array name, variables
|
29
|
+
connection.select_value sql
|
30
|
+
end
|
31
|
+
|
32
|
+
def select_object name, variables={}
|
33
|
+
sql = PgJbuilder.render_object name, variables
|
34
|
+
connection.select_value sql
|
35
|
+
end
|
36
|
+
|
37
|
+
def select_value name, variables={}
|
38
|
+
sql = PgJbuilder.render name, variables
|
39
|
+
connection.select_value sql
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
data/pg_jbuilder.gemspec
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'pg_jbuilder/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "pg_jbuilder"
|
8
|
+
spec.version = PgJbuilder::VERSION
|
9
|
+
spec.authors = ["tye"]
|
10
|
+
spec.email = ["tye@tye.ca"]
|
11
|
+
spec.summary = %q{Use PostgreSQL JSON functions to dump database queries directly to a JSON object or array.}
|
12
|
+
spec.description = %q{pg_jbuilder is a tool to dump database queries directly to a JSON object or array. It uses PostgreSQL's JSON functions ([array_to_json and row_to_json](http://www.postgresql.org/docs/9.3/static/functions-json.html)) to serialize the JSON completely bypassing ActiveRecord/Arel. This gives a large speed boost compared to serializing the JSON inside of Ruby/Rails. It is perfect for creating JSON APIs with very low response times.}
|
13
|
+
spec.homepage = ""
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0")
|
17
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
18
|
+
spec.require_paths = ["lib"]
|
19
|
+
|
20
|
+
spec.add_dependency 'handlebars', '~> 0.6', '>= 0.6.0'
|
21
|
+
spec.add_dependency 'activerecord', '>= 3.0.0'
|
22
|
+
spec.add_dependency 'pg', '>= 0'
|
23
|
+
spec.add_development_dependency "bundler", "~> 1.6"
|
24
|
+
spec.add_development_dependency "rake", '~> 10.4', '>= 10.4.2'
|
25
|
+
spec.add_development_dependency "rspec", '~> 3.1', '>= 3.1.0'
|
26
|
+
#spec.add_development_dependency 'guard-rspec', '~> 0'
|
27
|
+
spec.add_development_dependency "rails", '~> 4.2.0'
|
28
|
+
spec.add_development_dependency 'sqlite3'
|
29
|
+
end
|
30
|
+
|
data/queries/test1.sql
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
SELECT 1 as one
|
@@ -0,0 +1,28 @@
|
|
1
|
+
== README
|
2
|
+
|
3
|
+
This README would normally document whatever steps are necessary to get the
|
4
|
+
application up and running.
|
5
|
+
|
6
|
+
Things you may want to cover:
|
7
|
+
|
8
|
+
* Ruby version
|
9
|
+
|
10
|
+
* System dependencies
|
11
|
+
|
12
|
+
* Configuration
|
13
|
+
|
14
|
+
* Database creation
|
15
|
+
|
16
|
+
* Database initialization
|
17
|
+
|
18
|
+
* How to run the test suite
|
19
|
+
|
20
|
+
* Services (job queues, cache servers, search engines, etc.)
|
21
|
+
|
22
|
+
* Deployment instructions
|
23
|
+
|
24
|
+
* ...
|
25
|
+
|
26
|
+
|
27
|
+
Please feel free to use a different markup language if you do not plan to run
|
28
|
+
<tt>rake doc:app</tt>.
|
data/spec/dummy/Rakefile
ADDED
File without changes
|
@@ -0,0 +1,13 @@
|
|
1
|
+
// This is a manifest file that'll be compiled into application.js, which will include all the files
|
2
|
+
// listed below.
|
3
|
+
//
|
4
|
+
// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
|
5
|
+
// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
|
6
|
+
//
|
7
|
+
// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
|
8
|
+
// compiled file.
|
9
|
+
//
|
10
|
+
// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
|
11
|
+
// about supported directives.
|
12
|
+
//
|
13
|
+
//= require_tree .
|
@@ -0,0 +1,15 @@
|
|
1
|
+
/*
|
2
|
+
* This is a manifest file that'll be compiled into application.css, which will include all the files
|
3
|
+
* listed below.
|
4
|
+
*
|
5
|
+
* Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
|
6
|
+
* or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
|
7
|
+
*
|
8
|
+
* You're free to add application-wide styles to this file and they'll appear at the bottom of the
|
9
|
+
* compiled file so the styles you add here take precedence over styles defined in any styles
|
10
|
+
* defined in the other CSS/SCSS files in this directory. It is generally better to create a new
|
11
|
+
* file per style scope.
|
12
|
+
*
|
13
|
+
*= require_tree .
|
14
|
+
*= require_self
|
15
|
+
*/
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
@@ -0,0 +1 @@
|
|
1
|
+
TEST SQL
|
@@ -0,0 +1,14 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<title>Dummy</title>
|
5
|
+
<%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
|
6
|
+
<%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
|
7
|
+
<%= csrf_meta_tags %>
|
8
|
+
</head>
|
9
|
+
<body>
|
10
|
+
|
11
|
+
<%= yield %>
|
12
|
+
|
13
|
+
</body>
|
14
|
+
</html>
|
data/spec/dummy/bin/rake
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
require 'pathname'
|
3
|
+
|
4
|
+
# path to your application root.
|
5
|
+
APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
|
6
|
+
|
7
|
+
Dir.chdir APP_ROOT do
|
8
|
+
# This script is a starting point to setup your application.
|
9
|
+
# Add necessary setup steps to this file:
|
10
|
+
|
11
|
+
puts "== Installing dependencies =="
|
12
|
+
system "gem install bundler --conservative"
|
13
|
+
system "bundle check || bundle install"
|
14
|
+
|
15
|
+
# puts "\n== Copying sample files =="
|
16
|
+
# unless File.exist?("config/database.yml")
|
17
|
+
# system "cp config/database.yml.sample config/database.yml"
|
18
|
+
# end
|
19
|
+
|
20
|
+
puts "\n== Preparing database =="
|
21
|
+
system "bin/rake db:setup"
|
22
|
+
|
23
|
+
puts "\n== Removing old logs and tempfiles =="
|
24
|
+
system "rm -f log/*"
|
25
|
+
system "rm -rf tmp/cache"
|
26
|
+
|
27
|
+
puts "\n== Restarting application server =="
|
28
|
+
system "touch tmp/restart.txt"
|
29
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
require File.expand_path('../boot', __FILE__)
|
2
|
+
|
3
|
+
require 'rails/all'
|
4
|
+
|
5
|
+
Bundler.require(*Rails.groups)
|
6
|
+
require "pg_jbuilder"
|
7
|
+
|
8
|
+
module Dummy
|
9
|
+
class Application < Rails::Application
|
10
|
+
# Settings in config/environments/* take precedence over those specified here.
|
11
|
+
# Application configuration should go into files in config/initializers
|
12
|
+
# -- all .rb files in that directory are automatically loaded.
|
13
|
+
|
14
|
+
# Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
|
15
|
+
# Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
|
16
|
+
# config.time_zone = 'Central Time (US & Canada)'
|
17
|
+
|
18
|
+
# The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
|
19
|
+
# config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
|
20
|
+
# config.i18n.default_locale = :de
|
21
|
+
|
22
|
+
# Do not swallow errors in after_commit/after_rollback callbacks.
|
23
|
+
config.active_record.raise_in_transactional_callbacks = true
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# SQLite version 3.x
|
2
|
+
# gem install sqlite3
|
3
|
+
#
|
4
|
+
# Ensure the SQLite 3 gem is defined in your Gemfile
|
5
|
+
# gem 'sqlite3'
|
6
|
+
#
|
7
|
+
default: &default
|
8
|
+
adapter: sqlite3
|
9
|
+
pool: 5
|
10
|
+
timeout: 5000
|
11
|
+
|
12
|
+
development:
|
13
|
+
<<: *default
|
14
|
+
database: db/development.sqlite3
|
15
|
+
|
16
|
+
# Warning: The database defined as "test" will be erased and
|
17
|
+
# re-generated from your development database when you run "rake".
|
18
|
+
# Do not set this db to the same as development or production.
|
19
|
+
test:
|
20
|
+
<<: *default
|
21
|
+
database: db/test.sqlite3
|
22
|
+
|
23
|
+
production:
|
24
|
+
<<: *default
|
25
|
+
database: db/production.sqlite3
|
26
|
+
|
@@ -0,0 +1,41 @@
|
|
1
|
+
Rails.application.configure do
|
2
|
+
# Settings specified here will take precedence over those in config/application.rb.
|
3
|
+
|
4
|
+
# In the development environment your application's code is reloaded on
|
5
|
+
# every request. This slows down response time but is perfect for development
|
6
|
+
# since you don't have to restart the web server when you make code changes.
|
7
|
+
config.cache_classes = false
|
8
|
+
|
9
|
+
# Do not eager load code on boot.
|
10
|
+
config.eager_load = false
|
11
|
+
|
12
|
+
# Show full error reports and disable caching.
|
13
|
+
config.consider_all_requests_local = true
|
14
|
+
config.action_controller.perform_caching = false
|
15
|
+
|
16
|
+
# Don't care if the mailer can't send.
|
17
|
+
config.action_mailer.raise_delivery_errors = false
|
18
|
+
|
19
|
+
# Print deprecation notices to the Rails logger.
|
20
|
+
config.active_support.deprecation = :log
|
21
|
+
|
22
|
+
# Raise an error on page load if there are pending migrations.
|
23
|
+
config.active_record.migration_error = :page_load
|
24
|
+
|
25
|
+
# Debug mode disables concatenation and preprocessing of assets.
|
26
|
+
# This option may cause significant delays in view rendering with a large
|
27
|
+
# number of complex assets.
|
28
|
+
config.assets.debug = true
|
29
|
+
|
30
|
+
# Asset digests allow you to set far-future HTTP expiration dates on all assets,
|
31
|
+
# yet still be able to expire them through the digest params.
|
32
|
+
config.assets.digest = true
|
33
|
+
|
34
|
+
# Adds additional error checking when serving assets at runtime.
|
35
|
+
# Checks for improperly declared sprockets dependencies.
|
36
|
+
# Raises helpful error messages.
|
37
|
+
config.assets.raise_runtime_errors = true
|
38
|
+
|
39
|
+
# Raises error for missing translations
|
40
|
+
# config.action_view.raise_on_missing_translations = true
|
41
|
+
end
|