ajaxify_rails 0.2.1 → 0.5

data/spec/spec_helper.rb

@@ -0,0 +1,86 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+ENV["RAILS_ENV"] = 'test'
+require_relative "ajaxify_test/config/environment"
+
+require 'rspec/rails'
+require 'rspec-steps'
+require 'sqlite3'
+
+require 'haml'
+
+# Add this to load Capybara integration:
+require 'capybara/rspec'
+require 'capybara/rails'
+
+# require 'capybara/poltergeist'
+
+# Capybara.register_driver :poltergeist do |app|
+#   # Specifiying the phantomjs path only for RubyMine which fails to pick it up otherwise
+#   Capybara::Poltergeist::Driver.new(app, phantomjs: '/usr/local/bin/phantomjs') #, inspector: true
+# end
+
+# Capybara.javascript_driver = :poltergeist
+# Capybara.current_driver    = :poltergeist
+
+Capybara.default_selector  = :css
+Capybara.default_wait_time = 3
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  #config.run_all_when_everything_filtered = true
+  config.include Capybara::DSL
+end
+
+
+def wait_until_gone css
+	page.should have_no_css(css)
+end
+
+def wait_for_ajaxify_loaded
+  wait_until_gone ".ajaxify_loader"
+end
+
+def click_browser_back_button
+	page.execute_script("window.history.back()")
+end
+
+def click_browser_forward_button
+	page.execute_script("window.history.forward()")
+end
+
+def ensure_layout_not_reloaded
+	find('body')['data-id'].to_s.should eq(@layout_id), "Layout has been reloaded but shouldn't"
+end
+
+def should_have_content content
+	page.should have_css('#main', text: content)
+end
+
+def should_have_notice notice
+	page.should have_css('#notice', text: notice)
+end
+
+def disable_push_state
+	page.execute_script("window.history.pushState = null;")
+end
+
+def current_hash
+	URI.parse(current_url).fragment.to_s
+end
+
+def hash_path_should_be path
+	current_hash.should == path
+	current_path.should == '/'
+end
+
+def push_state_path_should_be path
+	current_hash.should == ''
+	current_path.should == path
+end
+

data/vendor/assets/javascripts/ajaxify_rails.js.coffee

@@ -4,6 +4,7 @@ content_container = 'main'
 base_paths = null
 flash_types = ['notice']
 dont_correct_url = false
+push_state_enabled = true
 
 ignore_hash_change = null
 load_page_from_hash = null
@@ -16,6 +17,10 @@ initial_history_state =
 base_path_regexp_cache = null
 
 
+# --------------------------------------------------------------------------------------------------------------------
+# public methods
+# --------------------------------------------------------------------------------------------------------------------
+
 activate = (new_active = true) ->
   active = new_active
 
@@ -26,12 +31,20 @@ set_content_container = (new_content_container) ->
   content_container = new_content_container
 
 
-ajaxify = ->
+init = (options = {}) ->
+  base_paths = options.base_paths if 'base_paths' of options
+  flash_types = options.flash_types if 'flash_types' of options
+  push_state_enabled = options.push_state_enabled if 'push_state_enabled' of options
+  active = options.active if 'active' of options
+  content_container = options.content_container if 'content_container' of options
+  correct_url() unless $('meta[name="ajaxify:dont_correct_url"]').length > 0
 
+
+ajaxify = ->
   if active
 
-    if Ajaxify.load_page_from_hash
-      Ajaxify.load_page_from_hash = false
+    if load_page_from_hash
+      load_page_from_hash = false
       on_hash_change()
 
     protocol_and_hostname = "#{window.location.protocol}//#{window.location.hostname}"
@@ -65,7 +78,6 @@ ajaxify = ->
 
       false
 
-
   # (history interface browsers only)
   $(window).on 'popstate', (e) ->
     e = e.originalEvent
@@ -73,7 +85,6 @@ ajaxify = ->
       e.state.cache = false
       load e.state, true
 
-
   # (non history interface browsers only)
   window.onhashchange = ->
     unless ignore_hash_change
@@ -82,36 +93,8 @@ ajaxify = ->
       ignore_hash_change = false
 
 
