simple_flaggable_column 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5519375f06815a7e44b9158d7c775fc9008c2d6a
-  data.tar.gz: e72384692c2244b58e966e9df850d398cb526c0f
+  metadata.gz: 3c89c0eff135320abf0a53dc93707c6c85fa0656
+  data.tar.gz: 64b94f3228a1b211cedcb76a5f98f03b13059b61
 SHA512:
-  metadata.gz: 10cd8c9d6d416277da37f339be37e875427b8ee76ecb86c53eda34cfb152e7ed96a0da5f4228d6a492db2cde6b998c6ca1afd8f018d5e8808fe656641041e0ce
-  data.tar.gz: d726167cc47139e3e9a4e98b30527b02f3814043cd6e909020893c40b4dd8901979d265e9007157dc93499b7e2d72e640fe60f0bf7e2555e1b06e940603d4433
+  metadata.gz: 5681dd1893fcb24894fb4a171e888eb0491563d9ca589ffa58645dbe1e869c76e7d63bbfb65d6cc1193c1ca5751d8ac1234d61b3df36dcf64fe16f965dacae78
+  data.tar.gz: be74c4d1388699fc686a2d0d47a916be8d6cf19f50147a6505540305d3f248283cfb8bbb610ecad0586e3209a26ce51b61f5cbdd5aa79f7912c7f5389884cba4

data/README.md

@@ -54,6 +54,38 @@ game.read_attribute(:platforms).to_s(2)
 
 Push/Pop and other arrays operations won't work, just simple writing and reading.
 
+### :throw_on_missing
+
+If you try to set a non-existing flag it will throw an ArgumentError
+
+```ruby
+game = Game.new
+game.platforms = [:potato]
+# => <ArgumentError: Flag potato doesn't exists>
+```
+
+To disable this and silently ignore invalid flags define the flags with :throw_on_missing set to false:
+
+```ruby
+class Game < ActiveRecord::Base
+  include SimpleFlaggableColumn
+
+  flag_column :platforms, {
+    win:   0b001,
+    mac:   0b010,
+    linux: 0b100
+  }, throw_on_missing: false
+end
+```
+
+Now invalid flags will be ignored
+
+```ruby
+game = Game.new
+game.platforms = [:win, :potato]
+# => [:win]
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/Zequez/simple_flaggable_column/fork )

data/lib/simple_flaggable_column.rb

@@ -4,8 +4,13 @@ require 'simple_flaggable_column/version'
 module SimpleFlaggableColumn
   extend ActiveSupport::Concern
 
-  def self.symbols_to_flags(symbols, symbols_flags)
-    symbols.map{|s| symbols_flags[s]}.compact.reduce(:|) || 0
+  def self.symbols_to_flags(symbols, symbols_flags, throw_on_missing = true)
+    symbols.map do |s|
+      if throw_on_missing && !symbols_flags[s]
+        throw ArgumentError.new("Flag #{s} doesn't exists")
+      end
+      symbols_flags[s]
+    end.compact.reduce(:|) || 0
   end
 
   def self.flags_to_symbols(flags, symbols_flags)
@@ -13,14 +18,22 @@ module SimpleFlaggableColumn
   end
 
   module ClassMethods
-    def flag_column(name, symbols_flags)
+    def flag_column(name, symbols_flags, options = {})
+      options = {
+        throw_on_missing: true
+      }.merge(options)
+
       flags_symbols = symbols_flags.invert
 
       define_singleton_method :"#{name}_flags" do |*symbols|
         if symbols.empty?
           symbols_flags
         else
-          SimpleFlaggableColumn.symbols_to_flags(symbols, symbols_flags)
+          SimpleFlaggableColumn.symbols_to_flags(
+            symbols,
+            symbols_flags,
+            options[:throw_on_missing]
+          )
         end
       end
 
@@ -32,7 +45,11 @@ module SimpleFlaggableColumn
         if symbols.nil?
           write_attribute name, 0
         elsif symbols.kind_of? Array
-          write_attribute name, SimpleFlaggableColumn.symbols_to_flags(symbols, symbols_flags)
+          write_attribute name, SimpleFlaggableColumn.symbols_to_flags(
+            symbols,
+            symbols_flags,
+            options[:throw_on_missing]
+          )
         else # numeric, or anything else
           write_attribute name, symbols
         end

data/lib/simple_flaggable_column/version.rb

@@ -1,3 +1,3 @@
 module SimpleFlaggableColumn
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/simple_flaggable_column/simple_flaggable_column_spec.rb

@@ -4,6 +4,7 @@ describe SimpleFlaggableColumn do
       def change
         create_table :games do |t|
           t.integer :platforms, default: 0, null: false
+          t.integer :softie, default: 0, null: false
         end
       end
     end
@@ -14,10 +15,15 @@ describe SimpleFlaggableColumn do
       include SimpleFlaggableColumn
 
       flag_column :platforms, {
-        win:   0b001,
-        mac:   0b010,
+        win:   0b1,
+        mac:   0b10,
         linux: 0b100
       }
+
+      flag_column :softie, {
+        vanilla:   0b1,
+        chocolate: 0b10
+      }, throw_on_missing: false
     end
   end
 
@@ -32,13 +38,6 @@ describe SimpleFlaggableColumn do
     expect(game.platforms).to match_array [:mac, :linux]
   end
 
-  it "should ignore items that aren't on the list" do
-    game = Game.new
-    game.platforms = [:mac, :linux, :potato]
-    expect(game.read_attribute(:platforms)).to eq 0b110
-    expect(game.platforms).to match_array [:mac, :linux]
-  end
-
   it 'should set the value to 0 when nil' do
     game = Game.new
     game.platforms = [:mac, :linux]
@@ -53,6 +52,25 @@ describe SimpleFlaggableColumn do
     expect(game.platforms).to eq [:win, :linux]
   end
 
+  context 'with throw_on_missing set to false' do
+    it 'should throw an exception when setting a non-existing flags' do
+      game = Game.new
+      expect{ game.platforms = [:potato] }.to raise_error ArgumentError
+    end
+  end
+
+  context 'with throw_on_missing set to true' do
+    it 'should not throw an exception when setting a non-existant flags' do
+      game = Game.new
+      expect{ game.softie = [:chocolate, :potato] }.to_not raise_error
+      expect(game.read_attribute(:softie)).to eq 0b10
+      expect(game.softie).to match_array [:chocolate]
+    end
+  end
+
+
+
+
   describe 'flags lists' do
     it 'should define the list of flags' do
       expect(Game.platforms_flags).to eq({

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_flaggable_column
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Zequez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-23 00:00:00.000000000 Z
+date: 2017-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport