rabl 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 69b64e79c938fa56b79fa08d95a97f92c4f1fff8
-  data.tar.gz: 92afd63714dd8aae58385ed097682baab04c81ab
+SHA256:
+  metadata.gz: 0f39e37962add4e967db96ddb7970e8b5567180494024c83ab1cd0f40b215789
+  data.tar.gz: f61f64c38bb2baf81ce33885feb2fb7a9fc3a9e3587a8767f08d29cacb88a455
 SHA512:
-  metadata.gz: 7721e7744da0a52bd67aea61d060a1db815cb926b9f4b7e019519ad581ba35ab1a0af5eefe4dfe9fc9cc22fff3e24c3479f2e54a66810180047ca6d93c993363
-  data.tar.gz: 95df50736a71777c09a731eb9cc3e9752a7282e3a22bf93ebd1da7c1a024fd1d6771351e2d84b8097bef872580c43d6556a37d4c0a75c891f730bed46e45cc3d
+  metadata.gz: fffcd3104d9a52f11ea39205040858112b12199df5062ad7e3bce56d5ef12f02c97718974bb11765cc2afbde585a8190d0aa93630e655b588d76d66a503854f2
+  data.tar.gz: 8a780a5d5dc6ca50da1183a71d2292bee13be1abbaffa8f7c7972854c009265c32543710a8879f8de1cbc1d7186cfd48b5d2528907e184a918832b07675f6d50

data/.travis.yml

@@ -5,8 +5,10 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1
-  - 2.2.5
-  - 2.3.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
 notifications:
   recipients:
     - nesquena@gmail.com

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.14.0 (October 31st, 2018)
+
+* Compatibility with Rails 5 API mode
+
 ## 0.13.1 (October 21st, 2016)
 
 * Further compatibility with Rails 5

data/README.md

@@ -1,8 +1,8 @@
 # RABL #
 
