flag_shih_tzu 0.3.1 → 0.3.2

data/CHANGELOG

@@ -1,3 +1,12 @@
+Version 0.3.2 - NOV.06.2012
+
+* Adds skip column check option :check_for_column - from arturaz
+* Adds a 'smart' set_flag_sql method which will auto determine the correct column for the given flag - from arturaz
+* Changes the behavior of sql_set_for_flag to not use table names in the generated SQL
+  - because it didn't actually work before
+  - Now there is a test ensuring that the generated SQL can be executed by a real DB
+  - This improved sql_set_for_flag underlies the public set_flag_sql method
+
 Version 0.3.1 - NOV.06.2012
 
 * Adds new methods (for a flag column named 'bar', with many individual flags within) - from ddidier

data/README.rdoc

@@ -302,6 +302,39 @@ operators in the SQL instead of an IN() list:
 The drawback is that due to the bit operator, this query can not use an index
 on the flags column.
 
+===Updating flag column by raw sql
+
+If you need to do mass updates without initializing object for each row, you can
+use #set_flag_sql method on your class. Example:
+
+  Spaceship.set_flag_sql(:warpdrive, true) # "flags = flags | 1"
+  Spaceship.set_flag_sql(:shields, false)  # "flags = flags & ~2"
+
+And then use it in:
+
+  Spaceship.update_all Spaceship.set_flag_sql(:shields, false)
+
+Beware that having multiple flag manipulation sql statements probably will not
+bring required result (at least on sqlite3, not tested on other databases), so
+you _should not_ do this:
+
+  Spaceship.update_all "#{Spaceship.set_flag_sql(:shields, false)},#{
+    Spaceship.set_flag_sql(:warpdrive, true)}"
+
+General rule of thumb: issue only one flag update per update statement.
+
+===Skipping flag column check
+
+By default when you call has_flags in your code it will automatically check
+your database to see if you have correct column defined.
+
+Sometimes this may not be a wanted behaviour (e.g. when loading model without
+database connection established) so you can set :check_for_column option to
+false to avoid it.
+
+  has_flags 1 => :warpdrive,
+            2 => :shields,
+            :check_for_column => false
 
 ==Running the gem tests
 

data/lib/flag_shih_tzu.rb

@@ -27,11 +27,12 @@ module FlagShihTzu
         :named_scopes => true,
         :column => DEFAULT_COLUMN_NAME,
         :flag_query_mode => :in_list,
-        :strict => false
+        :strict => false,
+        :check_for_column => true
       }.update(opts)
       colmn = opts[:column].to_s
 
-      return unless check_flag_column(colmn)
+      return if opts[:check_for_column] && ! check_flag_column(colmn)
 
       # options are stored in a class level hash and apply per-column
       self.flag_options ||= {}
@@ -157,6 +158,21 @@ module FlagShihTzu
       raise ArgumentError, "Invalid flag '#{flag}'" if flag_mapping[colmn].nil? || !flag_mapping[colmn].include?(flag)
     end
 
+    # Returns SQL statement to enable/disable flag.
+    # Automatically determines the correct column.
+    def set_flag_sql(flag, value, colmn = nil, custom_table_name = self.table_name)
+      colmn = determine_flag_colmn_for(flag) if colmn.nil?
+      sql_set_for_flag(flag, colmn, value, custom_table_name)
+    end
+
+    def determine_flag_colmn_for(flag)
+      return DEFAULT_COLUMN_NAME if self.flag_mapping.nil?
+      self.flag_mapping.each_pair do |colmn, mapping|
+        return colmn if mapping.include?(flag)
+      end
+      raise NoSuchFlagException.new("determine_flag_colmn_for: Couldn't determine column for your flags!")
+    end
+
     private
 
       def parse_options(*args)
@@ -222,8 +238,7 @@ module FlagShihTzu
     
       def sql_set_for_flag(flag, colmn, enabled = true, custom_table_name = self.table_name)
         check_flag(flag, colmn)
-
-        "#{custom_table_name}.#{colmn} = #{custom_table_name}.#{colmn} #{enabled ? "| " : "& ~" }#{flag_mapping[colmn][flag]}"
+        "#{colmn} = #{colmn} #{enabled ? "| " : "& ~" }#{flag_mapping[colmn][flag]}"
       end
 
       def is_valid_flag_key(flag_key)
