y-rb 0.1.3 → 0.1.4.alpha.1

data/lib/y/text.rb

@@ -87,7 +87,7 @@ module Y
     #
     #   text.empty? # true
     #
-    # @return [true|false]
+    # @return [TrueClass,FalseClass]
     def empty?
       length.zero?
     end
@@ -122,8 +122,7 @@ module Y
       if value.is_a?(String)
         ytext_insert(transaction, index, value) if attrs.nil?
         unless attrs.nil?
-          ytext_insert_with_attrs(transaction, index, value,
-                                  attrs)
+          ytext_insert_with_attributes(transaction, index, value, attrs)
         end
         return nil
       end
@@ -131,8 +130,7 @@ module Y
       if can_insert?(value)
         ytext_insert_embed(transaction, index, value) if attrs.nil?
         unless attrs.nil?
-          ytext_insert_embed_with_attrs(transaction, index, value,
-                                        attrs)
+          ytext_insert_embed_with_attributes(transaction, index, value, attrs)
         end
         return nil
       end
@@ -279,6 +277,8 @@ module Y
         value.is_a?(Hash)
     end
 
+    # rubocop:disable Layout/LineLength
+
     # @!method ytext_insert(transaction, index, chunk)
     #   Insert into text at position
     #
@@ -295,7 +295,7 @@ module Y
     # @param [Y::Text, Y::Array, Y::Map] content
     # @return [nil]
 
-    # @!method ytext_insert_embed_with_attrs(transaction, index, embed, attrs)
+    # @!method ytext_insert_embed_with_attributes(transaction, index, embed, attrs)
     #   Insert into text at position
     #
     # @param [Y::Transaction] transaction
@@ -304,7 +304,7 @@ module Y
     # @param [Hash] attrs
     # @return [nil]
 
-    # @!method ytext_insert_with_attrs(transaction, index, chunk, attrs)
+    # @!method ytext_insert_with_attributes(transaction, index, chunk, attrs)
     #   Insert into text at position
     #
     # @param [Y::Transaction] transaction
@@ -359,6 +359,8 @@ module Y
     # @param [Integer] subscription_id
     # @return [void]
 
+    # rubocop:enable Layout/LineLength
+
     # A reference to the current active transaction of the document this map
     # belongs to.
     #

data/lib/y/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Y
-  VERSION = "0.1.3"
+  VERSION = "0.1.4.alpha.1"
 end

data/lib/y.rb

@@ -1,4 +1,20 @@
 # frozen_string_literal: true
 
+# load native extension
+begin
+  ruby_version = /(\d+\.\d+)/.match(::RUBY_VERSION)
+  require_relative "#{ruby_version}/yrb"
+rescue LoadError
+  require "yrb"
+end
+
+require_relative "y/array"
+require_relative "y/doc"
+require_relative "y/map"
+require_relative "y/text"
+require_relative "y/xml"
+require_relative "y/transaction"
+require_relative "y/version"
+
 module Y
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: y-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4.alpha.1
 platform: ruby
 authors:
 - Hannes Moser
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-15 00:00:00.000000000 Z
+date: 2022-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -25,109 +25,107 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rutie
+  name: rb_sys
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.9.30
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.9.30
 - !ruby/object:Gem::Dependency
-  name: thermite
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 6.1.6.1
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.6.1
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: minitar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.6.1
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.6.1
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: minitar
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rake-compiler-dock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
 description: Ruby bindings for yrs. Yrs "wires" is a Rust port of the Yjs framework.
 email:
 - hmoser@gitlab.com
 - box@hannesmoser.at
 executables: []
 extensions:
-- ext/Rakefile
+- ext/yrb/extconf.rb
 extra_rdoc_files: []
 files:
-- ".dockerignore"
-- ".editorconfig"
-- ".rspec"
-- ".rubocop.yml"
-- ".rustfmt.toml"
-- ".yardopts"
-- Cargo.toml
-- Cross.toml
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
-- README.md
-- Rakefile
-- bin/console
-- bin/setup
-- build/Dockerfile
-- build/build.rb
-- build/entrypoint.sh
-- docs/decisions.md
-- docs/examples.md
-- docs/release.md
-- ext/Rakefile
+- ext/yrb/Cargo.lock
+- ext/yrb/Cargo.toml
+- ext/yrb/extconf.rb
+- ext/yrb/src/lib.rs
+- ext/yrb/src/utils.rs
+- ext/yrb/src/yany.rs
+- ext/yrb/src/yarray.rs
+- ext/yrb/src/yattrs.rs
+- ext/yrb/src/ydoc.rs
+- ext/yrb/src/ymap.rs
+- ext/yrb/src/ytext.rs
+- ext/yrb/src/ytransaction.rs
+- ext/yrb/src/yvalue.rs
+- ext/yrb/src/yxml_element.rs
+- ext/yrb/src/yxml_text.rs
 - lib/y.rb
 - lib/y/array.rb
 - lib/y/doc.rb
 - lib/y/map.rb
