rabl 0.14.1 → 0.14.2

data/fixtures/sinatra_test/db/migrate

@@ -1 +1 @@
-fixtures/sinatra_test/db/../../ashared/migrate
+../../ashared/migrate

data/fixtures/sinatra_test/models

@@ -1 +1 @@
-fixtures/sinatra_test/../ashared/models
+../ashared/models

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

@@ -1 +1 @@
-fixtures/sinatra_test/test/functional/../../../../test/integration/posts_controller_test.rb
+../../../../test/integration/posts_controller_test.rb

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

@@ -1 +1 @@
-fixtures/sinatra_test/test/functional/../../../../test/integration/users_controller_test.rb
+../../../../test/integration/users_controller_test.rb

data/fixtures/sinatra_test/views

@@ -1 +1 @@
-fixtures/sinatra_test/../ashared/views/
+../ashared/views/

data/lib/rabl.rb

@@ -17,9 +17,9 @@ require 'rabl/renderer'
 require 'rabl/cache_engine'
 
 if defined?(Rails) && Rails.respond_to?(:version)
-  require 'rabl/tracker'  if Rails.version =~ /^[45]/
-  require 'rabl/digestor' if Rails.version =~ /^[45]/
-  require 'rabl/railtie'  if Rails.version =~ /^[345]/
+  require 'rabl/tracker'  if Rails.version =~ /^[456]/
+  require 'rabl/digestor' if Rails.version =~ /^[456]/
+  require 'rabl/railtie'  if Rails.version =~ /^[3456]/
 end
 
 # Rabl.register!

data/lib/rabl/engine.rb

@@ -61,7 +61,9 @@ module Rabl
           template = @_options[:template] || @virtual_path
 
           digest =
-            if Gem::Version.new(Rails.version) >= Gem::Version.new('4.1')
+            if Rails.version.to_s =~ /^[6]/
+              Digestor.digest(name: template, finder: lookup_context, format: :rabl)
+            elsif Gem::Version.new(Rails.version) >= Gem::Version.new('4.1')
               Digestor.digest(:name => template, :finder => lookup_context)
             else
               Digestor.digest(template, :rabl, lookup_context)
@@ -390,7 +392,7 @@ module Rabl
       end
 
       def digestor_available?
-        defined?(Rails) && Rails.version =~ /^[45]/
+        defined?(Rails) && Rails.version =~ /^[456]/
       end
 
       def set_instance_variables!(context_scope, locals)

data/lib/rabl/railtie.rb

@@ -22,7 +22,7 @@ module Rabl
         Rabl.register!
 
         # Inject dependency tracker for :rabl
-        if Rails.version =~ /^[45]/
+        if Rails.version =~ /^[456]/
           require 'action_view/dependency_tracker'
           ActionView::DependencyTracker.register_tracker :rabl, Rabl::Tracker
         end

data/lib/rabl/template.rb

@@ -40,7 +40,7 @@ if defined?(ActionView) && defined?(Rails) && Rails.respond_to?(:version) && Rai
   ActionView::Template.register_template_handler :rabl, ActionView::TemplateHandlers::RablHandler
 end
 
-# Rails 3.X / 4.X Template
+# Rails 3.X / 4.X / 5.X Template
 if defined?(ActionView) && defined?(Rails) && Rails.respond_to?(:version) && Rails.version.to_s =~ /^[345]/
   module ActionView
     module Template::Handlers
@@ -61,3 +61,23 @@ if defined?(ActionView) && defined?(Rails) && Rails.respond_to?(:version) && Rai
 
   ActionView::Template.register_template_handler :rabl, ActionView::Template::Handlers::Rabl
 end
+
+# Rails 6.X Template
+if defined?(ActionView) && defined?(Rails) && Rails.respond_to?(:version) && Rails.version.to_s =~ /^[6]/
+  module ActionView
+    module Template::Handlers
+      class Rabl
+        class_attribute :default_format
+        self.default_format = :json
+
+        def self.call(template, source)
+          %{ ::Rabl::Engine.new(#{source.inspect}).
+              apply(self, assigns.merge(local_assigns)).
+              render }
+        end # call
+      end # rabl class
+    end # handlers
+  end
+
+  ActionView::Template.register_template_handler :rabl, ActionView::Template::Handlers::Rabl
+end

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.14.1"
+  VERSION = "0.14.2"
 end

data/rabl.gemspec

@@ -13,8 +13,6 @@ Gem::Specification.new do |s|
   s.description = %q{General ruby templating with json, bson, xml and msgpack support}
   s.license     = 'MIT'
 
-  s.rubyforge_project = "rabl"
-
   s.files         = `git ls-files`.split("\n")
   s.require_paths = ["lib"]
 

data/test/integration/rails6/posts_controller_test.rb

@@ -0,0 +1,185 @@
+# Lives in <rabl>/test/integration/posts_controller_test.rb
+# Symlinked to fixture applications
+
+begin # Padrino
+  require File.expand_path(File.dirname(__FILE__) + '/../../test_config.rb')
+rescue LoadError # Rails
+  require File.expand_path(File.dirname(__FILE__) + '/../test_helper.rb')
+end
+
+require 'rexml/document'
+
+context "PostsController" do
+  helper(:json_output) { JSON.parse(last_response.body) }
+
+  setup do
+    create_users!
+    Post.delete_all
+    @post1 = Post.create(:title => "Foo", :body => "Bar", :user_id => @user1.id)
+    @post2 = Post.create(:title => "Baz", :body => "Bah", :user_id => @user2.id)
+    @post3 = Post.create(:title => "Kaz", :body => "<script>alert('xss & test');</script>", :user_id => @user3.id)
+    @posts = [@post1, @post2, @post3]
+  end
+
+  context "for index action" do
+    setup do
+      get "/posts", format: :json
+    end
+
+    # Attributes (regular)
+    asserts("contains post titles") do
+      json_output['articles'].map { |o| o["article"]["title"] }
+    end.equals { @posts.map(&:title) }
+
+    asserts("contains post bodies") do
+      json_output['articles'].map { |o| o["article"]["body"] }
+    end.equals { @posts.map(&:body) }
+
+    # Attributes (custom name)
+    asserts("contains post posted_at") do
+      json_output['articles'].map { |o| o["article"]["posted_at"] }
+    end.equals { @posts.map(&:created_at).map{ |t| t.strftime("%Y-%m-%d %H:%M:%S %Z") } }
+
+    # Child
+    asserts("contains post user child username") do
+      json_output['articles'].map { |o| o["article"]["user"]["username"] }
+    end.equals { @posts.map(&:user).map(&:username) }
+
+    asserts("contains post user child role") do
+      json_output['articles'].map { |o| o["article"]["user"]["role"] }
+    end.equals { ["normal", "normal", "admin"] }
+
+    # Child Numbers of the Child User
+    asserts("contains post user child numbers") do
+      json_output['articles'].map { |o| o["article"]["user"]["pnumbers"][0]["pnumber"]["formatted"] }
+    end.equals { @posts.map(&:user).map(&:phone_numbers).map(&:first).map(&:formatted) }
+
+    # Glue (username to article)
+    asserts("contains glued usernames") do
+      json_output['articles'].map { |o| o["article"]["author_name"] }
+    end.equals { @posts.map(&:user).map(&:username) }
+
+    # Conditional Child (admin)
+    asserts("contains admin child only for admins") do
+      json_output['articles'].map { |o| o["article"]["admin"]["username"] if o["article"].has_key?("admin") }.compact
+    end.equals { [@user3.username] }
+
+    # Conditional Node (created_by_admin)
+    asserts("contains created_by_admin node for admins") do
+      json_output['articles'].last['article']['created_by_admin']
+    end.equals { true }
+
+    denies("contains no created_by_admin node for non-admins") do
+      json_output['articles'].first['article']
+    end.includes(:created_by_admin)
+  end # index action, json
+
+  context "escaping output in index action" do
+    context "for first post" do
+      setup do
+        Rabl.configuration.escape_all_output = true
+        get "/posts/#{@post1.id}", format: :json
+        json_output['post']
+      end
+
+      # Attributes (regular)
+      asserts("contains post title") { topic['title'] }.equals { @post1.title }
+      asserts("contains post body")  { topic['body'] }.equals { @post1.body }
+    end
+
+    context "for third post with script tags" do
+      setup do
+        Rabl.configuration.escape_all_output = true
+        get "/posts/#{@post3.id}", format: :json
+        json_output['post']
+      end
+
+      # Attributes (regular)
+      asserts("contains post title") { topic['title'] }.equals { @post3.title }
+      asserts("contains escaped post body")  { topic['body'] }.equals { ERB::Util.h(@post3.body) }
+    end
+  end # escaping output
+
+  context "for show action" do
+    setup do
+      get "/posts/#{@post1.id}", format: :json
+      json_output['post']
+    end
+
+    # Attributes (regular)
+    asserts("contains post title") { topic['title'] }.equals { @post1.title }
+    asserts("contains post body")  { topic['body'] }.equals { @post1.body }
+
+    # Attributes (custom name)
+    asserts("contains post posted_at") { topic['posted_at'] }.equals { @post1.created_at.strftime("%Y-%m-%d %H:%M:%S %Z") }
+
+    # Child
+    asserts("contains post user child username") { topic["user"]["username"] }.equals { @post1.user.username }
+    asserts("contains post user child role") { topic["user"]["role"] }.equals { "normal" }
+
+    # Child Numbers of the Child User
+    asserts("contains post user child numbers") do
+      topic["user"]["pnumbers"][0]["pnumber"]["formatted"]
+    end.equals { @post1.user.phone_numbers[0].formatted }
+
+    # Glue (username to article)
+    asserts("contains glued username") { topic["author_name"] }.equals { @post1.user.username }
+
+    # Non-ORM Date Node Partial
+    context "for date node" do
+      setup { json_output['post']['created_date'] }
+      asserts("contains date partial with day")   { topic['day'] }.equals { @post1.created_at.day }
+      asserts("contains date partial with hour")  { topic['hour'] }.equals { @post1.created_at.hour }
+      asserts("contains date partial with full")  { topic['full'] }.equals { @post1.created_at.iso8601 }
+    end # date node
+
+    asserts("contains helper action") { topic["foo"] }.equals { "BAR!" }
+    denies("contains helper action") { topic["created_at_in_words"] }.nil
+
+    asserts("contains post attributes via node") { topic["post"] }.equals { [@post1.title, @post1.body] }
+  end # show action, json
+
+  context "renderer" do
+    setup do
+      mock(ActionController::Base).perform_caching.any_number_of_times { true }
+      get "/posts/#{@post1.id}/renderer"
+      json_output['post']
+    end
+
+    # Attributes (regular)
+    asserts("contains post title") { topic['title'] }.equals { @post1.title }
+    asserts("contains post body")  { topic['body'] }.equals { @post1.body }
+
+    # Attributes (partial)
+    asserts("contains post partial title") { topic['partial']['title'] }.equals { @post1.title }
+    asserts("contains post partial body")  { topic['partial']['body'] }.equals { @post1.body }
+  end # renderer action, json
+
+  # HTML isn't supported in API mode
+  unless Rails.application.config.api_only
+    context "for index action rendering JSON within HTML" do
+      setup do
+        get "/posts", format: :html
+      end
+
+      asserts(:body).includes { "<html>" }
+    end # index action, html
+
+    context "for show action rendering JSON within HTML" do
+      setup do
+        get "/posts/#{@post1.id}", format: :html
+      end
+
+      asserts(:body).includes { "<html>" }
+    end # show action, html
+  end
+
+  context "mime_type" do
+    setup do
+      get "/posts/#{@post1.id}", format: :rabl_test_v1
+    end
+
+    asserts("contains post title") { json_output['post']['title_v1'] }.equals { @post1.title }
+    asserts("contains username") { json_output['post']['user']['username_v1'] }.equals { @post1.user.username }
+  end
+end

data/test/integration/rails6/users_controller_test.rb

@@ -0,0 +1,87 @@
+# Lives in <rabl>/test/integration/users_controller_test.rb
+# Symlinked to fixture applications
+
+begin # Sinatra
+  require File.expand_path(File.dirname(__FILE__) + '/../../test_config.rb')
+rescue LoadError # Rails
+  require File.expand_path(File.dirname(__FILE__) + '/../test_helper.rb')
+end
+
+context "UsersController" do
+  helper(:json_output) { JSON.parse(last_response.body) }
+
+  setup do
+    create_users!
+  end
+
+  context "for index action" do
+    # Tests `collection @users` extending from 'show' template
+
+    setup do
+      get "/users", format: :json
+    end
+
+    # Attributes (regular)
+    asserts("contains user usernames") do
+      json_output.map { |u| u["user"]["username"] }
+    end.equals { @users.map(&:username) }
+    asserts("contains email") do
+      json_output.map { |u| u["user"]["email"] }
+    end.equals { @users.map(&:email) }
+    asserts("contains location") do
+      json_output.map { |u| u["user"]["location"] }
+    end.equals { @users.map(&:location) }
+
+    # Attributes (custom name)
+    asserts("contains registered_at") do
+      json_output.map { |u| u["user"]["registered_at"] }
+    end.equals { @users.map(&:created_at).map { |t| t.strftime("%Y-%m-%d %H:%M:%S %Z") } }
+
+    # Node (renders based on attribute)
+    asserts("contains role") do
+      json_output.map { |u| u["user"]["role"] }
+    end.equals ['normal', 'normal', 'admin']
+
+    # Child (custom collection name)
+    asserts("contains formatted phone numbers") do
+      json_output.map { |u| u["user"]["pnumbers"].map { |n| n["pnumber"]["formatted"] } }
+    end.equals { @users.map { |u| u.phone_numbers.map(&:formatted) } }
+
+    # Node (renders collection partial)
+    asserts("contains reversed node numbers") do
+      json_output.map { |u| u["user"]["node_numbers"].map { |n| n["reversed"] } }
+    end.equals { @users.map { |u| u.phone_numbers.map(&:formatted).map(&:reverse) } }
+  end # index
+
+  context "for show action" do
+    # Tests `object :user => :person` custom parent node name
+    setup do
+      get "/users/#{@user1.id}", format: :json
+    end
+
+    # Attributes (regular)
+    asserts("contains username") { json_output["person"]["username"] }.equals { @user1.username }
+    asserts("contains email") { json_output["person"]["email"] }.equals { @user1.email }
+    asserts("contains location") { json_output["person"]["location"] }.equals { @user1.location }
+    # Attributes (custom name)
+    asserts("contains registered_at") { json_output["person"]["registered_at"] }.equals { @user1.created_at.strftime("%Y-%m-%d %H:%M:%S %Z") }
+    # Node (renders based on attribute)
+    asserts("contains role node") { json_output["person"]["role"] }.equals "normal"
+
+    # Child (custom collection name)
+    asserts("contains first phone number") {
+      json_output["person"]["pnumbers"][0]["pnumber"]["formatted"]
+    }.equals { @user1.phone_numbers[0].formatted }
+    asserts("contains second phone number") {
+      json_output["person"]["pnumbers"][1]["pnumber"]["formatted"]
+    }.equals { @user1.phone_numbers[1].formatted }
+
+    # Node (renders collection partial)
+    asserts("contains first node number") {
+      json_output["person"]["node_numbers"][0]["formatted"]
+    }.equals { @user1.phone_numbers[0].formatted }
+    asserts("contains second node number") {
+      json_output["person"]["node_numbers"][1]["formatted"]
+    }.equals { @user1.phone_numbers[1].formatted }
+  end # show
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rabl
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.14.2
 platform: ruby
 authors:
 - Nathan Esquenazi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-28 00:00:00.000000000 Z
+date: 2019-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -188,6 +188,21 @@ files:
 - fixtures/ashared/views_rails_3/users/phone_number.xml.rabl
 - fixtures/ashared/views_rails_3/users/show.json.rabl
 - fixtures/ashared/views_rails_3/users/show.rabl_test_v1.rabl
+- fixtures/ashared/views_rails_6/layouts/application.html.erb
+- fixtures/ashared/views_rails_6/posts/_show_footer_script.js.erb
+- fixtures/ashared/views_rails_6/posts/date.rabl
+- fixtures/ashared/views_rails_6/posts/index.html.erb
+- fixtures/ashared/views_rails_6/posts/index.rabl
+- fixtures/ashared/views_rails_6/posts/renderer.rabl
+- fixtures/ashared/views_rails_6/posts/renderer_partial.rabl
+- fixtures/ashared/views_rails_6/posts/show.html.erb
+- fixtures/ashared/views_rails_6/posts/show.rabl
+- fixtures/ashared/views_rails_6/posts/show.rabl_test_v1.rabl
+- fixtures/ashared/views_rails_6/users/index.json.rabl
+- fixtures/ashared/views_rails_6/users/phone_number.json.rabl
+- fixtures/ashared/views_rails_6/users/phone_number.xml.rabl
+- fixtures/ashared/views_rails_6/users/show.json.rabl
+- fixtures/ashared/views_rails_6/users/show.rabl_test_v1.rabl
 - fixtures/padrino_test/.components
 - fixtures/padrino_test/.gitignore
 - fixtures/padrino_test/Gemfile
@@ -556,6 +571,99 @@ files:
 - fixtures/rails5_api/test/models/.keep
 - fixtures/rails5_api/test/test_helper.rb
 - fixtures/rails5_api/tmp/.keep
+- fixtures/rails6/.gitignore
+- fixtures/rails6/Gemfile
+- fixtures/rails6/README.md
+- fixtures/rails6/Rakefile
+- fixtures/rails6/app/assets/config/manifest.js
+- fixtures/rails6/app/assets/images/.keep
+- fixtures/rails6/app/assets/stylesheets/application.css
+- fixtures/rails6/app/channels/application_cable/channel.rb
+- fixtures/rails6/app/channels/application_cable/connection.rb
+- fixtures/rails6/app/controllers/application_controller.rb
+- fixtures/rails6/app/controllers/concerns/.keep
+- fixtures/rails6/app/controllers/posts_controller.rb
+- fixtures/rails6/app/controllers/users_controller.rb
+- fixtures/rails6/app/helpers
+- fixtures/rails6/app/javascript/channels/consumer.js
+- fixtures/rails6/app/javascript/channels/index.js
+- fixtures/rails6/app/javascript/packs/application.js
+- fixtures/rails6/app/jobs/application_job.rb
+- fixtures/rails6/app/mailers/application_mailer.rb
+- fixtures/rails6/app/models
+- fixtures/rails6/app/views
+- fixtures/rails6/babel.config.js
+- fixtures/rails6/bin/bundle
+- fixtures/rails6/bin/rails
+- fixtures/rails6/bin/rake
+- fixtures/rails6/bin/setup
+- fixtures/rails6/bin/spring
+- fixtures/rails6/bin/webpack
+- fixtures/rails6/bin/webpack-dev-server
+- fixtures/rails6/bin/yarn
+- fixtures/rails6/config.ru
+- fixtures/rails6/config/application.rb
+- fixtures/rails6/config/boot.rb
+- fixtures/rails6/config/cable.yml
+- fixtures/rails6/config/credentials.yml.enc
+- fixtures/rails6/config/database.yml
+- fixtures/rails6/config/environment.rb
+- fixtures/rails6/config/environments/development.rb
+- fixtures/rails6/config/environments/production.rb
+- fixtures/rails6/config/environments/test.rb
+- fixtures/rails6/config/initializers/application_controller_renderer.rb
+- fixtures/rails6/config/initializers/assets.rb
+- fixtures/rails6/config/initializers/backtrace_silencers.rb
+- fixtures/rails6/config/initializers/content_security_policy.rb
+- fixtures/rails6/config/initializers/cookies_serializer.rb
+- fixtures/rails6/config/initializers/filter_parameter_logging.rb
+- fixtures/rails6/config/initializers/inflections.rb
+- fixtures/rails6/config/initializers/mime_types.rb
+- fixtures/rails6/config/initializers/wrap_parameters.rb
+- fixtures/rails6/config/locales/en.yml
+- fixtures/rails6/config/puma.rb
+- fixtures/rails6/config/routes.rb
+- fixtures/rails6/config/spring.rb
+- fixtures/rails6/config/storage.yml
+- fixtures/rails6/config/webpack/development.js
+- fixtures/rails6/config/webpack/environment.js
+- fixtures/rails6/config/webpack/production.js
+- fixtures/rails6/config/webpack/test.js
+- fixtures/rails6/config/webpacker.yml
+- fixtures/rails6/db/migrate/20111002092016_create_users.rb
+- fixtures/rails6/db/migrate/20111002092019_create_posts.rb
+- fixtures/rails6/db/migrate/20111002092024_create_phone_numbers.rb
+- fixtures/rails6/db/schema.rb
+- fixtures/rails6/db/seeds.rb
+- fixtures/rails6/lib/assets/.keep
+- fixtures/rails6/lib/tasks/.keep
+- fixtures/rails6/log/.keep
+- fixtures/rails6/package.json
+- fixtures/rails6/postcss.config.js
+- fixtures/rails6/public/404.html
+- fixtures/rails6/public/422.html
+- fixtures/rails6/public/500.html
+- fixtures/rails6/public/apple-touch-icon-precomposed.png
+- fixtures/rails6/public/apple-touch-icon.png
+- fixtures/rails6/public/favicon.ico
+- fixtures/rails6/public/robots.txt
+- fixtures/rails6/storage/.keep
+- fixtures/rails6/test/application_system_test_case.rb
+- fixtures/rails6/test/channels/application_cable/connection_test.rb
+- fixtures/rails6/test/controllers/.keep
+- fixtures/rails6/test/fixtures/.keep
+- fixtures/rails6/test/fixtures/files/.keep
+- fixtures/rails6/test/functional/posts_controller_test.rb
+- fixtures/rails6/test/functional/users_controller_test.rb
+- fixtures/rails6/test/helpers/.keep
+- fixtures/rails6/test/integration/.keep
+- fixtures/rails6/test/mailers/.keep
+- fixtures/rails6/test/models/.keep
+- fixtures/rails6/test/system/.keep
+- fixtures/rails6/test/test_helper.rb
+- fixtures/rails6/tmp/.keep
+- fixtures/rails6/vendor/.keep
+- fixtures/rails6/yarn.lock
 - fixtures/sinatra_test/Gemfile
 - fixtures/sinatra_test/Rakefile
 - fixtures/sinatra_test/app.rb
@@ -598,6 +706,8 @@ files:
 - test/integration/rails4/users_controller_test.rb
 - test/integration/rails5/posts_controller_test.rb
 - test/integration/rails5/users_controller_test.rb
+- test/integration/rails6/posts_controller_test.rb
+- test/integration/rails6/users_controller_test.rb
 - test/integration/test_init.rb
 - test/integration/users_controller_test.rb
 - test/models/ormless.rb
@@ -630,8 +740,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: rabl
-rubygems_version: 2.6.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: General ruby templating with json, bson, xml and msgpack support