unpoly-rails 0.20.0

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rack'
+gem 'therubyracer'
+gem 'sass'
+gem 'uglifier'
+gem 'coffee-script'
+gem 'sprockets-standalone'

data/Gemfile.lock

@@ -0,0 +1,42 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.9.1.1)
+    execjs (2.5.2)
+    hike (1.2.3)
+    json (1.8.2)
+    libv8 (3.16.14.11)
+    multi_json (1.10.1)
+    rack (1.6.0)
+    rake (10.4.2)
+    ref (1.0.5)
+    sass (3.4.11)
+    sprockets (2.12.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-standalone (1.2.1)
+      rake
+      sprockets (~> 2.0)
+    therubyracer (0.12.1)
+      libv8 (~> 3.16.14.0)
+      ref
+    tilt (1.4.1)
+    uglifier (2.7.0)
+      execjs (>= 0.3.0)
+      json (>= 1.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coffee-script
+  rack
+  sass
+  sprockets-standalone
+  therubyracer
+  uglifier

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014-2015 Henning Koch
+
+MIT License
+
+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,75 @@
+Unpoly + Rails bindings
+=======================
+
+Unpoly gives your traditional web application fast-responding views with minimal changes to your code and development style. If you require modern UX but don't want to pay the Javascript complexity tax, Unpoly can be a solution for you.
+
+This repository is home both to the Unpoly javascript code and its (optional) bindings for Ruby on Rails (`unpoly-rails` gem).
+
+
+Getting started
+---------------
+
+- See [unpoly.com](http://unpoly.com) for more information and Javascript API documentation.
+- See [`CHANGELOG.md`](https://github.com/unpoly/unpoly/blob/master/CHANGELOG.md) for notable changes.
+- See [`README_RAILS.md`](https://github.com/unpoly/unpoly/blob/master/README_RAILS.md) documentation of the Rails bindings.
+
+
+Development
+-----------
+
+### Running tests
+
+Overview:
+
+- This currently requires Ruby
+- There's a Rails app in `spec_app`
+- Jasmine tests for Unpoly live in `spec_app/spec/javascripts`
+- RSpec tests for the `unpoly-rails` gem live in `spec_app/spec/controllers`
+
+Install dependencies for tests:
+
+- Install Ruby 2.1.2
+- Install Bundler by running `gem install bundler`
+- `cd` into `spec_app`
+- Install dependencies by running `bundle install`
+
+To run Jasmine tests for Unpoly:
+
+- `cd` into `spec_app`
+- Start the Rails server by running `rails server`
+- Access `http://localhost:3000/specs` to see the Jasmine test runner
+
+To run RSpec tests for the `unpoly-rails` gem:
+
+- `cd` into `spec_app`
+- Run `rspec`
+
+
+### Making a new release
+
+We are currently feeding three release channels:
+
+- Manual download from Github
+- Bower (this also fetches from Github)
+- Rubygems (as the `unpoly-rails` gem)
+
+We always release to all channel simultaneously.
+
+To make a new release:
+
+- Edit `lib/unpoly/rails/version.rb` and bump the version number. Use [semantic versioning](http://semver.org/).
+- Add an entry to `CHANGELOG.md`
+- Commit and push the version bump and `CHANGELOG.md`
+- From the project root, type `rake assets:compile`. This will output minified JS and CSS files to the `dist` folder.
+- Commit and push the generated files in `dist`
+- From the project root, type `rake release`. This will publish a new gem version to Rubygems.org.
+  It will also push a tag for this version, which Bower requires for its own versioning scheme.
+
+Always run `rake assets:compile` before `rake release` so the git tag points to the correct commit (required for Bower versioning).
+
+
+Credits
+-------
+
+- [Henning Koch](mailto:henning.koch@makandra.de) from ([makandra](http://www.makandra.com) ([@triskweline](https://twitter.com/triskweline) on Twitter)
+

data/README_RAILS.md

@@ -0,0 +1,116 @@
+unpoly-rails: Ruby on Rails bindings for Unpoly
+===============================================
+
+[Unpoly](http://unpoly.com) is a backend-agnostic progressive enhancement framework. `unpoly-rails` gives your [Ruby on Rails](http://rubyonrails.org/) application some convenience candy when you are using Unpoly in your frontend.
+
+
+Features
+--------
+
+The methods documented below are available in all controllers, views and helpers.
+
+### Detecting a fragment update
+
+To test whether the current request is a [fragment update](http://unpoly.com/up.replace):
+
+    up?
+
+To retrieve the CSS selector that is being [updated](http://unpoly.com/up.replace):
+
+    up.selector
+
+The Unpoly frontend will expect an HTML response containing an element that matches this selector. If no such element is found, an error is shown to the user. Server-side code is free to optimize its response by only returning HTML that matches this selector.
+
+### Pushing a document title to the client
+
+To force Unpoly to set a document title when processing the response:
+
+    up.title = 'Title from server'
+
+This is useful when you skip rendering the `<head>` in an Unpoly request.
+
+### Detecting an Unpoly form validation
+
+To test whether the current request is a [form validation](http://unpoly.com/up-validate):
+
+    up.validate?
+
+When detecting a validation request, the server is expected to validate (but not save) the form submission and render a new copy of the form with validation errors. A typical saving action should behave like this:
+
+    class UsersController < ApplicationController
+
+      def create
+        user_params = params[:user].permit(:email, :password)
+        @user = User.new(user_params)
+        if up.validate?
+          @user.valid?  # run validations, but don't save to the database
+          render 'form' # render form with error messages
+        elsif @user.save?
+          sign_in @user
+        else
+          render 'form', status: :bad_request
+        end
+      end
+
+    end
+
+### Automatic redirect detection
+
+`unpoly-rails` installs a `before_filter` into all controllers which echoes the request's URL as a response header `X-Up-Location` and the request's
+HTTP method as `X-Up-Method`.
+
+The Unpoly frontend [requires these headers to detect redirects](http://unpoly.com/form-up-target#redirects), which are otherwise undetectable for an AJAX client.
+
+### Automatic method detection for initial page load
+
+`unpoly-rails` sets an `_up_request_method` cookie that Unpoly needs to detect the request method for the initial page load.
+
+If the initial page was loaded with a non-`GET` HTTP method, Unpoly will fall back to full page loads for all actions that require `pushState`.
+
+The reason for this is that some browsers remember the method of the initial page load and don't let the application change it, even with `pushState`. Thus, when the user reloads the page much later, an affected browser might request a `POST`, `PUT`, etc. instead of the correct method.
+
+
+What you still need to do manually
+----------------------------------
+
+### Failed form submissions must return a non-200 status code
+
+Unpoly lets you submit forms via AJAX by using the [`form[up-target]`](http://unpoly.com/form-up-target) selector or [`up.submit`](http://unpoly.com/up.submit) function.
+
+For Unpoly to be able to detect a failed form submission, the form must be re-rendered with a non-200 HTTP status code. We recommend to use either 400 (bad request) or 422 (unprocessable entity).
+
+To do so in Rails, pass a [`:status` option to `render`](http://guides.rubyonrails.org/layouts_and_rendering.html#the-status-option):
+
+    class UsersController < ApplicationController
+
+      def create
+        user_params = params[:user].permit(:email, :password)
+        @user = User.new(user_params)
+        if @user.save?
+          sign_in @user
+        else
+          render 'form', status: :bad_request
+        end
+      end
+
+    end
+
+
+Development
+-----------
+
+### Before you make a PR
+
+Before you make a PR, please have some discussion about the proposed change by [opening an issue on Github](https://github.com/unpoly/unpoly/issues/new).
+
+### Running tests
+
+- Install Ruby 2.1.2
+- Install Bundler by running `gem install bundler`
+- `cd` into `spec_app`
+- Install dependencies by running `bundle install`
+- Run `rspec`
+
+### Making a new release
+
+New versions of `unpoly-rails` are released as part of the [Unpoly release process](https://github.com/unpoly/unpoly/blob/master/README.md#making-a-new-release).

data/Rakefile

@@ -0,0 +1,45 @@
+require "bundler/gem_tasks"
+require 'sass/util'
+require 'sass/script'
+require 'sprockets/standalone'
+
+module Unpoly
+  module Assets
+    MANIFESTS = %w(unpoly.js unpoly-bootstrap3.js unpoly.css unpoly-bootstrap3.css)
+    SOURCES = %w(lib/assets/javascripts lib/assets/stylesheets)
+    OUTPUT = 'dist'
+  end
+end
+
+Sprockets::Standalone::RakeTask.new(:source_assets) do |task, sprockets|
+  task.assets   = Unpoly::Assets::MANIFESTS
+  task.sources  = Unpoly::Assets::SOURCES
+  task.output   = Unpoly::Assets::OUTPUT
+  task.compress = false
+  task.digest   = false
+  sprockets.js_compressor  = nil
+  sprockets.css_compressor = nil
+end
+
+Sprockets::Standalone::RakeTask.new(:minified_assets) do |task, sprockets|
+  task.assets   = Unpoly::Assets::MANIFESTS
+  task.sources  = Unpoly::Assets::SOURCES
+  task.output   = Unpoly::Assets::OUTPUT
+  task.compress = false
+  task.digest   = false
+  sprockets.js_compressor  = :uglifier
+  sprockets.css_compressor = :sass
+end
+
+namespace :assets do
+  desc 'Compile assets for Bower and manual download'
+  task :compile do
+    Rake::Task['minified_assets:compile'].invoke
+    Unpoly::Assets::MANIFESTS.each do |manifest|
+      source = "dist/#{manifest}"
+      target = "dist/#{manifest.sub(/\.([^\.]+)$/, '.min.\\1')}"
+      File.rename(source, target)
+    end
+    Rake::Task['source_assets:compile'].invoke
+  end
+end

data/bower.json

@@ -0,0 +1,26 @@
+{
+  "name": "unpoly",
+  "homepage": "https://github.com/unpoly/unpoly",
+  "authors": [
+    "Henning Koch <henning.koch@makandra.de>"
+  ],
+  "description": "Progressive enhancement Javascript framework",
+  "main": ["dist/unpoly.js", "dist/unpoly.css"],
+  "license": "MIT",
+  "ignore": [
+    "bin",
+    "design",
+    "doc",
+    "lib",
+    "pkg",
+    "spec_app",
+    "Gemfile",
+    "Gemfile.lock",
+    "Rakefile",
+    ".ruby-version",
+    "unpoly-rails.gemspec"
+  ],
+  "dependencies": {
+    "jquery": ">= 1.9.1"
+  }
+}

data/design/animation-ghosting.txt

@@ -0,0 +1,72 @@
+animate($element)
+
+  gar nix, ghosting macht NUR transition
+  
+  ($old und $new muss anders gehandelt werden)
+
+transition($old, $new)
+
+  1. $old.css(display: none)
+  
+  2. $new in den DOM setzen
+  
+  3. $new ausmessen
+  
+  4. ghost von $new erstellen
+     DOM kopieren
+     mit position: fixed
+     mit ausmessen des originals
+       left, top setzen
+       right, bottom löschen
+       width, height setzen
+       margin löschen
+
+  5. $new.css(display: none)
+  
+  6. $old.css(display: previousDisplay)
+        
+  7. ghost von $old erstellen
+  
+  8. $old.css(opacity: 0) // damit es den platz wegnimmt
+          
+  9. transition($oldGhost, $newGhost)
+  
+  10. $old löschen
+      $oldGhost löschen
+      $newGhost löschen
+  
+  11. $new.css(display: previousDisplay)
+  
+  
+was löst das, was nicht?
+========================
+
+- die teile müssen nicht mehr absolut gestellt werden
+- old muss immer noch absolut gehen :(
+ 
+
+  
+    
+
+
+
+  1. Ich kopiere $old zu $ghost
+
+  2. Ich setze die opacity von $old auf 0
+
+  3. Ich setze $ghost auf die Größe von $old
+    mit position: fixed
+    mit ausmessen des originals
+      left, top setzen
+      right, bottom löschen
+      width, height setzen
+      margin löschen
+      
+  ???????????
+
+  4. ich gebe $ghost an die animation
+
+  5. nach der animation
+    setze ich $opacity von $element auf 1
+    lösche ich $ghost
+

data/design/design.txt

@@ -0,0 +1,34 @@
+Gedanke 1
+---------
+- Immer die ganze Seite rendern ist langsam
+  - Optimierung nicht möglich: Layout überspringen wenn up-Request
+  - Optimierung nicht möglich: Manche Bereiche nicht rendern wenn up-Request
+  - Optimierung nicht möglich: Manche Bereiche nur für bestimmte X-Up-Selectors rendern
+- Das alles nur, um beim Back-Button sofort das HTML anzeigen zu können?
+- Sogar Turbolinks macht das nur Opt-In
+- Ich kann genauso gut bei popstate den aktuellen State replacen
+- Später: Opportunistisch cachen. Wann immer ich einen vollen Page-Load (mit/ohne Layout) sehe => cachen
+
+Gedanke 2
+---------
+- Das mit dem up.app und up.page checkt kein Mensch
+- In der Praxis wird es so sein, dass wichtige page-Handler nicht mehr in der Seite stehen
+- Ich brauche auch noch Code, um <script>-Tags auszuführen
+- Die Unterscheidung mache ich ja nur, um installierte Callbacks wieder wegzuräumen
+- Was ich eigentlich bräuchte, wäre ein Weg, installierte Callbacks geregelt lozuwerden
+
+     z. B.
+
+     up.compiler('.note_form', function($element) {
+
+      var timer = setTimeout(...)
+
+      function uninstall() {
+        clearInterval(timer);
+      }
+
+      return uninstall;
+
+     });
+
+- Vor dem Ersetzen eines Elements kann ich dann die uninstall-Funktion aufrufen.