model_updates 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 526e7e7db14d2a876ff88a99ae866fa13134fa7a
+  data.tar.gz: c589e3b8d720c13ae377b0592d4798f61ac0dd00
+SHA512:
+  metadata.gz: 46cd8b93ea8e032210048db5b961d5e6d86048a2473e1e5c5647ecc0f39e491bf8c2ce4ef239f60537dee0982e44b20ab2f5dc72748e410d7cac72648e558623
+  data.tar.gz: 406ddae50931f9a9d8ac38e4f80844582975de5685d4f86eb50fadf37fd04c4ffe9d4f154d7824eeea1fc14167b5649ef262403f76b63d9b04af3546b601b5db

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 kaspernj
+
+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,73 @@
+# ModelUpdates
+
+Rails gem to push updates to models into the frontend through ActionCable.
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'model_updates'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install model_updates
+```
+
+
+## Usage
+
+Include it in your JavaScript:
+
+```javascript
+//= require model_updates
+```
+
+Include the helper in your models:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  include ModelUpdates::ModelExtensions
+end
+```
+
+Choose which attributes should be broadcasted automatically:
+
+```ruby
+class Model < ApplicationRecord
+  model_updates_broadcast_attributes attributes: [:updated_at]
+end
+```
+
+Do like this in your views if you are using HAML:
+
+```haml
+.model-updates{data: {model_updates: model.model_updates_data_attrs(:updated_at)}}
+  = model.updated_at
+```
+
+Or like this in ERB:
+
+```erb
+<div class="model-updates" data-model-updates-model="Model" data-model-updates-id="1" data-model-updates-key="updated_at">
+  <%= model.updated_at %>
+</div>
+```
+
+Now that element should update automatically when the model is changed
+
+
+## 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

@@ -0,0 +1,26 @@
+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    = "ModelUpdates"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+if Rails.env.development? || Rails.env.test?
+  require "best_practice_project"
+  BestPracticeProject.load_tasks
+end

data/app/assets/config/model_updates_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/model_updates .js
+//= link_directory ../stylesheets/model_updates .css

data/app/assets/javascripts/model_updates/activate_elements.js

@@ -0,0 +1,45 @@
+$(document).ready(function() {
+  // Find all models that should be subscribed to
+  model_subscriptions = {}
+
+  $(".model-updates").each(function() {
+    model_type = $(this).data("model-updates-model")
+    model_id = $(this).data("model-updates-id")
+
+    if (!model_subscriptions[model_type])
+      model_subscriptions[model_type] = {}
+
+    model_subscriptions[model_type][model_id] = {}
+  })
+
+  // Subscribe to the found models
+  for(var model_type in model_subscriptions) {
+    for(var model_id in model_subscriptions[model_type]) {
+      App.cable.subscriptions.create(
+        {channel: "ModelUpdates::ModelChannel", id: model_id, model: model_type},
+        {
+          received: function(json) {
+            for(key in json.changes) {
+              element = $(".model-updates[data-model-updates-model='" + json.model + "'][data-model-updates-id='" + json.id + "'][data-model-updates-key='" + key + "']")
+
+              if (element.data("model-updates-callback")) {
+                function_to_call = element.data("model-updates-callback")
+
+                window[function_to_call]({
+                  changes: json.changes,
+                  element: element,
+                  id: json.id,
+                  key: key,
+                  model: json.model,
+                  value: json.changes[key]
+                })
+              } else {
+                element.text(json.changes[key])
+              }
+            }
+          }
+        }
+      )
+    }
+  }
+})

data/app/assets/javascripts/model_updates/formatters.js

@@ -0,0 +1,3 @@
+function model_updates_date_time_formatter(data) {
+  element.text(moment(data.value).format("LLLL"))
+}

data/app/assets/javascripts/model_updates.js

@@ -0,0 +1,2 @@
+//= require model_updates/activate_elements
+//= require model_updates/formatters

data/app/assets/stylesheets/model_updates/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/channels/model_updates/model_channel.rb

@@ -0,0 +1,6 @@
+class ModelUpdates::ModelChannel < ApplicationCable::Channel
+  def subscribed
+    model = params[:model].constantize.find(params[:id])
+    stream_for model
+  end
+end

data/app/controllers/model_updates/application_controller.rb

@@ -0,0 +1,5 @@
+module ModelUpdates; end
+
+class ModelUpdates::ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/app/helpers/model_updates/application_helper.rb

