nmspec 1.5.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 957a2a00e6c56c138e22265df428d64ac042572316b76b55468ecd38835dd6e4
-  data.tar.gz: 5ffe4d18075f75fcfb825a9c4b041f6d5f62a8ce9aa52d19b1fb46dc2f7051f5
+  metadata.gz: 3e70533f6e749c2e1002934b261b6d642d70d05c713ba4ae277e19fdc9ec5ca8
+  data.tar.gz: 1ab962483d6d486185ded45fdf9b74d5759741ba7f6baa6d03a857df399afcc6
 SHA512:
-  metadata.gz: 7a5d380015227e41dceaee8d125da1561e1e3d15736e24219eeabb1ff2506a0e8084ca143050253a25b2a422fd9df59af97a538315a9674caed795f19a9bf561
-  data.tar.gz: 0d7596ea1a35cfaed2feac076c77f0a10fba53c70254f2b2b756c827a4b9aed21ff130384421f27aa78a686286aa8b793043e10182c620d7120fef3f3750c763
+  metadata.gz: 7011dd7477bc0a65e472a93b8f305e5e9c4e240574543765a36dc30b2bc4244536a762bcd915bca646bca821dfa95c481d866eba9e24656c8d2349a33ed00a53
+  data.tar.gz: e173d860689aaa6845e3e7313305cb2667464122506dcfe7069fe5f064a2889fbe8e7638116c34548e3e56c077821b20aa0ce63c8b61747836b57c2d00131e86

data/README.md

@@ -12,6 +12,12 @@ described in `nmspec` are used to create both the reading and writing sides
 of the connection, so that a single source code file contains everything you
 need for a network peer, regardless of if it's the client or server.
 
+## Demo video explaining how to use this gem
+
+<a href="https://youtu.be/Ib6c6BEl82c">
+  <img src="https://s3.us-east-2.amazonaws.com/vim4evar.com/nmspec-imgs/link-to-demo-video.png" />
+</a>
+
 ## Motivation
 
 `nmspec` was specifically created to help with with a problem I was facing,
@@ -48,8 +54,8 @@ As a starting point this gem supports network messengers in these two languages:
 * [Ruby 3.0.x][ruby-lang]
 * [GDScript 3.4.stable][gdscript]
 
-`nmspec` came out of a online game project where the backend was written in
-Ruby, and the frontend build with the Godot game engine, which includes the
+`nmspec` came out of a online game project where the backend is written in
+Ruby, and the frontend is built with the Godot game engine, which includes the
 embedded scripting language, GDSCript.
 
 # Sample usage
@@ -283,7 +289,7 @@ description languages/tools in the past, beginning with [Prolac][prolac]. This
 lead me to other network messaging tools, binary serialization in general,
 finally [Google's protocol buffers][protobuffs]. Protocol buffers were probably
 the closest thing to what I wanted, and took care of binary
-serialization/deserialization, but weren't packaaged with the networking layer,
+serialization/deserialization, but weren't packaged with the networking layer,
 which introduces additional considerations such as byte ordering, efficient
 packet construction, TCP stack options, and communication retries and graceful
 failover. While protocol buffers are a good design, and I think do a good job of

data/lib/nmspec/gdscript.rb

@@ -14,7 +14,7 @@ module Nmspec
 
         if spec.dig(:msgr, :desc)
           code << '#'
-          code << "# #{spec.dig(:msgr, :desc)}"
+          spec.dig(:msgr, :desc).lines.each{|l| code << "# #{l.strip}" }
         end
 
         code << 'extends Reference'
@@ -91,7 +91,6 @@ module Nmspec
         code << '# WARN: this means sockets that use little-endian will tend to lock up'
         code << 'func _init(_socket):'
         code << "\tsocket = _socket"
-        code << "\tsocket.set_no_delay(#{nodelay})"
         code << "\tsocket.set_big_endian(#{big_endian})"
 
         code
@@ -324,7 +323,7 @@ module Nmspec
       def _proto_method(kind, proto_code, proto, local_vars, passed_params, subtypes)
         code = []
 
-        code << "# #{proto[:desc]}" if proto[:desc]
+        proto[:desc].lines.each{|l| code << "# #{l.strip}" } if proto[:desc]
         unless local_vars.empty?
           code << '#'
           code << '# returns:  (type | local var name)'

data/lib/nmspec/ruby.rb

@@ -14,8 +14,8 @@ module Nmspec
         code << '# NOTE: this code is auto-generated from an nmspec file'
 
         if spec.dig(:msgr, :desc)
-          code << '#'
-          code << "# #{spec.dig(:msgr, :desc)}"
+          code << '##'
+          spec.dig(:msgr, :desc).lines.each{|l| code << "# #{l.strip}" }
         end
 
         code << "class #{_class_name_from_msgr_name(spec.dig(:msgr, :name))}"
@@ -27,6 +27,8 @@ module Nmspec
 
         code << _initialize
         code << ''
+        code << _open?
+        code << ''
         code << _close
         code << ''
         code << _bool_type
@@ -77,18 +79,32 @@ module Nmspec
 
         code << '  def initialize(socket, no_delay=false)'
         code << '    @socket = socket'
+        code << '    @open = true'
         code << '    @socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1) if no_delay'
         code << '  end'
 
         code
       end
 
+      def _open?
+        code = []
+
+        code << '  ##'
+        code << '  # closes the socket inside this object'
+        code << '  def open?'
+        code << '    !!(@socket && @open)'
+        code << '  end'
+
+        code
+      end
+
       def _close
         code = []
 
         code << '  ##'
         code << '  # closes the socket inside this object'
         code << '  def close'
+        code << '    @open = false'
         code << '    @socket&.close'
         code << '  end'
 
@@ -356,7 +372,8 @@ module Nmspec
       def _proto_method(kind, proto_code, proto, local_vars, passed_params)
         code = []
 
-        code << "  # #{proto[:desc]}" if proto[:desc]
+        proto[:desc].lines.each{|l| code << "  # #{l.strip}" } if proto[:desc]
+
         unless local_vars.empty?
           code << '  #'
           code << '  # returns:  (type | local var name)'

data/lib/nmspec/version.rb

@@ -1 +1 @@
-NMSPEC_GEM_VERSION = '1.5.0'
+NMSPEC_GEM_VERSION = '1.6.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nmspec
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Jeff Lunt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2022-06-12 00:00:00.000000000 Z
 dependencies: []
 description: nmspec makes it easier to describe binary messages between two network
   peers via a config file, generate their network code in a number of languages, and