reins 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2524b1bf46d2ae61c2b40e164618ea2cef6bb83
+  data.tar.gz: 23695b75bd8701646b8eb593106c248e9ae7dda6
+SHA512:
+  metadata.gz: 9d5411e9e1c5c0ff63cf9b05e3afc94c46e2a77686e2423b3a74c5fe81361617dabdc2fcc1adb79f15a20af4bb29a11e8effa8a8c36514fbfe8936d20c185af8
+  data.tar.gz: 980e99a96ac2522b16d74c2f8e2cf29aece083c3e763b73468080e1b2173ee8d511d3c4031415e861419b2e630716e68956e15a5527bd9d9477d9ca4403446c3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Tony Goncalves
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Reins'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/rails/generators/reins/assets/assets_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/named_base'
+
+module Reins
+  module Generators
+    class AssetsGenerator < ::Rails::Generators::NamedBase
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_reins_controller
+        template(
+          'reins_controller.js',
+          File.join('app/assets/javascripts/controllers', class_path, "#{ file_name }.js")
+        )
+      end
+
+    end
+  end
+end

data/lib/rails/generators/reins/assets/templates/reins_controller.js

@@ -0,0 +1,94 @@
+/**
+ * Anonymous self-running function to keep us from polluting the global namespace
+ * with definitions that should be kept private.
+ */
++function() {
+
+  /**
+   * Publicly accessible functions related to <%= file_name %>.
+   * These can be called from anywhere as r.<%= file_name %>.function_name(arg1, arg2);
+   *
+   * This scope includes the JS controller action functions corresponding to the
+   * rails <%= file_name %> controller, so keep in mind that funcions
+   * that match the names of the actions will be called automatically by rails.
+   */
+  window.r.<%= file_name %> = {
+
+    /**
+     * Controller action corresponding to the #new rails action.
+     * This code is run everytime that the new.html format is rendered by rails.
+     */
+    // _new: function() {
+    // },
+
+
+    /**
+     * Controller action corresponding to the #create rails action.
+     * This code is run everytime that the create.html format is rendered by rails.
+     */
+    // _create: function(params) {
+    // },
+
+
+    /**
+     * Controller action corresponding to the #index rails action.
+     * This code is run everytime that the create.html format is rendered by rails.
+     */
+    // _index: function(params) {
+    // },
+
+
+    /**
+     * Controller action corresponding to the #show rails action.
+     * This code is run everytime that the create.html format is rendered by rails.
+     */
+    // _show: function(params) {
+    // },
+
+
+    /**
+     * Controller action corresponding to the #update rails action.
+     * This code is run everytime that the create.html format is rendered by rails.
+     */
+    // _update: function(params) {
+    // },
+
+
+    /**
+     * Controller action corresponding to the #destroy rails action.
+     * This code is run everytime that the create.html format is rendered by rails.
+     */
+    // _destroy: function(params) {
+    // },
+
+
+    /**
+     * You can also declare your own functions here.
+     *
+     * Call this one from anywhere like this:
+     *   r.<%= file_name %>.my_function('John Doe');
+     */
+    // my_function: function(name) {
+    //   alert('Have a nice day ' + name + '!');
+    // }
+
+  };
+
+
+
+  ////////////////////////////////////////////////////////////////////////////
+  // Anything below this but still inside the anonymous function is private //
+  ////////////////////////////////////////////////////////////////////////////
+
+  /**
+   * This is a private function. It can be called by any function inside this
+   * closure, including the controllers above, but it's invisible to the outside
+   * world.
+   */
+  // function my_function2() {
+  //   // do stuff...
+  // }
+
+
+
+}();

data/lib/reins.rb

@@ -0,0 +1,2 @@
+require 'reins/railtie'
+require 'reins/engine' if defined?(Rails)

data/lib/reins/engine.rb

@@ -0,0 +1,7 @@
+module Reins
+  class Engine < ::Rails::Engine
+    initializer 'reins.load_static_assets' do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/vendor"
+    end
+  end
+end

data/lib/reins/railtie.rb

@@ -0,0 +1,11 @@
+require 'reins/view_helpers'
+
+module Reins
+  class Railtie < Rails::Railtie
+    config.app_generators.javascript_engine :reins
+
+    initializer 'reins.view_helpers' do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/reins/version.rb

@@ -0,0 +1,3 @@
+module Reins
+  VERSION = "0.0.1"
+end

data/lib/reins/view_helpers.rb

@@ -0,0 +1,34 @@
+module Reins
+  module ViewHelpers
+
+    # Helper that creates a <script> tag insertable into HTML templates to set the
+    # reins controller and action to the current rails controller and action name.
+    #
+    # Returns:: The javascript code that will perform the necessary actions.
+    def reins_script_tag
+      "<script>#{ update_reins_controller }</script>".html_safe
+    end
+
+
+    # Helper that emits JS code to set the reins controller and action to the
+    # current rails controller and action name.
+    #
+    # Returns:: The javascript code that will perform the necessary actions.
+    def update_reins_controller
+      "r.controller = '#{ params[:controller]   }';
+       r.action     = '#{ params[:action]       }';
+       r.params     =  #{ @reins_params.to_json };".html_safe
+    end
+
+
+    # Helper for use in js.erb templates to automatically call the reins
+    # controller and action that matches the current rails controller and action
+    # name.
+    #
+    # Returns:: The javascript code that will perform the necessary actions.
+    def call_reins_controller
+      "#{ update_reins_controller }r.call_js_controller();".html_safe
+    end
+
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: reins
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tony Goncalves
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: execjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Reins is a ruby gem that automates the creation of javascript controllers
+  that match the structure of your rails controllers. This includes passing custom
+  data to the JS controllers from the server.
+email:
+- tony@weareredlight.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/rails/generators/reins/assets/assets_generator.rb
+- lib/rails/generators/reins/assets/templates/reins_controller.js
+- lib/reins.rb
+- lib/reins/engine.rb
+- lib/reins/railtie.rb
+- lib/reins/version.rb
+- lib/reins/view_helpers.rb
+homepage: http://github.com/weareredlight/reins
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Reins! Rein in your javascript
+test_files: []