js_render 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3537448b722ff236b75da2d4f60f5c69fbfa6290
-  data.tar.gz: 177de4414b1c645c485fbc6ef1b3bebe5b4a968f
+  metadata.gz: 3efa8f3b5071ab1391bc0f0884c7125ddfc875bc
+  data.tar.gz: eddc754107e5f99f70b9cb48855781023379735b
 SHA512:
-  metadata.gz: 97646f57c0c1428117e0ca0d2bb849f0cf04d6c5cdff34a3fd0f03cdb225f3668ff528b309b7ede336ec335493a7c377e61f46f6f2f651acac2ca89a5f6f14b3
-  data.tar.gz: 6869b116f9fdeb9842164f57727ad5878752f67da1e90976e7ca76c85e669c54f67dea3430b304d8c5231d13c3f699c8d50ff2c0aca478f49e2fe3ddb943f312
+  metadata.gz: f1a34fc4f3b80733f4b3b5335902a1ed43b40db6442cbc73e32f78b847bb263fdfaa9928dfcd5fa671910c95fb3340b6145b08039a0758170c8b969dd8426f84
+  data.tar.gz: 5b4011ffccaae946dfac1903abee032074e0cda6392b27e6fcd5af4c73675d55c88de7ebac4a96718e9ef102fbdb1b692972a55b58adb0727e041324f4ec3c5f

data/README.md

@@ -3,7 +3,7 @@
 
 # JsRender
 
-JsRender is an unopinionated Ruby library for rendering JavaScript "components" on the server side. This approach works with [React](https://facebook.github.io/react/), [Angular](ihttps://angular.io/), [Ember](http://emberjs.com/), or any other library of your choice. The only requirement is that there is a JavaScript function that returns HTML for the component or view such that it can be properly rendered on the server side (e.g. [`ReactDOMServer.renderToString`](https://facebook.github.io/react/docs/top-level-api.html#reactdomserver.rendertostring) in React).
+JsRender is an unopinionated Ruby library for rendering JavaScript "components" on the server side. This approach works with [React](https://facebook.github.io/react/), [Angular](https://angular.io/), [Ember](http://emberjs.com/), or any other library of your choice. The only requirement is that there is a JavaScript function that returns HTML for the component or view such that it can be properly rendered on the server side (e.g. [`ReactDOMServer.renderToString`](https://facebook.github.io/react/docs/top-level-api.html#reactdomserver.rendertostring) in React).
 
 The library works in two essential parts:
 - Calls a JavaScript function (defined by the user) that returns HTML. This allows us to render our JS component/view when the page initially loads, rather than having the delay of doing it solely on the client side.
@@ -150,7 +150,29 @@ Methods you can override if you subclass `JsRender::AssetFinder::Base`:
 
 > Defaults to `nil`
 
-** should_server_render **
+**key_transforms**
+
+An array of lambdas (or singletons that implement a `call` method) that can transform the keys of the data being passed into the component. The lambdas in the array are called in order, and the result of a lambda is passed to the next transform (as a string) for each key.
+
+`JsRender::Utils::Camelize` is a provided utility that will transform keys to camel case.
+
+Note: This only works if the component data is passed in as a hash, if it is already passed in as JSON, then the transforms will be ignored.
+
+Example:
+
+```ruby
+JsRender.config.key_transforms = [
+  JsRender::Utils::Camelize,
+  -> (key) { key + '_SomeEnding'}
+]
+
+# data => { camel_case: 2, something_else: 3 }
+# would be transformed to => { camelCase_SomeEnding: 2, somethingElse_SomeEnding: 3 }
+```
+
+> Defaults to `[]`
+
+**should_server_render**
 
 This config option is a boolean that specifies if the server render function and associated JS should be executed and run. When it is false, it only returns the span with the unique ID that the client side render function relies upon. This is meant for development purposes and enables things like console logging etc. that would normally cause errors in the `ExecJS` runtime.
 

data/lib/js_render.rb

@@ -1,6 +1,7 @@
 require 'js_render/version'
 require 'js_render/configuration'
 require 'js_render/errors'
+require 'js_render/utils'
 require 'js_render/asset_finder'
 require 'js_render/renderer'
 

data/lib/js_render/configuration.rb

@@ -23,6 +23,7 @@ module JsRender
                   :client_render_function,
                   :use_asset_pipeline,
                   :asset_finder_class,
+                  :key_transforms,
                   :should_server_render
 
     def initialize
@@ -33,6 +34,7 @@ module JsRender
       @client_render_function = 'window.render*Client'
       @use_asset_pipeline = false
       @asset_finder_class = nil
+      @key_transforms = []
       @should_server_render = true
     end
   end

data/lib/js_render/renderer.rb

@@ -13,7 +13,10 @@ module JsRender
 
     def initialize(component_name, data)
       @component_name = component_name
-      data = data.to_json if !data.is_a?(String)
+      unless data.is_a?(String)
+        transform_keys(data)
+        data = data.to_json
+      end
       @json_data = data
       @uuid = SecureRandom.uuid
     end
@@ -64,5 +67,13 @@ module JsRender
           AssetFinder::Base.new
         end
     end
+
+    def transform_keys(data)
+      JsRender.config.key_transforms.reduce(data) do |transformed_data, transform|
+        transformed_data.tap do |d|
+          d.keys.each { |k| d[transform.call(k.to_s)] = d.delete(k) }
+        end
+      end
+    end
   end
 end

data/lib/js_render/utils.rb

@@ -0,0 +1,6 @@
+require 'js_render/utils/camelize'
+
+module JsRender
+  module Utils
+  end
+end

data/lib/js_render/utils/camelize.rb

@@ -0,0 +1,9 @@
+module JsRender
+  module Utils
+    # based on rails camelize
+    Camelize = ->(key) do
+      key = key.sub(/^(?:(?=\b|[A-Z_])|\w)/) { $&.downcase }
+      key.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }
+    end
+  end
+end

data/lib/js_render/version.rb

@@ -1,3 +1,3 @@
 module JsRender
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_render
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jonathan Lehman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-01 00:00:00.000000000 Z
+date: 2016-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -219,6 +219,8 @@ files:
 - lib/js_render/rails/railtie.rb
 - lib/js_render/rails/view_helpers.rb
 - lib/js_render/renderer.rb
+- lib/js_render/utils.rb
+- lib/js_render/utils/camelize.rb
 - lib/js_render/version.rb
 homepage: http://github.com/jdlehman/js_render
 licenses: