active_flag 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1eab2c1d74e4f219e5fa9c3518fdc65efb97cb76
-  data.tar.gz: 9e694fdbf84d951e190d5986738f49d3adfb2c8e
+  metadata.gz: d91b4e83e18b7837784f5a39b0c9273b8e819a9b
+  data.tar.gz: 730b10b8a4af614ad6bc4a5f7c19fb535f486f77
 SHA512:
-  metadata.gz: 2cf6ca0d48b366dc48de2278225827a8ada2fa797cacaa62514d14d180f4c4948f11741eee3e7fc5fac3944090ff0fe6532f565b60539e6ae47576b8f9474d40
-  data.tar.gz: 3b802d4cc801ad8ad3b95dc55bca376712f06cf2c1776a51643b0f5092555901f8344f5be17e16da9b101d4b4296de838108ad52ec34d37819a51e668565aa5a
+  metadata.gz: 2149ba75280a6dbd098b4116e37513a6972ead377578fd2edebbb3f5d59513acc15f753c8fdd219f92dae71b5d9714685abfb5a4c8c6c15bf0c4b0190d367631
+  data.tar.gz: 1fc01029a9115d7769ad8d99954d58e60f0590a57bf126676982a852488c625568fff6815081bd3f73ad61d84e09fc01c58aba7c44942a122bbbe8152c896c86

data/README.md

@@ -2,7 +2,12 @@
 
 [![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.
+Store up to 64 multiple flags ([bit array](https://en.wikipedia.org/wiki/Bit_array)) in a single integer column with ActiveRecord. From a UI standpoint, it can be used as a  multi-select checkbox storage.
+
+Perfect solution to store multiple boolean values such as preferences, notification settings, achievement status, profile options, etc. in a single column.
+
+* **Single column to group multiple values.** You don't need to have many separate columns. You don't even need a migration when you add a new flag item to the list.
+* **Fast bitwise operations.** `WHERE languages & 3 > 0` is faster than `WHERE (english = true) OR (spanish = true) OR ...`
 
 ## Usage
 
@@ -22,8 +27,10 @@ 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
+Profile.where_languages(:french, :spanish)  #=> SELECT * FROM profiles WHERE languages & 10 > 0
+Profile.languages.maps                      #=> {:english=>1, :spanish=>2, :chinese=>4, :french=>8, :japanese=>16 }
+Profile.languages.set_all!(:chinese)        #=> UPDATE "profiles" SET languages = COALESCE(languages, 0) | 4
+Profile.languages.unset_all!(:chinese)      #=> UPDATE "profiles" SET languages = COALESCE(languages, 0) & ~4
 ```
 
 ## Install
@@ -49,13 +56,13 @@ add_column :users, :languages, :integer, null: false, default: 0, limit: 8
 For a querying purpose, use `where_[column]` scope.
 
 ```ruby
-Profile.where_languages(:french)      #=> SELECT * FROM profiles WHERE languages & 8 > 0
+Profile.where_languages(:french)            #=> SELECT * FROM profiles WHERE languages = 8
 ```
 
 Also takes multiple values.
 
 ```ruby
-Profile.where_languages(:french, :spanish)
+Profile.where_languages(:french, :spanish)  #=> SELECT * FROM profiles WHERE languages & 10 > 0
 ```
 
 By default, it searches with `or` operation, so the query above returns profiles that have either French or Spanish.
@@ -84,7 +91,7 @@ ja:
         japanese: 日本語
 ```
 
-and now `profile.languages.to_human` returns a translated string.
+and now `to_human` method returns a translated string.
 
 ```ruby
 I18n.locale = :ja

data/bin/console

@@ -5,5 +5,7 @@ require 'active_flag'
 
 require_relative '../test/load_fixtures'
 
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
 require 'irb'
 IRB.start

data/lib/active_flag/definition.rb

@@ -1,23 +1,14 @@
 module ActiveFlag
   class Definition
-    attr_accessor :keys, :maps, :options, :column
+    attr_reader :keys, :maps, :column
 
-    def initialize(column, keys, options, klass)
+    def initialize(column, keys, 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
@@ -34,25 +25,28 @@ module ActiveFlag
     # http://stackoverflow.com/a/12928899/157384
 
     def set_all!(key)
-      @klass.update_all("#{@column} = COALESCE(#{@column},0) | #{@maps[key]}")
+      @klass.update_all("#{@column} = COALESCE(#{@column}, 0) | #{@maps[key]}")
     end
 
     def unset_all!(key)
-      @klass.update_all("#{@column} = COALESCE(#{@column},0) & ~#{@maps[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
+      arg.map{|s| s && @maps[s.to_s.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)
+      Value.new(to_array(integer)).with(instance, self)
+    end
+
+    def to_array(integer)
+      @maps.map{|key, mask| (integer & mask > 0) ? key : nil }.compact
     end
 
+  private
+
     # Human-friendly print on class level
     def human(key, options={})
       return if key.nil? # otherwise, key.to_s.humanize will return ""

data/lib/active_flag/version.rb

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

data/lib/active_flag.rb

@@ -8,21 +8,21 @@ module ActiveFlag
   extend ActiveSupport::Concern
 
   module ClassMethods
-    def flag(column, keys, options = {})
+    def flag(column, keys)
       class << self
         attr_reader :active_flags
       end
       @active_flags ||= {}
-      @active_flags[column] = Definition.new(column, keys, options, self)
+      @active_flags[column] = Definition.new(column, keys, self)
 
       # Getter
       define_method column do
-        self.class.active_flags[column].get(self, read_attribute(column))
+        self.class.active_flags[column].to_value(self, read_attribute(column))
       end
 
       # Setter
       define_method "#{column}=" do |arg|
-        self.class.active_flags[column].set(self, arg)
+        write_attribute column, self.class.active_flags[column].to_i(arg)
       end
 
       # Reference to definition
@@ -38,7 +38,11 @@ module ActiveFlag
         if options[:op] == :and
           where("#{column_name} & #{integer} = #{integer}")
         else
-          where("#{column_name} & #{integer} > 0")
+          if integer & (integer - 1) == 0 # Power of 2, single bit
+            where("#{column_name} = #{integer}")
+          else
+            where("#{column_name} & #{integer} > 0")
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_flag
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kenn Ejima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-22 00:00:00.000000000 Z
+date: 2016-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord