paloma 4.2.1 → 6.1.0

data/vendor/assets/javascripts/paloma/init.js

@@ -18,14 +18,9 @@ else {
   };
 }
 
-$(document).ready(function(){
-  // Do not continue if Paloma not found.
-  if (window['Paloma'] === undefined) {
-    if (window['console'] !== undefined) {
-      console.warn("Paloma not found. Require it in your application.js.");
-    }
-    return true;
-  }
 
-  Paloma.engine.start();
-});
+if ( !window['Paloma'] ){
+  if ( !window['console'] ){
+    console.warn("Paloma not found. Require it in your application.js.");
+  }
+}

data/vendor/assets/javascripts/paloma/paloma.js

@@ -1,30 +1,29 @@
 (function(Paloma){
 
-  Paloma._router = new Paloma.Router('/');
-  Paloma._controllerFactory = new Paloma.ControllerFactory(Paloma._router);
-
-  //
-  // Declare Paloma controllers using this method.
-  // Will return a new constructor if the no controller with the passed name
-  // is found, else it will just return the current constructor.
-  //
-  Paloma.controller = function(name){
-    return Paloma._controllerFactory.get(name) ||
-            Paloma._controllerFactory.make(name);
-  };
-
-
-  Paloma.engine = new Paloma.Engine({factory: Paloma._controllerFactory});
+  var classFactory = new Paloma.ControllerClassFactory(),
+      controllerBuilder = new Paloma.ControllerBuilder(classFactory),
+      engine = new Paloma.Engine(controllerBuilder)
 
+  Paloma._controllerClassFactory = classFactory;
+  Paloma._controllerBuilder = controllerBuilder
+  Paloma.engine = engine;
 
-  Paloma.executeHook = function(){
-    var $hook = $('.js-paloma-hook:first script:first');
+  Paloma.controller = function(name, prototype){
+    return classFactory.make(name, prototype);
+  };
 
-    if ($hook.length == 0){ return; }
+  Paloma._executeHook = function(){
+    var hook = document.querySelector('.js-paloma-hook script');
+    if (hook) eval(hook.innerHTML);
+  };
 
-    var hook = $hook.html();
-    eval(hook);
+  Paloma.start = function(){
+    if ( !engine.hasRequest() ) this._executeHook();
+    if ( engine.hasRequest() ) engine.start();
   };
 
+  Paloma.isExecuted = function(){
+    return engine.lastRequest().executed;
+  };
 
-})(window.Paloma);
+})(window.Paloma);

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: paloma
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 6.1.0
 platform: ruby
 authors:
 - Karl Paragua
+- Gonçalo Morais
+- Sam Jewell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-01 00:00:00.000000000 Z
+date: 2021-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jquery-rails
@@ -17,7 +19,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -30,14 +32,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -137,101 +139,30 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.1.0
 description: Page-specific javascript for Rails done right
-email: kb.paragua@gmail.com
+email:
+- kb.paragua@gmail.com
+- gnclmorais@gmail.com
+- sam.jewell@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Changelog.md
-- DEVELOPMENT.md
-- Gemfile
-- License
-- README.md
-- TODO.md
 - app/views/paloma/_hook.html.erb
 - lib/paloma.rb
 - lib/paloma/action_controller_extension.rb
 - lib/paloma/controller.rb
 - lib/paloma/rails/engine.rb
+- lib/paloma/test_helper.rb
 - lib/paloma/utilities.rb
-- paloma.gemspec
-- test_app/.gitignore
-- test_app/.rspec
-- test_app/Gemfile
-- test_app/README.rdoc
-- test_app/Rakefile
-- test_app/app/assets/images/rails.png
-- test_app/app/assets/javascripts/admin/bar.js
-- test_app/app/assets/javascripts/application.js
-- test_app/app/assets/stylesheets/admin/bar.css
-- test_app/app/assets/stylesheets/application.css
-- test_app/app/assets/stylesheets/foo.css
-- test_app/app/assets/stylesheets/main.css
-- test_app/app/assets/stylesheets/multiple_names.css
-- test_app/app/controllers/admin/foos_controller.rb
-- test_app/app/controllers/application_controller.rb
-- test_app/app/controllers/main_controller.rb
-- test_app/app/helpers/admin/bar_helper.rb
-- test_app/app/helpers/application_helper.rb
-- test_app/app/helpers/foo_helper.rb
-- test_app/app/helpers/main_helper.rb
-- test_app/app/helpers/multiple_names_helper.rb
-- test_app/app/mailers/.gitkeep
-- test_app/app/models/.gitkeep
-- test_app/app/views/layouts/application.html.erb
-- test_app/app/views/main/ajax.html.erb
-- test_app/config.ru
-- test_app/config/application.rb
-- test_app/config/boot.rb
-- test_app/config/environment.rb
-- test_app/config/environments/development.rb
-- test_app/config/environments/production.rb
-- test_app/config/environments/test.rb
-- test_app/config/initializers/backtrace_silencers.rb
-- test_app/config/initializers/inflections.rb
-- test_app/config/initializers/mime_types.rb
-- test_app/config/initializers/secret_token.rb
-- test_app/config/initializers/session_store.rb
-- test_app/config/initializers/wrap_parameters.rb
-- test_app/config/locales/en.yml
-- test_app/config/routes.rb
-- test_app/db/seeds.rb
-- test_app/doc/README_FOR_APP
-- test_app/lib/assets/.gitkeep
-- test_app/lib/tasks/.gitkeep
-- test_app/log/.gitkeep
-- test_app/public/404.html
-- test_app/public/422.html
-- test_app/public/500.html
-- test_app/public/favicon.ico
-- test_app/public/robots.txt
-- test_app/script/rails
-- test_app/spec/integration/advanced_spec.rb
-- test_app/spec/integration/basic_spec.rb
-- test_app/spec/javascripts/controller_factory_spec.js
-- test_app/spec/javascripts/router_spec.js
-- test_app/spec/javascripts/support/jasmine.yml
-- test_app/spec/spec_helper.rb
-- test_app/spec/units/controller_spec.rb
-- test_app/spec/units/utilities_spec.rb
-- test_app/test/fixtures/.gitkeep
-- test_app/test/functional/.gitkeep
-- test_app/test/integration/.gitkeep
-- test_app/test/performance/browsing_test.rb
-- test_app/test/test_helper.rb
-- test_app/test/unit/.gitkeep
-- test_app/vendor/assets/javascripts/.gitkeep
-- test_app/vendor/assets/stylesheets/.gitkeep
-- test_app/vendor/plugins/.gitkeep
-- vendor/assets/javascripts/paloma/controller.js
-- vendor/assets/javascripts/paloma/controller_factory.js
+- vendor/assets/javascripts/paloma/base_controller.js
+- vendor/assets/javascripts/paloma/before_callback_performer.js
+- vendor/assets/javascripts/paloma/controller_builder.js
+- vendor/assets/javascripts/paloma/controller_class_factory.js
 - vendor/assets/javascripts/paloma/engine.js
 - vendor/assets/javascripts/paloma/index.js
 - vendor/assets/javascripts/paloma/init.js
 - vendor/assets/javascripts/paloma/paloma.js
-- vendor/assets/javascripts/paloma/router.js
-homepage: https://github.com/kbparagua/paloma
+homepage: https://github.com/gnclmorais/paloma
 licenses:
 - MIT
 metadata: {}
@@ -250,8 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Provides an easy way to execute page-specific javascript for Rails.

data/.gitignore

@@ -1,5 +0,0 @@
-Gemfile.lock
-*.gem
-/tmp/*
-/test_app/tmp/*
-/test_app/spec/tmp/*

data/Changelog.md

@@ -1,42 +0,0 @@
-## 4.2.1
-* https://github.com/kbparagua/paloma/issues/79 - Rendering "true" string fixed.
-* Catch situations where `js` function is called more than once.
-
-## 4.2.0
-* https://github.com/kbparagua/paloma/pull/75 - Explicitly insert hook in view.
-
-## 4.1.2
-* https://github.com/kbparagua/paloma/issues/73 - Fix `js false` issue.
-
-## 4.1.1
-* https://github.com/kbparagua/paloma/pull/57 - Fix Turbolinks Issues.
-* https://github.com/kbparagua/paloma/pull/55 - Fix issues when Paloma hook is not found.
-
-## 4.1.0
-* Support for Turbolinks.
-* `Paloma.executeHook()` to manually run the hook from the DOM.
-* Paloma hook will be appended using all `render` calls, except for calls that has the following keys `[:json, :js, :xml, :file]`.
-* Restore `Paloma.engine.start()` to start processing queued request.
-
-
-## 4.0.0
-* https://github.com/kbparagua/paloma/issues/26 - Paloma requests are not saved on `session`.
-* https://github.com/kbparagua/paloma/issues/26 - Chaining with redirect is removed.
-* Routing from javascript is removed.
-* Routing from Rails controller is added.
-* Ability to have a controller-wide setting.
-* https://github.com/kbparagua/paloma/issues/29 - Disable `console.log` and `console.warn` for non-development environments.
-
-
-## 3.0.2
-* Bug Fix: Converting Rails controller name to singular form.
-
-
-## 3.0.1
-* Bug Fix: Can't handle Rails controller with Multi-word name.
-* Bug Fix: Paloma Engine is halting when a warning is encountered.
-* Don't create Paloma request if rendering js, json, xml, or file.
-
-
-## 3.0.0
-* Rewrite Initial Release

data/DEVELOPMENT.md

@@ -1,15 +0,0 @@
-# Development
-
-## Testing
-
-1. Go to `test_app`
-1. Comment out `turbolinks.js` on `applciation.js`
-1. Run `bundle exec rails s`.
-1. Open your browser and visit [http://localhost:3000/specs](http://localhost:3000/specs).
-1. Run `bundle exec rake spec:units`.
-1. Run `bundle exec rake spec:integration`.
-
-## TODO
-
-1. Improve tests.
-1. Testing for turbolinks.

data/Gemfile

@@ -1,2 +0,0 @@
-source "http://rubygems.org"
-gemspec

data/License

@@ -1,22 +0,0 @@
-(The MIT License)
-
-Copyright (c) 2012-2013 Karl Paragua, Bia Esmero
-
-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

@@ -1,353 +0,0 @@
-**Important**
-- `master` branch contains the bleeding edge development code.
-- check `branches` or `tags` for the latest stable release or specific versions.
-
-# Paloma
-
-Page-specific javascript for Rails done right.
-
-## Advantages
-* Choose what specific javascript code to run per page.
-* Easily make ruby variables available on your javascript files.
-* Can be written using vanilla javascript, coffeescript, and anything that compiles to js.
-* Easy to understand (*because it is patterned after Rails' controller module*).
-
-## Quick Example
-
-Paloma controller.
-
-```javascript
-var UsersController = Paloma.controller('Users');
-
-// Executes when Rails User#new is executed.
-UsersController.prototype.new = function(){
-   alert('Hello Sexy User!' );
-};
-```
- 
-The Rails controller `app/controllers/users_controller.rb`:
-
-```ruby
-def UsersController < ApplicationController
-    def new
-      # a Paloma request will automatically be created.
-      @user = User.new
-    end
-end
-```
-
-That's it! Simply Sexy!
-
-## Minimum Requirements
-* jQuery 1.7 or higher
-* Rails 3.1 or higher
-
-
-## Install
-
-1. Without bundler: `sudo gem install paloma`.
-1. With bundler, add this to your Gemfile: `gem 'paloma'`
-1. Require `paloma` in your `application.js`: `//= require paloma`
-1. In your layouts insert Paloma hook.
-
-   `application.html.erb`
-   ```html
-   <html>
-      <head>
-      </head>
-      
-      <body>
-         <%= yield %>
-         <%= insert_paloma_hook %>
-      </body>
-   </html>
-   ```
-
-## Controllers
-
-Controllers are just classes that handle requests made by Rails Controllers. Each Rails Controller's action will be mapped to a specific Paloma Controller's action.
-
-
-### Creating a Controller
-
-A Controller constructor is created or accessed (if it already exists), using `Paloma.controller()` method.
-
-```javascript
-var ArticlesController = Paloma.controller('Articles');
-``` 
-
-It will return the constructor function of your controller.
-
-Note: Using `Paloma.controller` method, you can access the same controller constructor across different files.
-
-
-### Handling Actions
-
-Every time a request to Paloma is made (A Rails Controller action is executed), an instance of a Paloma controller is created and the method responsible for the request will be invoked.
- 
-```javascript
-var ArticlesController = Paloma.controller('Articles');
-
-ArticlesController.prototype.new = function(){
-  // Handle new articles
-};
-
-ArticlesController.prototype.edit = function(){
-  // Handle edit articles
-};
-```
-
-
-## Advanced Usage
-
-You can manipulate what controller/action should Paloma execute by calling `js` method **before** rendering.
-
-1. Changing controller
-
-   ```ruby
-   class UsersController < ApplicationController
-      def new
-         @user = User.new
-         js 'Accounts' # will use Accounts controller instead of Users controller
-      end
-   end
-   ```
-
-2. Changing action
-
-   You can use the symbol syntax:
-   ```ruby
-   def new
-      @user = User.new
-      js :register # will execute register method instead of new
-   end
-   ```
-   
-   Or the string syntax:
-   ```ruby
-   def new
-      @user = User.new
-      js '#register'
-   end
-   ```
-
-3. Changing controller and action.
-
-   ```ruby
-   def new
-     @user = User.new
-     js 'Accounts#register' # will execute Accounts#register instead of Users#new
-   end
-   ```
-
-4. Changing controller with namespace.
-
-   Paloma supports namespaces using '/' as delimiter.
-
-   ```ruby
-   def new
-      @user = User.new
-      js `Admin/Accounts` # will use Admin/Accounts controller instead of Users controller
-   end
-   ```
-   
-   ```ruby
-   def new
-      @user = User.new
-      js 'Admin/Accounts#register' # will execute Admin/Accounts#register instead of Users#new
-   end
-   ```
-   
-
-## Passing Parameters
-
-You can access the parameters on your Paloma Controller using `this.params` object.
-
-
-1. Parameters only.
- 
-   `users_controller.rb`
-   ```ruby
-   def destroy
-       user = User.find params[:id]
-       user.destroy
-       
-       js :id => user.id
-   end
-   ```
-
-   Paloma controller.
-
-   ```javascript
-   var UsersController = Paloma.controller('Users');
-   
-   UsersController.prototype.destroy = function(){
-     alert('User ' + this.params['id'] + ' is deleted.');
-   };
-   ```
-
-2. Path with parameters.
-
-   ```ruby
-   def destroy
-      user = User.find params[:id]
-      user.destroy
-      
-      js 'Accounts#delete', :id => user.id
-   end
-   ```
-   
-   
-## Preventing Paloma Execution
-
-If you want to Paloma not to execute in a specific Rails Controller action you need to pass `false` as the Paloma parameter.
-
-```ruby
-def edit
-  @user = User.find params[:id]
-  js false
-end
-```
-
-
-## Controller-wide setup
-
-You can call `js` outside Rails controller actions for global or controller-wide settings.
-
-
-**Example:**
-
-```ruby
-class UsersController < ApplicationController
-   js 'Accounts' # use Accounts controller instead of Users for all actions.
-
-
-   def new
-      @user = User.new
-   end
-   
-   def show
-      @user = User.find params[:id]
-   end
-end
-```
-
-Like `before_filter` you can also pass `only` and `except` options.
-
-
-```ruby
-class UsersController < ApplicationController
-
-   js 'Admin/Accounts', :except => :destroy # Use Admin/Accounts except for destroy method
-
-end
-```
-
-
-**IMPORTANT NOTE:**
-If you are going to pass parameters for Controller-wide settings, put them inside a `:params` hash.
-
-```ruby
-class UsersController < ApplicationController
-  js 'Accounts', :params => {:x => 1, :y => 2, :z => 3}, :only => :show
-end
-```
-
-### Overriding Controller-wide setup
-
-If you want to override the controller-wide setup, just call `js` again inside a controller action. From there you can override the controller/action or pass additional parameters.
-
-```ruby
-class UsersController < ApplicationController
-
-   js 'Accounts', :params => {:x => 1}
-   
-   
-   def new
-      @user = User.new
-      js :register, :y => 2 # will execute Accounts#register with params {:x => 1, :y => 2}
-   end
-end
-```
-
-## Hook
-
-`insert_paloma_hook` is a helper method that you can use in your views to insert Paloma's HTML hook.
-Inside this HTML hook is where the magic happens. This is the reason why Paloma can magically know what Javascript controller/action to execute. To further understand how Paloma works, you can inspect the HTML hook, by checking the generated HTML (*inspect element*) and locate the `div` element that has the class `js-paloma-hook`.
-
-Ideally, you just need to call `insert_paloma_hook` in your layouts, since the layout will always be included in every rendered view. But if you are rendering a view without a layout, make sure to call `insert_paloma_hook` in that view.
-
-
-## AJAX
-
-1. Make sure that the AJAX response contains the html hook. (use `insert_paloma_hook`)
-2. Execute the hook and start Paloma's engine on complete/success.
-
-   ```js
-   $.get('http://example.com', function(response){
-      $('#result').html(response);
-      
-      // Execute Paloma hook and start the engine.
-      Paloma.executeHook();
-      Palama.engine.start();
-   });
-   ```
-
-## Turbolinks Support
-
-As of version `4.1.0`, Paloma is compatible with Turbolinks without additional setup.
-
-### Execute Paloma when user hits `Back` or `Forward` button.
-
-Paloma executes page-specific javascript by adding a `<script>` tag to the response body. Turbolinks, by default, executes any inline javascript in the response body when you visit a page, so the `<script>` tag appended by Paloma will automatically be executed. However, when Turbolinks restores a page from cache (*this happens when a user hits `Back` or `Forward` button in his browser*) any **inline javascript will not be executed** anymore. This is the intentional behavior of Turbolinks, and it is not a bug. If you want to execute Paloma again when Turbolinks restores a page, do something like this:
-
-```js
-$(document).on('page:restore', function(){
-  // Manually evaluates the appended script tag.
-  Paloma.executeHook();
-});
-```
-
-### Turbolinks without `jquery.turbolinks` gem
-
-You need to manually run Paloma every page load if you are not using `jquery.turbolinks` gem.
-
-In your `application.js`
-
-```js
-$(document).on('page:load', function(){
-   Paloma.executeHook();
-   Paloma.engine.start();
-});
-```
-
-
-## Gotchas
-
-* Make sure that the rendered view has the paloma hook (*use `insert_paloma_hook`*) for Paloma to execute. 
-
-* It will cause conflicts if you have a controller and a module that has the same name.
-
-   Example:
-   ```js
-   var AdminController = Paloma.controller('Admin');
-   
-   // This will override the AdminController and replace it
-   // with a module named 'Admin'.
-   var UsersController = Paloma.controller('Admin/Users');
-   ```
-
-## Where to put code?
-
-Again, Paloma is now flexible and doesn't force developers to follow specific directory structure.
-You have the freedom to create controllers anywhere in your application.
-
-Personally, I prefer having a javascript file for each controller.
-
-
-## Contribute
-
-1. Fork.
-2. Do awesome things.
-3. Submit Pull-Request to `master` branch.
-4. Add short summary of changes on your PR.