bitfields 0.2.1 → 0.2.2

data/Rakefile

@@ -11,12 +11,11 @@ end
 
 begin
   require 'jeweler'
-  project_name = 'bitfields'
   Jeweler::Tasks.new do |gem|
-    gem.name = project_name
+    gem.name = 'bitfields'
     gem.summary = "Save migrations and columns by storing multiple booleans in a single integer."
     gem.email = "grosser.michael@gmail.com"
-    gem.homepage = "http://github.com/grosser/#{project_name}"
+    gem.homepage = "http://github.com/grosser/#{gem.name}"
     gem.authors = ["Michael Grosser"]
   end
 

data/{README.markdown → Readme.md}

@@ -42,7 +42,8 @@ TIPS
 ====
  - Never do: "#{bitfield_sql(...)} AND #{bitfield_sql(...)}", merge both into one hash
  - bit_operator is faster in most cases, use :query_mode => :in_list sparingly
- - standard mysql integer is 4 byte -> 32 bitfields
+ - Standard mysql integer is 4 byte -> 32 bitfields
+ - If you are lazy or bad at math you can also do `bitfields :bits, :foo, :bar, :baz`
 
 ![performance](http://chart.apis.google.com/chart?chtt=bit-operator+vs+IN+--+with+index&chd=s:CEGIKNPRUW,DEHJLOQSVX,CFHKMPSYXZ,DHJMPSVYbe,DHLPRVZbfi,FKOUZeinsx,FLQWbglqw2,HNTZfkqw19,BDEGHJLMOP,BDEGIKLNOQ,BDFGIKLNPQ,BDFGILMNPR,BDFHJKMOQR,BDFHJLMOQS,BDFHJLNPRT,BDFHJLNPRT&chxt=x,y&chxl=0:|100K|200K|300K|400K|500K|600K|700K|800K|900K|1000K|1:|0|1441.671ms&cht=lc&chs=600x500&chdl=2bits+%28in%29|3bits+%28in%29|4bits+%28in%29|6bits+%28in%29|8bits+%28in%29|10bits+%28in%29|12bits+%28in%29|14bits+%28in%29|2bits+%28bit%29|3bits+%28bit%29|4bits+%28bit%29|6bits+%28bit%29|8bits+%28bit%29|10bits+%28bit%29|12bits+%28bit%29|14bits+%28bit%29&chco=0000ff,0000ee,0000dd,0000cc,0000bb,0000aa,000099,000088,ff0000,ee0000,dd0000,cc0000,bb0000,aa0000,990000,880000)
 
@@ -50,8 +51,11 @@ TODO
 ====
  - convenient named scope `User.with_bitfields(:xxx=>true, :yy=>false)`
 
-Author
-======
-[Michael Grosser](http://pragmatig.wordpress.com)  
-grosser.michael@gmail.com  
+Authors
+=======
+### [Contributors](http://github.com/grosser/bitfields/contributors)
+ - [Hellekin O. Wolf](https://github.com/hellekin)
+
+[Michael Grosser](http://grosser.it)  
+michael@grosser.it  
 Hereby placed under public domain, do what you want, just do not hold me accountable...

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/bitfields.gemspec

@@ -5,18 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bitfields}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Grosser"]
-  s.date = %q{2011-01-22}
+  s.date = %q{2011-02-04}
   s.email = %q{grosser.michael@gmail.com}
-  s.extra_rdoc_files = [
-    "README.markdown"
-  ]
   s.files = [
-    "README.markdown",
     "Rakefile",
+    "Readme.md",
     "VERSION",
     "benchmark/bit_operator_vs_in.rb",
     "bitfields.gemspec",

data/lib/bitfields.rb

@@ -3,6 +3,7 @@ require 'active_support'
 module Bitfields
   VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
   TRUE_VALUES = [true, 1, '1', 't', 'T', 'true', 'TRUE'] # taken from ActiveRecord::ConnectionAdapters::Column
+  class DuplicateBitNameError < ArgumentError; end
 
   def self.included(base)
     base.class_inheritable_accessor :bitfields, :bitfield_options
@@ -14,6 +15,7 @@ module Bitfields
     options.keys.select{|key| key.is_a?(Fixnum) }.each do |bit|
       raise "#{bit} is not a power of 2 !!" unless bit.to_s(2).scan('1').size == 1
       bit_name = options.delete(bit).to_sym
+      raise DuplicateBitNameError if bitfields.include?(bit_name)
       bitfields[bit_name] = bit
     end
     bitfields
@@ -26,10 +28,11 @@ module Bitfields
   end
 
   module ClassMethods
-    def bitfield(column, options)
+    def bitfield(column, *args)
       # prepare ...
       column = column.to_sym
-      options = options.dup # since we will modify them...
+      options = (args.last.is_a?(Hash) ? args.pop.dup : {}) # since we will modify them...
+      args.each_with_index{|field,i| options[2**(i+1)] = field } # add fields given in normal args to options
 
       # extract options
       self.bitfields ||= {}

data/spec/bitfields_spec.rb

@@ -36,6 +36,23 @@ class BitOperatorMode < ActiveRecord::Base
   bitfield :bits, 1 => :seller, 2 => :insane, :query_mode => :bit_operator
 end
 
+class WithoutThePowerOfTwo < ActiveRecord::Base
+  set_table_name 'users'
+  include Bitfields
+  bitfield :bits, :seller, :insane, :query_mode => :bit_operator
+end
+
+class WithoutThePowerOfTwoWithoutOptions < ActiveRecord::Base
+  set_table_name 'users'
+  include Bitfields
+  bitfield :bits, :seller, :insane
+end
+
+class CheckRaise < ActiveRecord::Base
+  set_table_name 'users'
+  include Bitfields
+end
+
 class ManyBitsUser < User
   set_table_name 'users'
 end
@@ -215,6 +232,30 @@ describe Bitfields do
         BitOperatorMode.all(:conditions => MultiBitUser.bitfield_sql(:seller => true, :insane => false)).should == [u2]
       end
     end
+
+    describe 'without the power of two' do
+      it 'has all fields' do
+        u = WithoutThePowerOfTwo.create!(:seller => false, :insane => true)
+        u.seller.should == false
+        u.insane.should == true
+        WithoutThePowerOfTwo.bitfield_options.should == {:bits=>{:query_mode=>:bit_operator}}
+      end
+
+      it "can e built without options" do
+        u = WithoutThePowerOfTwoWithoutOptions.create!(:seller => false, :insane => true)
+        u.seller.should == false
+        u.insane.should == true
+        WithoutThePowerOfTwoWithoutOptions.bitfield_options.should == {:bits=>{}}
+      end
+    end
+
+    it "checks that bitfields are unique" do
+      lambda{
+        CheckRaise.class_eval do
+          bitfield :foo, :bar, :baz, :bar
+        end
+      }.should raise_error(Bitfields::DuplicateBitNameError)
+    end
   end
 
   describe :set_bitfield_sql do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bitfields
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Michael Grosser
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-22 00:00:00 +01:00
+date: 2011-02-04 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -25,11 +25,11 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.markdown
+extra_rdoc_files: []
+
 files: 
-- README.markdown
 - Rakefile
+- Readme.md
 - VERSION
 - benchmark/bit_operator_vs_in.rb
 - bitfields.gemspec