page_specific_js 0.0.2

data/spec/javascripts/page_specific_spec.js

@@ -0,0 +1,160 @@
+DummyAppWithoutPageSpecific = {};
+
+DummyAppWithoutAllControllers = {
+  PageSpecific: {
+  }
+};
+
+DummyAppWithAllControllers = {
+  PageSpecific: {
+    AllControllers: {
+    }
+  }
+};
+
+DummyApplication = {
+  PageSpecific: {
+    AllControllers: {
+      allActions: function() {},
+      someactionAction: function() {}
+    },
+    TestOneController: {
+      // This controller-specific class has neither allActions nor an action-specifc method
+    },
+    TestTwoController: {
+      // This controller has both allActions and an action-specific method
+      allActions: function() {},
+      someactionAction: function() {
+        console.debug('someactionAction was called');
+      }
+    }
+  }
+};
+
+describe("PageSpecific", function() {
+  var $appClassToTest;
+
+  describe(".init", function() {
+
+    describe("for an app that doesn't have a PageSpecific class", function() {
+      beforeEach(function() {
+        appClassToTest = DummyAppWithoutPageSpecific;
+      });
+
+      it("should not throw an exception", function() {
+        expect(function() {
+          PageSpecific.init(appClassToTest);
+        }).not.toThrow();
+      });
+    });
+
+    describe("for an app that doesn't have AllControllers", function() {
+      beforeEach(function() {
+        appClassToTest = DummyAppWithoutAllControllers;
+      });
+
+      it("should not throw an exception", function() {
+        expect(function() {
+          PageSpecific.init(appClassToTest);
+        }).not.toThrow();
+      });
+    });
+
+    describe("for an app that does have AllControllers", function() {
+      beforeEach(function() {
+        appClassToTest = DummyAppWithAllControllers;
+      });
+
+      describe("for an app that doesn't have AllControllers.allActions or a AllControllers.<current action>Action method", function() {
+        beforeEach(function() {
+          $('body').attr('data-controller_name', 'irrelevant_controller');
+          $('body').attr('data-action_name', 'someaction');
+        });
+
+        it("should not throw an exception", function() {
+          expect(function() {
+            PageSpecific.init(appClassToTest);
+          }).not.toThrow();
+        });
+      });
+
+      describe("for an app that does have AllControllers.allActions and a AllControllers.<current action>Action method", function() {
+        beforeEach(function() {
+          appClassToTest = DummyApplication;
+        });
+
+        it("should invoke App.PageSpecific.AllControllers.allActions method", function() {
+          spyOn(DummyApplication.PageSpecific.AllControllers, 'allActions');
+          PageSpecific.init(appClassToTest);
+          expect(DummyApplication.PageSpecific.AllControllers.allActions).toHaveBeenCalled();
+        });
+
+        it("should invoke App.PageSpecific.AllControllers.<currentaction>Action", function() {
+          spyOn(DummyApplication.PageSpecific.AllControllers, 'someactionAction');
+          PageSpecific.init(appClassToTest);
+          expect(DummyApplication.PageSpecific.AllControllers.someactionAction).toHaveBeenCalled();
+        });
+      });
+    });
+  });
+
+  describe("for a page whose body doesn't have data-controller_name or data-action_name attributes", function() {
+    it("should not throw an exception", function() {
+      expect(function() {
+        PageSpecific.init(DummyApplication);
+      }).not.toThrow();
+    });
+  });
+
+  describe("if there is no controller-specific class for this controller", function() {
+    beforeEach(function() {
+      $('body').attr('data-controller_name', 'missing_controller');
+      $('body').attr('data-action_name', 'someaction');
+    });
+
+    it("should not throw an exception", function() {
+      expect(function() {
+        PageSpecific.init(DummyApplication);
+      }).not.toThrow();
+    });
+  });
+
+  describe("if the controller-specific class does not have an all-actions method or action-specifc method", function() {
+    beforeEach(function() {
+      $('body').attr('data-controller_name', 'test_one_controller');
+      $('body').attr('data-action_name', 'someaction');
+    });
+
+    it("should not throw an exception", function() {
+      expect(function() {
+        PageSpecific.init(DummyApplication);
+      }).not.toThrow();
+    });
+  });
+
+  describe("if the controller-specific class has an all-actions method", function() {
+    beforeEach(function() {
+      $('body').attr('data-controller_name', 'test_two_controller');
+      $('body').attr('data-action_name', 'someaction');
+    });
+
+    it("should call the controller-specific AllActions method", function() {
+      spyOn(DummyApplication.PageSpecific.TestTwoController, 'allActions');
+      PageSpecific.init(DummyApplication);
+      expect(DummyApplication.PageSpecific.TestTwoController.allActions).toHaveBeenCalled();
+    });
+  });
+
+  describe("if the controller-specific class has an action method for this action", function() {
+    beforeEach(function() {
+      $('body').attr('data-controller_name', 'test_two_controller');
+      $('body').attr('data-action_name', 'someaction');
+    });
+
+    it("should call the controller+action specific method", function() {
+      spyOn(DummyApplication.PageSpecific.TestTwoController, 'someactionAction');
+      PageSpecific.init(DummyApplication);
+      expect(DummyApplication.PageSpecific.TestTwoController.someactionAction).toHaveBeenCalled();
+    });
+  });
+});

