RubyGems - rails_document_ready - Versions diffs - 1.0.1 - Mend

rails_document_ready 1.0.1

Files changed (12) hide show

data/MIT-LICENSE +20 -0
data/README.rdoc +48 -0
data/Rakefile +25 -0
data/app/assets/javascripts/rails_document_ready.js +1 -0
data/app/assets/javascripts/rails_document_ready/rails_document_ready.coffee +9 -0
data/app/helpers/rails_document_ready_helper.rb +5 -0
data/config/routes.rb +2 -0
data/lib/rails_document_ready.rb +4 -0
data/lib/rails_document_ready/engine.rb +7 -0
data/lib/rails_document_ready/version.rb +3 -0
data/lib/tasks/rails_document_ready_tasks.rake +4 -0
metadata +96 -0

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+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.rdoc ADDED Viewed

@@ -0,0 +1,48 @@
+= RailsDocumentReady
+In the asset pipeline in Rails, each of the Javascript files are meshed into one big file. If you project relies a lot
+on Javascript, you may find that you have a lot of $(document).ready functions which will all fire on every page load.
+A lot of these are probably harmless as they will probably use jQuery to find elements that don't exist and therefore
+have no effect. But in bigger projects you are eventually going to run into one of these scripts doing something unexpected.
+This gem has two very small parts. One is a helper to insert in the <body> tag of each page which specifies the controller
+and action for the current page. The second uses a very simple $(document).ready script to read these tags and look for a
+jQuery class that matches the naming and execute a function named after the action. This should be made a little clearer
+in the following example.
+== Installation
+It's a gem, add this to your Gemfile:
+    gem 'rails_document_ready'
+=== View Configuration
+This gem uses data tags to detect the current controller and action. You need to modify your body tag to look like this:
+    <body <%= rails_document_ready_tags %>>
+=== Asset Configuration
+Add the following to your application.js
+    //= require rails_document_ready
+That's it for the setup.
+== Example
+For some unknown reason, we want to pop up with an alert saying "Hello" every time the HomeController renders the index action and "Goodbye" when it renders
+the show action. In our /app/assets/javascripts/home.coffee we can put:
+    class @HomeReady
+      @index: ->
+        alert("Hello")
+      @show: ->
+        alert("Goodbye")
+== Namespaces
+The controller name generated includes any namespacing of the controllers to prevent collisions. You can always see the expected name of your class by looking at
+the generated body tag from your application and adding "Ready" to the end of it.Eg admin/home_controller.rb will likely end up with a class name of AdminHomeReady.

data/Rakefile ADDED Viewed

@@ -0,0 +1,25 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsDocumentReady'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+Bundler::GemHelper.install_tasks
+task :default => :build

data/app/assets/javascripts/rails_document_ready.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ //= require rails_document_ready/rails_document_ready

data/app/assets/javascripts/rails_document_ready/rails_document_ready.coffee ADDED Viewed

@@ -0,0 +1,9 @@
+$(document).ready(->
+  controller = $("body").data("controller")
+  return unless controller
+  action = $("body").data("action")
+  jsController = "#{controller}Ready"
+  if "function" == typeof window[jsController]
+    if "function" == typeof window[jsController][action]
+      window[jsController][action]()
+)

data/app/helpers/rails_document_ready_helper.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module RailsDocumentReadyHelper
+  def rails_document_ready_tags
+    "data-controller=#{controller_path.gsub(/\//, '_').camelize} data-action=#{action_name}"
+  end
+end

data/config/routes.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ Rails.application.routes.draw do
2	+ end

data/lib/rails_document_ready.rb ADDED Viewed

@@ -0,0 +1,4 @@
+require "rails_document_ready/engine"
+module RailsDocumentReady
+end

data/lib/rails_document_ready/engine.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module RailsDocumentReady
+  class Engine < ::Rails::Engine
+    initializer "RailsDocumentReady" do
+      ActionView::Base.send :include, RailsDocumentReadyHelper
+    end
+  end
+end

data/lib/rails_document_ready/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module RailsDocumentReady
+  VERSION = "1.0.1"
+end

data/lib/tasks/rails_document_ready_tasks.rake ADDED Viewed

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

metadata ADDED Viewed

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rails_document_ready
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease:
+platform: ruby
+authors:
+- David Monagle
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple way to have per controller and per action methods called on
+  document ready when using the asset pipeline.
+email:
+- david.monagle@intrica.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/rails_document_ready/rails_document_ready.coffee
+- app/assets/javascripts/rails_document_ready.js
+- app/helpers/rails_document_ready_helper.rb
+- config/routes.rb
+- lib/rails_document_ready/engine.rb
+- lib/rails_document_ready/version.rb
+- lib/rails_document_ready.rb
+- lib/tasks/rails_document_ready_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/intrica/twitter_bootstrap_helper
+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'
+      segments:
+      - 0
+      hash: 4343976524517282365
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4343976524517282365
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: A simple way to have per controller and per action methods called on document
+  ready when using the asset pipeline.
+test_files: []