bpmn-js-rails 0.1.0

data/app/javascript/bpmn_js_rails/controllers/form_js_viewer_controller.js

@@ -0,0 +1,52 @@
+import { Controller } from "@hotwired/stimulus"
+
+// Connects to data-controller="form-js-viewer"
+//
+// Values:
+//   schema (Object) - the form-js JSON schema
+//   data   (Object) - initial form data to populate fields
+//
+// Lifecycle:
+//   connect:    creates the FormViewer.Form instance
+//   disconnect: destroys it (cleans up DOM + listeners)
+//
+// Events dispatched on the controller element:
+//   form-js:submit  - { detail: { data, errors } }
+//   form-js:changed - { detail: { data } }
+//
+export default class extends Controller {
+  static values = {
+    schema: { type: Object, default: { type: "default", components: [] } },
+    data:   { type: Object, default: {} }
+  }
+
+  connect() {
+    if (typeof FormViewer === "undefined") {
+      console.error("[bpmn-js-rails] FormViewer global not found. Make sure form-viewer.umd.js is loaded.")
+      return
+    }
+
+    FormViewer.createForm({
+      container: this.element,
+      schema: this.schemaValue,
+      data: this.dataValue
+    }).then((form) => {
+      this.form = form
+
+      form.on("submit", (event) => {
+        this.dispatch("submit", { detail: { data: event.data, errors: event.errors } })
+      })
+
+      form.on("changed", (event) => {
+        this.dispatch("changed", { detail: { data: event.data } })
+      })
+    })
+  }
+
+  disconnect() {
+    if (this.form) {
+      this.form.destroy()
+      this.form = null
+    }
+  }
+}

data/app/javascript/bpmn_js_rails/index.js

@@ -0,0 +1,34 @@
+import BpmnJsViewerController from "bpmn_js_rails/controllers/bpmn_js_viewer_controller"
+import BpmnJsModelerController from "bpmn_js_rails/controllers/bpmn_js_modeler_controller"
+import FormJsViewerController from "bpmn_js_rails/controllers/form_js_viewer_controller"
+import FormJsEditorController from "bpmn_js_rails/controllers/form_js_editor_controller"
+import DmnJsViewerController from "bpmn_js_rails/controllers/dmn_js_viewer_controller"
+import DmnJsModelerController from "bpmn_js_rails/controllers/dmn_js_modeler_controller"
+
+// Register all bpmn-js-rails Stimulus controllers with the host application.
+//
+// Usage in your controllers/application.js:
+//
+//   import { Application } from "@hotwired/stimulus"
+//   import { registerBpmnJsControllers } from "bpmn_js_rails"
+//
+//   const application = Application.start()
+//   registerBpmnJsControllers(application)
+//
+export function registerBpmnJsControllers(application) {
+  application.register("bpmn-js-viewer", BpmnJsViewerController)
+  application.register("bpmn-js-modeler", BpmnJsModelerController)
+  application.register("form-js-viewer", FormJsViewerController)
+  application.register("form-js-editor", FormJsEditorController)
+  application.register("dmn-js-viewer", DmnJsViewerController)
+  application.register("dmn-js-modeler", DmnJsModelerController)
+}
+
+export {
+  BpmnJsViewerController,
+  BpmnJsModelerController,
+  FormJsViewerController,
+  FormJsEditorController,
+  DmnJsViewerController,
+  DmnJsModelerController
+}

