rabl-rails 0.3.4 → 0.4.0

data/.travis.yml

@@ -1,11 +1,11 @@
 language: ruby
 env:
-  - "RAILS_VERSION=3.1.0"
   - "RAILS_VERSION=3.2.0"
   - "RAILS_VERSION=4.0.0"
+  - "RAILS_VERSION=4.1.0"
 rvm:
   - 1.9.3
   - jruby-19mode
-  - rbx
+  - rbx-2
   - 2.0.0
   - 2.1.0

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 0.4.0
+  * Internal cleanup and refactor
+  * Remove the `allow_empty_format_in_template` option, since it has become
+    the default behavior.
+  * Remove multi_json dependency
+  * New options available
+    * replace_nil_values_with_empty_strings
+    * replace_empty_string_values_with_nil
+    * exclude_nil_values
+
 ## 0.3.4
   * Add `xml_options` option to root_level (brettallred)
 

data/Gemfile

@@ -6,18 +6,20 @@ rails_version = ENV['RAILS_VERSION'] || 'default'
 
 rails = case rails_version
 when 'master'
-  {github: 'rails/rails'}
+  { github: 'rails/rails' }
 when "default"
   '~> 3.2.0'
 else
   "~> #{rails_version}"
 end
 
+minitest_version = rails_version == '4.0.0' ? '~> 4.7' : '~> 5.4'
+
 gem 'activesupport', rails
 gem 'railties', rails
 
-group :development, :test do
-  gem 'actionpack', rails
+group :test do
+  gem 'minitest', minitest_version
 end
 
 gem 'plist'
@@ -34,9 +36,3 @@ platforms :jruby do
   gem 'nokogiri'
 end
 
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'minitest'
-  gem 'rubysl-test-unit'
-end
-

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+ application** and is compatible with mri 1.9.3, jRuby and rubinius.
+rabl-rails only targets **Rails 3.2+ application** and is compatible with mri 1.9.3+, jRuby and rubinius.
 
 ## Installation
 
@@ -91,12 +91,14 @@ RablRails.configure do |config|
   # These are the default
   # config.cache_templates = true
   # config.include_json_root = true