data/spec/javascripts/support/jasmine.yml

@@ -0,0 +1,76 @@
+# src_files
+#
+# Return an array of filepaths relative to src_dir to include before jasmine specs.
+# Default: []
+#
+# EXAMPLE:
+#
+# src_files:
+#   - lib/source1.js
+#   - lib/source2.js
+#   - dist/**/*.js
+#
+src_files:
+  - vendor/assets/javascripts/page_specific.js
+
+# stylesheets
+#
+# Return an array of stylesheet filepaths relative to src_dir to include before jasmine specs.
+# Default: []
+#
+# EXAMPLE:
+#
+# stylesheets:
+#   - css/style.css
+#   - stylesheets/*.css
+#
+stylesheets:
+  - stylesheets/**/*.css
+
+# helpers
+#
+# Return an array of filepaths relative to spec_dir to include before jasmine specs.
+# Default: ["helpers/**/*.js"]
+#
+# EXAMPLE:
+#
+# helpers:
+#   - helpers/**/*.js
+#
+helpers:
+  - helpers/**/*.js
+
+# spec_files
+#
+# Return an array of filepaths relative to spec_dir to include.
+# Default: ["**/*[sS]pec.js"]
+#
+# EXAMPLE:
+#
+# spec_files:
+#   - **/*[sS]pec.js
+#
+spec_files:
+  - '**/*[sS]pec.js'
+
+# src_dir
+#
+# Source directory path. Your src_files must be returned relative to this path. Will use root if left blank.
+# Default: project root
+#
+# EXAMPLE:
+#
+# src_dir: public
+#
+src_dir:
+
+# spec_dir
+#
+# Spec directory path. Your spec_files must be returned relative to this path.
+# Default: spec/javascripts
+#
+# EXAMPLE:
+#
+# spec_dir: spec/javascripts
+#
+spec_dir: spec/javascripts

data/spec/javascripts/support/jasmine_config.rb

@@ -0,0 +1,23 @@
+module Jasmine
+  class Config
+
+    # Add your overrides or custom config code here
+
+  end
+end
+
+
+# Note - this is necessary for rspec2, which has removed the backtrace
+module Jasmine
+  class SpecBuilder
+    def declare_spec(parent, spec)
+      me = self
+      example_name = spec["name"]
+      @spec_ids << spec["id"]
+      backtrace = @example_locations[parent.description + " " + example_name]
+      parent.it example_name, {} do
+        me.report_spec(spec["id"])
+      end
+    end
+  end
+end

data/spec/javascripts/support/jasmine_runner.rb

@@ -0,0 +1,32 @@
+$:.unshift(ENV['JASMINE_GEM_PATH']) if ENV['JASMINE_GEM_PATH'] # for gem testing purposes
+
+require 'rubygems'
+require 'jasmine'
+jasmine_config_overrides = File.expand_path(File.join(File.dirname(__FILE__), 'jasmine_config.rb'))
+require jasmine_config_overrides if File.exist?(jasmine_config_overrides)
+if Jasmine::Dependencies.rspec2?
+  require 'rspec'
+else
+  require 'spec'
+end
+
+jasmine_config = Jasmine::Config.new
+spec_builder = Jasmine::SpecBuilder.new(jasmine_config)
+
+should_stop = false
+
+if Jasmine::Dependencies.rspec2?
+  RSpec.configuration.after(:suite) do
+    spec_builder.stop if should_stop
+  end
+else
+  Spec::Runner.configure do |config|
+    config.after(:suite) do
+      spec_builder.stop if should_stop
+    end
+  end
+end
+
+spec_builder.start
+should_stop = true
+spec_builder.declare_suites

data/vendor/assets/javascripts/page_specific.js

