rabl 0.13.1 → 0.14.0

data/fixtures/rails5_api/config/initializers/application_controller_renderer.rb

@@ -0,0 +1,6 @@
+# Be sure to restart your server when you modify this file.
+
+# ApplicationController.renderer.defaults.merge!(
+#   http_host: 'example.org',
+#   https: false
+# )

data/fixtures/rails5_api/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/fixtures/rails5_api/config/initializers/cors.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Avoid CORS issues when API is called from the frontend app.
+# Handle Cross-Origin Resource Sharing (CORS) in order to accept cross-origin AJAX requests.
+
+# Read more: https://github.com/cyu/rack-cors
+
+# Rails.application.config.middleware.insert_before 0, Rack::Cors do
+#   allow do
+#     origins 'example.com'
+#
+#     resource '*',
+#       headers: :any,
+#       methods: [:get, :post, :put, :patch, :delete, :options, :head]
+#   end
+# end

data/fixtures/rails5_api/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/fixtures/rails5_api/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

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

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# 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_api/config/initializers/new_framework_defaults.rb

@@ -0,0 +1,18 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains migration options to ease your Rails 5.0 upgrade.
+#
+# Read the Guide for Upgrading Ruby on Rails for more info on each option.
+
+# Make Ruby 2.4 preserve the timezone of the receiver when calling `to_time`.
+# Previous versions had false.
+ActiveSupport.to_time_preserves_timezone = true
+
+# Require `belongs_to` associations by default. Previous versions had false.
+Rails.application.config.active_record.belongs_to_required_by_default = true
+
+# Do not halt callback chains when a callback returns false. Previous versions had true.
+ActiveSupport.halt_callback_chains_on_return_false = false
+
+# Configure SSL options to enable HSTS with subdomains. Previous versions had false.
+Rails.application.config.ssl_options = { hsts: { subdomains: true } }

data/fixtures/rails5_api/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#   self.include_root_in_json = true
+# end

data/fixtures/rails5_api/config/locales/en.yml

@@ -0,0 +1,23 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+  hello: "Hello world"

data/fixtures/rails5_api/config/puma.rb

@@ -0,0 +1,47 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum, this matches the default thread size of Active Record.
+#
+threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }.to_i
+threads threads_count, threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests, default is 3000.
+#
+port        ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked webserver processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory. If you use this option
+# you need to make sure to reconnect any threads in the `on_worker_boot`
+# block.
+#
+# preload_app!
+
+# The code in the `on_worker_boot` will be called if you are using
+# clustered mode by specifying a number of `workers`. After each worker
+# process is booted this block will be run, if you are using `preload_app!`
+# option you will want to use this block to reconnect to any threads
+# or connections that may have been created at application boot, Ruby
+# cannot share connections between processes.
+#
+# on_worker_boot do
+#   ActiveRecord::Base.establish_connection if defined?(ActiveRecord)
+# end
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart

data/fixtures/rails5_api/config/routes.rb

@@ -0,0 +1,8 @@
+Rails.application.routes.draw do
+  resources :users
+  resources :posts do
+    member do
+      get 'renderer'
+    end
+  end
+end

data/fixtures/rails5_api/config/secrets.yml

@@ -0,0 +1,22 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rails secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+development:
+  secret_key_base: 62de20421b0c0b633ba96ebc33fa2aa67af1a89d2d7a031721526887cef59648b0bdd1cd109db47b865c6edbaa98da992b7f2ae1944ebab515839276e1e0582a
+
+test:
+  secret_key_base: c2460a288fb4918b55bd17f4666c2ff1a2460d4003ca06a0c0b1e7f1fb82df7f7ffd4d7b4b185ac198e1e451365dc3b0d535a44ab854086d17d6587dea367f72
+
+# Do not keep production secrets in the repository,
+# instead read values from the environment.
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/fixtures/rails5_api/config/spring.rb

@@ -0,0 +1,6 @@
+%w(
+  .ruby-version
+  .rbenv-vars
+  tmp/restart.txt
+  tmp/caching-dev.txt
+).each { |path| Spring.watch(path) }

data/fixtures/rails5_api/db/migrate

@@ -0,0 +1 @@
+fixtures/rails5_api/db/../../ashared/migrate

data/fixtures/rails5_api/db/schema.rb

@@ -0,0 +1,41 @@
+# 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_api/db/seeds.rb

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rails db:seed command (or created alongside the database with db:setup).
+#
+# Examples:
+#
+#   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
+#   Character.create(name: 'Luke', movie: movies.first)

data/fixtures/rails5_api/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-agent: *
+# Disallow: /

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

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

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

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

data/fixtures/rails5_api/test/test_helper.rb

