binary-protocol 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7acca312b640e28dfc66b2bad980b78ee035d76c
+  data.tar.gz: c339bdb3911d544e5e47aeea983fed415ed52be7
+SHA512:
+  metadata.gz: 1e4fe348d8f69a6d83d7c64e45adf8b7eec9e51f3c29b599a83d1f4dae537c7cddc07feaf68461d7ae60567c2af537a6afd90aaf562be0cd63ab7d70378a13ac
+  data.tar.gz: da21c64e0281573263101ee3a77ab253987228cdcbeeab09bf2b89e1bb46afe1c59d2bfb0c215e23df82ab099ee0f803de2114de995df6c8933d50702dc50094

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rvmrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in binary-protocol.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Bennett
+
+MIT License
+
+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

@@ -0,0 +1,29 @@
+# Binary::Protocol
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'binary-protocol'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install binary-protocol
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/binary-protocol.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'binary/protocol/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "binary-protocol"
+  spec.version       = Binary::Protocol::VERSION
+  spec.authors       = ["Andrew Bennett"]
+  spec.email         = ["andrew@pagodabox.com"]
+  spec.description   = %q{Helpful DSL for reading and writing binary protocols}
+  spec.summary       = %q{Helpful DSL for reading and writing binary protocols}
+  spec.homepage      = "https://github.com/potatosalad/binary-protocol"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+end

data/lib/binary/protocol.rb

