bitfifo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd36212289b1bb01aafb67ac001e9a4f511b4534
+  data.tar.gz: eac39808f5e906f7c49ad38592dee9ce8b55f80d
+SHA512:
+  metadata.gz: 97afebebf73bcd2b6cafc4ed3eba1ccb242de35f1e64d2308b97897d8d7b64b36b6132731d2d191bf2be0c04efb9a0cf12e428a797ae7e75ac3f3ed5aa5a51f7
+  data.tar.gz: 7a405b407246b9a8aa04245be63bfa090fc8007d50dd2aec67804546617c52d82502e649452073975b8e7a3460386e74fe8f454535ab7d251e7844c0bd704b23

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at bryan@bdlsys.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Bryan Colvin
+
+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,90 @@
+# Bitfifo
+
+Bitfifo implements a FIFO for 1 or more bits of an Integer.
+This will be needed for a compression and encryption system.
+Could be used for any variable length integer based problems including base64 encode/decode.
+Includes bit reversals for LSB first or MSB first systems.
+No need to worry about overfill as a Bignum is used to store bits.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bitfifo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bitfifo
+
+## Usage
+
+A FIFO (first in first out) for variable length integers is a necessary component for data compression systems.
+Basically, what you put is what you get in the same order. See the example below:
+
+```ruby
+
+# single bits:
+fifo = Bitfifo.new
+fifo.put true       # converts true/false to 1/0
+fifo.get            # returns 1
+
+# multiple bits:
+fifo = Bitfifo.new
+fifo.put 99, 7      # store 7 bits of the number 99
+fifo.put 3,5        # store 5 bits of the number 3
+fifo.put 0xffff     # stores lsb bit only, others masked
+fifo.count          # >> 13  the number of stored bits
+fifo.get 7          # >> 99
+fifo.get 5          # >> 3
+
+# reverse bits:
+fifo = Bitfifo.new
+fifo.rput 0b11010101, 8  # store 213 in reverse bit order
+fifo.get 8               # >> 0b10101011 or 171
+Bitfifo.reverse(171,8)   # >> 213
+
+# what you reverse put, you reverse get
+fifo = Bitfifo.new
+fifo.rput 99, 7      # store 7 bits of the number 99
+fifo.rput 3,5        # store 5 bits of the number 3
+fifo.rget 7          # >> 99
+fifo.rget 5          # >> 3
+```
+
+The current methods are as follows:
+
+```ruby
+# instance methods:
+#count                 ... returns the number of stored bits
+#size                  ... same thing as count
+#put(data, nbits=nil)  ... stores `nbits` of data or a single bit if `nbits` not specified
+#rput(data, nbits=nil) ... reverses bit order of data, then calls #put
+#get(nbits=1)          ... retrieves nbits of data
+#rget(nbits=1)         ... retrieves nbits of data in reverse bit order
+#empty?                ... true if there is no data in FIFO
+#empty                 ... clears all data from FIFO, returns what was cleared.   
+
+# class method:
+# Bitfifo.reverse(data, nbits) ... returns reversed bit order of nbits worth of data. Other bits are masked.
+```
+
+## 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`. 
+
+## Contributing
+
+I need to control this for the time being
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bitfifo"
+
+# 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

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/bitfifo.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bitfifo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bitfifo"
+  spec.version       = Bitfifo::VERSION
+  spec.authors       = ["Bryan Colvin"]
+  spec.email         = ["bryan@bdlsys.com"]
+
+  spec.summary       = %q{FIFO system for 1 or more bits}
+  spec.description   = %q{Bitfifo implements a FIFO for 1 or more bits of an Integer.
+This will be needed for a compression and encryption system.
+Could be used for any variable length integer based problems including base64 encode/decode.
+Includes bit reversals for LSB first or MSB first systems.
+No need to worry about overfill as a Bignum is used to store bits.}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/bitfifo/version.rb

@@ -0,0 +1,3 @@
+class Bitfifo
+  VERSION = "0.1.0"
+end

data/lib/bitfifo.rb

@@ -0,0 +1,76 @@
+require "bitfifo/version"
+
+class Bitfifo
+  def self.reverse(data,nb)
+    data &= (1 << nb) - 1
+    rtn = 0
+    nb.times do |ii|
+      rtn <<= 1
+      rtn |= (data & 1)
+      data >>= 1
+    end
+    rtn
+  end
+
+  def initialize
+    @bits = 0
+    @size = 0
+    self
+  end
+
+  def put(data, nb=nil)
+    if nb.nil?
+      data=1 if data==true
+      data=0 if data==false
+      @bits <<= 1
+      @bits |= data & 1
+      @size += 1
+    else
+      mask = (1 << nb) - 1
+      data &= mask
+      @bits <<= nb
+      @bits |= data
+      @size += nb
+    end
+  end
+
+  def get(nb=1)
+    mask = (1 << nb) - 1
+    rtn = (@bits & (mask << (@size-nb))) >> (@size-nb)
+    @size -= nb
+    if @size < 0
+      @size=0
+      return nil
+    end
+    rtn
+  end
+  
+  def rput(data, nb=nil)
+    return put(data) if nb.nil?
+    put(self.class.reverse(data,nb),nb)
+  end
+
+  def rget(nb=1)
+    self.class.reverse(get(nb),nb)
+  end
+  
+  def size
+    @size
+  end
+
+  def count
+    @size
+  end
+
+  def empty
+    rtn = @bits
+    @bits = 0
+    @size = 0
+    rtn
+  end 
+
+  def empty?
+    @size==0
+  end
+ 
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: bitfifo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bryan Colvin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: |-
+  Bitfifo implements a FIFO for 1 or more bits of an Integer.
+  This will be needed for a compression and encryption system.
+  Could be used for any variable length integer based problems including base64 encode/decode.
+  Includes bit reversals for LSB first or MSB first systems.
+  No need to worry about overfill as a Bignum is used to store bits.
+email:
+- bryan@bdlsys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bitfifo.gemspec
+- lib/bitfifo.rb
+- lib/bitfifo/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: FIFO system for 1 or more bits
+test_files: []