pagelet_rails 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3aa99a010f992678e4b22a55fefd07737f61f5f2
-  data.tar.gz: a39f2946ef9ebb00c36f0d10621df7ddfc806eb3
+  metadata.gz: 4e50eed9cbc5cc8321966e7f7ffe1ec0aac7f74e
+  data.tar.gz: 7a0462d6c842b876a84711e06c3c0e214c95d111
 SHA512:
-  metadata.gz: 09169c64e88710b63b47adee7ede33b2bf24cb79291bb8d25e4f6c74b2de3486526d63a63a58425f7a6cef4ee73f23be16d7e01f2b0136cc9c51daa407228ac0
-  data.tar.gz: 395a4647fef22cc347fd0ae0808522b3205e172e41e7f0378b7cc239189d513863a84c8c47aa8339a3a97ee9fdcc4928dc6e260815a3148227d40a2f5d0224e3
+  metadata.gz: 1d13544c9d7c095b7493f6873de350a548f85089626473865c22b917a9cad4772404ada34f19b3639785085265404614c4b1cf96abe1fa820971410df9aa8ac3
+  data.tar.gz: 7f226cf84f54bca6949d85d32f2a962917ad2d3774b3f4e1a7b602a7c20b85a478f0674c646235e8f87e3e4d7dcc6824f51b4993eb47c96fc7f49db2204e1167

data/README.md

@@ -11,7 +11,7 @@
 
 Don't make your users wait for page to load.
  
