pagelet_rails 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce0e29cccaa2bbb2df0f627d3f6384d5e9646dce
-  data.tar.gz: 4e685ae8f50137fffed19940a7801468c2b59f8d
+  metadata.gz: 1a94ff187b504886484c7a6ea7f3e7606ee8a1b4
+  data.tar.gz: da24f459abc2b52b87bc687332467e5d37383bb3
 SHA512:
-  metadata.gz: df451c73ea6f88a1ea2ae7cc0956afaae34591a0d610e52024dfe73be726b94b41e20c21c3a38ebb5a14f9395f145cf6bc79206f3baaec574b64f431b8932be5
-  data.tar.gz: 044fee3287b458a9f4385119a0ee7fe6656ab0bd927b707a8216d9920031e27e2d0dcb2fdf704e223bede0ae4899815cd121c61030d017bba8b7e294d147e957
+  metadata.gz: 944a95a469bf4d377f17ba270bdd2dcf53034e6218b39415ae5529b60e649b51d8f0d427ef0d52e5e94ad1acd5083d20fc02ab42d14b065415b8d52456955507
+  data.tar.gz: bfec15b0d980d68efac76521ef017ef82ecd0713babce334f1e8ed5708e5a1e87eda3ff83c57dd72ac73c6579517d6512f701ac5e0623320525825a8d5371cf8

data/.gitignore

