clearwater-virtual_list 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6802029dc7bf2e5fbe3d38344ce15197d3e7d07a8c44f2e10eae8f575df451c0
+  data.tar.gz: a8cfeb648351da3bd5de72858c61856f12db918e850b4de1cd8888627d01ee61
+SHA512:
+  metadata.gz: f31107cab21fecd8e128f6dfb7d2d7cd96693e4d03ac0763546dc2521fc2d5404a2f084d3d69ed3ea640eb5a14fcc04be0e354784eee74c4f7db3988f806b555
+  data.tar.gz: bd20de801e88703e041a98adb4398b74a99cb9459626af8fdd5fdcde3b673dc124d9022bcac5a4feb2827ed8179b6491635e169a8e658168c27088ac28e97d6d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jgaskins@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in clearwater-virtual_list.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jamie Gaskins
+
+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,43 @@
+# Clearwater::VirtualList
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/clearwater/virtual_list`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clearwater-virtual_list'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clearwater-virtual_list
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/clearwater-virtual_list. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Clearwater::VirtualList project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/clearwater-virtual_list/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clearwater/virtual_list"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/clearwater-virtual_list.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "clearwater/virtual_list/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "clearwater-virtual_list"
+  spec.version       = Clearwater::VirtualList::VERSION
+  spec.authors       = ["Jamie Gaskins"]
+  spec.email         = ["jgaskins@gmail.com"]
+
+  spec.summary       = %q{Virtual-list component to hide off-screen list elements}
+  spec.homepage      = "https://github.com/clearwater-rb/clearwater-virtual_list"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/clearwater/virtual_list/version.rb

@@ -0,0 +1,5 @@
+module Clearwater
+  module VirtualList
+    VERSION = "0.1.0"
+  end
+end

data/lib/clearwater/virtual_list.rb

@@ -0,0 +1,10 @@
+require 'opal'
+
+require 'clearwater/virtual_list/version'
+
+module Clearwater
+  module VirtualList
+  end
+end
+
+Opal.append_path File.expand_path('../../../opal', __FILE__)

data/opal/clearwater/virtual_list.rb

@@ -0,0 +1,114 @@
+require 'clearwater/virtual_dom'
+require 'clearwater/black_box_node'
+require 'bowser'
+
+module Clearwater
+  module VirtualList
+    def self.create(buffer: 0, &block)
+      Class.new(Component) do
+        define_method :content do
+          block.call(
+            items: @items[@first..@last],
+            list_style: {
+              height: "#{total_height}px",
+              padding_top: "#{@first * height}px",
+              box_sizing: 'border-box',
+            },
+            item_style: {
+              height: "#{@item_height}px",
+              box_sizing: 'border-box',
+            },
+          )
+        end
+
+        define_method(:buffer) { buffer }
+      end
+    end
+
+    class Component
+      include Clearwater::BlackBoxNode
+
+      attr_reader :items, :height, :first, :last
+      attr_reader :onscroll, :onresize
+      attr_reader :vdom
+
+      def initialize(items, item_height:)
+        @items = items
+        @height = item_height
+      end
+
+      def mount element
+        @vdom = Clearwater::VirtualDOM::Document.new(element)
+        @onscroll = Bowser.window.on(:scroll) { render_content element }
+        @onresize = Bowser.window.on(:resize) { render_content element }
+
+        render_content element
+      end
+
+      def update previous, element
+        @vdom = previous.vdom
+        @onscroll = previous.onscroll
+        @onresize = previous.onresize
+
+        return if height == previous.height &&
+          buffer == previous.buffer &&
+          items == previous.items
+
+        render_content element
+      end
+
+      def destroy
+        Bowser.window.off :scroll, &onscroll
+        Bowser.window.off :resize, &onresize
+      end
+
+      def render_content(element)
+        @first, @last = visible_item_bounds(element)
+        vdom.render Clearwater::Component.sanitize_content(content)
+      end
+
+      def visible_item_bounds(element)
+        window = Bowser.window
+        view_height = window.inner_height || window.client_height
+
+        view_top = window.page_y_offset
+        view_bottom = view_top + view_height
+
+        list_top = top_from_window(element) - top_from_window(window)
+        list_height = height.to_i * items.count
+
+        list_view_top = [0, view_top - list_top].max
+        list_view_bottom = [0, [list_height, view_bottom - list_top].min].max
+
+        first_item_index = [0, (list_view_top / height).to_i - buffer].max
+        last_item_index = [items.count, (list_view_bottom / height).ceil + buffer].min
+
+        [first_item_index, last_item_index]
+      end
+
+      def top_from_window element
+        return 0 unless element
+        return 0 if element.equal? Bowser.window
+
+        element.offset_top.to_i + top_from_window(element.offset_parent)
+      end
+
+      def total_height
+        height * items.count
+      end
+    end
+  end
+end
+
+# Monkeypatch to wrap the offsetParent element
+module Bowser
+  class Element
+    def offset_parent
+      parent = super
+
+      return unless parent
+
+      Element.new(parent)
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: clearwater-virtual_list
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Gaskins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- jgaskins@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clearwater-virtual_list.gemspec
+- lib/clearwater/virtual_list.rb
+- lib/clearwater/virtual_list/version.rb
+- opal/clearwater/virtual_list.rb
+homepage: https://github.com/clearwater-rb/clearwater-virtual_list
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Virtual-list component to hide off-screen list elements
+test_files: []