ffi-bitfield 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e2586353fd6f53337bf3ffef8019d477c279c0284642165fad4d592315ccc1a
-  data.tar.gz: 2772a6b9ef73faeccc105c501494d6fe82079614b6e23bab14de3954d1f1d1f2
+  metadata.gz: 6e82e912397a405df792824503984be18325c6c22b76307a0fc9d7fe65c5a95f
+  data.tar.gz: a3bbf7a5ecdcba6e4627c80e9a108788e281fc18f9d4abededf5d47833b0783d
 SHA512:
-  metadata.gz: 911015a3478c323f4469076489e68d7634d12188200dea1e8ae76263af368b992fb424c6f086cc46cb30aa501ca12326039a8a6a184524e2f54b6cb35f2495c1
-  data.tar.gz: 82951de5f89c776408d35e656a8ce100c1306899e808569dd181cd5c56bfbee961329ac989455b9814e5815928227e732d4ea1e8d21a09141fadcb00cce49760
+  metadata.gz: 76c80c9d0444042ad7ca1b8c28b084562c84b9ac843f0f23a3253444fefee3f4a959da752395d4fa43fc663aab4b1854bb5bd3e21b2550fca2b5c4cc8560ad4a
+  data.tar.gz: 33b72012820da5d15fcf1f753cd2a1203c3bd467b0d4596b429e7c46ba485bee91d45424142c4411996545054eb8f3bd368d53fa477cf7bde330c680689a9276

data/README.md

@@ -13,9 +13,21 @@ gem install ffi-bitfield
 
 ## Usage
 
+Classes
+
+* class BitStruct < FFI::Struct
+* class ManagedBitStruct < FFI::ManagedStruct
+
+Loading
+
 ```ruby
 require 'ffi/bit_struct'
+require 'ffi/managed_bit_struct'
+```
+
+Define your struct
 
+```ruby
 class Struct1 < FFI::BitStruct
   layout \
     :a, :uint8,
@@ -29,10 +41,14 @@ class Struct1 < FFI::BitStruct
     :y, 1,
     :z, 1
 end
+```
+
+Reading
 
+```ruby
 s = Struct1.new
-s[:a] = 63
 
+s[:a] = 63
 p s[:u] # 3
 p s[:v] # 3
 p s[:w] # 1
@@ -41,6 +57,19 @@ p s[:y] # 0
 p s[:z] # 0
 ```
 
+Writing
+
+```ruby
+s = Struct1.new
+
+s[:u] = 0
+s[:v] = 0
+s[:w] = 0
+s[:x] = 0
+s[:y] = 1
+p s[:a] # 64
+```
+
 ### Loading
 
 ```ruby
@@ -54,14 +83,6 @@ require 'ffi/bit_struct'
 require 'ffi/managed_bit_struct'
 ```
 
-## API Overview
-
-```md
-* module FFI
-  * class BitStruct < FFI::Struct
-  * class ManagedBitStruct < FFI::ManagedStruct
-```
-
 ## Development
 
 ```
@@ -71,11 +92,19 @@ bundle install
 bundle exec rake test
 ```
 
+* [ffi-bitfield - read/write bit fields with Ruby-FFI](https://dev.to/kojix2/ffi-bitfield-g4h)
+
 ## Contributing
 
+Your feedback is important.
+
 ffi-bitfield is a library under development, so even small improvements like typofix are welcome! Please feel free to send us your pull requests.
 Bug reports and pull requests are welcome on GitHub at https://github.com/kojix2/bitstruct.
 
+    Do you need commit rights to my repository?
+    Do you want to get admin rights and take over the project?
+    If so, please feel free to contact me @kojix2.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/ffi/bit_field/property.rb

@@ -19,7 +19,7 @@ module FFI
       def []=(member_name, value)
         parent_name, start, width = member_value_info(member_name)
         if parent_name
-          raise "Value #{value} is larger than bit_length: #{width}" if value.bit_length > width
+          raise ArgumentError, "Value #{value} is larger than bit_length: #{width}" if value.bit_length > width
 
           parent_value = get_member_value(parent_name)
           new_value = (((1 << width) - 1 << start) & parent_value ^ parent_value) |

data/lib/ffi/bit_field/version.rb

@@ -2,6 +2,6 @@
 
 module FFI
   module BitField
-    VERSION = '0.0.6'
+    VERSION = '0.0.7'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-bitfield
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-17 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -24,76 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: irb
-  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: minitest
-  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'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  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: bit fields for Ruby-FFI
 email:
 - 2xijok@gmail.com
@@ -128,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: bit fields for Ruby-FFI