bit_set 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a550438abe4ced2c45d1c9f4ce131af1ff1774c5
+  data.tar.gz: a8fe4334ef7a7e012df35d46b9f9ebde5bfb22cc
+SHA512:
+  metadata.gz: 9ecdac54a146f3c81d3a52834968a321b86d240c0808fd7bf2408d43fd8564dbea13d79d21fd1c3bf5f9acad031b42c79f89d873d9e3728e7d73d590257a654a
+  data.tar.gz: 75d501dfdaec1271e5005c89564f7b7144d2be7aabb21cb0e5cbea73ad6b9b7c0159a7c6195e1c165dec6e7adbd1af4355c09f832f2a98d973977a3d8eeac3cf

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,12 @@
+# Project metadata
+nbproject
+.idea
+
+Gemfile.lock
+
+doc/api
+coverage
+pkg
+.yardoc
+.rbx
+*.rbc

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,54 @@
+language: ruby
+os:
+  - linux
+  - osx
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - rbx-2
+  - rbx-3.26
+matrix:
+  include:
+    - rvm: &jruby_1_7 jruby-19mode
+      jdk: openjdk6
+      os: linux
+    - rvm: *jruby_1_7
+      jdk: openjdk7
+      os: linux
+    - rvm: *jruby_1_7
+      jdk: oraclejdk7
+      os: linux
+    - rvm: *jruby_1_7
+      jdk: oraclejdk8
+      os: linux
+    - rvm: &jruby_9_0 jruby-9.0.5.0
+      jdk: openjdk6
+      os: linux
+    - rvm: *jruby_9_0
+      jdk: openjdk7
+      os: linux
+    - rvm: *jruby_9_0
+      jdk: oraclejdk7
+      os: linux
+    - rvm: *jruby_9_0
+      jdk: oraclejdk8
+      os: linux
+    - rvm: *jruby_1_7
+      os: osx
+    - rvm: *jruby_9_0
+      os: osx
+  allow_failures:
+    - rvm: 2.2 # Not available on Travis CI yet
+      os: osx
+    - rvm: 2.3.0 # Not available on Travis CI yet
+      os: osx
+    - rvm: *jruby_1_7 # Not available on Travis CI yet
+      os: osx
+    - rvm: *jruby_9_0 # JRuby 9.x does not support OpenJDK 6
+      jdk: openjdk6
+
+before_install:
+  - gem install bundler

data/.yardopts

@@ -0,0 +1,9 @@
+--output-dir=doc/api
+--embed-mixins
+--protected
+--no-private
+--markup-provider=kramdown
+--markup=markdown
+-
+HISTORY.md
+LICENSE.md

data/Gemfile

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+=begin
+Copyright GodObject Team <dev@godobject.net>, 2012-2016
+
+This file is part of BitSet.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+source 'https://rubygems.org'
+
+# Gem dependencies are specified in the .gemspec file
+gemspec
+
+gem 'coveralls', require: false

data/HISTORY.md

@@ -0,0 +1,6 @@
+0.1.0 / 2016-05-05
+==================
+
+* 1 major enhancement
+
+  * Birthday!

data/LICENSE.md

