birdel 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db9122f08319c04ac5b369965004710158895525de8b4cd5318a217e6ffaebb8
-  data.tar.gz: 71e3290a92de20a8b7fa7def761759b9d706a400e06238f3d4e252a43c323277
+  metadata.gz: e7f141c3d5be51f76b78a748d5521d24a7f1921e2eb0a6167490c4706a3dd925
+  data.tar.gz: 510744019aa67d13ced99d9ead12b65e415412c5e19065b68bdb52442e0e9cda
 SHA512:
-  metadata.gz: ef39b27f0398e92ce27544077907575070f096e283dc27187c3461a6ce3a7350f7dc8a5a285b792d0354d427bea053949a13c5ec9afcb821a5b3ac227cc1c00d
-  data.tar.gz: 07ab2b7fea19fe05454fbb521719fcde95d4039a48be01f43bdc480176630ee88671c057e006e581529d6050ac15e8ce065379617d45d7da66ca6d869fbad1cf
+  metadata.gz: 45de59d0371824a3d04928e9b29a11c58aeb194389178ec70e7f2baf4d124d8a8f2cb63b928e56d72e6755f723b5b160ad74607a60fe3510966891fcf2e6bbf2
+  data.tar.gz: f17fd2d63c274875b715ebb1cd0c937d2f17f7190fa31771dbc0b2723a5ac79aeb739f4acfdde073aa9953fbd878ea6fae9a3844f2bbbea357c34c9e34ee3c4f

data/README.md

@@ -1,242 +1,32 @@
 # Birdel - microframework for rails
-The new coding way to server<->client speaking and assets management
-## 🛣️ Rona
-This module proces JSON request and send inputs to actor method. Inside actor method you can write your custom code and response some output values. If request has required_component field - Rona module will authomatically render that component by passing outputs values to this component.
-
-### Rona usage example
-
-```js
-  // Birdel.js request
-  window.Birdel.send({
-    "actor": "ui__sunny_squirrel_actor",
-    "method": "get_article",
-    "required_component": "home--article-component",
-    "inputs": {
-      "articleId": 69
-    },
-    "callback": {
-      "component":   "home--articles-component",
-      "actor":       "articles-component-actor",
-      "method":      "renderArticle",
-      "resource_id": false
-    }
-  });
-
-  //Response example
-  {
-    "ok": true,
-    "message": "Rendered article",
-    "data": {
-      "actor": "ui__sunny_squirrel_actor",
-      "method": "get_article",
-      "outputs": {
-        "article": {id:...}
-      },
-      "html": "<div>My Article component html</div>",
-    },
-    "callback": {
-      "component":   "home--articles-component",
-      "actor":       "articles-component-actor",
-      "method":      "renderArticle",
-      "resource_id": false
-    }
-  }
-```
-
-```js
-  // Birdel.js Direct request
-  window.Birdel.sendDirect({
-    "required_component": "home--confirm-modal-component",
-    "inputs": {
-      "confirmMessage": "Are you sure?"
-    },
-    "callback": {
-      "component":   "home--modals-component",
-      "actor":       "modals-component-actor",
-      "method":      "appendModal",
-      "resource_id": false
-    }
-  });
-
-  //Response example
-  {
-    "ok": true,
-    "message": "Actor Direct",
-    "data": {
-      "outputs": {
-        "confirmMessage": "Are you sure?"
-      },
-      "html": "<div>My confirmation modal component html</div>",
-    },
-    "callback": {
-      "component":   "home--articles-component",
-      "actor":       "articles-component-actor",
-      "method":      "renderArticle",
-      "resource_id": false
-    }
-  }
-```
-
-
-```ruby
-# Actor processor
-class SunnySquirrelActor::SunnySquirrelActor
-  def get_article(inputs, current_user)
-    article_id = inputs.fetch("articleId")
-    article = Article.find_by(id: cupboard_id)
-    return {ok: false, message: "Article not found", outputs: {}} unless article
-    return {ok: true, message: "Article", outputs: {article: article}}
-  end
-end
-```
-
-```ruby
-  #Your main channel for current entry page
-  class HomeChannel < ApplicationCable::Channel
-    state_attr_accessor :first_stream
-    include Birdel::Rona
-
-    def subscribed
-      self.first_stream = "#{params[:channel]}_#{params[:id]}"
-      stream_from self.first_stream
-    end
-  end
-```
-
-## Blah Blah Blah
-
-- [ ] Cif - Chain of Responsibility pattern
-- [x] Components generator
-- [ ] Actors generator
-- [ ] Actors specifications
-- [x] Synth - rewrite CSS ans JS indexes
-- [x] Map - generate entry page
-
-## 📝 Map
-
-Entry pages indexes generator module
 
+Generate component
 ```bash
-$ birdel map Ui::Bentries::Home
-# + app/assets/stylesheets/ui/bentries/home/components.css.json
-# + app/assets/stylesheets/ui/bentries/home/precomponents.css.json
-# + app/assets/stylesheets/ui/bentries/home/components.css
-# + app/assets/stylesheets/ui/bentries/home/precomponents.css
-# + app/assets/stylesheets/ui/bentries/home/index.css
-
-# + app/javascript/ui/bentries/home/components.js.json
-# + app/javascript/ui/bentries/home/components.js
-# + app/javascript/ui/bentries/home/index.js
-
-# + app/viewslayouts/ui/bentries/home/index.html.erb
+$ birdel gcom Ui::Bentries::Home::HomeComponent
 ```
