ant-wireless 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0440d58876178ab22b480c72d95830474b407f7b1b366e518a7733a02abdd857
-  data.tar.gz: 2e0eb9be083381e57df2b13843894c33f43a957bff10a30fd06654fee41a5085
+  metadata.gz: abd16b62c0eb3b3e7e683fd46cca0382fa6b0400f23d8ae8a12de4455e66599a
+  data.tar.gz: c0e7b0571d2cb8285f072b23027b226ac4c472e0b2147faa34c1bd13d4c78aef
 SHA512:
-  metadata.gz: 8237b0332974c4bc1afc2697b4502bb0048dbc00e6caf3ca4f004bc71a0f854fa997b0239d961dd0a0681dbeb3d3bbc370407c4900812233c6ae0a00fef7dbb1
-  data.tar.gz: e2e8f4dff3fc5d60181bd1b7a9f8fa3b5e7683d0c56243ffa0c4645cccc2b1692f738e39fc7f09ea63affaa6d126e4e9a254efbcbb624df14f811a78ccf17e72
+  metadata.gz: 994058a2faa922f5d5469b9ab04aa5eecefaa6fdac4921a035a9bfe4f0ca58bea90a32f225c54d695f93b5cc27bcaf87ce2442b80160984944e7a04234eb0036
+  data.tar.gz: 11f91861b51651d3cfba2309334ac4e9253a4ea9bc313bd0434f42eaa4a86e05d3659b11cfed13a85b162761b1913afb2da13d99faf58f1b14cf53b52fb03da3

data/History.md

@@ -1,6 +1,14 @@
 # Release History for ruby-ant
 
 ---
+## v0.2.1 [2021-09-30] Michael Granger <ged@FaerieMUD.org>
+
+Bugfixes:
+
+- Add missing files to the manifest
+
+
+
 ## v0.2.0 [2021-09-22] Michael Granger <ged@FaerieMUD.org>
 
 Enhancements:

data/lib/ant/bitvector.rb

