mrpin-rocketamf 1.0.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89a384bbdb4acd4fbd09cec6b2b1bc063f33eb6a
-  data.tar.gz: 9a547e174f37ec203153c2a871406495a3339f5a
+  metadata.gz: 9d63832510464963b845035c265bbc971b411ecb
+  data.tar.gz: 658cafa2f6e9ec23b55d343178eeeeb1466410de
 SHA512:
-  metadata.gz: 6b46b6df13dd18e05c4963cd791de40f5ec5a35786f20822e48118605e2913a573c8277ca1152fa3d7aa7e8e1849e4aad2a4098f11722e7e2f4f2bdd84a01742
-  data.tar.gz: ef6039476cc10fbe2f29a55f77577d9801614bec24f1fca758231c4bc5c0f2eee5c6af557745ceb37d385bcd5bfa7352ce64030d1b42b9e4c64acd38deb83193
+  metadata.gz: 38481d7ea20ab45a9b3ebb9f7b339e7796a9756c93f75773f2a671fdc62d4c2109a3b92811b121a2a7cf4bd285f95f927feb0309002d77c841a7211bbe8741be
+  data.tar.gz: 3bed4925ed2fb064f79bb1ed8716fc65bf40a9dd51187634fb7b646bf9bd776fcf55930ffbe83547fb811a0675b6c379a8a80bf2f2c92d710f4b94a2c5f884b1

data/README.rdoc

@@ -18,7 +18,7 @@ compatible with Ruby 1.9.
 
   hash = {:apple => "Apfel", :red => "Rot", :eyes => "Augen"}
   File.open("amf.dat", 'w') do |f|
-    f.write RocketAMF.serialize(hash, 3) # Use AMF3 encoding to serialize
+    f.write RocketAMF.serialize(hash) # Use AMF3 encoding to serialize
   end
 
 == LICENSE:

data/Rakefile

@@ -6,15 +6,15 @@ require 'rspec/core/rake_task'
 require 'rake/extensiontask'
 
 desc 'Default: run the specs.'
-task :default => :spec
+task default: :spec
 
 # I don't want to depend on bundler, so we do it the bundler way without it
 gemspec_path = 'mrpin-rocketamf.gemspec'
-spec = begin
+spec         = begin
   eval(File.read(File.join(File.dirname(__FILE__), gemspec_path)), TOPLEVEL_BINDING, gemspec_path)
 rescue LoadError => e
   original_line = e.backtrace.find { |line| line.include?(gemspec_path) }
-  msg  = "There was a LoadError while evaluating #{gemspec_path}:\n  #{e.message}"
+  msg           = "There was a LoadError while evaluating #{gemspec_path}:\n  #{e.message}"
   msg << " from\n  #{original_line}" if original_line
   msg << "\n"
   puts msg
@@ -28,7 +28,7 @@ desc 'Generate documentation'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = spec.name
-  rdoc.options += spec.rdoc_options
+  rdoc.options  += spec.rdoc_options
   rdoc.rdoc_files.include(*spec.extra_rdoc_files)
   rdoc.rdoc_files.include('lib') # Don't include ext folder because no one cares
 end
@@ -39,15 +39,15 @@ Gem::PackageTask.new(spec) do |pkg|
 end
 
 Rake::ExtensionTask.new('rocketamf_ext', spec) do |ext|
-  if RUBY_PLATFORM =~ /mswin|mingw/ then
+  if RUBY_PLATFORM =~ /mswin|mingw/
     # No cross-compile on win, so compile extension to lib/1.[89]
     RUBY_VERSION =~ /(\d+\.\d+)/
     ext.lib_dir = "lib/#{$1}"
   else
-    ext.cross_compile = true
+    ext.cross_compile  = true
     ext.cross_platform = 'x86-mingw32'
     ext.cross_compiling do |gem_spec|
-      gem_spec.post_install_message = "You installed the binary version of this gem!"
+      gem_spec.post_install_message = 'You installed the binary version of this gem!'
     end
   end
   #ext.config_options << '--enable-sort-props'

data/benchmark.rb

@@ -6,7 +6,7 @@ require 'rocketamf/pure/deserializer' # Only ext gets included by default if ava
 require 'rocketamf/pure/serializer'
 
 OBJECT_COUNT = 100000
-TESTS = 5
+TESTS        = 5
 
 class TestClass
   attr_accessor :prop_a, :prop_b, :prop_c, :prop_d, :prop_e
@@ -28,47 +28,54 @@ OBJECT_COUNT.times do
   objs << TestClass.new.populate
 end
 
