rjs_helpers 0.0.4 → 1.0

data/README.md

@@ -5,16 +5,12 @@ RJS Helpers
 
 Some helper methods to perform standard JS library tasks from js.erb without having to write actual javascript
 
+**Important**: This version was made for use with Rails >= 3.1. If you are using Rails 2.3, please take a look
+               at the `rails2` branch.
+
 Installation
 ============
 
-As a plugin
------------
-
-To install the plugin in your Rails 2.3 application, simply run
-
-    ruby script/plugin install https://github.com/Stex/rjs_helpers.git
-
 As a gem
 --------
 
@@ -26,16 +22,12 @@ or put this into your `Gemfile`:
 
     gem 'rjs_helpers'
 
-    
-This will automatically load the Rails helper into all your controllers.
-As explained below, the plugin ships with a default JS adapter for jQuery
-which can be automatically copied to your public/javascripts directory with
-the following line:
+In this version, RJS helpers is built as a Rails engine,
+so the necessary helper methods and assets are automatically loaded into your application.
 
-    ruby script/generate rjs_helpers js
-    
-Now you only have to include this js file into your application layout
-and you're good to go.
+You only have to extend your `application.js` file to include the necessary javascript:
+
+    //= require rjs_helpers
 
 Usage
 =====
@@ -124,16 +116,9 @@ if you have a fixed top navbar (greetings to you, bootstrap).
 
 If `:top` is given as the first argument, the page will simply scroll to the very top (+ offset).
 
-
-
-
-
-
-
-
-
 Examples
 ========
