rabl-rails 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfd78996e96f1bf4dc99f2ffe80c69b57e1d7c72
-  data.tar.gz: e7c0c4bcf0d10beba1a814962ac15fd5c55434e7
+  metadata.gz: de487a654a879918209db30bfb6d384b26e8bc0e
+  data.tar.gz: 54e73001a009a25491238d246da5e0a09b79d66f
 SHA512:
-  metadata.gz: b75c2a1b05cd16037797aa5a2eedb63041be6e0670cef0e0658cadd709e514e96d718d52f6d4e7b616873e91e280439eb08f7a09c4409eebc65ebe5c95f8a704
-  data.tar.gz: 87a2345a2b7b02dda10ceadfedbe6e231f3af9fd365fd4ab4d35019184ce7318420d5c92cb02b0013b2a591d0f6765c24cc75b50ea5cf4258d161665fd28bd76
+  metadata.gz: 21fdf8c8e8f80b1d6807dc0f082e3db64b29c24329010c63f4979245bbe10752c8122f527728311113befde3f766a2e981639473d879d7888d584e53dc70a24c
+  data.tar.gz: 26511a368b88f055e7c9f8a63253239be920714f1d19740ac82cc060899f5aa8686fbf51062be76c1c8819d8ac7139350809a76f5c2e09b83718c7e8ba37220a

data/.travis.yml

@@ -1,14 +1,21 @@
 language: ruby
+cache: bundler
+dist: trusty
 env:
-  - "RAILS_VERSION=3.2.0"
-  - "RAILS_VERSION=4.0.0"
-  - "RAILS_VERSION=4.1.0"
-  - "RAILS_VERSION=4.2.0"
+  - "RAILS_VERSION=4.2.6"
+  - "RAILS_VERSION=master"
 rvm:
-  - 1.9.3
-  - jruby-19mode
-  - rbx-2
-  - 2.0.0
-  - 2.1.8
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+  - jruby-9.1.12.0
+  - rbx-3.71
 before_install:
   - gem update bundler
+matrix:
+  fast_finish: true
+  allow_failures:
+    - env: RAILS_VERSION=master
+  exclude:
+    - rvm: 2.1.8
+      env: "RAILS_VERSION=master"

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 0.5.0
+  * Add requirement ruby >= 2.2
+  * Drop support for Rails < 4.2
+  * Replace `thread_safe` with `concurrent_ruby`
+  * Remove custom responder
+  * Remove rendering outside of Rails
+  * Improve Rails 5 compatibility
+
 ## 0.4.3
   * Fix custom responder compatibility with responders 2.1 (itkin)
   * Fix bug when template was already loaded by ActionView and causing a nil

data/Gemfile

@@ -8,33 +8,25 @@ rails = case rails_version
 when 'master'
   { github: 'rails/rails' }
 when "default"
-  '~> 4.2.0'
+  '~> 4.2.5'
 else
   "~> #{rails_version}"
 end
 
-minitest_version = rails_version == '4.0.0' ? '~> 4.7' : '~> 5.4'
-
 gem 'activesupport', rails
 gem 'railties', rails
 
 group :test do
-  gem 'minitest', minitest_version
+  gem 'minitest', '~> 5.8'
   gem 'actionpack', rails
-
-  if rails_version > '4.0.0'
-    gem 'actionview', rails
-  end
+  gem 'actionview', rails
 end
 
 gem 'plist'
 
-platforms :ruby do
-  gem 'oj'
-end
-
 platforms :mri do
   gem 'libxml-ruby'
+  gem 'oj'
 end
 
 platforms :jruby do

data/README.md

@@ -4,7 +4,7 @@ RABL (Ruby API Builder Language) is a ruby templating system for rendering resou
 
 rabl-rails is **faster** and uses **less memory** than the standard rabl gem while letting you access the same features. There are some slight changes to do on your templates to get this gem to work but it should't take you more than 5 minutes.
 