-["native", "pure"].each do |type|
+%w(native pure).each do |type|
+
+  use_ruby_version = type == 'pure'
+
   # Set up class mapper
-  cm = if type == "pure"
-    RocketAMF::ClassMapping
+  class_mapper     = nil
+
+  if use_ruby_version
+    class_mapper = RocketAMF::ClassMapping
   else
-    RocketAMF::Ext::FastClassMapping
+    class_mapper = RocketAMF::Ext::FastClassMapping
   end
-  cm.define do |m|
-    m.map :as => 'TestClass', :ruby => 'TestClass'
+
+  class_mapper.define do |m|
+    m.map as: 'TestClass', ruby: 'TestClass'
   end
 
-  [0, 3].each do |version|
-    # 2**24 is larger than anyone is ever going to run this for
-    min_serialize = 2**24
-    min_deserialize = 2**24
-
-    puts "Testing #{type} AMF#{version}:"
-    TESTS.times do
-      ser = if type == "pure"
-        RocketAMF::Pure::Serializer.new(cm.new)
-      else
-        RocketAMF::Ext::Serializer.new(cm.new)
-      end
-      start_time = Time.now
-      out = ser.serialize(version, objs)
-      end_time = Time.now
-      puts "\tserialize run: #{end_time-start_time}s"
-      min_serialize = [end_time-start_time, min_serialize].min
-
-      des = if type == "pure"
-        RocketAMF::Pure::Deserializer.new(cm.new)
-      else
-        RocketAMF::Ext::Deserializer.new(cm.new)
-      end
-      start_time = Time.now
-      temp = des.deserialize(version, out)
-      end_time = Time.now
-      puts "\tdeserialize run: #{end_time-start_time}s"
-      min_deserialize = [end_time-start_time, min_deserialize].min
+
+  # 2**24 is larger than anyone is ever going to run this for
+  min_serialize   = 2**24
+  min_deserialize = 2**24
+
+  puts "Testing #{type} AMF3"
+  TESTS.times do
+    serializer   = nil
+    deserializer = nil
+
+    if use_ruby_version
+      serializer   = RocketAMF::Pure::Serializer.new(class_mapper.new)
+      deserializer = RocketAMF::Pure::Deserializer.new(class_mapper.new)
+    else
+      serializer   = RocketAMF::Ext::Serializer.new(class_mapper.new)
+      deserializer = RocketAMF::Ext::Deserializer.new(class_mapper.new)
     end
-    puts "\tminimum serialize time: #{min_serialize}s"
-    puts "\tminimum deserialize time: #{min_deserialize}s"
+
+    start_time = Time.now
+    out        = serializer.serialize(objs)
+    end_time   = Time.now
+    puts "\tserialize run: #{end_time-start_time}s"
+    min_serialize = [end_time-start_time, min_serialize].min
+
+    start_time = Time.now
+    temp       = deserializer.deserialize(out)
+    end_time   = Time.now
+    puts "\tdeserialize run: #{end_time-start_time}s"
+    min_deserialize = [end_time-start_time, min_deserialize].min
   end
+
+  puts "\tminimum serialize time: #{min_serialize}s"
+  puts "\tminimum deserialize time: #{min_deserialize}s"
 end

data/ext/rocketamf_ext/class_mapping.c

