lazy_render 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 162bcd81c6d2834ceb78bcba7ac6dc01d288ae39
+  data.tar.gz: 5f0140f4a30735176c8d082383c61f1d09ac97a6
+SHA512:
+  metadata.gz: 3a50a4c9a59a3a7a276ef5715836d66715fb41ab13803297f068c963556a65efe6fd5fde8c1fff3bf06ec7fba43081d6345b461ae94901ef6283919f6ce5bbb8
+  data.tar.gz: 39e5dd6a341c1aafb90f974d9c1dc857c9ac7863636e7158995b67613d5cb2dccb314b6c99459184ad1e30a10187526acd1ea49174a7017caf75f01d84d1a4af

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 vexus2
+
+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/Rakefile

@@ -0,0 +1,35 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LazyRender'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/test_app/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+task :default => :spec
+

data/app/assets/javascripts/lazy_render.js

@@ -0,0 +1,86 @@
+//= require jquery
+
+var LazyRender = {
+  load                 : function (context) {
+    var lazy_renders = [];
+    var lazy_render_elms = [];
+    $('[class^=js-lazy-render]', context).each(function () {
+      var param = {
+        name     : $(this).data('lazy-render-name'),
+        locals   : $(this).data('lazy-render-params'),
+        cache    : $(this).data('lazy-render-cache'),
+        version  : $(this).data('lazy-render-version'),
+        callback : $(this).data('lazy-render-callback')
+      };
+      if (param['cache']) {
+        var cache = LazyRender.cache_read(param['name'] + $(this).attr('data-lazy-render-lazy_renders'), param['version']);
+        if (cache) {
+          LazyRender.apply(this, param, cache);
+          return;
+        }
+      }
+      lazy_render_elms[lazy_render_elms.length] = this;
+      lazy_renders.push(param);
+    });
+    $.ajax({
+      type     : 'post',
+      url      : '/lazy_render/load',
+      data     : {
+        lazy_renders : lazy_renders,
+        referrer     : document.referrer ? document.referrer : ''
+      },
+      cache    : false,
+      dataType : 'json',
+      success  : function (result) {
+        $(lazy_renders).each(function (i, lazy_render) {
+          LazyRender.apply(lazy_render_elms[i], lazy_render, result[i]);
+          if (lazy_render['cache']) {
+            LazyRender.cache_write(result[i], lazy_render['name'] + $(lazy_render_elms[i]).attr('data-lazy-render-lazy_renders'), lazy_render['version'], lazy_render['cache']);
+          }
+        });
+      }
+    });
+  },
+  apply                : function (elm, data, html) {
+    if ($(elm).data('lazy-render-replace') == 'inner') {
+      $(elm).html(html);
+    } else {
+      $(elm).replaceWith(html);
+    }
+    if (data['callback']) {
+      eval(data['callback'] + '(data, elm);');
+    }
+  },
+  cache_storage_prefix : 'lazy_render_cache_',
+  cache_storage_key    : function (key) {
+    return location.protocol + this.cache_storage_prefix + key;
+  },
+  cache_read           : function (key, version) {
+    if (typeof sessionStorage == 'undefined' || typeof JSON == 'undefined') return false;
+    if (location.search.match('cacheclear=1')) return false;
+    try {
+      var cache = JSON.parse(sessionStorage[this.cache_storage_key(key)]);
+      if (!cache) return false;
+      var now = new Date / 1e3 | 0;
+      return cache['expire'] > now && cache['version'] == version ? cache['data'] : false;
+    }catch (e) {
+      return false;
+    }
+  },
+  cache_write          : function (data, key, version, lifetimesec) {
+    if (typeof sessionStorage == 'undefined' || typeof JSON == 'undefined') return false;
+    sessionStorage[this.cache_storage_key(key)] = JSON.stringify({
+      data    : data,
+      version : version,
+      expire  : (new Date / 1e3 | 0) + lifetimesec
+    });
+    return true;
+  }
+};
+
+
+$(function () {
+  if ($('[class^=js-lazy-render]').length > 0) {
+    LazyRender.load(document);
+  }
+});

data/app/controllers/lazy_render/application_controller.rb

@@ -0,0 +1,4 @@
+module LazyRender
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/lazy_render/lazyload_controller.rb

@@ -0,0 +1,27 @@
+require_dependency 'lazy_render/application_controller'
+
+module LazyRender
+  class LazyloadController < ApplicationController
+    protect_from_forgery with: :null_session
+
+    def load
+      return unless params['lazy_renders']
+      result = []
+      @data  = {}
+      params['lazy_renders'].values.each do |v|
+        next unless v['name']
+        data = {
+            name:   v['name'],
+            locals: v['locals'] || {}
+        }
+        data[:locals].empty? ? send(data[:name]) : send(data[:name], data[:locals])
+        # TODO: Add Benchmark time
+        html = render_to_string 'lazy_render/' + data[:name].gsub('__', '/'), layout: false, locals: { data: @data || {} }
+        result << html
+      end
+
+      render json: result
+    end
+
+  end
+end

data/app/helpers/lazy_render/application_helper.rb

@@ -0,0 +1,4 @@
+module LazyRender
+  module ApplicationHelper
+  end
+end

data/app/helpers/lazy_render/lazyload_helper.rb

@@ -0,0 +1,12 @@
+module LazyRender
+  module LazyloadHelper
+    def lazy_render(name, locals: {}, cache: false, callback: false)
+      data = {'lazy-render-name' => name}
+      data['lazy-render-params'] = locals if locals.instance_of?(Hash) && locals.presence
+      data['lazy-render-cache'] = cache.to_i if cache
+      data['lazy-render-callback'] = callback if callback
+      content_tag :span, nil, class: "js-lazy-render-#{name}", data: data
+    end
+
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+LazyRender::Engine.routes.draw do
+end