@@ -0,0 +1,39 @@
+# Load Silence Functionality
+require File.expand_path(File.dirname(__FILE__) + "/../../../test/silence.rb")
+
+# Load Environment
+silence_warnings do
+  ENV["RAILS_ENV"] = "test"
+  require File.expand_path('../../config/environment', __FILE__)
+  require 'rails/test_help'
+end
+
+# Load Riot Test Environment
+require File.expand_path(File.dirname(__FILE__) + "/../../../test/integration/test_init.rb")
+
+# silence_stream was removed for Rails 5 because it's not thread-safe.
+# Duplicate that work here:
+# See https://github.com/rails/rails/pull/13392
+def silence_stream(stream)
+  old_stream = stream.dup
+  stream.reopen(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ ? 'NUL:' : '/dev/null')
+  stream.sync = true
+  yield
+ensure
+  stream.reopen(old_stream)
+  old_stream.close
+end
+
+# Run Migrations
+silence_stream(STDOUT) do
+  dbconf = YAML::load(File.open('config/database.yml'))[Rails.env]
+  ActiveRecord::Base.establish_connection(dbconf)
+  ActiveRecord::Base.logger = Logger.new(File.open('log/database.log', 'a'))
+  silence_stream(STDOUT) { ActiveRecord::Migrator.up('db/migrate') }
+end
+
+class Riot::Situation
+  def app
+    Rails.application
+  end
+end

data/lib/rabl.rb

@@ -83,6 +83,6 @@ end
 if defined?(Padrino)
   require 'padrino-core'
   Padrino.after_load { Rabl.register! }
-elsif defined?(Rails) && Rails.version =~ /^2/
+elsif defined?(Rails.version) && Rails.version =~ /^2/
   Rabl.register!
 end

data/lib/rabl/builder.rb

@@ -1,3 +1,5 @@
+require 'active_support/inflector' # for the sake of camelcasing keys
+
 module Rabl
   class Builder
     include Helpers
@@ -138,7 +140,7 @@ module Rabl
         return unless @_object && attribute_present?(name) && resolve_condition(options)
 
         attribute = data_object_attribute(name)
-        name = (options[:as] || name).to_sym
+        name = create_key(options[:as] || name)
         @_result[name] = attribute
       end
       alias_method :attributes, :attribute
@@ -151,7 +153,7 @@ module Rabl
 
         result = block.call(@_object)
         if name.present?
-          @_result[name.to_sym] = result
+          @_result[create_key(name)] = result
         elsif result.is_a?(Hash) # merge hash into root hash
           @_result.merge!(result)
         end
@@ -174,7 +176,7 @@ module Rabl
 
         object = { object => name } if data.is_a?(Hash) && object # child :users => :people
 
-        engines << { name.to_sym => object_to_engine(object, engine_options, &block) }
+        engines << { create_key(name) => object_to_engine(object, engine_options, &block) }
       end
 
       # Glues data from a child node to the json_output
@@ -248,5 +250,13 @@ module Rabl
           yield
         end
       end
+
+      def create_key(name)
+        if Rabl.configuration.camelize_keys
+          name.to_s.camelize(Rabl.configuration.camelize_keys == :upper ? :upper : :lower).to_sym
+        else
+          name.to_sym
+        end
+      end
   end
 end

data/lib/rabl/configuration.rb

@@ -52,6 +52,7 @@ module Rabl
     attr_accessor :replace_empty_string_values_with_nil_values
     attr_accessor :exclude_nil_values
     attr_accessor :exclude_empty_values_in_collections
+    attr_accessor :camelize_keys
 
     DEFAULT_XML_OPTIONS = { :dasherize  => true, :skip_types => false }
 
@@ -81,6 +82,7 @@ module Rabl
       @replace_empty_string_values_with_nil_values  = false
       @exclude_nil_values                           = false
       @exclude_empty_values_in_collections          = false
+      @camelize_keys                                = false
     end
 
     # @return The JSON engine used to encode Rabl templates into JSON

data/lib/rabl/engine.rb

@@ -27,6 +27,8 @@ module Rabl
     # Renders the representation based on source, object, context_scope and locals
     # Rabl::Engine.new("...source...", { :format => "xml" }).apply(context_scope, { :foo => "bar", :object => @user })
     def apply(context_scope, locals, &block)
+      locals = locals.dup unless locals.nil?
+
       set_instance_variables!(context_scope, locals)
 
       reset_settings!

data/lib/rabl/railtie.rb

@@ -1,6 +1,23 @@
 module Rabl
   class Railtie < Rails::Railtie
     initializer "rabl.initialize" do |app|
+      # Force Rails to load view templates even in API mode
+      # Stolen shamelessly from jbuilder: https://github.com/rails/jbuilder/blob/master/lib/jbuilder/railtie.rb
+      if Rails::VERSION::MAJOR >= 5
+        module ::ActionController
+          module ApiRendering
+            include ActionView::Rendering
+          end
+        end
+
+        ActiveSupport.on_load :action_controller do
+          if self == ActionController::API
+            include ActionController::Helpers
+            include ActionController::ImplicitRender
+          end
+        end
+      end
+
       ActiveSupport.on_load(:action_view) do
         Rabl.register!