@@ -0,0 +1,2 @@
+module ModelUpdates::ApplicationHelper
+end

data/app/jobs/model_updates/application_job.rb

@@ -0,0 +1,2 @@
+class ModelUpdates::ApplicationJob < ActiveJob::Base
+end

data/app/mailers/model_updates/application_mailer.rb

@@ -0,0 +1,4 @@
+class ModelUpdates::ApplicationMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout "mailer"
+end

data/app/models/model_updates/application_record.rb

@@ -0,0 +1,3 @@
+class ModelUpdates::ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/app/views/layouts/model_updates/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Model updates</title>
+  <%= stylesheet_link_tag    "model_updates/application", media: "all" %>
+  <%= javascript_include_tag "model_updates/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

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

data/lib/model_updates/attribute_generator.rb

@@ -0,0 +1,23 @@
+class ModuleUpdates::AttributeGenerator
+  def self.generate(args)
+    data_attributes = {
+      "model-updates-id" => args.fetch(:model).id,
+      "model-updates-key" => args.fetch(:key),
+      "model-updates-model" => args.fetch(:model).class.name
+    }
+
+    data_attributes.merge!(args.fetch(:attributes)) if args[:attributes]
+    data_attributes
+  end
+
+  def self.short(args)
+    data_attributes = {
+      "id" => args.fetch(:model).id,
+      "key" => args.fetch(:key),
+      "model" => args.fetch(:model).class.name
+    }
+
+    data_attributes.merge!(args.fetch(:attributes)) if args[:attributes]
+    data_attributes
+  end
+end

data/lib/model_updates/engine.rb

@@ -0,0 +1,3 @@
+class ModelUpdates::Engine < ::Rails::Engine
+  isolate_namespace ModelUpdates
+end

data/lib/model_updates/model_extensions.rb

@@ -0,0 +1,36 @@
+module ModelUpdates::ModelExtensions
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def model_updates_broadcast_attributes(args)
+      after_save do
+        changes = {}
+
+        args.fetch(:attributes).each do |attribute_name|
+          method_changed = "saved_change_to_#{attribute_name}?"
+          next unless __send__(method_changed)
+          changes[attribute_name] = __send__(attribute_name)
+        end
+
+        if changes.any?
+          ModelUpdates::ModelChannel.broadcast_to(
+            self,
+            id: id,
+            model: self.class.name,
+            changes: changes
+          )
+        end
+      end
+    end
+  end
+
+  def model_updates_data_attrs(key, more = {})
+    {
+      id: id,
+      model: self.class.name,
+      key: key
+    }.merge(more)
+  end
+end

data/lib/model_updates/version.rb

@@ -0,0 +1,3 @@
+module ModelUpdates
+  VERSION = "0.0.1".freeze
+end

data/lib/model_updates.rb

@@ -0,0 +1,8 @@
+require "model_updates/engine"
+
+module ModelUpdates
+  path = "#{File.dirname(__FILE__)}/model_updates"
+
+  autoload :AttributeGenerator, "#{path}/attribute_generator"
+  autoload :ModelExtensions, "#{path}/model_extensions"
+end

data/lib/tasks/model_updates_tasks.rake

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

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: model_updates
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- kaspernj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description: Rails gem to push updates to models into the frontend through ActionCable
+email:
+- kaspernj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/model_updates_manifest.js
+- app/assets/javascripts/model_updates.js
+- app/assets/javascripts/model_updates/activate_elements.js
+- app/assets/javascripts/model_updates/formatters.js
+- app/assets/stylesheets/model_updates/application.css
+- app/channels/model_updates/model_channel.rb
+- app/controllers/model_updates/application_controller.rb
+- app/helpers/model_updates/application_helper.rb
+- app/jobs/model_updates/application_job.rb
+- app/mailers/model_updates/application_mailer.rb
+- app/models/model_updates/application_record.rb
+- app/views/layouts/model_updates/application.html.erb
+- config/routes.rb
+- lib/model_updates.rb
+- lib/model_updates/attribute_generator.rb
+- lib/model_updates/engine.rb
+- lib/model_updates/model_extensions.rb
+- lib/model_updates/version.rb
+- lib/tasks/model_updates_tasks.rake
+homepage: https://github.com/kaspernj/model_updates
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Rails gem to push updates to models into the frontend through ActionCable
+test_files: []