rjs_helpers 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rjs_helpers.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stefan Exner
+
+MIT License
+
+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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 [name of plugin creator]
+
+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/README.md

@@ -0,0 +1,138 @@
+RJS Helpers
+==============
+
+Some helper methods to perform standard JS library tasks from js.erb without having to write actual javascript
+
+Installation
+============
+
+To install the plugin in your Rails 2.3 application, simply run
+
+    ruby script/plugin install https://github.com/Stex/rjs_helpers.git
+    
+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:
+
+    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.
+
+Usage
+=====
+
+The plugin consists of two parts:
+
+1. A Rails helper which is available in application views
+2. A JS helper library which has to be included into your application scripts / layout
+
+The JS file which is part of this plugin uses jQuery to perform its tasks.
+If your application is using a different framework, feel free to write an 
+own adapter for it.
+
+The Rails helper does not directly generate code for just one library, as jQuery might
+not be used for all applications. Instead, it will generate calls to an own API which can be
+found in the included javascript file.
+
+Available Functions
+===================
+
+Update, Replace, Append, Prepend
+--------------------------------
+
+These content update functions always take a selector element and the new content.
+
+The selector element may either be a string/symbol which is passed directly to the JS function
+or something the `dom_id()` function would take as well (an instance of ActiveRecord or an Array).
+
+The content may either be a string containing the new content or options for the 
+ActionView `render()` method.
+
+    js_update_element(element, content)
+    
+Updates the given element with the given content
+
+    js_replace_element(element, content)
+    
+Replaces the given element with the new content
+
+    js_append_element_to(element, content)
+    
+Appends the given content to the given container element
+
+    js_prepend_element_to(element, content)
+    
+Like `append`, but at the top of the container element
+
+
+Removing DOM elements
+---------------------
+
+    js_remove_element(element)
+    
+Removes the given element from the DOM.
+
+
+Show, Hide and Toggle
+---------------------
+
+    js_show_element(element)
+    
+Shows the given element, by default with `.show()`
+
+    js_hide_element(element)
+    
+Hides the given element, by default with `.hide()`
+
+    js_toggle_element(element)
+    
+Toggles the given element, by default with `.toggle()`
+
+
+Various Actions
+---------------
+
+    js_redirect_to(url)
+
+Performs a javascript redirect to the given URL. 
+The argument may be everything that the `url_for()` function would accept, e.g. `[:admin, :users]` or `"http://www.google.com"`
+
+    js_scroll_to(element, offset_top = 0)
+    
+Scrolls to the given element on the page.
+The optional second parameter can be used to set a top offset. This is e.g. useful
+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', ...)
+#=> jQuery('#user_123').html(...)
+
+= js_update_element [@user, :emails], :partial => 'emails'
+#=> rjsHelpers.updateElementByDomId('emails_user_123', ...)
+#=> jQuery('#emails_user_123').html(...)
+
+= js_hide_element '#myContainer'
+#=> rjsHelpers.hideElement('#myContainer')
+#=> jQuery('#myContainer').hide()
+
+= js_replace_element '#willBeOverridden', 'And now for something completely different'
+#=> rjsHelpers.replaceElement('#willBeOverridden', 'And now for something completely different')
+#=> jQuery('#willBeOverridden').replaceWith('And now for something completely different')
+```
+
+Copyright (c) 2013 Stex, released under the MIT license

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+desc "Compiles the plugin's coffeescript to a js file"
+task :make do |t|
+  input_files = ['./app/coffeescripts/']
+  output_directory = './generators/rjs_helpers/templates/assets/js'
+
+  input_files.each do |file|
+    `coffee -l -c -o #{output_directory} #{file}`
+  end
+end

data/app/coffeescripts/rjs_helper.coffee

