bin_struct 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a90f75409d497521af8957e89577a4e8b7c14211e5343aa9126a71ef413d759
-  data.tar.gz: b07e2bf73d2cb1f4b7be4340944cd52df4382fc94f171607357adf10ddc7a914
+  metadata.gz: df710325cf6aa4414fc997d77033b8bea34d4dc80e571ceb184462b2aa047eb3
+  data.tar.gz: aa372402e27bc5b254b7e4e82cb7d9b2178823c84adc3c1bda17bba7806ff05e
 SHA512:
-  metadata.gz: 6acd7aeb0516bf6692ae5971aecb10c8ae685936f24302d909ff16f055118a68588876409819d0ba966e4f3a7b524b194e58713bfb0ccaef95eb542fca221bb3
-  data.tar.gz: 790bf0b81cef084c030e0412731e3b0b852815fa1f66f5d28564278579e12b7e3fd3ef3674c6f36dd32bc792e1c248f7f20b3f65f505d3193f370b2d8c6f1d88
+  metadata.gz: 6ef8207d1fc62509bda66a0caa779ec2b6b95e2a7805fb10199423bcf1300a7f05dd5c5b595f33f8b6605b93277e485a5a18f80a83b7c6954339eea0541f6073
+  data.tar.gz: b47f00bd2497c5330eeb6a01721b3cbd4a305d624e6df7dce2fd13b8f996c61e287ab92df393ea0fcb67fece0396497354220e9a56cb50bf617fa0d9b3ccdaff

data/CHANGELOG.md

@@ -3,6 +3,16 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.2.1 - 2024-11-25
+
+### Added
+
+- `CString` and `String` initializers now accepts `:value` option to set string initial value.
+
+### Changed
+
+- `IntString` initializer option `:string` is renamed into `:value`.
+
 ## 0.2.0 - 2024-07-21
 
 ### Changed

data/README.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/bin_struct.svg)](https://badge.fury.io/rb/bin_struct)
+[![Specs](https://github.com/lemontree55/bin_struct/actions/workflows/main.yml/badge.svg)](https://github.com/lemontree55/bin_struct/actions/workflows/main.yml)
+
 # BinStruct
 
 BinStruct provides a simple way to create and dissect binary data. It is an extraction from [PacketGen](https://github.com/lemontree55/packetgen) 3.x Fields.
@@ -6,9 +9,12 @@ BinStruct provides a simple way to create and dissect binary data. It is an extr
 
 Installation using RubyGems is easy:
 
-    $ gem install bin_struct
+```shell
+gem install bin_struct
+```
 
 Or add it to a Gemfile:
+
 ```ruby
 gem 'bin_struct'
 ```

data/lib/bin_struct/cstring.rb

@@ -76,8 +76,9 @@ module BinStruct
 
     # @param [Hash] options
     # @option options [Integer] :static_length set a static length for this string
+    # @option options [::String] :value string value (default to +''+)
     def initialize(options = {})
-      register_internal_string(+'')
+      register_internal_string(options[:value] || +'')
       @static_length = options[:static_length]
     end
 

data/lib/bin_struct/int_string.rb

@@ -20,9 +20,9 @@ module BinStruct
 
     # @param [Hash] options
     # @option options [Class] :length_type should be a {Int} subclass. Default to {Int8}.
-    # @option options [::String] :string String value. Default to +""+
+    # @option options [::String] :value String value. Default to +""+
     def initialize(options = {})
-      @string = BinStruct::String.new.read(options[:string] || '')
+      @string = BinStruct::String.new.read(options[:value] || +'')
       @length = (options[:length_type] || Int8).new
       calc_length
     end

data/lib/bin_struct/string.rb

@@ -32,8 +32,9 @@ module BinStruct
     # @option options [Int,Proc] :length_from object or proc from which
     #   takes length when reading
     # @option options [Integer] :static_length set a static length for this string
+    # @option options [::String] :value string value (default to +''+)
     def initialize(options = {})
-      register_internal_string(+'')
+      register_internal_string(options[:value] || +'')
       initialize_length_from(options)
       @static_length = options[:static_length]
     end

data/lib/bin_struct/version.rb

@@ -8,5 +8,5 @@
 
 module BinStruct
   # BinStruct version
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bin_struct
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - LemonTree55
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-21 00:00:00.000000000 Z
+date: 2024-11-25 00:00:00.000000000 Z
 dependencies: []
 description: 'BinStruct is a binary dissector and generator. It eases manipulating
   complex binary data.