RubyGems - step_render - Versions diffs - 0.1.0 - Mend

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +53 -0
data/Rakefile +36 -0
data/app/assets/config/step_render_manifest.js +0 -0
data/app/controllers/step_load_controller.rb +8 -0
data/config/routes.rb +3 -0
data/lib/step_render/engine.rb +10 -0
data/lib/step_render/version.rb +3 -0
data/lib/step_render/view_helper.rb +19 -0
data/lib/step_render.rb +8 -0
data/lib/tasks/step_render_tasks.rake +4 -0
metadata +83 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1dbac8447ea28251a3dfd1c2495681bbb9cc576a
+  data.tar.gz: 14ba0115c59490d1bb9464ef9fa827b5736eb3fa
+SHA512:
+  metadata.gz: 9a23a1c1d8d18f9dcff748baaa41b217c181780d874517eb00aadb096992a64b62e5cca13c5614382a6ce1fbc28ced59fef0de0500c9541e3d4b9c325899c229
+  data.tar.gz: 49a2d59fda93f573b882d8ffab21f5e5dfb772e29c0e36c4a212b490f2573c66015cb2d08e51ee68e1045380ad7f5603c4b685bf38bfb84092f31ef0522463c4

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2017
+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 ADDED Viewed

@@ -0,0 +1,53 @@
+# StepRender
+It is very easy to enable lazy loading of partial with scroll in views.
+You only use `step_render` method instead of `render` method.
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'step_render'
+```
+And then execute:
+```bash
+$ bundle
+```
+## Usage
+### 1. Load javascript library
+This plugin depends on [lazysizes](https://github.com/aFarkas/lazysizes).
+If you do not import lazysizes to your application, load `import_step_render` method in required view.
+#### Example
+`application.html.erb`
+```html
+<head>
+  ~~~
+  ~~~
+  <%= import_step_render %>
+  ~~~
+</head>
+```
+### 2. Use `step_render` method instead of `render` method
+Replace `render` helper method used to rendering the partial with `step_render`.
+Partial must be specified as an absolute path.
+#### Example
+`app/views/top/index.html.erb`
+```html
+<%= step_render 'top/partial_name' %>
+```
+## Contributing
+Contribution directions go here.
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile ADDED Viewed

@@ -0,0 +1,36 @@
+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    = 'StepRender'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+task default: :test

data/app/assets/config/step_render_manifest.js ADDED Viewed

File without changes

data/app/controllers/step_load_controller.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+class StepLoadController < ApplicationController
+  layout false
+  def partial
+    @options = ActiveJob::Arguments.deserialize(Marshal.load(cookies.signed[params[:key]]))
+    render inline: "<%= render *@options %>"
+  end
+end

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get 'step_render/:key', to: 'step_load#partial', as: 'step_render'
+end

data/lib/step_render/engine.rb ADDED Viewed

@@ -0,0 +1,10 @@
+require 'step_render/view_helper'
+module StepRender
+  class Engine < ::Rails::Engine
+    initializer 'step_render.action_controller_helpers' do
+      ActiveSupport.on_load :action_controller do
+        ActionView::Base.send :include, StepRender::ViewHelper
+      end
+    end
+  end
+end

data/lib/step_render/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module StepRender
+  VERSION = '0.1.0'
+end

data/lib/step_render/view_helper.rb ADDED Viewed

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module StepRender
+  module ViewHelper
+    def step_render(*options)
+      if Rails.cache.is_a?(ActiveSupport::Cache::NullStore)
+        render *options
+      else
+        key = "lazy-partial-#{SecureRandom.hex(12)}"
+        cookies.signed[key] = { value: Marshal.dump(ActiveJob::Arguments.serialize(options)), expires: 2.hour.from_now }
+        # if use cache store
+        # Rails.cache.fetch(key, skip_digest: true, expires_in: 10.minute) { ActiveJob::Arguments.serialize(options) }
+        %(<div class= "related-articles lazyload" data-include="#{step_render_path(key)}">loading</div>).html_safe
+      end
+    end
+    def import_step_render
+      '<script src="https://cdnjs.cloudflare.com/ajax/libs/lazysizes/3.0.0/lazysizes.min.js"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/lazysizes/3.0.0/plugins/include/ls.include.min.js"></script>'.html_safe
+    end
+  end
+end

data/lib/step_render.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require "step_render/engine"
+require 'active_job/arguments'
+# ActionView::Base.send :include, StepRender::ViewHelper
+module StepRender
+  # Your code goes here...
+end

data/lib/tasks/step_render_tasks.rake ADDED Viewed

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

metadata ADDED Viewed

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: step_render
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- EastResident
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: It is very easy to enable lazy loading of partial with scroll in views
+email:
+- eastresident@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/step_render_manifest.js
+- app/controllers/step_load_controller.rb
+- config/routes.rb
+- lib/step_render.rb
+- lib/step_render/engine.rb
+- lib/step_render/version.rb
+- lib/step_render/view_helper.rb
+- lib/tasks/step_render_tasks.rake
+homepage: https://github.com/EastResident/step_render
+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: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.5.1
+signing_key:
+specification_version: 4
+summary: It is very easy to enable lazy loading of partial with scroll in views
+test_files: []

step_render 0.1.0