active_model_serializers_pg 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 749a92cbe1a5ef80dbfcf46cda82127108e0497465258e19a2023e0847b9696d
+  data.tar.gz: 32956f1353aa108fd173d02b2da79391ba45c286efc1e6080bb4e4927f630bf2
+SHA512:
+  metadata.gz: f9861a254e392c60be71bb396497e2f9fb226c6c9b1054635d1bd6dcb3bbd04992e5126d084a2f80d277c1d78603e9f82fb9eb166f6d545c373576eefa8d7fc7
+  data.tar.gz: ac39133be71300ecea935c95f090e2282b48bd55cd00431e905e04cf32974efec50e8fa34f6b2b4ec10652ae24201eb33c55b7c0c6ef42d8731a35144d761f42

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin/
+.env
+.ruby-version
+.ruby-gemset
+gemfiles/*.lock
+*.swp
+*.un~
+.pryrc

data/.rspec

@@ -0,0 +1 @@
+--color --tty

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+sudo: false
+cache: bundler
+
+rvm:
+- 2.4.9
+- 2.5.7
+- 2.6.5
+
+gemfile:
+  - gemfiles/Gemfile.activerecord-5.0.x
+  - gemfiles/Gemfile.activerecord-5.1.x
+  - gemfiles/Gemfile.activerecord-5.2.x
+
+env: DATABASE_URL=postgres://localhost/travis RUBYOPT=-W0
+
+before_script:
+- bundle exec rake db:migrate
+
+addons:
+  postgresql: '9.4'

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+unless ENV['CI']
+  gem 'm'
+  gem 'pry'
+  gem 'pry-highlight'
+  gem 'pry-byebug', platforms: [:mri]
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2019 Paul A. Jungwirth
+
+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,111 @@
+# active\_model\_serializers\_pg
+
+This gem provides an ActiveModelSerializers adapter that can generate JSON directly in Postgres.
+It was inspired by [postgres\_ext-serializers](https://github.com/DavyJonesLocker/postgres_ext-serializers) which is no longer maintained and only supports Rails 4 and AMS 0.8.
+This gem adds support for Rails 5 and AMS 0.10.
+In addition we provide output in [JSON:API](https://jsonapi.org/) format.
+(I'd like to add normal JSON output too, so let me know if that would be helpful to you.)
+
+Building your JSON is Postgres can reduce your response time 10-100x.
+You skip instantiating thousands of Ruby objects (and garbage collecting them later),
+and Postgres can generate the JSON far more quickly than AMS.
+
+You can read lots more about this gem's approach at DockYard's blog post,
+[Avoid Rails When Generating JSON responses with PostgreSQL](https://dockyard.com/blog/2014/05/27/avoid-rails-when-generating-json-responses-with-postgresql) by Dan McClain,
+or [watch a YouTube video](https://www.youtube.com/watch?v=tYTw3Jshrqo) of his Postgres Open 2014 Talk [Using PostgreSQL, not Rails, to make Rails faster](http://slides.com/danmcclain/postgresopen-2014) (Slides).
+Not everything is this same, but hopefully you'll still get the general idea.
+
+This gem requires Rails 5, AMS 0.10, and Postgres 9.4+.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_model_serializers_pg'
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install active_model_serializers_pg
+
+## Usage
+
+You can enable in-Postgres serialization for everything by putting this in a Rails initializer:
+
+    ActiveModelSerializers.config.adapter = :json_api_pg
+
+or use it more selectively in your controller actions by saying:
+
+    render json: @users, adapter: :json_api_pg
+
+You could also turn it on for everything but then set `adapter: :json_api` for any actions where it doesn't work.
+
+Note this gem also respects `ActiveModelSerializers.config.key_transform = :dash`, if you are using that.
+
+### Methods in Serializers and Models
+
+If you are using methods to compute properties for your JSON responses
+in your models or serializers, active\_model\_serializers\_pg will try to
+discover a SQL version of this call by looking for a class method with
+the same name and the suffix `__sql`. Here's an example:
+
+```ruby
+class MyModel < ActiveRecord::Base
+  def full_name
+    "#{object.first_name} #{object.last_name}"
+  end
+
+  def self.full_name__sql
+    "first_name || ' ' || last_name"
+  end
+end
+```
+
+There is no instance of MyModel created so sql computed properties needs to be
+a class method. Right now, this string is used as a SQL literal, so be sure to
+*not* use untrusted values in the return value.
+
+## Developing
+
+To work on active\_model\_serializers\_pg locally, follow these steps:
+
+ 1. Run `bundle install`, this will install (almost) all the development
+    dependencies.
+ 2. Run `gem install byebug` (not a declared dependency to not break CI).
+ 3. Run `bundle exec rake setup`, this will set up the `.env` file necessary to run
+    the tests and set up the database.
+ 4. Run `bundle exec rake db:create`, this will create the test database.
+ 5. Run `bundle exec rake db:migrate`, this will set up the database tables required
+    by the test.
+ 6. Run `bundle exec rake test:all` to run tests against all supported versions of Active Record (currently 5.0.x, 5.1.x, 5.2.x).
+    You can also say `BUNDLE_GEMFILE=gemfiles/Gemfile.activerecord-5.2.x bundle exec rspec spec` to run against a specific version (and select specific tests).
+
+Commands for building/releasing/installing:
+
+* `rake build`
+* `rake install`
+* `rake release`
+
+## Authors
+
+Paul Jungwirth
+[github](http://github.com/pjungwir)
+
+Thanks to [Dan McClain](https://github.com/danmcclain) for writing the original postgres\_ext-serializers gem!
+
+## Versioning ##
+
+This gem follows [Semantic Versioning](http://semver.org)
+
+## Want to help? ##
+
+Please do! We are always looking to improve this gem.
+
+## Legal ##
+
+Copyright &copy; 2019 Paul A. Jungwirth
+
+[Licensed under the MIT license](http://www.opensource.org/licenses/mit-license.php)

data/Rakefile

@@ -0,0 +1,134 @@
+require 'uri'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+task :setup do
+  if File.exist?('.env')
+    puts 'This will overwrite your existing .env file'
+  end
+
+  default_db_name = 'active_model_serializers_pg_test'
+  default_db_host = 'localhost'
+  default_db_port = '5432'
+
+  print "Enter your database name: [#{default_db_name}] "
+  db_name = STDIN.gets.chomp
+  print 'Enter your database user: [] '
+  db_user = STDIN.gets.chomp
+  print 'Enter your database password: [] '
+  db_password = STDIN.gets.chomp
+  print "Enter your database host: [#{default_db_host}] "
+  db_host = STDIN.gets.chomp
+  print "Enter your database port: [#{default_db_port}] "
+  db_port = STDIN.gets.chomp
+
+  db_name = default_db_name if db_name.empty?
+  db_password = ":#{URI.escape(db_password)}" unless db_password.empty?
+  db_ = default_db_host if db_host.empty?
+
+  db_user_at = db_user.empty? ? '' : '@'
+  db_port_colon = db_port.empty? ? '' : ':'
+
+  env_path = File.expand_path('./.env')
+  File.open(env_path, 'w') do |file|
+    file.puts "DATABASE_NAME=#{db_name}"
+    file.puts "DATABASE_PORT=#{db_port}"
+    file.puts "DATABASE_URL=\"postgres://#{db_user}#{db_password}#{db_user_at}#{db_host}#{db_port_colon}#{db_port}/#{db_name}\""
+  end
+
+  puts '.env file saved'
+end
+
+namespace :db do
+  task :load_db_settings do
+    require 'active_record'
+    unless ENV['DATABASE_URL']
+      require 'dotenv'
+      Dotenv.load
+    end
+  end
+
+  task :psql => :load_db_settings do
+    exec "psql -p #{ENV['DATABASE_PORT']} #{ENV['DATABASE_NAME']}"
+  end
+
+  task :drop => :load_db_settings do
+    %x{ dropdb -p #{ENV['DATABASE_PORT']} #{ENV['DATABASE_NAME']} }
+  end
+
+  task :create => :load_db_settings do
+    %x{ createdb -p #{ENV['DATABASE_PORT']} #{ENV['DATABASE_NAME']} }
+  end
+
+  task :migrate => :load_db_settings do
+    ActiveRecord::Base.establish_connection
+
+    ActiveRecord::Base.connection.create_table :people, force: true do |t|
+      t.string   "first_name"
+      t.string   "last_name"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    ActiveRecord::Base.connection.create_table :notes, force: true do |t|
+      t.string   "name"
+      t.string   "content"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    ActiveRecord::Base.connection.create_table :tags, force: true do |t|
+      t.integer  "note_id"
+      t.string   "name"
+      t.boolean  "popular"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    ActiveRecord::Base.connection.create_table :offers, force: true do |t|
+      t.integer  "created_by_id"
+      t.integer  "reviewed_by_id"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    ActiveRecord::Base.connection.create_table :users, force: true do |t|
+      t.string   "name"
+      t.string   "mobile"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    ActiveRecord::Base.connection.create_table :addresses, force: true do |t|
+      t.string   "district_name"
+      t.integer  "user_id"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    puts 'Database migrated'
+  end
+end
+
+namespace :test do
+  desc 'Test against all supported ActiveRecord versions'
+  task :all do
+    # Escape current bundler environment
+    Bundler.with_clean_env do
+      # Currently only supports Active Record v5.0-v5.2
+      %w(5.0.x 5.1.x 5.2.x).each do |version|
+        sh "BUNDLE_GEMFILE='gemfiles/Gemfile.activerecord-#{version}' bundle install --quiet"
+        sh "BUNDLE_GEMFILE='gemfiles/Gemfile.activerecord-#{version}' bundle exec rspec spec"
+      end
+    end
+  end
+end

data/active_model_serializers_pg.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_model_serializers_pg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_model_serializers_pg"
+  spec.version       = ActiveModelSerializersPg::VERSION
+  spec.authors       = ["Paul A. Jungwirth"]
+  spec.email         = ["pj@illuminatedcomputing.com"]
+  spec.summary       = %q{Harness the power of PostgreSQL when crafting JSON reponses}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/pjungwir/active_model_serializers_pg"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency     'active_model_serializers', '~> 0.10.8'
+  spec.add_runtime_dependency     'activerecord', '~> 5.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'actionpack', '> 4.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'bourne', '~> 1.3.0'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'dotenv'
+  if RUBY_PLATFORM =~ /java/
+    spec.add_development_dependency 'activerecord-jdbcpostgresql-adapter', '1.3.0.beta2'
+  else
+    spec.add_development_dependency 'pg', '~> 0.15'
+  end
+end

data/gemfiles/Gemfile.activerecord-5.0.x

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

data/gemfiles/Gemfile.activerecord-5.1.x

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

data/gemfiles/Gemfile.activerecord-5.2.x

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