data/lib/lazy_render.rb

@@ -0,0 +1,4 @@
+require 'lazy_render/engine'
+
+module LazyRender
+end

data/lib/lazy_render/engine.rb

@@ -0,0 +1,17 @@
+require 'lazy_render/rails/routes'
+module LazyRender
+  class Engine < ::Rails::Engine
+    isolate_namespace LazyRender
+
+    initializer 'lazy_render.lazyload_controller' do |app|
+       ActiveSupport.on_load :lazyload_controller do
+         helper LazyRender::LazyloadHelper
+       end
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+    end
+  end
+end

data/lib/lazy_render/rails/routes.rb

@@ -0,0 +1,11 @@
+require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/hash/slice'
+
+module ActionDispatch::Routing
+  class Mapper
+    def lazy_render_for(path, *block)
+      options = block.extract_options!
+      match "#{path}", to: "#{options[:to]}#load", via: 'post'
+    end
+  end
+end

data/lib/lazy_render/version.rb

@@ -0,0 +1,3 @@
+module LazyRender
+  VERSION = "0.1.0"
+end

data/lib/tasks/lazy_render_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :lazy_render do
+#   # Task goes here
+# end

data/spec/controllers/lazy_render/lazy_render_controller_spec.rb

@@ -0,0 +1,7 @@
+require 'rails_helper'
+
+module LazyRender
+  RSpec.describe LazyRenderController, :type => :controller do
+
+  end
+end

data/spec/features/lazy_render_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'LazyRender', :type => :feature, js: true do
+  before { visit root_path; sleep 1 }
+  describe 'is show lazy_render messages after secs' do
+    it { expect(page).to have_content('LazyRender Message') }
+    it { expect(page).to have_content('value1') }
+    it { expect(page).to have_content('value2') }
+    it { expect(page).to have_content('sample text') }
+    it { expect(page).to have_content('Separated by the directory') }
+  end
+end

data/spec/helpers/lazy_render/lazy_render_helper_spec.rb

@@ -0,0 +1,37 @@
+require 'rails_helper'
+
+# Specs in this file have access to a helper object that includes
+# the LazyloadHelper. For example:
+#
+# describe LazyloadHelper do
+#   describe "string concat" do
+#     it "concats two strings with spaces" do
+#       expect(helper.concat_strings("this","that")).to eq("this that")
+#     end
+#   end
+# end
+module LazyRender
+  RSpec.describe LazyloadHelper, :type => :helper do
+
+    describe '#lazy_render' do
+      it 'return span tag with class and name' do
+        expect(helper.lazy_render('sample_class')).to eq "<span class=\"js-lazy-render-sample_class\" data-lazy-render-name=\"sample_class\"></span>"
+        expect(helper.lazy_render('sample_class', locals: [])).to eq "<span class=\"js-lazy-render-sample_class\" data-lazy-render-name=\"sample_class\"></span>"
+        expect(helper.lazy_render('sample_class', locals: 'Sample')).to eq "<span class=\"js-lazy-render-sample_class\" data-lazy-render-name=\"sample_class\"></span>"
+      end
+      it 'return span tag with class and name and locals' do
+        expect(helper.lazy_render('sample_class', locals: { var1: 'var3', var2: 'var4' })).to eq "<span class=\"js-lazy-render-sample_class\" data-lazy-render-name=\"sample_class\" data-lazy-render-params=\"{&quot;var1&quot;:&quot;var3&quot;,&quot;var2&quot;:&quot;var4&quot;}\"></span>"
+      end
+
+      it 'return span tag with class and name and cache params' do
+        expect(helper.lazy_render('sample_class', cache: 200)).to eq "<span class=\"js-lazy-render-sample_class\" data-lazy-render-name=\"sample_class\" data-lazy-render-cache=\"200\"></span>"
+        expect(helper.lazy_render('sample_class', cache: '300')).to eq "<span class=\"js-lazy-render-sample_class\" data-lazy-render-name=\"sample_class\" data-lazy-render-cache=\"300\"></span>"
+        expect(helper.lazy_render('sample_class', cache: 'abc')).to eq "<span class=\"js-lazy-render-sample_class\" data-lazy-render-name=\"sample_class\" data-lazy-render-cache=\"0\"></span>"
+      end
+
+      it 'return span tag with class and name and callback method' do
+        expect(helper.lazy_render('sample_class', callback: 'Activity.start')).to eq "<span class=\"js-lazy-render-sample_class\" data-lazy-render-name=\"sample_class\" data-lazy-render-callback=\"Activity.start\"></span>"
+      end
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,65 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+ENV["RAILS_ROOT"] ||= File.dirname(__FILE__) + "../../../spec/test_app"
+require 'spec_helper'
+require File.expand_path("../test_app/config/environment", __FILE__)
+require 'rspec/rails'
+require 'capybara-webkit'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+
+ENGINE_RAILS_ROOT=File.join(File.dirname(__FILE__), '../')
+Dir[File.join(ENGINE_RAILS_ROOT, "spec/support/**/*.rb")].each {|f| require f }
+
+RSpec.configure do |config|
+  config.include Rails.application.routes.url_helpers
+  config.mock_with :rspec
+  config.use_transactional_fixtures = true
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = "random"
+  config.include Capybara::DSL
+  Capybara.javascript_driver = :webkit
+end
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+end

data/spec/spec_helper.rb

@@ -0,0 +1,85 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end