mplight 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c3b91fcd4e88bbb134216d55ff1945c6dc7aefcb72ef798eceb39b1498838f7
+  data.tar.gz: 74666ea4879a2f9e56ad77d9c4b53972da6d5f6a45bdb7cb2837b5eeeeaaf529
+SHA512:
+  metadata.gz: d54904ba3e5bf7ab1cf1f17457b78f54d89791c376158dc305b5477fa4ca77fb1ad43f7f8c312da3ecb5dd2fd54265365d18e50e85f10468e63e3ac555f71d8b
+  data.tar.gz: 4b8a193ee07474925f0be252b4b743945dd60344b0cac9d187b2b7f7aa1bbceba0f9cf74833c9226a078cc271f807726d2ecb1b9f25073706142c66c6341610a

data/LICENSE

@@ -0,0 +1,52 @@
+# BSD-2-clause license, extended by language use conditions
+
+Copyright (C) 2024, Bertram Scharpf <software@bertram-scharpf.de>.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+  * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+
+  * Redistributions must not contain any clauses about anticipated
+    harassment or discrimination, nor must they be held in a so-called
+    "inclusive language". As far as German language is used, the
+    conditions mentioned below additionally apply.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+## Use of the German Language
+
+Beim Gebrauch deutscher Sprache sind Weiterentwicklungen und
+-verbreitungen nur gestattet unter Einhaltung folgender
+zusätzlicher Bedingungen:
+
+  * Keine Verwendung von sogenannter „geschlechtergerechter Sprache“,
+    also Anfügen von weiblichen Endungen mit Binnen-I, Sternchen,
+    Doppelpunkt, Unterstrich oder ähnlichem, oder Konstruktionen, die
+    den Sachverhalt falsch wiedergeben („Radfahrende“, „Studierende“).
+
+  * Keine Verwendung der „reformierten Rechtschreibung“ von 1996,
+    insbesondere Doppel-S am Silbenende, „plazieren“ mit T, sowie
+    Großschreibung von Wendungen wie „des weiteren“.
+
+
+<!-- vim:set ft=markdown : -->

data/README.md

@@ -0,0 +1,64 @@
+# MPLight
+
+  - Ruby library
+  - Yet another implementation of the [MessagePack](http://msgpack.org)
+    protocol/format
+  - Designed to be as small as possible. Clean code, no dependecies, no
+    frills, no wokeness.
+
+RubyGems install:
+
+```
+gem install mplight
+```
+
+If you like to reduce dependencies, you might prefer to copy the ~300
+lines of Ruby code into your project. See
+[Ruby-Nvim](https://github.com/BertramScharpf/ruby-nvim) for an example.
+
+
+## Usage
+
+```ruby
+require "mplight"
+IO.pipe do |r,w|
+  t = MPLight::Types.new
+
+  t.extend MPLight::Packer
+  t.init_output w
+  t.put %w(foo bar baz)
+
+  t.extend MPLight::Unpacker
+  t.init_input r
+  puts t.get.inspect
+end
+```
+
+Usage with [Neovim](https://neovim.io/):
+
+```ruby
+require "mplight"
+require "yaml"
+IO.popen %w(nvim --api-info) do |r|
+  t = MPLight::Types.new
+  t.extend MPLight::Unpacker
+  t.init_input r
+  puts t.get.to_yaml
+end
+```
+
+See the [`testit`](testit) file for further examples.
+
+
+## Sister Project
+
+This library was written together with the
+[Ruby-Nvim](https://github.com/BertramScharpf/ruby-nvim).
+
+
+
+## Copyright
+
+  * (C) 2024 Bertram Scharpf <software@bertram-scharpf.de>
+  * License: [BSD-2-Clause+](LICENSE)
+

data/lib/mplight/bufferio.rb

@@ -0,0 +1,36 @@
+#
+#  mplight/bufferio.rb  --  Buffer behaving like an IO
+#
+
+
+module MPLight
+
+  class BufferIO
+
+    attr_reader :data
+
+    def initialize str = nil
+      @data = str||""
+    end
+
+    def binmode
+      @data.force_encoding Encoding::ASCII_8BIT
+    end
+    def sync= _ ; end
+    def sync    ; true ; end
+
+    def write d
+      @data << d
+    end
+
+    def read n
+      @data.slice! 0, n
+    end
+
+    def flush
+    end
+
+  end
+
+end
+

data/lib/mplight.rb

@@ -0,0 +1,312 @@
+#
+#  mplight.rb  --  Lightweight MessagePack implementation
+#
+
+
+module MPLight
+
+  VERSION = "1.0".freeze
+
+  class Error ; end
+
+
+  class Types
+
+    def initialize *args, **kwargs
+      @cls = {}
+      @ids = {}
+      register -1, Time
+    end
+
+    def register id, klass
+      @cls[ id], @ids[ klass] = klass, id
+    end
+
+    def dump obj
+      t = @ids[ obj.class]
+      unless t then
+        return if @default_to_string
+        raise Error, "Unregistered class: #{obj.class}"
+      end
+      [ t, obj.to_mpdata]
+    end
+
+    def default_to_string! ; @default_to_string = true ; end
+
+    def create id, data
+      c = @cls[ id]
+      c or raise Error, "Unregistered type id: #{obj.class}"
+      c.from_mpdata data, *additional_data
+    end
+
+    def additional_data
+      []
+    end
+
+  end
+
+
+  module Packer
+
+    attr_reader :output
+
+    def init_output output
+      @output = output
+      @output.binmode
+      @output.sync = true
+      self
+    end
+
+    def do_output output
+      oi = @output
+      init_output output
+      yield
+    ensure
+      @output = oi
+    end
+
+    def put obj
+      case obj
+      when nil   then write_fmt 0xc0
+      when false then write_fmt 0xc2
+      when true  then write_fmt 0xc3
+      when Integer then
+        if obj >= 0 then
+          case obj
+          when                ...0x80 then write_fmt obj
+          when               ...0x100 then write_fmt 0xcc ; write_pack obj, "C"
+          when             ...0x10000 then write_fmt 0xcd ; write_pack obj, "S>"
+          when         ...0x100000000 then write_fmt 0xce ; write_pack obj, "L>"
+          when ...0x10000000000000000 then write_fmt 0xcf ; write_pack obj, "Q>"
+          else                                 raise ArgumentError, "Integer too large: #{obj}"
+          end
+        else
+          case obj
+          when               -0x20... then write_fmt obj+256
+          when               -0x80... then write_fmt 0xd0 ; write_pack obj, "c"
+          when             -0x8000... then write_fmt 0xd1 ; write_pack obj, "s>"
+          when         -0x80000000... then write_fmt 0xd2 ; write_pack obj, "l>"
+          when -0x8000000000000000... then write_fmt 0xd3 ; write_pack obj, "q>"
+          else                             raise ArgumentError, "Integer too large: #{obj}"
+          end
+        end
+      when Float then
+        case
+        when false then write_fmt 0xca ; write_pack obj, "g"
+        else            write_fmt 0xcb ; write_pack obj, "G"
+        end
+      when String then
+        if obj.encoding == Encoding::ASCII_8BIT then
+          l = obj.size
+          case l
+          when       ...0x100 then write_fmt 0xc4 ; write_pack l, "C"
+          when     ...0x10000 then write_fmt 0xc5 ; write_pack l, "S>"
+          when ...0x100000000 then write_fmt 0xc6 ; write_pack l, "L>"
+          else                     raise ArgumentError, "Byte array too long: #{l} bytes"
+          end
+        else
+          obj = obj.encode Encoding::UTF_8 unless obj.encoding == Encoding::UTF_8
+          l = obj.bytesize
+          case l
+          when        ...0x20 then write_fmt 0xa0+l
+          when       ...0x100 then write_fmt 0xd9 ; write_pack l, "C"
+          when     ...0x10000 then write_fmt 0xda ; write_pack l, "S>"
+          when ...0x100000000 then write_fmt 0xdb ; write_pack l, "L>"
+          else                     raise ArgumentError, "String too long: #{l} bytes"
+          end
+        end
+        write_pack obj, "A*"
+      when Array then
+        l = obj.length
+        case l
+        when        ...0x10 then write_fmt 0x90+l
+        when     ...0x10000 then write_fmt 0xdc ; write_pack l, "S>"
+        when ...0x100000000 then write_fmt 0xdd ; write_pack l, "L>"
+        else                     raise ArgumentError, "Array too long: #{l} elements"
+        end
+        obj.each { |o| put o }
+      when Hash then
+        l = obj.length
+        case l
+        when        ...0x10 then write_fmt 0x80+l
+        when     ...0x10000 then write_fmt 0xde ; write_pack l, "S>"
+        when ...0x100000000 then write_fmt 0xdf ; write_pack l, "L>"
+        else                     raise ArgumentError, "Hash too long: #{l} keys"
+        end
+        obj.each { |k,v| put k ; put v }
+      when Symbol then
+        put obj.to_s
+      else
+        type, data = dump obj
+        type or return put obj.to_s
+        l = data.bytesize
+        case l
+        when           0x01 then write_fmt 0xd4 ;                      write_pack type, "c"
+        when           0x02 then write_fmt 0xd5 ;                      write_pack type, "c"
+        when           0x04 then write_fmt 0xd6 ;                      write_pack type, "c"
+        when           0x08 then write_fmt 0xd7 ;                      write_pack type, "c"
+        when           0x10 then write_fmt 0xd8 ;                      write_pack type, "c"
+        when       ...0x100 then write_fmt 0xc7 ; write_pack l, "C"  ; write_pack type, "c"
+        when     ...0x10000 then write_fmt 0xc8 ; write_pack l, "S>" ; write_pack type, "c"
+        when ...0x100000000 then write_fmt 0xc9 ; write_pack l, "L>" ; write_pack type, "c"
+        else                     raise ArgumentError, "Object too large: #{l} bytes"
+        end
+        write_pack data, "A*"
+      end
+      self
+    end
+
+    private
+
+    def write_pack i, t
+      d = [i].pack t
+      @output.write d
+    end
+
+    def write_fmt i
+      write_pack i, "C"
+    end
+
+  end
+
+
+  module Unpacker
+
+    attr_reader :input
+
+    def init_input input
+      @input = input
+      @input.binmode
+      self
+    end
+
+    def do_input input
+      oi = @input
+      init_input input
+      yield
+    ensure
+      @input = oi
+    end
+
+    def eof?
+      @input.eof?
+    end
+
+    def get
+      fmt = (read 1).unpack1 "C"
+      case fmt >> 7
+      when 0b0 then fmt
+      else
+        case fmt >> 5
+        when 0b111 then fmt - 256
+        when 0b101 then get_str fmt&0b11111
+        else
+          case fmt >> 4
+          when 0b1000 then get_hsh fmt&0b1111
+          when 0b1001 then get_ary fmt&0b1111
+          else
+            case fmt
+            when 0xc0 then nil
+            when 0xc1 then raise ArgumentError, "Illegal format: #{fmt}"
+            when 0xc2 then false
+            when 0xc3 then true
+            when 0xc4 then read    get_len1
+            when 0xc5 then read    get_len2
+            when 0xc6 then read    get_len4
+            when 0xc7 then get_ext get_len1
+            when 0xc8 then get_ext get_len2
+            when 0xc9 then get_ext get_len4
+            when 0xca then (read 4).unpack1 "g"
+            when 0xcb then (read 8).unpack1 "G"
+            when 0xcc then (read 1).unpack1 "C"
+            when 0xcd then (read 2).unpack1 "S>"
+            when 0xce then (read 4).unpack1 "L>"
+            when 0xcf then (read 8).unpack1 "Q>"
+            when 0xd0 then (read 1).unpack1 "c"
+            when 0xd1 then (read 2).unpack1 "s>"
+            when 0xd2 then (read 4).unpack1 "l>"
+            when 0xd3 then (read 8).unpack1 "q>"
+            when 0xd4 then get_ext  1
+            when 0xd5 then get_ext  2
+            when 0xd6 then get_ext  4
+            when 0xd7 then get_ext  8
+            when 0xd8 then get_ext 16
+            when 0xd9 then get_str get_len1
+            when 0xda then get_str get_len2
+            when 0xdb then get_str get_len4
+            when 0xdc then get_ary get_len2
+            when 0xdd then get_ary get_len4
+            when 0xde then get_hsh get_len2
+            when 0xdf then get_hsh get_len4
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def read n
+      @input.read n
+    end
+
+    def get_len1 ; (read 1).unpack1 "C"  ; end
+    def get_len2 ; (read 2).unpack1 "S>" ; end
+    def get_len4 ; (read 4).unpack1 "L>" ; end
+
+    def get_str len
+      (read len).force_encoding Encoding::UTF_8
+    end
+
+    def get_ary len
+      (0...len).map { get }
+    end
+
+    def get_hsh len
+      (0...len).inject Hash.new do |h,| k = get ; h[k] = get ; h end
+    end
+
+    def get_ext len
+      type = (read 1).unpack1 "c"
+      create type, (read len)
+    end
+
+  end
+
+end
+
+
+class Time
+
+  class <<self
+
+    def from_mpdata data, *args
+      case data.length
+      when  4 then
+        s, = data.unpack "L>"
+        Time.at s
+      when  8 then
+        t, = data.unpack "Q>"
+        n = t >> 34
+        t &= 0x3ffffffff
+        Time.at t, n, :nanosecond
+      when 12 then
+        n, s = data.unpack "L>Q>"
+        Time.at s, n, :nanosecond
+      else
+        raise ArgumentError, "Illegal time data: #{data.inspect}"
+      end
+    end
+
+  end
+
+  def to_mpdata
+    case
+    when tv_nsec.zero? && tv_sec < 0x100000000 then [ tv_sec].pack "L>"
+    when                  tv_sec < 0x400000000 then [ (tv_nsec << 34)|tv_sec].pack "Q>"
+    else                                            [ tv_nsec, tv_sec].pack "L>Q>"
+    end
+  end
+
+end
+

data/testit

@@ -0,0 +1,123 @@
+#!/usr/bin/env ruby
+
+#
+#  testit  --  Test MPLight
+#
+
+$:.unshift "./lib"
+require "mplight"
+require "mplight/bufferio"
+
+
+class Some
+  attr_reader :i
+  def initialize i
+    @i = i
+  end
+  def == oth ; @i == oth.i ; end
+
+  class <<self
+    def from_mpdata data
+      new *(data.unpack1 "C")
+    end
+  end
+  def to_mpdata
+    [ @i].pack "C"
+  end
+end
+
+class Other
+  def == oth ; true ; end
+
+  class <<self
+    def from_mpdata data
+      data == "x"*50 or raise "Identification failed."
+      new
+    end
+  end
+  def to_mpdata
+    "x"*50
+  end
+end
+
+
+class Types < MPLight::Types
+  include MPLight::Packer
+  include MPLight::Unpacker
+  def initialize
+    super
+    register 1, Some
+    register 2, Other
+  end
+  def init_inout f
+    init_input  f
+    init_output f
+  end
+end
+
+
+OBJS = [
+  Math::PI, Float::INFINITY,
+  "tränenüberströmt", "€ 100,-", "Holleri du dödl di, diri diri dudl dö.",
+  ("äöü".force_encoding "ascii-8bit"),
+  true, false,
+  %w(ant bat cat dog eel fox gnu hen ide jay kea),
+  ["x"], ["x"]*100,
+  { "voc" => "Roger", "gt" => "Pete", "bs" => "John", "dr" => "Keith", },
+  0, 1, 0x1f, 0x20, 0x7f, 0x80, -31, -32, -33, 0xffff, 0x1000, 0x1001,
+  0xffffffff, 0x100000000, 0x100000001,
+  (Some.new 127), Other.new,
+]
+
+
+
+t = Types.new
+
+if $*.delete "-s" then
+  require "socket"
+  class UNIXServer
+    alias accept_orig accept
+    def accept ; a = accept_orig ; yield a ; ensure ; a.close ; end
+  end
+  UNIXServer.open "mplighttest" do |s|
+    s.accept { |a|
+      t.init_inout a
+      OBJS.each do |o|
+        t.put o
+        u = t.get
+        u == o or raise "Didn't work."
+      end
+    }
+  end
+
+elsif $*.delete "-c" then
+  require "socket"
+  begin
+    UNIXSocket.open "mplighttest" do |c|
+      t.init_inout c
+      OBJS.each do |o|
+        u = t.get
+        puts u.inspect
+        t.put o
+      end
+    end
+  ensure
+    File.unlink "mplighttest"
+  end
+
+else
+  t.init_inout MPLight::BufferIO.new
+  OBJS.each do |o|
+    t.put o
+    u = t.get
+    u == o or raise "Didn't work."
+  rescue
+    puts o.inspect
+    puts u.inspect
+    raise
+  end
+
+end
+
+puts "Everthing is fine!"
+

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: mplight
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Bertram Scharpf
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-13 00:00:00.000000000 Z
+dependencies: []
+description: |
+  This a a very small (<300 loc) library for
+  writing and reading MessagePack data.
+email: software@bertram-scharpf.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+files:
+- LICENSE
+- README.md
+- lib/mplight.rb
+- lib/mplight/bufferio.rb
+- testit
+homepage: http://github.com/BertramScharpf/mplight
+licenses:
+- LicenseRef-LICENSE
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Just Ruby
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: Lightweight MessagePack tool
+test_files: []