@@ -311,11 +326,7 @@ module FlagShihTzu
     end
 
     def determine_flag_colmn_for(flag)
-      return DEFAULT_COLUMN_NAME if self.class.flag_mapping.nil?
-      self.class.flag_mapping.each_pair do |colmn, mapping|
-        return colmn if mapping.include?(flag)
-      end
-      raise NoSuchFlagException.new("determine_flag_colmn_for: Couldn't determine column for your flags!")
+      self.class.determine_flag_colmn_for(flag)
     end
 
 end

data/lib/flag_shih_tzu/version.rb

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

data/test/flag_shih_tzu_test.rb

@@ -250,6 +250,35 @@ class FlagShihTzuClassMethodsTest < Test::Unit::TestCase
     assert_where_value "(spaceships.flags & 2 = 0)", SpaceshipWithBitOperatorQueryMode.not_shields
   end
 
+  def test_should_work_with_raw_sql
+    spaceship = Spaceship.new
+    spaceship.enable_flag(:shields)
+    spaceship.enable_flag(:electrolytes)
+    spaceship.save!
+
+    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
+
+    spaceship = Spaceship.new
+    spaceship.enable_flag(:warpdrive)
+    spaceship.enable_flag(:shields)
+    spaceship.enable_flag(:electrolytes)
+    spaceship.save!
+
+    Spaceship.update_all Spaceship.set_flag_sql(:shields, false),
+                         ["id=?", spaceship.id]
+    spaceship.reload
+
+    assert_equal true, spaceship.warpdrive
+    assert_equal false, spaceship.shields
+    assert_equal true, spaceship.electrolytes
+  end
+
   def test_should_return_the_correct_number_of_items_from_a_named_scope
     spaceship = Spaceship.new
     spaceship.enable_flag(:warpdrive)
@@ -714,18 +743,18 @@ class FlagShihTzuInstanceMethodsTest < Test::Unit::TestCase
   end
 
   def test_column_guessing_for_default_column
-    assert_equal 'flags', @spaceship.send(:determine_flag_colmn_for, :warpdrive)
+    assert_equal 'flags', @spaceship.class.determine_flag_colmn_for(:warpdrive)
   end
 
   def test_column_guessing_for_default_column
     assert_raises FlagShihTzu::NoSuchFlagException do
-      @spaceship.send(:determine_flag_colmn_for, :xxx)
+      @spaceship.class.determine_flag_colmn_for(:xxx)
     end
   end
 
   def test_column_guessing_for_2_columns
-    assert_equal 'commanders', @big_spaceship.send(:determine_flag_colmn_for, :jeanlucpicard)
-    assert_equal 'bits', @big_spaceship.send(:determine_flag_colmn_for, :warpdrive)
+    assert_equal 'commanders', @big_spaceship.class.determine_flag_colmn_for(:jeanlucpicard)
+    assert_equal 'bits', @big_spaceship.class.determine_flag_colmn_for(:warpdrive)
   end
 
 end
@@ -807,8 +836,8 @@ class FlagShihTzuDerivedClassTest < Test::Unit::TestCase
   end
 
   def test_should_return_a_sql_set_method_for_flag
-    assert_equal "spaceships.flags = spaceships.flags | 1",  Spaceship.send( :sql_set_for_flag, :warpdrive, 'flags', true)
-    assert_equal "spaceships.flags = spaceships.flags & ~1", Spaceship.send( :sql_set_for_flag, :warpdrive, 'flags', false)
+    assert_equal "flags = flags | 1",  Spaceship.send( :sql_set_for_flag, :warpdrive, 'flags', true)
+    assert_equal "flags = flags & ~1", Spaceship.send( :sql_set_for_flag, :warpdrive, 'flags', false)
   end
 
 end

data/test/test_helper.rb

@@ -7,6 +7,11 @@ ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
 ActiveRecord::Migration.verbose = false
 
 configs = YAML.load_file(File.dirname(__FILE__) + "/database.yml")
+if RUBY_PLATFORM == "java"
+  configs['sqlite']['adapter'] = 'jdbcsqlite3' 
+  configs['mysql']['adapter'] = 'jdbcmysql' 
+  configs['postgresql']['adapter'] = 'jdbcpostgresql' 
+end
 ActiveRecord::Base.configurations = configs
 
 db_name = ENV["DB"] || "sqlite"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flag_shih_tzu
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors: