bitfields 0.4.0 → 0.4.1

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - ree
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -1,9 +1,7 @@
 source :rubygems
+gemspec
 
-group :dev do
-  gem 'activerecord', ENV['AR']
-  gem 'sqlite3'
-  gem 'rake'
-  gem 'rspec', '~>2'
-  gem 'jeweler'
-end
+gem 'activerecord', ENV['AR']
+gem 'sqlite3'
+gem 'rake'
+gem 'rspec', '~>2'

data/Gemfile.lock

@@ -1,3 +1,8 @@
+PATH
+  remote: .
+  specs:
+    bitfields (0.4.1)
+
 GEM
   remote: http://rubygems.org/
   specs:
@@ -17,12 +22,7 @@ GEM
     bcrypt-ruby (2.1.4)
     builder (3.0.0)
     diff-lcs (1.1.2)
-    git (1.2.5)
     i18n (0.6.0)
-    jeweler (1.6.2)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
     multi_json (1.0.3)
     rake (0.9.2)
     rspec (2.6.0)
@@ -41,7 +41,7 @@ PLATFORMS
 
 DEPENDENCIES
   activerecord
-  jeweler
+  bitfields!
   rake
   rspec (~> 2)
   sqlite3

data/Rakefile

@@ -1,24 +1,29 @@
-task :default do
+require 'bundler/gem_tasks'
+
+task :spec do
   sh "rspec spec"
 end
 
-task :all do
-  sh "AR=2.3.12 bundle && bundle exec rake"
-  sh "AR=3.0.8 bundle && bundle exec rake"
-  sh "AR=3.1.0.rc4 bundle && bundle exec rake"
+task :default do
+  sh "AR=2.3.14 && (bundle check || bundle install) && bundle exec rake spec"
+  sh "AR=3.0.12 && (bundle check || bundle install) && bundle exec rake spec"
+  sh "AR=3.1.4 && (bundle check || bundle install) && bundle exec rake spec"
+  sh "AR=3.2.3 && (bundle check || bundle install) && bundle exec rake spec"
 end
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    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/#{gem.name}"
-    gem.authors = ["Michael Grosser"]
-  end
+# extracted from https://github.com/grosser/project_template
+rule /^version:bump:.*/ do |t|
+  sh "git status | grep 'nothing to commit'" # ensure we are not dirty
+  index = ['major', 'minor','patch'].index(t.name.split(':').last)
+  file = 'lib/bitfields/version.rb'
+
+  version_file = File.read(file)
+  old_version, *version_parts = version_file.match(/(\d+)\.(\d+)\.(\d+)/).to_a
+  version_parts[index] = version_parts[index].to_i + 1
+  version_parts[2] = 0 if index < 2 # remove patch for minor
+  version_parts[1] = 0 if index < 1 # remove minor for major
+  new_version = version_parts * '.'
+  File.open(file,'w'){|f| f.write(version_file.sub(old_version, new_version)) }
 
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+  sh "bundle && git add #{file} Gemfile.lock && git commit -m 'bump version to #{new_version}'"
 end

data/Readme.md

@@ -26,6 +26,7 @@ Or as Rails plugin: ` rails plugin install git://github.com/grosser/bitfields.gi
 
 ### Migration
 ALWAYS set a default, bitfield queries will not work for NULL
+
     t.integer :my_bits, :default => 0, :null => false
     OR
     add_column :users, :my_bits, :integer, :default => 0, :null => false
@@ -33,19 +34,27 @@ ALWAYS set a default, bitfield queries will not work for NULL
 Examples
 ========
 Update all users
+
     User.seller.not_stupid.update_all(User.set_bitfield_sql(:seller => true, :insane => true))
 
 Delete the shop when a user is no longer a seller
+
     before_save :delete_shop, :if => lambda{|u| u.changes['seller'] == [true, false]}
 
 TIPS
 ====
  - [Upgrading] in version 0.2.2 the first field(when not given as hash) used bit 2 -> add a bogus field in first position
+ - [Defaults] afaik it is not possible to have some bits true by default (without monkeypatching AR/see [tests](https://github.com/grosser/bitfields/commit/2170dc546e2c4f1187089909a80e8602631d0796)) -> choose a good naming like `xxx_on` / `xxx_off` to use the default 'false'
  - 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
  - If you are lazy or bad at math you can also do `bitfields :bits, :foo, :bar, :baz`
 
+Query-mode Benchmark
+=========
+The `:query_mode => :in_list` is slower for most queries and scales mierably with the number of bits.<br/>
+*Stay with the default query-mode*. Only use :in_list if your edge-case shows better performance.
+
 ![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)
 
 TODO
@@ -59,4 +68,6 @@ Authors
 
 [Michael Grosser](http://grosser.it)<br/>
 michael@grosser.it<br/>
-Hereby placed under public domain, do what you want, just do not hold me accountable...
+License: MIT<br/>
+[![Build Status](https://secure.travis-ci.org/grosser/bitfields.png)](http://travis-ci.org/grosser/bitfields)
+

data/bitfields.gemspec

@@ -1,41 +1,12 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+name = "bitfields"
+require "#{name}/version"
 
-Gem::Specification.new do |s|
-  s.name = %q{bitfields}
-  s.version = "0.4.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+Gem::Specification.new name, Bitfields::VERSION do |s|
+  s.summary = "Save migrations and columns by storing multiple booleans in a single integer"
   s.authors = ["Michael Grosser"]
-  s.date = %q{2011-06-21}
-  s.email = %q{grosser.michael@gmail.com}
-  s.files = [
-    "Gemfile",
-    "Gemfile.lock",
-    "Rakefile",
-    "Readme.md",
-    "VERSION",
-    "benchmark/bit_operator_vs_in.rb",
-    "bitfields.gemspec",
-    "lib/bitfields.rb",
-    "spec/bitfields_spec.rb",
-    "spec/database.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/grosser/bitfields}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{Save migrations and columns by storing multiple booleans in a single integer.}
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
+  s.email = "michael@grosser.it"
+  s.homepage = "http://github.com/grosser/#{name}"
+  s.files = `git ls-files`.split("\n")
+  s.license = 'MIT'
 end
-

data/lib/bitfields.rb

@@ -1,15 +1,29 @@
+require 'bitfields/version'
 require 'active_support'
 require 'active_support/version'
 
 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)
     class << base
-      attr_accessor :bitfields, :bitfield_options
+      attr_accessor :bitfields, :bitfield_options, :bitfield_args
+      
+      # all the args passed into .bitfield so children can initialize from parents
+      def bitfield_args
+        @bitfield_args ||= []
+      end
+
+      def inherited(klass)
+        super
+        klass.bitfield_args = bitfield_args.dup
+        klass.bitfield_args.each do |column, options|
+          klass.send :store_bitfield_values, column, options.dup
+        end
+      end
     end
+
     base.extend Bitfields::ClassMethods
   end
 
@@ -26,56 +40,70 @@ module Bitfields
 
   # AR 3+ -> :scope, below :named_scope
   def self.ar_scoping_method
-    return :scope if defined?(ActiveRecord::VERSION::MAJOR) and ActiveRecord::VERSION::MAJOR >= 3
-    :named_scope
+    if defined?(ActiveRecord::VERSION::MAJOR) and ActiveRecord::VERSION::MAJOR >= 3
+      :scope
+    else
+      :named_scope
+    end
   end
 
   module ClassMethods
     def bitfield(column, *args)
-      # prepare ...
       column = column.to_sym
-      options = (args.last.is_a?(Hash) ? args.pop.dup : {}) # since we will modify them...
-      args.each_with_index{|field,i| options[2**i] = field } # add fields given in normal args to options
-
-      # extract options
-      self.bitfields ||= {}
-      self.bitfield_options ||= {}
-      bitfields[column] = Bitfields.extract_bits(options)
-      bitfield_options[column] = options
+      options = extract_bitfield_options args
+      bitfield_args << [column, options.dup]
 
-      # add instance methods and scopes
-      bitfields[column].keys.each do |bit_name|
-        define_method(bit_name){ bitfield_value(bit_name) }
-        define_method("#{bit_name}?"){ bitfield_value(bit_name) }
-        define_method("#{bit_name}="){|value| set_bitfield_value(bit_name, value) }
-        if options[:scopes] != false
-          scoping_method = Bitfields.ar_scoping_method
-          send scoping_method, bit_name, :conditions => bitfield_sql(bit_name => true)
-          send scoping_method, "not_#{bit_name}", :conditions => bitfield_sql(bit_name => false)
-        end
-      end
-
-      include Bitfields::InstanceMethods
+      store_bitfield_values column, options
+      add_bitfield_methods column, options
     end
 
     def bitfield_column(bit_name)
-      found = bitfields.detect{|c, bits| bits.keys.include?(bit_name.to_sym) }
+      found = bitfields.detect{|_, bits| bits.keys.include?(bit_name.to_sym) }
       raise "Unknown bitfield #{bit_name}" unless found
       found.first
     end
 
     def bitfield_sql(bit_values, options={})
-      bits = group_bits_by_column(bit_values).sort_by{|c,v| c.to_s }
+      bits = group_bits_by_column(bit_values).sort_by{|c,_| c.to_s }
       bits.map{|column, bit_values| bitfield_sql_by_column(column, bit_values, options) } * ' AND '
     end
 
     def set_bitfield_sql(bit_values)
-      bits = group_bits_by_column(bit_values).sort_by{|c,v| c.to_s }
+      bits = group_bits_by_column(bit_values).sort_by{|c,_| c.to_s }
       bits.map{|column, bit_values| set_bitfield_sql_by_column(column, bit_values) } * ', '
     end
 
     private
 
+    def extract_bitfield_options(args)
+      options = (args.last.is_a?(Hash) ? args.pop.dup : {})
+      args.each_with_index{|field,i| options[2**i] = field } # add fields given in normal args to options
+      options
+    end
+
+    def store_bitfield_values(column, options)
+      self.bitfields ||= {}
+      self.bitfield_options ||= {}
+      bitfields[column] = Bitfields.extract_bits(options)
+      bitfield_options[column] = options
+    end
+
+    def add_bitfield_methods(column, options)
+      bitfields[column].keys.each do |bit_name|
+        define_method(bit_name) { bitfield_value(bit_name) }
+        define_method("#{bit_name}?") { bitfield_value(bit_name) }
+        define_method("#{bit_name}=") { |value| set_bitfield_value(bit_name, value) }
+
+        if options[:scopes] != false
+          scoping_method = Bitfields.ar_scoping_method
+          send scoping_method, bit_name, :conditions => bitfield_sql(bit_name => true)
+          send scoping_method, "not_#{bit_name}", :conditions => bitfield_sql(bit_name => false)
+        end
+      end
+
+      include Bitfields::InstanceMethods
+    end
+
     def bitfield_sql_by_column(column, bit_values, options={})
       mode = options[:query_mode] || (bitfield_options[column][:query_mode] || :bit_operator)
       case mode
@@ -122,13 +150,13 @@ module Bitfields
 
   module InstanceMethods
     def bitfield_values(column)
-      Hash[self.class.bitfields[column.to_sym].map{|bit_name, bit| [bit_name, bitfield_value(bit_name)]}]
+      Hash[self.class.bitfields[column.to_sym].map{|bit_name, _| [bit_name, bitfield_value(bit_name)]}]
     end
 
     private
 
     def bitfield_value(bit_name)
-      column, bit, current_value = bitfield_info(bit_name)
+      _, bit, current_value = bitfield_info(bit_name)
       current_value & bit != 0
     end
 

data/lib/bitfields/version.rb

@@ -0,0 +1,3 @@
+module Bitfields
+  Version = VERSION = "0.4.1"
+end

data/spec/bitfields_spec.rb

@@ -1,4 +1,4 @@
-require 'spec/spec_helper'
+require 'spec_helper'
 
 class User < ActiveRecord::Base
   include Bitfields
@@ -23,9 +23,26 @@ class UserWithoutScopes < ActiveRecord::Base
   bitfield :bits, 1 => :seller, 2 => :insane, 4 => :stupid, :scopes => false
 end
 
+class UserWithoutSetBitfield < ActiveRecord::Base
+  set_table_name 'users'
+  include Bitfields
+end
+
 class InheritedUser < User
 end
 
+class GrandchildInheritedUser < InheritedUser
+end
+
+# other children should not disturb the inheritance
+class OtherInheritedUser < UserWithoutSetBitfield
+  set_table_name 'users'
+  bitfield :bits, 1 => :seller_inherited
+end
+
+class InheritedUserWithoutSetBitfield < UserWithoutSetBitfield
+end
+
 class OverwrittenUser < User
   bitfield :bits, 1 => :seller_inherited
 end
@@ -57,6 +74,16 @@ class ManyBitsUser < User
   set_table_name 'users'
 end
 
+class InitializedUser < User
+  set_table_name 'users'
+  bitfield :bits, 1 => :seller, 2 => :insane, 4 => :stupid, :scopes => false
+
+  after_initialize do
+    self.seller = true
+    self.insane = false
+  end
+end
+
 describe Bitfields do
   before do
     User.delete_all
@@ -346,12 +373,48 @@ describe Bitfields do
       OverwrittenUser.bitfields.should == {:bits=>{:seller_inherited=>1}}
     end
 
-    xit "knows inherited values when overwriting" do
-      OverwrittenUser.bitfield_column(:seller).should == :bits
+    it "knows overwritten values when overwriting" do
+      OverwrittenUser.bitfield_column(:seller_inherited).should == :bits
     end
 
-    xit "knows inherited values without overwriting" do
+    it "does not know old values when overwriting" do
+      expect{
+        OverwrittenUser.bitfield_column(:seller)
+      }.to raise_error
+    end
+
+    it "knows inherited values without overwriting" do
       InheritedUser.bitfield_column(:seller).should == :bits
     end
+
+    it "has inherited scopes" do
+      InheritedUser.should respond_to(:not_seller)
+    end
+
+    it "has inherited methods" do
+      InheritedUser.new.should respond_to(:seller?)
+    end
+
+    it "knows grandchild inherited values without overwriting" do
+      GrandchildInheritedUser.bitfield_column(:seller).should == :bits
+    end
+
+    it "inherits no bitfields for a user without bitfields set" do
+      InheritedUserWithoutSetBitfield.bitfields.should be_nil
+    end
+  end
+
+  describe 'initializers' do
+    it "sets defaults" do
+      InitializedUser.new.seller.should == true
+      InitializedUser.new.insane.should == false
+    end
+
+    it "can overwrite defaults in new" do
+      pending do
+        InitializedUser.new(:seller => false).seller.should == false
+        InitializedUser.new(:insane => true).insane.should == true
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -10,4 +10,4 @@ require 'timeout'
 require 'active_record'
 puts "Using ActiveRecord #{ActiveRecord::VERSION::STRING}"
 
-require 'spec/database'
+require File.expand_path('../database', __FILE__)

metadata

@@ -1,77 +1,63 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bitfields
-version: !ruby/object:Gem::Version 
-  hash: 15
+version: !ruby/object:Gem::Version
+  version: 0.4.1
   prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 0
-  version: 0.4.0
 platform: ruby
-authors: 
+authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-21 00:00:00 +02:00
-default_executable: 
+date: 2012-05-26 00:00:00.000000000 Z
 dependencies: []
-
 description: 
-email: grosser.michael@gmail.com
+email: michael@grosser.it
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - Rakefile
 - Readme.md
-- VERSION
 - benchmark/bit_operator_vs_in.rb
 - bitfields.gemspec
 - lib/bitfields.rb
+- lib/bitfields/version.rb
 - spec/bitfields_spec.rb
 - spec/database.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/grosser/bitfields
-licenses: []
-
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 4196443429503694670
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 4196443429503694670
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Save migrations and columns by storing multiple booleans in a single integer.
+summary: Save migrations and columns by storing multiple booleans in a single integer
 test_files: []
-

data/VERSION

@@ -1 +0,0 @@
-0.4.0