@@ -0,0 +1,17 @@
+# Ignore bundler config.
+/.bundle
+.ruby-version
+
+# Ignore Gemfile.lock
+/Gemfile.lock
+/gemfiles/*.gemfile.lock
+
+# Ignore test files
+/coverage
+
+# Ignore dummy app files
+/test/dummy/db/*.sqlite3
+/test/dummy/db/*.sqlite3-journal
+/test/dummy/log/*.log
+/test/dummy/tmp/
+

data/.travis.yml

@@ -0,0 +1,14 @@
+dist: trusty
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+gemfile:
+  - gemfiles/rails_4.2.8.gemfile
+  - gemfiles/rails_5.0.2.gemfile
+  - gemfiles/rails_5.1.0.gemfile
+after_success:
+  - bundle exec codeclimate-test-reporter

data/Appraisals

@@ -0,0 +1,14 @@
+RAILS_VERSIONS = %w(
+  4.2.8
+  5.0.2
+  5.1.0
+)
+
+RAILS_VERSIONS.each do |version|
+  appraise "rails_#{version}" do
+    gem 'rails', version
+
+    # http://stackoverflow.com/questions/43886586/minitest-plugin-rb9-getting-wrong-number-of-arguments
+    gem 'minitest', '~> 5.10', '!= 5.10.2'
+  end
+end

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+### 0.1.7
+
+- fixed Rails 5.1
+- added compatibility with Rails 2.4
+
+### 0.1.6
+
+- fixed #3 include more data in pagelet request
+
+### 0.1.5
+
+- fixed #2 when routes were causing error 
+
+### 0.1.4
+
+- added support for server side includes rendering mode
+
+### 0.1.3
+
+- fixed #1 - ajax loading of single pagelet fails over https
+- fixed templates
+- fixed placeholder style
+
+### 0.1.2
+
+- removed 'slim' dependency
+- rails 4 support
+
+### 0.1.1
+
+- fixed bugs with missing styles and dependencies
+ 
+### 0.1.0
+
+- extracted as a separate gem

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter', require: nil
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright 2016 Anton Katunin
+
+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,25 +1,29 @@
 # PageletRails
 
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/antulik/pagelet_rails/master/LICENSE)
 [![Gem Version](https://badge.fury.io/rb/pagelet_rails.svg)](https://badge.fury.io/rb/pagelet_rails)
+[![Build Status](https://travis-ci.org/antulik/pagelet_rails.svg?branch=master)](https://travis-ci.org/antulik/pagelet_rails)
+[![Code Climate](https://codeclimate.com/github/antulik/pagelet_rails/badges/gpa.svg)](https://codeclimate.com/github/antulik/pagelet_rails)
+[![Test Coverage](https://codeclimate.com/github/antulik/pagelet_rails/badges/coverage.svg)](https://codeclimate.com/github/antulik/pagelet_rails/coverage)
 
 Warning: This gem is still in testing, so API might change.
 
 ## Why?
 
-* Do you have pages with a lot of information? 
+* Do you have pages with a lot of information?
 * The pages where you need to get data from 5 or 10 different sources?
 * What if one of them is slow?
 * Does this mean your users have to wait?
 
 Don't make your users wait for page to load.
- 
+
 [View Demo Project](http://polar-river-18908.herokuapp.com)
- 
+
 ## Example
- 
+
 ![](https://camo.githubusercontent.com/50f4078cc4015e3df89afc753a5ff79828ac0e8e/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f662e636c2e6c792f6974656d732f303031323133314d324b3147335831483276314f2f313433303033383036373738372e6a7067)
 
-For example let's take facebook user home page. It has A LOT of data, but it loads very quickly. How? The answer is [perceived performance](https://en.wikipedia.org/wiki/Perceived_performance). It's not about in how many milliseconds you can serve request, but how fast it **feels** to the user. 
+For example let's take facebook user home page. It has A LOT of data, but it loads very quickly. How? The answer is [perceived performance](https://en.wikipedia.org/wiki/Perceived_performance). It's not about in how many milliseconds you can serve request, but how fast it **feels** to the user.
 
 The page body is served instantly and all the data is loaded after. Even for facebook it takes multiple seconds to fully load the page. But it feels instant, that it's all about.
 
@@ -33,12 +37,12 @@ Originally I saw such solution implemented at Facebook and Linkedin. Each page c
 
 ## What is Pagelet?
 
-You can break a web page into number of sections, where each one is responsible for its own functionality. Pagelet is the name for each section. It is a part of the page which has it's own route, controller and view. 
+You can break a web page into number of sections, where each one is responsible for its own functionality. Pagelet is the name for each section. It is a part of the page which has it's own route, controller and view.
+
+The closest alternative in ruby is [cells gem](https://github.com/apotonick/cells). After using it for long time I've faced many limitations of its approach. Cells has a custom Rails-like syntax but not quite. That is frustrating as you have to learn and remember those differences. The second issue, and the biggest, cells are internal only and not designed to be routable. This stops many great possibilities for improving perceived performance, as request has to wait for all cells to render.
 
-The closest alternative in ruby is [cells gem](https://github.com/apotonick/cells). After using it for long time I've faced many limitations of its approach. Cells has a custom Rails-like syntax but not quite. That is frustrating as you have to learn and remember those differences. The second issue, and the biggest, cells are internal only and not designed to be routable. This stops many great possibilities for improving perceived performance, as request has to wait for all cells to render.  
- 
 Pagelet_rails is built on top of Rails and uses it as much as possible. The main philosophy: **Do not reinvent the wheel, build on shoulders of giants.**
- 
+
 
 # Usage
 
@@ -85,16 +89,16 @@ app
 ```ruby
 # app/pagelets/current_time/current_time_controller.rb
 class CurrentTime::CurrentTimeController < ApplicationController
-  include PageletRails::Concerns::Controller  
-  
+  include PageletRails::Concerns::Controller
+
   # add pagelets_current_time_path route
   # which gives "/pagelets/current_time" url route
-  pagelet_resource only: [:show] 
+  pagelet_resource only: [:show]
 
   def show
   end
 end
-``` 
+```
 
 ```erb
 <!-- Please note view path -->
@@ -130,7 +134,7 @@ And now use it anywhere in your view
 
 ## Pagelet view helper
 
-`pagelet` helper allows you to render pagelets in views. Name of pagelet is its path. 
+`pagelet` helper allows you to render pagelets in views. Name of pagelet is its path.
 
 For example pagelet with route `pagelets_current_time_path` will have `pagelets_current_time` name.
 
@@ -198,22 +202,22 @@ You can pass any other data and it will be available in `pagelet_options`
 ```ruby
 class CurrentTime::CurrentTimeController < ::ApplicationController
   include PageletRails::Concerns::Controller
-  
+
   # Set default option for all actions
-  pagelet_options remote: true 
-  
+  pagelet_options remote: true
+
   # set option for :show and :edit actions only
-  pagelet_options :show, :edit, remote: :turbolinks 
-  
+  pagelet_options :show, :edit, remote: :turbolinks
+
   def show
   end
-  
+
   def new
   end
-  
+
   def edit
   end
-  
+
 end
 ```
 
@@ -226,37 +230,37 @@ end
 
 ## Inline routes
 
-Because pagelets are small you will have many of them. In order to keep them under control pagelet_rails provides helpers. 
+Because pagelets are small you will have many of them. In order to keep them under control pagelet_rails provides helpers.
 
 You can inline routes inside you controller.
 
 ```ruby
 class CurrentTime::CurrentTimeController < ::ApplicationController
   include PageletRails::Concerns::Controller
-  
+
   pagelet_resource only: [:show]
   # same as in config/routes.rb:
   #
   # resource :current_time, only: [:show]
   #
-  
+
   pagelet_resources
   # same as in config/routes.rb:
   #
   # resources :current_time
   #
-    
+
   pagelet_routes do
     # this is the same context as in config/routes.rb:
     get 'show_me_time' => 'current_time/current_time#show'
   end
-  
+
 end
 ```
 
 ## Pagelet cache
 
-Cache of pagelet rails is built on top of [actionpack-action_caching gem](https://github.com/rails/actionpack-action_caching). 
+Cache of pagelet rails is built on top of [actionpack-action_caching gem](https://github.com/rails/actionpack-action_caching).
 
 Simple example
 
@@ -264,7 +268,7 @@ Simple example
 # app/pagelets/current_time/current_time_controller.rb
 class CurrentTime::CurrentTimeController < ::ApplicationController
   include PageletRails::Concerns::Controller
-  
+
   pagelet_options expires_in: 10.minutes
 
   def show
@@ -275,7 +279,7 @@ end
 
 ### cache_path
 
-Is a hash of additional parameters for cache key. 
+Is a hash of additional parameters for cache key.
 
 * `Hash` - static hash
 * `Proc` - dynamic params, it must return hash. Eg. `Proc.new { params.permit(:sort_by) }`
@@ -284,7 +288,7 @@ Is a hash of additional parameters for cache key.
 
 ### expires_in
 
-Set the cache expiry. For example `expires_in: 1.hour`. 
+Set the cache expiry. For example `expires_in: 1.hour`.
 
 Warning: if `expires_in` is missing, it will be cached indefinitely.
 
@@ -330,7 +334,7 @@ In the example above cache will be scoped per `user_id` and for 5 minutes unless
   </p>
 </div>
 ```
-Please note `remote: true` option for `link_to`. 
+Please note `remote: true` option for `link_to`.
 
 This is default Rails functionality with small addition. If that link is inside pagelet, than controller response will be replaced in that pagelet.
 
@@ -338,14 +342,14 @@ This is default Rails functionality with small addition. If that link is inside
 # app/pagelets/current_time/current_time_controller.rb
 class CurrentTime::CurrentTimeController < ::ApplicationController
   include PageletRails::Concerns::Controller
-  
+
   pagelet_resource only: [:show]
 
   def show
   end
 
 end
-``` 
+```
 
 This will partially update the page and replace only that pagelet.
 
@@ -356,12 +360,14 @@ This is the most efficient way to deliver data with minimum delays. The placehol
 
 This mode requires rendering of templates with [streaming mode](http://api.rubyonrails.org/classes/ActionController/Streaming.html) enabled.
 
+Warning: Session and Cookies are currently not supported in streaming mode.
+
 ```ruby
   #...
   def show
     render :show, stream: true
   end
-  #...  
+  #...
 ```
 
 In you layout add `pagelet_stream` right before `</body>` tag.
@@ -376,7 +382,7 @@ In you layout add `pagelet_stream` right before `</body>` tag.
 </body>
 ```
 
-Usage: 
+Usage:
 
 ```erb
 <%= pagelet :pagelets_current_time, remote: :stream %>
@@ -384,15 +390,15 @@ Usage:
 
 **Warning!!!** You also should have webserver compatible for streaming like puma, passenger or unicorn (requires special config).
 
-**Warning!!!** you need to have multiple threads/processes configured in the web server. This is required so the page could fetch assets while content is streaming. 
- 
-Finally if everything is done right you should see significant rendering speed improvements especially on old browsers, slow network or with cold cache. 
+**Warning!!!** you need to have multiple threads/processes configured in the web server. This is required so the page could fetch assets while content is streaming.
+
+Finally if everything is done right you should see significant rendering speed improvements especially on old browsers, slow network or with cold cache.
 
 
 ### Super smart caching
 
 Probably one of the coolest functionality of pagelet_rails is "super smart caching". It allows you to render pagelets through ajax and cache them, but if page is reloaded the pagelet is rendered instantly from cache.
- 
+
  So on the first page load user sees "Loading..." blocks, but after the content is instant.
 
 The best thing, it's enabled by default if pagelet has caching enabled and is rendering through ajax request.
@@ -410,6 +416,8 @@ There will be one request per group. Missing value is considered a separate grou
 
 ## Todo
 
+* assets support with webpacker in rails 5.1
+* session (and CSRF) support in streaming mode
 * delay load of not visible pagelets (aka. below the fold)
   * do not load pagelets which are not visible to the user until user scrolls down. For example like Youtube comments.
 * high test coverage

data/app/assets/javascripts/pagelet_rails.js

@@ -38,7 +38,7 @@
   };
 
   root.loadThroughBatchProxy = function(urls) {
-    if (urls.length == 0) { return; }
+    if (urls.length === 0) { return; }
 
     var prev_index = 0;
 
@@ -59,7 +59,7 @@
         do {
           end_index = text.indexOf("\n\n//\n\n", prev_index);
 
-          if (end_index != -1) {
+          if (end_index !== -1) {
             var new_text = text.substring(prev_index, end_index);
 
             eval(new_text);
@@ -69,7 +69,7 @@
             // console.log(new_text);
           }
 
-        } while (end_index != -1);
+        } while (end_index !== -1);
       }
     });
   };
@@ -102,7 +102,7 @@
       if (groups.hasOwnProperty(group_name)) {
         var group = groups[group_name];
 
-        if (group.length == 1) {
+        if (group.length === 1) {
           root.loadDirectly(group[0]);
         } else {
           var urls = group.map(function(e) { return e.url; });
@@ -179,7 +179,3 @@
 
   initialise();
 })(window);
-
-
-
-

data/app/controllers/pagelet_controller.rb

@@ -1,4 +1,3 @@
 class PageletController < ::ApplicationController
   include PageletRails::Concerns::Controller
-
 end

data/app/helpers/pagelets_helper.rb

@@ -70,13 +70,20 @@ module PageletsHelper
       }
     end
 
-    p_options.deep_merge! parent_params: params.to_h
+    parent_params =
+      if params.respond_to?(:to_unsafe_h)
+        params.to_unsafe_h
+      else
+        params.to_h
+      end
+
+    p_options.deep_merge! parent_params: parent_params
 
     c = controller_class.new
     c.pagelet_options p_options
     c.pagelet_options original_options: p_options
 
-    env = request.env.select do |key, value|
+    env = request.env.select do |key, _value|
       case key.to_s
       when /^action_dispatch\.request/i,
         /^action_controller/i,