-  # config.json_engine = :oj
-  # config.xml_engine = 'LibXML'
+  # 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
+  # config.exclude_nil_values = false
 end
 ```
 

data/Rakefile

@@ -27,8 +27,8 @@ require 'rake/testtask'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
+  t.pattern = 'test/**/test_*.rb'
+  # t.verbose = true
 end
 
 

data/lib/rabl-rails.rb

@@ -1,96 +1,43 @@
 require 'rails/railtie'
 
 require 'active_support'
-require 'active_support/core_ext/class/attribute_accessors'
 
 require 'rabl-rails/version'
+require 'rabl-rails/helpers'
 require 'rabl-rails/template'
-require 'rabl-rails/condition'
+require 'rabl-rails/nodes'
 require 'rabl-rails/compiler'
 
+require 'rabl-rails/visitors'
 require 'rabl-rails/renderer'
-
 require 'rabl-rails/library'
+
 require 'rabl-rails/handler'
 require 'rabl-rails/railtie'
 
-require 'multi_json'
+require 'rabl-rails/configuration'
+
+begin
+  require 'oj'
+  Oj.default_options =  { mode: :compat, time_format: :ruby }
+rescue LoadError
+  require 'json'
+end
 
 module RablRails
   extend Renderer
 
-  autoload :Responder, 'rabl-rails/responder'
-
-  mattr_accessor :cache_templates
-  @@cache_templates = true
-
-  mattr_accessor :include_json_root
-  @@include_json_root = true
-
-  mattr_accessor :use_custom_responder
-  @@use_custom_responder = false
-
-  mattr_accessor :responder_default_template
-  @@responder_default_template = 'show'
-
-  mattr_reader :plist_engine
-  @@plist_engine = nil
-
-  mattr_accessor :include_plist_root
-  @@include_plist_root = nil
-
-  mattr_accessor :enable_jsonp_callbacks
-  @@enable_jsonp_callbacks = false
-
-  mattr_accessor :allow_empty_format_in_template
-  @@allow_empty_format_in_template = false
-
-  mattr_accessor :xml_options
-  @@xml_options = { dasherize: true, skip_types: false }
-
-  def self.configure
-    yield self
-
-    ActionController::Base.responder = Responder if self.use_custom_responder
-  end
-
-  def self.json_engine=(name)
-    MultiJson.engine = name
-  rescue LoadError
-    Rails.logger.warn %Q(WARNING: rabl-rails could not load "#{name}" as JSON engine, fallback to default)
-  end
-
-  def self.json_engine
-    MultiJson.engine
-  end
-
-  def self.xml_engine=(name)
-    ActiveSupport::XmlMini.backend = name
-  rescue LoadError, NameError
-    Rails.logger.warn %Q(WARNING: rabl-rails could not load "#{name}" as XML engine, fallback to default)
-  end
-
-  def self.xml_engine
-    ActiveSupport::XmlMini.backend
-  end
-
-  def self.plist_engine=(name)
-    raise "Your plist engine does not respond to #dump" unless name.respond_to?(:dump)
-    @@plist_engine = name
-  end
-
-  def self.cache_templates?
-    ActionController::Base.perform_caching && @@cache_templates
-  end
+  class << self
+    def configure
+      yield configuration
+    end
 
-  def self.load_default_engines!
-    self.json_engine  = MultiJson.default_engine
-    self.plist_engine = Plist::Emit if defined?(Plist)
+    def configuration
+      @_configuration ||= Configuration.new
+    end
 
-    if defined?(LibXML)
-      self.xml_engine = 'LibXML'
-    elsif defined?(Nokogiri)
-      self.xml_engine = 'Nokogiri'
+    def reset_configuration
+      @_configuration = nil
     end
   end
 end

data/lib/rabl-rails/compiler.rb

@@ -4,8 +4,8 @@ module RablRails
   # representing data structure
   #
   class Compiler
-    def initialize
-      @i = -1
+    def initialize(view)
+      @view = view
     end
 
     #
@@ -41,15 +41,19 @@ module RablRails
     #   attribute :email => :super_secret
     #
     def attribute(*args)
+      node = Nodes::Attribute.new
+
       if args.first.is_a?(Hash)
-        args.first.each_pair { |k, v| @template[v] = k }
+        args.first.each_pair { |k, v| node[v] = k }
       else
         options = args.extract_options!
         args.each { |name|
           key = options[:as] || name
-          @template[key] = name
+          node[key] = name
         }
       end
+
+      @template.add_node node
     end
     alias_method :attributes, :attribute
 
@@ -66,12 +70,14 @@ module RablRails
       data, name = extract_data_and_name(name_or_data)
       name = options[:root] if options.has_key? :root
 
-      @template[name] = if options[:partial]
-        template = Library.instance.compile_template_from_path(options[:partial])
-        template.merge!(:_data => data)
+      if options.key?(:partial)
+        template = Library.instance.compile_template_from_path(options[:partial], @view)
+        template.data = data
       elsif block_given?
-        sub_compile(data) { yield }
+        template = sub_compile(data) { yield }
       end
+
+      @template.add_node Nodes::Child.new(name, template)
     end
 
     #
@@ -81,7 +87,9 @@ module RablRails
     #
     def glue(data)
       return unless block_given?
-      @template[sequence('glue')] = sub_compile(data) { yield }
+
+      template = sub_compile(data) { yield }
+      @template.add_node Nodes::Glue.new(template)
     end
 
     #
@@ -93,18 +101,8 @@ module RablRails
     #   node(:role, if: ->(u) { !u.admin? }) { |u| u.role }
     #
     def node(name = nil, options = {}, &block)
-      name ||= sequence('merge')
-      condition = options[:if]
-
-      if condition
-        if condition.is_a?(Proc)
-          @template[name] = [condition, block]
-        else
-          @template[name] = block if condition
-        end
-      else
-        @template[name] = block
-      end
+      return unless block_given?
+      @template.add_node Nodes::Code.new(name, block, options[:if])
     end
     alias_method :code, :node
 
@@ -114,9 +112,9 @@ module RablRails
     # Example:
     #   merge { |item| partial("specific/#{item.to_s}", object: item) }
     #
-    def merge(&block)
+    def merge
       return unless block_given?
-      node(sequence('merge'), &block)
+      node(nil) { yield }
     end
 
     #
@@ -125,8 +123,7 @@ module RablRails
     #   extends 'users/base'
     #
     def extends(path)
-      t = Library.instance.compile_template_from_path(path)
-      @template.merge!(t.source)
+      @template.extends Library.instance.compile_template_from_path(path, @view)
     end
 
     #
@@ -138,7 +135,7 @@ module RablRails
     #
     def condition(proc)
       return unless block_given?
-      @template[sequence('if')] = Condition.new(proc, sub_compile(nil) { yield })
+      @template.add_node Nodes::Condition.new(proc, sub_compile(nil, true) { yield })
     end
 
     def cache(&block)
@@ -147,14 +144,6 @@ module RablRails
 
     protected
 
-    #
-    # Return unique symbol starting with given name
-    #
-    def sequence(name)
-      @i += 1
-      :"_#{name}#{@i}"
-    end
-
     #
     # Extract data root_name and root name
     # Example:
@@ -173,11 +162,12 @@ module RablRails
       end
     end
 
-    def sub_compile(data)
-      return {} unless block_given?
-      old_template, @template = @template, {}
+    def sub_compile(data, only_nodes = false)
+      raise unless block_given?
+      old_template, @template = @template, CompiledTemplate.new
       yield
-      data ? @template.merge!(:_data => data) : @template
+      @template.data = data
+      only_nodes ? @template.nodes : @template
     ensure
       @template = old_template
     end

data/lib/rabl-rails/configuration.rb

@@ -0,0 +1,48 @@
+module RablRails
+  class Configuration
+    attr_accessor :json_engine, :include_json_root, :enable_jsonp_callbacks
+    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
+
+    def initialize
+      @json_engine            = defined?(::Oj) ? ::Oj : ::JSON
+      @include_json_root      = true
+      @enable_jsonp_callbacks = false
+
+      @xml_options = { dasherize: true, skip_types: false }
+
+      @plist_engine       = defined?(::Plist) ? ::Plist::Emit : nil
+      @include_plist_root = false
+
+      @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
+    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
+        result |= 0b01  if @replace_nil_values_with_empty_strings
+        result |= 0b10  if @replace_empty_string_values_with_nil
+        result |= 0b100 if @exclude_nil_values
+        result
+      end
+    end
+  end
+end

data/lib/rabl-rails/handler.rb

@@ -1,7 +1,9 @@
+require 'active_support/core_ext/class/attribute'
+
 module RablRails
   module Handlers
     class Rabl
-      cattr_accessor :default_format
+      class_attribute :default_format
       self.default_format = 'application/json'
 
       def self.call(template)

data/lib/rabl-rails/helpers.rb

@@ -0,0 +1,7 @@
+module RablRails
+  module Helpers
+    def collection?(resource)
+      resource && resource.respond_to?(:each) && !resource.is_a?(Struct)
+    end
+  end
+end

data/lib/rabl-rails/library.rb

@@ -1,37 +1,64 @@
 require 'singleton'
+require 'monitor'
+require 'thread_safe'
 
 module RablRails
   class Library
     include Singleton
 
     def initialize
-      @cached_templates = {}
+      @cached_templates = ThreadSafe::Cache.new
+      @mutex = Monitor.new
     end
 
-    def get_rendered_template(source, context, locals = nil)
-      path = context.instance_variable_get(:@virtual_path)
-      @lookup_context = context.lookup_context
+    def reset_cache!
+      @cached_templates = ThreadSafe::Cache.new
+    end
 
-      compiled_template = compile_template_from_source(source, path)
+    def get_rendered_template(source, view, locals = nil)
+      compiled_template = compile_template_from_source(source, view)
+      format = view.params[:format] ? view.params[:format].to_s.upcase : :JSON
+      Renderers.const_get(format).render(compiled_template, view, locals)
+    end
 
-      format = context.params[:format] ? context.params[:format].to_s.upcase : :JSON
-      Renderers.const_get(format).new(context, locals).render(compiled_template)
+    def compile_template_from_source(source, view)
+      if RablRails.configuration.cache_templates
+        path = view.instance_variable_get(:@virtual_path)
+        synchronized_compile(path, source, view)
+      else
+        compile(source, view)
+      end
     end
 
-    def compile_template_from_source(source, path = nil)
-      if path && RablRails.cache_templates?
-        @cached_templates[path] ||= Compiler.new.compile_source(source)
-        @cached_templates[path].dup
+    def compile_template_from_path(path, view)
+      if RablRails.configuration.cache_templates
+        synchronized_compile(path, nil, view)
       else
-        Compiler.new.compile_source(source)
+        source = fetch_source(path, view)
+        compile(source, view)
       end
     end
 
-    def compile_template_from_path(path)
-      return @cached_templates[path].dup if @cached_templates.has_key?(path)
+    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
+      end
+    end
+
+    def compile(source, view)
+      Compiler.new(view).compile_source(source)
+    end
 
-      t = @lookup_context.find_template(path, [], false)
-      compile_template_from_source(t.source, path)
+    def fetch_source(path, view)
+      view.lookup_context.find_template(path, [], false).source
     end
   end
 end