Initial version.

Author: tunabay

Diff for: .ci/golangci-lint.yml

@@ -0,0 +1,62 @@
+run:
+  timeout: 5m
+  tests: false
+  fast: false
+  skip-dirs-use-default: true
+  print-issued-lines: true
+  print-linter-name: true
+
+linters:
+  disable-all: true
+  fast: false
+  enable:
+    - deadcode
+    - errcheck
+    - errname
+    - gosimple
+    - govet
+    - ineffassign
+    - staticcheck
+    - structcheck
+    - typecheck
+    - unused
+    - varcheck
+    - asciicheck
+    - bodyclose
+    - dogsled
+    - errorlint
+    - exportloopref
+    - forbidigo
+    - forcetypeassert
+    - goconst
+    - gocritic
+    - goerr113
+    - gofmt
+    - gofumpt
+    - goimports
+    - gomodguard
+    - goprintffuncname
+    - gosec
+    - ifshort
+    - importas
+    - misspell
+    - nakedret
+    - noctx
+    - nolintlint
+    - prealloc
+    - predeclared
+    - revive
+    - rowserrcheck
+    - sqlclosecheck
+    - stylecheck
+    - testpackage
+    - unconvert
+    - unparam
+    - wastedassign
+    - whitespace
+    - wrapcheck
+
+issues:
+  max-issues-per-linter: 1023
+  max-same-issues: 255
+  fix: false

Diff for: .github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: gomod
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "09:00"
+  open-pull-requests-limit: 30

Diff for: .github/workflows/go-test.yml

@@ -0,0 +1,34 @@
+name: go-test
+on:
+  push:
+    tags:
+      - v*
+    branches-ignore:
+      - 'doc-*'
+      - 'doc/*'
+  pull_request:
+    branches:
+      - main
+      - master
+      - release
+jobs:
+  go-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-go@v2
+        with:
+          go-version: ^1.17
+      - uses: actions/checkout@v2
+      - name: go-test
+        run: |
+          go test -v -count=1 \
+                  -covermode=count \
+                  -coverpkg=github.com/tunabay/go-bitarray \
+                  -coverprofile=cover.out \
+                  ./...
+          go tool cover -func=cover.out
+          go tool cover -html=cover.out -o go-test-coverage.html
+      - uses: actions/upload-artifact@v2
+        with:
+          path: go-test-coverage.html
+          retention-days: 3

Diff for: .github/workflows/golangci-lint.yml

@@ -0,0 +1,31 @@
+name: golangci-lint
+on:
+  push:
+    tags:
+      - v*
+    branches-ignore:
+      - 'doc-*'
+      - 'doc/*'
+  pull_request:
+    branches:
+      - main
+      - master
+      - release
+jobs:
+  golangci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-go@v2
+        with:
+          go-version: ^1.17
+      - uses: actions/checkout@v2
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v2
+        with:
+          version: v1.42
+          only-new-issues: true
+          skip-go-installation: true
+          args: >-
+            --verbose
+            --issues-exit-code=1
+            --config=.ci/golangci-lint.yml

Diff for: LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2021 Hirotsuna Mizuno - https://github.com/tunabay
+
+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.

Diff for: README.md

@@ -1 +1,55 @@
-# go-bitarray
+# go-bitarray
+
+[![Go Reference](https://pkg.go.dev/badge/github.com/tunabay/go-bitarray.svg)](https://pkg.go.dev/github.com/tunabay/go-bitarray)
+[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
+
+## Overview
+
+Package bitarray provides data types and functions for manipulating bit arrays,
+aka bit strings, of arbitrary length.
+
+This is designed to handle bit arrays across byte boundaries naturally, without
+error-prone bitwise operation code such as shifting, masking, and ORing. It may
+be useful when dealing with Huffman coding, raw packet of various protocols, and
+binary file formats, etc.
+
+## Usage
+
+```
+import (
+	"fmt"
+	"github.com/tunabay/go-bitarray"
+)
+
+func main() {
+	// Parse string representation
+	ba1, err := bitarray.Parse("111000")
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(ba1) // 111000
+
+	// Slice and Repeat
+	ba2 := ba1.Slice(2, 5).Repeat(2)
+	fmt.Println(ba2) // 100100
+
+	// Append
+	ba3 := ba2.Append(bitarray.MustParse("101011"))
+	// alternative formatting
+	fmt.Printf("% b\n", ba3) // 10010010 1011
+
+	// Extract bits from []byte across byte boundary
+	buf := []byte{0xff, 0x00}
+	ba4 := bitarray.NewFromBytes(buf, 4, 7)
+	fmt.Println(ba4) // 1111000
+}
+```
+[Run in Go Playground](https://play.golang.org/)
+
+## Documentation and examples:
+
+- Read the [documentation](https://pkg.go.dev/github.com/tunabay/go-bitarray).
+
+## License
+
+go-bitarray is available under the MIT license. See the [LICENSE](LICENSE) file for more information.

Diff for: alignment.go

@@ -0,0 +1,22 @@
+// Copyright (c) 2021 Hirotsuna Mizuno. All rights reserved.
+// Use of this source code is governed by the MIT license that can be found in
+// the LICENSE file.
+
+package bitarray
+
+// Alignment is used in some bitwise operations to specify whether the bits are
+// left-aligned or right-aligned. The zero value is AlignLeft.
+type Alignment bool
+
+const (
+	AlignLeft  Alignment = false
+	AlignRight Alignment = true
+)
+
+// String returns the string representation of Alignment.
+func (a Alignment) String() string {
+	if a == AlignLeft {
+		return "align-left"
+	}
+	return "align-right"
+}

Diff for: alignment_test.go

@@ -0,0 +1,29 @@
+// Copyright (c) 2021 Hirotsuna Mizuno. All rights reserved.
+// Use of this source code is governed by the MIT license that can be found in
+// the LICENSE file.
+
+package bitarray_test
+
+import (
+	"testing"
+
+	"github.com/tunabay/go-bitarray"
+)
+
+func TestAlignment_String(t *testing.T) {
+	var zero bitarray.Alignment
+	tcs := []struct {
+		a bitarray.Alignment
+		s string
+	}{
+		{zero, "align-left"},
+		{bitarray.AlignLeft, "align-left"},
+		{bitarray.AlignRight, "align-right"},
+	}
+	for _, tc := range tcs {
+		s := tc.a.String()
+		if s != tc.s {
+			t.Errorf("unexpected result: got %q, want %q", s, tc.s)
+		}
+	}
+}