enummer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f7599c1e54a52e62cd02fa52bda47b02b108193508575c9c7e4d46e7e67deb0
+  data.tar.gz: 9b26e5c4c28e8229519dd3eb1fed85c725d953472b7442b4291196740b7c6561
+SHA512:
+  metadata.gz: 647d8fa2a18291044340ba71dc0ba0524c1e838ae1bb2187b54321c27888a0daa433cdd6ce132e7743a41b365540fdc3aa054e1f7c37c8813b4dc9bf1f1dff09
+  data.tar.gz: 5530474e36838b2189ad4d138520bd689e792086e8a1d5661d1b0846db5d17511e535ec7fab0c6969cdb82223ec33801fb990a843c62a099cf0527de2f287771

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Jamie Schembri
+
+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,41 @@
+# Enummer
+Enummer is a lightweight answer for adding enums with multiple values to Rails, with a similar syntax to Rails' built-in `enum`. It officially supports only PostgreSQL and recent Rails versions because I don't really care about anything else, but PRs are welcome.
+
+## Installation
+Add `gem "enummer"` to your Gemfile and `bundle`.
+
+## Usage
+Create a migration for a bitstring that looks something like this:
+
+```ruby
+class CreateUsers < ActiveRecord::Migration[7.0]
+  def change
+    create_table :users do |t|
+      t.column :permissions, "bit(8)"
+    end
+  end
+end
+```
+
+Now set up enummer with the available values in your model:
+
+```ruby
+enummer permissions: %i[read write execute]
+```
+
+Note that the limit is currently **required** — do not use variable bit fields. 1 bit gets you 1 option.
+
+*TODO*: a generator. Because.
+
+## Usage outside of Rails
+lol stop
+
+## Contributing
+Make an issue / PR and we'll see.
+
+## Alternatives
+- [flag_shih_tzu](https://github.com/pboling/flag_shih_tzu)
+- Lots of booleans
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/enummer/enummer_type.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "active_record/type"
+
+module Enummer
+  class EnummerType < ::ActiveRecord::Type::Value
+    attr_reader :bit_pairs
+
+    def initialize(value_names:, limit:)
+      @value_names = value_names
+      @bit_pairs = determine_bit_pairs(value_names)
+      @limit = limit
+    end
+
+    def type
+      "enummer[#{@value_names.join("|")}]".to_sym
+    end
+
+    def serialize(value)
+      return unless value
+
+      int = Array.wrap(value).sum { |value_name| @bit_pairs.fetch(value_name, 0) }
+
+      int.to_s(2).rjust(@limit, "0")
+    end
+
+    def deserialize(value)
+      return [] unless value
+
+      value = value.to_i(2)
+      @bit_pairs.each_with_object([]) do |(pair_name, pair_value), value_names|
+        next if (value & pair_value).zero?
+
+        value_names << pair_name
+      end
+    end
+
+    private
+
+    def determine_bit_pairs(value_names)
+      value_names.map.with_index do |name, shift|
+        [name, 1 << shift]
+      end.to_h
+    end
+  end
+end

data/lib/enummer/extension.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Enummer
+  module Extension
+    def enummer(values)
+      options = {}
+      options[:_prefix] = values.delete(:_prefix)
+      options[:_suffix] = values.delete(:_suffix)
+
+      name, values = values.first
+
+      limit = column_for_attribute(name).limit
+
+      attribute(name, :enummer, value_names: values, limit: limit)
+
+      singleton_class.__send__(:define_method, name) { values }
+
+      _enummer_build_with_scope(name, values, limit)
+      _enummer_build_values(name, values, limit, options)
+    end
+
+    private
+
+    def _enummer_build_values(attribute_name, value_names, limit, options)
+      value_names.each_with_index do |name, i|
+        method_name = _enummer_method_name(attribute_name, name, options)
+
+        define_method("#{method_name}?") { self[attribute_name].include?(name) }
+        define_method("#{method_name}=") do |new_value|
+          if new_value
+            self[attribute_name].push(name)
+          else
+            self[attribute_name].delete(name)
+          end
+        end
+        define_method("#{method_name}!") do
+          update(attribute_name => self[attribute_name] + [name])
+        end
+
+        bit_position = limit - i - 1
+
+        scope method_name, -> { where("get_bit(#{attribute_name}, ?) = 1", bit_position) }
+        scope "not_#{method_name}", -> { where("get_bit(#{attribute_name}, ?) = 0", bit_position) }
+      end
+    end
+
+    def _enummer_build_with_scope(attribute_name, value_names, limit)
+      scope "with_#{attribute_name}", lambda { |desired|
+        desired = Array.wrap(desired)
+
+        bitstring = (0..limit - 1).to_a.sum("") { |i| desired.include?(value_names[i]) ? "1" : "0" }.reverse
+
+        where("#{attribute_name} & :expected = :expected", expected: bitstring)
+      }
+    end
+
+    def _enummer_method_name(attribute_name, value_name, options)
+      prefix = _enummer_affix(attribute_name, options[:_prefix])
+      suffix = _enummer_affix(attribute_name, options[:_suffix])
+
+      [prefix, value_name, suffix].compact.join("_")
+    end
+
+    def _enummer_affix(attribute_name, value)
+      return unless value
+      return attribute_name if value == true
+
+      value
+    end
+  end
+end

data/lib/enummer/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Enummer
+  class Railtie < ::Rails::Railtie
+    initializer "enummer" do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Type.register(:enummer, EnummerType)
+        extend Enummer::Extension
+      end
+    end
+  end
+end

data/lib/enummer/version.rb

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

data/lib/enummer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Enummer; end
+
+require "enummer/version"
+require "enummer/enummer_type"
+require "enummer/extension"
+require "enummer/railtie"

data/lib/tasks/enummer_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :enummer do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: enummer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Schembri
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: Enummer implements multi-value enums with PostgreSQL bitstrings.
+email:
+- jamie@schembri.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/enummer.rb
+- lib/enummer/enummer_type.rb
+- lib/enummer/extension.rb
+- lib/enummer/railtie.rb
+- lib/enummer/version.rb
+- lib/tasks/enummer_tasks.rake
+homepage: https://github.com/shkm/enummer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shkm/enummer
+  source_code_uri: https://github.com/shkm/enummer
+  changelog_uri: https://github.com/shkm/enummer/CHANGELOG.md
+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.3.3
+signing_key:
+specification_version: 4
+summary: Multi-value enums for Rails
+test_files: []