-rabl-rails only targets **Rails 3.2+ application** and is compatible with mri 1.9.3+, jRuby and rubinius.
+rabl-rails only targets **Rails 4.2+ application** and is compatible with mri 2.2+, jRuby and rubinius.
 
 ## Installation
 
@@ -93,8 +93,6 @@ RablRails.configure do |config|
   # config.include_json_root = true
   # config.json_engine = ::Oj
   # config.xml_options = { :dasherize => true, :skip_types => false }
-  # config.use_custom_responder = false
-  # config.default_responder_template = 'show'
   # config.enable_jsonp_callbacks = false
   # config.replace_nil_values_with_empty_strings = false
   # config.replace_empty_string_values_with_nil = false
@@ -296,28 +294,17 @@ child :posts do
 end
 ```
 
-### Render object directly
-
-There are cases when you want to render object outside Rails view context. For instance to render objects in the console or to create message queue payloads. For these situations, you can use `RablRails.render` as show below:
-
-```ruby
-RablRails.render(object, template, :view_path => 'app/views', :format => :json) #=> "{...}"
-```
-
-You can find more informations about how to use this method in the [wiki](http://github.com/ccocchi/rabl-rails/wiki/Render-object-directly)
-
 ### Other features
 
 * [Caching](https://github.com/ccocchi/rabl-rails/wiki/Caching)
-* [Custom responder](https://github.com/ccocchi/rabl-rails/wiki/Using-custom-responder)
 
 And more in the [WIKI](https://github.com/ccocchi/rabl-rails/wiki)
 
 ## Performance
 
-Benchmarks have been made using this [application](http://github.com/ccocchi/rabl-benchmark), with rabl 0.7.6 and rabl-rails 0.3.0
+Benchmarks have been made using this [application](http://github.com/ccocchi/rabl-benchmark), with rabl 0.13.1 and rabl-rails 0.5.0
 
-Overall, Rabl-rails is **20% faster and use 10% less memory**, even **twice faster** when using extends.
+Overall, rabl-rails is **10% faster and use 10% less memory**, but these numbers skyrockets to **50%** when using `extends` with collection of objects.
 
 You can see full tests on test application repository.
 
@@ -330,9 +317,8 @@ Want to make another change ? Just fork and contribute, any help is very much ap
 
 ## Original idea
 
-* [RABL](http://github.com/nesquena/rabl) Standart RABL gem. I used it a lot but I needed to improve my API response time, and
-  since most of the time was spent in view rendering, I decided to implement a faster rabl gem.
+* [RABL](http://github.com/nesquena/rabl) Standart RABL gem. I used it a lot but I needed to improve my API response time, and since most of the time was spent in view rendering, I decided to implement a faster rabl gem.
 
 ## Copyright
 
-Copyright © 2011-2012 Christopher Cocchi-Perrier. See [MIT-LICENSE](http://github.com/ccocchi/rabl-rails/blob/master/MIT-LICENSE) for details.
+Copyright © 2012-2017 Christopher Cocchi-Perrier. See [MIT-LICENSE](http://github.com/ccocchi/rabl-rails/blob/master/MIT-LICENSE) for details.

data/lib/rabl-rails.rb

@@ -1,19 +1,25 @@
-require 'rails/railtie'
-
 require 'active_support'
 
 require 'rabl-rails/version'
 require 'rabl-rails/helpers'
+require 'rabl-rails/exceptions'
 require 'rabl-rails/template'
 require 'rabl-rails/nodes'
 require 'rabl-rails/compiler'
 
 require 'rabl-rails/visitors'
-require 'rabl-rails/renderer'
+require 'rabl-rails/renderers/hash'
+require 'rabl-rails/renderers/json'
+require 'rabl-rails/renderers/xml'
+require 'rabl-rails/renderers/plist'
 require 'rabl-rails/library'
 
 require 'rabl-rails/handler'
-require 'rabl-rails/railtie'
+
+if defined?(Rails)
+  require 'rails/railtie'
+  require 'rabl-rails/railtie'
+end
 
 require 'rabl-rails/configuration'
 
@@ -25,8 +31,6 @@ rescue LoadError
 end
 
 module RablRails
-  extend Renderer
-
   class << self
     def configure
       yield configuration

data/lib/rabl-rails/compiler.rb

@@ -68,16 +68,9 @@ module RablRails
     #   child(:posts, :partial => 'posts/base')
     #
     def child(name_or_data, options = {})
-      data, name = extract_data_and_name(name_or_data)
-      name = options[:root] if options.has_key? :root
-
-      if options.key?(:partial)
-        template = Library.instance.compile_template_from_path(options[:partial], @view)
-        template.data = data
-      elsif block_given?
-        template = sub_compile(data) { yield }
-      end
-
+      data, name  = extract_data_and_name(name_or_data)
+      name        = options[:root] if options.has_key? :root
+      template    = partial_or_block(data, options) { yield }
       @template.add_node Nodes::Child.new(name, template)
     end
 
@@ -86,10 +79,8 @@ module RablRails
     # Example:
     #   glue(:@user) { attribute :name }
     #
-    def glue(data)
-      return unless block_given?
-
-      template = sub_compile(data) { yield }
+    def glue(data, options = {})
+      template = partial_or_block(data, options) { yield }
       @template.add_node Nodes::Glue.new(template)
     end
 
@@ -113,18 +104,25 @@ module RablRails
     # Example:
     #   merge { |item| partial("specific/#{item.to_s}", object: item) }
     #
-    def merge
+    def merge(opts = {})
       return unless block_given?
-      node(nil) { yield }
+      node(nil, opts) { yield }
     end
 
     #
     # Extends an existing rabl template
     # Example:
     #   extends 'users/base'
+    #   extends 'posts/base', locals: { hide_comments: true }
     #
-    def extends(path)
-      @template.extends Library.instance.compile_template_from_path(path, @view)
+    def extends(path, options = nil)
+      other = Library.instance.compile_template_from_path(path, @view)
+
+      if options && options.is_a?(Hash)
+        @template.add_node Nodes::Extend.new(other.nodes, options[:locals])
+      else
+        @template.extends(other)
+      end
     end
 
     #
@@ -138,6 +136,7 @@ module RablRails
       return unless block_given?
       @template.add_node Nodes::Condition.new(proc, sub_compile(nil, true) { yield })
     end
+    alias_method :_if, :condition
 
     def cache(&block)
       @template.cache_key = block_given? ? block : nil
@@ -145,6 +144,16 @@ module RablRails
 
     protected
 
+    def partial_or_block(data, options)
+      if options.key?(:partial)
+        template = Library.instance.compile_template_from_path(options[:partial], @view)
+        template.data = data
+        template
+      elsif block_given?
+        sub_compile(data) { yield }
+      end
+    end
+
     #
     # Extract data root_name and root name
     # Example:

data/lib/rabl-rails/configuration.rb

@@ -6,8 +6,6 @@ module RablRails
     attr_accessor :xml_options
     attr_accessor :plist_engine, :include_plist_root
     attr_accessor :cache_templates
-    attr_reader   :use_custom_responder
-    attr_accessor :responder_default_template
     attr_accessor :replace_nil_values_with_empty_strings
     attr_accessor :replace_empty_string_values_with_nil
     attr_accessor :exclude_nil_values
@@ -25,9 +23,6 @@ module RablRails
 
       @cache_templates    = ActionController::Base.perform_caching
 
-      @use_custom_responder       = false
-      @responder_default_template = 'show'
-
       @replace_nil_values_with_empty_strings  = false
       @replace_empty_string_values_with_nil   = false
       @exclude_nil_values                     = false
@@ -35,11 +30,6 @@ module RablRails
       @non_collection_classes = Set.new(['Struct'])
     end
 
-    def use_custom_responder=(value)
-      @use_custom_responder = value
-      require 'rabl-rails/responder' if value
-    end
-
     def result_flags
       @result_flags ||= begin
         result = 0

data/lib/rabl-rails/exceptions.rb

@@ -0,0 +1,3 @@
+module RablRails
+  class PartialError < StandardError; end
+end

data/lib/rabl-rails/library.rb

@@ -1,6 +1,5 @@
 require 'singleton'
-require 'monitor'
-require 'thread_safe'
+require 'concurrent/map'
 
 module RablRails
   class Library
@@ -16,12 +15,11 @@ module RablRails
     }.freeze
 
     def initialize
-      @cached_templates = ThreadSafe::Cache.new
-      @mutex = Monitor.new
+      @cached_templates = Concurrent::Map.new
     end
 
     def reset_cache!
-      @cached_templates = ThreadSafe::Cache.new
+      @cached_templates = Concurrent::Map.new
     end
 
     def get_rendered_template(source, view, locals = nil)
@@ -52,14 +50,9 @@ module RablRails
     private
 
     def synchronized_compile(path, source, view)
-      @cached_templates[path] || @mutex.synchronize do
-        # Any thread holding this lock will be compiling the template needed
-        # by the threads waiting. So re-check the template presence to avoid
-        # re-compilation
-        @cached_templates.fetch(path) do
-          source ||= fetch_source(path, view)
-          @cached_templates[path] = compile(source, view)
-        end
+      @cached_templates.compute_if_absent(path) do
+        source ||= fetch_source(path, view)
+        compile(source, view)
       end
     end
 

data/lib/rabl-rails/nodes.rb

@@ -1,6 +1,6 @@
-require 'rabl-rails/nodes/node'
 require 'rabl-rails/nodes/attribute'
 require 'rabl-rails/nodes/glue'
 require 'rabl-rails/nodes/child'
 require 'rabl-rails/nodes/code'
 require 'rabl-rails/nodes/condition'
+require 'rabl-rails/nodes/extend'

data/lib/rabl-rails/nodes/attribute.rb

@@ -1,18 +1,20 @@
-require 'forwardable'
-
 module RablRails
   module Nodes
     class Attribute
-      include Node
-      extend Forwardable
-
-      def_delegators :@hash, :[]=, :each
       attr_reader   :hash
       attr_accessor :condition
 
       def initialize(hash = {})
         @hash = hash
       end
+
+      def []=(key, value)
+        @hash[key] = value
+      end
+
+      def each(&block)
+        @hash.each(&block)
+      end
     end
   end
 end

data/lib/rabl-rails/nodes/code.rb

@@ -1,8 +1,6 @@
 module RablRails
   module Nodes
     class Code
-      include Node
-
       attr_reader :name, :block, :condition
 
       def initialize(name, block, condition = nil)
@@ -16,4 +14,4 @@ module RablRails
       end
     end
   end
-end
+end

data/lib/rabl-rails/nodes/condition.rb

@@ -1,8 +1,6 @@
 module RablRails
   module Nodes
     class Condition
-      include Node
-
       attr_reader :condition, :nodes
 
       def initialize(condition, nodes)
@@ -11,4 +9,4 @@ module RablRails
       end
     end
   end
-end
+end

data/lib/rabl-rails/nodes/extend.rb

@@ -0,0 +1,12 @@
+module RablRails
+  module Nodes
+    class Extend
+      attr_reader :nodes, :locals
+
+      def initialize(nodes, locals)
+        @nodes  = nodes
+        @locals = locals
+      end
+    end
+  end
+end

data/lib/rabl-rails/nodes/glue.rb

@@ -1,25 +1,17 @@
 module RablRails
   module Nodes
     class Glue
-      include Node
-
-      attr_reader :template
+      attr_reader :nodes, :data
 
       def initialize(template)
-        @template = template
-      end
-
-      def data
-        @template.data
-      end
-
-      def nodes
-        @template.nodes
+        @nodes  = template.nodes
+        @data   = template.data
+        @is_var = @data.to_s.start_with?('@')
       end
 
       def instance_variable_data?
-        @instance_variable_data ||= data.to_s.start_with?('@')
+        @is_var
       end
     end
   end
-end
+end