data/app/models/bpmn_js_rails/decision.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module BpmnJsRails
+  class Decision < ActiveRecord::Base
+    self.table_name = "bpmn_js_rails_decisions"
+
+    STATUSES = %w[draft published].freeze
+
+    DEFAULT_XML = <<~DMN
+      <?xml version="1.0" encoding="UTF-8"?>
+      <definitions xmlns="https://www.omg.org/spec/DMN/20191111/MODEL/"
+                   xmlns:dmndi="https://www.omg.org/spec/DMN/20191111/DMNDI/"
+                   xmlns:dc="http://www.omg.org/spec/DMN/20180521/DC/"
+                   id="Definitions_1"
+                   name="definitions"
+                   namespace="http://camunda.org/schema/1.0/dmn">
+        <decision id="Decision_1" name="Decision">
+          <decisionTable id="DecisionTable_1">
+            <input id="Input_1" label="">
+              <inputExpression id="InputExpression_1" typeRef="string">
+                <text></text>
+              </inputExpression>
+            </input>
+            <output id="Output_1" label="" name="" typeRef="string" />
+          </decisionTable>
+        </decision>
+        <dmndi:DMNDI>
+          <dmndi:DMNDiagram id="DMNDiagram_1">
+            <dmndi:DMNShape id="DMNShape_1" dmnElementRef="Decision_1">
+              <dc:Bounds height="80" width="180" x="250" y="300" />
+            </dmndi:DMNShape>
+          </dmndi:DMNDiagram>
+        </dmndi:DMNDI>
+      </definitions>
+    DMN
+
+    validates :name, presence: true
+    validates :xml, presence: true
+    validates :status, inclusion: { in: STATUSES }
+
+    scope :draft, -> { where(status: "draft") }
+    scope :published, -> { where(status: "published") }
+
+    attribute :xml, :string, default: -> { DEFAULT_XML }
+    attribute :status, :string, default: "draft"
+    attribute :version, :integer, default: 1
+
+    def published?
+      status == "published"
+    end
+
+    def draft?
+      status == "draft"
+    end
+
+    def publish!
+      update!(status: "published")
+    end
+  end
+end

data/app/models/bpmn_js_rails/diagram.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module BpmnJsRails
+  class Diagram < ActiveRecord::Base
+    self.table_name = "bpmn_js_rails_diagrams"
+
+    STATUSES = %w[draft published].freeze
+
+    DEFAULT_XML = <<~BPMN
+      <?xml version="1.0" encoding="UTF-8"?>
+      <bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL"
+                        xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI"
+                        xmlns:dc="http://www.omg.org/spec/DD/20100524/DC"
+                        targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1">
+        <bpmn:process id="Process_1" isExecutable="false">
+          <bpmn:startEvent id="StartEvent_1"/>
+        </bpmn:process>
+        <bpmndi:BPMNDiagram id="BPMNDiagram_1">
+          <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1">
+            <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1">
+              <dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/>
+            </bpmndi:BPMNShape>
+          </bpmndi:BPMNPlane>
+        </bpmndi:BPMNDiagram>
+      </bpmn:definitions>
+    BPMN
+
+    validates :name, presence: true
+    validates :xml, presence: true
+    validates :status, inclusion: { in: STATUSES }
+
+    scope :draft, -> { where(status: "draft") }
+    scope :published, -> { where(status: "published") }
+
+    attribute :xml, :string, default: -> { DEFAULT_XML }
+    attribute :status, :string, default: "draft"
+    attribute :version, :integer, default: 1
+
+    def published?
+      status == "published"
+    end
+
+    def draft?
+      status == "draft"
+    end
+
+    def publish!
+      update!(status: "published")
+    end
+  end
+end

data/app/models/bpmn_js_rails/form.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module BpmnJsRails
+  class Form < ActiveRecord::Base
+    self.table_name = "bpmn_js_rails_forms"
+
+    STATUSES = %w[draft published].freeze
+
+    validates :name, presence: true
+    validates :schema, presence: true
+    validates :status, inclusion: { in: STATUSES }
+
+    scope :draft, -> { where(status: "draft") }
+    scope :published, -> { where(status: "published") }
+
+    attribute :schema, :json, default: -> { { "type" => "default", "components" => [] } }
+    attribute :status, :string, default: "draft"
+    attribute :version, :integer, default: 1
+
+    def published?
+      status == "published"
+    end
+
+    def draft?
+      status == "draft"
+    end
+
+    def publish!
+      update!(status: "published")
+    end
+  end
+end

data/config/importmap.rb

@@ -0,0 +1,7 @@
+pin "bpmn_js_rails", to: "bpmn_js_rails/index.js"
+pin "bpmn_js_rails/controllers/bpmn_js_viewer_controller", to: "bpmn_js_rails/controllers/bpmn_js_viewer_controller.js"
+pin "bpmn_js_rails/controllers/bpmn_js_modeler_controller", to: "bpmn_js_rails/controllers/bpmn_js_modeler_controller.js"
+pin "bpmn_js_rails/controllers/form_js_viewer_controller", to: "bpmn_js_rails/controllers/form_js_viewer_controller.js"
+pin "bpmn_js_rails/controllers/form_js_editor_controller", to: "bpmn_js_rails/controllers/form_js_editor_controller.js"
+pin "bpmn_js_rails/controllers/dmn_js_viewer_controller", to: "bpmn_js_rails/controllers/dmn_js_viewer_controller.js"
+pin "bpmn_js_rails/controllers/dmn_js_modeler_controller", to: "bpmn_js_rails/controllers/dmn_js_modeler_controller.js"