-[![Continuous Integration status](https://secure.travis-ci.org/nesquena/rabl.png)](http://travis-ci.org/nesquena/rabl)
-[![Dependency Status](https://gemnasium.com/nesquena/rabl.png)](https://gemnasium.com/nesquena/rabl)
-[![Code Climate](https://codeclimate.com/github/nesquena/rabl.png)](https://codeclimate.com/github/nesquena/rabl)
+[![Continuous Integration status](https://secure.travis-ci.org/nesquena/rabl.svg)](http://travis-ci.org/nesquena/rabl)
+[![Dependency Status](https://gemnasium.com/nesquena/rabl.svg)](https://gemnasium.com/nesquena/rabl)
+[![Code Climate](https://codeclimate.com/github/nesquena/rabl.svg)](https://codeclimate.com/github/nesquena/rabl)
 
 RABL (Ruby API Builder Language) is a Rails and [Padrino](http://padrinorb.com) ruby templating system for generating JSON, XML, MessagePack, PList and BSON.
 When using the ActiveRecord 'to_json' method, I find myself wanting a more expressive and powerful solution for generating APIs.
@@ -146,6 +146,7 @@ Rabl.configure do |config|
   # config.replace_empty_string_values_with_nil_values = true # Defaults to false
   # config.exclude_nil_values = true # Defaults to false
   # config.exclude_empty_values_in_collections = true # Defaults to false
+  # config.camelize_keys = :upper # Defaults to false
 end
 ```
 
@@ -186,6 +187,8 @@ If `exclude_nil_values` is set to `true`, all values that are `nil` and would no
 
 if `exclude_empty_values_in_collections` is set to `true`, all vaules in a collection that are `{}` and would normally be displayed as `{}` in the response are not included in the response.
 
+If `camelize_keys` is set to `true`, all object keys will be converted to camel case. By default the first character will be lower case. The value can be set to `:upper` to set the first chracter to upper case.
+
 If you wish to use [oj](https://github.com/ohler55/oj) as
 the primary JSON encoding engine simply add that to your Gemfile:
 
@@ -300,6 +303,13 @@ Named and aliased attributes can not be combined on the same line. This currentl
 attributes :foo, :bar => :baz # throws exception
 ```
 
+in such cases, you need to specify attributes twice.
+
+```ruby
+attributes :foo
+attributes :bar => :baz
+```
+
 ### Child Nodes ###
 
 Often a response requires including nested information from data associated with the parent model:
@@ -580,11 +590,11 @@ You can also pass in other instance variables to be used in your template as:
 Rabl::Renderer.new('posts/show', @post, :locals => { :custom_title => "Hello world!" })
 ````
 
-Then, in your template, you can use `@custom_title` as:
+Then, in your template, you can use `locals[:custom_title]` as:
 
-```
+```ruby
 attribute :content
-node(:title) { @custom_title }
+node(:title) { locals[:custom_title] }
 ```
 
 ### Content Type Headers ###
@@ -624,13 +634,9 @@ Tutorials can always be helpful when first getting started:
 
  * [Railscasts #322](http://railscasts.com/episodes/322-rabl) - Ryan Bates explains RABL
  * [BackboneRails](http://www.backbonerails.com/) - Great screencasts by Brian Mann
- * [Creating an API with RABL and Padrino](http://blog.crowdint.com/2012/10/22/rabl-with-padrino.html)
  * http://blog.joshsoftware.com/2011/12/23/designing-rails-api-using-rabl-and-devise/
- * http://engineering.gomiso.com/2011/06/27/building-a-platform-api-on-rails/
- * http://blog.lawrencenorton.com/better-json-requests-with-rabl
  * http://tech.favoritemedium.com/2011/06/using-rabl-in-rails-json-web-api.html
  * http://seesparkbox.com/foundry/better_rails_apis_with_rabl
- * http://blog.dcxn.com/2011/06/22/rails-json-templates-through-rabl
  * http://teohm.github.com/blog/2011/05/31/using-rabl-in-rails-json-web-api
 
 Let me know if there's any other useful resources not listed here.

data/Rakefile

@@ -9,7 +9,11 @@ Rake::TestTask.new(:test) do |test|
   test.pattern = 'test/*_test.rb'
   test.warning = true
   test.verbose = true
-  test.ruby_opts = ['-rubygems']
+  if RUBY_VERSION < "1.9.0"
+    # -rubygems isn't needed as of 1.9, and is gone as of 2.5
+    # https://github.com/ruby/ruby/blob/v2_5_0/NEWS#stdlib-compatibility-issues-excluding-feature-bug-fixes
+    test.ruby_opts = ['-rubygems']
+  end
 end
 
 # Running integration tests
@@ -17,7 +21,7 @@ end
 # rake test:setup
 # rake test:full
 
-fixture_list = "{padrino_test,sinatra_test,rails2,rails3,rails3_2,rails4,rails5}"
+fixture_list = "{padrino_test,sinatra_test,rails2,rails3,rails3_2,rails4,rails5,rails5_api}"
 
 desc "Clean up the fixtures being tested by cleaning and installing dependencies"
 task "test:clean" do
@@ -33,7 +37,12 @@ task "test:setup" do
     puts "\n*** Setting up for #{File.basename(fixture)} tests ***\n"
     `export BUNDLE_GEMFILE="#{fixture}/Gemfile"` if ENV["TRAVIS"]
     Bundler.with_clean_env {
-      Dir.chdir(fixture) { puts `mkdir -p tmp/cache; bundle install --gemfile="#{fixture}/Gemfile"`; }
+      Dir.chdir(fixture) {
+        puts `mkdir -p tmp/cache; bundle install --gemfile="#{fixture}/Gemfile"`
+        if fixture.include? 'rails'
+          puts `bundle exec rake db:reset`
+        end
+      }
     }
   end
 end

data/fixtures/ashared/NOTES

@@ -42,3 +42,49 @@ ln -s "../../ashared/views_rails_3/" app/views
 ln -s "../../ashared/migrate" db/migrate
 ln -s ../../../../test/integration/rails3_2/posts_controller_test.rb test/functional/posts_controller_test.rb
 ln -s ../../../../test/integration/rails3_2/users_controller_test.rb test/functional/users_controller_test.rb
+
+# Rails 5
+
+cd fixtures/rails5
+ln -s "../../ashared/models" app/models
+ln -s "../../ashared/views_rails_3/" app/views
+ln -s "../../ashared/migrate" db/migrate
+ln -s "../../ashared/helpers" app/helpers
+ln -s "../../../ashared/controllers_rails_5/posts_controller.rb" app/controllers/posts_controller.rb
+ln -s "../../../ashared/controllers_rails_5/users_controller.rb" app/controllers/users_controller.rb
+ln -s ../../../../test/integration/rails5/posts_controller_test.rb test/functional/posts_controller_test.rb
+ln -s ../../../../test/integration/rails5/users_controller_test.rb test/functional/users_controller_test.rb
+echo "Mime::Type.register 'application/vnd.rabl-test_v1+json', :rabl_test_v1" >> config/initializers/mime_types.rb
+# Do route file?
+
+# Rails 5 API mode
+
+# Basic setup
+cd fixtures
+rvm use 2.5.0
+rails _5.0.2_ new rails5_api --api
+cd rails5_api
+
+# Server config
+echo "Mime::Type.register 'application/vnd.rabl-test_v1+json', :rabl_test_v1" >> config/initializers/mime_types.rb
+cp ../rails5/config/routes.rb config/routes.rb
+
+# Application
+rm -r app/models app/views app/migrate
+ln -s "../../ashared/models" app/models
+ln -s "../../ashared/views_rails_3/" app/views
+ln -s "../../ashared/migrate" db/migrate
+ln -s "../../ashared/helpers" app/helpers
+ln -s "../../../ashared/controllers_rails_5/posts_controller.rb" app/controllers/posts_controller.rb
+ln -s "../../../ashared/controllers_rails_5/users_controller.rb" app/controllers/users_controller.rb
+
+# Test setup
+cp ../rails5/Rakefile ./
+mkdir test/functional
+ln -s ../../../../test/integration/rails5/posts_controller_test.rb test/functional/posts_controller_test.rb
+ln -s ../../../../test/integration/rails5/users_controller_test.rb test/functional/users_controller_test.rb
+cp ../rails5/test/test_helper.rb ./test/test_helper.rb
+
+# Do a bunch of junk with gemfiles and test helpers and such
+
+# end Rails 5 API mode

data/fixtures/ashared/controllers_rails_5/posts_controller.rb

@@ -0,0 +1,17 @@
+class PostsController < ApplicationController
+
+  respond_to :json, :xml, :html, :rabl_test_v1
+
+  def index
+    @posts = Post.order('id ASC').load
+  end
+
+  def show
+    @post = Post.find(params[:id])
+  end
+
+  def renderer
+    post = Post.find(params[:id])
+    render json: Rabl.render(post, 'posts/renderer', view_path: 'app/views', format: :json, scope: view_context)
+  end
+end

data/fixtures/ashared/controllers_rails_5/users_controller.rb

@@ -0,0 +1,11 @@
+class UsersController < ApplicationController
+  respond_to :json
+
+  def index
+    @users = User.order('username ASC').load
+  end
+
+  def show
+    @user = User.find(params[:id])
+  end
+end

data/fixtures/rails3/db/schema.rb

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20111002092024) do
+
+  create_table "phone_numbers", :force => true do |t|
+    t.integer "user_id"
+    t.boolean "is_primary"
+    t.string  "area_code"
+    t.string  "prefix"
+    t.string  "suffix"
+    t.string  "name"
+  end
+
+  create_table "posts", :force => true do |t|
+    t.integer  "user_id"
+    t.string   "title"
+    t.text     "body"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "users", :force => true do |t|
+    t.string   "username"
+    t.string   "email"
+    t.string   "location"
+    t.boolean  "is_admin"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/fixtures/rails4/Gemfile

@@ -1,15 +1,19 @@
 source 'https://rubygems.org'
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-gem 'rails', '4.0.0'
+gem 'rails', '4.2.8'
 
 # Use sqlite3 as the database for Active Record
 gem 'sqlite3'
 gem 'rabl', :path => File.expand_path(File.dirname(__FILE__) + "/../../")
 gem 'riot', :group => "test"
+gem 'pry-rails', :group => "test"
 
 gem "oj"
 
+# respond_to is its own gem now
+gem 'responders', '~> 2.0'
+
 # Use SCSS for stylesheets
 gem 'sass-rails', '~> 4.0.0'
 

data/fixtures/rails4/config/environments/test.rb

@@ -33,4 +33,7 @@ Rails4::Application.configure do
 
   # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
+
+  # Run tests in sorted order (squash test error)
+  config.active_support.test_order = :sorted
 end

data/fixtures/rails4/db/schema.rb

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20111002092024) do
+
+  create_table "phone_numbers", force: :cascade do |t|
+    t.integer "user_id"
+    t.boolean "is_primary"
+    t.string  "area_code"
+    t.string  "prefix"
+    t.string  "suffix"
+    t.string  "name"
+  end
+
+  create_table "posts", force: :cascade do |t|
+    t.integer  "user_id"
+    t.string   "title"
+    t.text     "body"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "users", force: :cascade do |t|
+    t.string   "username"
+    t.string   "email"
+    t.string   "location"
+    t.boolean  "is_admin"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/fixtures/rails5/Gemfile

@@ -33,6 +33,7 @@ gem 'jbuilder', '~> 2.5'
 group :development, :test do
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem 'byebug', platform: :mri
+  gem 'pry-rails'
 end
 
 group :development do

data/fixtures/rails5/Rakefile

@@ -7,7 +7,7 @@ require 'rake/testtask'
 Rails.application.load_tasks
 
 Rake::TestTask.new("test:rabl") do |test|
-  test.pattern = "test/controllers/**/*_test.rb"
+  test.pattern = "test/functional/**/*_test.rb"
   test.verbose = true
   test.warning = false
 end

data/fixtures/rails5/app/controllers/posts_controller.rb

@@ -0,0 +1 @@
+fixtures/rails5/app/controllers/../../../ashared/controllers_rails_5/posts_controller.rb

data/fixtures/rails5/app/controllers/users_controller.rb

@@ -0,0 +1 @@
+fixtures/rails5/app/controllers/../../../ashared/controllers_rails_5/users_controller.rb

data/fixtures/rails5/app/helpers

@@ -0,0 +1 @@
+fixtures/rails5/app/../../ashared/helpers

data/fixtures/rails5/config/initializers/mime_types.rb

@@ -2,3 +2,5 @@
 
 # Add new mime types for use in respond_to blocks:
 # Mime::Type.register "text/richtext", :rtf
+
+Mime::Type.register 'application/vnd.rabl-test_v1+json', :rabl_test_v1

data/fixtures/rails5/test/functional/posts_controller_test.rb

@@ -0,0 +1 @@
+fixtures/rails5/test/functional/../../../../test/integration/rails5/posts_controller_test.rb

data/fixtures/rails5/test/functional/users_controller_test.rb

@@ -0,0 +1 @@
+fixtures/rails5/test/functional/../../../../test/integration/rails5/users_controller_test.rb

data/fixtures/rails5_api/.gitignore

@@ -0,0 +1,21 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore Byebug command history file.
+.byebug_history

data/fixtures/rails5_api/Gemfile

@@ -0,0 +1,46 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 5.0.2'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+# Use Puma as the app server
+gem 'puma', '~> 3.0'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+# gem 'jbuilder', '~> 2.5'
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 3.0'
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+# Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
+# gem 'rack-cors'
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platform: :mri
+  gem 'pry-rails'
+end
+
+group :development do
+  gem 'listen', '~> 3.0.5'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
+gem 'rabl', :path => File.expand_path(File.dirname(__FILE__) + "/../../")
+gem 'riot', :group => "test"
+gem 'responders', '~> 2.0'