javascript_util_asset_pack 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,52 @@
+== Rails 3.1 javascript - Util asset pack
+
+== Sets up a window.Util object which includes
+
+* Spinner, with methods to set spinner next to element or hide the spinner
+* AjaxForm, to ajax enable simple forms
+* jQuery ajaxError global handler, exception data during development and friendly message in production
+
+== Usage
+
+spinner (js version)
+
+    window.Util.spinner.nextTo('#my_button'); 
+    window.Util.spinner.nextTo('#my_button', 3, 4); // selector, top offset, left offset
+    window.Util.spinner.hide();
+    
+ajax form (coffee script version)
+
+    jQuery ->
+        new window.Util.AjaxForm '#my_form', -> 
+            log "my_form submit success callback"
+
+== Install
+
+Update the Gemfile in your rails project, add the following line
+
+    gem 'javascript_util_asset_pack'
+
+Run the generator
+
+    rails generate javascript_util_asset_pack
+    
+does the following:
+
+* Copy spinner.gif to /app/assets/images
+* Update application.html.erb adding javascript create window.Rails.env variable
+* Update application.html.erb adding image_tag for spinner.gif
+* Update application.js adding util_pack
+
+== Coming Soon
+
+* configuration object so text in ajaxError can be overridden 
+
+== Resources
+
+* spinner.gif generated using http://www.ajaxload.info
+
+== License
+
+The Unlicense (aka: public domain)
+http://unlicense.org
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/javascript_util_asset_pack.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "javascript_util_asset_pack/version"
+
+Gem::Specification.new do |s|
+  s.name        = "javascript_util_asset_pack"
+  s.version     = JavascriptUtilAssetPack::VERSION
+  s.authors     = ["Jesse House"]
+  s.email       = ["jesse.house@gmail.com"]
+  s.homepage    = "https://github.com/house9/javascript_util_asset_pack"
+  s.summary     = %q{
+    Rails 3.1 javascript Util asset pack, show hide spinner, global jquery error handler, etc...
+  }
+  s.description = File.open('README.rdoc') { |f| f.read }
+
+  s.rubyforge_project = "javascript_util_asset_pack"
+  
+  s.add_dependency 'rails', '~> 3.1.0.rc'  
+  s.add_dependency 'javascript_safe_logger', '~> 0.0.3'  
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/generators/javascript_util_asset_pack/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate javascript_util_asset_pack 
+
+    This will create:
+        what/will/it/create

data/lib/generators/javascript_util_asset_pack/javascript_util_asset_pack_generator.rb

@@ -0,0 +1,37 @@
+class JavascriptUtilAssetPackGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  
+  def manifest
+    copy_spinner_gif
+    update_layout_add_spinner
+    update_layout_add_rails_env_to_js
+    update_application_js
+  end
+  
+  private 
+  
+  def update_application_js
+    inject_into_file "app/assets/javascripts/application.js", "//= require util_pack\n", :before => "//= require_tree .\n", 
+  end  
+  
+  def copy_spinner_gif
+    copy_file 'spinner.gif', 'app/assets/images/spinner.gif'
+  end
+  
+  def update_layout_add_spinner
+    inject_into_file "app/views/layouts/application.html.erb", :before => "</body>\n" do
+      "    <%= image_tag 'spinner.gif', :alt => 'Spinner Icon', :id => 'spinner', :style => 'display:none' %>\n"
+    end
+  end
+  
+  def update_layout_add_rails_env_to_js
+    inject_into_file "app/views/layouts/application.html.erb", :before => "</head>\n" do
+<<-CONTENT
+    <script>
+      window.Rails = window.Rails || {};
+      window.Rails.env = "<%= Rails.env.upcase %>"; 
+    </script>
+CONTENT
+    end
+  end
+end

data/lib/javascript_util_asset_pack.rb

@@ -0,0 +1,3 @@
+module JavascriptUtilAssetPack
+  require 'javascript_util_asset_pack/engine'
+end

data/lib/javascript_util_asset_pack/engine.rb

@@ -0,0 +1,5 @@
+module JavascriptUtilAssetPack
+  class Engine < Rails::Engine
+    # auto-wire to rails host
+  end
+end

data/lib/javascript_util_asset_pack/version.rb

@@ -0,0 +1,3 @@
+module JavascriptUtilAssetPack
+  VERSION = "0.0.2"
+end

data/vendor/assets/javascripts/util_pack/ajax_form.coffee

@@ -0,0 +1,15 @@
+class AjaxForm
+  constructor: (selector, callback = null) ->
+    $(selector).submit (e) ->
+      e.preventDefault()
+      form = this
+      success = if callback? then callback else () -> log "no success callback"
+
+      $.ajax $(form).attr('action'), 
+        type: "POST"
+        data: $(form).serialize() 
+        success: success
+
+window.Util ?= {}
+window.Util.AjaxForm = AjaxForm
+

data/vendor/assets/javascripts/util_pack/index.js

@@ -0,0 +1,3 @@
+//= require ./spinner
+//= require ./ajax_form
+//= require ./jquery_ajax_error

data/vendor/assets/javascripts/util_pack/jquery_ajax_error.coffee