data/config/routes.rb

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

data/db/migrate/20260319000001_create_bpmn_js_rails_diagrams.rb

@@ -0,0 +1,15 @@
+class CreateBpmnJsRailsDiagrams < ActiveRecord::Migration[8.1]
+  def change
+    create_table :bpmn_js_rails_diagrams do |t|
+      t.string :name, null: false
+      t.text :description
+      t.text :xml, null: false
+      t.string :status, null: false, default: "draft"
+      t.integer :version, null: false, default: 1
+
+      t.timestamps
+    end
+
+    add_index :bpmn_js_rails_diagrams, :status
+  end
+end

data/db/migrate/20260319000002_create_bpmn_js_rails_forms.rb

@@ -0,0 +1,15 @@
+class CreateBpmnJsRailsForms < ActiveRecord::Migration[8.1]
+  def change
+    create_table :bpmn_js_rails_forms do |t|
+      t.string :name, null: false
+      t.text :description
+      t.json :schema, null: false, default: { type: "default", components: [] }
+      t.string :status, null: false, default: "draft"
+      t.integer :version, null: false, default: 1
+
+      t.timestamps
+    end
+
+    add_index :bpmn_js_rails_forms, :status
+  end
+end

data/db/migrate/20260319000003_create_bpmn_js_rails_decisions.rb

@@ -0,0 +1,15 @@
+class CreateBpmnJsRailsDecisions < ActiveRecord::Migration[8.1]
+  def change
+    create_table :bpmn_js_rails_decisions do |t|
+      t.string :name, null: false
+      t.text :description
+      t.text :xml, null: false
+      t.string :status, null: false, default: "draft"
+      t.integer :version, null: false, default: 1
+
+      t.timestamps
+    end
+
+    add_index :bpmn_js_rails_decisions, :status
+  end
+end

data/lib/bpmn-js-rails.rb

@@ -0,0 +1 @@
+require "bpmn_js_rails"

data/lib/bpmn_js_rails/engine.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module BpmnJsRails
+  class Engine < ::Rails::Engine
+    isolate_namespace BpmnJsRails
+
+    initializer "bpmn_js_rails.assets" do |app|
+      app.config.assets.paths << root.join("app/assets/javascripts")
+      app.config.assets.paths << root.join("app/assets/stylesheets")
+      app.config.assets.paths << root.join("app/javascript")
+    end
+
+    initializer "bpmn_js_rails.importmap", before: "importmap" do |app|
+      if app.config.respond_to?(:importmap)
+        app.config.importmap.paths << root.join("config/importmap.rb")
+      end
+    end
+
+    initializer "bpmn_js_rails.helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include BpmnJsRails::ViewHelper
+      end
+    end
+
+    initializer "bpmn_js_rails.migrations" do |app|
+      engine_migrate_path = root.join("db/migrate").to_s
+      app.config.paths["db/migrate"] << engine_migrate_path
+    end
+  end
+end

data/lib/bpmn_js_rails/version.rb

@@ -0,0 +1,3 @@
+module BpmnJsRails
+  VERSION = "0.1.0"
+end

data/lib/bpmn_js_rails/version.rb.erb

@@ -0,0 +1,3 @@
+module BpmnJsRails
+  VERSION = "<%= version %>"
+end

data/lib/bpmn_js_rails.rb

@@ -0,0 +1,5 @@
+require "bpmn_js_rails/version"
+require "bpmn_js_rails/engine"
+
+module BpmnJsRails
+end

