bitfieldable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf3a1d7ed90f38d1356a6249e6746de19ee8192b18b6845abe0576ea78bcf589
+  data.tar.gz: b864d734fad1eab3d42bd8e1e168c919fba3818d7772039d6e095b017ffa681d
+SHA512:
+  metadata.gz: 0ddac27962ae67733bb2d670b5523a1022623f4886e5f844e21447ac8ae35aa1f13bb9e5de5e11196973ab194ad32ed1e17a24ec251de46654df3499467946ba
+  data.tar.gz: f0526cd7a9cce57cc97afa5e7b556becef8263945623e78fdb80a2736343c55a13af4426267d4404c171b2f36863f447ee93630990c960de413f56a4fa0c554f

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,52 @@
+AllCops:
+  TargetRubyVersion: 2.7.1
+  NewCops: enable
+
+Metrics/ClassLength:
+  Max: 1500
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Layout/DotPosition:
+  EnforcedStyle: leading
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineAssignmentLayout:
+  EnforcedStyle: same_line
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - class_methods

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bitfieldable.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    bitfieldable (0.1.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.4.3)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    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)
+    rubocop (0.88.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.2.0)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bitfieldable!
+  rake (~> 12.0)
+  rspec (~> 3.2)
+  rubocop
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Yasyf Mohamedali
+
+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,57 @@
+# Bitfieldable
+
+The `Bitfieldable` gem allows you to define a set of boolean flag attributes that are backed by a single integer bitfield.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bitfieldable'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bitfieldable
+
+## Usage
+
+For example, create a `User` model with an `int NOT NULL` field called `flags`, which defaults to 0.
+
+```ruby
+class User
+  include Bitfieldable::Concern
+
+  bitfields flags: %i[admin special shadowbanned]
+end
+
+user = User.new
+
+user.admin? # false
+user.admin!
+user.admin? # true
+user.flags # 1
+
+user.flip_special!
+user.special? # true
+user.flags # 3
+
+user.shadowbanned = true
+user.shadowbanned? # true
+user.flags # 7
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/yasyf/bitfieldable.
+

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bitfieldable'
+
+# 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/bitfieldable.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/bitfieldable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bitfieldable'
+  spec.version       = Bitfieldable::VERSION
+  spec.authors       = ['Yasyf Mohamedali']
+  spec.email         = ['yasyfm@gmail.com']
+
+  spec.summary       = 'Implement boolean flags as integer bitfields.'
+  spec.description   = 'The `Bitfieldable` gem allows you to define a set of boolean flag attributes that are backed by a single integer bitfield.'
+  spec.homepage      = 'https://github.com/yasyf/bitfieldable'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/yasyf/bitfieldable'
+
+  # 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(__dir__)) 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 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop'
+
+  spec.add_dependency 'activesupport'
+end

data/lib/bitfieldable.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bitfieldable/version'
+require 'bitfieldable/concern'

data/lib/bitfieldable/concern.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext'
+require 'active_support/concern'
+
+module Bitfieldable
+  module Concern
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def parse_spec(spec)
+        spec.each_with_object({}) do |(attr, fields), hsh|
+          fields.each_with_index do |field, idx|
+            hsh[field] = {
+              attribute: attr,
+              index: idx,
+            }
+          end
+        end.to_h.with_indifferent_access
+      end
+
+      def bitfields(**spec)
+        return if spec.blank?
+        @bitfields = parse_spec spec
+        define_bitfield_methods!
+      end
+
+      def bitfield_spec
+        instance_variable_defined?(:@bitfields) ? @bitfields : {}
+      end
+
+      def bitfield_keys
+        bitfield_spec.keys.map(&:to_sym)
+      end
+
+      def define_bitfield_methods!
+        bitfield_spec.each do |field, spec|
+          define_method(field) { read_bitfield(spec) }
+          define_method("#{field}?") { read_bitfield(spec) }
+          define_method("#{field}!") { write_bitfield(spec, true) }
+          define_method("flip_#{field}!") { write_bitfield(spec, !read_bitfield(spec)) }
+          define_method("#{field}=") { |value| write_bitfield(spec, value) }
+        end
+      end
+    end
+
+    private
+
+    def read_bitfield(spec)
+      value = send(spec[:attribute]) || 0
+      value[spec[:index]].positive?
+    end
+
+    def write_bitfield(spec, new_value)
+      value = send(spec[:attribute]) || 0
+      if new_value
+        value |= 1 << spec[:index]
+      else
+        value &= ~(1 << spec[:index])
+      end
+      send("#{spec[:attribute]}=", value)
+      value.positive?
+    end
+  end
+end

data/lib/bitfieldable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Bitfieldable
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: bitfieldable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yasyf Mohamedali
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The `Bitfieldable` gem allows you to define a set of boolean flag attributes
+  that are backed by a single integer bitfield.
+email:
+- yasyfm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bitfieldable.gemspec
+- lib/bitfieldable.rb
+- lib/bitfieldable/concern.rb
+- lib/bitfieldable/version.rb
+homepage: https://github.com/yasyf/bitfieldable
+licenses: []
+metadata:
+  homepage_uri: https://github.com/yasyf/bitfieldable
+  source_code_uri: https://github.com/yasyf/bitfieldable
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Implement boolean flags as integer bitfields.
+test_files: []