-[View Demo Project](https://polar-river-18908.herokuapp.com)
+[View Demo Project](http://polar-river-18908.herokuapp.com)
  
 ## Example
  
@@ -405,13 +405,28 @@ Only relevant for `remote: true` and `remote: :turbolinks` when request is loade
 
 There will be one request per group. Missing value is considered a separate group as well.
 
- 
+## All possible advantages of this gem's approach
+
+This is a list of all advantages that would be made possible by using this gem's approach of abstraction and decomposition. Note: not all features are implemented yet.
+
+- Ability to use HTTP public cache for fragment caching
+- Easier fragment caching on the server
+- Batch Ajax requests
+- Custom loading placeholders
+- Progressive rendering of the page
+- Partial page updates
+- "Super smart caching" 
+- Delay render below the fold
+- Simplified development and testing
+- Minimum DSL or new syntax
+- Asset dependencies
+- Parallel rendering
+- Take advantage of HTTP2 features
+
 ## Todo
 
 * 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.
-* fix streaming with nested layouts (rails bug?)
-* add rails 4 support
 * high test coverage
 * update actionpack-action_caching gem to support rails 5
 

data/app/helpers/pagelets_helper.rb

@@ -1,5 +1,25 @@
 module PageletsHelper
 
+  def html_container_attributes
+    html_opts = pagelet_options.html || {}
+    classes = html_opts.fetch(:class, '').split(' ')
+    classes << "pagelet-#{controller_name}"
+    classes << "pagelet-#{controller_name}-#{action_name}"
+
+    html_opts[:id] ||= pagelet_default_id
+    html_opts[:class] = classes.join(' ')
+
+    html_opts['data-pagelet-container'] = true
+
+    encode_data = pagelet_options.original_options.to_h.except('remote')
+    html_opts['data-pagelet-options'] = PageletRails::Encryptor.encode(encode_data)
+
+    if pagelet_options.ajax_group
+      html_opts['data-pagelet-group'] = pagelet_options.ajax_group
+    end
+    html_opts
+  end
+
   def pagelet_stream
     return nil if pagelet_stream_objects.empty?
     pagelet_stream_objects.each do |key, block|
@@ -24,7 +44,7 @@ module PageletsHelper
   end
 
   def pagelet path, p_options = {}
-    puts "Rendering pagelet #{path}".blue
+    Rails.logger.info "Rendering pagelet #{path}"
 
     p_params = p_options.delete(:params) { {} }.with_indifferent_access
 
@@ -72,8 +92,12 @@ module PageletsHelper
     p_request.parameters.clear
     p_request.parameters.merge! p_params
 
-    p_response = controller_class.make_response! p_request
-    c.dispatch(action, p_request, p_response)
+    if c.method(:dispatch).arity == 3
+      p_response = controller_class.make_response! p_request
+      c.dispatch(action, p_request, p_response)
+    else
+      c.dispatch(action, p_request)
+    end
 
     body = c.response.body
     body.html_safe

data/app/views/layouts/pagelet_rails/container.html.erb

@@ -0,0 +1,8 @@
+<% if pagelet_request? || pagelet_options.skip_container %>
+  <%= content_for?(:content) ? yield(:content) : yield %>
+
+<% else %>
+  <%= content_tag :div, html_container_attributes do %>
+    <%= content_for?(:content) ? yield(:content) : yield %>
+  <% end %>
+<% end %>

data/app/views/layouts/pagelet_rails/inner.html.erb

@@ -0,0 +1 @@
+<%= content_for?(:content) ? yield(:content) : yield %>

data/app/views/layouts/pagelet_rails/{loading_placeholder.slim → loading_placeholder.html.erb}

@@ -1,9 +1,8 @@
-ruby:
-  height = pagelet_options.placeholder.try(:[], :height)
-  text = pagelet_options.placeholder.try(:[], :text) || 'Loading ...'
-  height = height.is_a?(Numeric) ? "#{height}px" : 'auto'
+<% height = pagelet_options.placeholder.try(:[], :height) %>
+<% height = height.is_a?(Numeric) ? "#{height}px" : 'auto' %>
+<% text = pagelet_options.placeholder.try(:[], :text) || 'Loading ...' %>
 
-css:
+<style type="text/css">
   /* Three Bounce */
   .spinner.spinner-three-bounce {
     width: 70px;
@@ -53,14 +52,20 @@ css:
       -webkit-transform: scale(1.0);
     }
   }
+</style>
 
-
-div style="display: table; height: #{height}; overflow: hidden; width: 100%;"
-  div style="display: table-cell; vertical-align: middle;"
-    div.text-center
-      span.spinner.spinner-three-bounce
-        .bounce1
-        .bounce2
-        .bounce3
-      br
-      span = text
+<div style="display: table; height: <%= height %>; overflow: hidden; width: 100%;">
+  <div style="display: table-cell; vertical-align: middle;">
+    <div class="text-center">
+      <div class="spinner spinner-three-bounce">
+        <div class="bounce1"></div>
+        <div class="bounce2"></div>
+        <div class="bounce3"></div>
+      </div>
+      <br>
+      <span>
+        <%= text %>
+      </span>
+    </div>
+  </div>
+</div>

data/lib/pagelet_rails/concerns/controller.rb

@@ -16,13 +16,13 @@ module PageletRails::Concerns::Controller
 
     helper_method :pagelet_request?
 
-    pagelet_options layout: 'panel'
+    pagelet_options layout: 'container'
   end
 
   def layout_name
     layout = params[:layout] || pagelet_options.layout
 
-    "pagelets/#{layout}"
+    "pagelet_rails/#{layout}"
   end
 
   def pagelet_request?
@@ -33,6 +33,7 @@ module PageletRails::Concerns::Controller
 
   def append_pagelet_view_paths
     self.view_paths.unshift 'app/pagelets/'
+    self.view_paths.unshift 'test/dummy/app/pagelets/' if Rails.env.test?
 
     # lookup_context.prefixes.clear
     view = "#{controller_name}/views"

data/lib/pagelet_rails/concerns/options.rb

@@ -8,7 +8,7 @@ module PageletRails::Concerns::Options
   end
 
   def pagelet_options *args
-    set_pagelet_options *args
+    set_pagelet_options(*args)
 
     opts = self.class.pagelet_options
     class_default_opts = opts.fetch('default', {})
@@ -47,7 +47,7 @@ module PageletRails::Concerns::Options
     include Shared
 
     def pagelet_options *args
-      set_pagelet_options *args
+      set_pagelet_options(*args)
 
       if superclass && superclass.instance_variable_defined?(:@pagelet_options)
         parent = superclass.instance_variable_get :@pagelet_options

data/lib/pagelet_rails/concerns/response_wrapper.rb

@@ -14,7 +14,7 @@ module PageletRails::Concerns::ResponseWrapper
           memo
         }
 