@@ -88,15 +88,15 @@ static VALUE mapset_init(VALUE self) {
 static VALUE mapset_map_defaults(VALUE self) {
     const int NUM_MAPPINGS = 9;
     const char* ruby_classes[] = {
-        "RocketAMF::Values::AbstractMessage",
-        "RocketAMF::Values::RemotingMessage",
-        "RocketAMF::Values::AsyncMessage",
-        "RocketAMF::Values::AsyncMessageExt",
-        "RocketAMF::Values::CommandMessage",
-        "RocketAMF::Values::CommandMessageExt",
-        "RocketAMF::Values::AcknowledgeMessage",
-        "RocketAMF::Values::AcknowledgeMessageExt",
-        "RocketAMF::Values::ErrorMessage"
+        "RocketAMF::Types::AbstractMessage",
+        "RocketAMF::Types::RemotingMessage",
+        "RocketAMF::Types::AsyncMessage",
+        "RocketAMF::Types::AsyncMessageExt",
+        "RocketAMF::Types::CommandMessage",
+        "RocketAMF::Types::CommandMessageExt",
+        "RocketAMF::Types::AcknowledgeMessage",
+        "RocketAMF::Types::AcknowledgeMessageExt",
+        "RocketAMF::Types::ErrorMessage"
     };
     const char* as_classes[] = {
         "flex.messaging.messages.AbstractMessage",
@@ -309,7 +309,7 @@ static VALUE mapping_as_class_name(VALUE self, VALUE obj) {
  *
  * Instantiates a ruby object using the mapping configuration based on the
  * source AS class name. If there is no mapping defined, it returns a
- * <tt>RocketAMF::Values::TypedHash</tt> with the serialized class name.
+ * <tt>RocketAMF::Types::TypedHash</tt> with the serialized class name.
  */
 static VALUE mapping_get_ruby_obj(VALUE self, VALUE name) {
     CLASS_MAPPING *map;
@@ -475,7 +475,7 @@ void Init_rocket_amf_fast_class_mapping() {
     rb_define_method(cFastClassMapping, "props_for_serialization", mapping_props, 1);
 
     // Cache values
-    cTypedHash = rb_const_get(rb_const_get(mRocketAMF, rb_intern("Values")), rb_intern("TypedHash"));
+    cTypedHash = rb_const_get(rb_const_get(mRocketAMF, rb_intern("Types")), rb_intern("TypedHash"));
     id_use_ac = rb_intern("use_array_collection");
     id_use_ac_ivar = rb_intern("@use_array_collection");
     id_mappings = rb_intern("mappings");

data/ext/rocketamf_ext/remoting.c

@@ -180,5 +180,5 @@ void Init_rocket_amf_remoting() {
     id_data = rb_intern("data");
     cRocketAMFHeader = rb_const_get(mRocketAMF, rb_intern("Header"));
     cRocketAMFMessage = rb_const_get(mRocketAMF, rb_intern("Message"));
-    cRocketAMFAbstractMessage = rb_const_get(rb_const_get(mRocketAMF, rb_intern("Values")), rb_intern("AbstractMessage"));
+    cRocketAMFAbstractMessage = rb_const_get(rb_const_get(mRocketAMF, rb_intern("Types")), rb_intern("AbstractMessage"));
 }

data/lib/rocketamf.rb

@@ -1,20 +1,31 @@
 $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 $:.unshift "#{File.expand_path(File.dirname(__FILE__))}/rocketamf/"
+$:.unshift "#{File.expand_path(File.dirname(__FILE__))}/rocketamf/types/"
 
-require "date"
-require "stringio"
+require 'date'
+require 'stringio'
+require 'rocketamf/errors'
 require 'rocketamf/extensions'
-require 'rocketamf/class_mapping'
+require 'rocketamf/mapping/class_mapping'
 require 'rocketamf/constants'
-require 'rocketamf/remoting'
+require 'rocketamf/types'
 
-# RocketAMF is a full featured AMF0/3 serializer and deserializer with support for
+
+#todo: implement C version
+# begin
+#   require 'rocketamf/ext'
+# rescue LoadError
+
+require 'rocketamf/pure'
+# end
+
+# MrPin RocketAMF is a full featured AMF3 serializer and deserializer with support for
 # bi-directional Flash to Ruby class mapping, custom serialization and mapping,
-# remoting gateway helpers that follow AMF0/3 messaging specs, and a suite of specs
+# remoting gateway helpers that follow AMF3 messaging specs, and a suite of specs
 # to ensure adherence to the specification documents put out by Adobe. If the C
 # components compile, then RocketAMF automatically takes advantage of them to
 # provide a substantial performance benefit. In addition, RocketAMF is fully
-# compatible with Ruby 1.9.
+# compatible with Ruby 2.0, 2.1.
 #
 # == Performance
 #
@@ -27,17 +38,12 @@ require 'rocketamf/remoting'
 # some benchmarks I took using using a simple little benchmarking utility I whipped
 # up, which can be found in the root of the repository.
 #
+#todo:change benchmark
 #   # 100000 objects
 #   # Ruby 1.8
-#   Testing native AMF0:
-#     minimum serialize time: 1.229868s
-#     minimum deserialize time: 0.86465s
 #   Testing native AMF3:
 #     minimum serialize time: 1.444652s
 #     minimum deserialize time: 0.879407s
-#   Testing pure AMF0:
-#     minimum serialize time: 25.427931s
-#     minimum deserialize time: 11.706084s
 #   Testing pure AMF3:
 #     minimum serialize time: 31.637864s
 #     minimum deserialize time: 14.773969s
@@ -47,9 +53,7 @@ require 'rocketamf/remoting'
 # RocketAMF provides two main methods - <tt>serialize</tt> and <tt>deserialize</tt>.
 # Deserialization takes a String or StringIO object and the AMF version if different
 # from the default. Serialization takes any Ruby object and the version if different
-# from the default. Both default to AMF0, as it's more widely supported and slightly
-# faster, but AMF3 does a better job of not sending duplicate data. Which you choose
-# depends on what you need to communicate with and how much serialized size matters.
+# from the default. AMF3  not sending duplicate data.
 #
 # == Mapping Classes Between Flash and Ruby
 #
@@ -60,50 +64,6 @@ require 'rocketamf/remoting'
 # replace it with a class mapper of your own devising that matches the documented
 # API.
 #
-# == Remoting
-#
-# You can use RocketAMF bare to write an AMF gateway using the following code.
-# In addition, you can use rack-amf (http://github.com/rubyamf/rack-amf) or
-# RubyAMF (http://github.com/rubyamf/rubyamf), both of which provide rack-compliant
-# AMF gateways.
-#
-#   # helloworld.ru
-#   require 'rocketamf'
-#
-#   class HelloWorldApp
-#     APPLICATION_AMF = 'application/x-amf'.freeze
-#
-#     def call env
-#       if is_amf?(env)
-#         # Wrap request and response
-#         env['rack.input'].rewind
-#         request = RocketAMF::Envelope.new.populate_from_stream(env['rack.input'].read)
-#         response = RocketAMF::Envelope.new
-#
-#         # Handle request
-#         response.each_method_call request do |method, args|
-#           raise "Service #{method} does not exists" unless method == 'App.helloWorld'
-#           'Hello world'
-#         end
-#
-#         # Pass back response
-#         response_str = response.serialize
-#         return [200, {'Content-Type' => APPLICATION_AMF, 'Content-Length' => response_str.length.to_s}, [response_str]]
-#       else
-#         return [200, {'Content-Type' => 'text/plain', 'Content-Length' => '16' }, ["Rack AMF gateway"]]
-#       end
-#     end
-#
-#     private
-#     def is_amf? env
-#       return false unless env['CONTENT_TYPE'] == APPLICATION_AMF
-#       return false unless env['PATH_INFO'] == '/amf'
-#       return true
-#     end
-#   end
-#
-#   run HelloWorldApp.new
-#
 # == Advanced Serialization (encode_amf and IExternalizable)
 #
 # RocketAMF provides some additional functionality to support advanced
@@ -129,11 +89,7 @@ require 'rocketamf/remoting'
 #
 #   class VariableObject
 #     def encode_amf ser
-#       if ser.version == 0
-#         ser.serialize 0, true
-#       else
-#         ser.serialize 3, false
-#       end
+#         ser.serialize(false)
 #     end
 #   end
 #
@@ -148,10 +104,6 @@ require 'rocketamf/remoting'
 #
 #   class ResultSet < Array
 #     def encode_amf ser
-#       if ser.version == 0
-#         # Serialize as simple array in AMF0
-#         ser.write_array self
-#       else
 #         # Serialize as an ArrayCollection object
 #         # It conforms to IExternalizable, does not have any dynamic properties,
 #         # and has no "sealed" members. See the AMF3 specs for more details about
@@ -162,7 +114,6 @@ require 'rocketamf/remoting'
 #           :dynamic => false,
 #           :members => []
 #         }
-#       end
 #     end
 #   
 #     # Write self as array to stream
@@ -176,43 +127,35 @@ require 'rocketamf/remoting'
 #     end
 #   end
 module RocketAMF
-  #todo: implement C version
-  # begin
-  #   require 'rocketamf/ext'
-  # rescue LoadError
 
-    require 'rocketamf/pure'
-  # end
+  #
+  # Constants
+  #
+
+  #todo: use c version
+  CLASS_MAPPER = RocketAMF::ClassMapping
+
+  #
+  # Static methods
+  #
 
   # Deserialize the AMF string _source_ of the given AMF version into a Ruby
   # data structure and return it. Creates an instance of <tt>RocketAMF::Deserializer</tt>
-  # with a new instance of <tt>RocketAMF::ClassMapper</tt> and calls deserialize
-  # on it with the given source and amf version, returning the result.
-  def self.deserialize source, amf_version = 0
-    des = RocketAMF::Deserializer.new(RocketAMF::ClassMapper.new)
-    des.deserialize(amf_version, source)
+  # with a new instance of <tt>RocketAMF::CLASS_MAPPER</tt> and calls deserialize
+  # on it with the given source, returning the result.
+  def self.deserialize(source)
+    deserializer = RocketAMF::Deserializer.new(RocketAMF::CLASS_MAPPER.new)
+    deserializer.deserialize(source)
   end
 
   # Serialize the given Ruby data structure _obj_ into an AMF stream using the
   # given AMF version. Creates an instance of <tt>RocketAMF::Serializer</tt>
-  # with a new instance of <tt>RocketAMF::ClassMapper</tt> and calls serialize
-  # on it with the given object and amf version, returning the result.
-  def self.serialize obj, amf_version = 0
-    ser = RocketAMF::Serializer.new(RocketAMF::ClassMapper.new)
-    ser.serialize(amf_version, obj)
+  # with a new instance of <tt>RocketAMF::CLASS_MAPPER</tt> and calls serialize
+  # on it with the given object, returning the result.
+  def self.serialize(obj)
+    serializer = RocketAMF::Serializer.new(RocketAMF::CLASS_MAPPER.new)
+    serializer.serialize(obj)
   end
 
-  # We use const_missing to define the active ClassMapper at runtime. This way,
-  # heavy modification of class mapping functionality is still possible without
-  # forcing extenders to redefine the constant.
-  def self.const_missing const #:nodoc:
-    if const == :ClassMapper
-      RocketAMF.const_set(:ClassMapper, RocketAMF::ClassMapping)
-    else
-      super(const)
-    end
-  end
 
-  # The base exception for AMF errors.
-  class AMFError < StandardError; end
 end

data/lib/rocketamf/constants.rb

@@ -20,24 +20,24 @@ module RocketAMF
   AMF0_AMF3_MARKER          = 0x11 #"\021"
 
   # AMF3 Type Markers
-  AMF3_UNDEFINED_MARKER     =  0x00 #"\000"
-  AMF3_NULL_MARKER          =  0x01 #"\001"
-  AMF3_FALSE_MARKER         =  0x02 #"\002"
-  AMF3_TRUE_MARKER          =  0x03 #"\003"
-  AMF3_INTEGER_MARKER       =  0x04 #"\004"
-  AMF3_DOUBLE_MARKER        =  0x05 #"\005"
-  AMF3_STRING_MARKER        =  0x06 #"\006"
-  AMF3_XML_DOC_MARKER       =  0x07 #"\a"
-  AMF3_DATE_MARKER          =  0x08 #"\b"
-  AMF3_ARRAY_MARKER         =  0x09 #"\t"
-  AMF3_OBJECT_MARKER        =  0x0A #"\n"
-  AMF3_XML_MARKER           =  0x0B #"\v"
-  AMF3_BYTE_ARRAY_MARKER    =  0x0C #"\f"
-  AMF3_VECTOR_INT_MARKER    =  0x0D #"\r"
-  AMF3_VECTOR_UINT_MARKER   =  0x0E #"\016"
-  AMF3_VECTOR_DOUBLE_MARKER =  0x0F #"\017"
-  AMF3_VECTOR_OBJECT_MARKER =  0x10 #"\020"
-  AMF3_DICT_MARKER          =  0x11 #"\021"
+  AMF3_UNDEFINED_MARKER     = 0x00 #"\000"
+  AMF3_NULL_MARKER          = 0x01 #"\001"
+  AMF3_FALSE_MARKER         = 0x02 #"\002"
+  AMF3_TRUE_MARKER          = 0x03 #"\003"
+  AMF3_INTEGER_MARKER       = 0x04 #"\004"
+  AMF3_DOUBLE_MARKER        = 0x05 #"\005"
+  AMF3_STRING_MARKER        = 0x06 #"\006"
+  AMF3_XML_DOC_MARKER       = 0x07 #"\a"
+  AMF3_DATE_MARKER          = 0x08 #"\b"
+  AMF3_ARRAY_MARKER         = 0x09 #"\t"
+  AMF3_OBJECT_MARKER        = 0x0A #"\n"
+  AMF3_XML_MARKER           = 0x0B #"\v"
+  AMF3_BYTE_ARRAY_MARKER    = 0x0C #"\f"
+  AMF3_VECTOR_INT_MARKER    = 0x0D #"\r"
+  AMF3_VECTOR_UINT_MARKER   = 0x0E #"\016"
+  AMF3_VECTOR_DOUBLE_MARKER = 0x0F #"\017"
+  AMF3_VECTOR_OBJECT_MARKER = 0x10 #"\020"
+  AMF3_DICT_MARKER          = 0x11 #"\021"
 
   # Other AMF3 Markers
   AMF3_EMPTY_STRING         = 0x01
@@ -45,6 +45,6 @@ module RocketAMF
   AMF3_CLOSE_DYNAMIC_ARRAY  = 0x01
 
   # Other Constants
-  MAX_INTEGER               = 268435455
-  MIN_INTEGER               = -268435456
+  MAX_INTEGER               = 268_435_455
+  MIN_INTEGER               = -268_435_456
 end