yrby-rails 0.4.0

data/lib/y/action_cable.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "y"
+
+module Y
+  # ActionCable integration for yrby.
+  #
+  # Provides Y::ActionCable::Sync, a channel concern implementing the
+  # y-websocket sync protocol and awareness/presence over ActionCable (and
+  # AnyCable), so a Rails app can be the collaboration server for Y.js editors
+  # with no Node sidecar. The CRDT documents, awareness, and protocol primitives
+  # themselves come from the core `yrby` gem.
+  module ActionCable
+    # `include Y::ActionCable` forwards to `Y::ActionCable::Sync`, the
+    # module's home. Both spellings work; the short one reads better in a
+    # channel.
+    def self.included(base)
+      base.include(Sync)
+    end
+  end
+end
+
+require "y/action_cable/sync"

data/lib/yrby/engine.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rails/engine"
+require "action_dispatch" # Engine::Configuration references it at subclass definition
+
+module Yrby
+  # The Rails engine. Autoloads the gem's models (Y::Document,
+  # Y::DocumentUpdate) from app/models.
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/yrby/rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Yrby
+  module Rails
+    VERSION = "0.4.0"
+  end
+end

data/lib/yrby-rails.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Entry point matching the gem name, so `Bundler.require` loads it automatically.
+require "yrby/rails/version"
+require "y/action_cable"
+require "yrby/engine" if defined?(Rails::Engine)

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: yrby-rails
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- JP Camara
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: yrby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: actioncable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: 'The Rails integration for yrby (formerly yrby-actioncable): a y-websocket
+  sync channel for Action Cable and AnyCable (include Y::ActionCable), engine-owned
+  document storage with compaction (Y::Document, Y::DocumentUpdate), and an install
+  generator. A Rails app serves Y.js editors with no Node sidecar.'
+email:
+- johnpcamara@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG-rails.md
+- LICENSE
+- README.md
+- app/models/y/document.rb
+- app/models/y/document_update.rb
+- lib/generators/yrby/install/USAGE
+- lib/generators/yrby/install/install_generator.rb
+- lib/generators/yrby/install/templates/document_channel.rb
+- lib/generators/yrby/tables/tables_generator.rb
+- lib/generators/yrby/tables/templates/create_y_tables.rb
+- lib/y/action_cable.rb
+- lib/y/action_cable/sync.rb
+- lib/yrby-rails.rb
+- lib/yrby/engine.rb
+- lib/yrby/rails/version.rb
+homepage: https://github.com/jpcamara/yrby
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/jpcamara/yrby
+  changelog_uri: https://github.com/jpcamara/yrby/blob/main/CHANGELOG-rails.md
+  bug_tracker_uri: https://github.com/jpcamara/yrby/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: 'The Rails integration for yrby: sync channel, document models, and install
+  generator'
+test_files: []