actionview-component-live 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e37880218a7e67c17a027babfc3814c27120d216e9981b2c3cae9829744312d
+  data.tar.gz: 207a44247020ae81c515a02785125cdc64041a821e0d63310faf558521e63fb4
+SHA512:
+  metadata.gz: b9170c628f9857eb78fd9937b0b85a083eab0a73bdbb4a61e734240726a7058e4f21fe5c75b2e9282841f8220aecf094028bdedd33ceb07a7bc8557353379bea
+  data.tar.gz: b50e47e7d132e82519a336ba305da57c00d2ce610c391382ed02c153501141e45779281233f0feca1c70f25e68ad74412dc6e89924347ddd828fff276fb6c271

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Simon Træls Ravn
+
+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,87 @@
+# Actionview::Component::Live
+This is a small add-on to ActionView::Component to make your components update automatically when data is changed serverside.
+
+## Usage
+Lets say you have a MiniBasketComponent that is renders the small basket in the top of your webshop.
+Wouldn't it be nice if that just updated it self whenever a change happens to the draft order?
+
+First lets create a small component for our mini basket.
+This component requires a DraftOrder and will listen to any change to the draft order it renders.
+```ruby
+class MiniBasketComponent < ActionView::Component::Base
+  include ActionView::Component::Live::Subscriber
+
+  listen_to :draft_order
+
+  def initialize(draft_order:)
+    @order = draft_order
+  end
+
+  def count
+    @order.product_count
+  end
+
+  def id
+    @order.id
+  end
+end
+```
+
+**Important!** There is a strict naming requirement on the `listen_to` part and named argument in initialize!
+
+Then the component view. The view that should be auto updated must be wrapped in a element that attaches to a Stimulus controller called LiveController.
+It needs the name of the component and the id of the object that it is attached to.
+```erb
+<div data-controller="live" data-live-component="MiniBasketComponent" data-live-id="<%= id %>">
+  <b><%= count %> products in basket</b>
+</div>
+```
+
+Finally we need to tell our DraftOrder to broadcast changes.
+```ruby
+class DraftOrder < ApplicationRecord
+  include ActionView::Component::Live::Broadcaster
+end
+```
+
+Thats it. Now any update your draft order will be broadcast through ActionCable and your view will update in real time.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'actionview-component-live'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Add stimulus controller
+```bash
+$ yarn add stimulus-actionview-live
+```
+
+Add these 2 lines to your `app/javascript/controllers/index.js`
+```javascript
+import LiveController from "stimulus-actionview-live"
+application.register("live", LiveController)
+```
+
+## Test
+Running the tests requires a Redis server to have ActionCable running in a productionlike environment. This might seem like a bit overkill but this way one system test will test the entire gem.
+
+In the `test/dummy` app there is a complete example of a live updating component.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+# TODO
+## Nice to have
+- install generator that does yarn add and adds lines to stimulus controllers file
+- find a way to do collection updates, a component that lists many items
+- move the component wrapper div out of component (to avoid unsubscribe/subscribe on all updates)
+- could we do something for components that rely on multiple objects?
+- allow the listen to method to accept a list of attributes so we only get updates to relevant things
+

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'Actionview::Component::Live'
+  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", __dir__)
+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/channels/action_view/component/live/live_channel.rb

@@ -0,0 +1,18 @@
+module ActionView
+  module Component
+    module Live
+      class LiveChannel < ActionCable::Channel::Base
+        def subscribed
+          stream_from "action_view:component:live:live:#{params[:component]}:#{params[:id]}"
+        end
+
+        def unsubscribed
+          # Any cleanup needed when channel is unsubscribed
+        end
+
+        def notify
+        end
+      end
+    end
+  end
+end

data/app/models/action_view/component/live/broadcaster.rb

@@ -0,0 +1,15 @@
+module ActionView
+  module Component
+    module Live
+      module Broadcaster
+        extend ActiveSupport::Concern
+
+        included do
+          after_update do
+            LiveUpdater.update self
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/action_view/component/live/live_updater.rb

@@ -0,0 +1,29 @@
+module ActionView
+  module Component
+    module Live
+      class LiveUpdater
+        class << self
+          def update(model)
+            model_name = model.class.name
+            return unless subscriptions[model_name].present?
+
+            subscriptions[model_name].each do |component_name|
+              locals = {model_name.underscore.to_sym => model}
+              body = ApplicationController.render template: 'live', layout: false, locals: {component: component_name, locals: locals}
+              LiveChannel.broadcast_to "#{component_name}:#{model.id}", body: body
+            end
+          end
+
+          def subscribe(model, component_name)
+            subscriptions[model] ||= []
+            subscriptions[model] << component_name
+          end
+
+          def subscriptions
+            @subscriptions ||= {}
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/action_view/component/live/subscriber.rb

@@ -0,0 +1,15 @@
+module ActionView
+  module Component
+    module Live
+      module Subscriber
+        extend ActiveSupport::Concern
+
+        class_methods do
+          def listen_to(name)
+            LiveUpdater.subscribe(name.to_s.classify, self)
+          end
+        end
+      end
+    end
+  end
+end

data/app/views/live.html.erb

@@ -0,0 +1 @@
+<%= render component: component, locals: locals %>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/actionview/component/live.rb

@@ -0,0 +1,17 @@
+require 'action_view/component'
+require "actionview/component/live/engine"
+
+require_relative "../../../app/models/action_view/component/live/broadcaster"
+require_relative "../../../app/models/action_view/component/live/subscriber"
+require_relative "../../../app/models/action_view/component/live/live_updater"
+
+require_relative "../../../app/channels/action_view/component/live/live_channel"
+
+
+module Actionview
+  module Component
+    module Live
+      # Your code goes here...
+    end
+  end
+end

data/lib/actionview/component/live/engine.rb

@@ -0,0 +1,8 @@
+module Actionview
+  module Component
+    module Live
+      class Engine < ::Rails::Engine
+      end
+    end
+  end
+end

data/lib/actionview/component/live/version.rb

@@ -0,0 +1,7 @@
+module Actionview
+  module Component
+    module Live
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/tasks/actionview/component/live_tasks.rake

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

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: actionview-component-live
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Simon Træls Ravn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: actionview-component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.29.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.29.0
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.142.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.142.0
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+- !ruby/object:Gem::Dependency
+  name: webpacker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+description: Liveupdate from ActiveRecord models to Actionview components
+email:
+- cs2@cs2.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/actionview_component_live_manifest.js
+- app/channels/action_view/component/live/live_channel.rb
+- app/models/action_view/component/live/broadcaster.rb
+- app/models/action_view/component/live/live_updater.rb
+- app/models/action_view/component/live/subscriber.rb
+- app/views/live.html.erb
+- config/routes.rb
+- lib/actionview/component/live.rb
+- lib/actionview/component/live/engine.rb
+- lib/actionview/component/live/version.rb
+- lib/tasks/actionview/component/live_tasks.rake
+homepage: https://bitbucket.org/cs2software/actionview-component-live
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Liveupdating view components
+test_files: []