active_flag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1eab2c1d74e4f219e5fa9c3518fdc65efb97cb76
+  data.tar.gz: 9e694fdbf84d951e190d5986738f49d3adfb2c8e
+SHA512:
+  metadata.gz: 2cf6ca0d48b366dc48de2278225827a8ada2fa797cacaa62514d14d180f4c4948f11741eee3e7fc5fac3944090ff0fe6532f565b60539e6ae47576b8f9474d40
+  data.tar.gz: 3b802d4cc801ad8ad3b95dc55bca376712f06cf2c1776a51643b0f5092555901f8344f5be17e16da9b101d4b4296de838108ad52ec34d37819a51e668565aa5a

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,118 @@
+# ActiveFlag - Bit array for ActiveRecord
+
+[![Build Status](https://travis-ci.org/kenn/active_flag.svg)](https://travis-ci.org/kenn/active_flag)
+
+Store up to 64 multiple flags ([bit array](https://en.wikipedia.org/wiki/Bit_array)) in a single integer column with ActiveRecord.
+
+## Usage
+
+```ruby
+class Profile < ActiveRecord::Base
+  flag :languages, [:english, :spanish, :chinese, :french, :japanese]
+end
+
+# Instance methods
+profile.languages                           #=> #<ActiveFlag::Value: {:english, :japanese}>
+profile.languages.english?                  #=> true
+profile.languages.set(:spanish)
+profile.languages.unset(:japanese)
+profile.languages.raw                       #=> 3
+profile.languages.to_a                      #=> [:english, :spanish]
+
+profile.languages = [:spanish, :japanese]   # Direct assignment that works with forms
+
+# Class methods
+Profile.languages.maps                #=> {:english=>1, :spanish=>2, :chinese=>4, :french=>8, :japanese=>16 }
+Profile.where_languages(:french)      #=> SELECT * FROM profiles WHERE languages & 8 > 0
+```
+
+## Install
+
+```ruby
+gem 'active_flag'
+```
+
+### Migration
+
+Always set `0` as a default.
+
+```ruby
+t.integer :languages,                    null: false, default: 0, limit: 8
+# OR
+add_column :users, :languages, :integer, null: false, default: 0, limit: 8
+```
+
+`limit: 8` is only required if you need more than 32 flags.
+
+## Query
+
+For a querying purpose, use `where_[column]` scope.
+
+```ruby
+Profile.where_languages(:french)      #=> SELECT * FROM profiles WHERE languages & 8 > 0
+```
+
+Also takes multiple values.
+
+```ruby
+Profile.where_languages(:french, :spanish)
+```
+
+By default, it searches with `or` operation, so the query above returns profiles that have either French or Spanish.
+
+If you want to change it to `and` operation, you can specify:
+
+```ruby
+Profile.where_languages(:french, :spanish, op: :and)
+```
+
+## Translation
+
+`ActiveFlag` supports [i18n](http://guides.rubyonrails.org/i18n.html) just as ActiveModel does.
+
+For instance, create a Japanese translation in `config/locales/ja.yml`
+
+```yaml
+ja:
+  active_flag:
+    profile:
+      languages:
+        english: 英語
+        spanish: スペイン語
+        chinese: 中国語
+        french: フランス語
+        japanese: 日本語
+```
+
+and now `profile.languages.to_human` returns a translated string.
+
+```ruby
+I18n.locale = :ja
+profile.languages.to_human  #=> ['英語', 'スペイン語']
+
+I18n.locale = :en
+profile.languages.to_human  #=> ['English', 'Spanish']
+```
+
+## Forms
+
+Thanks to the translation support, forms just work as you would expect with the `pairs` convenience method.
+
+```ruby
+# With FormBuilder
+= form_for(@profile) do |f|
+  = f.collection_check_boxes :languages, Profile.languages.pairs
+
+# With SimpleForm
+= simple_form_for(@profile) do |f|
+  = f.input :languages, as: :check_boxes, collection: Profile.languages.pairs
+```
+
+## Other solutions
+
+There are plenty of gems that share the same goal. However they have messy syntax than necessary in my opinion, and I wanted a better API to achieve that goal.
+
+- [bitfields](https://github.com/grosser/bitfields)
+- [flag_shih_tzu](https://github.com/pboling/flag_shih_tzu)
+
+Also, `ActiveFlag` has one of the simplest code base that you can easily reason about or hack on.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/active_flag.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_flag/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_flag'
+  spec.version       = ActiveFlag::VERSION
+  spec.authors       = ['Kenn Ejima']
+  spec.email         = ['kenn.ejima@gmail.com']
+
+  spec.summary       = %q{Bit array for ActiveRecord}
+  spec.description   = %q{Bit array for ActiveRecord}
+  spec.homepage      = 'https://github.com/kenn/active_flag'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activerecord', '~> 4.2.0'
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'sqlite3'
+end

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'active_flag'
+
+require_relative '../test/load_fixtures'
+
+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/lib/active_flag.rb

@@ -0,0 +1,46 @@
+require 'active_flag/definition'
+require 'active_flag/railtie'
+require 'active_flag/value'
+require 'active_flag/version'
+require 'active_record'
+
+module ActiveFlag
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def flag(column, keys, options = {})
+      class << self
+        attr_reader :active_flags
+      end
+      @active_flags ||= {}
+      @active_flags[column] = Definition.new(column, keys, options, self)
+
+      # Getter
+      define_method column do
+        self.class.active_flags[column].get(self, read_attribute(column))
+      end
+
+      # Setter
+      define_method "#{column}=" do |arg|
+        self.class.active_flags[column].set(self, arg)
+      end
+
+      # Reference to definition
+      define_singleton_method column.to_s.pluralize do
+        active_flags[column]
+      end
+
+      # Scopes
+      define_singleton_method "where_#{column}" do |*args|
+        options = args.extract_options!
+        integer = active_flags[column].to_i(args)
+        column_name = connection.quote_table_name_for_assignment(table_name, column)
+        if options[:op] == :and
+          where("#{column_name} & #{integer} = #{integer}")
+        else
+          where("#{column_name} & #{integer} > 0")
+        end
+      end
+    end
+  end
+end

data/lib/active_flag/definition.rb

@@ -0,0 +1,70 @@
+module ActiveFlag
+  class Definition
+    attr_accessor :keys, :maps, :options, :column
+
+    def initialize(column, keys, options, klass)
+      @column = column
+      @keys = keys.freeze
+      @maps = Hash[keys.map.with_index{|key, i| [key, 2**i] }].freeze
+      @options = options
+      @klass = klass
+    end
+
+    def get(instance, integer)
+      to_value(instance, integer)
+    end
+
+    def set(instance, arg)
+      instance.send :write_attribute, @column, to_i(arg)
+    end
+
+    def humans
+      @humans ||= {}
+      @humans[I18n.locale] ||= begin
+        @keys.map{|key| [key, human(key)] }.to_h
+      end
+    end
+
+    def pairs
+      @pairs ||= {}
+      @pairs[I18n.locale] ||= humans.invert
+    end
+
+    # Set / unset a bit on all records for migration
+    # http://stackoverflow.com/a/12928899/157384
+
+    def set_all!(key)
+      @klass.update_all("#{@column} = COALESCE(#{@column},0) | #{@maps[key]}")
+    end
+
+    def unset_all!(key)
+      @klass.update_all("#{@column} = COALESCE(#{@column},0) & ~#{@maps[key]}")
+    end
+
+    def to_i(arg)
+      return 0 if arg.blank?
+      arg = [arg] unless arg.is_a?(Enumerable)
+      arg.map{|i| i && @maps[i.to_sym] || 0 }.sum
+    end
+
+  private
+
+    def to_value(instance, integer)
+      Value.new(@maps.map{|key, mask| (integer & mask > 0) ? key : nil }.compact).with(instance, self)
+    end
+
+    # Human-friendly print on class level
+    def human(key, options={})
+      return if key.nil? # otherwise, key.to_s.humanize will return ""
+      # Mimics ActiveModel::Translation.human_attribute_name
+      defaults = @klass.lookup_ancestors.map do |klass|
+        :"#{@klass.i18n_scope}.active_flag.#{klass.model_name.i18n_key}.#{@column}.#{key}"
+      end
+      defaults << :"active_flag.#{@klass.model_name.i18n_key}.#{@column}.#{key}"
+      defaults << :"active_flag.#{@column}.#{key}"
+      defaults << options.delete(:default) if options[:default]
+      defaults << key.to_s.humanize
+      I18n.translate defaults.shift, options.reverse_merge(count: 1, default: defaults)
+    end
+  end
+end

data/lib/active_flag/railtie.rb

@@ -0,0 +1,11 @@
+module ActiveFlag
+  if defined? Rails::Railtie
+    class Railtie < Rails::Railtie
+      initializer 'active_flag.insert_into_active_record' do |app|
+        ActiveSupport.on_load :active_record do
+          include ActiveFlag
+        end
+      end
+    end
+  end
+end

data/lib/active_flag/value.rb

@@ -0,0 +1,45 @@
+module ActiveFlag
+  class Value < Set
+    def with(instance, definition)
+      @instance = instance
+      @definition = definition
+      @column = definition.column
+
+      @definition.keys.each do |key|
+        self.class.class_eval do
+          define_method "#{key}?" do
+            @instance.send(@column).include?(key)
+          end 
+        end
+      end
+
+      return self
+    end
+
+    def raw
+      @instance.read_attribute(@column)
+    end
+
+    def to_human
+      @instance.send(@column).to_a.map{|key| @definition.humans[key] }
+    end
+
+    def set(key)
+      @instance.send "#{@column}=", add(key)
+    end
+
+    def unset(key)
+      @instance.send "#{@column}=", delete(key)
+    end
+
+    def set!(key, options={})
+      set(key)
+      @instance.save!(options)
+    end
+
+    def unset!(key, options={})
+      unset(key)
+      @instance.save!(options)
+    end
+  end
+end

data/lib/active_flag/version.rb

@@ -0,0 +1,3 @@
+module ActiveFlag
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: active_flag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kenn Ejima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+description: Bit array for ActiveRecord
+email:
+- kenn.ejima@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- active_flag.gemspec
+- bin/console
+- bin/setup
+- lib/active_flag.rb
+- lib/active_flag/definition.rb
+- lib/active_flag/railtie.rb
+- lib/active_flag/value.rb
+- lib/active_flag/version.rb
+homepage: https://github.com/kenn/active_flag
+licenses: []
+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.2
+signing_key: 
+specification_version: 4
+summary: Bit array for ActiveRecord
+test_files: []