flag_shih_tzu 0.3.2 → 0.3.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39037feb3a3b52c19a177cfdd173334d4f94d841
+  data.tar.gz: f5f735bb7b3cea9470b224fbc4dc43661b883bf4
+SHA512:
+  metadata.gz: d50b56dc9b3217ca2766f0795f92846ad0a88356ff38a3f3153283ac5f65c220d0be7f1a7a4c22a46d2538e45d2106b9b1d8df15e28a73ada846cc7d199753ed
+  data.tar.gz: 198b808f2f9004c159620075678939ff19efdb383c30a349d5940e68c39e250f159e2f05c73bb347e68e12ad5eb7c69b3b0d9ca525f6c9fed252f501727a0cd3

data/CHANGELOG

@@ -1,3 +1,18 @@
+Version 0.3.3 - JUN.20.2013
+* Allow non sequential flag numbers by Thomas Jachmann
+* Report correct source location for class_evaled methods. by Sebastian Korfmann
+* Implemented chained_flags_with, which allows optimizing the bit search by Tatsuhiko Miyagawa
+* [bugfix] flag_options[colmn][:column] is symbol, it causes error undefined method `length' for nil:NilClass by Artem Pisarev
+* Validator raises an error if the validated column is not a flags column. by David DIDIER
+* Allow multiple include by Peter Goldstein
+* fix a deprecation warning in rails4 by Mose
+* Add flag_keys convenience method. by Keith Pitty
+* [bugfix] Column names provided as symbols fully work now, as they are converted to strings by Peter Boling
+* [bugfix issues/28] Since 0.3.0 flags no longer work in a class using an alternative database connection by Peter Boling
+* [bugfix issues/7] Breaks db:create rake task by Peter Boling
+* convenience methods now have default parameter so `all_flags` works with arity 0. by Peter Boling
+* Many more tests, including arity tests by Peter Boling
+
 Version 0.3.2 - NOV.06.2012
 
 * Adds skip column check option :check_for_column - from arturaz

data/README.rdoc

@@ -1,23 +1,4 @@
-== Change of Ownership and 0.3.X Release Notes
-
-FlagShihTzu was originally a {XING AG}[http://www.xing.com/] project.  {Peter Boling}[http://peterboling.com] was a long time contributor and watcher of the project.
-In September 2012 XING transferred ownership of the project to Peter Boling.  Peter Boling had been maintaining a
-fork with extended capabilities.  These additional features become a part of the 0.3 line.  The 0.2 line of the gem will
-remain true to XING's original.  The 0.3 line aims to maintain complete parity and compatibility with XING's original as
-well.  I will continue to monitor other forks for original ideas and improvements. Pull requests are welcome, but please
-rebase your work onto the current master to make integration easier.
-
-Some new things in the 0.3 line:
-
-* ClassWithHasFlags.set_#{flag_name}_sql # Returns the sql string for setting a flag for use in customized SQL
-* ClassWithHasFlags.unset_#{flag_name}_sql # Returns the sql string for unsetting a flag for use in customized SQL
-* ClassWithHasFlags.flag_columns # Returns the column_names used by FlagShihTzu as bit fields
-* has_flags :strict => true # DuplicateFlagColumnException raised when a single DB column is declared as a flag column twice
-* Less verbosity for expected conditions when the DB connection for the class is unavailable.
-* Tests for additional features, but does not change any behavior of 0.2 versions by default.
-* Easily migrate from 0.2 versions. No code changes required.
-
-=FlagShihTzu
+=FlagShihTzu {<img src="https://secure.travis-ci.org/pboling/flag_shih_tzu.png" />}[http://travis-ci.org/pboling/flag_shih_tzu] {<img src="http://api.coderwall.com/pboling/endorsecount.png" />}[http://coderwall.com/pboling]
 
 Bit fields for ActiveRecord
 
@@ -25,8 +6,6 @@ An extension for {ActiveRecord}[https://rubygems.org/gems/activerecord]
 to store a collection of boolean attributes in a single integer column
 as a bit field.
 
-http://github.com/xing/flag_shih_tzu
-
 This gem lets you use a single integer column in an ActiveRecord model
 to store a collection of boolean attributes (flags). Each flag can be used
 almost in the same way you would use any boolean attribute on an
@@ -34,7 +13,7 @@ ActiveRecord object.
 
 The benefits:
 * No migrations needed for new boolean attributes. This helps a lot
-  if you have very large db-tables, on which you want to avoid ALTER TABLE
+  if you have very large db-tables, on which you want to avoid `ALTER TABLE`
   whenever possible.
 * Only the one integer column needs to be indexed.
 
@@ -44,11 +23,22 @@ without needing any migration. Just add a new flag to the +has_flags+ call.
 And just in case you are wondering what a "Shih Tzu" is:
 http://en.wikipedia.org/wiki/Shih_Tzu
 
+== Change of Ownership and 0.3.X Release Notes
+
+FlagShihTzu was originally a {XING AG}[http://www.xing.com/] project.  {Peter Boling}[http://peterboling.com] was a long time contributor and watcher of the project.
+In September 2012 XING transferred ownership of the project to Peter Boling.  Peter Boling had been maintaining a
+fork with extended capabilities.  These additional features become a part of the 0.3 line.  The 0.2 line of the gem will
+remain true to XING's original.  The 0.3 line aims to maintain complete parity and compatibility with XING's original as
+well.  I will continue to monitor other forks for original ideas and improvements. Pull requests are welcome, but please
+rebase your work onto the current master to make integration easier.
+
+More information on the changes for 0.3.X: {pboling/flag_shih_tzu/wiki/Changes-for-0.3.x}[https://github.com/pboling/flag_shih_tzu/wiki/Changes-for-0.3.x]
 
 ==Build status
 
-{<img src="https://secure.travis-ci.org/pboling/flag_shih_tzu.png" />}[http://travis-ci.org/pboling/flag_shih_tzu]
+Travis CI: {<img src="https://secure.travis-ci.org/pboling/flag_shih_tzu.png" />}[http://travis-ci.org/pboling/flag_shih_tzu]
 
+CodeClimate: https://codeclimate.com/github/pboling/flag_shih_tzu
 
 ==Prerequisites
 
@@ -377,11 +367,35 @@ and a helpful group of
 Thanks!
 
 Find out more about Peter Boling's work
-{PeterBoling.com}[http://peterboling.com/].
+{RailsBling.com}[http://railsbling.com/].
 
 Find out more about XING
 {Devblog}[http://devblog.xing.com/].
 
+== Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+6. Create new Pull Request
+
+== Versioning
+
+This library aims to adhere to {Semantic Versioning 2.0.0}[http://semver.org/].
+Violations of this scheme should be reported as bugs. Specifically, 
+if a minor or patch version is released that breaks backward 
+compatibility, a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will 
+only be introduced with new major versions.
+
+As a result of this policy, you can (and should) specify a 
+dependency on this gem using the {Pessimistic Version Constraint}[http://docs.rubygems.org/read/chapter/16#page74] with two digits of precision. 
+
+For example:
+
+    spec.add_dependency 'flag_shih_tzu', '~> 4.0'
 
 ==License
 

data/flag_shih_tzu.gemspec

@@ -5,6 +5,8 @@ require "flag_shih_tzu/version"
 Gem::Specification.new do |s|
   s.name        = "flag_shih_tzu"
   s.version     = FlagShihTzu::VERSION
+  s.licenses    = ['MIT']
+  s.email       = 'peter.boling@gmail.com'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Patryk Peszko", "Sebastian Roebke", "David Anderson", "Tim Payton"]
   s.homepage    = "https://github.com/xing/flag_shih_tzu"

data/lib/flag_shih_tzu.rb

@@ -1,6 +1,7 @@
 require "rubygems"
 require "active_record"
 require "active_support/all"
+require "flag_shih_tzu/validators"
 
 module FlagShihTzu
   # taken from ActiveRecord::ConnectionAdapters::Column
@@ -31,8 +32,15 @@ module FlagShihTzu
         :check_for_column => true
       }.update(opts)
       colmn = opts[:column].to_s
-
-      return if opts[:check_for_column] && ! check_flag_column(colmn)
+      if !is_valid_column_name(opts[:column])
+        puts "FlagShihTzu says: Please use a String to designate column names! I see you here: #{caller.first}"
+        opts[:column] = opts[:column].to_s
+      end
+      colmn = opts[:column]
+      if opts[:check_for_column] && !check_flag_column(colmn)
+        puts "FlagShihTzu says: Flag column #{colmn} appears to be missing!\nTo turn off this warning set check_for_colum: false in has_flags definition here: #{caller.first}"
+        return
+      end
 
       # options are stored in a class level hash and apply per-column
       self.flag_options ||= {}
@@ -55,8 +63,9 @@ module FlagShihTzu
         raise ArgumentError, "has_flags: flag name #{flag_name} already defined, please choose different name" if method_defined?(flag_name)
 
         flag_mapping[colmn][flag_name] = 1 << (flag_key - 1)
+        #puts "Defined: #{flag_key} as #{flag_mapping[colmn][flag_name]}"
 
-        class_eval <<-EVAL
+        class_eval <<-EVAL, __FILE__, __LINE__ + 1
           def #{flag_name}
             flag_enabled?(:#{flag_name}, '#{colmn}')
           end
@@ -96,7 +105,7 @@ module FlagShihTzu
         EVAL
 
         if colmn != DEFAULT_COLUMN_NAME
-          class_eval <<-EVAL
+          class_eval <<-EVAL, __FILE__, __LINE__ + 1
 
             def all_#{colmn}
               all_flags('#{colmn}')
@@ -131,7 +140,7 @@ module FlagShihTzu
 
         # Define bancg methods when requested
         if flag_options[colmn][:bang_methods]
-          class_eval <<-EVAL
+          class_eval <<-EVAL, __FILE__, __LINE__ + 1
             def #{flag_name}!
               enable_flag(:#{flag_name}, '#{colmn}')
             end
@@ -143,11 +152,20 @@ module FlagShihTzu
         end
 
         # Define the named scopes if the user wants them and AR supports it
-        if flag_options[colmn][:named_scopes] && respond_to?(named_scope_method)
-          class_eval <<-EVAL
-            #{named_scope_method} :#{flag_name}, lambda { { :conditions => #{flag_name}_condition } }
-            #{named_scope_method} :not_#{flag_name}, lambda { { :conditions => not_#{flag_name}_condition } }
-          EVAL
+        if flag_options[colmn][:named_scopes]
+          if ActiveRecord::VERSION::MAJOR == 2 && respond_to?(:named_scope)
+            # Prevent deprecation notices on Rails 3 when using +named_scope+ instead of +scope+.
+            class_eval <<-EVAL, __FILE__, __LINE__ + 1
+              named_scope :#{flag_name}, lambda { { :conditions => #{flag_name}_condition } }
+              named_scope :not_#{flag_name}, lambda { { :conditions => not_#{flag_name}_condition } }
+            EVAL
+          elsif respond_to?(:scope)
+            # Prevent deprecation notices on Rails 4 when using +conditions+ instead of +where+.
+            class_eval <<-EVAL, __FILE__, __LINE__ + 1
+              scope :#{flag_name}, lambda { where(#{flag_name}_condition) }
+              scope :not_#{flag_name}, lambda { where(not_#{flag_name}_condition) }
+            EVAL
+          end
         end
       end
 
@@ -173,8 +191,43 @@ module FlagShihTzu
       raise NoSuchFlagException.new("determine_flag_colmn_for: Couldn't determine column for your flags!")
     end
 
+    def chained_flags_with(*args)
+      where(chained_flags_condition(*args))
+    end
+
+    def chained_flags_condition(colmn, *args)
+      "(#{self.table_name}.#{colmn} in (#{chained_flags_values(colmn, *args).join(',')}))"
+    end
+
+    def flag_keys(colmn = DEFAULT_COLUMN_NAME)
+      flag_mapping[colmn].keys
+    end
+
     private
 
+      def max_flag_value_for_column(colmn)
+        flag_mapping[colmn].values.max
+      end
+
+      def chained_flags_values(colmn, *args)
+        val = (1..(2 * max_flag_value_for_column(colmn))).to_a
+        args.each do |flag|
+          neg = false
+          if flag.match /^not_/
+            neg = true
+            flag = flag.to_s.sub(/^not_/, '').to_sym
+          end
+          check_flag(flag, colmn)
+          flag_values = sql_in_for_flag(flag, colmn)
+          if neg
+            val = val - flag_values
+          else
+            val = val & flag_values
+          end
+        end
+        val
+      end
+
       def parse_options(*args)
         options = args.shift
         if args.size >= 1
@@ -191,22 +244,30 @@ module FlagShihTzu
       def check_flag_column(colmn, custom_table_name = self.table_name)
         # If you aren't using ActiveRecord (eg. you are outside rails) then do not fail here
         # If you are using ActiveRecord then you only want to check for the table if the table exists so it won't fail pre-migration
-        has_ar = !!defined?(ActiveRecord) && self.respond_to?(:descends_from_active_record?)
+        has_ar = (!!defined?(ActiveRecord) && self.respond_to?(:descends_from_active_record?))
         # Supposedly Rails 2.3 takes care of this, but this precaution is needed for backwards compatibility
-        has_table = has_ar ? ActiveRecord::Base.connection.tables.include?(custom_table_name) : true
-
+        has_table = has_ar ? connection.tables.include?(custom_table_name) : true
         if has_table
           found_column = columns.find {|column| column.name == colmn}
           #If you have not yet run the migration that adds the 'flags' column then we don't want to fail, because we need to be able to run the migration
           #If the column is there but is of the wrong type, then we must fail, because flag_shih_tzu will not work
           if found_column.nil?
-            logger.warn("Error: Column '#{colmn}' doesn't exist on table '#{custom_table_name}'.  Did you forget to run migrations?") and return false
+            if respond_to?(:logger)
+              logger.warn("Error: Column '#{colmn}' doesn't exist on table '#{custom_table_name}'.  Did you forget to run migrations?") and return false
+            else
+              puts("Error: Column '#{colmn}' doesn't exist on table '#{custom_table_name}'.  Did you forget to run migrations?") and return false
+            end
           elsif found_column.type != :integer
             raise IncorrectFlagColumnException.new("Table '#{custom_table_name}' must have an integer column named '#{colmn}' in order to use FlagShihTzu.") and return false
           end
         else
           # ActiveRecord gem probably hasn't loaded yet?
-          logger.warn("FlagShihTzu#has_flags: Table '#{custom_table_name}' doesn't exist.  Have all migrations been run?") and return false
+          if respond_to?(:logger)
+            logger.warn("FlagShihTzu#has_flags: Table '#{custom_table_name}' doesn't exist.  Have all migrations been run?") if has_ar
+            return false
+          #else
+          #  puts("FlagShihTzu#has_flags: Table '#{custom_table_name}' doesn't exist.  Have all migrations been run?") and return false
+          end
         end
 
         true
@@ -232,10 +293,10 @@ module FlagShihTzu
       # returns an array of integers suitable for a SQL IN statement.
       def sql_in_for_flag(flag, colmn)
         val = flag_mapping[colmn][flag]
-        num = 2 ** flag_mapping[flag_options[colmn][:column]].length
+        num = 2 * max_flag_value_for_column(colmn)
         (1..num).select {|i| i & val == val}
       end
-    
+
       def sql_set_for_flag(flag, colmn, enabled = true, custom_table_name = self.table_name)
         check_flag(flag, colmn)
         "#{colmn} = #{colmn} #{enabled ? "| " : "& ~" }#{flag_mapping[colmn][flag]}"
@@ -249,6 +310,10 @@ module FlagShihTzu
         flag_name.is_a?(Symbol)
       end
 
+      def is_valid_column_name(colmn)
+        colmn.is_a?(String)
+      end
+
       # Returns the correct method to create a named scope.
       # Use to prevent deprecation notices on Rails 3 when using +named_scope+ instead of +scope+.
       def named_scope_method
@@ -291,32 +356,32 @@ module FlagShihTzu
     self[colmn] || 0
   end
 
-  def set_flags(value, colmn)
+  def set_flags(value, colmn = DEFAULT_COLUMN_NAME)
     self[colmn] = value
   end
 
-  def all_flags(column)
-    flag_mapping[column].keys
+  def all_flags(colmn = DEFAULT_COLUMN_NAME)
+    flag_mapping[colmn].keys
   end
 
-  def selected_flags(column)
-    all_flags(column).map { |flag_name| self.send(flag_name) ? flag_name : nil }.compact
+  def selected_flags(colmn = DEFAULT_COLUMN_NAME)
+    all_flags(colmn).map { |flag_name| self.send(flag_name) ? flag_name : nil }.compact
   end
 
-  def select_all_flags(column)
-    all_flags(column).each do |flag|
-      enable_flag(flag, column)
+  def select_all_flags(colmn = DEFAULT_COLUMN_NAME)
+    all_flags(colmn).each do |flag|
+      enable_flag(flag, colmn)
     end
   end
 
-  def unselect_all_flags(column)
-    all_flags(column).each do |flag|
-      disable_flag(flag, column)
+  def unselect_all_flags(colmn = DEFAULT_COLUMN_NAME)
+    all_flags(colmn).each do |flag|
+      disable_flag(flag, colmn)
     end
   end
 
-  def has_flag?(column = DEFAULT_COLUMN_NAME)
-    not selected_flags(column).empty?
+  def has_flag?(colmn = DEFAULT_COLUMN_NAME)
+    not selected_flags(colmn).empty?
   end
 
   private

data/lib/flag_shih_tzu/validators.rb

@@ -0,0 +1,54 @@
+module ActiveModel
+  module Validations
+
+    class PresenceOfFlagsValidator < EachValidator
+      def validate_each(record, attribute, value)
+        value = record.send(:read_attribute_for_validation, attribute)
+        check_flag(record, attribute)
+        record.errors.add(attribute, :blank, options) if value.blank? or value == 0
+      end
+
+      private
+
+      def check_flag(record, attribute)
+        unless record.class.flag_columns.include? attribute.to_s
+          raise ArgumentError.new("#{attribute} is not one of the flags columns (#{record.class.flag_columns.join(', ')})")
+        end
+      end
+    end
+
+    module HelperMethods
+      # Validates that the specified attributes are flags and are not blank.
+      # Happens by default on save. Example:
+      #
+      #  class Spaceship < ActiveRecord::Base
+      #    include FlagShihTzu
+      #
+      #    has_flags({ 1 => :warpdrive, 2 => :hyperspace }, :column => 'engines')
+      #    validates_presence_of_flags :engines
+      #  end
+      #
+      # The engines attribute must be a flag in the object and it cannot be blank.
+      #
+      # Configuration options:
+      # * <tt>:message</tt> - A custom error message (default is: "can't be blank").
+      # * <tt>:on</tt> - Specifies when this validation is active. Runs in all
+      #   validation contexts by default (+nil+), other options are <tt>:create</tt>
+      #   and <tt>:update</tt>.
+      # * <tt>:if</tt> - Specifies a method, proc or string to call to determine if
+      #   the validation should occur (e.g. <tt>:if => :allow_validation</tt>, or
+      #   <tt>:if => Proc.new { |user| user.signup_step > 2 }</tt>). The method, proc
+      #   or string should return or evaluate to a true or false value.
+      # * <tt>:unless</tt> - Specifies a method, proc or string to call to determine
+      #   if the validation should not occur (e.g. <tt>:unless => :skip_validation</tt>,
+      #   or <tt>:unless => Proc.new { |spaceship| spaceship.warp_step <= 2 }</tt>). The method,
+      #   proc or string should return or evaluate to a true or false value.
+      # * <tt>:strict</tt> - Specifies whether validation should be strict.
+      #   See <tt>ActiveModel::Validation#validates!</tt> for more information.
+      def validates_presence_of_flags(*attr_names)
+        validates_with PresenceOfFlagsValidator, _merge_attributes(attr_names)
+      end
+    end
+
+  end
+end

data/lib/flag_shih_tzu/version.rb

@@ -1,3 +1,3 @@
 module FlagShihTzu
-  VERSION = "0.3.2"
+  VERSION = "0.3.4"
 end

data/test/flag_shih_tzu_test.rb

@@ -54,6 +54,16 @@ class SpaceshipWith3CustomFlagsColumn < ActiveRecord::Base
   has_flags({ 1 => :power, 2 => :anti_ax_routine }, :column => 'hal3000')
 end
 
+class SpaceshipWithSymbolAndStringFlagColumns < ActiveRecord::Base
+  self.table_name = 'spaceships_with_symbol_and_string_flag_columns'
+  include FlagShihTzu
+
+  has_flags({ 1 => :warpdrive, 2 => :hyperspace }, :column => :peace, :check_for_column => true)
+  has_flags({ 1 => :photon, 2 => :laser, 3 => :ion_cannon, 4 => :particle_beam }, :column => :love, :check_for_column => true)
+  has_flags({ 1 => :power, 2 => :anti_ax_routine }, :column => 'happiness', :check_for_column => true)
+  validates_presence_of_flags :peace, :love
+end
+
 class SpaceshipWithBitOperatorQueryMode < ActiveRecord::Base
   self.table_name = 'spaceships'
   include FlagShihTzu
@@ -68,9 +78,44 @@ class SpaceshipWithBangMethods < ActiveRecord::Base
   has_flags(1 => :warpdrive, 2 => :shields, :bang_methods => true)
 end
 
+class SpaceshipWithMissingFlags < ActiveRecord::Base
+  self.table_name = 'spaceships'
+  include FlagShihTzu
+
+  has_flags 1 => :warpdrive,
+            3 => :electrolytes
+end
+
 class SpaceCarrier < Spaceship
 end
 
+class SpaceshipWithValidationsAndCustomFlagsColumn < ActiveRecord::Base
+  self.table_name = 'spaceships_with_custom_flags_column'
+  include FlagShihTzu
+
+  has_flags(1 => :warpdrive, 2 => :hyperspace, :column => 'bits')
+  validates_presence_of_flags :bits
+end
+
+class SpaceshipWithValidationsAnd3CustomFlagsColumn < ActiveRecord::Base
+  self.table_name = 'spaceships_with_3_custom_flags_column'
+  include FlagShihTzu
+
+  has_flags({ 1 => :warpdrive, 2 => :hyperspace }, :column => 'engines')
+  has_flags({ 1 => :photon, 2 => :laser, 3 => :ion_cannon, 4 => :particle_beam }, :column => 'weapons')
+  has_flags({ 1 => :power, 2 => :anti_ax_routine }, :column => 'hal3000')
+
+  validates_presence_of_flags :engines, :weapons
+end
+
+class SpaceshipWithValidationsOnNonFlagsColumn < ActiveRecord::Base
+  self.table_name = 'spaceships_with_custom_flags_column'
+  include FlagShihTzu
+
+  has_flags(1 => :warpdrive, 2 => :hyperspace, :column => 'bits')
+  validates_presence_of_flags :id
+end
+
 # table planets is missing intentionally to see if flagshihtzu handles missing tables gracefully
 class Planet < ActiveRecord::Base
 end
@@ -176,6 +221,11 @@ class FlagShihTzuClassMethodsTest < Test::Unit::TestCase
     assert_equal "(spaceships.flags in (4,5,6,7))", Spaceship.electrolytes_condition
   end
 
+  def test_should_define_a_sql_condition_method_for_flag_enabled_with_missing_flags
+    assert_equal "(spaceships.flags in (1,3,5,7))", SpaceshipWithMissingFlags.warpdrive_condition
+    assert_equal "(spaceships.flags in (4,5,6,7))", SpaceshipWithMissingFlags.electrolytes_condition
+  end
+
   def test_should_accept_a_table_alias_option_for_sql_condition_method
     assert_equal "(old_spaceships.flags in (1,3,5,7))", Spaceship.warpdrive_condition(:table_alias => 'old_spaceships')
   end
@@ -193,6 +243,11 @@ class FlagShihTzuClassMethodsTest < Test::Unit::TestCase
     assert_equal "(spaceships.flags not in (4,5,6,7))", Spaceship.not_electrolytes_condition
   end
 
+  def test_should_define_a_sql_condition_method_for_flag_not_enabled_with_missing_flags
+    assert_equal "(spaceships.flags not in (1,3,5,7))", SpaceshipWithMissingFlags.not_warpdrive_condition
+    assert_equal "(spaceships.flags not in (4,5,6,7))", SpaceshipWithMissingFlags.not_electrolytes_condition
+  end
+
   def test_should_define_a_sql_condition_method_for_flag_enabled_with_custom_table_name
     assert_equal "(custom_spaceships.flags in (1,3,5,7))", Spaceship.send(:sql_condition_for_flag, :warpdrive, 'flags', true, 'custom_spaceships')
   end
@@ -259,7 +314,7 @@ class FlagShihTzuClassMethodsTest < Test::Unit::TestCase
     Spaceship.update_all Spaceship.set_flag_sql(:warpdrive, true),
                          ["id=?", spaceship.id]
     spaceship.reload
-    
+
     assert_equal true, spaceship.warpdrive
     assert_equal true, spaceship.shields
     assert_equal true, spaceship.electrolytes
@@ -301,6 +356,33 @@ class FlagShihTzuClassMethodsTest < Test::Unit::TestCase
     assert_equal 0, Spaceship.not_warpdrive.not_shields.count
   end
 
+  def test_should_return_the_correct_condition_with_chained_flags
+    assert_equal "(spaceships.flags in (3,7))", Spaceship.chained_flags_condition("flags", :warpdrive, :shields)
+    assert_equal "(spaceships.flags in (7))", Spaceship.chained_flags_condition("flags", :warpdrive, :shields, :electrolytes)
+    assert_equal "(spaceships.flags in (2,6))", Spaceship.chained_flags_condition("flags", :not_warpdrive, :shields)
+  end
+
+  def test_should_return_the_correct_number_of_items_with_chained_flags_with
+    spaceship = Spaceship.new
+    spaceship.enable_flag(:warpdrive)
+    spaceship.enable_flag(:shields)
+    spaceship.save!
+    spaceship.reload
+    spaceship_2 = Spaceship.new
+    spaceship_2.enable_flag(:warpdrive)
+    spaceship_2.save!
+    spaceship_2.reload
+    spaceship_3 = Spaceship.new
+    spaceship_3.enable_flag(:shields)
+    spaceship_3.save!
+    spaceship_3.reload
+    assert_equal 2, Spaceship.chained_flags_with("flags", :warpdrive).count
+    assert_equal 1, Spaceship.chained_flags_with("flags", :warpdrive, :shields).count
+    assert_equal 1, Spaceship.chained_flags_with("flags", :warpdrive, :not_shields).count
+    assert_equal 0, Spaceship.chained_flags_with("flags", :not_warpdrive, :shields, :electrolytes).count
+    assert_equal 1, Spaceship.chained_flags_with("flags", :not_warpdrive, :shields, :not_electrolytes).count
+  end
+
   def test_should_not_define_named_scopes_if_not_wanted
     assert !SpaceshipWithoutNamedScopes.respond_to?(:warpdrive)
     assert !SpaceshipWithoutNamedScopesOldStyle.respond_to?(:warpdrive)
@@ -340,6 +422,18 @@ class FlagShihTzuClassMethodsTest < Test::Unit::TestCase
     end
   end
 
+  def test_should_not_error_out_when_column_is_not_present
+    assert_nothing_raised(ActiveRecord::StatementInvalid) do
+      Planet.class_eval do
+        # Now it has a table that exists, but the column does not.
+        self.table_name = 'spaceships'
+        include FlagShihTzu
+
+        has_flags({ 1 => :warpdrive, 2 => :hyperspace }, :column => :i_do_not_exist, :check_for_column => true)
+      end
+    end
+  end
+
   private
 
   def assert_where_value(expected, scope)
@@ -439,11 +533,15 @@ class FlagShihTzuInstanceMethodsTest < Test::Unit::TestCase
 
   # --------------------------------------------------
 
-  def test_should_define_an_all_flags_reader_method
+  def test_should_define_an_all_flags_reader_method_with_arity_1
     assert_array_similarity [:electrolytes, :warpdrive, :shields], @spaceship.all_flags('flags')
   end
 
-  def test_should_define_a_selected_flags_reader_method
+  def test_should_define_an_all_flags_reader_method_with_arity_0
+    assert_array_similarity [:electrolytes, :warpdrive, :shields], @spaceship.all_flags
+  end
+
+  def test_should_define_a_selected_flags_reader_method_with_arity_1
     assert_array_similarity [], @spaceship.selected_flags('flags')
 
     @spaceship.warpdrive = true
@@ -457,14 +555,35 @@ class FlagShihTzuInstanceMethodsTest < Test::Unit::TestCase
     assert_array_similarity [], @spaceship.selected_flags('flags')
   end
 
-  def test_should_define_a_select_all_flags_method
+  def test_should_define_a_selected_flags_reader_method_with_arity_0
+    assert_array_similarity [], @spaceship.selected_flags
+
+    @spaceship.warpdrive = true
+    assert_array_similarity [:warpdrive], @spaceship.selected_flags
+
+    @spaceship.electrolytes = true
+    assert_array_similarity [:electrolytes, :warpdrive], @spaceship.selected_flags
+
+    @spaceship.warpdrive = false
+    @spaceship.electrolytes = false
+    assert_array_similarity [], @spaceship.selected_flags
+  end
+
+  def test_should_define_a_select_all_flags_method_with_arity_1
     @spaceship.select_all_flags('flags')
     assert @spaceship.warpdrive
     assert @spaceship.shields
     assert @spaceship.electrolytes
   end
 
-  def test_should_define_an_unselect_all_flags_method
+  def test_should_define_a_select_all_flags_method_with_arity_0
+    @spaceship.select_all_flags
+    assert @spaceship.warpdrive
+    assert @spaceship.shields
+    assert @spaceship.electrolytes
+  end
+
+  def test_should_define_an_unselect_all_flags_method_with_arity_1
     @spaceship.warpdrive = true
     @spaceship.shields = true
     @spaceship.electrolytes = true
@@ -476,7 +595,19 @@ class FlagShihTzuInstanceMethodsTest < Test::Unit::TestCase
     assert !@spaceship.electrolytes
   end
 
-  def test_should_define_an_has_flag_method
+  def test_should_define_an_unselect_all_flags_method_with_arity_0
+    @spaceship.warpdrive = true
+    @spaceship.shields = true
+    @spaceship.electrolytes = true
+
+    @spaceship.unselect_all_flags
+
+    assert !@spaceship.warpdrive
+    assert !@spaceship.shields
+    assert !@spaceship.electrolytes
+  end
+
+  def test_should_define_an_has_flag_method_with_arity_1
     assert !@spaceship.has_flag?('flags')
 
     @spaceship.warpdrive = true
@@ -492,6 +623,22 @@ class FlagShihTzuInstanceMethodsTest < Test::Unit::TestCase
     assert !@spaceship.has_flag?('flags')
   end
 
+  def test_should_define_an_has_flag_method_with_arity_0
+    assert !@spaceship.has_flag?
+
+    @spaceship.warpdrive = true
+    assert @spaceship.has_flag?
+
+    @spaceship.shields = true
+    assert @spaceship.has_flag?
+
+    @spaceship.electrolytes = true
+    assert @spaceship.has_flag?
+
+    @spaceship.unselect_all_flags
+    assert !@spaceship.has_flag?
+  end
+
   # --------------------------------------------------
 
   def test_should_define_a_customized_all_flags_reader_method
@@ -742,11 +889,11 @@ class FlagShihTzuInstanceMethodsTest < Test::Unit::TestCase
     assert !SpaceshipWithoutFlagsColumn.method_defined?(:warpdrive)
   end
 
-  def test_column_guessing_for_default_column
+  def test_column_guessing_for_default_column_2
     assert_equal 'flags', @spaceship.class.determine_flag_colmn_for(:warpdrive)
   end
 
-  def test_column_guessing_for_default_column
+  def test_column_guessing_for_default_column_1
     assert_raises FlagShihTzu::NoSuchFlagException do
       @spaceship.class.determine_flag_colmn_for(:xxx)
     end
@@ -757,6 +904,57 @@ class FlagShihTzuInstanceMethodsTest < Test::Unit::TestCase
     assert_equal 'bits', @big_spaceship.class.determine_flag_colmn_for(:warpdrive)
   end
 
+  # --------------------------------------------------
+
+  def test_validation_should_raise_if_not_a_flag_column
+    spaceship = SpaceshipWithValidationsOnNonFlagsColumn.new
+    assert_raises ArgumentError do
+      spaceship.valid?
+    end
+  end
+
+  def test_validation_should_succeed_with_a_blank_optional_flag
+    spaceship = Spaceship.new
+    assert_equal true, spaceship.valid?
+  end
+
+  def test_validation_should_fail_with_a_nil_required_flag
+    spaceship = SpaceshipWithValidationsAndCustomFlagsColumn.new
+    spaceship.bits = nil
+    assert_equal false, spaceship.valid?
+    assert_equal ["can't be blank"], spaceship.errors.messages[:bits]
+  end
+
+  def test_validation_should_fail_with_a_blank_required_flag
+    spaceship = SpaceshipWithValidationsAndCustomFlagsColumn.new
+    assert_equal false, spaceship.valid?
+    assert_equal ["can't be blank"], spaceship.errors.messages[:bits]
+  end
+
+  def test_validation_should_succeed_with_a_set_required_flag
+    spaceship = SpaceshipWithValidationsAndCustomFlagsColumn.new
+    spaceship.warpdrive = true
+    assert_equal true, spaceship.valid?
+  end
+
+  def test_validation_should_fail_with_a_blank_required_flag_among_2
+    spaceship = SpaceshipWithValidationsAnd3CustomFlagsColumn.new
+    assert_equal false, spaceship.valid?
+    assert_equal ["can't be blank"], spaceship.errors.messages[:engines]
+    assert_equal ["can't be blank"], spaceship.errors.messages[:weapons]
+
+    spaceship.warpdrive = true
+    assert_equal false, spaceship.valid?
+    assert_equal ["can't be blank"], spaceship.errors.messages[:weapons]
+  end
+
+  def test_validation_should_succeed_with_a_set_required_flag_among_2
+    spaceship = SpaceshipWithValidationsAnd3CustomFlagsColumn.new
+    spaceship.warpdrive = true
+    spaceship.photon = true
+    assert_equal true, spaceship.valid?
+  end
+
 end
 
 class FlagShihTzuDerivedClassTest < Test::Unit::TestCase
@@ -848,6 +1046,8 @@ class FlagShihTzuClassMethodsTest < Test::Unit::TestCase
     assert_equal Spaceship.flag_columns, ['flags']
     assert_equal SpaceshipWith2CustomFlagsColumn.flag_columns, ['bits', 'commanders']
     assert_equal SpaceshipWith3CustomFlagsColumn.flag_columns, ['engines', 'weapons', 'hal3000']
+    assert_equal SpaceshipWithValidationsAnd3CustomFlagsColumn.flag_columns, ["engines", "weapons", "hal3000"]
+    assert_equal SpaceshipWithSymbolAndStringFlagColumns.flag_columns, ['peace', 'love', 'happiness']
   end
 
 end

data/test/schema.rb

@@ -1,15 +1,15 @@
 ActiveRecord::Schema.define(:version => 0) do
-  create_table :spaceships, :force => true do |t| 
+  create_table :spaceships, :force => true do |t|
     t.string :type, :null => false, :default => 'Spaceship'
     t.integer :flags, :null => false, :default => 0
     t.string :incorrect_flags_column, :null => false, :default => ''
-  end 
+  end
 
-  create_table :spaceships_with_custom_flags_column, :force => true do |t| 
+  create_table :spaceships_with_custom_flags_column, :force => true do |t|
     t.integer :bits, :null => false, :default => 0
   end
 
-  create_table :spaceships_with_2_custom_flags_column, :force => true do |t| 
+  create_table :spaceships_with_2_custom_flags_column, :force => true do |t|
     t.integer :bits, :null => false, :default => 0
     t.integer :commanders, :null => false, :default => 0
   end
@@ -20,10 +20,22 @@ ActiveRecord::Schema.define(:version => 0) do
     t.integer :hal3000, :null => false, :default => 0
   end
 
-  create_table :spaceships_without_flags_column, :force => true do |t| 
+  create_table :spaceships_with_3_custom_flags_column, :force => true do |t|
+    t.integer :engines, :null => false, :default => 0
+    t.integer :weapons, :null => false, :default => 0
+    t.integer :hal3000, :null => false, :default => 0
+  end
+
+  create_table :spaceships_with_symbol_and_string_flag_columns, :force => true do |t|
+    t.integer :peace, :null => false, :default => 0
+    t.integer :love, :null => false, :default => 0
+    t.integer :happiness, :null => false, :default => 0
+  end
+
+  create_table :spaceships_without_flags_column, :force => true do |t|
   end
 
-  create_table :spaceships_with_non_integer_column, :force => true do |t| 
+  create_table :spaceships_with_non_integer_column, :force => true do |t|
     t.string :flags, :null => false, :default => 'A string'
   end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flag_shih_tzu
 version: !ruby/object:Gem::Version
-  version: 0.3.2
-  prerelease: 
+  version: 0.3.4
 platform: ruby
 authors:
 - Patryk Peszko
@@ -12,100 +11,85 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-06 00:00:00.000000000 Z
+date: 2013-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.4.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'Bit fields for ActiveRecord:
-
+description: |
+  Bit fields for ActiveRecord:
   This gem lets you use a single integer column in an ActiveRecord model
-
   to store a collection of boolean attributes (flags). Each flag can be used
-
   almost in the same way you would use any boolean attribute on an
-
   ActiveRecord object.
-
-'
-email: 
+email: peter.boling@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -124,37 +108,39 @@ files:
 - gemfiles/Gemfile.activerecord-3.2.x
 - init.rb
 - lib/flag_shih_tzu.rb
+- lib/flag_shih_tzu/validators.rb
 - lib/flag_shih_tzu/version.rb
 - test/database.yml
 - test/flag_shih_tzu_test.rb
 - test/schema.rb
 - test/test_helper.rb
 homepage: https://github.com/xing/flag_shih_tzu
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Bit fields for ActiveRecord
 test_files:
 - test/database.yml
 - test/flag_shih_tzu_test.rb
 - test/schema.rb
 - test/test_helper.rb
+has_rdoc: