s_matrix 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3c71d1514129d41285ca6bcdba7675d8c679a15
-  data.tar.gz: 1d805c4c4711ab18cf4265db484c59bfd7aba042
+  metadata.gz: 9f8531538924a03ba311631db046c9297191ae0d
+  data.tar.gz: 16ac09c06c0106317814bb73553fce502fdf8746
 SHA512:
-  metadata.gz: ce62e5637c30997f00aea492b231b2076f0e4880e052204b648a02bf5e1ac241469134c7adf92250cc2a9c55a2931866ca9c220efd55c383452ce456503c3d83
-  data.tar.gz: d5dc439be30b0d6ba4284de0c9ae5d1de460361395ecc1083bbae105dcb87e5771fea1fc224465474d1473fef98b464f0b494cbecf78a8e9224a85e188a99414
+  metadata.gz: 9424d88c77864237d2f7a41dc6bc5ae01f2a339bf3302c0749386abaafb968908cc21c421e8a2f752924b5e1c46f19faf960968737c0677dca04010d9f3eefc5
+  data.tar.gz: 46c2d3de7e6f9227a8b5a583d0bce41928b3fb2ee10851f108a8513816649c95da7326a8651f7d453260fb9a9efd1f0a2f96d339fd6797e980e62d139e15178b

data/README.md

@@ -1,7 +1,18 @@
-# SMatrix
-
-# Reduce memory usage for a large number of config.  For example, game config in excel
-
+Current version 1.0.0
+Latest stable version is 1.0.0
+
+### Matrix reduce memory usage for large Hash.
+  Matrix store the hash like this: <br>
+  # {<br>
+  #  '234234' => {'id' => '23232', 'name' => 'haha'},<br>
+  #  '234235' => {'id' => '23235', 'name' => 'haha2', 'hp' => '232'}<br>
+  #  '234236' => {'id' => '23235', 'name' => 'haha2', 'attack' => '2322'}<br>
+  # }<br>
+  For example, loading a game config ./spec/equipment\_strengthen.plist will use 480M when using ruby Hash like this:<br>
+  #      {'234232' => {id: '23423', name: 'haha'}}<br>
+   Because there are about 1440000 ruby String objects when loading to memory.<br>
+     And it will use 5M when using SMatrix.<br>
+Result from test:   rspec ./spec/performance\_spec.rb<br>
 
 ## Installation
 
@@ -17,20 +28,25 @@ Or install it yourself as:
 
     $ gem install s_matrix
 
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-1. Fork it ( https://github.com/libinzhangyuan/s_matrix/fork )
-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 a new Pull Request
-
-gem build s_matrix.gemspec
-
-gem install ./s_matrix-0.0.1.gem  # please change version number to current one.
-
-gem push s_matrix-0.0.1.gem
 
+## Usage
+### initialize the config const
+  # every thing will change to string (.to\_s) when saving to SMatrix<br>
+  EQUIPMENTS = SMatrix.new<br>
+  EQUIPMENTS.add\_row('10001', {'id' => '10001', 'name' => 'wood sword', 'attack' => '342'})<br>
+  EQUIPMENTS.add\_row('20002', {id: 10002, name: 'shoe', speed: 5})<br>
+
+### use the config const
+  # everything get back will be string<br>
+    EQUIPMENTS\['10001'].should == {'id' => '10001', 'name' => 'wood sword', 'attack' => '342''}<br>
+    EQUIPMENTS\['10001']['id'].should == '10001'<br>
+    EQUIPMENTS\['10001'][:id].should == '10001'<br>
+    EQUIPMENTS\['20002'].should == {'id' => '10002', 'name' => 'shoe', 'speed' => '5'}<br>
+    EQUIPMENTS\['20002']['attack'].should == '552'<br>
+    EQUIPMENTS.size.should == 2
+  # or you can use get\_row instead of []<br>
+    EQUIPMENTS.get\_row('20002')<br>
+  # each
+    EQUIPMENTS.each {|k, v| k == '10001', v == {'id' => '10001', 'name' => 'sword', ...} }
+  # for debug
+    puts EQUIPMENTS.to_s

data/README_for_contributor.md

@@ -0,0 +1,22 @@
+# SMatrix
+Please coding following the 'Code Compelte' book.
+And please write the rspec test.
+
+## Contributing
+1. Fork it ( https://github.com/libinzhangyuan/s_matrix/fork )
+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 a new Pull Request
+
+##  Compile
+rake clean
+rake compile
+
+## Test
+rspec ./spec
+
+# how to build gem
+gem build s_matrix.gemspec
+gem install ./s_matrix-0.0.1.gem  # please change version number to current one. Find version at lib/s_matrix/version.rb.
+gem push s_matrix-0.0.1.gem

data/ext/s_matrix/gmatx.cpp

@@ -12,6 +12,7 @@ GMatx::GMatx(void)
 void GMatx::add_row(const std::string& id, const t_key_value_hash& row_content)
 {
     // 处理新增的title
+    // deal the new title
     //
     for (t_key_value_hash::const_iterator iter = row_content.begin();
             iter != row_content.end(); ++iter)
@@ -21,7 +22,7 @@ void GMatx::add_row(const std::string& id, const t_key_value_hash& row_content)
             m_titles.add_title(title);
     }
 
-    // 加到content中
+    // 加到content中    add this row to content.
     //
     m_contents.set_row_with_order(id, row_content, m_titles.get_titles());
 }

data/ext/s_matrix/gmatx.h

@@ -13,6 +13,7 @@ public:
     void add_row(const std::string& id, const t_key_value_hash& row_content);
 
     // 当找不到id所对应的行时，返回的t_key_value_hash数据的size=0
+    // size of t_key_value_hash will be zero when couldn't find the row.
     t_key_value_hash get_row(const std::string& id) const;
     std::string to_s(void) const;
     size_t size(void) const;

data/ext/s_matrix/matx_content.cpp

@@ -63,6 +63,7 @@ std::string MatxContent::to_s(const std::vector<std::string>& titles) const
 void MatxContent::set_row_with_order(const std::string& id, const t_key_value_hash& row_content, const std::vector<std::string>& titles_for_order)
 {
     // 根据titles_for_order的顺序，组装出value
+    // assemble the values following the order of titles_for_order.
     std::vector<std::string> values;
     for (std::vector<std::string>::const_iterator iter = titles_for_order.begin();
             iter != titles_for_order.end(); ++iter)
@@ -78,5 +79,6 @@ void MatxContent::set_row_with_order(const std::string& id, const t_key_value_ha
     }
 
     // 保存行
+    // save row.
     m_rows[id] = MatxRow(values);
 }

data/ext/s_matrix/matx_content.h

@@ -12,6 +12,7 @@ public:
     MatxContent(void);
 
     // 按照titles_for_order中的顺序，格式化row_content中的内容，来设置新行
+    // set new row following the order of titles_for_order.
     void set_row_with_order(const std::string& id, const t_key_value_hash& row_content, const std::vector<std::string>& titles_for_order);
 
     const MatxRow& get_row(const std::string& id) const;

data/ext/s_matrix/s_matrix.cpp

@@ -70,7 +70,7 @@ static VALUE t_add_row(VALUE self, VALUE id, VALUE row)
     Check_Type(row, T_HASH);
 
 
-    // 处理id
+    // 处理id     deal with id
     //
     VALUE id_str = rb_funcall(id, rb_intern("to_s"), 0);
     char* p_id_c_str = StringValuePtr(id_str);
@@ -78,12 +78,12 @@ static VALUE t_add_row(VALUE self, VALUE id, VALUE row)
     if (p_id_c_str[0] == 0)
         rb_raise(rb_eTypeError, "id can't be blank!");
 
-    // 处理row
+    // 处理row    deal with row
     //
     t_key_value_hash row_hash;
     rb_hash_foreach(row, (int (*)(ANYARGS))t_add_row_hash_iter_func, (VALUE)&row_hash);
 
-    // 存数据
+    // 存数据   store data
     //
     class GMatx* pMatx = NULL;
     Data_Get_Struct(self, class GMatx, pMatx);
@@ -110,11 +110,11 @@ static VALUE row_hash_to_ruby_hash(const t_key_value_hash& row_hash)
 
 static VALUE t_get_row(VALUE self, VALUE id)
 {
-    // 处理id
+    // 处理id      deal with id
     //
     VALUE id_str = rb_funcall(id, rb_intern("to_s"), 0);
     char* p_id_c_str = StringValuePtr(id_str);
-    // id 为空字符串
+    // id 为空字符串   check whether id blank
     if (p_id_c_str[0] == 0)
         rb_raise(rb_eTypeError, "id can't be blank!");
 

data/lib/s_matrix/version.rb

@@ -1,5 +1,5 @@
 class SMatrix
-  VERSION = "0.0.3"
+  VERSION = "1.0.0"
 end
 
 require "s_matrix/s_matrix"

data/lib/s_matrix.rb

@@ -4,7 +4,7 @@ require 's_matrix'
 
 
 class SMatrix
-  def self.test
-    3
+  def [](index)
+    self.get_row(index.to_s)
   end
 end

data/s_matrix.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake-compiler", "~> 0.9"
 
 
-  # 临时添加测试用
-  spec.add_development_dependency "plist", "~> 3.1.0"
+  # for testing
+  spec.add_development_dependency "plist", "~> 3.1"
 end

data/spec/smatrix_spec.rb

@@ -85,6 +85,16 @@ describe SMatrix do
     end
   end
 
+  describe '[]' do
+    it '' do
+      a = SMatrix.new
+      a.add_row('2', {a: 2})
+      a.add_row('2', {b: 3})
+      expect(a['2']).to eq({'a' => nil, 'b' => '3'})
+      expect(a['2'][:a]).to eq nil
+      expect(a['2']['b']).to eq '3'
+    end
+  end
 
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s_matrix
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - zhangyuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-27 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.1'
 description: not finish
 email:
 - libinzhangyuan@gmail.com
@@ -92,6 +92,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- README_for_contributor.md
 - Rakefile
 - ext/s_matrix/Makefile
 - ext/s_matrix/extconf.rb