-- lib/y/rb.rb
 - lib/y/text.rb
 - lib/y/transaction.rb
 - lib/y/version.rb
 - lib/y/xml.rb
-- src/lib.rs
-- src/util.rs
-- src/yarray.rs
-- src/ydoc.rs
-- src/ymap.rs
-- src/ytext.rs
-- src/ytransaction.rs
-- src/yxml.rs
 homepage: https://github.com/y-crdt/yrb
 licenses:
 - MIT
@@ -145,12 +143,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.32
 signing_key:

data/.dockerignore

@@ -1,5 +0,0 @@
-.idea/
-.yardoc/
-doc/
-docs/
-target/

data/.editorconfig

@@ -1,16 +0,0 @@
-# EditorConfig is awesome: https://EditorConfig.org
-
-root = true
-
-[*]
-end_of_line = lf
-insert_final_newline = true
-charset = utf-8
-
-[*.{rb,yml}]
-indent_style = space
-indent_size = 2
-
-[*.rs]
-indent_style = space
-indent_size = 4

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,23 +0,0 @@
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 2.6
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/y/*_spec.rb
-
-Style/Documentation:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 80
-  Exclude:
-    - y-rb.gemspec

data/.rustfmt.toml

@@ -1,74 +0,0 @@
-max_width = 80
-hard_tabs = false
-tab_spaces = 4
-newline_style = "Auto"
-indent_style = "Block"
-use_small_heuristics = "Default"
-fn_call_width = 60
-attr_fn_like_width = 70
-struct_lit_width = 18
-struct_variant_width = 35
-array_width = 60
-chain_width = 60
-single_line_if_else_max_width = 50
-wrap_comments = false
-format_code_in_doc_comments = false
-comment_width = 80
-normalize_comments = false
-normalize_doc_attributes = false
-license_template_path = ""
-format_strings = false
-format_macro_matchers = false
-format_macro_bodies = true
-empty_item_single_line = true
-struct_lit_single_line = true
-fn_single_line = false
-where_single_line = false
-imports_indent = "Block"
-imports_layout = "Mixed"
-imports_granularity = "Preserve"
-group_imports = "Preserve"
-reorder_imports = true
-reorder_modules = true
-reorder_impl_items = false
-type_punctuation_density = "Wide"
-space_before_colon = false
-space_after_colon = true
-spaces_around_ranges = false
-binop_separator = "Front"
-remove_nested_parens = true
-combine_control_expr = true
-overflow_delimited_expr = false
-struct_field_align_threshold = 0
-enum_discrim_align_threshold = 0
-match_arm_blocks = true
-match_arm_leading_pipes = "Never"
-force_multiline_blocks = false
-fn_args_layout = "Tall"
-brace_style = "SameLineWhere"
-control_brace_style = "AlwaysSameLine"
-trailing_semicolon = true
-trailing_comma = "Never"
-match_block_trailing_comma = false
-blank_lines_upper_bound = 1
-blank_lines_lower_bound = 0
-edition = "2015"
-version = "One"
-inline_attribute_width = 0
-merge_derives = true
-use_try_shorthand = false
-use_field_init_shorthand = false
-force_explicit_abi = true
-condense_wildcard_suffixes = false
-color = "Auto"
-unstable_features = false
-disable_all_formatting = false
-skip_children = false
-hide_parse_errors = false
-error_on_line_overflow = false
-error_on_unformatted = false
-report_todo = "Never"
-report_fixme = "Never"
-ignore = []
-emit_mode = "Files"
-make_backup = false

data/.yardopts

@@ -1,2 +0,0 @@
---markup-provider=redcarpet
---markup=markdown

data/Cargo.toml

@@ -1,29 +0,0 @@
-[package]
-name = "y-rb"
-version = "0.1.3"
-authors = ["Hannes Moser <box@hannesmoser.at>", "Hannes Moser <hmoser@gitlab.com>"]
-edition = "2021"
-homepage = "https://github.com/y-crdt/yrb"
-repository = "https://github.com/y-crdt/yrb"
-
-[dependencies]
-lazy_static = "1.4.0"
-rutie = "0.8.4"
-yrs = "0.10.1"
-lib0 = "0.10.1" # must match yrs version
-
-[target.aarch64-unknown-linux-musl.dependencies]
-rutie = {version="0.8.4", features=["no-link"]}
-
-[target.x86_64-unknown-linux-musl.dependencies]
-rutie = {version="0.8.4", features=["no-link"]}
-
-[target.aarch64-unknown-linux-gnu.dependencies]
-rutie = {version="0.8.4", features=["no-link"]}
-
-[lib]
-name = "y_rb"
-crate-type = ["cdylib"]
-
-[package.metadata.thermite]
-github_releases = true

data/Cross.toml

@@ -1,17 +0,0 @@
-[build]
-
-[build.dockerfile]
-file = "./build/Dockerfile"
-
-[build.env]
-passthrough = [
-    "RUBY_VERSION"
-]
-
-[target.aarch64-apple-darwin]
-
-[target.x86_64-apple-darwin]
-
-[target.x86_64-unknown-linux-gnu]
-
-[target.x86_64-unknown-linux-musl]

data/Gemfile

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in y-rb.gemspec
-gemspec
-
-gem "github-markup"
-gem "redcarpet"
-gem "rspec", "~> 3.11.0"
-gem "rubocop", "~> 1.31"
-gem "rubocop-rspec", "~> 2.12.1"
-gem "yard"

data/Gemfile.lock

@@ -1,93 +0,0 @@
-PATH
-  remote: .
-  specs:
-    y-rb (0.1.3)
-      rake (~> 13.0)
-      rutie (~> 0.0.4)
-      thermite (~> 0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.1.6.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    ast (2.4.2)
-    concurrent-ruby (1.1.10)
-    diff-lcs (1.5.0)
-    github-markup (4.0.1)
-    i18n (1.12.0)
-      concurrent-ruby (~> 1.0)
-    json (2.6.2)
-    minitar (0.9)
-    minitest (5.16.2)
-    parallel (1.22.1)
-    parser (3.1.2.0)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    redcarpet (3.5.1)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.31.2)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.19.1)
-      parser (>= 3.1.1.0)
-    rubocop-rspec (2.12.1)
-      rubocop (~> 1.31)
-    ruby-progressbar (1.11.0)
-    rutie (0.0.4)
-    thermite (0.13.0)
-      minitar (~> 0.5)
-      rake (>= 10)
-      tomlrb (~> 1.2)
-    tomlrb (1.3.0)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.2.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
-    zeitwerk (2.6.0)
-
-PLATFORMS
-  arm64-darwin-21
-  x86_64-linux
-
-DEPENDENCIES
-  activesupport (~> 6.1.6.1)
-  github-markup
-  minitar (~> 0.9)
-  redcarpet
-  rspec (~> 3.11.0)
-  rubocop (~> 1.31)
-  rubocop-rspec (~> 2.12.1)
-  y-rb!
-  yard
-
-BUNDLED WITH
-   2.2.32

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2022 Hannes Moser <hmoser@gitlab.com>
-
-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

@@ -1,102 +0,0 @@
-# Yrb
-
-Yrb is a Ruby binding for Y-CRDT. It provides distributed data types that enable
-real-time collaboration between devices. Yrb can sync data with any other
-platform that has a Y-CRDT binding, allowing for seamless cross-domain
-communication.
-
-The library is a thin wrapper around Yrs, taking advantage of the safety and
-performance of Rust.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'y-rb'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install y-rb
-
-> **⚠ WARNING: Partial support for pre-built binaries.**  
-> `y-rb` comes with experimental pre-built binaries for a few platforms, but it
-> is not possible to support all targets right now. Please make sure there is an
-> archive that matches the OS, CPU architecture, and Ruby version. You can find
-> the assets listed with each [release](https://github.com/y-crdt/yrb/releases).
->
-> If the platform is not listed, you need to add the latest stable Rust + Cargo
-> to your build dependencies in order for `y-rb` to install properly.
-
-## Usage
-
-```ruby
-# creates a new document and text structure
-local = Y::Doc.new 
-local_text = local.get_text("my text")
-
-# add some data to the text structure
-local_text.push("hello")  
-  
-# create a remote document sharing the same text structure
-remote = Y::Doc.new 
-remote_text = remote.get_text("my text")  
-
-# retrieve the current state of the remote document
-remote_state = remote.state  
-
-# create an update for the remote document based on the current
-# state of the remote document
-update = local.diff(remote_state)  
-  
-# apply update to remote document
-remote.sync(update)  
-
-puts remote_text.to_s == local_text.to_s # true  
-```  
-
-More [examples](docs/examples.md).
-
-## Development
-
-Make sure you have `cargo` available (2021 edition). The gem needs the lib to
-be built every time when there is a change.
-
-```bash
-cargo build --release
-```
-
-After checking out the repo, run `bin/setup` to install dependencies. Then,
-run `rake spec` to run the tests. You can also run `bin/console` for an
-interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`.
-To release a new version, update the version number in `version.rb`, and then
-run `bundle exec rake release`, which will create a git tag for the version,
-push git commits and the created tag, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
-
-## Docs
-
-You can run `yard` locally and open the docs with:
-
-```bash
-yard server 
-open "http://0.0.0.0:8808/"
-```
-
-## Decision log
-
-For this `gem`, we maintain a [decision log](docs/decisions.md). Please consult it
-in case there is some ambiguity in terms of why certain implementation details
-look as they are. 
-
-## License
-
-The gem is available as open source under the terms of the
-[MIT License](https://opensource.org/licenses/MIT).