@@ -0,0 +1,72 @@
+/*
+ * This is a page-specific JavaScript framework (primarily for Rails).
+ *
+ * It allows you to target JS to run on all pages, for a specific action on all pages (e.g. index),
+ * for all actions for a specific controller, or for one page (specific controller/action).
+ *
+ * See README file for installation info and examples.
+ */
+
+PageSpecific = {
+
+  init: function(application, debug) {
+    var controllerName = $('body').attr('data-controller_name');
+    var actionName = $('body').attr('data-action_name');
+    var controllerSpecificCodeClassname;
+    var actionMethodName;
+
+    PageSpecific.debugging = debug;
+
+    if (controllerName != undefined) {
+      controllerSpecificCodeClassname = PageSpecific.camelize(controllerName);
+      PageSpecific.debug('controllerSpecificCodeClassname = '+ controllerSpecificCodeClassname);
+    }
+    if (actionName != undefined) {
+      actionMethodName = PageSpecific.camelize(actionName, true) + 'Action';
+      PageSpecific.debug('actionMethodName = '+ actionMethodName);
+    }
+
+    if (application.PageSpecific &&
+        application.PageSpecific.AllControllers) {
+      if (application.PageSpecific.AllControllers.allActions) {
+        PageSpecific.debug('calling AllControllers.allActions');
+        application.PageSpecific.AllControllers.allActions();
+      }
+      if (actionMethodName && application.PageSpecific.AllControllers[actionMethodName]) {
+        application.PageSpecific.AllControllers[actionMethodName]();
+      }
+    }
+
+    if (controllerSpecificCodeClassname && application.PageSpecific[controllerSpecificCodeClassname]) {
+      PageSpecific.debug('detected '+ controllerSpecificCodeClassname);
+      if (application.PageSpecific[controllerSpecificCodeClassname].allActions) {
+        PageSpecific.debug('calling '+ controllerSpecificCodeClassname +'.allActions');
+        application.PageSpecific[controllerSpecificCodeClassname].allActions();
+      }
+
+      if (actionMethodName && application.PageSpecific[controllerSpecificCodeClassname][actionMethodName]) {
+        PageSpecific.debug('calling '+ controllerSpecificCodeClassname + "." + actionMethodName);
+        application.PageSpecific[controllerSpecificCodeClassname][actionMethodName]();
+      }
+    }
+  },
+
+  camelize: function(str, lowerFirstChar) {
+    var newStr = str.replace(/_(.)/g, function(match, firstChar) {
+      return firstChar.toUpperCase();
+    });
+    if (lowerFirstChar) {
+      return newStr;
+    } else {
+      return newStr.replace(/^(.)/, function(match, firstChar) {
+        return firstChar.toUpperCase();
+      });
+    }
+  },
+
+  debug: function(message) {
+    if (PageSpecific.debugging) {
+      console.debug('PageSpecific: ' + message);
+    }
+  }
+};

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: page_specific_js
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Sam Pierson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70329436518100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70329436518100
+- !ruby/object:Gem::Dependency
+  name: jasmine
+  requirement: &70329436527180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70329436527180
+description: ! " It allows you to target JS to run on all pages,\n                      for
+  a particular action on all pages (e.g. index),\n                      for all actions
+  for a specific controller,\n                      or for one specific controller/action
+  (i.e. a single page).\n                    "
+email:
+- sam@sampierson.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- lib/page_specific_js.rb
+- lib/page_specific_js/helper.rb
+- lib/page_specific_js/version.rb
+- page_specific_js.gemspec
+- spec/javascripts/fixtures/.gitkeep
+- spec/javascripts/helpers/jasmine-jquery-1.3.1.js
+- spec/javascripts/helpers/jquery.js
+- spec/javascripts/page_specific_spec.js
+- spec/javascripts/support/jasmine.yml
+- spec/javascripts/support/jasmine_config.rb
+- spec/javascripts/support/jasmine_runner.rb
+- vendor/assets/javascripts/page_specific.js
+homepage: ''
+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: page_specific_js
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Page-specific JavaScript framework for Rails
+test_files:
+- spec/javascripts/fixtures/.gitkeep
+- spec/javascripts/helpers/jasmine-jquery-1.3.1.js
+- spec/javascripts/helpers/jquery.js
+- spec/javascripts/page_specific_spec.js
+- spec/javascripts/support/jasmine.yml
+- spec/javascripts/support/jasmine_config.rb
+- spec/javascripts/support/jasmine_runner.rb