rabl 0.13.1 → 0.14.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 69b64e79c938fa56b79fa08d95a97f92c4f1fff8
-  data.tar.gz: 92afd63714dd8aae58385ed097682baab04c81ab
+SHA256:
+  metadata.gz: 319983ae5fd329b2650da09ab880866b0f07f4d81bc722a27c9d0305fd1a77af
+  data.tar.gz: 7b6b13b88d7da8b770e1f4cc8aaa0d3193f50f01b0f57980a4ce8071538e4849
 SHA512:
-  metadata.gz: 7721e7744da0a52bd67aea61d060a1db815cb926b9f4b7e019519ad581ba35ab1a0af5eefe4dfe9fc9cc22fff3e24c3479f2e54a66810180047ca6d93c993363
-  data.tar.gz: 95df50736a71777c09a731eb9cc3e9752a7282e3a22bf93ebd1da7c1a024fd1d6771351e2d84b8097bef872580c43d6556a37d4c0a75c891f730bed46e45cc3d
+  metadata.gz: b1362d83db64761f01d4080168836f8eba428679b71d81b099aed9280b9b8a4514ad3ba02a318371eb1749a4321610e6da111f7a73450898894a702f075611be
+  data.tar.gz: 0f321dcb3312a35df5f5381aa66af94a527c526c529922994346d8833c72ec986f8879de6050c7bc35dfbe333bc4257846ddb3d70d74406e94b0cab0c65aaaf3

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # CHANGELOG
 
+## 0.14.4 (April 1st, 2021)
+
+* Test against latest Ruby versions
+* Exclude yarn lock
+* Remove non-required files from the .gem
+
+## 0.14.3 (April 22nd, 2020)
+
+* Fix regression on Rails 4.2 (@tagliala)
+
+## 0.14.2 (September 10th, 2019)
+
+* Made Rails 6 compatible (@jpawlyn)
+* Drop EOL'd property from gemspec (@olleolleolle)
+
+## 0.14.1 (April 28th, 2019)
+
+* Many adjustments and various non-breaking fixes
+* Improvements to caching (@zenspider)
+* Fix tests for Rails 5 (@robertoz)
+
 ## 0.13.1 (October 21st, 2016)
 
 * Further compatibility with Rails 5

data/CONTRIBUTING.md

@@ -3,7 +3,7 @@ We love pull requests. Here's a quick guide:
 1. Fork the repo.
 
 2. Run the tests. We only take pull requests with passing tests, and it's great
-to know that you have a clean slate: `bundle && rake test`
+to know that you have a clean slate: `bundle && bundle exec rake test`
 
 3. Add a test for your change. Only refactoring and documentation changes
 require no new tests. If you are adding functionality or fixing a bug, we need
@@ -34,4 +34,4 @@ Syntax:
 
 And in case we didn't emphasize it enough: we love tests!
 
-NOTE: Adapted from https://raw.github.com/thoughtbot/factory_girl_rails/master/CONTRIBUTING.md
+NOTE: Adapted from https://raw.github.com/thoughtbot/factory_girl_rails/master/CONTRIBUTING.md

data/README.md

@@ -1,8 +1,7 @@
 # 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)
