flag_shih_tzu 0.1.0.pre → 0.2.3

data/.gitignore

@@ -1,5 +1,4 @@
 test/debug.log
-test/flag_shih_tzu_plugin.sqlite3.db
 coverage
 .idea
 .idea/*
@@ -7,4 +6,6 @@ coverage
 *.gem
 .bundle
 Gemfile.lock
+gemfiles/*.lock
 pkg/*
+rdoc/*

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+gemfile:
+  - gemfiles/Gemfile.activerecord-2.3.x
+  - gemfiles/Gemfile.activerecord-3.0.x
+  - gemfiles/Gemfile.activerecord-3.1.x

data/Gemfile

@@ -1,4 +1,4 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in ..gemspec
+# Specify your gem's dependencies in flag_shih_tzu.gemspec
 gemspec

data/README.rdoc

@@ -1,59 +1,76 @@
 =FlagShihTzu
 
-A rails plugin to store a collection of boolean attributes in a single
-ActiveRecord column as a bit field.
+Bit fields for ActiveRecord
+
+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 plugin lets you use a single integer column in an ActiveRecord model
+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.
 
 The benefits:
 * No migrations needed for new boolean attributes. This helps a lot
-  if you have very large db-tables where you want to avoid ALTER TABLE whenever
-  possible.
+  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.
 
 Using FlagShihTzu, you can add new boolean attributes whenever you want,
 without needing any migration. Just add a new flag to the +has_flags+ call.
 
-And just in case you are wondering what "Shih Tzu" means:
+And just in case you are wondering what a "Shih Tzu" is:
 http://en.wikipedia.org/wiki/Shih_Tzu
 
 
+==Build status
+
+{<img src="https://secure.travis-ci.org/xing/flag_shih_tzu.png" />}[http://travis-ci.org/xing/flag_shih_tzu]
+
+
 ==Prerequisites
 
-FlagShihTzu assumes that your ActiveRecord model already has an integer field
-to store the flags, which should be defined to not allow NULL values and
-should have a default value of 0 (which means all flags are initially set to
-false).
+The gem is actively being tested with:
 
-The plugin has been tested with Rails versions from 2.1 to 3.0 and MySQL,
-PostgreSQL and SQLite3 databases. It has been tested with ruby 1.9.2 (with
-Rails 3 only).
+* ActiveRecord versions 2.3.x, 3.0.x, 3.1.x
+* MySQL, PostgreSQL and SQLite3 databases
+* Ruby 1.8.7 and 1.9.2
 
 
 ==Installation
 
-===As plugin (Rails 2.x, Rails 3)
+===Rails 2.x
+
+In environment.rb:
+
+  config.gem 'flag_shih_tzu'
+
+Then:
 
-  cd path/to/your/rails-project
-  ./script/plugin install git://github.com/xing/flag_shih_tzu.git
+  $ rake gems:install # use sudo if necessary
 
-===As gem (Rails 3)
+===Rails 3
 
-Add following line to your Gemfile:
+In Gemfile:
 
-  gem 'flag_shih_tzu', '0.1.0.pre'
+  gem 'flag_shih_tzu'
 
-Make sure to install gem with bundler:
+Then:
+
+  $ bundle install
 
-  bundle install
 
 ==Usage
 
+FlagShihTzu assumes that your ActiveRecord model already has an integer field
+to store the flags, which should be defined to not allow NULL values and
+should have a default value of 0 (which means all flags are initially set to
+false).
+
+
 ===Defining the flags
 
   class Spaceship < ActiveRecord::Base
@@ -71,6 +88,44 @@ That is why the plugin forces you to set them explicitly.
 The values are symbols for the flags being created.
 
 
+===How it stores the values
+
+As said, FlagShihTzu uses a single integer column to store the values for all
+the defined flags as a bit field.
+
+The bit position of a flag corresponds to the given key.
+
+This way, we can use bit operators on the stored integer value to set, unset
+and check individual flags.
+
+                +---+---+---+                +---+---+---+
+                |   |   |   |                |   |   |   |
+  Bit position  | 3 | 2 | 1 |                | 3 | 2 | 1 |
+  (flag key)    |   |   |   |                |   |   |   |
+                +---+---+---+                +---+---+---+
+                |   |   |   |                |   |   |   |
+  Bit value     | 4 | 2 | 1 |                | 4 | 2 | 1 |
+                |   |   |   |                |   |   |   |
+                +---+---+---+                +---+---+---+
+                | e | s | w |                | e | s | w |
+                | l | h | a |                | l | h | a |
+                | e | i | r |                | e | i | r |
+                | c | e | p |                | c | e | p |
+                | t | l | d |                | t | l | d |
+                | r | d | r |                | r | d | r |
+                | o | s | i |                | o | s | i |
+                | l |   | v |                | l |   | v |
+                | y |   | e |                | y |   | e |
+                | t |   |   |                | t |   |   |
+                | e |   |   |                | e |   |   |
+                | s |   |   |                | s |   |   |
+                +---+---+---+                +---+---+---+
+                | 1 | 1 | 0 | = 4 + 2 = 6    | 1 | 0 | 1 | = 4 + 1 = 5
+                +---+---+---+                +---+---+---+
+
+Read more about bit fields here: http://en.wikipedia.org/wiki/Bit_field
+
+
 ===Using a custom column name
 
 The default column name to store the flags is 'flags', but you can provide a
@@ -82,7 +137,7 @@ different columns for separate flags:
             3 => :electrolytes,
             :column => 'features'
 
-  has_flags 1 => :spock, 
+  has_flags 1 => :spock,
             2 => :scott,
             3 => :kirk,
             :column => 'crew'
@@ -96,12 +151,17 @@ on Spaceship:
   Spaceship#warpdrive
   Spaceship#warpdrive?
   Spaceship#warpdrive=
+  Spaceship#warpdrive_changed?
+
   Spaceship#shields
   Spaceship#shields?
   Spaceship#shields=
+  Spaceship#shields_changed?
+
   Spaceship#electrolytes
   Spaceship#electrolytes?
   Spaceship#electrolytes=
+  Spaceship#electrolytes_changed?
 
 
 ===Generated named scopes
@@ -141,44 +201,6 @@ the scopes. The option on has_flags is still named <tt>:named_scopes</tt> howeve
   ...
 
 
-===How it stores the values
-
-As said, FlagShihTzu uses a single integer column to store the values for all
-the defined flags as a bit field.
-
-The bit position of a flag corresponds to the given key.
-
-This way, we can use bit operators on the stored integer value to set, unset
-and check individual flags.
-
-                +---+---+---+                +---+---+---+
-                |   |   |   |                |   |   |   |
-  Bit position  | 3 | 2 | 1 |                | 3 | 2 | 1 |
-  (flag key)    |   |   |   |                |   |   |   |
-                +---+---+---+                +---+---+---+
-                |   |   |   |                |   |   |   |
-  Bit value     | 4 | 2 | 1 |                | 4 | 2 | 1 |
-                |   |   |   |                |   |   |   |
-                +---+---+---+                +---+---+---+
-                | e | s | w |                | e | s | w |
-                | l | h | a |                | l | h | a |
-                | e | i | r |                | e | i | r |
-                | c | e | p |                | c | e | p |
-                | t | l | d |                | t | l | d |
-                | r | d | r |                | r | d | r |
-                | o | s | i |                | o | s | i |
-                | l |   | v |                | l |   | v |
-                | y |   | e |                | y |   | e |
-                | t |   |   |                | t |   |   |
-                | e |   |   |                | e |   |   |
-                | s |   |   |                | s |   |   |
-                +---+---+---+                +---+---+---+
-                | 1 | 1 | 0 | = 4 + 2 = 6    | 1 | 0 | 1 | = 4 + 1 = 5
-                +---+---+---+                +---+---+---+
-
-Read more about bit fields here: http://en.wikipedia.org/wiki/Bit_field
-
-
 ===Support for manually building conditions
 
 The following class methods may support you when manually building
@@ -190,8 +212,8 @@ ActiveRecord conditions:
   Spaceship.not_shields_condition       # "(spaceships.flags not in (2,3,6,7))"
   Spaceship.electrolytes_condition      # "(spaceships.flags in (4,5,6,7))"
   Spaceship.not_electrolytes_condition  # "(spaceships.flags not in (4,5,6,7))"
-  
-These methods also accept a :table_alias option that can be used when 
+
+These methods also accept a :table_alias option that can be used when
 generating SQL that references the same table more than once:
 
   Spaceship.shields_condition(:table_alias => 'evil_spaceships') # "(evil_spaceships.flags in (2,3,6,7))"
@@ -209,74 +231,75 @@ For MySQL, depending on your MySQL settings, this can even hit the
 In this case, consider changing the flag query mode to <tt>:bit_operator</tt>
 instead of <tt>:in_list</tt>, like so:
 
-  has_flags 1 => :warpdrive, 
-            2 => :shields, 
+  has_flags 1 => :warpdrive,
+            2 => :shields,
             :flag_query_mode => :bit_operator
 
 This will modify the generated condition and named_scope methods to use bit
 operators in the SQL instead of an IN() list:
 
-  Spaceship.warpdrive_condition         # "(spaceships.flags & 1 = 1)",
-  Spaceship.not_warpdrive_condition     # "(spaceships.flags & 1 = 0)",
-  Spaceship.shields_condition           # "(spaceships.flags & 2 = 2)",
-  Spaceship.not_shields_condition       # "(spaceships.flags & 2 = 0)",
+  Spaceship.warpdrive_condition     # "(spaceships.flags & 1 = 1)",
+  Spaceship.not_warpdrive_condition # "(spaceships.flags & 1 = 0)",
+  Spaceship.shields_condition       # "(spaceships.flags & 2 = 2)",
+  Spaceship.not_shields_condition   # "(spaceships.flags & 2 = 0)",
 
-  Spaceship.warpdrive         # :conditions => "(spaceships.flags & 1 = 1)"
-  Spaceship.not_warpdrive     # :conditions => "(spaceships.flags & 1 = 0)"
-  Spaceship.shields           # :conditions => "(spaceships.flags & 2 = 2)"
-  Spaceship.not_shields       # :conditions => "(spaceships.flags & 2 = 0)"
+  Spaceship.warpdrive     # :conditions => "(spaceships.flags & 1 = 1)"
+  Spaceship.not_warpdrive # :conditions => "(spaceships.flags & 1 = 0)"
+  Spaceship.shields       # :conditions => "(spaceships.flags & 2 = 2)"
+  Spaceship.not_shields   # :conditions => "(spaceships.flags & 2 = 0)"
 
 The drawback is that due to the bit operator, this query can not use an index
 on the flags column.
 
 
-==Running the plugin tests
+==Running the gem tests
+
+First, make sure all required gems are installed:
+
+  $ bundle install
 
-1. (Rails 3 only) Add <tt>mysql2</tt>, <tt>pg</tt> and <tt>sqlite3</tt> gems to your Gemfile.
-1. Install flag_shih_tzu as plugin inside working Rails application.
-1. Modify <tt>test/database.yml</tt> to fit your test environment.
-2. If needed, create the test database you configured in <tt>test/database.yml</tt>.
+The default rake test task will run the tests against the currently locked
+ActiveRecord version (see +Gemfile.lock+):
 
-Then you can run
+  $ bundle exec rake test
 
-  DB=mysql|postgres|sqlite3 rake test:plugins PLUGIN=flag_shih_tzu
+If you want to run the tests against all supported ActiveRecord versions:
 
-from your Rails project root or
+  $ bundle exec rake test:all
 
-  DB=mysql|postgres|sqlite3 rake
+This will internally use bundler to load specific ActiveRecord versions
+before executing the tests (see +gemfiles/+), e.g.:
 
-from <tt>vendor/plugins/flag_shih_tzu</tt>.
+  $ BUNDLE_GEMFILE='gemfiles/Gemfile.activerecord-3.1.x' bundle exec rake test
+
+
+All tests will use an in-memory sqlite database by default.
+If you want to use a different database, see <tt>test/database.yml</tt>,
+install the required adapter gem and use the DB environment variable to
+specify which config from <tt>test/database.yml</tt> to use, e.g.:
+
+  $ DB=mysql bundle exec rake
 
 
 ==Authors
 
 {Patryk Peszko}[http://github.com/ppeszko],
 {Sebastian Roebke}[http://github.com/boosty],
-{David Anderson}[http://github.com/alpinegizmo]
-and {Tim Payton}[http://github.com/dizzy42]
+{David Anderson}[http://github.com/alpinegizmo],
+{Tim Payton}[http://github.com/dizzy42]
+and a helpful group of
+{contributors}[https://github.com/xing/flag_shih_tzu/contributors].
+Thanks!
 
 Please find out more about our work in our
 {tech blog}[http://blog.xing.com/category/english/tech-blog].
 
 
-==Contributors
-
-{TobiTobes}[http://github.com/rngtng],
-{Martin Stannard}[http://github.com/martinstannard],
-{Ladislav Martincik}[http://github.com/lacomartincik],
-{Peter Boling}[http://github.com/pboling],
-{Daniel Jagszent}[http://github.com/d--j],
-{Thorsten Boettger}[http://github.com/alto],
-{Darren Torpey}[http://github.com/darrentorpey],
-{Joost Baaij}[http://github.com/tilsammans] and
-{Musy Bite}[http://github.com/musybite]
-
-
 ==License
 
 The MIT License
 
-Copyright (c) 2009 {XING AG}[http://www.xing.com/]
+Copyright (c) 2011 {XING AG}[http://www.xing.com/]
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -1,6 +1,6 @@
 require 'rake'
 require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rdoc/task'
 
 require 'bundler'
 Bundler::GemHelper.install_tasks
@@ -16,15 +16,23 @@ Rake::TestTask.new(:test) do |t|
 end
 
 desc 'Generate documentation for the flag_shih_tzu plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
+RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'FlagShihTzu'
-  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
 namespace :test do
+  desc 'Test against all supported ActiveRecord versions'
+  task :all do
+    %w(2.3.x 3.0.x 3.1.x).each do |version|
+      sh "BUNDLE_GEMFILE='gemfiles/Gemfile.activerecord-#{version}' bundle"
+      sh "BUNDLE_GEMFILE='gemfiles/Gemfile.activerecord-#{version}' bundle exec rake test"
+    end
+  end
+
   desc 'Measures test coverage'
   task :coverage do
     rm_f "coverage"

data/flag_shih_tzu.gemspec

@@ -8,9 +8,10 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Patryk Peszko", "Sebastian Roebke", "David Anderson", "Tim Payton"]
   s.homepage    = "https://github.com/xing/flag_shih_tzu"
-  s.summary     = %q{A rails plugin to store a collection of boolean attributes in a single ActiveRecord column as a bit field}
+  s.summary     = %q{Bit fields for ActiveRecord}
   s.description = <<-EODOC
-This plugin lets you use a single integer column in an ActiveRecord model
+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.
@@ -20,4 +21,12 @@ ActiveRecord object.
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+
+  s.add_dependency "activerecord", ">= 2.3.0"
+
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rdoc", ">= 2.4.2"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rcov"
+  s.add_development_dependency "sqlite3"
 end

data/gemfiles/Gemfile.activerecord-2.3.x

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec :path => '..'
+
+gem "activerecord", "~>2.3.0"

data/gemfiles/Gemfile.activerecord-3.0.x

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec :path => '..'
+
+gem "activerecord", "~>3.0.0"

data/gemfiles/Gemfile.activerecord-3.1.x

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec :path => '..'
+
+gem "activerecord", "~>3.1.0"

data/lib/flag_shih_tzu.rb

@@ -1,9 +1,17 @@
+require "rubygems"
+require "active_record"
+require "active_support/all"
+
 module FlagShihTzu
-  TRUE_VALUES = [true, 1, '1', 't', 'T', 'true', 'TRUE'] # taken from ActiveRecord::ConnectionAdapters::Column
+  # taken from ActiveRecord::ConnectionAdapters::Column
+  TRUE_VALUES = [true, 1, '1', 't', 'T', 'true', 'TRUE']
+
   DEFAULT_COLUMN_NAME = 'flags'
 
   def self.included(base)
     base.extend(ClassMethods)
+    base.class_attribute :flag_options
+    base.class_attribute :flag_mapping
   end
 
   class IncorrectFlagColumnException < Exception; end
@@ -18,19 +26,17 @@ module FlagShihTzu
         :column => DEFAULT_COLUMN_NAME,
         :flag_query_mode => :in_list
       }.update(opts)
-      colmn = opts[:column]
+      colmn = opts[:column].to_s
 
       return unless check_flag_column(colmn)
 
       # options are stored in a class level hash and apply per-column
-      class_inheritable_hash :flag_options
-      write_inheritable_attribute(:flag_options, {}) if flag_options.nil?
-      flag_options[colmn] = opts
+      self.flag_options ||= {}
+      self.flag_options[colmn] = opts
 
       # the mappings are stored in this class level hash and apply per-column
-      class_inheritable_hash :flag_mapping
-      write_inheritable_attribute(:flag_mapping, {}) if flag_mapping.nil?
-      flag_mapping[colmn] ||= {}
+      self.flag_mapping ||= {}
+      self.flag_mapping[colmn] ||= {}
 
       flag_hash.each do |flag_key, flag_name|
         raise ArgumentError, "has_flags: flag keys should be positive integers, and #{flag_key} is not" unless is_valid_flag_key(flag_key)
@@ -53,6 +59,15 @@ module FlagShihTzu
             FlagShihTzu::TRUE_VALUES.include?(value) ? enable_flag(:#{flag_name}, '#{colmn}') : disable_flag(:#{flag_name}, '#{colmn}')
           end
 
+          def #{flag_name}_changed?
+            if colmn_changes = changes['#{colmn}']
+              flag_bit = self.class.flag_mapping['#{colmn}'][:#{flag_name}]
+              (colmn_changes[0] & flag_bit) != (colmn_changes[1] & flag_bit)
+            else
+              false
+            end
+          end
+
           def self.#{flag_name}_condition(options = {})
             sql_condition_for_flag(:#{flag_name}, '#{colmn}', true, options[:table_alias] || self.table_name)
           end
@@ -98,7 +113,7 @@ module FlagShihTzu
         # 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?)
         # 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?(table_name) : true
+        has_table = has_ar ? connection.tables.include?(table_name) : true
 
         logger.warn("Error: Table '#{table_name}' doesn't exist") and return false unless has_table
 
@@ -207,4 +222,3 @@ module FlagShihTzu
     end
 
 end
-

data/lib/flag_shih_tzu/version.rb

@@ -1,3 +1,3 @@
 module FlagShihTzu
-  VERSION = "0.1.0.pre"
+  VERSION = "0.2.3"
 end

data/test/database.yml

@@ -1,17 +1,13 @@
-sqlite3:
+sqlite:
   adapter: sqlite3
-  database: test/flag_shih_tzu_plugin.sqlite3.db
-
+  database: ":memory:"
+  timeout: 500
 mysql:
   adapter: mysql2
-  host: localhost
-  username: root
-  password: 
-  database: flag_shih_tzu_plugin_test
-
+  database: flag_shih_tzu_test
+  username:
+  encoding: utf8
 postgresql:
   adapter: postgresql
+  database: flag_shih_tzu_test
   username: postgres
-  password: 
-  database: flag_shih_tzu_plugin_test
-  min_messages: ERROR

data/test/flag_shih_tzu_test.rb

@@ -1,12 +1,11 @@
 require File.expand_path(File.dirname(__FILE__) + '/test_helper.rb')
-load_schema
 
 class Spaceship < ActiveRecord::Base
   set_table_name 'spaceships'
   include FlagShihTzu
 
-  has_flags 1 => :warpdrive, 
-            2 => :shields, 
+  has_flags 1 => :warpdrive,
+            2 => :shields,
             3 => :electrolytes
 end
 
@@ -31,6 +30,13 @@ class SpaceshipWithCustomFlagsColumn < ActiveRecord::Base
   has_flags(1 => :warpdrive, 2 => :hyperspace, :column => 'bits')
 end
 
+class SpaceshipWithColumnNameAsSymol < ActiveRecord::Base
+  set_table_name 'spaceships_with_custom_flags_column'
+  include FlagShihTzu
+
+  has_flags(1 => :warpdrive, 2 => :hyperspace, :column => :bits)
+end
+
 class SpaceshipWith2CustomFlagsColumn < ActiveRecord::Base
   set_table_name 'spaceships_with_2_custom_flags_column'
   include FlagShihTzu
@@ -42,7 +48,7 @@ end
 class SpaceshipWithBitOperatorQueryMode < ActiveRecord::Base
   set_table_name 'spaceships'
   include FlagShihTzu
-  
+
   has_flags(1 => :warpdrive, 2 => :shields, :flag_query_mode => :bit_operator)
 end
 
@@ -54,7 +60,7 @@ class Planet < ActiveRecord::Base
 end
 
 class FlagShihTzuClassMethodsTest < Test::Unit::TestCase
-  
+
   def setup
     Spaceship.destroy_all
   end
@@ -87,14 +93,14 @@ class FlagShihTzuClassMethodsTest < Test::Unit::TestCase
           )
     end
   end
-  
+
   def test_has_flags_should_raise_an_exception_when_desired_flag_name_method_already_defined
     assert_raises ArgumentError do
       eval(<<-EOF
         class SpaceshipWithAlreadyUsedMethod < ActiveRecord::Base
           set_table_name 'spaceships_with_2_custom_flags_column'
           include FlagShihTzu
-          
+
           def jeanluckpicard; end
 
           has_flags({ 1 => :jeanluckpicard }, :column => 'bits')
@@ -110,7 +116,7 @@ class FlagShihTzuClassMethodsTest < Test::Unit::TestCase
         class SpaceshipWithAlreadyUsedMethodByFlagshitzu < ActiveRecord::Base
           set_table_name 'spaceships_with_2_custom_flags_column'
           include FlagShihTzu
-          
+
           has_flags({ 1 => :jeanluckpicard }, :column => 'bits')
           has_flags({ 1 => :jeanluckpicard }, :column => 'bits')
         end
@@ -138,7 +144,7 @@ class FlagShihTzuClassMethodsTest < Test::Unit::TestCase
     assert_equal "(spaceships.flags in (2,3,6,7))", Spaceship.shields_condition
     assert_equal "(spaceships.flags in (4,5,6,7))", Spaceship.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
@@ -155,10 +161,10 @@ class FlagShihTzuClassMethodsTest < Test::Unit::TestCase
     assert_equal "(spaceships.flags not in (2,3,6,7))", Spaceship.not_shields_condition
     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_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  
+    assert_equal "(custom_spaceships.flags in (1,3,5,7))", Spaceship.send(:sql_condition_for_flag, :warpdrive, 'flags', true, 'custom_spaceships')
+  end
 
   def test_should_define_a_sql_condition_method_for_flag_enabled_with_2_colmns_not_enabled
     assert_equal "(spaceships_with_2_custom_flags_column.bits not in (1,3))", SpaceshipWith2CustomFlagsColumn.not_warpdrive_condition
@@ -166,7 +172,7 @@ class FlagShihTzuClassMethodsTest < Test::Unit::TestCase
     assert_equal "(spaceships_with_2_custom_flags_column.commanders not in (1,3))", SpaceshipWith2CustomFlagsColumn.not_jeanlucpicard_condition
     assert_equal "(spaceships_with_2_custom_flags_column.commanders not in (2,3))", SpaceshipWith2CustomFlagsColumn.not_dajanatroj_condition
   end
-  
+
   def test_should_define_a_sql_condition_method_for_flag_enabled_using_bit_operators
     assert_equal "(spaceships.flags & 1 = 1)", SpaceshipWithBitOperatorQueryMode.warpdrive_condition
     assert_equal "(spaceships.flags & 2 = 2)", SpaceshipWithBitOperatorQueryMode.shields_condition
@@ -178,39 +184,39 @@ class FlagShihTzuClassMethodsTest < Test::Unit::TestCase
   end
 
   def test_should_define_a_named_scope_for_flag_enabled
-    assert_equal(["(spaceships.flags in (1,3,5,7))"], Spaceship.warpdrive.where_values)
-    assert_equal(["(spaceships.flags in (2,3,6,7))"], Spaceship.shields.where_values)
-    assert_equal(["(spaceships.flags in (4,5,6,7))"], Spaceship.electrolytes.where_values)
+    assert_where_value "(spaceships.flags in (1,3,5,7))", Spaceship.warpdrive
+    assert_where_value "(spaceships.flags in (2,3,6,7))", Spaceship.shields
+    assert_where_value "(spaceships.flags in (4,5,6,7))", Spaceship.electrolytes
   end
 
   def test_should_define_a_named_scope_for_flag_not_enabled
-    assert_equal(["(spaceships.flags not in (1,3,5,7))"], Spaceship.not_warpdrive.where_values)
-    assert_equal(["(spaceships.flags not in (2,3,6,7))"], Spaceship.not_shields.where_values)
-    assert_equal(["(spaceships.flags not in (4,5,6,7))"], Spaceship.not_electrolytes.where_values)
+    assert_where_value "(spaceships.flags not in (1,3,5,7))", Spaceship.not_warpdrive
+    assert_where_value "(spaceships.flags not in (2,3,6,7))", Spaceship.not_shields
+    assert_where_value "(spaceships.flags not in (4,5,6,7))", Spaceship.not_electrolytes
   end
 
   def test_should_define_a_named_scope_for_flag_enabled_with_2_columns
-    assert_equal(["(spaceships_with_2_custom_flags_column.bits in (1,3))"], SpaceshipWith2CustomFlagsColumn.warpdrive.where_values)
-    assert_equal(["(spaceships_with_2_custom_flags_column.bits in (2,3))"], SpaceshipWith2CustomFlagsColumn.hyperspace.where_values)
-    assert_equal(["(spaceships_with_2_custom_flags_column.commanders in (1,3))"], SpaceshipWith2CustomFlagsColumn.jeanlucpicard.where_values)
-    assert_equal(["(spaceships_with_2_custom_flags_column.commanders in (2,3))"], SpaceshipWith2CustomFlagsColumn.dajanatroj.where_values)
+    assert_where_value "(spaceships_with_2_custom_flags_column.bits in (1,3))", SpaceshipWith2CustomFlagsColumn.warpdrive
+    assert_where_value "(spaceships_with_2_custom_flags_column.bits in (2,3))", SpaceshipWith2CustomFlagsColumn.hyperspace
+    assert_where_value "(spaceships_with_2_custom_flags_column.commanders in (1,3))", SpaceshipWith2CustomFlagsColumn.jeanlucpicard
+    assert_where_value "(spaceships_with_2_custom_flags_column.commanders in (2,3))", SpaceshipWith2CustomFlagsColumn.dajanatroj
   end
 
   def test_should_define_a_named_scope_for_flag_not_enabled_with_2_columns
-    assert_equal(["(spaceships_with_2_custom_flags_column.bits not in (1,3))"], SpaceshipWith2CustomFlagsColumn.not_warpdrive.where_values)
-    assert_equal(["(spaceships_with_2_custom_flags_column.bits not in (2,3))"], SpaceshipWith2CustomFlagsColumn.not_hyperspace.where_values)
-    assert_equal(["(spaceships_with_2_custom_flags_column.commanders not in (1,3))"], SpaceshipWith2CustomFlagsColumn.not_jeanlucpicard.where_values)
-    assert_equal(["(spaceships_with_2_custom_flags_column.commanders not in (2,3))"], SpaceshipWith2CustomFlagsColumn.not_dajanatroj.where_values)
+    assert_where_value "(spaceships_with_2_custom_flags_column.bits not in (1,3))", SpaceshipWith2CustomFlagsColumn.not_warpdrive
+    assert_where_value "(spaceships_with_2_custom_flags_column.bits not in (2,3))", SpaceshipWith2CustomFlagsColumn.not_hyperspace
+    assert_where_value "(spaceships_with_2_custom_flags_column.commanders not in (1,3))", SpaceshipWith2CustomFlagsColumn.not_jeanlucpicard
+    assert_where_value "(spaceships_with_2_custom_flags_column.commanders not in (2,3))", SpaceshipWith2CustomFlagsColumn.not_dajanatroj
   end
-  
+
   def test_should_define_a_named_scope_for_flag_enabled_using_bit_operators
-    assert_equal(["(spaceships.flags & 1 = 1)"], SpaceshipWithBitOperatorQueryMode.warpdrive.where_values)
-    assert_equal(["(spaceships.flags & 2 = 2)"], SpaceshipWithBitOperatorQueryMode.shields.where_values)
+    assert_where_value "(spaceships.flags & 1 = 1)", SpaceshipWithBitOperatorQueryMode.warpdrive
+    assert_where_value "(spaceships.flags & 2 = 2)", SpaceshipWithBitOperatorQueryMode.shields
   end
 
   def test_should_define_a_named_scope_for_flag_not_enabled_using_bit_operators
-    assert_equal(["(spaceships.flags & 1 = 0)"], SpaceshipWithBitOperatorQueryMode.not_warpdrive.where_values)
-    assert_equal(["(spaceships.flags & 2 = 0)"], SpaceshipWithBitOperatorQueryMode.not_shields.where_values)
+    assert_where_value "(spaceships.flags & 1 = 0)", SpaceshipWithBitOperatorQueryMode.not_warpdrive
+    assert_where_value "(spaceships.flags & 2 = 0)", SpaceshipWithBitOperatorQueryMode.not_shields
   end
 
   def test_should_return_the_correct_number_of_items_from_a_named_scope
@@ -251,12 +257,20 @@ class FlagShihTzuClassMethodsTest < Test::Unit::TestCase
     assert_equal "(spaceships_with_custom_flags_column.bits not in (1,3))", SpaceshipWithCustomFlagsColumn.not_warpdrive_condition
     assert_equal "(spaceships_with_custom_flags_column.bits in (2,3))", SpaceshipWithCustomFlagsColumn.hyperspace_condition
     assert_equal "(spaceships_with_custom_flags_column.bits not in (2,3))", SpaceshipWithCustomFlagsColumn.not_hyperspace_condition
-    assert_equal(["(spaceships_with_custom_flags_column.bits in (1,3))"], SpaceshipWithCustomFlagsColumn.warpdrive.where_values)
-    assert_equal(["(spaceships_with_custom_flags_column.bits not in (1,3))"], SpaceshipWithCustomFlagsColumn.not_warpdrive.where_values)
-    assert_equal(["(spaceships_with_custom_flags_column.bits in (2,3))"], SpaceshipWithCustomFlagsColumn.hyperspace.where_values)
-    assert_equal(["(spaceships_with_custom_flags_column.bits not in (2,3))"], SpaceshipWithCustomFlagsColumn.not_hyperspace.where_values)
+    assert_where_value "(spaceships_with_custom_flags_column.bits in (1,3))", SpaceshipWithCustomFlagsColumn.warpdrive
+    assert_where_value "(spaceships_with_custom_flags_column.bits not in (1,3))", SpaceshipWithCustomFlagsColumn.not_warpdrive
+    assert_where_value "(spaceships_with_custom_flags_column.bits in (2,3))", SpaceshipWithCustomFlagsColumn.hyperspace
+    assert_where_value "(spaceships_with_custom_flags_column.bits not in (2,3))", SpaceshipWithCustomFlagsColumn.not_hyperspace
+  end
+
+  def test_should_work_with_a_custom_flags_column_name_as_symbol
+    spaceship = SpaceshipWithColumnNameAsSymol.new
+    spaceship.enable_flag(:warpdrive)
+    spaceship.save!
+    spaceship.reload
+    assert_equal 1, spaceship.flags('bits')
   end
-  
+
   def test_should_not_error_out_when_table_is_not_present
     assert_nothing_raised(ActiveRecord::StatementInvalid) do
       Planet.class_eval do
@@ -265,7 +279,14 @@ class FlagShihTzuClassMethodsTest < Test::Unit::TestCase
       end
     end
   end
-  
+
+  private
+
+  def assert_where_value(expected, scope)
+    assert_equal expected,
+      ActiveRecord::VERSION::MAJOR == 2 ? scope.proxy_options[:conditions] : scope.where_values.first
+  end
+
 end
 
 class FlagShihTzuInstanceMethodsTest < Test::Unit::TestCase
@@ -364,6 +385,27 @@ class FlagShihTzuInstanceMethodsTest < Test::Unit::TestCase
     assert @spaceship.warpdrive
   end
 
+  def test_should_define_dirty_suffix_changed?
+    assert !@spaceship.warpdrive_changed?
+    assert !@spaceship.shields_changed?
+
+    @spaceship.enable_flag(:warpdrive)
+    assert @spaceship.warpdrive_changed?
+    assert !@spaceship.shields_changed?
+
+    @spaceship.enable_flag(:shields)
+    assert @spaceship.warpdrive_changed?
+    assert @spaceship.shields_changed?
+
+    @spaceship.disable_flag(:warpdrive)
+    assert !@spaceship.warpdrive_changed?
+    assert @spaceship.shields_changed?
+
+    @spaceship.disable_flag(:shields)
+    assert !@spaceship.warpdrive_changed?
+    assert !@spaceship.shields_changed?
+  end
+
   def test_should_respect_true_values_like_active_record
     [true, 1, '1', 't', 'T', 'true', 'TRUE'].each do |true_value|
       @spaceship.warpdrive = true_value
@@ -375,7 +417,7 @@ class FlagShihTzuInstanceMethodsTest < Test::Unit::TestCase
       assert !@spaceship.warpdrive
     end
   end
-  
+
   def test_should_ignore_has_flags_call_if_column_does_not_exist_yet
     assert_nothing_raised do
       eval(<<-EOF
@@ -390,10 +432,10 @@ class FlagShihTzuInstanceMethodsTest < Test::Unit::TestCase
       EOF
       )
     end
-    
+
     assert !SpaceshipWithoutFlagsColumn.method_defined?(:warpdrive)
   end
-  
+
   def test_should_ignore_has_flags_call_if_column_not_integer
     assert_raises FlagShihTzu::IncorrectFlagColumnException do
       eval(<<-EOF
@@ -463,14 +505,14 @@ class FlagShihTzuDerivedClassTest < Test::Unit::TestCase
   end
 
   def test_enable_flag_should_leave_the_flag_enabled_when_called_twice
-    2.times do 
+    2.times do
       @spaceship.enable_flag(:warpdrive)
       assert @spaceship.flag_enabled?(:warpdrive)
     end
   end
 
   def test_disable_flag_should_leave_the_flag_disabled_when_called_twice
-    2.times do 
+    2.times do
       @spaceship.disable_flag(:warpdrive)
       assert !@spaceship.flag_enabled?(:warpdrive)
     end

data/test/test_helper.rb

@@ -1,35 +1,14 @@
-ENV['RAILS_ENV'] = 'test'
-ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+require "test/unit"
+require "yaml"
+require "logger"
+require "flag_shih_tzu"
 
-#exend LOAD_PATH for test with- and without Railsframework
-$LOAD_PATH << 'lib/'
-$LOAD_PATH << 'vendor/plugins/flag_shih_tzu/lib/'
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
 
-require 'test/unit'
-require 'yaml'
-require 'logger'
-require 'rubygems'
-gem 'activerecord', '~> 3.0'
-require 'active_record'
-require 'flag_shih_tzu' 
+configs = YAML.load_file(File.dirname(__FILE__) + "/database.yml")
+ActiveRecord::Base.configurations = configs
 
-def load_schema
-  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
-  ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
-  db_adapter = ENV['DB'] || 'sqlite3'
-  
-  # no DB passed, try sqlite3 by default
-  db_adapter ||=
-    begin
-      require 'sqlite3'
-        'sqlite3'
-    rescue MissingSourceFile 
-    end
-    
-  if db_adapter.nil? 
-    raise "No DB Adapter selected. Configure test/database.yml and use DB=mysql|postgresql|sqlite3 to pick one. sqlite3 will be used by default (gem install sqlite3-ruby)."
-  end
-  
-  ActiveRecord::Base.establish_connection(config[db_adapter])
-  load(File.dirname(__FILE__) + "/schema.rb")
-end
+db_name = ENV["DB"] || "sqlite"
+ActiveRecord::Base.establish_connection(db_name)
+
+load(File.dirname(__FILE__) + "/schema.rb")

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: flag_shih_tzu
 version: !ruby/object:Gem::Version 
-  hash: 961915980
-  prerelease: 6
+  hash: 17
+  prerelease: 
   segments: 
   - 0
-  - 1
-  - 0
-  - pre
-  version: 0.1.0.pre
+  - 2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Patryk Peszko
@@ -19,12 +18,99 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-09 00:00:00 +03:00
-default_executable: 
-dependencies: []
-
+date: 2011-10-31 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 4
+        - 2
+        version: 2.4.2
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
 description: |
-  This plugin lets you use a single integer column in an ActiveRecord model
+  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.
@@ -38,10 +124,14 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - Gemfile
 - README.rdoc
 - Rakefile
 - flag_shih_tzu.gemspec
+- gemfiles/Gemfile.activerecord-2.3.x
+- gemfiles/Gemfile.activerecord-3.0.x
+- gemfiles/Gemfile.activerecord-3.1.x
 - init.rb
 - lib/flag_shih_tzu.rb
 - lib/flag_shih_tzu/version.rb
@@ -49,7 +139,6 @@ files:
 - test/flag_shih_tzu_test.rb
 - test/schema.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: https://github.com/xing/flag_shih_tzu
 licenses: []
 
@@ -70,21 +159,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: A rails plugin to store a collection of boolean attributes in a single ActiveRecord column as a bit field
+summary: Bit fields for ActiveRecord
 test_files: 
 - test/database.yml
 - test/flag_shih_tzu_test.rb