decidim-notify 0.4 → 0.5

data/lib/decidim/notify/version.rb

@@ -3,7 +3,7 @@
 module Decidim
   # This holds the decidim-notify version.
   module Notify
-    VERSION = "0.4"
-    MIN_DECIDIM_VERSION = ">= 0.21"
+    VERSION = "0.5"
+    MIN_DECIDIM_VERSION = ">= 0.25"
   end
 end

data/lib/decidim/notify.rb

@@ -13,30 +13,27 @@ module Decidim
 
     class << self
       def cable
-        return @cable if @cable
-
-        @cable = ActionCable::Server::Configuration.new
-        @cable.mount_path = config.cable_mount_path
-        @cable.connection_class = -> { Decidim::Notify::Connection }
-        @cable.url = config.cable_url
-        @cable.cable = {
-          "adapter" => config.cable_adapter,
-          "channel_prefix" => config.cable_channel_prefix
-        }
-        @cable
+        @cable || begin
+          @cable = ActionCable::Server::Configuration.new
+          @cable.mount_path = config.cable_mount_path
+          @cable.connection_class = -> { Decidim::Notify::Connection }
+          @cable.url = config.cable_url
+          @cable.cable = {
+            "adapter" => config.cable_adapter,
+            "channel_prefix" => config.cable_channel_prefix
+          }
+          @cable
+        end
       end
 
       def server
-        return @server if @server
-
-        @server = ActionCable::Server::Base.new
-        @server.config = cable
-        @server
+        @server ||= ActionCable::Server::Base.new(config: cable)
       end
     end
 
+    # Notify uses its custom ActionCable server, better not to use the default /cable route as it causes conflicts
     config_accessor :cable_mount_path do
-      "/cable"
+      "/notify_cable"
     end
 
     # Not recommended to use "async", event for development

data/lib/tasks/decidim_notify_webpacker_tasks.rake

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "decidim/gem_manager"
+
+namespace :decidim_notify do
+  namespace :webpacker do
+    desc "Installs Decidim Awesome webpacker files in Rails instance application"
+    task install: :environment do
+      raise "Decidim gem is not installed" if decidim_path.nil?
+
+      install_notify_npm
+    end
+
+    desc "Adds Decidim Awesome dependencies in package.json"
+    task upgrade: :environment do
+      raise "Decidim gem is not installed" if decidim_path.nil?
+
+      install_notify_npm
+    end
+
+    def install_notify_npm
+      notify_npm_dependencies.each do |type, packages|
+        system! "npm i --save-#{type} #{packages.join(" ")}"
+      end
+    end
+
+    def notify_npm_dependencies
+      @notify_npm_dependencies ||= begin
+        package_json = JSON.parse(File.read(notify_path.join("package.json")))
+
+        {
+          prod: package_json["dependencies"].map { |package, version| "#{package}@#{version}" },
+          dev: package_json["devDependencies"].map { |package, version| "#{package}@#{version}" }
+        }.freeze
+      end
+    end
+
+    def notify_path
+      @notify_path ||= Pathname.new(notify_gemspec.full_gem_path) if Gem.loaded_specs.has_key?(gem_name)
+    end
+
+    def notify_gemspec
+      @notify_gemspec ||= Gem.loaded_specs[gem_name]
+    end
+
+    def rails_app_path
+      @rails_app_path ||= Rails.root
+    end
+
+    def copy_awesome_file_to_application(origin_path, destination_path = origin_path)
+      FileUtils.cp(notify_path.join(origin_path), rails_app_path.join(destination_path))
+    end
+
+    def system!(command)
+      system("cd #{rails_app_path} && #{command}") || abort("\n== Command #{command} failed ==")
+    end
+
+    def gem_name
+      "decidim-notify"
+    end
+  end
+end

data/package.json

