stark 0.7.0 → 0.8.0

data/lib/stark/struct.rb

@@ -1,42 +1,53 @@
 module Stark
   class Struct
     def initialize(fields={})
-      @fields = fields
+      fields.each do |k,v|
+        send(:"#{k}=", v) if respond_to?(:"#{k}=")
+      end
     end
 
-    def set_from_index(type, idx, ip)
-      info = self.class::Fields[idx]
-      return unless info
-
-      if info.type == type
-        @fields[info.name] = info.read(ip)
-      else
-        ip.skip type
+    def [](*args)
+      values = []
+      args.each do |a|
+        case a
+        when Fixnum
+          n = self.class.fields[a]
+          values << (n ? send(n) : nil)
+        when Range
+          values += self[*a.to_a]
+        when String, Symbol
+          values << send(a)
+        end
       end
+      values = values.first if values.size == 1
+      values
     end
 
-    def read(ip)
-      ip.read_struct_begin
-
-      while true
-        _, ftype, fid = ip.read_field_begin
-        break if ftype == ::Thrift::Types::STOP
-
-        set_from_index ftype, fid, ip
-
-        ip.read_field_end
+    def to_hash
+      {}.tap do |hash|
+        self.class.fields.each do |idx,name|
+          v = send name
+          hash[name] = v if v
+        end
       end
+    end
 
-      ip.read_struct_end
-
-      self
+    def self.fields
+      @fields ||= {}
     end
 
-    def write_fields(op)
-      self.class::Fields.each do |idx, field|
-        next if idx == :count
-        field.write op, @fields[field.name]
+    def self.attr_accessor(*attrs)
+      attrs.each do |a|
+        n = field_number
+        fields[n] = a
+        self.field_number n + 1
       end
+      super
+    end
+
+    def self.field_number(n = nil)
+      @field_number = n if n
+      @field_number ||= 1
     end
   end
 end

data/lib/stark/thrift.kpeg

@@ -122,7 +122,7 @@ reserved =
   "synchronized"       |
   "then"               |
   "this"               |
-  "throw"              |
+  "throws"             |
   "transient"          |
   "try"                |
   "undef"              |
@@ -172,11 +172,13 @@ root = Program !.
 
 Program = Element*:a { a }
 
-CComment = "/*" < (!"*/" .)* > "*/" obsp ~comment(text)
+CMLComment = "/*" < (!"*/" .)* > "*/" obsp ~comment(text)
+
+CSLComment = "//" <  (!"\n" .)* > bsp ~comment(text)
 
 HComment = "#" <  (!"\n" .)* > bsp ~comment(text)
 
-Comment = CComment | HComment
+Comment = CMLComment | CSLComment | HComment
 
 CaptureDocText = {}
 DestroyDocText = {}
@@ -277,7 +279,7 @@ Function = CaptureDocText OneWay?:o FunctionType:rt - tok_identifier:name
 
 OneWay = ("oneway" | "async") - { :oneway }
 
-Throws = - "throws" - "(" FieldList ")"
+Throws = osp "throws" osp "(" FieldList ")"
 
 FieldList = FieldList:l Field:f { l + [f] }
           | Field:f { [f] }

data/stark.gemspec

@@ -2,39 +2,39 @@
 
 Gem::Specification.new do |s|
   s.name = "stark"
-  s.version = "0.5.0.20130227233247"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Evan Phoenix"]
-  s.date = "2013-02-28"
-  s.description = "Optimized thrift bindings for ruby"
+  s.date = "2013-05-22"
+  s.description = "Optimized thrift bindings for ruby."
   s.email = ["evan@phx.io"]
   s.executables = ["stark"]
