turbo-scroll 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 23360c1f88090467e027eea7b95d0e26124eaf84a88a6b61d92ff4383e5c7547
+  data.tar.gz: 1c530abf7d4c18357db082d3c537ccc11304d9a25b18a38566b9df52762f67c1
+SHA512:
+  metadata.gz: 5655f6dfb6f34dd1811713562de9c19bf0af16acdd3a2e10d1652e9eea90d42f2bc5139eacabf130a91fa06ff7e4a577408c4739426e7059d200deb3494946bb
+  data.tar.gz: da875aded8920791a105d033078d89c394acc08fb5fc056049256cb3707fd3fc0cd1d9849cb8e09136da2640c7262b1bc2d675384e5731c9d5e0f71f152ced50

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Koen handekyn
+
+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,110 @@
+# TurboScroll
+
+TurboScroll is a minimalistic gem that provides infinite scrolling for Rails based applications
+using Turbo.
+
+Underlying it depends on ViewComponent and Slim but these are not forced upon the user.
+
+## Usage
+
+### Controller
+
+Make sure your index action responds both to html and turbo_stream
+
+```
+    respond_to do |format|
+      format.html
+      format.turbo_stream
+    end
+```
+
+### index.html.erb|slim
+
+In your index page, make sure you have a DOM element with ID `infinite`
+and render inside of it your initial page content.
+
+At the bottom of your page, add the infinite scrolling loader
+by calling the `turbo_scroll_loader` helper and passing the next page index
+if a next page is present.
+
+You could use the [next_pageable](https://github.com/allcrux/next_pageable) gem
+but one can also use any other pagination gem of choice.
+
+#### Slim Example
+
+
+```
+#infinite
+  - @articles.each do |article|
+    = article
+
+= turbo_scroll_loader(page: @articles.next_page_index)
+```
+
+If you want to use a different ID, you'll have to pass it on in turbo_stream response.
+
+### index.turbo_stream.erb|slim
+
+Your turbo_stream response can use the `turbo_scroll_update` helper to
+append the next page content and update the current loader with a
+loader for the next page.
+
+When using the [next_pageable](https://github.com/allcrux/next_pageable) gem
+the next_page_index is already present on the collection when a next page exists.
+
+```
+= turbo_scroll_update page: @articles.next_page_index
+  - @articles.each do |article|
+    = article
+```
+
+### Using a different DOM ID
+
+In case you want or need to use a different DOM ID you
+can pass it on as an extra param to the `turbo_scroll_update` helper.
+
+The below example illustrates this for the case where your
+DOM ID is `#scroll`.
+
+index.html.slim
+
+```
+#scroll
+  - @articles.each do |article|
+    = article
+
+= turbo_scroll_loader(page: @articles.next_page_index)
+```
+
+index.turbo_stream.slim
+
+```
+= turbo_scroll_update page: @articles.next_page_index, infinite_dom_id: :scroll
+  - @articles.each do |article|
+    = article
+```
+
+
+
+### index.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "turbo-scroll"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install turbo-scroll
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/tasks/turbo_scroll_tasks.rake

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

data/lib/turbo-scroll/loader.html.slim

@@ -0,0 +1,3 @@
+= turbo_frame_tag :infinite_loader, src: next_page_stream_path, loading: "lazy", target: "_top"
+  .page-loading
+    p ==t(".click_here", next_page_path: next_page_path)

data/lib/turbo-scroll/loader.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "turbo-rails"
+
+class TurboScroll::Loader < ViewComponent::Base
+  include Turbo::FramesHelper
+
+  attr_reader :page
+
+  def initialize(page:)
+    @page = page
+  end
+
+  def query_params
+    @query_params ||=
+      request.query_parameters.except(:page, :raw, :format)
+  end
+
+  def next_page_path
+    url_for(page: page, **query_params)
+  end
+
+  def next_page_stream_path
+    url_for(format: :turbo_stream, page: page, **query_params)
+  end
+
+  def render?
+    page
+  end
+end
+

data/lib/turbo-scroll/loader.scss

@@ -0,0 +1,10 @@
+.page-loading {
+  height: 15.5em;
+  padding-top: 4em;
+}
+
+.page-loading p {
+  text-align: center;
+  width: 100%;
+  padding-top: 2em;
+}

data/lib/turbo-scroll/railtie.rb

@@ -0,0 +1,13 @@
+module TurboScroll
+  class Railtie < ::Rails::Railtie
+    initializer "turbo-scrolls.load_components" do
+      require_relative "update"
+      require_relative "loader"
+    end
+    initializer "turbo-scrolls.view_helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include TurboScroll::ViewHelpers
+      end
+    end
+  end
+end

data/lib/turbo-scroll/update.html.slim

@@ -0,0 +1,5 @@
+= turbo_stream.append(infinite_dom_id)
+  = content
+
+= turbo_stream.replace(:infinite_loader)
+  = render(TurboScroll::Loader.new(page: page))

data/lib/turbo-scroll/update.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "turbo-rails"
+
+class TurboScroll::Update < ViewComponent::Base
+  include Turbo::FramesHelper
+  include Turbo::StreamsHelper
+
+  attr_reader :page
+  attr_reader :infinite_dom_id
+
+  def initialize(page:, infinite_dom_id: :infinite)
+    @page = page
+    @infinite_dom_id = infinite_dom_id
+  end
+end
+

data/lib/turbo-scroll/version.rb

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

data/lib/turbo-scroll.rb

@@ -0,0 +1,14 @@
+require "turbo-scroll/version"
+require "turbo-scroll/railtie" if defined?(Rails::Railtie)
+
+module TurboScroll
+  module ViewHelpers
+    def turbo_scroll_loader(page:)
+      render(TurboScroll::Loader.new(page: page))
+    end
+
+    def turbo_scroll_update(page:, infinite_dom_id: :infinite, &block)
+      render(TurboScroll::Update.new(page: page, infinite_dom_id: infinite_dom_id), &block)
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: turbo-scroll
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Koen handekyn
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Description of TurboScroll.
+email:
+- koen@handekyn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/tasks/turbo_scroll_tasks.rake
+- lib/turbo-scroll.rb
+- lib/turbo-scroll/loader.html.slim
+- lib/turbo-scroll/loader.rb
+- lib/turbo-scroll/loader.scss
+- lib/turbo-scroll/railtie.rb
+- lib/turbo-scroll/update.html.slim
+- lib/turbo-scroll/update.rb
+- lib/turbo-scroll/version.rb
+homepage: https://github.com/allcrux/turbo-scroll
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/allcrux/turbo-scroll
+  source_code_uri: https://github.com/allcrux/turbo-scroll
+  changelog_uri: https://github.com/allcrux/turbo-scroll/blob/main/CHANGELOG.md
+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: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Summary of TurboScroll.
+test_files: []