barray 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7070bc266a2e93bb988db83a949d2a39a00389c5e51a9db1311c2e272c08b40f
+  data.tar.gz: 7fc745173d6c21c69277aee84d2428cb29ec98b2946de40452c705ff8cc0eef0
+SHA512:
+  metadata.gz: 8b956b0b633dbf6f892dfa731daacb8634c2a058b519b113f72523efe5c903b4121f4a42fa1f540929f5433d271543478ba9023ac755abf9568a9499e307992d
+  data.tar.gz: 71b6a6af639cf58aa576ca20f78c2e2ead9511f1d0bfd6f9b589536a296ed95bb451d6975cd8ea4acaf0880d5034322f1e1f8b300083145e94d20c27cd0d82db

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.gems
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at pvratsalis@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in barray.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    barray (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  barray!
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Pantelis Vratsalis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+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.

data/README.md

@@ -0,0 +1,101 @@
+# Barray
+
+Welcome to Barray! Barray is a ruby implementation of bit array that allows creating, querying, storing and restoring a bit array.
+
+Bit arrays are a compact, space efficient data structure that represent a group of boolean values. A very common use is in probabilistic data structures (like Bloom filter).
+
+Since Ruby does not have a bit or byte data structure, the underlying data structure that stores the bit array in Barray is a string. This makes it super easy to get and store the underlying string in e.g. a file and restore it (e.g. when a service that uses the bit array restarts after a crash or after a deployment).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'barray'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install barray
+
+## Usage
+
+In order to create a bit array, only its size is required:
+
+```ruby
+# Create a bit array that can store 100 bits
+arr = Barray::BitArray.new(100)
+```
+
+Some common operations on individual bits that Barray::BitArray supports:
+
+```ruby
+# set the 5th bit
+arr.set(5)
+
+# get the 5th bit
+arr.get(5)
+
+# unset the 5th bit
+arr.unset(5)
+
+# toggle the value of the 10th bit
+arr.toggle(10)
+
+# returns true if the bit is set
+arr.set?(10)
+```
+
+The set and unset operations are idempotent, as the final state of the bit is the same. This is not the case with toggle, as it changes the bit value from 1 to 0 or 0 to 1.
+
+Some operations that apply on the bit array itself:
+
+```ruby
+# resets the values of all bits to zero
+arr.reset
+
+# each_bit returns an iterator with the values of the bits
+arr.each_bit do |bit_value|
+  puts bit_value
+end
+
+# get the number of set bits
+arr.set_size
+
+# alternatively, get the number of unset bits
+arr.unset_size
+```
+
+Finally, it is very easy to dump the bit array's data (string), which can be used in order to store the bit array's value (e.g. in a file or in a database) and restore the bit array from that value:
+
+```ruby
+arr_value = arr.dump # this can be stored in a file or in a database
+
+# at another point (e.g. on service restart after a crash)
+new_arr = Barray::BitArray.new(100)
+new_arr.load(arr_value) # arr_value can be loaded from a file or a database
+```
+
+**Note**: The underlying string is duplicated, so loading a bit array is not affected by direct operations on the string value outside the Barray::BitArray public API.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/barray. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Barray project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/barray/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/barray.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "barray/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "barray"
+  spec.version       = Barray::VERSION
+  spec.authors       = ["Pantelis Vratsalis"]
+  spec.email         = ["pvratsalis@gmail.com"]
+
+  spec.summary       = %q{A bit array implemented in Ruby.}
+  spec.description   = %q{A bit array implemented in Ruby.}
+  spec.homepage      = "https://github.com/m1lt0n/barray"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/m1lt0n/barray"
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "barray"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/barray.rb

@@ -0,0 +1,92 @@
+require 'barray/version'
+
+module Barray
+  class InvalidPositionError < StandardError; end
+  class LossyOperationError < StandardError; end
+
+  class BitArray
+    attr_reader :size
+
+    def initialize(size)
+      @size = size
+      @byte_size = (size / 8.0).ceil
+      @data = init_data
+    end
+
+    def dump
+      data.dup
+    end
+
+    def load(data_in)
+      raise LossyOperationError, 'Data size exceeds array size' if data_in.bytesize > byte_size
+
+      self.data = data_in.dup << "\u0000" * (byte_size - data_in.bytesize)
+    end
+
+    def set(position)
+      ensure_position!(position)
+      data.setbyte(position / 8, (data.getbyte(position / 8) | (1 << (position % 8))))
+    end
+
+    def unset(position)
+      ensure_position!(position)
+      data.setbyte(position / 8, (data.getbyte(position / 8) & (255 ^ (1 << (position % 8)))))
+    end
+
+    def set?(position)
+      ensure_position!(position)
+      get(position) != 0
+    end
+
+    def get(position)
+      ensure_position!(position)
+      data.getbyte(position / 8) & (1 << (position % 8)) != 0 ? 1 : 0
+    end
+
+    def reset
+      init_data
+    end
+
+    def toggle(position)
+      ensure_position!(position)
+      data.setbyte(position / 8, (data.getbyte(position / 8) ^ (1 << (position % 8))))
+    end
+
+    def each_bit
+      return enum_for(:each_bit) unless block_given?
+
+      size.times do |bit_position|
+        yield get(bit_position)
+      end
+    end
+
+    def set_size
+      count = 0
+
+      data.each_byte do |byte|
+        next if byte.zero?
+
+        count += byte.to_s(2).split('').reject { |bit| bit == '0' }.length
+      end
+
+      count
+    end
+
+    def unset_size
+      size - set_size
+    end
+
+    private
+
+    attr_accessor :byte_size, :data
+    attr_writer :size
+
+    def init_data
+      self.data = "\u0000" * byte_size
+    end
+
+    def ensure_position!(position)
+      raise InvalidPositionError, 'Position cannot exceed size' if position >= size
+    end
+  end
+end

data/lib/barray/version.rb

@@ -0,0 +1,3 @@
+module Barray
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: barray
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pantelis Vratsalis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A bit array implemented in Ruby.
+email:
+- pvratsalis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- barray.gemspec
+- bin/console
+- bin/setup
+- lib/barray.rb
+- lib/barray/version.rb
+homepage: https://github.com/m1lt0n/barray
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/m1lt0n/barray
+  source_code_uri: https://github.com/m1lt0n/barray
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A bit array implemented in Ruby.
+test_files: []