io_request 1.2.0 → 2.0.0

data/lib/io_request/message.rb

@@ -1,112 +1,94 @@
+# frozen_string_literal: true
+
 module IORequest
-  # Message to other side of IO.
+  # Single message. Either request or response.
   class Message
-    # @return [Integer] ID of message.
-    attr_reader :id
-    alias_method :to_i, :id
-
-    # @return [Hash] stored data.
-    attr_reader :data
+    include Utility::WithID
+    # Types of messages.
+    TYPES = %i[request response].freeze
 
-    # Initialize new message.
-    #
+    # Create new message.
     # @param data [Hash]
-    # @param id [Integer, nil] if +nil+ provided {Message.generate_id} will be
-    #   used to generate random id.
-    def initialize(data, id = nil)
-      @id = id || Message.generate_id
+    # @param type [Symbol] one of {TYPES} member.
+    # @param id [Utility::ExtendedID, String, nil] only should be filled if message is received from outside.
+    # @param to [Utility::ExtendedID, String, nil] if message is response, it should include integer
+    #   of original request.
+    def initialize(data, type: :request, id: nil, to: nil)
       @data = data
-    end
+      @type = type
+      @id = id.nil? ? extended_id : Utility::ExtendedID.from(id)
+      @to = to.nil? ? nil : Utility::ExtendedID.from(to)
 
-    # @return [String] human-readable form.
-    def to_s
-      "#{self.class.name}##{@id}: #{@data.inspect}"
+      check_data
     end
 
-    # @return [Integer] random numerical ID based on current time and random salt.
-    def self.generate_id
-      ((rand(999) + 1) * Time.now.to_f * 1000).to_i % 2**32
+    # Check data correctness.
+    def check_data
+      raise '@data is not a hash' unless @data.is_a? Hash
+      raise 'incorrect @type' unless TYPES.include? @type
+      raise 'incorrect @id' unless @id.is_a? Utility::ExtendedID
+      raise '@to not specified for response' if response? && @to.nil?
     end
-  end
-
-  # Request for server or client.
-  class Request < Message
-    # Amount of time to sleep before checking whether responded.
-    JOIN_SLEEP_TIME = 0.5
-
-    # @return [Integer, Response, nil] ID of response or response itself for this message.
-    attr_reader :response
 
-    # @!visibility private
-    attr_writer :response
+    # @return [Hash]
+    attr_reader :data
 
-    # Initialize new request.
-    #
-    # @param data [Hash]
-    # @param response [Integer, Response, nil]
-    # @param id [Integer, nil]
-    def initialize(data, response = nil, id = nil)
-      @response = response
-      super(data, id)
-    end
+    # @return [Symbol]
+    attr_reader :type
 
-    # @return [String] human readable form.
-    def to_s
-      "#{super.to_s}; #{@response ? "Response ID: #{@response.to_i}" : "Not responded"}"
-    end
+    # @return [Utility::ExtendedID]
+    attr_reader :id
 
-    # Freezes thread until request is responded or until timeout expends.
-    #
-    # @param timeout [Integer, Float, nil] timeout size or +nil+ if no timeout.
-    #
-    # @return [Integer] amount of time passed
-    def join(timeout = nil)
-      time_passed = 0
-      while @response.nil? && (timeout.nil? || time_passed < timeout)
-        time_passed += (sleep JOIN_SLEEP_TIME)
-      end
-      time_passed
-    end
+    # @return [Utility::ExtendedID]
+    attr_reader :to
 
-    # Save into hash.
-    def to_hash
-      { type: "request", data: @data, id: @id, response: @response.to_i }
+    # @return [Boolean]
+    def request?
+      @type == :request
     end
 
-    # Initialize new request from hash obtained with {Request#to_hash}.
-    def self.from_hash(hash)
-      Request.new(hash[:data], hash[:response], hash[:id])
+    # @return [Boolean]
+    def response?
+      @type == :response
     end
-  end
 
-  # Response to some request.
-  class Response < Message
-    # @return [Integer, Request] ID of initial request or request itself.
-    attr_reader :request
-
-    # Initialize new response.
-    #
-    # @param data [Hash]
-    # @param request [Integer, Request]
-    # @param id [Integer, nil]
-    def initialize(data, request, id = nil)
-      @request = request
-      super(data, id)
+    # @return [String]
+    def to_s
+      if request?
+        "Request##{@id}: #{data}"
+      else
+        "Response##{@id}: #{data} to ##{@to}"
+      end
     end
 
-    # @return [String] human readable form.
-    def to_s
-      "#{super.to_s}; Initial request ID: #{@request.to_i}"
+    # @return [String] binary data to be passed over IO.
+    def to_binary
+      json_string = JSON.generate({
+                                    id: @id.to_s,
+                                    type: @type.to_s,
+                                    to: @to.to_s,
+                                    data: @data
+                                  })
+      [json_string.size, json_string].pack("Sa#{json_string.size}")
     end
 
-    # Save into hash.
-    def to_hash
-      { type: "response", data: @data, id: @id, request: @request.to_i }
+    # @param io_w [:write]
+    def write_to(io_w)
+      io_w.write(to_binary)
     end
 
-    # Initialize new request from hash obtained with {Response#to_hash}.
-    def self.from_hash(hash)
-      Response.new(hash[:data], hash[:request], hash[:id])
+    # @param io_r [:read]
+    # @return [Message]
+    def self.read_from(io_r)
+      size = io_r.read(2).unpack1('S')
+      raise '0 size received' if size.zero?
+
+      json_string = io_r.read(size).unpack1("a#{size}")
+      msg = JSON.parse(json_string, symbolize_names: true)
+      Message.new(msg[:data],
+                  id: msg[:id],
+                  type: msg[:type].to_sym,
+                  to: msg[:to])
     end
   end
 end

data/lib/io_request/utility/multi_thread.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module IORequest
+  # Utility methods.
+  module Utility
+    # Adds some methods to spawn new threads and join them.
+    # @note This module creates instance variables with prefix +@__multi_thread__+.
+    module MultiThread
+      private
+
+      # @return [Array<Thread>] array of running threads.
+      def __multi_thread__threads
+        @__multi_thread__threads ||= []
+      end
+      alias running_threads __multi_thread__threads
+
+      # @return [Mutex] threads manipulations mutex.
+      def __multi_thread__mutex
+        @__multi_thread__mutex ||= Mutex.new
+      end
+
+      # Runs block with provided arguments forwarded as arguments in separate thread.
+      # All the inline args will be passed to block.
+      # @param thread_name [String] thread name.
+      # @return [Thread]
+      def in_thread(*args, name: nil)
+        # Synchronizing addition/deletion of new threads. That's important
+        __multi_thread__mutex.synchronize do
+          new_thread = Thread.new(*args) do |*in_args|
+            yield(*in_args)
+          ensure
+            __multi_thread__remove_current_thread
+          end
+          __multi_thread__threads << new_thread
+          new_thread.name = name if name
+          new_thread
+        end
+      end
+
+      # Removes current thread from thread list.
+      def __multi_thread__remove_current_thread
+        __multi_thread__mutex.synchronize do
+          __multi_thread__threads.delete(Thread.current)
+        end
+      end
+
+      # For each running thread.
+      def each_thread(&block)
+        __multi_thread__threads.each(&block)
+      end
+
+      # Kills each thread.
+      def kill_threads
+        each_thread(&:kill)
+        each_thread(&:join)
+      end
+
+      # Joins each thread.
+      def join_threads
+        each_thread(&:join)
+      end
+    end
+  end
+end

data/lib/io_request/utility/with_id.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module IORequest
+  # Utility methods.
+  module Utility
+    # Extended Id of object
+    class ExtendedID
+      include Comparable
+
+      # Create new Id based on PID, thread ID and object ID.
+      def initialize(pid = nil, tid = nil, oid = nil)
+        @pid = pid || Process.pid
+        @tid = tid || Thread.current.object_id
+        @oid = oid || object_id
+      end
+
+      # @return [Integer] process ID.
+      attr_reader :pid
+
+      # @return [Integer] thread ID.
+      attr_reader :tid
+
+      # @return [Integer] object ID.
+      attr_reader :oid
+
+      # @return [String]
+      def to_s
+        "#{@pid}##{@tid}##{@oid}"
+      end
+
+      # Comparison operator.
+      def <=>(other)
+        if @pid == other.pid && @tid == other.tid
+          @oid <=> other.oid
+        elsif @pid == other.pid && @tid != other.tid
+          @tid <=> tid
+        else
+          @pid <=> other.pid
+        end
+      end
+
+      def self.from(obj)
+        case obj
+        when ExtendedID then new(obj.pid, obj.tid, obj.oid)
+        when String then new(*obj.split('#').map(&:to_i))
+        else
+          raise 'unknown type'
+        end
+      end
+    end
+    # Adds special method to return object ID.
+    module WithID
+      # Identifies object in thread and process.
+      def __with_id__extended_id
+        @__with_id__extended_id ||= ExtendedID.new
+      end
+      alias extended_id __with_id__extended_id
+    end
+  end
+end

data/lib/io_request/utility/with_prog_name.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module IORequest
+  # Utility methods.
+  module Utility
+    # Adds special method to identify object in log files.
+    module WithProgName
+      # Identifies object and thread it runs in.
+      def prog_name
+        "#{self.class.name}##{object_id} in Thread##{Thread.current.object_id}"
+      end
+    end
+  end
+end

data/lib/io_request/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module IORequest
   # Gem version.
-  VERSION = "1.2.0"
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: io_request
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Fizvlad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-04 00:00:00.000000000 Z
+date: 2020-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,75 +25,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: logger
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: timeout-extensions
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: timeout-extensions
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.1.1
 description: 
 email:
 - fizvlad@mail.ru
@@ -102,9 +102,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -112,10 +113,12 @@ files:
 - examples/simple_example.rb
 - io_request.gemspec
 - lib/io_request.rb
+- lib/io_request/authorizer.rb
 - lib/io_request/client.rb
-- lib/io_request/logging.rb
 - lib/io_request/message.rb
-- lib/io_request/utility.rb
+- lib/io_request/utility/multi_thread.rb
+- lib/io_request/utility/with_id.rb
+- lib/io_request/utility/with_prog_name.rb
 - lib/io_request/version.rb
 homepage: https://github.com/fizvlad/io-request-rb
 licenses:
@@ -132,14 +135,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.1
+      version: 2.6.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.0.pre2
 signing_key: 
 specification_version: 4
 summary: Small gem to create JSON request/response type of connection over IO object