js_namespace_framework 2.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [Brent Greeff]
+
+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

@@ -0,0 +1,83 @@
+= Js::Namespace::Framework
+
+== Use the power of Rails to namespace your JavaScript.
+
+* Add
+
+      <%= init_javascript if requires_javascript? %>
+
+to the bottom of your layout.
+
+When you need some JS Love on a page
+Lets say
+
+      :controller => 'messages', :action => 'show'
+
+* simply define the following method in the messages_helper.rb
+
+      def requires_javascript?
+        return true if action_is? 'show'
+      end
+
+* This will generate the following namespaced call.
+
+      SiteName.controller.action_page();
+
+* In this case
+
+      SiteName.messages.show_page();
+
+* Then just define your namespace and method
+
+      SiteName = {}
+      
+      SiteName.messages = {
+        
+        show_page: function() {
+          SiteName.awesomeness.activate();
+        }
+      }
+
+
+* If you need some more progressive enhancement on messages.index
+* In the messages_helper.rb
+
+      def requires_javascript?
+        return true if action_is? 'show', 'index'
+      end
+
+
+* In a Js file
+
+      SiteName = {}
+      
+      SiteName.messages = {
+        
+        show_page: function() {
+          SiteName.awesomeness.activate();
+        },
+        
+        index_page: function() {
+          SiteName.progressively.enhance();
+        }
+      }
+
+
+I would recommend creating one Js file per controller
+to keep things nice and neat and using Asset Packager
+to pack everything together for production.
+
+
+== INSTALL
+
+braid add (this) -p
+
+get braid if you do not have it.
+
+
+* Define
+      SITE_NAME
+somewhere
+
+
+Copyright (c) 2009 [Brent Greeff], released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the js_namespace_framework plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the js_namespace_framework plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'JsNamespaceFramework'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+2.0.0

data/lib/js_namespace_framework.rb

@@ -0,0 +1,3 @@
+require 'js_namespace_framework/helper_methods'
+
+ActionView::Base.send :include, Js::Namespace::Framework

data/lib/js_namespace_framework/helper_methods.rb

@@ -0,0 +1,35 @@
+module Js
+  module Namespace
+    module Framework
+      
+      def init_javascript
+        unless defined? SITE_NAME
+          raise Js::Namespace::Framework::Setup::Error, 'Please define SITE_NAME'
+        end
+        
+        action = params[:action]
+        action = 'new' if params[:action].eql? 'create'
+        action = 'edit' if params[:action].eql? 'update'
+        
+        javascript_tag("#{SITE_NAME}.#{params[:controller]}.#{action}_page();")
+      end
+      
+      def requires_javascript?
+        false
+      end
+      
+      def action_is?(*args)
+        return true if args.include? params[:action]
+        
+        return true if args.include? 'new' and params[:action].eql? 'create'
+        return true if args.include? 'edit' and params[:action].eql? 'update'
+        
+        return false
+      end
+      
+      module Setup
+        class Error < RuntimeError; end
+      end
+    end
+  end
+end

data/test/js_namespace_framework_test.rb

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

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: js_namespace_framework
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
+platform: ruby
+authors: 
+- Brent Greeff
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-30 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Use the power of Rails to namespace your JavaScript.
+email: email@brentgreeff.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/js_namespace_framework.rb
+- lib/js_namespace_framework/helper_methods.rb
+- test/js_namespace_framework_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/brentgreeff/js_namespace_framework
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Use the power of Rails to namespace your JavaScript.
+test_files: []
+