-        if html.match /^\s*</
+        if html.match(/^\s*</)
           # the body could be javascript, make sure it's html before wrapping
 
           id = ActionController::Base.helpers.escape_javascript params[:target_container]

data/lib/pagelet_rails/concerns/routes.rb

@@ -29,52 +29,14 @@ module PageletRails::Concerns::Routes
       end
     end
 
-    # Define inline single route for the following method.
-    # It automatically adds :controller and :action names to the route
-    #
-    #     class PageletRails::Examples::ExamplesController
-    #       pageletlet_route :get, ''
-    #       def bingo
-    #       end
-    #     end
-    #
-    # will generate routes
-    #   Helper:            pagelets_examples_path
-    #   HTTP Verb:         GET
-    #   Path:              /pagelets/examples(.:format)
-    #   Controller#Action: pagelets/examples/examples#bingo
-    #
-    def pagelet_route *args
-      @pagelet_route << args
-    end
-
-    def method_added method_name
-      return unless @pagelet_route
-      @pagelet_route.each do |args|
-        options = args.extract_options!
-        options[:controller] ||= self.controller_name
-        options[:action] ||= method_name
-
-        @pagelet_routes << Proc.new do
-          scope path: options[:controller], as: options[:controller] do
-            self.send *args, options
-          end
-        end
-      end
-
-      @pagelet_route = []
-      super
-    end
-
     def load_pagelet_routes! context
       @pagelet_routes.each do |proc|
-        context.instance_eval &proc
+        context.instance_eval(&proc)
       end
     end
 
     def inherited subklass
       subklass.instance_variable_set(:@pagelet_routes, [])
-      subklass.instance_variable_set(:@pagelet_route, [])
       super
     end
   end

data/lib/pagelet_rails/version.rb

@@ -1,3 +1,3 @@
 module PageletRails
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: pagelet_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Anton Katunin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-19 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: ejs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -59,9 +73,9 @@ files:
 - app/controllers/pagelet_controller.rb
 - app/controllers/pagelet_proxy_controller.rb
 - app/helpers/pagelets_helper.rb
-- app/views/layouts/pagelet_rails/container.html.slim
-- app/views/layouts/pagelet_rails/inner.slim
-- app/views/layouts/pagelet_rails/loading_placeholder.slim
+- app/views/layouts/pagelet_rails/container.html.erb
+- app/views/layouts/pagelet_rails/inner.html.erb
+- app/views/layouts/pagelet_rails/loading_placeholder.html.erb
 - config/routes.rb
 - lib/action_controller/action_caching.rb
 - lib/action_controller/caching/actions.rb

data/app/views/layouts/pagelet_rails/container.html.slim

@@ -1,24 +0,0 @@
-- if pagelet_request? || pagelet_options.skip_container
-  = content_for?(:content) ? yield(:content) : yield
-
-- else
-  ruby:
-    html_opts = pagelet_options.html || {}
-    classes = html_opts.fetch(:class, '').split(' ')
-    classes << "pagelet-#{controller_name}"
-    classes << "pagelet-#{controller_name}-#{action_name}"
-
-    html_opts[:id] ||= pagelet_default_id
-    html_opts[:class] = classes.join(' ')
-
-    html_opts['data-pagelet-container'] = true
-
-    encode_data = pagelet_options.original_options.to_h.except('remote')
-    html_opts['data-pagelet-options'] = PageletRails::Encryptor.encode(encode_data)
-
-    if pagelet_options.ajax_group
-        html_opts['data-pagelet-group'] = pagelet_options.ajax_group
-    end
-
-  div *html_opts
-    = content_for?(:content) ? yield(:content) : yield

data/app/views/layouts/pagelet_rails/inner.slim

@@ -1 +0,0 @@
-= content_for?(:content) ? yield(:content) : yield