+[![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 +145,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 +186,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 +302,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 +589,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 +633,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/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!
@@ -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
@@ -135,10 +137,13 @@ module Rabl
       # attribute :foo, :as => "bar"
       # attribute :foo, :as => "bar", :if => lambda { |m| m.foo }
       def attribute(name, options = {})
-        return unless @_object && attribute_present?(name) && resolve_condition(options)
+        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 +156,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 +179,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
@@ -198,10 +203,11 @@ module Rabl
 
       # Evaluate conditions given a symbol/proc/lambda/variable to evaluate
       def call_condition_proc(condition, object)
-        # This will evaluate lambda, proc & symbol and call it with 1 argument
-        return condition.to_proc.call(object) if condition.is_a?(Proc) || condition.is_a?(Symbol)
-        # Else we send directly the object
-        condition
+        case condition
+        when Proc   then condition.call(object)
+        when Symbol then condition.to_proc.call(object)
+        else             condition
+        end
       end
 
       # resolve_condition(:if => true) => true
@@ -211,8 +217,10 @@ module Rabl
       # resolve_condition(:unless => lambda { |m| false }, :if => proc { true}) => true
       def resolve_condition(options)
         result = true
-        result &&= call_condition_proc(options[:if], @_object) if options.key?(:if)
-        result &&= !call_condition_proc(options[:unless], @_object) if options.key?(:unless)
+        result &&=  call_condition_proc(options[:if], @_object)     if
+          options.key?(:if)
+        result &&= !call_condition_proc(options[:unless], @_object) if
+          options.key?(:unless)
         result
       end
 
@@ -220,13 +228,9 @@ module Rabl
       # Checks if an attribute is present. If not, check if the configuration specifies that this is an error
       # attribute_present?(created_at) => true
       def attribute_present?(name)
-        if @_object.respond_to?(name)
-          true
-        elsif Rabl.configuration.raise_on_missing_attribute
-          raise "Failed to render missing attribute #{name}"
-        else
-          false
-        end
+        @_object.respond_to?(name) ||
+          (Rabl.configuration.raise_on_missing_attribute &&
+           raise("Failed to render missing attribute #{name}"))
       end
 
       # Returns a guess at the format in this context_scope
@@ -248,5 +252,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/cache_engine.rb

@@ -5,8 +5,35 @@
 #     config.cache_engine = AdvancedCacheEngine.new
 #
 
+class LRU < Hash
+  attr_accessor :max_size
+
+  def initialize
+    super
+    self.max_size = 100_000
+  end
+
+  def []= k,v
+    r = super
+    limit_size
+    r
+  end
+
+  def limit_size
+    if size > max_size then
+      delete keys.shift while size > max_size
+    end
+  end
+end
+
 module Rabl
   class CacheEngine
+    def initialize
+      unless defined?(Rails)
+        @cache = LRU.new
+      end
+    end
+
 
     # Fetch given a key and options and a fallback block attempts to find the key in the cache
     # and stores the block result in there if no key is found.
@@ -17,13 +44,15 @@ module Rabl
       if defined?(Rails)
         Rails.cache.fetch(key, cache_options, &block)
       else
-        yield
+        @cache[key] ||= yield
       end
     end
 
     def write(key, value, options = {})
       if defined?(Rails)
         Rails.cache.write(key, value, options)
+      else
+        @cache[key] = yield
       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!
@@ -58,8 +60,10 @@ module Rabl
         if digestor_available? && respond_to?(:lookup_context) && lookup_context
           template = @_options[:template] || @virtual_path
 
-          digest = \
-            if Gem::Version.new(Rails.version) >= Gem::Version.new('4.1')
+          digest =
+            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)
@@ -81,7 +85,7 @@ module Rabl
 
       options[:root_name] = determine_object_root(data, root_name, options[:root])
 
-      result = \
+      result =
         if is_object?(data) || !data # object @user
           Builder.new(data, @_settings, options).to_hash
         elsif is_collection?(data) # collection @users
@@ -165,6 +169,7 @@ module Rabl
       @_root_name_data = @_root_name_data.values.first if @_root_name_data.is_a?(Hash)
 
       # If we turn this around, `@_root_name_date ==` may trigger data to be loaded unnecessarily.
+      # TODO: is nil a different semantic? otherwise don't use `false ==`, use !
       if false == @_root_name_data
         @_object_root_name = false
         @_collection_name = false
@@ -387,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)
@@ -407,15 +412,21 @@ module Rabl
       end
 
       def eval_source(locals, &block)
-        # Note: locals and block may be used by the eval'ed source
-
         return unless @_source.present?
 
-        if @_options[:source_location]
-          instance_eval(@_source, @_options[:source_location])
-        else
-          instance_eval(@_source)
+        msg = "cached_source_#{@_source.hash.abs}"
+
+        unless self.respond_to? msg then
+          src = "def #{msg} locals, &block\n#{@_source}\nend"
+
+          if @_options[:source_location]
+            self.class.class_eval(src, @_options[:source_location])
+          else
+            self.class.class_eval(src)
+          end
         end
+
+        send msg, locals, &block
       end
   end
 end

data/lib/rabl/helpers.rb

@@ -14,7 +14,9 @@ module Rabl
     # data_object_attribute(data) => @_object.send(data)
     def data_object_attribute(data)
       attribute = @_object.__send__(data)
-      attribute = attribute.as_json if is_collection?(attribute, false) && attribute.respond_to?(:as_json)
+      attribute = attribute.as_json if
+        is_collection?(attribute, false) &&
+        attribute.respond_to?(:as_json)
       attribute
     end
 
@@ -81,8 +83,10 @@ module Rabl
     # is_collection?([]) => true
     def is_collection?(obj, follow_symbols = true)
       data_obj = follow_symbols ? data_object(obj) : obj
-      data_obj && data_obj.respond_to?(:map) && data_obj.respond_to?(:each) &&
-        !(data_obj.is_a?(Struct) || defined?(Hashie::Mash) && data_obj.is_a?(Hashie::Mash))
+      data_obj &&
+        data_obj.respond_to?(:map) && data_obj.respond_to?(:each) &&
+        !(data_obj.is_a?(Struct) ||
+          defined?(Hashie::Mash) && data_obj.is_a?(Hashie::Mash))
     end
 
     # Returns the context_scope wrapping this engine, used for retrieving data, invoking methods, etc

data/lib/rabl/railtie.rb

@@ -1,11 +1,28 @@
 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!
 
         # 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