+
 ```ruby
 = js_update_element @user, :partial => 'user', :object => @user
 #=> rjsHelpers.updateElementByDomId('user_123', ...)

data/app/helpers/rjs_helper.rb

@@ -134,7 +134,7 @@ module RjsHelper
   end
 
   def string_args(args)
-    args.map {|a| a.is_a?(Numeric) ? a : ('"' + fixed_escape_javascript(a.to_s) + '"')}.join(', ')
+    args.map {|a| a.is_a?(Numeric) ? a : "'#{a}'"}.join(', ')
   end
 
 
@@ -144,15 +144,6 @@ module RjsHelper
   # Also, it automatically escapes javascript in the given content
   #--------------------------------------------------------------
   def rendered_content(content)
-    content.is_a?(Hash) ? render(content) : content
-  end
-
-  #
-  # The Rails +escape_javascript+ helper does not seem to automatically
-  # escape unicode newline elements which causes javascript strings
-  # to break. This method escapes these sequences.
-  #
-  def fixed_escape_javascript(text)
-    escape_javascript(text).gsub("\342\200\250", "
")
+    escape_javascript(content.is_a?(Hash) ? render(content) : content)
   end
 end

data/lib/rjs_helpers/engine.rb

@@ -0,0 +1,4 @@
+module RjsHelpers
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/rjs_helpers/version.rb

@@ -1,3 +1,3 @@
 module RjsHelpers
-  VERSION = '0.0.4'
+  VERSION = '1.0'
 end

data/lib/rjs_helpers.rb

@@ -1 +1,2 @@
-# RailsJsHelpers
+require 'rjs_helpers/version'
+require 'rjs_helpers/engine' if defined?(::Rails)

data/rjs_helpers.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'railties', '>= 3.2', '< 5.0'
+
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake', '0.9.2.2'
   spec.add_development_dependency 'barista'

data/test/rjs_helpers_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class RjsHelperTest < ActiveSupport::TestCase
+class JrsHelperTest < ActiveSupport::TestCase
   # Replace this with your real tests.
   test "the truth" do
     assert true

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rjs_helpers
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 15
   prerelease: 
   segments: 
+  - 1
   - 0
-  - 0
-  - 4
-  version: 0.0.4
+  version: "1.0"
 platform: ruby
 authors: 
 - Stefan Exner
@@ -15,12 +14,34 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-06-05 00:00:00 Z
+date: 2014-03-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: railties
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 3
+        - 2
+        version: "3.2"
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 5
+        - 0
+        version: "5.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -31,11 +52,11 @@ dependencies:
         - 3
         version: "1.3"
   type: :development
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -48,11 +69,11 @@ dependencies:
         - 2
         version: 0.9.2.2
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: barista
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -62,7 +83,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 description: Some helper methods to perform standard JS library tasks from js.erb without having to write actual javascript
 email: 
 - stexmedia@googlemail.com
@@ -79,16 +100,12 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/coffeescripts/rjs_helper.coffee
+- app/assets/javascripts/rjs_helpers.coffee
 - app/helpers/rjs_helper.rb
-- generators/rjs_helpers/rjs_helpers_generator.rb
-- generators/rjs_helpers/templates/assets/js/rjs_helper.js
-- init.rb
 - install.rb
 - lib/rjs_helpers.rb
+- lib/rjs_helpers/engine.rb
 - lib/rjs_helpers/version.rb
-- lib/tasks/rjs_helpers.rake
-- rails/init.rb
 - rjs_helpers.gemspec
 - test/rjs_helpers_test.rb
 - test/test_helper.rb
@@ -122,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.22
 signing_key: 
 specification_version: 3
 summary: Some helper methods to perform standard JS library tasks from js.erb without having to write actual javascript

data/generators/rjs_helpers/rjs_helpers_generator.rb

@@ -1,13 +0,0 @@
-class RjsHelpersGenerator < Rails::Generator::NamedBase
-  def manifest
-    record do |m|
-      m.file File.join('assets', 'js', 'rjs_helper.js'), File.join('public', 'javascripts', 'rjs_helper.js')
-    end
-  end
-
-  protected
-
-  def banner
-    "Usage: #{$0} rjs_helpers js"
-  end
-end

data/generators/rjs_helpers/templates/assets/js/rjs_helper.js

@@ -1,82 +0,0 @@
-// Generated by CoffeeScript 1.4.0
-(function() {
-
-  window.rjsHelpers = {
-    updateElement: function(element, content) {
-      return jQuery(element).html(content);
-    },
-    updateElementById: function(element, content) {
-      return this.updateElement("#" + element, content);
-    },
-    replaceElement: function(element, content) {
-      return jQuery(element).replaceWith(content);
-    },
-    replaceElementById: function(element, content) {
-      return this.replaceElement("#" + element, content);
-    },
-    removeElement: function(element) {
-      return jQuery(element).remove();
-    },
-    removeElementById: function(element) {
-      return this.removeElement("#" + element);
-    },
-    appendElement: function(element, content) {
-      return jQuery(element).append(content);
-    },
-    appendElementById: function(element, content) {
-      return this.appendElement("#" + element, content);
-    },
-    prependElement: function(element, content) {
-      return jQuery(element).prepend(content);
-    },
-    prependElementById: function(element, content) {
-      return this.prependElement("#" + element, content);
-    },
-    hideElement: function(element) {
-      return jQuery(element).hide();
-    },
-    hideElementById: function(element) {
-      return this.hideElement("#" + element);
-    },
-    showElement: function(element) {
-      return jQuery(element).show();
-    },
-    showElementById: function(element) {
-      return this.showElement("#" + element);
-    },
-    toggleElement: function(element) {
-      return jQuery(element).toggle();
-    },
-    toggleElementById: function(element) {
-      return this.toggleElement("#" + element);
-    },
-    scrollToElement: function(element, offsetTop) {
-      if (offsetTop == null) {
-        offsetTop = 0;
-      }
-      jQuery('html, body').animate({
-        scrollTop: jQuery(element).offset().top - offsetTop
-      }, 1000);
-      return false;
-    },
-    scrollToElementById: function(element, offsetTop) {
-      if (offsetTop == null) {
-        offsetTop = 0;
-      }
-      return this.scrollToElement("#" + element, offsetTop);
-    },
-    scrollToTop: function(offsetTop) {
-      if (offsetTop == null) {
-        offsetTop = 0;
-      }
-      jQuery("html, body").animate({
-        scrollTop: offsetTop
-      }, 600);
-      return false;
-    },
-    redirectTo: function(url) {
-      return window.location.href = url;
-    }
-  };
-
-}).call(this);

data/init.rb

@@ -1 +0,0 @@
-require File.dirname(__FILE__) + '/rails/init'

data/lib/tasks/rjs_helpers.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :rails_js_helpers do
-#   # Task goes here
-# end

data/rails/init.rb

@@ -1,4 +0,0 @@
-#Automatically include the js_erb helper in each controller
-ActionController::Base.class_eval do
-  helper :rjs
-end