@@ -0,0 +1,200 @@
+{
+  "name": "decidim-module-notify",
+  "version": "1.1.0",
+  "description": "A conversation tracker for Decidim",
+  "scripts": {
+    "lint": "eslint -c .eslintrc.json --ext .js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Platoniq/decidim-module-notify.git"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "eslint -c .eslintrc.json --ext .js app/packs/",
+    "lint-fix": "eslint -c .eslintrc.json --ext .js app/packs/ --fix",
+    "stylelint": "stylelint **/*.scss",
+    "stylelint-fix": "stylelint **/*.scss --fix"
+  },
+  "keywords": [
+    "decidim"
+  ],
+  "author": "ivan@platoniq.net",
+  "license": "AGPL-3.0-or-later",
+  "bugs": {
+    "url": "https://github.com/Platoniq/decidim-module-notify/issues"
+  },
+  "homepage": "https://github.com/Platoniq/decidim-module-notify#readme",
+  "stylelint": {
+    "rules": {
+      "at-rule-empty-line-before": [
+        "always",
+        {
+          "except": [
+            "blockless-after-same-name-blockless",
+            "first-nested"
+          ],
+          "ignore": [
+            "after-comment"
+          ],
+          "ignoreAtRules": [
+            "else"
+          ]
+        }
+      ],
+      "at-rule-name-case": "lower",
+      "at-rule-semicolon-newline-after": "always",
+      "block-closing-brace-empty-line-before": "never",
+      "block-closing-brace-newline-after": "always",
+      "block-closing-brace-newline-before": "always-multi-line",
+      "block-closing-brace-space-before": "always-single-line",
+      "block-no-empty": true,
+      "block-opening-brace-newline-after": "always-multi-line",
+      "block-opening-brace-space-after": "always-single-line",
+      "block-opening-brace-space-before": "always",
+      "color-hex-case": "lower",
+      "color-hex-length": "short",
+      "color-no-invalid-hex": true,
+      "comment-empty-line-before": [
+        "always",
+        {
+          "except": [
+            "first-nested"
+          ],
+          "ignore": [
+            "stylelint-commands"
+          ]
+        }
+      ],
+      "comment-no-empty": true,
+      "comment-whitespace-inside": "always",
+      "custom-property-empty-line-before": [
+        "always",
+        {
+          "except": [
+            "after-custom-property",
+            "first-nested"
+          ],
+          "ignore": [
+            "after-comment",
+            "inside-single-line-block"
+          ]
+        }
+      ],
+      "declaration-bang-space-after": "never",
+      "declaration-bang-space-before": "always",
+      "declaration-block-no-duplicate-properties": [
+        true,
+        {
+          "ignore": [
+            "consecutive-duplicates-with-different-values"
+          ]
+        }
+      ],
+      "declaration-block-no-redundant-longhand-properties": true,
+      "declaration-block-no-shorthand-property-overrides": true,
+      "declaration-block-semicolon-newline-after": "always-multi-line",
+      "declaration-block-semicolon-space-after": "always-single-line",
+      "declaration-block-semicolon-space-before": "never",
+      "declaration-block-single-line-max-declarations": 1,
+      "declaration-block-trailing-semicolon": "always",
+      "declaration-colon-newline-after": "always-multi-line",
+      "declaration-colon-space-after": "always-single-line",
+      "declaration-colon-space-before": "never",
+      "declaration-empty-line-before": [
+        "always",
+        {
+          "except": [
+            "after-declaration",
+            "first-nested"
+          ],
+          "ignore": [
+            "after-comment",
+            "inside-single-line-block"
+          ]
+        }
+      ],
+      "function-calc-no-unspaced-operator": true,
+      "function-comma-newline-after": "always-multi-line",
+      "function-comma-space-after": "always-single-line",
+      "function-comma-space-before": "never",
+      "function-linear-gradient-no-nonstandard-direction": true,
+      "function-max-empty-lines": 0,
+      "function-name-case": "lower",
+      "function-parentheses-newline-inside": "always-multi-line",
+      "function-parentheses-space-inside": "never-single-line",
+      "function-whitespace-after": "always",
+      "indentation": 2,
+      "keyframe-declaration-no-important": true,
+      "length-zero-no-unit": true,
+      "max-empty-lines": 1,
+      "media-feature-colon-space-after": "always",
+      "media-feature-colon-space-before": "never",
+      "media-feature-name-case": "lower",
+      "media-feature-name-no-unknown": true,
+      "media-feature-parentheses-space-inside": "never",
+      "media-feature-range-operator-space-after": "always",
+      "media-feature-range-operator-space-before": "always",
+      "media-query-list-comma-newline-after": "always-multi-line",
+      "media-query-list-comma-space-after": "always-single-line",
+      "media-query-list-comma-space-before": "never",
+      "no-empty-source": true,
+      "no-eol-whitespace": true,
+      "no-extra-semicolons": true,
+      "no-invalid-double-slash-comments": true,
+      "no-missing-end-of-source-newline": true,
+      "number-leading-zero": "never",
+      "number-no-trailing-zeros": true,
+      "property-case": "lower",
+      "property-no-unknown": true,
+      "rule-empty-line-before": [
+        "always-multi-line",
+        {
+          "except": [
+            "first-nested"
+          ],
+          "ignore": [
+            "after-comment"
+          ]
+        }
+      ],
+      "selector-attribute-brackets-space-inside": "never",
+      "selector-attribute-operator-space-after": "never",
+      "selector-attribute-operator-space-before": "never",
+      "selector-combinator-space-after": "always",
+      "selector-combinator-space-before": "always",
+      "selector-descendant-combinator-no-non-space": true,
+      "selector-list-comma-newline-after": "always",
+      "selector-list-comma-space-before": "never",
+      "selector-max-empty-lines": 0,
+      "selector-pseudo-class-case": "lower",
+      "selector-pseudo-class-no-unknown": true,
+      "selector-pseudo-class-parentheses-space-inside": "never",
+      "selector-pseudo-element-case": "lower",
+      "selector-pseudo-element-colon-notation": "double",
+      "selector-pseudo-element-no-unknown": true,
+      "selector-type-case": "lower",
+      "selector-type-no-unknown": true,
+      "shorthand-property-no-redundant-values": true,
+      "string-no-newline": true,
+      "unit-case": "lower",
+      "unit-no-unknown": true,
+      "value-list-comma-newline-after": "always-multi-line",
+      "value-list-comma-space-after": "always-single-line",
+      "value-list-comma-space-before": "never",
+      "value-list-max-empty-lines": 0
+    }
+  },
+  "devDependencies": {
+    "eslint": "^7.32.0",
+    "eslint": "^7.25.0",
+    "eslint-config-prettier": "^8.2.0",
+    "eslint-config-standard": "^11.0.0",
+    "eslint-plugin-import": "^2.22.0",
+    "stylelint": "13.11.0"
+  },
+  "dependencies": {
+    "@rails/actioncable": "6.0.4",
+    "select2": "^4.1.0-rc.0"
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decidim-notify
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Ivan Vergés
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-09 00:00:00.000000000 Z
+date: 2022-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decidim-admin
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.25'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.25'
 - !ruby/object:Gem::Dependency
   name: decidim-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.25'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.25'
 - !ruby/object:Gem::Dependency
   name: decidim-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.25'
 description: A note-taker feature focused on conversations.
 email:
 - ivan@platoniq.net
@@ -62,16 +62,6 @@ files:
 - LICENSE-AGPLv3.txt
 - README.md
 - Rakefile
-- app/assets/config/decidim_notify_manifest.css
-- app/assets/config/decidim_notify_manifest.js
-- app/assets/images/decidim/notify/icon.svg
-- app/assets/javascripts/cable.js
-- app/assets/javascripts/channels/decidim/notify/conversations.js
-- app/assets/javascripts/decidim/notify/conversations.js.es6
-- app/assets/javascripts/decidim/notify/select2.js.es6
-- app/assets/stylesheets/decidim/notify/_hexagon.scss
-- app/assets/stylesheets/decidim/notify/admin.scss
-- app/assets/stylesheets/decidim/notify/notify.scss
 - app/cells/decidim/notify/chapter/show.erb
 - app/cells/decidim/notify/chapter_cell.rb
 - app/cells/decidim/notify/note/show.erb
@@ -109,6 +99,18 @@ files:
 - app/models/decidim/notify/author.rb
 - app/models/decidim/notify/chapter.rb
 - app/models/decidim/notify/note.rb
+- app/packs/entrypoints/decidim_notify_component.js
+- app/packs/entrypoints/decidim_notify_component.scss
+- app/packs/entrypoints/decidim_notify_selects.js
+- app/packs/images/decidim/notify/icon.svg
+- app/packs/src/decidim/notify/consumer.js
+- app/packs/src/decidim/notify/notify.js
+- app/packs/src/decidim/notify/notify_channel.js
+- app/packs/src/decidim/notify/notify_selects.js
+- app/packs/stylesheets/decidim/notify/admin.scss
+- app/packs/stylesheets/decidim/notify/hexagon.scss
+- app/packs/stylesheets/decidim/notify/notify.scss
+- app/packs/stylesheets/decidim/notify/select2-foundation-theme.css
 - app/permissions/decidim/notify/admin/permissions.rb
 - app/permissions/decidim/notify/permissions.rb
 - app/views/decidim/notify/admin/chapters/_form.html.erb
@@ -124,6 +126,7 @@ files:
 - app/views/decidim/notify/conversations/_script.js.erb
 - app/views/decidim/notify/conversations/index.html.erb
 - app/views/decidim/notify/conversations/private.html.erb
+- config/assets.rb
 - config/i18n-tasks.yml
 - config/locales/ca.yml
 - config/locales/cs.yml
@@ -148,9 +151,8 @@ files:
 - lib/decidim/notify/test/factories.rb
 - lib/decidim/notify/test/shared_examples/component_examples.rb
 - lib/decidim/notify/version.rb
-- vendor/assets/javascripts/select2.js
-- vendor/assets/stylesheets/select2-foundation-theme.css
-- vendor/assets/stylesheets/select2.css
+- lib/tasks/decidim_notify_webpacker_tasks.rake
+- package.json
 homepage: https://github.com/decidim/decidim-module-notify
 licenses:
 - AGPL-3.0
@@ -170,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A conversation tracker module for Decidim

data/app/assets/config/decidim_notify_manifest.css

@@ -1,2 +0,0 @@
-/*= link decidim/notify/notify */
-/*= link decidim/notify/admin */

data/app/assets/config/decidim_notify_manifest.js

@@ -1,3 +0,0 @@
-//= link channels/decidim/notify/conversations.js
-//= link decidim/notify/select2.js
-//= link decidim/notify/conversations.js

data/app/assets/javascripts/cable.js

@@ -1,13 +0,0 @@
-// Action Cable provides the framework to deal with WebSockets in Rails.
-// You can generate new channels where WebSocket features live using the `rails generate channel` command.
-//
-//= require action_cable
-//= require_self
-//= require_tree ./channels
-
-(function() {
-  this.App || (this.App = {});
-
-  App.cable = ActionCable.createConsumer();
-
-}).call(this);

data/app/assets/javascripts/channels/decidim/notify/conversations.js

@@ -1,90 +0,0 @@
-// = require cable
-
-jQuery.fn.reverse = [].reverse;
-
-var updateEmptyStatus = function(selector) {
-  $(selector).each(function(){
-    if($(this).children().length == 0){
-      $(this).addClass("empty");
-    } else {
-      $(this).removeClass("empty");
-    }
-  });
-};
-
-App.notifyNotesChannel = App.cable.subscriptions.create({ channel: "Decidim::Notify::NotesChannel", id: window.Notify && window.Notify.id }, {
-  received: function(data) {
-    // console.log("note received",data);
-
-    if(data.create) $(`#notify-chapter-notes-${data.chapterId||"unclassified"}`).prepend(data.create);
-    if(data.update) {
-      var $note = $(`#notify-note-${data.id}`);
-      var $old = $note.closest(".notify-chapter-notes");
-      var $new = $(`#notify-chapter-notes-${data.chapterId||"unclassified"}`);
-      if($old[0] != $new[0]) {
-        // TODO: put it in the right place by time of creation
-        $note.detach().prependTo($new);
-      }
-      $note.replaceWith(data.update);
-    }
-    if(data.destroy) $(`#notify-note-${data.destroy}`).remove();
-
-    updateEmptyStatus(".notify-chapter-notes");
-  }
-});
-
-
-App.notifyParticipantsChannel = App.cable.subscriptions.create({ channel: "Decidim::Notify::ParticipantsChannel", id: window.Notify && window.Notify.id }, {
-  received: function(data) {
-    // console.log("participants received",data);
-
-    $("#notify-note_takers").html(data.noteTakers);
-    $("#notify-participants").html(data.participants);
-  }
-});
-
-App.notifyChaptersChannel = App.cable.subscriptions.create({ channel: "Decidim::Notify::ChaptersChannel", id: window.Notify && window.Notify.id }, {
-  received: function(data) {
-    // console.log("chapter received",data);
-    var newOption;
-    if(data.create) {
-      $("#notify-chapters").prepend(data.create);
-      $(document).foundation();
-      if (!$(`#note_chapter [value="${data.title}"]`).length) {
-        newOption = new Option(data.title, data.title, true, true);
-        $("#note_chapter").append(newOption).trigger("change");
-      }
-    }
-
-    if(data.update) {
-      var $chapter = $(`#notify-chapter-${data.id} .chapter-title`);
-      if($chapter.length) {
-        var old = $chapter.text();
-        $chapter.text(data.update);
-        if(data.active) {
-          $(".notify-chapter h3").removeClass("active");
-          $(`.toggle-chapter-active .switch-input:not(#chapter_active-${data.id})`).prop("checked", false);
-          $chapter.closest("h3").addClass("active");
-        }
-        var activate = $('#note_body').val()=="" && data.active;
-        newOption = new Option(data.update, data.update, activate, activate);
-        $(`#note_chapter [value="${old}"]`).remove();
-        $('#note_chapter').append(newOption).trigger('change');
-      } else {
-        console.error("Chapter not found", data);
-      }
-    }
-
-    if(data.destroy) {
-      // Move notes to the unclassified
-      var $unclassified = $("#notify-chapter-notes-unclassified");
-      $(`#notify-chapter-notes-${data.destroy} .notify-note`).reverse().each(function() {
-        $(this).detach().prependTo($unclassified);
-      });
-
-      $(`#notify-chapter-${data.destroy}`).remove();
-    }
-
-    updateEmptyStatus(".notify-chapter-notes");
-  }
-});