-  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
-  s.files = [".autotest", "History.txt", "Manifest.txt", "README.txt", "Rakefile", "bin/stark", "lib/stark.rb", "test/test_stark.rb", "test/test_client.rb", "test/test_parser.rb", "test/test_server.rb", ".gemtest"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.md", "examples/README.md"]
+  s.files = [".autotest", ".gemtest", ".travis.yml", "History.txt", "Manifest.txt", "README.md", "Rakefile", "bin/stark", "examples/README.md", "examples/client.rb", "examples/health.thrift", "examples/server.rb", "lib/stark.rb", "lib/stark/ast.rb", "lib/stark/client.rb", "lib/stark/exception.rb", "lib/stark/log_transport.rb", "lib/stark/parser.rb", "lib/stark/processor.rb", "lib/stark/protocol_helpers.rb", "lib/stark/raw_parser.rb", "lib/stark/ruby.rb", "lib/stark/struct.rb", "lib/stark/thrift.kpeg", "stark.gemspec", "test/ThriftSpec.thrift", "test/blah.thrift", "test/comments.thrift", "test/gen-rb/profile_constants.rb", "test/gen-rb/profile_types.rb", "test/gen-rb/user_storage.rb", "test/include_blah.thrift", "test/leg.rb", "test/legacy_profile/profile_constants.rb", "test/legacy_profile/profile_types.rb", "test/legacy_profile/user_storage.rb", "test/parsing_error.thrift", "test/profile.thrift", "test/properties.thrift", "test/test_client.rb", "test/test_coerce_strings.rb", "test/test_helper.rb", "test/test_marshal.rb", "test/test_parser.rb", "test/test_ruby.rb", "test/test_server.rb", "test/test_stark.rb", "test/types.thrift", "test/users.thrift"]
   s.homepage = "http://github.com/evanphx/stark"
-  s.rdoc_options = ["--main", "README.txt"]
+  s.rdoc_options = ["--main", "README.md"]
   s.require_paths = ["lib"]
   s.rubyforge_project = "stark"
-  s.rubygems_version = "1.8.25"
-  s.summary = "Optimized thrift bindings for ruby"
-  s.test_files = ["test/test_client.rb", "test/test_parser.rb", "test/test_server.rb"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "Optimized thrift bindings for ruby."
+  s.test_files = ["test/test_client.rb", "test/test_coerce_strings.rb", "test/test_helper.rb", "test/test_marshal.rb", "test/test_parser.rb", "test/test_ruby.rb", "test/test_server.rb", "test/test_stark.rb"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<thrift>, ["~> 0.9.0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.10"])
-      s.add_development_dependency(%q<hoe>, ["~> 3.5"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_development_dependency(%q<hoe>, ["~> 3.6"])
     else
       s.add_dependency(%q<thrift>, ["~> 0.9.0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.10"])
-      s.add_dependency(%q<hoe>, ["~> 3.5"])
+      s.add_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_dependency(%q<hoe>, ["~> 3.6"])
     end
   else
     s.add_dependency(%q<thrift>, ["~> 0.9.0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.10"])
-    s.add_dependency(%q<hoe>, ["~> 3.5"])
+    s.add_dependency(%q<rdoc>, ["~> 4.0"])
+    s.add_dependency(%q<hoe>, ["~> 3.6"])
   end
 end

data/test/ThriftSpec.thrift

@@ -181,3 +181,7 @@ struct NestedMapInMapKey {
 struct NestedMapInMapValue {
   2: map<byte, map<byte, byte>> value
 }
+
+service HelloService {
+  list<Hello> all()
+}

data/test/comments.thrift

@@ -0,0 +1,15 @@
+/*
+ * multi-line
+ * comment
+ */
+
+/* one-liner of multi-line style in struct */
+
+// single line
+
+# hash style also supported
+
+struct Foo {
+  // one comment entry is allowed here, but not elsewhere inside the struct
+  1: i32 id
+}

data/test/leg.rb

@@ -57,8 +57,6 @@ end
 
 server = UserStorage::Processor.new Handler.new
 
-Thread.abort_on_exception = true
-
 st = Thread.new do
   server.process server_p, server_p
 end

data/test/parsing_error.thrift

@@ -0,0 +1,5 @@
+include 'profile.thrift'
+
+structure {
+  1: id32 uid
+}

data/test/properties.thrift

@@ -0,0 +1,9 @@
+struct Property {
+  1: i32 id
+  2: string name
+}
+
+service Properties {
+ list<Property> list(),
+ Property get(1:i32 property_uid)
+}

data/test/test_client.rb

@@ -9,361 +9,236 @@ $: << "test/legacy_profile"
 
 require 'user_storage'
 
-class TestClient < Test::Unit::TestCase
-  def setup
-    @client_t, @server_t = Stark.pipe_transport
-    @client_p = Thrift::BinaryProtocol.new @client_t
-    @server_p = Thrift::BinaryProtocol.new @server_t
-
-    @n = Module.new
-    Stark.materialize "test/profile.thrift", @n
+require 'test/test_helper'
 
-    @client = @n::UserStorage::Client.new @client_p, @client_p
-    @handler = Handler.new(@n)
-    @server = UserStorage::Processor.new @handler
-  end
+class TestClient < Test::Unit::TestCase
+  IDL = "test/profile.thrift"
+  SERVICE = "UserStorage"
+  include TestHelper
 
-  def teardown
-    @client_t.close
-    @server_t.close
+  def setup
+    setup_client
   end
 
-  class Handler
-    def initialize(n)
-      @users = {}
-      @last_map = nil
-      @last_list = nil
-      @last_status = nil
-      @n = n
-      @user_status = nil
-      @user_relationship = nil
-    end
-
-    attr_accessor :last_map, :last_list, :last_status, :user_status
-
-    def store(obj)
-      @users[obj.uid] = obj
-    end
-
-    def retrieve(id)
-      @users[id]
-    end
-
-    def set_map(m)
-      @last_map = m
-    end
-
-    def set_list(l)
-      @last_list = l
-    end
-
-    def set_status(s)
-      @last_status = s
-    end
-
-    def volume_up
-      raise RockTooHard.new(:volume => 11)
-    end
-
-    def make_bitcoins
-      sleep 2
-    end
-
-    def add(a,b)
-      a + b
-    end
+  def test_store_and_retrieve
+    send_to_server do
+      xuser = @n::UserProfile.new 'uid' => 0, 'name' => 'root', 'blurb' => 'god'
 
-    def set_user_status(s)
-      @user_status = s
+      @client.store xuser
     end
 
-    attr_accessor :user_relationship
-    def set_user_relationship(rel)
-      @user_relationship = rel
+    obj = send_to_server do
+      @client.retrieve 0
     end
 
-    attr_accessor :user_friends
-    def set_user_friends(fr)
-      @user_friends = fr
-    end
+    assert_equal 0, obj.uid
+    assert_equal "root", obj.name
+    assert_equal "god", obj.blurb
   end
 
-  def test_store_and_retrieve
-    st = Thread.new do
-      @server.process @server_p, @server_p
+  def test_store_and_retrieve_with_some_missing_values
+    send_to_server do
+      xuser = @n::UserProfile.new 'uid' => 0, 'name' => 'root'
+      @client.store xuser
     end
 
-    xuser = @n::UserProfile.new 'uid' => 0, 'name' => 'root', 'blurb' => 'god'
-
-    @client.store xuser
-
-    st.join
-
-    st = Thread.new do
-      @server.process @server_p, @server_p
+    obj = send_to_server do
+      @client.retrieve 0
     end
 
-    obj = @client.retrieve 0
-
-    st.join
-
     assert_equal 0, obj.uid
     assert_equal "root", obj.name
-    assert_equal "god", obj.blurb
+    assert obj.blurb.nil?
   end
 
   def test_set_map
-    st = Thread.new do
-      @server.process @server_p, @server_p
-    end
+    send_to_server do
 
-    m = { "blah" => "foo", "a" => "b" }
+      m = { "blah" => "foo", "a" => "b" }
 
-    @client.set_map m
+      @client.set_map m
 
-    st.join
+    end
 
     assert_equal "foo", @handler.last_map["blah"]
     assert_equal "b", @handler.last_map["a"]
   end
 
   def test_last_map
-    st = Thread.new do
-      @server.process @server_p, @server_p
-    end
-
-    @handler.last_map = { "blah" => "foo", "a" => "b" }
+    m = send_to_server do
+      @handler.last_map = { "blah" => "foo", "a" => "b" }
 
-    m = @client.last_map
-
-    st.join
+      @client.last_map
+    end
 
     assert_equal "foo", m["blah"]
     assert_equal "b", m["a"]
   end
 
   def test_set_list
-    st = Thread.new do
-      @server.process @server_p, @server_p
-    end
-
     m = [ "blah", "foo", "a", "b" ]
 
-    @client.set_list m
-
-    st.join
+    send_to_server do
+      @client.set_list m
+    end
 
     assert_equal m, @handler.last_list
   end
 
   def test_last_list
-    st = Thread.new do
-      @server.process @server_p, @server_p
-    end
-
-    l = [ "blah", "foo", "a", "b" ]
-    @handler.last_list = l
+    send_to_server do
+      l = [ "blah", "foo", "a", "b" ]
+      @handler.last_list = l
 
-    begin
-      assert_equal l, @client.last_list
-    rescue Interrupt => e
-      puts e.backtrace
+      begin
+        assert_equal l, @client.last_list
+      rescue Interrupt => e
+        puts e.backtrace
+      end
     end
-
-    st.join
   end
 
   def test_last_list_is_nil
-    st = Thread.new do
-      @server.process @server_p, @server_p
-    end
-
-    begin
-      assert_equal nil, @client.last_list
-    rescue Interrupt => e
-      puts e.backtrace
+    send_to_server do
+      begin
+        assert_equal nil, @client.last_list
+      rescue Interrupt => e
+        puts e.backtrace
+      end
     end
-
-    st.join
   end
 
   def test_enum
-    st = Thread.new do
-      @server.process @server_p, @server_p
+    send_to_server do
+      @client.set_status :ON
     end
 
-    @client.set_status :ON
-
-    st.join
-
     assert_equal 0, @handler.last_status
   end
 
   def test_enum_recv
-    st = Thread.new do
-      @server.process @server_p, @server_p
-    end
-
-    @handler.last_status = 0
+    send_to_server do
+      @handler.last_status = 0
 
-    assert_equal :ON, @client.last_status
-
-    st.join
+      assert_equal :ON, @client.last_status
+    end
   end
 
   def test_throw
-    st = Thread.new do
-      @server.process @server_p, @server_p
-    end
-
-    e = assert_raises @n::RockTooHard do
-      @client.volume_up
+    e = send_to_server do
+      assert_raises @n::RockTooHard do
+        @client.volume_up
+      end
     end
 
-    st.join
-
     assert_equal 11, e.volume
   end
 
-  # Thread.abort_on_exception = true
-
   def test_oneway
-    st = Thread.new do
-      @server.process @server_p, @server_p
-    end
+    send_to_server do
+      t = Time.now
 
-    t = Time.now
+      Timeout.timeout 3 do
+        assert_equal nil, @client.make_bitcoins
+      end
 
-    Timeout.timeout 3 do
-      assert_equal nil, @client.make_bitcoins
+      assert Time.now - t < 0.1
     end
-
-    assert Time.now - t < 0.1
-
-    st.join
   end
 
   def test_2args
-    st = Thread.new do
-      @server.process @server_p, @server_p
+    send_to_server do
+      assert_equal 7, @client.add(3, 4)
     end
-
-    assert_equal 7, @client.add(3, 4)
-
-    st.join
   end
 
   def test_read_struct_in_a_struct
-    st = Thread.new do
-      @server.process @server_p, @server_p
-    end
-
-    prof = UserProfile.new 'uid' => 0, 'name' => 'root', 'blurb' => 'god'
-    stat = UserStatus.new 'profile' => prof, 'active' => true
+    send_to_server do
+      prof = UserProfile.new 'uid' => 0, 'name' => 'root', 'blurb' => 'god'
+      stat = UserStatus.new 'profile' => prof, 'active' => true
 
-    @handler.user_status = stat
+      @handler.user_status = stat
 
-    status = @client.user_status
+      status = @client.user_status
 
-    assert_equal true, status.active
-    
-    prof = status.profile
+      assert_equal true, status.active
 
-    assert_equal 0, prof.uid
-    assert_equal "root", prof.name
-    assert_equal "god", prof.blurb
+      prof = status.profile
 
-    st.join
+      assert_equal 0, prof.uid
+      assert_equal "root", prof.name
+      assert_equal "god", prof.blurb
+    end
   end
 
   def test_write_struct_in_a_struct
-    st = Thread.new do
-      @server.process @server_p, @server_p
-    end
-
-    prof = @n::UserProfile.new 'uid' => 0, 'name' => 'root', 'blurb' => 'god'
-    stat = @n::UserStatus.new 'profile' => prof, 'active' => true
+    send_to_server do
+      prof = @n::UserProfile.new 'uid' => 0, 'name' => 'root', 'blurb' => 'god'
+      stat = @n::UserStatus.new 'profile' => prof, 'active' => true
 
-    @client.set_user_status stat
+      @client.set_user_status stat
 
-    status = @handler.user_status
+      status = @handler.user_status
 
-    assert_equal true, status.active
-    
-    prof = status.profile
+      assert_equal true, status.active
 
-    assert_equal 0, prof.uid
-    assert_equal "root", prof.name
-    assert_equal "god", prof.blurb
+      prof = status.profile
 
-    st.join
+      assert_equal 0, prof.uid
+      assert_equal "root", prof.name
+      assert_equal "god", prof.blurb
+    end
   end
 
   def test_read_enum_in_struct
-    st = Thread.new do
-      @server.process @server_p, @server_p
-    end
-
-    stat = UserRelationship.new 'user' => 0, 'status' => 4
-
-    @handler.user_relationship = stat
+    send_to_server do
+      stat = UserRelationship.new 'user' => 0, 'status' => 4
 
-    rel = @client.user_relationship
+      @handler.user_relationship = stat
 
-    assert_equal 0, rel.user
-    assert_equal :ITS_COMPLICATED, rel.status
+      rel = @client.user_relationship
 
-    st.join
+      assert_equal 0, rel.user
+      assert_equal :ITS_COMPLICATED, rel.status
+    end
   end
 
   def test_write_enum_in_struct
-    st = Thread.new do
-      @server.process @server_p, @server_p
-    end
+    send_to_server do
+      stat = @n::UserRelationship.new 'user' => 0, 'status' => :ITS_COMPLICATED
 
-    stat = @n::UserRelationship.new 'user' => 0, 'status' => :ITS_COMPLICATED
+      @client.set_user_relationship stat
 
-    @client.set_user_relationship stat
+      rel = @handler.user_relationship
 
-    rel = @handler.user_relationship
-
-    assert_equal 0, rel.user
-    assert_equal 4, rel.status
-
-    st.join
+      assert_equal 0, rel.user
+      assert_equal 4, rel.status
+    end
   end
 
   def test_read_list_in_struct
-    st = Thread.new do
-      @server.process @server_p, @server_p
-    end
-
-    stat = UserFriends.new 'user' => 0, 'friends' => [4,8,47]
-
-    @handler.user_friends = stat
+    send_to_server do
+      stat = UserFriends.new 'user' => 0, 'friends' => [4,8,47]
 
-    rel = @client.user_friends
+      @handler.user_friends = stat
 
-    assert_equal 0, rel.user
-    assert_equal [4,8,47], rel.friends
+      rel = @client.user_friends
 
-    st.join
+      assert_equal 0, rel.user
+      assert_equal [4,8,47], rel.friends
+    end
   end
 
   def test_write_list_in_struct
-    st = Thread.new do
-      @server.process @server_p, @server_p
-    end
-
-    stat = @n::UserFriends.new 'user' => 0, 'friends' => [4,8,47]
+    send_to_server do
+      stat = @n::UserFriends.new 'user' => 0, 'friends' => [4,8,47]
 
-    @client.set_user_friends stat
+      @client.set_user_friends stat
 
-    rel = @handler.user_friends
+      rel = @handler.user_friends
 
-    assert_equal 0, rel.user
-    assert_equal [4,8,47], rel.friends
-
-    st.join
+      assert_equal 0, rel.user
+      assert_equal [4,8,47], rel.friends
+    end
   end
 end