@@ -0,0 +1,33 @@
+jQuery(document).ajaxError (event, xhr, settings, exception) ->
+  baseMessage = "Error: "
+  friendly = baseMessage
+  local = "#{baseMessage}#{xhr.status}, #{xhr.statusText} #{exception}\n#{settings.url}"
+  
+  if xhr.status is 404
+    friendly = "#{friendly}Page not found"
+  else
+    friendly = "#{friendly}an exception has occurred\nPlease try again"
+
+  window.Util.spinner.hide()
+
+  if window.Rails?.env is "DEVELOPMENT"
+    contentType = xhr.getResponseHeader("content-type")
+    if contentType.indexOf('html') > -1
+      body = "<div>#{xhr.responseText}</div>"      
+      fragment = $(body).find "h1"
+      local = "#{local} \n#{fragment.text()}"
+      fragment = $(body).find "pre"
+      
+      if fragment.length > 0
+        fragment.each () -> local = "#{local}\n#{$(this).text()}"
+
+    else
+      # json, text, xml, etc... add specific parsing later if needed
+      local = "#{local}"
+  
+    lengthOfVisibleErrorMessage = if local.length > 350 then 350 else local.length
+    message = local.substring(0, lengthOfVisibleErrorMessage)
+    alert "#{message}...\n\n  - Check browser console for more info.\n  - This message for development only."
+
+  else
+    alert friendly

data/vendor/assets/javascripts/util_pack/spinner.coffee

@@ -0,0 +1,31 @@
+class Spinner
+  constructor: (spinnerId) ->
+    @spinnerId = spinnerId
+
+  hide: () ->
+    jQuery(@spinnerId).hide()    
+
+  nextTo: (controlID, topOffset = 0, leftOffset = 14) ->
+    if controlID?
+      $control = jQuery(controlID)
+      return null if $control.length is 0
+
+      offset = $control.offset()
+      top = parseInt(offset.top + topOffset)
+      left = parseInt(offset.left + leftOffset + $control.width())
+
+      # sometimes things are not what they seem, use the parent coordinates if needed
+      if left < 0
+        left = jQuery(controlID).parent().offset().left + leftOffset
+        
+      # show spinner
+      jQuery(@spinnerId)
+        .css('position', 'absolute')
+        .css('top', "#{top}px")
+        .css('left', "#{left}px  ")
+        .show()
+        .css('z-index', 33010)
+
+window.Util ?= {}
+window.Util.spinner = new Spinner('#spinner')
+

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: javascript_util_asset_pack
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Jesse House
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.1.0.rc
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: javascript_safe_logger
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.0.3
+  type: :runtime
+  version_requirements: *id002
+description: |+
+  == Rails 3.1 javascript - Util asset pack
+  
+  == Sets up a window.Util object which includes
+  
+  * Spinner, with methods to set spinner next to element or hide the spinner
+  * AjaxForm, to ajax enable simple forms
+  * jQuery ajaxError global handler, exception data during development and friendly message in production
+  
+  == Usage
+  
+  spinner (js version)
+  
+      window.Util.spinner.nextTo('#my_button'); 
+      window.Util.spinner.nextTo('#my_button', 3, 4); // selector, top offset, left offset
+      window.Util.spinner.hide();
+      
+  ajax form (coffee script version)
+  
+      jQuery ->
+          new window.Util.AjaxForm '#my_form', -> 
+              log "my_form submit success callback"
+  
+  == Install
+  
+  Update the Gemfile in your rails project, add the following line
+  
+      gem 'javascript_util_asset_pack'
+  
+  Run the generator
+  
+      rails generate javascript_util_asset_pack
+      
+  does the following:
+  
+  * Copy spinner.gif to /app/assets/images
+  * Update application.html.erb adding javascript create window.Rails.env variable
+  * Update application.html.erb adding image_tag for spinner.gif
+  * Update application.js adding util_pack
+  
+  == Coming Soon
+  
+  * configuration object so text in ajaxError can be overridden 
+  
+  == Resources
+  
+  * spinner.gif generated using http://www.ajaxload.info
+  
+  == License
+  
+  The Unlicense (aka: public domain)
+  http://unlicense.org
+  
+email: 
+- jesse.house@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- javascript_util_asset_pack.gemspec
+- lib/generators/javascript_util_asset_pack/USAGE
+- lib/generators/javascript_util_asset_pack/javascript_util_asset_pack_generator.rb
+- lib/generators/javascript_util_asset_pack/templates/spinner.gif
+- lib/javascript_util_asset_pack.rb
+- lib/javascript_util_asset_pack/engine.rb
+- lib/javascript_util_asset_pack/version.rb
+- vendor/assets/javascripts/util_pack/ajax_form.coffee
+- vendor/assets/javascripts/util_pack/index.js
+- vendor/assets/javascripts/util_pack/jquery_ajax_error.coffee
+- vendor/assets/javascripts/util_pack/spinner.coffee
+homepage: https://github.com/house9/javascript_util_asset_pack
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: javascript_util_asset_pack
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Rails 3.1 javascript Util asset pack, show hide spinner, global jquery error handler, etc...
+test_files: []
+