reins 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e29a5fa03f69f5d1b2b94436937f6c6e691111c7
-  data.tar.gz: 4e8f0994a7d98254fcf05fb583cc9856e7a1a6dd
+  metadata.gz: afbdfa48fc19a1f413c5f71527218bb1daaf3d3a
+  data.tar.gz: 612f9ff4237d55935bcbf3cf0b88c689c732ed57
 SHA512:
-  metadata.gz: 11a5af34c6def9a79db78f442915ee3e73fe2e629e3043b735d34f9f4be27f2a11eaf8a7e8604843d2dbb20ae52945559c515749eb573111835be778cbc3cf8d
-  data.tar.gz: aecc8f25cc808a37cbcc3a98a6b1153504a622079f6e5e58963d728bb7286b10a3530de52bfa0cd385cdbad942f2ae4d5399b5ed187a39c404eba9ad2a4d58df
+  metadata.gz: d1aaa49ceda92281a40d5c96bdac4a8e598b2a026cca0ddd6ce9858b179adf545f5ba99681c067f26718dc3e980db539b7aa7abf3e5c8fe9cc52842256e6cc65
+  data.tar.gz: b9d4833090d527baeaf94a5ce298754e334d140023b8666d1cb380a67462e7debc5756f8ca78673ba5b2f5ffb4306f9d989fc967eff22810b2840ee38df35de0

data/README.md

@@ -0,0 +1,30 @@
+# Reins [![Gem Version](https://badge.fury.io/rb/reins.svg)](http://badge.fury.io/rb/reins) [![wercker status](https://app.wercker.com/status/6ea31467d299403dc3bac9f6bd962d96/s/master "wercker status")](https://app.wercker.com/project/bykey/6ea31467d299403dc3bac9f6bd962d96) ![](http://ruby-gem-downloads-badge.herokuapp.com/reins)
+
+Reins is a ruby gem that automates the creation of javascript controllers that match the structure of your rails controllers.
+It enables you to keep javascript code out of your views by defining namespaced functions that get called automatically for each rails controller action that runs.
+
+This even works in the case of javascript code that needs data from the server (which almost always ends up inside a <script> tag somewhere with <%%> tags...).
+You just have to define the @reins_params hash on the controller and this hash will be JSONified and passed to the javascript controller as a dictionary object.
+
+Reins can be used with or without turbolinks.
+
+
+To start using it:
+
+add to your gemfile:
+
+  gem 'reins'
+
+
+add to application.js:
+
+  //= require reins
+
+
+add to layouts/*.html.erb, right before </body> closing tag:
+
+  <%= reins_script_tag %>
+
+
+
+Reins is licenced under the MIT License. Please see the file MIT-LICENSE for more details.

data/lib/reins/version.rb

@@ -1,3 +1,3 @@
 module Reins
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/vendor/assets/javascripts/reins.js

@@ -0,0 +1,50 @@
+/**
+ * Implementation of JavaScript controllers that match the rails controllers
+ * and get called automatically upon rendering of html.erb views.
+ *
+ * "r" is the main namespace where all JS controllers related code will be
+ * nested in.
+ */
+var r = {
+
+  /**
+   * Varible where current rails controller name is stored for easy access.
+   */
+  controller: '',
+
+
+  /**
+   * Varible where current rails action name is stored for easy access.
+   */
+  action: '',
+
+
+  /**
+   * Varible where the @reins_params that were set on the server controller get
+   * stored.
+   */
+  params: null,
+
+
+  /**
+   * Calls the current JS controller that corresponds to the rendered rails
+   * controller#action (if it exists).
+   */
+  call_js_controller: function() {
+    var reins_controller = r.controller.replace(/\//gi, '_');
+    if (r[reins_controller] != null) {
+      var func = r[reins_controller]['_' + r.action];
+      if (typeof func == 'function')
+        func.call(r[reins_controller], r.params);
+    }
+  }
+
+};
+
+
+
+/**
+ * When page is ready, run javascript controller#action that corresponds to
+ * current rails controller#action.
+ */
+$(document).on('page:load ready', r.call_js_controller);

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reins
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tony Goncalves
@@ -62,6 +62,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
 - Rakefile
 - lib/rails/generators/reins/assets/assets_generator.rb
 - lib/rails/generators/reins/assets/templates/reins_controller.js
@@ -70,6 +71,7 @@ files:
 - lib/reins/railtie.rb
 - lib/reins/version.rb
 - lib/reins/view_helpers.rb
+- vendor/assets/javascripts/reins.js
 homepage: http://github.com/weareredlight/reins
 licenses:
 - MIT