-base_path_regexp = ->
-  return null unless base_paths
-  return base_path_regexp_cache if base_path_regexp_cache
-  # match starting and ending with base path, e.g. "^\/en$" (i.e. we are at the base path root) or
-  # starting with base path and continuing with '/', e.g. "^\/en\/" (i.e. we are NOT at the base path root) or
-  # starting with base path and continuing with '?', e.g. "^\/en\?" (i.e. we are at the base path root and have query params)
-  base_path_regexp_cache = new RegExp("^\/(#{ $.map(base_paths, (el) ->
-    el = regexp_escape el
-    "#{el}($|\/|\\?)"
-  ).join('|')})", 'i')
-
-
-# load content from url hash (non history interface browsers)
-on_hash_change = ->
-  url = window.location.hash.replace(/#/, "")
-
-  if match = window.location.pathname.match(base_path_regexp())
-    url = match[0] + url
-
-  url = '/' if url == ''
-  hash_changed = true
-
-  load
-    url: url
-  , true
-
-
 load = (options, pop_state = false) ->
-
-  unless Ajaxify.load_page_from_hash
+  unless load_page_from_hash
 
     data = options.data || { ajaxified: true }
 
@@ -145,44 +128,9 @@ load = (options, pop_state = false) ->
         on_ajaxify_success data, status, jqXHR, pop_state, options
 
 
-show_flashes = (flashes) ->
-  $.each flash_types, ->
-    if flashes and flashes[this]
-      $("##{this}").html flashes[this]
-      $("##{this}").show()
-      $(document).trigger 'ajaxify:flash_displayed', [this]
-
-    else
-      $("##{this}").hide()
-
-
-on_ajaxify_success = (data, status, jqXHR, pop_state, options) ->
-
-  $("##{content_container}").html data
-
-  title = $('#ajaxify_content').data('page-title')
-  flashes = $('#ajaxify_content').data('flashes')
-
-  # Correct the url after a redirect and when it has the ajaxify param in it.
-  # The latter can happen e.g. for pagination links that are auto generated.
-  current_url = $('#ajaxify_content #ajaxify_location').html()
-  if options.url != current_url
-    options.url = current_url.replace(/(&|&|\?)ajaxify_redirect=true/,'')
-    options.type = 'GET'
-
-  update_url options, pop_state
-
-  $(document).trigger 'ajaxify:content_inserted'
-
-  $("##{content_container} #ajaxify_content").remove()
-
-  if title
-    document.title = title.replace /&/, '&'   # Todo: need to figure out what else needs to be unescaped
-
-  show_flashes(flashes)
-
-  $(document).trigger('ajaxify:content_loaded', [data, status, jqXHR, options.url])
-
+# --------------------------------------------------------------------------------------------------------------------
+# private methods
+# --------------------------------------------------------------------------------------------------------------------
 
 update_url = (options, pop_state = false) ->
 
@@ -191,7 +139,7 @@ update_url = (options, pop_state = false) ->
   # unless back/forward arrowing or request method is not 'get'
   if !pop_state and get_request
 
-    if window.history.pushState
+    if push_state()
 
       if initial_history_state != ''
         window.history.replaceState initial_history_state, ''
@@ -216,15 +164,41 @@ update_url = (options, pop_state = false) ->
       window.location.hash = hash
 
 
+on_ajaxify_success = (data, status, jqXHR, pop_state, options) ->
+
+  $("##{content_container}").html data
+
+  title = $('#ajaxify_content').data('page-title')
+  flashes = $('#ajaxify_content').data('flashes')
+
+  # Correct the url after a redirect and when it has the ajaxify param in it.
+  # The latter can happen e.g. for pagination links that are auto generated.
+  current_url = $('#ajaxify_content #ajaxify_location').html()
+  if options.url != current_url
+    options.url = current_url.replace(/(&|&|\?)ajaxify_redirect=true/,'')
+    options.type = 'GET'
+
+  update_url options, pop_state
+
+  $(document).trigger 'ajaxify:content_inserted'
+
+  $("##{content_container} #ajaxify_content").remove()
+
+  if title
+    document.title = title.replace /&/, '&'   # Todo: need to figure out what else needs to be unescaped
+
+  show_flashes(flashes)
+
+  $(document).trigger('ajaxify:content_loaded', [data, status, jqXHR, options.url])
+
+
 correct_url = ->
   if active
-
     if window.location.hash.indexOf('#') == 0   # if url has a '#' in it treat it as a non history interface hash based scheme url
-
       return unless window.location.hash.match(/^#(\/|\?)/) # check hash format
 
-      if !window.history.pushState
-        Ajaxify.load_page_from_hash = true   # notify Ajaxify that a hash will be loaded and ignore all other calls to load until hash url is loaded
+      if !push_state()
+        load_page_from_hash = true   # notify Ajaxify that a hash will be loaded and ignore all other calls to load until hash url is loaded
       else
         # load proper url in case browser supports history api
         path = window.location.pathname
@@ -232,8 +206,7 @@ correct_url = ->
         path = path + window.location.hash.replace(/#/, "")
         window.location.href = "#{protocol_with_host()}#{path}"
 
-    else if !window.history.pushState # move path behind '#' for browsers without history api
-
+    else if !push_state() # move path behind '#' for browsers without history api
       if base_path_regexp() and (match = window.location.pathname.match(base_path_regexp()))
         if match[0] == window.location.pathname
           if window.location.search == ''
@@ -251,30 +224,72 @@ correct_url = ->
 
       window.location.href = "#{protocol_with_host()}#{path}#{window.location.search}"
 
-init = (options = {}) ->
-  base_paths = options.base_paths if 'base_paths' of options
-  flash_types = options.flash_types if 'flash_types' of options
-  active = options.active if 'active' of options
-  content_container = options.content_container if 'content_container' of options
-  correct_url() unless $('meta[name="ajaxify:dont_correct_url"]').length > 0
 
-#
-# utility functions
-#
+show_flashes = (flashes) ->
+  $.each flash_types, ->
+    if flashes and flashes[this]
+      $("##{this}").html flashes[this]
+      $("##{this}").show()
+      $(document).trigger 'ajaxify:flash_displayed', [this]
+
+    else
+      $("##{this}").hide()
+
+
+# load content from url hash (non history interface browsers)
+on_hash_change = ->
+  url = window.location.hash.replace(/#/, "")
+
+  if match = window.location.pathname.match(base_path_regexp())
+    url = match[0] + url
+
+  url = '/' if url == ''
+  hash_changed = true
+
+  load
+    url: url
+  , true
+
+
+base_path_regexp = ->
+  return null unless base_paths
+  return base_path_regexp_cache if base_path_regexp_cache
+  # match starting and ending with base path, e.g. "^\/en$" (i.e. we are at the base path root) or
+  # starting with base path and continuing with '/', e.g. "^\/en\/" (i.e. we are NOT at the base path root) or
+  # starting with base path and continuing with '?', e.g. "^\/en\?" (i.e. we are at the base path root and have query params)
+  base_path_regexp_cache = new RegExp("^\/(#{ $.map(base_paths, (el) ->
+    el = regexp_escape el
+    "#{el}($|\/|\\?)"
+  ).join('|')})", 'i')
+
 
 is_string = (variable) ->
   Object.prototype.toString.call(variable) == '[object String]'
 
+
 regexp_escape = (str) ->
   str.replace new RegExp('[.\\\\+*?\\[\\^\\]$(){}=!<>|:\\-]', 'g'), '\\$&'
 
+
 protocol_with_host = ->
   loc = window.location
   "#{loc.protocol}//#{loc.host}"
 
 
+push_state = ->
+  push_state_enabled and window.history.pushState 
+
+
+# --------------------------------------------------------------------------------------------------------------------
+# public interface
+# --------------------------------------------------------------------------------------------------------------------
+
 @Ajaxify = { init, ajaxify, load, update_url, activate, set_content_container, get_content_container }
 
 
+# --------------------------------------------------------------------------------------------------------------------
+# ajaxify page on dom ready
+# --------------------------------------------------------------------------------------------------------------------
+
 jQuery ->
   Ajaxify.ajaxify()

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ajaxify_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: '0.5'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -27,6 +27,150 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: rspec-steps
+  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'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.30.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.30.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'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
 description: ! "Automatically makes your Rails app loading content in the background
   via ajax. Works by turning all internal links into\n                         ajax
   links that trigger an update of the page's content area. Also form submissions are
@@ -43,6 +187,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -51,6 +197,54 @@ files:
 - lib/ajaxify_rails.rb
 - lib/ajaxify_rails/action_controller_additions.rb
 - lib/ajaxify_rails/version.rb
+- spec/ajaxify_test/Rakefile
+- spec/ajaxify_test/app/assets/images/ajax-loader-y.gif
+- spec/ajaxify_test/app/assets/images/ajax-loader.gif
+- spec/ajaxify_test/app/assets/javascripts/application.js
+- spec/ajaxify_test/app/assets/javascripts/home.js.coffee
+- spec/ajaxify_test/app/assets/javascripts/main.js.coffee
+- spec/ajaxify_test/app/assets/stylesheets/application.css
+- spec/ajaxify_test/app/assets/stylesheets/home.css.scss
+- spec/ajaxify_test/app/controllers/application_controller.rb
+- spec/ajaxify_test/app/controllers/home_controller.rb
+- spec/ajaxify_test/app/helpers/application_helper.rb
+- spec/ajaxify_test/app/helpers/home_helper.rb
+- spec/ajaxify_test/app/mailers/.gitkeep
+- spec/ajaxify_test/app/models/.gitkeep
+- spec/ajaxify_test/app/views/home/index.html.haml
+- spec/ajaxify_test/app/views/home/page1.html.haml
+- spec/ajaxify_test/app/views/home/page2.html.haml
+- spec/ajaxify_test/app/views/home/page3.html.haml
+- spec/ajaxify_test/app/views/layouts/application.html.haml
+- spec/ajaxify_test/config.ru
+- spec/ajaxify_test/config/application.rb
+- spec/ajaxify_test/config/boot.rb
+- spec/ajaxify_test/config/database.yml
+- spec/ajaxify_test/config/environment.rb
+- spec/ajaxify_test/config/environments/development.rb
+- spec/ajaxify_test/config/environments/production.rb
+- spec/ajaxify_test/config/environments/test.rb
+- spec/ajaxify_test/config/initializers/backtrace_silencers.rb
+- spec/ajaxify_test/config/initializers/inflections.rb
+- spec/ajaxify_test/config/initializers/mime_types.rb
+- spec/ajaxify_test/config/initializers/secret_token.rb
+- spec/ajaxify_test/config/initializers/session_store.rb
+- spec/ajaxify_test/config/initializers/wrap_parameters.rb
+- spec/ajaxify_test/config/locales/en.yml
+- spec/ajaxify_test/config/routes.rb
+- spec/ajaxify_test/db/development.sqlite3
+- spec/ajaxify_test/db/seeds.rb
+- spec/ajaxify_test/db/test.sqlite3
+- spec/ajaxify_test/lib/assets/.gitkeep
+- spec/ajaxify_test/lib/tasks/.gitkeep
+- spec/ajaxify_test/public/404.html
+- spec/ajaxify_test/public/422.html
+- spec/ajaxify_test/public/500.html
+- spec/ajaxify_test/public/favicon.ico
+- spec/ajaxify_test/public/robots.txt
+- spec/ajaxify_test/script/rails
+- spec/integration/ajaxify_rails_spec.rb
+- spec/spec_helper.rb
 - vendor/assets/javascripts/ajaxify_rails.js.coffee
 homepage: https://github.com/ncri/ajaxify_rails
 licenses: []
@@ -64,18 +258,71 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1291222513041922099
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1291222513041922099
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Rails gem for automatically turning internal links/forms into ajax links/forms
   that load content without a full page reload.
-test_files: []
-has_rdoc: 
+test_files:
+- spec/ajaxify_test/Rakefile
+- spec/ajaxify_test/app/assets/images/ajax-loader-y.gif
+- spec/ajaxify_test/app/assets/images/ajax-loader.gif
+- spec/ajaxify_test/app/assets/javascripts/application.js
+- spec/ajaxify_test/app/assets/javascripts/home.js.coffee
+- spec/ajaxify_test/app/assets/javascripts/main.js.coffee
+- spec/ajaxify_test/app/assets/stylesheets/application.css
+- spec/ajaxify_test/app/assets/stylesheets/home.css.scss
+- spec/ajaxify_test/app/controllers/application_controller.rb
+- spec/ajaxify_test/app/controllers/home_controller.rb
+- spec/ajaxify_test/app/helpers/application_helper.rb
+- spec/ajaxify_test/app/helpers/home_helper.rb
+- spec/ajaxify_test/app/mailers/.gitkeep
+- spec/ajaxify_test/app/models/.gitkeep
+- spec/ajaxify_test/app/views/home/index.html.haml
+- spec/ajaxify_test/app/views/home/page1.html.haml
+- spec/ajaxify_test/app/views/home/page2.html.haml
+- spec/ajaxify_test/app/views/home/page3.html.haml
+- spec/ajaxify_test/app/views/layouts/application.html.haml
+- spec/ajaxify_test/config.ru
+- spec/ajaxify_test/config/application.rb
+- spec/ajaxify_test/config/boot.rb
+- spec/ajaxify_test/config/database.yml
+- spec/ajaxify_test/config/environment.rb
+- spec/ajaxify_test/config/environments/development.rb
+- spec/ajaxify_test/config/environments/production.rb
+- spec/ajaxify_test/config/environments/test.rb
+- spec/ajaxify_test/config/initializers/backtrace_silencers.rb
+- spec/ajaxify_test/config/initializers/inflections.rb
+- spec/ajaxify_test/config/initializers/mime_types.rb
+- spec/ajaxify_test/config/initializers/secret_token.rb
+- spec/ajaxify_test/config/initializers/session_store.rb
+- spec/ajaxify_test/config/initializers/wrap_parameters.rb
+- spec/ajaxify_test/config/locales/en.yml
+- spec/ajaxify_test/config/routes.rb
+- spec/ajaxify_test/db/development.sqlite3
+- spec/ajaxify_test/db/seeds.rb
+- spec/ajaxify_test/db/test.sqlite3
+- spec/ajaxify_test/lib/assets/.gitkeep
+- spec/ajaxify_test/lib/tasks/.gitkeep
+- spec/ajaxify_test/public/404.html
+- spec/ajaxify_test/public/422.html
+- spec/ajaxify_test/public/500.html
+- spec/ajaxify_test/public/favicon.ico
+- spec/ajaxify_test/public/robots.txt
+- spec/ajaxify_test/script/rails
+- spec/integration/ajaxify_rails_spec.rb
+- spec/spec_helper.rb