-
-### Visualized files structure
-```
-# Css structure
-app/
-├─ assets/
-│  ├─ stylesheets/
-│  │  ├─ ui/
-│  │  │  ├─ bentries/
-│  │  │  │  ├─ some_page/
-│  │  │  │  │  ├─ index.css
-│  │  │  │  │  ├─ components.css
-│  │  │  │  │  ├─ precomponents.css.json
-│  │  │  │  │  └─ components.css.json
-
-# Javascript structure
-├─ javascript/
-│  ├─ ui/
-│  │  ├─ bentries/
-│  │  │  ├─ some_page/
-│  │  │  │  ├─ index.js
-│  │  │  │  ├─ components.js
-│  │  │  │  └─ components.js.json
-
-# Actors structure
-app/
-├─ ui/
-│  ├─ bactors/
-│  │  ├─ angry_cat_actor/
-│  │  │  └─ angry_cat_actor.rb
-
-# Component structure random example
-app/
-├─ ui/
-│  ├─ bentries/
-│  │  ├─ home/
-│  │  │  ├─ home_component/
-│  │  │  │  ├─ home_component.rb
-│  │  │  │  ├─ home_component.js
-│  │  │  │  ├─ home_component.css
-│  │  │  │  ├─ home_component_controller.js
-│  │  │  │  └─ home_component_actor.js
-│  ├─ mix/
-│  │  ├─ home/
-│  │  │  ├─ top_bar_component/
-│  │  │  │  ├─ top_bar_component.rb
-│  │  │  │  ├─ top_bar_component.js
-│  │  │  │  ├─ top_bar_component.css
-│  │  │  │  ├─ top_bar_component_controller.js
-│  │  │  │  └─ top_bar_component_actor.js
+Generate entry
+```bash
+$ birdel gent Home
 ```
-
-
-
-```ruby
-# app/assets/stylesheets/ui/home/precomponents.json
-
-[
-  "ui/birdel/dropdown",
-  "ui/birdel/layout"
-]
-
-# app/assets/stylesheets/ui/home/components.css.json
-[
-  "ui/bentries/home/home_component/home_component",
-  "ui/mix/home/mini_product_component/mini_product_component"
-]
-
-# app/views/layouts/ui/bentries/home/index.html.erb
-...
-  <%= stylesheet_link_tag "ui/bentries/home/index", "data-turbo-track": "reload" %>
-  <%= javascript_include_tag "ui/bentries/home/index", "data-turbo-track": "reload", defer: true, type: "module" %>
-...
+Sync css and js
+```bash
+$ birdel synth
 ```
-
-## Actor Specification example
-
-```ruby
-class AngryCatActor::AngryCatActorSpecification
-  def initialize(msg)
-    parsed_msg = JSON.parse(msg)
-    @msg = parsed_msg.transform_keys(&:to_sym)
-  end
-
-  def inputs
-    [
-      { name: "customer", type: "string" },
-      { name: "items", type: "array" }
-    ]
-  end
-
-  def outputs
-    [
-      { name: "order_id", type: "integer" },
-      { name: "total_amount", type: "float" }
-    ]
-  end
-
-  def methods
-    [
-      { name: "process_order", input: ["customer", "items"], output: ["order_id", "total_amount"] }
-    ]
-  end
-
-  def msg_valid?
-    @msg[:inputs]&.keys.to_set == inputs.map { |i| i[:name] }.to_set &&
-    inputs.all? { |i| @msg[:inputs][i[:name]].is_a?(i[:type].camelize.constantize) }
-  end
-end
-```
+Send request
+```js
+window.Birdel.actor("ui__angry_cat_actor")
+  .method("get_article")
+  .required_component("ui--mix--article-component") // or false
+  .inputs({
+    articleId: 69
+  })
+  .callback({
+    "component":   "ui--entries--home-component",
+    "actor":       "home-component-actor",
+    "method":      "showArticle",
+    "resource_id": false //or ID of your actor
+  })
+  .send()
+```
+
+Full documentation is not ready and will be at https://digitalthing.io/docs/birdel, well, sorry😄

data/lib/birdel/rona/rona_actor.rb

@@ -28,7 +28,13 @@ module Birdel
       end
       if callback
         res[:callback] = callback
-        res[:callback][:resourceId] = method_res[:resource_id].present? ? method_res[:resource_id] : false
+        # first - check if Actor method returned specific resource_id
+        # otherwise - set resource_id from callback if it exists or set false
+        if method_res[:resource_id].present?
+          res[:callback][:resourceId] = method_res[:resource_id]
+        else
+          res[:callback][:resourceId] = callback[:resourceId].present? ? callback[:resourceId] : false
+        end
         ActionCable.server.broadcast(self.first_stream, res)
       end
     end

data/lib/birdel/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Birdel
-  VERSION = "3.1.0"
+  VERSION = "3.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: birdel
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Serhii
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-15 00:00:00.000000000 Z
+date: 2023-06-06 00:00:00.000000000 Z
 dependencies: []
 description: Send json messages to your actors and get view_components back! Now you
   can be sure that your actors are processed correctly.