@@ -0,0 +1,197 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+# vim: set nosta noet ts=4 sw=4:
+
+require 'ant' unless defined?( Ant )
+
+# Ant::BitVector -- a convenience class for manipulating and
+# comparing bit vectors.
+#
+# This is a slightly-modified version of the same utility in StaticCling.
+#
+# == Synopsis
+#
+#   require 'ant/bitvector'
+#
+#   vector = Ant::BitVector.new
+#
+#   vector.on( 4 )     # => 16
+#   vector.on( 12 )    # => 4112
+#   vector.toggle( 4 ) # => 4096
+#   vector.on?( 4 )    # => false
+#   vector.size        # => 13
+#   vector.to_hex      # => 0x1000
+#
+#   vector2 = Ant::BitVector.new( 5 )
+#   vector > vector2   # => true
+#
+#   vector2.each_with_index do |bit, i|
+#		puts "Bit %d is %s" % [ i + 1, bit.zero? ? 'off' : 'on' ]
+#	end
+#
+#		Bit 1 is on
+#		Bit 2 is off
+#		Bit 3 is on
+#
+# == Version
+#
+#  $Id$
+#
+# == Author
+#
+# * Mahlon E. Smith <mahlon@martini.nu>
+#
+# == License
+#
+# Copyright (c) 2000-2013, Mahlon E. Smith <mahlon@martini.nu>
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#     * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#
+#     * Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#
+#     * Neither the name of the author, nor the names of contributors may be
+#     used to endorse or promote products derived from this software without
+#     specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+class Ant::BitVector
+	include Enumerable,
+		Comparable
+
+	### Create a new bit vector object, optionally from a pre-existing
+	### +init+ number (Any number that ruby supports natively should be
+	### fine -- 0b, 0x, or decimal.)
+	def initialize( init=0 )
+		unless init.respond_to?( :to_i )
+			raise ArgumentError, "I don't know what to do with a %s object." % [ init.class.name ]
+		end
+
+		@bv = init.to_i
+	end
+
+
+	######
+	public
+	######
+
+	# let any additional methods fall through to Fixnum/Bignum objs,
+	# and return new vector objects.  This allows for doing bitwise math
+	# or simple addition/subtraction on two BitVector objects.
+	%w{ % & * ** + - / << >> ^ | ~ }.each do |op|
+		define_method( op.to_sym ) do |arg|
+			res = @bv.send( op.to_sym, arg.bv )
+			return self.class.new( res )
+		end
+	end
+
+
+	##
+	# Allow external access to the underlying Fixnum/Bignum
+	attr_reader :bv
+
+
+	### Return the bit vector as a decimal.
+	def to_i
+		return @bv
+	end
+	alias_method :to_int, :to_i
+	alias_method :to_dec, :to_i
+
+
+	### Return the bit vector as a binary string.
+	def to_bin
+		return "0b%s" % @bv.to_s(2)
+	end
+
+
+	### Return the bit vector as a hexidecimal string.
+	def to_hex
+		return "0x%04x" % @bv
+	end
+
+
+	### Return the length of the vector in bytes.
+	def size
+		return @bv.to_s(2).length
+	end
+
+
+	### Switch a +bit+ on.
+	def on( bit )
+		@bv = @bv | ( 1 << bit )
+	end
+
+
+	### Return boolean true if given +bit+ is currently on.
+	def on?( bit )
+		return @bv[ bit ].zero? ? false : true
+	end
+	alias_method :[], :on?
+
+
+	### Switch a +bit+ off.
+	def off( bit )
+		@bv = @bv & ~( 1 << bit )
+	end
+
+
+	### Return boolean true if given +bit+ is currently +off+.
+	def off?( bit )
+		return ! self.on?( bit )
+	end
+
+
+	### Swap the current state of the given +bit+.
+	def toggle( bit )
+		@bv = @bv ^ ( 1 << bit )
+	end
+	alias_method :flip, :toggle
+
+
+	### Set a +bit+ to +bool+ -- either true (on) or false (off).
+	### Any value other than nil or false is treated as true.
+	### This form also accepts ranges of bits, a la: vector[ 1..4 ] = true
+	def []=( bit, bool )
+		if bit.respond_to?( :each )
+			bit.each { |b| bool ? self.on( b ) : self.off( b ) }
+		else
+			bool ? self.on( bit ) : self.off( bit )
+		end
+	end
+
+
+	### Yield each binary position, least significant +bit+ first.
+	def each
+		@bv.to_s(2).reverse.each_byte do |bit|
+			yield bit.chr.to_i
+		end
+	end
+
+
+	### Comparision operator for Comparable mixin, fallthrough to
+	### Fixnum/Bignum.  Compares current state against +cmp+.
+	def <=>( cmp )
+		@bv <=> cmp.bv
+	end
+
+end # class Ant::BitVector
+

data/lib/ant.rb

@@ -12,7 +12,7 @@ module Ant
 	extend Loggability
 
 	# Package version
-	VERSION = '0.2.0'
+	VERSION = '0.2.1'
 
 	# A Range for matching valid ANT device numbers
 	VALID_DEVICE_NUMBERS = ( 0...65535 ).freeze

data/spec/bitvector_spec.rb

