tint 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0043f48824279d1625572d74b4bd9f9e7c504a4
-  data.tar.gz: c42e86959edfd7411dba82f08736cb2b0faed36d
+  metadata.gz: 3bf5b7492db85d5811d4cef5eacf1ea485d0ff23
+  data.tar.gz: a209dcc5a5154cef5ad48ef614b2305cec5e3771
 SHA512:
-  metadata.gz: a1d114c2f5254e27c25c41f410a9dd8d3c03b39c75d831acf6765f984a95dceadecdf8048c3f0778fbdf28585e31b67fe240ef46e40c73b3c0dff4a2038e427c
-  data.tar.gz: d47802117dbf5598db469fa102cf67ee3392909b73cdd7f47948e91ab5af67b54cef53d5839fb9acb3c0712dbc914fc7beb8b0f804c1861666ce82144ffbc26c
+  metadata.gz: 1e48ba414b74198f2fe478e9650a3b081fed327f161fc117b19dab7267d41eb66e47c9eb1dfb982e923361bcf8051ee2813d64f2308a5736532284234ab6a236
+  data.tar.gz: b60ef0723a9142b51576006e1e9801df62e06f6e000a3f2a31dbccb100d2e5b311fc97394ad9f1cab7aae41a9b37b86f66796e597a0d2f5f562712bacfcc4656

data/README.md

@@ -1,6 +1,6 @@
 # Tint
 
-Easily define object decorators for JSON APIs using simple declarative syntax 
+Easily define object decorators for JSON APIs using simple declarative syntax
 
 ## Installation
 
@@ -22,17 +22,17 @@ You can use Tint by creating a decorator class that inherits from `Tint::Decorat
 
 ## Defining attributes
 
-To include methods and attributes available on the decorated object, simply list them using `attributes`. 
+To include methods and attributes available on the decorated object, simply list them using `attributes`.
 
 ```ruby
 # decorators/user_decorator.rb
 class UserDecorator < Tint::Decorator
-  attributes :username, :first_name, :last_name 
+  attributes :username, :first_name, :last_name
 end
 ```
 
-You can map attributes to different names on the decorator by providing a hash as the final argument 
- 
+You can map attributes to different names on the decorator by providing a hash as the final argument
+
 ```ruby
 # decorators/user_decorator.rb
 class UserDecorator < Tint::Decorator
@@ -40,6 +40,29 @@ class UserDecorator < Tint::Decorator
 end
 ```
 
+## Defining attributes for *_ids
+
+The `ids_for` method adds `*Ids` values to a JSON object and ensures the corresponding association is automatically eager loaded:
+
+```ruby
+class ProductDecorator < Tint::Decorator
+  attributes :id, :description, :price
+
+  ids_for :sales # will add a saleIds attribute to the JSON object
+end
+```
+
+It's possible to give the `*Ids` attribute a different name by providing the name of the association as a key-value pair:
+
+
+```ruby
+class ProductDecorator < Tint::Decorator
+  attributes :id, :description, :price
+
+  ids_for sales: :purchase_identifiers # will add a purchaseIdentifiers attribute to the JSON object
+end
+```
+
 ## Defining custom methods
 
 Tint will use a decorator instance method in preference to one defined on the decorated object, so it is possible to customise how a particular attribute appears. The original definition of the attribute is available via the `object` instance variable.
@@ -47,9 +70,9 @@ Tint will use a decorator instance method in preference to one defined on the de
 ```ruby
 class ProductDecorator < Tint::Decorator
   attributes :id, :description, :price
-  
+
   def price
-    "$" + object.price  
+    "$" + object.price
   end
 end
 ```
@@ -59,9 +82,9 @@ It's also possible to define methods that are not available on the decorated obj
 ```ruby
 class ProductDecorator < Tint::Decorator
   attributes :id, :description, :on_sale
-  
+
   def on_sale
-    SaleItems.include?(object)  
+    SaleItems.include?(object)
   end
 end
 ```
@@ -79,13 +102,13 @@ end
 # decorators/user_decorator.rb
 class UserDecorator < Tint::Decorator
   attributes :username
-  
+
   decorates_association :products
 end
 ```
 
 By default, `decorates_association` uses the name of the association to guess the decorator it should use. In this case it will use `ProductDecorator`, but if you wished to render with `SpecialProductDecorator`, the `with` option may be used:
- 
+
 ```ruby
 decorates_association :product, with: SpecialProductDecorator
 ```
@@ -111,26 +134,26 @@ decorates_associations :previous_address, :current_address, with: AddressDecorat
 ## Eager loading associations
 
 When you declare a new association using `decorates_association` or `decorates_associations`, Tint automatically eager loads the associations when the decorator is rendered as JSON and automatically prevents many N+1 queries. It does this by maintaining a list `eager_loads` which is available on all decorators.
- 
+
 ```ruby
 class UserDecorator < Tint::Decorator
   attributes :username
-  
+
   decorates_association :products
 end
- 
- 
+
+
 UserDecorator.eager_loads # [:products]
 ```
 
 If you need to manually add to the list of associations which are eager loaded for any reason, you can do so using the `eager_load` method
- 
+
 ```ruby
 class UserDecorator < Tint::Decorator
   attributes :username
-  
+
   decorates_association :products
-  
+
   eager_load :addresses
 end
 
@@ -139,7 +162,7 @@ UserDecorator.eager_loads # [:products, :addresses]
 
 ## Decorating a single instance
 
-Tint maintains the interface defined by Draper for decorating objects. To decorate a single object, use the `decorate` method. 
+Tint maintains the interface defined by Draper for decorating objects. To decorate a single object, use the `decorate` method.
 
 Using the `UserDecorator` defined above:
 
@@ -150,16 +173,16 @@ class UsersController < ApplicationController
 
   def show
     @user = User.find(params[:id]) #<User username: "john_doe", first_name: "John", surname: "Doe">
-     
+
     render json: UserDecorator.decorate(@user) # { username: "john_doe", firstName: "John", lastName: "Doe" }
   end
-  
+
 end
 ```
 
 `decorate` also accepts an optional has of options. For more information about the supported options, see the [Draper documentation](https://github.com/drapergem/draper#adding-context).
- 
- 
+
+
 ## Decorating a collection
 
 The `decorate_collection` method is used for decorating an instance of ActiveRecord::Relation (or any class that implements the same interface). It accepts all of the same options as the `decorate` method.
@@ -171,17 +194,17 @@ class UsersController < ApplicationController
 
   def index
     @users = User.all
-     
+
     render json: UserDecorator.decorate_collection(@users) # [ { username: "john_doe", firstName: "John", lastName: "Doe" }, ... ]
   end
-  
+
 end
 ```
-    
+
 ## Configuration
 
 By default, Tint camelizes attribute names, however it's possible to configure Tint to use any of the following capitalization conventions:
-  
+
 ```ruby
 Tint.configuration do |config|
   # attribute_naMe123 ==> attributeNaMe123 (Default)

data/lib/tint/decorator.rb

@@ -157,6 +157,34 @@ module Tint
         true
       end
 
+      def ids_for(*options)
+        mapped_attrs = options.extract_options!
+
+        attribute_options = options.map do |association_name|
+          association_method = method_name_from_association(association_name)
+          eager_load(association_name)
+          association_method
+        end
+
+        attribute_options.push(
+            mapped_attrs.inject({}) do |memo, key_and_value|
+              association_name, value = key_and_value
+              memo[value] = method_name_from_association(association_name)
+
+              eager_load(association_name)
+              memo
+            end
+        )
+
+        attributes(*attribute_options)
+      end
+
+      private
+
+      def method_name_from_association(association)
+        association.to_s.singularize + '_ids'
+      end
+
       def link_delegations_to_object(delegated_attrs)
         @_override_methods ||= {}
 
@@ -186,8 +214,6 @@ module Tint
         end
       end
 
-      private
-
       def expand_schema(schema)
         if schema.kind_of?(Hash)
           schema.inject({}) do |memo, (schema_key, schema_value)|

data/lib/tint/json_conversion.rb

@@ -1,9 +1,5 @@
 module Tint
   module JsonConversion
-    def to_json(options={})
-      as_json.to_json(options)
-    end
-
     def as_json(options={})
       attributes_for_json
     end
@@ -44,6 +40,10 @@ module Tint
       end
     end
 
+    def remove_js_unsafe_chars(string)
+      string.gsub(/[\u007f-\u009f\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/, '')
+    end
+
     def attributes_for_json
       attribute_list = self.class._attributes
       override_methods = self.class._override_methods
@@ -74,7 +74,8 @@ module Tint
           end
 
         unless value.nil?
-          memo[strategy.transform(key)] = value.respond_to?(:as_json) ? value.as_json : value
+          json_value = value.respond_to?(:as_json) ? value.as_json : value
+          memo[strategy.transform(key)] = json_value.kind_of?(String) ? remove_js_unsafe_chars(json_value) : value
         end
 
         memo

data/lib/tint/version.rb

@@ -1,3 +1,3 @@
 module Tint
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tint
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Aleck Greenham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-10 00:00:00.000000000 Z
+date: 2017-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: draper