@@ -0,0 +1,15 @@
+Copyright GodObject Team <dev@godobject.net>, 2012-2016
+
+BitSet is licensed under the following ISC-style license:
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,435 @@
+BitSet
+======
+
+[![Gem Version](https://badge.fury.io/rb/bit_set.png)](https://badge.fury.io/rb/bit_set)
+[![Dependency Status](https://gemnasium.com/godobject/bit_set.png)](https://gemnasium.com/godobject/bit_set)
+[![Code Climate](https://codeclimate.com/github/godobject/bit_set.png)](https://codeclimate.com/github/godobject/bit_set)
+[![Build Status](https://secure.travis-ci.org/godobject/bit_set.png)](https://secure.travis-ci.org/godobject/bit_set)
+[![Coverage Status](https://coveralls.io/repos/github/godobject/bit_set/badge.svg?branch=master)](https://coveralls.io/github/godobject/bit_set?branch=master)
+
+* [Documentation][docs]
+* [Project][project]
+
+   [docs]:    http://rdoc.info/github/godobject/bit_set/
+   [project]: https://github.com/godobject/bit_set/
+
+Description
+-----------
+
+BitSet is a Ruby library implementing a bit set structure with labeled digits
+and binary logic operators. Additionally it allows to create precached
+configurations of BitSets which also allow the String representation to be
+customized easily.
+
+Features / Problems
+-------------------
+
+This project tries to conform to:
+
+* [Semantic Versioning (2.0.0)][semver]
+* [Ruby Packaging Standard (0.5-draft)][rps]
+* [Ruby Style Guide][style]
+* [Gem Packaging: Best Practices][gem]
+
+   [semver]: http://semver.org/spec/v2.0.0.html
+   [rps]:    http://chneukirchen.github.com/rps/
+   [style]:  https://github.com/bbatsov/ruby-style-guide
+   [gem]:    http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices
+
+Additional facts:
+
+* Written purely in Ruby.
+* Documented with YARD.
+* Automatically testable through RSpec.
+* Intended to be used with Ruby 1.9.3 or higher.
+* Cryptographically signed git tags.
+* This library was developed as part of the
+  [PosixMode](https://rubygems.org/gems/posix_mode) project.
+
+Shortcomings and problems:
+
+* BitSets with numbered but unnamed digits can't currently be handled.
+* The library is optimized for usability and not for computational efficiency.
+
+If you have solved any of these feel free to submit your changes back.
+
+Requirements
+------------
+
+* Ruby 1.9.3 or higher
+
+Installation
+------------
+
+On *nix systems you may need to prefix the command with `sudo` to get root
+privileges.
+
+### Gem
+
+    gem install bit_set
+
+### Automated testing
+
+Go into the root directory of the installed gem and run the following command
+to fetch all development dependencies:
+
+    bundle
+
+Afterwards start the test runner:
+
+    rake spec
+
+If something goes wrong you should be notified through failing examples.
+
+Usage
+-----
+
+This documentation defines the public interface of the software. The version
+number of the software tracks changes to this public interface as described in
+[Semantic Versioning][semver]. Do not use elements that are marked as private.
+These elements are not guaranteed to exist in otherwise compatible future
+versions. Should you really need some parts that are currently marked as
+private, please contact us. We might be able to expose them as public
+interface for your convenience.
+
+This is still experimental software, even the public interface may change
+substantially in future releases.
+
+   [semver]: http://semver.org/spec/v2.0.0.html
+
+### Ruby interface
+
+#### Loading
+
+In most cases you want to load the code by using the following command:
+
+~~~~~ ruby
+require 'bit_set'
+~~~~~
+
+In a bundler Gemfile you should use the following:
+
+~~~~~ ruby
+gem 'bit_set'
+~~~~~
+
+#### Namespace
+
+This project is contained within a namespace to avoid name collisions with
+other code. If you do not want to specifiy the namespace explicitly you can
+include it into the current scope by executing the following statement:
+
+~~~~~ ruby
+include GodObject::BitSet
+~~~~~
+
+The following documentation assumes that you did include the namespace.
+
+#### Creating a Configuration
+
+A configuration defines the amount of bits in the set and defines a unique name
+for each. The simplest way to create a configuration is to providing a list of
+symbols. In the concrete bit sets, each digit will then be represented by a "1"
+if it is enabled and a "0" if it is disabled.
+
+~~~~~
+Configuration.new([:red, :green, :blue])
+~~~~~
+
+Instead you can also provide each digit with a specificy "enabled"
+representation. The given String will be used to represent the specific digit
+when it is enabled. In case it is disabled a "-" will be displayed.
+
+~~~~~
+pixel_config = Configuration.new(
+  red: 'r',
+  green: 'g',
+  blue: 'b'
+)
+~~~~~
+
+One further option is to provide each digit with both specific "enabled" and
+"disabled" representations.
+
+~~~~~
+Configuration.new(
+  red: ['r', 'o'],
+  green: ['g', '!'],
+  blue: ['b', 'x']
+)
+~~~~~
+
+#### Creating a BitSet
+
+To create an actual BitSet based on a given configuration you can call the
+following:
+
+~~~~~
+bitset = pixel_config.new
+# => #<GodObject::BitSet: "---">
+~~~~~
+
+If you want to provide an initial state for the BitSet you can either list all
+enabled digits like this:
+
+~~~~~
+bitset = pixel_config.new(:red, :blue)
+# => #<GodObject::BitSet: "r-b">
+~~~~~
+
+Or you can set the initial state by giving an integer representation like this:
+
+~~~~~
+bitset = pixel_config.new(6)
+# => #<GodObject::BitSet: "rg-">
+~~~~~
+
+Additionally it is possible to create a BitSet by providing a
+Configuration object directly:
+
+~~~~~
+bitset = BitSet.new(:blue, pixel_configuration)
+# => #<GodObject::BitSet: "--b">
+~~~~~
+
+Or by creating a Configuration definition on-the-fly:
+
+~~~~~
+bitset = BitSet.new(:green, red: 'r', green: 'g', blue: 'b')
+# => #<GodObject::BitSet: "-g-">
+~~~~~
+
+#### Examing a BitSet
+
+Each BitSet can be asked for the state of its individual digits:
+
+~~~~~
+bitset.red?
+# => false
+
+bitset.green?
+# => true
+
+bitset.blue?
+# => false
+~~~~~
+
+Or in a slightly different way:
+
+~~~~~
+bitset[:red]
+# => false
+
+bitset[:green]
+# => true
+
+bitset[:blue]
+# => false
+~~~~~
+
+You can also get a complete state-containing hash by the following:
+
+~~~~~
+bitset.state
+# => {:red=>false, :green=>true, :blue=>false}
+~~~~~
+
+Or a Set of all enabled/disabled digits:
+
+~~~~~
+bitset.enabled_digits
+# => #<Set: {:green}>
+
+bitset.disabled_digits
+# => #<Set: {:red, :blue}>
+~~~~~
+
+A String representation can be generated in the usual way:
+
+~~~~~
+bitset.to_s
+# => "-g-"
+~~~~~
+
+By default this will generate the long version, with both the enabled and the
+disabled digits represented. A short variant is available as long as each digit
+in the configuration has a unique enabled representation.
+
+~~~~~
+bitset.to_s(:short)
+# => "g"
+~~~~~
+
+An Integer representation of the BitSet is as well available in a
+straight-forward way:
+
+~~~~~
+bitset.to_s
+# => #<GodObject::BitSet::Configuration: … >
+~~~~~
+
+To gain access to the Configuration of the BitSet just use the following:
+
+~~~~~
+bitset.configuration
+# => 2
+~~~~~
+
+#### Comparison
+
+BitSets are considered equal when their state and configuration are equal.
+Configurations are considered equal when they have the same list of
+digits, without considering their String representations.
+
+Using the #eql? method for comparison also checks for class family
+compatibility.
+
+#### Operations
+
+A set of operations can be used upon BitSets. Notice that BitSets are immutable
+so that the results of the operations are always new BitSet objects.
+
+Each digit's state in a BitSet can be inverted like the following:
+
+~~~~~
+bitset.invert
+# => #<GodObject::BitSet: "r-b">
+~~~~~
+
+You can combine the enabled digits of two BitSets by adding them together:
+
+~~~~~
+pixel_config.new(:red) + pixel_config.new(:red, :blue)
+# => #<GodObject::BitSet: "r-b">
+~~~~~
+
+To disable all digits in a BitSet that are enabled in another you can subtract
+them from one another:
+
+~~~~~
+pixel_config.new(:red, :blue) - pixel_config.new(:green, :blue)
+# => #<GodObject::BitSet: "r--">
+~~~~~
+
+To produce a BitSet which has only those digits enabled which are enabled on
+both given BitSets you can calculate the intersection:
+
+~~~~~
+pixel_config.new(:red, :blue) ^ pixel_config.new(:green, :blue)
+# => #<GodObject::BitSet: "--b">
+~~~~~
+
+An to only have those digits enabled in the result which are enabled on only
+one of the given BitSets, calculate the symmetric difference:
+
+~~~~~
+pixel_config.new(:red, :blue).symmetric_difference(pixel_config.new(:green, :blue))
+# => #<GodObject::BitSet: "rg-">
+~~~~~
+
+Development
+-----------
+
+### Bug reports and feature requests
+
+Please use the [issue tracker][issues] on github.com to let us know about errors
+or ideas for improvement of this software.
+
+   [issues]: https://github.com/godobject/bit_set/issues/
+
+### Source code
+
+#### Distribution
+
+This software is developed in the source code management system Git. There are
+several synchronized mirror repositories available:
+
+* [GitHub][github] (located in California, USA)
+    
+    URI: https://github.com/godobject/bit_set.git
+
+* [GitLab][gitlab] (located in Illinois, USA)
+    
+    URI: https://gitlab.com/godobject/bit_set.git
+
+* [BitBucket][bitbucket] (located in California, USA)
+    
+    URI: https://bitbucket.org/godobject/bit_set.git
+
+* [Pikacode][pikacode] (located in France)
+
+    URI: https://pikacode.com/godobject/bit_set.git
+
+   [github]:    https://github.com/godobject/bit_set/
+   [gitlab]:    https://gitlab.com/godobject/bit_set/
+   [bitbucket]: https://bitbucket.org/godobject/bit_set/
+   [pikacode]:  https://pikacode.com/godobject/bit_set/
+
+You can get the latest source code with the following command, while
+exchanging the placeholder for one of the mirror URIs:
+
+    git clone MIRROR_URI
+
+#### Tags and cryptographic verification
+
+The final commit before each released gem version will be marked by a tag
+named like the version with a prefixed lower-case "v". Every tag will be signed
+by Alexander E. Fischer's [OpenPGP public key][openpgp] which enables you to
+verify your copy of the code cryptographically.
+
+   [openpgp]: https://aef.name/crypto/aef-openpgp.asc
+
+Add the key to your GnuPG keyring by the following command:
+
+    gpg --import aef-openpgp.asc
+
+This command will tell you if your code is of integrity and authentic:
+
+    git tag --verify [TAG NAME]
+
+#### Building gems
+
+To package your state of the source code into a gem package use the following
+command:
+
+    rake build
+
+The gem will be generated according to the .gemspec file in the project root
+directory and will be placed into the pkg/ directory.
+
+### Contribution
+
+Help on making this software better is always very appreciated. If you want
+your changes to be included in the official release, please clone the project
+on github.com, create a named branch to commit, push your changes into it and
+send a pull request afterwards.
+
+Please make sure to write tests for your changes so that no one else will break
+them when changing other things. Also notice that an inclusion of your changes
+cannot be guaranteed before reviewing them.
+
+The following people were involved in development:
+
+* Oliver Feldt <of@godobject.net>
+* Alexander E. Fischer <aef@godobject.net>
+* Axel Sorge <as@godobject.net>
+* Andreas Wurm <aw@godobject.net>
+
+License
+-------
+
+Copyright GodObject Team <dev@godobject.net>, 2012-2016
+
+This file is part of BitSet.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.