@@ -0,0 +1,141 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+require 'ant/bitvector'
+
+
+RSpec.describe( Ant::BitVector ) do
+
+	context 'when first instantiated' do
+
+		it "is empty when created without arguments" do
+			v = described_class.new
+			expect( v.to_i ).to eq( 0 )
+			expect( v.size ).to eq( 1 )
+		end
+
+
+		it "accepts a decimal argument" do
+			v = described_class.new( 242 )
+			expect( v.to_hex ).to eq( '0x00f2' )
+		end
+
+
+		it "accepts a hexadecimal argument" do
+			v = described_class.new( 0x00f2 )
+			expect( v.to_i ).to eq( 242 )
+		end
+
+
+		it "accepts a bit string argument" do
+			v = described_class.new( 0b11110010 )
+			expect( v.to_i ).to eq( 242 )
+		end
+
+
+		it "accepts a different BitVector argument" do
+			v = described_class.new( described_class.new( 242 ) )
+			expect( v.to_i ).to eq( 242 )
+		end
+
+
+		it "accepts a string argument" do
+			v = described_class.new( "242" )
+			expect( v.to_i ).to eq( 242 )
+		end
+
+
+		it "rejects objects that don't have a 'to_i' method" do
+			expect {
+				described_class.new( Class )
+			}.to raise_error( ArgumentError, /don't know what to do/i )
+		end
+
+	end
+
+
+	context 'after modified with a value' do
+
+		let( :bv ) { described_class.new( 242 ) }
+
+
+		it "can be converted into various formats" do
+			expect( bv.to_int ).to eq( 242 )
+			expect( bv.to_hex ).to eq( '0x00f2' )
+			expect( bv.to_bin ).to eq( '0b11110010' )
+		end
+
+
+		it "knows the size of its own bit string" do
+			expect( bv.size ).to eq( 8 )
+			bv.toggle( 9 )
+			expect( bv.size ).to eq( 10 )
+		end
+
+
+		it "can switch specific bits on and off" do
+			expect( bv.on?( 12 ) ).to be_falsey
+
+			bv.on( 12 )
+			expect( bv[12] ).to be_truthy
+
+			bv.off( 12 )
+			expect( bv.off?( 12 ) ).to be_truthy
+
+			bv[12] = true
+			expect( bv.on?( 12 ) ).to be_truthy
+		end
+
+
+		it "can set bits in a range" do
+			expect( bv[ 8] ).to be_falsey
+			expect( bv[ 9] ).to be_falsey
+			expect( bv[10] ).to be_falsey
+			expect( bv[11] ).to be_falsey
+			expect( bv[12] ).to be_falsey
+
+			bv[8..12] = true
+
+			expect( bv[ 8] ).to be_truthy
+			expect( bv[ 9] ).to be_truthy
+			expect( bv[10] ).to be_truthy
+			expect( bv[11] ).to be_truthy
+			expect( bv[12] ).to be_truthy
+		end
+
+
+		it "delegates math operations to the underlying integer" do
+			bv2 = described_class.new( 4112 )
+
+			bv3 = bv + bv2
+			expect( bv3.to_int ).to eq( 4354 )
+
+			bv3 = bv | bv2
+			expect( bv3.to_int ).to eq( 4338 )
+
+			bv3 = bv & bv2
+			expect( bv3.to_int ).to eq( 16 )
+
+			expect( bv3 ).to be_a( described_class )
+		end
+
+
+		it "can compare different bitvector objects" do
+			bv1 = described_class.new( bv )
+			bv2 = described_class.new( 4112 )
+			expect( bv ).to eq( bv1 )
+			expect( bv ).to be < bv2
+		end
+
+
+		it "is enumerable" do
+			bits = bv.to_a
+			expect( bits ).to eq( [0, 1, 0, 0, 1, 1, 1, 1] )
+		end
+
+	end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ant-wireless
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Michael Granger
@@ -34,7 +34,7 @@ cert_chain:
   MCh97sQ/Z/MOusb5+QddBmB+k8EicXyGNl4b5L4XpL7fIQu+Y96TB3JEJlShxFD9
   k9FjI4d9EP54gS/4
   -----END CERTIFICATE-----
-date: 2021-09-22 00:00:00.000000000 Z
+date: 2021-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -106,6 +106,7 @@ files:
 - ext/ant_ext/version.h
 - lib/ant-wireless.rb
 - lib/ant.rb
+- lib/ant/bitvector.rb
 - lib/ant/channel.rb
 - lib/ant/channel/event_callbacks.rb
 - lib/ant/message.rb
@@ -113,6 +114,7 @@ files:
 - lib/ant/response_callbacks.rb
 - lib/ant/wireless.rb
 - spec/ant_spec.rb
+- spec/bitvector_spec.rb
 - spec/spec_helper.rb
 homepage: https://sr.ht/~ged/ruby-ant-wireless/
 licenses: