durl-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c35976a924894217ab9f42710a3bdfda50c0a2a6
+  data.tar.gz: ab0114a5ee3ec0738b44cf71cc4cf5453e6bac54
+SHA512:
+  metadata.gz: eb96535badd1f389ccb451787bc6e89bfaabdc6534c0a6e00bbd7e3085c0082066da64ca9da936b6d841f3d3a97d64783dd35940a242113043b7cba96b72436e
+  data.tar.gz: a4243ae9d30727c85047c2030c7a456e12f8a7e21f2b6eb143ec4888991d22c92728906ee055b112c2411ed21720f589d067598eb5d037f6b02dcbdb7ca41a21

data/.gitignore

@@ -0,0 +1,8 @@
+pkg/*
+tmp
+spec/support/*/Gemfile.lock
+spec/support/*/public/javascripts
+.ruby-version
+.bundle
+imports/*
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0 (6 August 2016)
+
+- well, I started.

data/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+Thanks for helping our good friend dURL!
+
+## Updating dURL
+
+If dURL scripts changed, open an issue and submit a pull request
+
+## Tests
+
+dURL has its own tests.  Not much to test here.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2016 Tyler Kasten
+
+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

@@ -0,0 +1,59 @@
+# durl-rails
+
+dURL! For Rails!
+
+This gem provides:
+
+  * dURL
+
+  See [VERSIONS.md](VERSIONS.md) to see which versions of durl-rails bundle which versions of dURL.
+
+## Versions
+
+```
+patch version bump = updates to durl-rails, and patch-level updates to dURL
+minor version bump = minor-level updates to dURL
+major version bump = major-level updates to dURL and updates to rails which may be backwards-incompatible
+```
+
+## Installation
+
+Gemfile
+
+```ruby
+gem "durl-rails"
+```
+
+And run `bundle install`. The rest of the installation depends on whether the asset pipeline is being used.
+
+### Rails 3.1 or greater (with asset pipeline *enabled*)
+
+The dURL files will be added to the asset pipeline and available for you to use. add these lines to `app/assets/javascripts/application.js`:
+
+```js
+//= require durl
+```
+
+### Rails 3.0 (or greater with asset pipeline *disabled*)
+
+This gem adds a single generator: `durl:install`. Running the generator will copy dURL to the `public/javascripts` directory.
+
+This gem will also hook into the Rails configuration process, adding dURL to the javascript files included by the `javascript_include_tag(:defaults)` call. While this gem contains the minified and un-minified versions of dURL, only the minified versions will be included in the `:defaults` when Rails is run in `production` or `test` mode  (un-minified versions will be included when Rails is run in `development` mode).
+
+To invoke the generator, run:
+
+```sh
+rails generate durl:install
+```
+
+You're done!
+
+## Contributing
+
+Feel free to open an issue ticket if you find something that could be improved. 
+
+## Acknowledgements
+
+This gem's structure and technique for wrapping a JS library into a rails friendly package is based entirely on jquery-rails. Many thanks are due to all of [the jquery-rails contributors](https://github.com/rails/jquery-rails/graphs/contributors).
+
+Copyright Tyler Kasten, released under the MIT License.

data/Rakefile

@@ -0,0 +1,44 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+# Check if versions are correct between VERSION constants and .js files
+#
+task :release => [:guard_version]
+
+task :guard_version do
+  def check_version(file, pattern, constant)
+    body = File.read("vendor/assets/javascripts/#{file}")
+    match = body.match(pattern) or abort "Version check failed: no pattern matched in #{file}"
+    file_version = body.match(pattern)[1]
+    constant_version = Durl::Rails.const_get(constant)
+
+    unless constant_version == file_version
+      abort "Durl::Rails::#{constant} was #{constant_version} but it should be #{file_version}"
+    end
+  end
+
+  check_version('durl.js', /Version: ([\S]+)/, 'DURL_VERSION')
+end
+
+task :update_durl do
+  puts "Downloading durl.js"
+  puts `curl -o vendor/assets/javascripts/durl.js https://raw.githubusercontent.com/tkasten/durl/master/src/durl.js`
+
+  puts "Updating version.rb"
+  version = false
+  File.foreach('vendor/assets/javascripts/durl.js') do |line|
+    version = line.match(/Version: ([\S]+)/)
+    version = version && version[1]
+    break if version
+  end
+
+  version_path = 'lib/durl/rails/version.rb'
+  lines = IO.readlines(version_path).map do |line|
+    line.gsub(/DURL_VERSION = "([\d\.]+)"/, "DURL_VERSION = \"#{version}\"")
+  end
+  File.open(version_path, 'w') do |file|
+    file.puts lines
+  end
+
+  puts "\e[32mDone!\e[0m"
+end

data/VERSIONS.md

@@ -0,0 +1,5 @@
+# Bundled Versions
+
+| Gem    | dURL   |
+|--------|--------|
+| 1.0.0  | 1.0.5  |

data/durl-rails.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/durl/rails/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "durl-rails"
+  s.version     = Durl::Rails::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tyler Kasten"]
+  s.email       = ["tyler.kasten@gmail.com"]
+  s.homepage    = "https://github.com/tkasten/durl-rails"
+  s.summary     = "Use dURL with Rails 3+"
+  s.description = "This gem provides dURL for your Rails 3+ application."
+  s.license     = "MIT"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "durl-rails"
+
+  s.add_dependency "railties", ">= 3.0", "< 5.0"
+  s.add_dependency "thor",     ">= 0.14", "< 2.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_path = 'lib'
+end

data/lib/durl/rails/engine.rb

@@ -0,0 +1,6 @@
+module Durl
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/durl/rails/version.rb

@@ -0,0 +1,6 @@
+module Durl
+  module Rails
+    VERSION = "1.0.0"
+    DURL_VERSION = "1.0.5"
+  end
+end

data/lib/durl/rails.rb

@@ -0,0 +1,7 @@
+require 'durl/rails/engine' if ::Rails.version >= '3.1'
+require 'durl/rails/version'
+
+module Durl
+  module Rails
+  end
+end

data/lib/durl-rails.rb

@@ -0,0 +1 @@
+require 'durl/rails'

data/lib/generators/durl/install/install_generator.rb

@@ -0,0 +1,37 @@
+require 'rails'
+
+# Supply generator for Rails 3.0.x or if asset pipeline is not enabled
+if ::Rails.version < "3.1" || !::Rails.application.config.assets.enabled
+  module Durl
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+
+        desc "This generator installs dURL #{Durl::Rails::DURL_VERSION}"
+        source_root File.expand_path('../../../../../vendor/assets/javascripts', __FILE__)
+
+        def copy_durl
+          say_status("copying", "dURL (#{Durl::Rails::DURL_VERSION})", :green)
+          copy_file "durl.js", "public/javascripts/durl.js"
+          copy_file "durl.min.js", "public/javascripts/durl.min.js"
+        end
+
+      end
+    end
+  end
+else
+  module Durl
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+        desc "Just show instructions so people will know what to do when mistakenly using generator for Rails 3.1 apps"
+
+        def do_nothing
+          say_status("deprecated", "You are using Rails 3.1 with the asset pipeline enabled, so this generator is not needed.")
+          say_status("", "The necessary files are already in your asset pipeline.")
+          say_status("", "Just add `//= require durl` to your app/assets/javascripts/application.js")
+          say_status("", "If you do not want the asset pipeline enabled, you may turn it off in application.rb and re-run this generator.")
+          # ok, nothing
+        end
+      end
+    end
+  end
+end

data/vendor/assets/javascripts/durl.js

@@ -0,0 +1,153 @@
+/*
+ * File: durl.js
+ * Version: 1.0.5
+ * Desc: DURL keeps your i-frame's Deep URL stored in the hash fragment of your parent page
+ * Doc: https://github.com/tkasten/durl
+ * Author: Tyler Kasten tyler.kasten@gmail.com
+ */
+
+function Durl(options){
+  this.options = options || {}
+  this.deep_url_var_name = this.options.deep_url_var_name || "durl"
+  this.window = this.options.window
+  this.pm = this.options.postMassage
+
+  if(!this.pm){
+    this.pm = new PostMassage({namespace: 'durl', window: this.window})
+  }
+
+  this.options.producer ? this.bootAsProducer() : this.bootAsConsumer()
+}
+
+Durl.prototype.bootAsProducer = function(){
+  if(window != parent.window){
+    this.log("booting: " + window.location.href)
+    this.pm.bind('setDURLFromConsumer', this.setDURLFromConsumer.bind(this))
+    this.pm.call('setDURL', encodeURIComponent(window.location.href))
+    var self = this
+    document.addEventListener("DOMContentLoaded", function(){
+      if("onhashchange" in window.document.body){
+        window.addEventListener("hashchange", function(){
+          self.pm.call('setDURL', encodeURIComponent(window.location.href))
+        })
+      }
+    })
+  }else{
+    this.log("refusing to boot, no parent window detected")
+  }
+},
+
+Durl.prototype.bootAsConsumer = function(){
+  this.log("booting")
+  this.pm.bind('setDURL', this.setDURL.bind(this))
+  if("onhashchange" in window.document.body){
+    var self = this
+    window.addEventListener("hashchange", function(){
+      var durl = self.getDeepPath()
+      self.log('sendDURLFromConsumer: ' + durl)
+      self.pm.call('setDURLFromConsumer', durl)
+    })
+  }
+}
+
+Durl.prototype.matchDeepPath = function(path) {
+  /**
+    *
+    * DURL will store its durl (deep url) in the consumer's hash fragment in the
+    * form of `this.deep_url_var_name=url_encoded_url`
+    * 
+    * But we don't know how the consumer is using their hash fragment so we try
+    * to make safe, unobtrusive assumptions about how to integrate our data into
+    * their fragment. Consider the following potential use cases on their end:
+    *
+    * TKK TODO - spec these cases (also need more cases/clean-up etc)...
+    *
+    * Hash Bang style followed with traditional path and url variables
+    * www.example.com/page/path?var1=stuff#!/some/path?p1=v1&durl=value!&p2=v2z
+    * www.example.com/page/path?var1=stuff#!/some/path?p1=v1&durl=value!
+    *
+    * Same as above case but no consumer variables mixed with durl
+    * www.example.com/page/path?vars=stuff#!/some/path?durl=value!
+    *
+    * No Bang(!) just right into the variables
+    * www.example.com/page/path#?p1=v2&durl=value!
+    *
+    * Same as above but no consumer variables mixed with durl
+    * www.example.com/page/path#?durl=value!
+    *
+    */
+
+  pattern = new RegExp("(\\?|&)" + this.deep_url_var_name + "=([^&\n]*)")
+  return pattern.exec(this.vanillaHash()) || '' // [whole match, joiner, url]
+}
+
+Durl.prototype.setDURL = function(new_url) {
+  new_url = new_url || ''
+  hash = this.vanillaHash()
+
+  if(matches = this.matchDeepPath()){
+    if(matches[2] == new_url){
+      return
+    }else{
+      whole  = matches[0]
+      joiner = matches[1]
+      hash   = hash.replace(whole, joiner + this.deep_url_var_name + "=" + new_url)
+    }
+  }else{
+    hash += hash.indexOf('?') == -1 ? '?' : '&'
+    hash += this.deep_url_var_name + "=" + new_url
+  }
+
+  this.log('replacing location: ' + hash)
+  location.replace('#' + hash)
+}
+
+Durl.prototype.getDeepPath = function() {
+  if(matches = this.matchDeepPath())
+    return decodeURIComponent(matches[2])
+  else
+    return ''
+}
+
+Durl.prototype.setDURLFromConsumer = function(path) {
+  if(window.location.href != path){
+    this.log('setDURLFromConsumer: ' + path)
+    // this sillyness is in response to receiving a new path from the consumer
+    // that is a double-encoded relative path (has leading encoded '/'). It's
+    // already been decoded once before getting here, and if we still see what
+    // looks like an encoded forward flash, let's decode it again.
+    // Discovered b/c react-router (v 0.11.6) has a double encoding bug:
+    // https://github.com/petehunt/react-router-1/blob/master/CHANGELOG.md
+    if(path.substr(0,3) == "%2F"){
+      path = decodeURIComponent(path)
+    }
+    window.location.replace(path)
+  }else{
+    this.log('refusing to change frame location, path is unchanged: ' + path)
+  }
+}
+
+Durl.prototype.vanillaHash = function() {
+  // Note that we don't use location.hash because firefox alone decodes it on read.
+  // See http://stackoverflow.com/questions/1703552/encoding-of-window-location-hash
+  return location.href.split("#")[1] || ''
+}
+
+Durl.prototype.log = function(message){
+  if(this.options.logging && window.console){
+    loggerId = this.options.producer ? 'producer' : 'consumer'
+    console.log('[' + loggerId + '] ' + message)
+  }
+}
+
+function factory(){
+  return Durl
+}
+
+if (typeof define === 'function' && define.amd) {
+  define([],factory)
+} else if (typeof module === 'object' && typeof module.exports === 'object') { //Node for browserfy
+  module.exports = factory()
+} else {
+  window.Durl = window.Durl || factory()
+}

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: durl-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tyler Kasten
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: This gem provides dURL for your Rails 3+ application.
+email:
+- tyler.kasten@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSIONS.md
+- durl-rails.gemspec
+- lib/durl-rails.rb
+- lib/durl/rails.rb
+- lib/durl/rails/engine.rb
+- lib/durl/rails/version.rb
+- lib/generators/durl/install/install_generator.rb
+- vendor/assets/javascripts/durl.js
+homepage: https://github.com/tkasten/durl-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: durl-rails
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Use dURL with Rails 3+
+test_files: []