@@ -0,0 +1,100 @@
+#This file contains different helpers for js.erb files throughout the application.
+#Using this methods allows us to be able to replace the underlying js framework
+
+window.rjsHelpers =
+
+  #----------------------------------------------------------------
+  #                  Update / Replace Elements
+  #----------------------------------------------------------------
+
+  updateElement: (element, content) ->
+    jQuery(element).html(content)
+
+  updateElementById: (element, content) ->
+    @.updateElement("##{element}", content)
+
+  replaceElement: (element, content) ->
+    jQuery(element).replaceWith(content)
+
+  replaceElementById: (element, content) ->
+    @.replaceElement("##{element}", content)
+
+
+  #----------------------------------------------------------------
+  #                        Remove Elements
+  #----------------------------------------------------------------
+
+  removeElement: (element) ->
+    jQuery(element).remove()
+
+  removeElementById: (element) ->
+    @.removeElement("##{element}")
+
+  #----------------------------------------------------------------
+  #                        Append / Prepend
+  #----------------------------------------------------------------
+
+  appendElement: (element, content) ->
+    jQuery(element).append(content)
+
+  appendElementById: (element, content) ->
+    @.appendElement("##{element}", content)
+
+  prependElement: (element, content) ->
+    jQuery(element).prepend(content)
+
+  prependElementById: (element, content) ->
+    @.prependElement("##{element}", content)
+
+
+  #----------------------------------------------------------------
+  #                        Show / Hide
+  #----------------------------------------------------------------
+
+  hideElement: (element) ->
+    jQuery(element).hide()
+
+  hideElementById: (element) ->
+    @.hideElement("##{element}")
+
+  showElement: (element) ->
+    jQuery(element).show()
+
+  showElementById: (element) ->
+    @.showElement("##{element}")
+
+  toggleElement: (element) ->
+    jQuery(element).toggle()
+
+  toggleElementById: (element) ->
+    @.toggleElement("##{element}")
+
+  #----------------------------------------------------------------
+  #                          Scrolling
+  #----------------------------------------------------------------
+
+  scrollToElement: (element, offsetTop) ->
+    offsetTop = 0 unless offsetTop?
+    jQuery('html, body').animate({
+      scrollTop: jQuery(element).offset().top - offsetTop
+    }, 1000)
+    false
+
+  scrollToElementById: (element) ->
+    @.scrollToElement("##{element}")
+
+  scrollToTop: (offsetTop) ->
+    offsetTop = 0 unless offsetTop?
+    jQuery("html, body").animate {scrollTop: offsetTop }, 600
+    false
+
+  #----------------------------------------------------------------
+  #                           Various
+  #----------------------------------------------------------------
+
+  # Redirects to the given URL
+  #--------------------------------------------------------------
+  redirectTo: (url) ->
+    window.location.href = url
+
+

data/app/helpers/rjs_helper.rb

