bits_in_bytes 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 863ddb8fc11c3726a64d316a850d81f10332a90b018f13fbb2f63576646808d6
-  data.tar.gz: 62805a853fdda87177f9d5c69e35f50e2e416f7487c976ff9a52c2b1e1b3ec36
+  metadata.gz: 5fee2b65cecbf81a180d8f488084ecdb318156728af08484136c2b89c87b6fd0
+  data.tar.gz: abbe2d5b610f681e55d165cd282009ca301feee9a018eb7ebe3403af354a9d2c
 SHA512:
-  metadata.gz: 12e3bec780442ec4b185e37c6ef16c6a6587f261d38e2115d81a5a8446633b70a34179286dbaf0bf4970e6fc7446a1902abc58096cd4ad4b8f734e17bf952069
-  data.tar.gz: f227b7160c97dd74603d800ab778570da140d1689de3d7508fdc27c6f293db810560cafd66ca7bb7ffab691ca6bdf4afc4718b81c1a58eacee0d0e3a2644a805
+  metadata.gz: 5044c967008eb994ef694f80bc168e0186a69bce53c3d5b17cbcb6df15da114148bfd74709d286dbc9793ddb00c8af34bd1fb38690785e0d6b5e7db620ffc979
+  data.tar.gz: d944481948d8fa06ea6686469beb4c4bf9384f4988b384a06a047e614c57caabcbd73ffc8806a7ca76441c560b0df31e17182690db25ff4b526122c9e1d7ede4

data/README.md

@@ -22,16 +22,20 @@ Or install it yourself as:
 ## Usage
 
 You can use the 'BitInByte' object to find out which bits are set in a given
-byte. The first argument is the position of the bit you would like to check,
-starting with the index value one. The second argument is the decimal byte value, which must not
-be bigger than 255.
+byte. The first argument is the position of the bit you would like to check.
+The position must be in the range of 1 to 8.
+The second argument is the actual byte value, which must be in the 
+range of 0 to 255. It may be a decimal, hex, octal or binary value.
 
 Simple examples:
 ```ruby
-puts BitInByte.new(8, 128).value # output -> true
-puts BitInByte.new(4, 8).value # output -> false
-puts BitInByte.new(1, 17).value # output -> true
-puts BitInByte.new(3, 64).value # output -> false
+BitInByte.new(8, 128).value # output -> true
+BitInByte.new(4, 8).value # output -> false
+BitInByte.new(1, 17).value # output -> true
+BitInByte.new(3, 64).value # output -> false
+BitInByte.new(5, 0x10).value # output -> true
+BitInByte.new(7, 0b00000011).value # output -> false
+BitInByte.new(2, 0o12).value # output -> true
 ```
 
 ## Development

data/bits_in_bytes.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["thexsalkin@gmail.com"]
 
   spec.summary       = "Gem to determine which bits are set in a byte"
-  spec.description   = "Gem which allows the user to determine which bits are set in a decimal byte value"
+  spec.description   = "Gem which allows the user to determine which bits are set inside a byte value"
   spec.homepage      = "https://github.com/SNException/bits_in_bytes"
   spec.license       = "MIT"
 

data/lib/core/bit_in_byte.rb

@@ -19,6 +19,15 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
+
+# The BitInByte object represents a single bit inside a byte value.
+# He accepts a postion of himself which must be in the range
+# of 1-8 and the actualbyte value which must be in the range of 0-255. 
+# The byte value may be decimal, hex, octal, or binary.
+#
+# author:: Niklas Schultz
+# version:: 0.1.2
+# license:: MIT
 class BitInByte
   def initialize(pos, byte)
     @pos = pos
@@ -26,8 +35,8 @@ class BitInByte
   end
 
   def value
-    raise ArgumentError, 'pos must 1-8' if @pos <= 0 || @pos > 8
-    raise ArgumentError, 'byte must 0-255' if @byte < 0 || @byte > 255
+    raise ArgumentError, 'pos must be 1-8' if @pos <= 0 || @pos > 8
+    raise ArgumentError, 'byte must be 0-255' if @byte < 0 || @byte > 255
 
     position = @pos - 1
     ((1 << position) & @byte) != 0

data/lib/core/version.rb

@@ -20,5 +20,5 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 module BitsInBytes
-  VERSION = "0.1.1"
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bits_in_bytes
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Niklas Schultz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-10 00:00:00.000000000 Z
+date: 2019-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,8 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-description: Gem which allows the user to determine which bits are set in a decimal
-  byte value
+description: Gem which allows the user to determine which bits are set inside a byte
+  value
 email:
 - thexsalkin@gmail.com
 executables: []