@@ -0,0 +1,397 @@
+require "binary/protocol/version"
+require "binary/protocol/extensions"
+
+module Binary
+  module Protocol
+
+    BYTES_8  = 1.freeze
+    BYTES_16 = 2.freeze
+    BYTES_32 = 4.freeze
+    BYTES_64 = 8.freeze
+
+    INT8_PACK       = 'c'.freeze  # 8-bit signed (signed char)
+    INT16_PACK      = 's'.freeze  # 16-bit signed, native endian (int16_t)
+    INT32_PACK      = 'l'.freeze  # 32-bit signed, native endian (int32_t)
+    INT64_PACK      = 'q'.freeze  # 64-bit signed, native endian (int64_t)
+    INT16BE_PACK    = 's>'.freeze # 16-bit signed, big-endian
+    INT32BE_PACK    = 'l>'.freeze # 32-bit signed, big-endian
+    INT64BE_PACK    = 'q>'.freeze # 64-bit signed, big-endian
+    INT16LE_PACK    = 's<'.freeze # 16-bit signed, little-endian
+    INT32LE_PACK    = 'l<'.freeze # 32-bit signed, little-endian
+    INT64LE_PACK    = 'q<'.freeze # 64-bit signed, little-endian
+
+    UINT8_PACK      = 'C'.freeze  # 8-bit unsigned (unsigned char)
+    UINT16_PACK     = 'S'.freeze  # 16-bit unsigned, native endian (uint16_t)
+    UINT32_PACK     = 'L'.freeze  # 32-bit unsigned, native endian (uint32_t)
+    UINT64_PACK     = 'Q'.freeze  # 64-bit unsigned, native endian (uint64_t)
+    UINT16BE_PACK   = 'n'.freeze  # 16-bit unsigned, network (big-endian) byte order
+    UINT32BE_PACK   = 'N'.freeze  # 32-bit unsigned, network (big-endian) byte order
+    UINT64BE_PACK   = 'Q>'.freeze # 64-bit unsigned, network (big-endian) byte order
+    UINT16LE_PACK   = 'v'.freeze  # 16-bit unsigned, VAX (little-endian) byte order
+    UINT32LE_PACK   = 'V'.freeze  # 32-bit unsigned, VAX (little-endian) byte order
+    UINT64LE_PACK   = 'Q<'.freeze # 64-bit unsigned, VAX (little-endian) byte order
+
+    SINGLE_PACK     = 'F'.freeze  # 32-bit single-precision, native format
+    DOUBLE_PACK     = 'D'.freeze  # 64-bit double-precision, native format
+    SINGLEBE_PACK   = 'g'.freeze  # 32-bit sinlge-precision, network (big-endian) byte order
+    DOUBLEBE_PACK   = 'G'.freeze  # 64-bit double-precision, network (big-endian) byte order
+    SINGLELE_PACK   = 'e'.freeze  # 32-bit sinlge-precision, little-endian byte order
+    DOUBLELE_PACK   = 'E'.freeze  # 64-bit double-precision, little-endian byte order
+
+    class << self
+
+      # Extends the including class with +ClassMethods+.
+      #
+      # @param [Class] subclass the inheriting class
+      def included(base)
+        super
+
+        base.extend ClassMethods
+      end
+
+      private :included
+    end
+
+    # Provides a DSL for defining struct-like fields for building
+    # binary messages.
+    #
+    # @example
+    #   class Command
+    #     include Binary::Protocol
+    #
+    #     int32 :length
+    #   end
+    #
+    #   Command.fields # => [:length]
+    #   command = Command.new
+    #   command.length = 12
+    #   command.serialize_length("") # => "\f\x00\x00\x00"
+    module ClassMethods
+
+      # @return [Array] the methods to run in order for serialiation
+      def serialization
+        @serialization ||= []
+      end
+
+      # @return [Array] the fields defined for this message
+      def fields
+        @fields ||= []
+      end
+
+      %w[
+        int8
+        int16
+        int32
+        int64
+        int16be
+        int32be
+        int64be
+        int16le
+        int32le
+        int64le
+        uint8
+        uint16
+        uint32
+        uint64
+        uint16be
+        uint32be
+        uint64be
+        uint16le
+        uint32le
+        uint64le
+      ].each do |name|
+        pack_const = "#{name.upcase}_PACK".intern
+        size_const = "BYTES_#{name.match(/(\d+)/)[0]}".intern
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name}(name, options = {}, &block)
+            __bytes__(#{pack_const.inspect}, #{size_const.inspect}, name, options, &block)
+          end
+        RUBY
+      end
+
+      %w[
+        single
+        singlebe
+        singlele
+        double
+        doublebe
+        doublele
+      ].each do |name|
+        pack_const = "#{name.upcase}_PACK".intern
+        size_const = !!(name =~ /single/) ? "BYTES_32".intern : "BYTES_64".intern
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name}(name, options = {}, &block)
+            __bytes__(#{pack_const.inspect}, #{size_const.inspect}, name, options, &block)
+          end
+        RUBY
+      end
+
+      # Declare a string field.
+      #
+      # @example
+      #   class Message
+      #     include Binary::Protocol
+      #     string :collection
+      #   end
+      #
+      # @param [String] name the name of this field
+      def string(name, options = {})
+        if options.key?(:always)
+          __define_always__(name, options[:always])
+        else
+          if options.key?(:default)
+            __define_default__(name, options[:default])
+          else
+            attr_accessor name
+          end
+
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def deserialize_#{name}(buffer)
+              raise NotImplementedError
+            end
+          RUBY
+        end
+
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def serialize_#{name}(buffer)
+            buffer << #{name}
+          end
+        RUBY
+
+        serialization << :"serialize_#{name}"
+        fields << name
+      end
+
+      # Declare a null terminated string field.
+      #
+      # @example
+      #   class Message
+      #     include Binary::Protocol
+      #     stringz :collection
+      #   end
+      #
+      # @param [String] name the name of this field
+      def stringz(name, options = {})
+        if options.key?(:always)
+          __define_always__(name, options[:always])
+        else
+          if options.key?(:default)
+            __define_default__(name, options[:default])
+          else
+            attr_accessor name
+          end
+
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def deserialize_#{name}(buffer)
+              raise NotImplementedError
+            end
+          RUBY
+        end
+
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def serialize_#{name}(buffer)
+            buffer << #{name}
+            buffer << 0
+          end
+        RUBY
+
+        serialization << :"serialize_#{name}"
+        fields << name
+      end
+
+      # Declares the protocol class as complete, and defines its serialization
+      # method from the declared fields.
+      def finalize
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def serialize(buffer = "")
+            #{serialization.map { |command| "#{command}(buffer)" }.join("\n")}
+            buffer
+          end
+          alias to_s serialize
+        RUBY
+      end
+
+      def deserialize(buffer = nil, &block)
+        if block_given?
+          re_define_method(:deserialize, &block)
+        else
+          message = allocate
+          message.deserialize(buffer)
+          message
+        end
+      end
+
+      protected
+
+      def __bytes__(pack_const, size_const, name, options = {}, &block)
+        if block_given?
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def before_serialize_#{name}(buffer)
+              @#{name}_start = buffer.bytesize
+            end
+          RUBY
+
+          serialization << :"before_serialize_#{name}"
+        end
+
+        if options.key?(:always)
+          __define_always__(name, options[:always])
+        else
+          if options.key?(:default)
+            __define_default__(name, options[:default])
+          else
+            attr_accessor name
+          end
+
+          if options[:type] == :array
+            class_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def deserialize_#{name}(buffer)
+                raise NotImplementedError
+              end
+            RUBY
+          else
+            class_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def deserialize_#{name}(buffer)
+                self.#{name}, = buffer.read(#{size_const}).unpack(#{pack_const})
+              end
+            RUBY
+          end
+        end
+
+        if options[:type] == :array
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def serialize_#{name}(buffer)
+              buffer << #{name}.pack(#{pack_const}+"*")
+            end
+          RUBY
+        else
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def serialize_#{name}(buffer)
+              buffer << [#{name}].pack(#{pack_const})
+            end
+          RUBY
+        end
+
+        serialization << :"serialize_#{name}"
+
+        if block_given?
+          returning = fields << name
+          instance_eval(&block)
+
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def after_serialize_#{name}(buffer)
+              self.#{name} = buffer.bytesize - @#{name}_start - #{options[:inclusive] ? 0 : size_const}
+              buffer[@#{name}_start, #{size_const}] = serialize_#{name} ""
+            end
+          RUBY
+
+          serialization << :"after_serialize_#{name}"
+
+          returning
+        else
+          fields << name
+        end
+      end
+
+      def __define_always__(name, always)
+        if always.respond_to?(:call)
+          re_define_method(name, &always)
+        else
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{name}
+              @#{name} ||= #{always.inspect}
+            end
+          RUBY
+        end
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def deserialize_#{name}(buffer)
+            # do nothing
+          end
+        RUBY
+      end
+
+      def __define_default__(name, default)
+        attr_writer name
+
+        if default.respond_to?(:call)
+          dval = :"__#{name}_default_value__"
+          ivar = :"@#{name}"
+          re_define_method(dval, &default)
+          re_define_method(name) do
+            if instance_variable_defined?(ivar)
+              instance_variable_get(ivar)
+            else
+              instance_variable_set(ivar, __send__(dval))
+            end
+          end
+        else
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{name}
+              @#{name} ||= #{default.inspect}
+            end
+          RUBY
+        end
+      end
+
+      private
+
+      # This ensures that subclasses of the primary protocol classes have
+      # identical fields.
+      def inherited(subclass)
+        super
+
+        subclass.serialization.replace serialization
+        subclass.fields.replace fields
+      end
+
+    end
+
+    # Default implementation for a message is to do nothing when receiving
+    # replies.
+    #
+    # @example Receive replies.
+    #   message.receive_replies(connection)
+    #
+    # @param [ Connection ] connection The connection.
+    #
+    # @since 1.0.0
+    #
+    # @return [ nil ] nil.
+    def receive_replies(connection); end
+
+    def deserialize(buffer)
+      self.class.fields.each do |field|
+        __send__(:"deserialize_#{field}", buffer)
+      end
+      self
+    end
+
+    # Serializes the message and all of its fields to a new buffer or to the
+    # provided buffer.
+    #
+    # @param [String] buffer a buffer to serialize to
+    # @return [String] the result of serliazing this message
+    def serialize(buffer = "")
+      raise NotImplementedError, "This method is generated after calling #finalize on a message class"
+    end
+    alias to_s serialize
+
+    # @return [String] the nicely formatted version of the message
+    def inspect
+      fields = self.class.fields.map do |field|
+        "@#{field}=" + __send__(field).inspect
+      end
+      "#<#{self.class.name} " <<
+      "#{fields * " "}>"
+    end
+
+    def pretty_inspect
+      fields = self.class.fields.map do |field|
+        "@#{field}=" + __send__(field).inspect
+      end
+      "#<#{self.class.name}\n" <<
+      "  #{fields * "\n  "}>"
+    end
+
+  end
+end

data/lib/binary/protocol/extensions.rb

@@ -0,0 +1 @@
+require "binary/protocol/extensions/module"

data/lib/binary/protocol/extensions/module.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module Binary
+  module Protocol
+    module Extensions
+      module Module
+
+        # Redefine the method. Will undef the method if it exists or simply
+        # just define it.
+        #
+        # @example Redefine the method.
+        #   Object.re_define_method("exists?") do
+        #     self
+        #   end
+        #
+        # @param [ String, Symbol ] name The name of the method.
+        # @param [ Proc ] block The method body.
+        #
+        # @return [ Method ] The new method.
+        #
+        # @since 3.0.0
+        def re_define_method(name, &block)
+          undef_method(name) if method_defined?(name)
+          define_method(name, &block)
+        end
+      end
+    end
+  end
+end
+
+unless ::Module.respond_to?(:re_define_method, true)
+  ::Module.__send__(:include, Binary::Protocol::Extensions::Module)
+end

data/lib/binary/protocol/version.rb

@@ -0,0 +1,5 @@
+module Binary
+  module Protocol
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: binary-protocol
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Bennett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Helpful DSL for reading and writing binary protocols
+email:
+- andrew@pagodabox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- binary-protocol.gemspec
+- lib/binary/protocol.rb
+- lib/binary/protocol/extensions.rb
+- lib/binary/protocol/extensions/module.rb
+- lib/binary/protocol/version.rb
+homepage: https://github.com/potatosalad/binary-protocol
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Helpful DSL for reading and writing binary protocols
+test_files: []