data/lib/generators/bpmn_js_rails/install/install_generator.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module BpmnJsRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Install BpmnJsRails: copy migrations for forms, diagrams, and decisions"
+
+      def self.next_migration_number(dirname)
+        next_migration_nr = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_nr)
+      end
+
+      def copy_migrations
+        migration_template(
+          "create_bpmn_js_rails_forms.rb.erb",
+          "db/migrate/create_bpmn_js_rails_forms.rb"
+        )
+
+        migration_template(
+          "create_bpmn_js_rails_diagrams.rb.erb",
+          "db/migrate/create_bpmn_js_rails_diagrams.rb"
+        )
+
+        migration_template(
+          "create_bpmn_js_rails_decisions.rb.erb",
+          "db/migrate/create_bpmn_js_rails_decisions.rb"
+        )
+      end
+
+      def show_post_install_message
+        say ""
+        say "BpmnJsRails installed successfully!", :green
+        say ""
+        say "Next steps:"
+        say "  1. Run migrations:  rails db:migrate"
+        say ""
+        say "  Forms (form-js):"
+        say "    - Add to layout:  <%= form_js_assets %>"
+        say "    - Viewer:         <%= form_js_viewer(@form) %>"
+        say "    - Editor:         <%= form_js_editor(@form, field_name: 'form[schema]') %>"
+        say ""
+        say "  Diagrams (bpmn-js):"
+        say "    - Add to layout:  <%= bpmn_js_assets %>"
+        say "    - Viewer:         <%= bpmn_js_viewer(@diagram) %>"
+        say "    - Modeler:        <%= bpmn_js_modeler(@diagram, field_name: 'diagram[xml]') %>"
+        say ""
+        say "  Decisions (dmn-js):"
+        say "    - Add to layout:  <%= dmn_js_assets %>"
+        say "    - Viewer:         <%= dmn_js_viewer(@decision) %>"
+        say "    - Modeler:        <%= dmn_js_modeler(@decision, field_name: 'decision[xml]') %>"
+        say ""
+      end
+    end
+  end
+end

data/lib/generators/bpmn_js_rails/install/templates/create_bpmn_js_rails_decisions.rb.erb

@@ -0,0 +1,15 @@
+class CreateBpmnJsRailsDecisions < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :bpmn_js_rails_decisions do |t|
+      t.string :name, null: false
+      t.text :description
+      t.text :xml, null: false
+      t.string :status, null: false, default: "draft"
+      t.integer :version, null: false, default: 1
+
+      t.timestamps
+    end
+
+    add_index :bpmn_js_rails_decisions, :status
+  end
+end

data/lib/generators/bpmn_js_rails/install/templates/create_bpmn_js_rails_diagrams.rb.erb

@@ -0,0 +1,15 @@
+class CreateBpmnJsRailsDiagrams < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :bpmn_js_rails_diagrams do |t|
+      t.string :name, null: false
+      t.text :description
+      t.text :xml, null: false
+      t.string :status, null: false, default: "draft"
+      t.integer :version, null: false, default: 1
+
+      t.timestamps
+    end
+
+    add_index :bpmn_js_rails_diagrams, :status
+  end
+end

data/lib/generators/bpmn_js_rails/install/templates/create_bpmn_js_rails_forms.rb.erb

@@ -0,0 +1,15 @@
+class CreateBpmnJsRailsForms < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :bpmn_js_rails_forms do |t|
+      t.string :name, null: false
+      t.text :description
+      t.json :schema, null: false, default: { type: "default", components: [] }
+      t.string :status, null: false, default: "draft"
+      t.integer :version, null: false, default: 1
+
+      t.timestamps
+    end
+
+    add_index :bpmn_js_rails_forms, :status
+  end
+end

data/lib/tasks/form_js_rails_tasks.rake

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

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: bpmn-js-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nathan
+bindir: bin
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.0
+description: bpmn-io/bpmn-js and form-js packaged as a Rails engine
+email:
+- nathankidd@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- app/assets/javascripts/bpmn-js/bpmn-modeler.production.min.js
+- app/assets/javascripts/bpmn-js/bpmn-viewer.production.min.js
+- app/assets/javascripts/dmn-js/dmn-modeler.production.min.js
+- app/assets/javascripts/dmn-js/dmn-viewer.production.min.js
+- app/assets/javascripts/form-js/form-editor.umd.js
+- app/assets/javascripts/form-js/form-viewer.umd.js
+- app/assets/stylesheets/bpmn-js/bpmn-font/css/bpmn-codes.css
+- app/assets/stylesheets/bpmn-js/bpmn-font/css/bpmn-embedded.css
+- app/assets/stylesheets/bpmn-js/bpmn-font/css/bpmn.css
+- app/assets/stylesheets/bpmn-js/bpmn-font/font/bpmn.eot
+- app/assets/stylesheets/bpmn-js/bpmn-font/font/bpmn.svg
+- app/assets/stylesheets/bpmn-js/bpmn-font/font/bpmn.ttf
+- app/assets/stylesheets/bpmn-js/bpmn-font/font/bpmn.woff
+- app/assets/stylesheets/bpmn-js/bpmn-font/font/bpmn.woff2
+- app/assets/stylesheets/bpmn-js/bpmn-js.css
+- app/assets/stylesheets/bpmn-js/diagram-js.css
+- app/assets/stylesheets/dmn-js/diagram-js.css
+- app/assets/stylesheets/dmn-js/dmn-font/css/dmn-codes.css
+- app/assets/stylesheets/dmn-js/dmn-font/css/dmn-embedded.css
+- app/assets/stylesheets/dmn-js/dmn-font/css/dmn.css
+- app/assets/stylesheets/dmn-js/dmn-font/font/dmn.eot
+- app/assets/stylesheets/dmn-js/dmn-font/font/dmn.svg
+- app/assets/stylesheets/dmn-js/dmn-font/font/dmn.ttf
+- app/assets/stylesheets/dmn-js/dmn-font/font/dmn.woff
+- app/assets/stylesheets/dmn-js/dmn-font/font/dmn.woff2
+- app/assets/stylesheets/dmn-js/dmn-js-boxed-expression-controls.css
+- app/assets/stylesheets/dmn-js/dmn-js-boxed-expression.css
+- app/assets/stylesheets/dmn-js/dmn-js-decision-table-controls.css
+- app/assets/stylesheets/dmn-js/dmn-js-decision-table.css
+- app/assets/stylesheets/dmn-js/dmn-js-drd.css
+- app/assets/stylesheets/dmn-js/dmn-js-literal-expression.css
+- app/assets/stylesheets/dmn-js/dmn-js-shared.css
+- app/assets/stylesheets/form-js/form-js-editor.css
+- app/assets/stylesheets/form-js/form-js.css
+- app/helpers/bpmn_js_rails/view_helper.rb
+- app/javascript/bpmn_js_rails/controllers/bpmn_js_modeler_controller.js
+- app/javascript/bpmn_js_rails/controllers/bpmn_js_viewer_controller.js
+- app/javascript/bpmn_js_rails/controllers/dmn_js_modeler_controller.js
+- app/javascript/bpmn_js_rails/controllers/dmn_js_viewer_controller.js
+- app/javascript/bpmn_js_rails/controllers/form_js_editor_controller.js
+- app/javascript/bpmn_js_rails/controllers/form_js_viewer_controller.js
+- app/javascript/bpmn_js_rails/index.js
+- app/models/bpmn_js_rails/decision.rb
+- app/models/bpmn_js_rails/diagram.rb
+- app/models/bpmn_js_rails/form.rb
+- config/importmap.rb
+- config/routes.rb
+- db/migrate/20260319000001_create_bpmn_js_rails_diagrams.rb
+- db/migrate/20260319000002_create_bpmn_js_rails_forms.rb
+- db/migrate/20260319000003_create_bpmn_js_rails_decisions.rb
+- lib/bpmn-js-rails.rb
+- lib/bpmn_js_rails.rb
+- lib/bpmn_js_rails/engine.rb
+- lib/bpmn_js_rails/version.rb
+- lib/bpmn_js_rails/version.rb.erb
+- lib/generators/bpmn_js_rails/install/install_generator.rb
+- lib/generators/bpmn_js_rails/install/templates/create_bpmn_js_rails_decisions.rb.erb
+- lib/generators/bpmn_js_rails/install/templates/create_bpmn_js_rails_diagrams.rb.erb
+- lib/generators/bpmn_js_rails/install/templates/create_bpmn_js_rails_forms.rb.erb
+- lib/tasks/form_js_rails_tasks.rake
+homepage: https://github.com/general-intelligence-systems/bpmn-js-rails
+licenses: []
+metadata:
+  homepage_uri: https://github.com/general-intelligence-systems/bpmn-js-rails
+  source_code_uri: https://github.com/general-intelligence-systems/bpmn-js-rails
+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.7.2
+specification_version: 4
+summary: bpmn-io/bpmn-js and form-js packaged as a Rails engine
+test_files: []