@@ -0,0 +1,145 @@
+module RjsHelper
+  #----------------------------------------------------------------
+  #                    Helpers for js.erb files
+  #     Have a look at app/coffeescripts/rjs_helper.coffee
+  #----------------------------------------------------------------
+
+  # Updates the content of the given selector with the given content
+  #----------------------------------------------------------------------------
+  def js_update_element(element, content)
+    rjs_method :update_element, :element => element, :content => content
+  end
+
+  # Like js_update_element, but with the element's dom_id
+  #----------------------------------------------------------------------------
+  def js_update_element_by_dom_id(element, content)
+    js_update_element(element, content)
+  end
+
+  # Appends the given content to the given element
+  #--------------------------------------------------------------
+  def js_append_element_to(element, content)
+    rjs_method :append_element, :element => element, :content => content
+  end
+
+  # Appends the given content to the given element
+  #--------------------------------------------------------------
+  def js_prepend_element_to(element, content)
+    rjs_method :prepend_element, :element => element, :content => content
+  end
+
+  # Replaces the given selector with the given content
+  #----------------------------------------------------------------------------
+  def js_replace_element(element, content)
+    rjs_method :replace_element, :element => element, :content => content
+  end
+
+  # Like js_replace_element, but with the element's dom_id
+  #----------------------------------------------------------------------------
+  def js_replace_element_by_dom_id(element, content)
+    js_replace_element(element, content)
+  end
+
+  # Removes the given element from the DOM
+  #--------------------------------------------------------------
+  def js_remove_element(element)
+    rjs_method :remove_element, element
+  end
+
+  # Like +js_remove_element+, but with the element's dom_id
+  #--------------------------------------------------------------
+  def js_remove_element_by_dom_id(element)
+    js_remove_element(element)
+  end
+
+  # Redirects the user to the given URL using javascript
+  #--------------------------------------------------------------
+  def js_redirect_to(url)
+    rjs_method :redirect_to, url_for(url)
+  end
+
+  #----------------------------------------------------------------
+  #                       Show / Hide / Toggle
+  #----------------------------------------------------------------
+
+  def js_show_element(element)
+    rjs_method :show_element, element
+  end
+
+  def js_hide_element(element)
+    rjs_method :hide_element, element
+  end
+
+  def js_show_element_by_dom_id(element)
+    js_show_element(element)
+  end
+
+  def js_hide_element_by_dom_id(element)
+    js_hide_element(element)
+  end
+
+  def js_toggle_element(element)
+    rjs_method :toggle_element, element
+  end
+
+  #----------------------------------------------------------------
+  #                        Other GUI Actions
+  #----------------------------------------------------------------
+
+  # Scrolls to the given element on the page.
+  # If the symbol +:top+ is given, the page will scroll to
+  # top without having to specify a certain element
+  #
+  # Additionally, an offset can be given as the second parameter.
+  # This is e.g. useful in cases of layouts with a fixed top navbar.
+  #--------------------------------------------------------------
+  def js_scroll_to(element, offset_top = 0)
+    if element == :top
+      rjs_method :scroll_to_top, offset_top
+    else
+      rjs_method :scroll_to_element, :element => element, :args => [offset_top]
+    end
+  end
+
+  private
+
+  def rjs_method(func, element_or_options = {})
+    if element_or_options.is_a?(Hash)
+      element = element_or_options.delete(:element)
+      content = element_or_options.delete(:content)
+      args    = element_or_options.delete(:args) || []
+    else
+      element = element_or_options
+      content = nil
+      args    = []
+    end
+
+    if element.is_a?(ActiveRecord::Base) || element.is_a?(Array)
+      elem = dom_id(*Array(element))
+      js_function = "#{func}_by_id".camelize(:lower)
+    else
+      elem = element.to_s
+      js_function = func.to_s.camelize(:lower)
+    end
+    js_args = []
+    js_args << elem if elem
+    js_args << rendered_content(content) if content
+    js_args += args
+
+    %{rjsHelpers.#{js_function}(#{string_args(js_args)});}
+  end
+
+  def string_args(args)
+    args.map {|a| a.is_a?(Numeric) ? a : "'#{a}'"}.join(', ')
+  end
+
+
+  # Processes the given content.
+  # Strings are simply forwarded while Hashes
+  # are passed to Rails' +render+ function.
+  # Also, it automatically escapes javascript in the given content
+  #--------------------------------------------------------------
+  def rendered_content(content)
+    escape_javascript(content.is_a?(Hash) ? render(content) : content)
+  end
+end

data/generators/rjs_helpers/rjs_helpers_generator.rb

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,79 @@
+// Generated by CoffeeScript 1.3.3
+(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) {
+      return this.scrollToElement("#" + element);
+    },
+    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

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

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/rjs_helpers/version.rb

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

data/lib/rjs_helpers.rb

@@ -0,0 +1 @@
+# RailsJsHelpers

data/lib/tasks/rjs_helpers.rake

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

data/rails/init.rb

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

data/rjs_helpers.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rjs_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rjs_helpers'
+  spec.version       = RjsHelpers::VERSION
+  spec.authors       = ['Stefan Exner']
+  spec.email         = ['stexmedia@googlemail.com']
+  spec.description   = %q{Some helper methods to perform standard JS library tasks from js.erb without having to write actual javascript}
+  spec.summary       = %q{Some helper methods to perform standard JS library tasks from js.erb without having to write actual javascript}
+  spec.homepage      = 'https://github.com/Stex/rjs_helpers'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '0.9.2.2'
+  spec.add_development_dependency 'barista'
+end

data/test/rjs_helpers_test.rb

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

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification 
+name: rjs_helpers
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Stefan Exner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-09-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 9
+        - 2
+        - 2
+        version: 0.9.2.2
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: barista
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Some helper methods to perform standard JS library tasks from js.erb without having to write actual javascript
+email: 
+- stexmedia@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/coffeescripts/rjs_helper.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/version.rb
+- lib/tasks/rjs_helpers.rake
+- rails/init.rb
+- rjs_helpers.gemspec
+- test/rjs_helpers_test.rb
+- test/test_helper.rb
+- uninstall.rb
+homepage: https://github.com/Stex/rjs_helpers
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.26
+signing_key: 
+specification_version: 3
+summary: Some helper methods to perform standard JS library tasks from js.erb without having to write actual javascript
+test_files: 
+- test/rjs_helpers_test.rb
+- test/test_helper.rb