hstore_flags 0.0.3

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+pkg

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+gemspec
+
+gem 'activerecord', '~>3.0'
+gem 'activerecord-postgres-hstore', '~>0.4'
+gem 'pg', '~>0.14'
+gem 'rspec', '~>2'
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,111 @@
+PATH
+  remote: .
+  specs:
+    hstore_flags (0.0.3)
+      activerecord (~> 3.0)
+      activerecord-postgres-hstore (~> 0.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.8)
+      actionpack (= 3.2.8)
+      mail (~> 2.4.4)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activerecord-postgres-hstore (0.4.1)
+      pg
+      rails
+      rake
+    activeresource (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.5)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.7)
+    pg (0.14.1)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.8)
+      actionmailer (= 3.2.8)
+      actionpack (= 3.2.8)
+      activerecord (= 3.2.8)
+      activeresource (= 3.2.8)
+      activesupport (= 3.2.8)
+      bundler (~> 1.0)
+      railties (= 3.2.8)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.34)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0)
+  activerecord-postgres-hstore (~> 0.4)
+  hstore_flags!
+  pg (~> 0.14)
+  rake
+  rspec (~> 2)

data/README.md

@@ -0,0 +1,43 @@
+HStore Flags
+------------
+
+integer/bit flags aggrevating you? try this.
+
+Requirements
+------------
+
+* Rails 3.0 or greater
+* Postgresql 8.4+ with contrib package
+* Read [activerecord-postgres-hstore](https://raw.github.com/engageis/activerecord-postgres-hstore) for index creation
+
+Installation
+------------
+
+TODO
+
+Usage
+-----
+
+```ruby
+# defining flags
+class User < ActiveRecord::Base
+  hstore_flags :active, :admin
+  hstore_flags :customer, :vendor, :drop_ship, field: "user_type"
+end
+
+class Group < ActiveRecord::Base
+  hstore_flags :active, :public, :invite_only, scopes: false
+end
+
+# setting flags
+u = User.new
+u.active = true
+u.vendor = false
+
+# automatic scope creation
+User.active.to_sql        #=> SELECT * FROM users WHERE (defined(flags, 'active') IS TRUE)
+User.not_drop_ship.to_sql #=> SELECT * FROM users WHERE (defined(user_type, 'drop_ship') IS NOT TRUE)
+```
+
+* `field` option defaults to `flags`
+* `scopes: false` disables scope creation. though im not sure how useful that is

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+RSpec::Core::RakeTask.new(:spec)

data/hstore_flags.gemspec

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require "hstore_flags/version"
+
+Gem::Specification.new do |s|
+  s.name          = "hstore_flags"
+  s.version       = HStoreFlags::VERSION
+  s.summary       = "Store many boolean flags in an hstore column in PostgreSQL"
+  s.authors       = ["Zachery Hostens"]
+  s.email         = "zachery.hostens@countrystone.com"
+  s.homepage      = "https://github.com/infinitysw/hstore_flags"
+  s.files         = `git ls-files`.split("\n")
+  s.license       = "MIT"
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activerecord", "~> 3.0"
+  s.add_dependency "activerecord-postgres-hstore", "~> 0.4"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "pg"
+end

data/lib/hstore_flags.rb

@@ -0,0 +1,60 @@
+require 'hstore_flags/version'
+require 'activerecord-postgres-hstore'
+
+module HStoreFlags
+  TRUE_VALUES = [true, 1, '1', 't', 'T', 'true', 'TRUE']
+
+  def self.included(base)
+    base.extend(ClassMethods)
+
+    protected
+    def set_hstore_flag_field(field, flag, value)
+      new_val = TRUE_VALUES.include?(value)
+      old_val = self.send(flag)
+      return if new_val == old_val
+
+      if defined? changed_attributes
+        send(:changed_attributes).merge!(flag.to_s => old_val)
+      end
+
+      if new_val
+        self[field] = (self[field] || {}).merge({flag.to_s => true.to_s})
+      else
+        self[field] && self[field].delete(flag.to_s)
+      end
+      send("#{field}_will_change!")
+      new_val
+    end
+  end
+
+  module ClassMethods
+    def hstore_flags(*args)
+      opts  = args.last.is_a?(Hash) ? args.pop.dup : {}
+      field = opts[:field] || "flags"
+      table_field = "#{self.table_name}." + field
+
+      args.each do |flag|
+        define_method("#{flag}")  {(self[field] || {})[flag.to_s] == "true"}
+        define_method("#{flag}?") {(self[field] || {})[flag.to_s] == "true"}
+        define_method("#{flag}=") {|val| set_hstore_flag_field(field, flag, val)}
+
+        unless opts[:scopes] == false
+          scope "#{flag}",     where("defined(#{table_field}, '#{flag}') IS TRUE")
+          scope "not_#{flag}", where("defined(#{table_field}, '#{flag}') IS NOT TRUE")
+
+          class_eval <<-EVAL
+            def self.#{flag}_condition
+              "(defined(#{table_field}, '#{flag}') IS TRUE)"
+            end
+
+            def self.not_#{flag}_condition
+              "(defined(#{table_field}, '#{flag}') IS NOT TRUE)"
+            end
+          EVAL
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, HStoreFlags)

data/lib/hstore_flags/version.rb

@@ -0,0 +1,3 @@
+module HStoreFlags
+  Version = VERSION = "0.0.3"
+end

data/spec/database.rb

@@ -0,0 +1,17 @@
+require 'active_record'
+
+# connect
+ActiveRecord::Base.establish_connection(
+  adapter: 'postgresql',
+  database: 'testing')
+
+ActiveRecord::Base.connection.execute("CREATE EXTENSION IF NOT EXISTS hstore")
+
+ActiveRecord::Schema.define(version: 1) do
+  execute "DROP TABLE IF EXISTS users"
+
+  create_table :users do |t|
+    t.column :flags, :hstore
+    t.column :more_flags, :hstore
+  end
+end

data/spec/hstore_flags_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+class User < ActiveRecord::Base
+  hstore_flags :fighter, :lover
+end
+
+class UserNoScopes < ActiveRecord::Base
+  self.table_name = "users"
+  hstore_flags :fighter, :lover, :referee, scopes: false
+end
+
+class UserMultiFlags < ActiveRecord::Base
+  self.table_name = "users"
+  hstore_flags :fighter, :lover, :referee
+  hstore_flags :drinker, :smoker, :bartender, field: "more_flags"
+end
+
+describe HStoreFlags do
+  it "creates accessors for flags" do
+    u = User.new(fighter: true)
+    expect(u.fighter).to eq(true)
+    expect(u.fighter?).to eq(true)
+    expect(u.lover).to eq(false)
+    expect(u.lover?).to eq(false)
+  end
+
+  it "creates scopes without scopes: false" do
+    expect(User).to respond_to(:fighter)
+    expect(User).to respond_to(:not_fighter)
+    expect(User).to respond_to(:lover)
+    expect(User).to respond_to(:not_lover)
+  end
+
+  it "does not create scopes with scopes: false" do
+    expect(UserNoScopes).not_to respond_to(:fighter)
+    expect(UserNoScopes).not_to respond_to(:not_fighter)
+    expect(UserNoScopes).not_to respond_to(:lover)
+    expect(UserNoScopes).not_to respond_to(:not_lover)
+  end
+
+  it "creates proper scopes when no field is defined" do
+    expect(User.fighter.to_sql).to match(/defined\(users.flags, 'fighter'\) IS TRUE/)
+    expect(User.not_fighter.to_sql).to match(/defined\(users.flags, 'fighter'\) IS NOT TRUE/)
+  end
+
+  it "creates proper scopes when field is defined" do
+    expect(UserMultiFlags.drinker.to_sql).to match(/defined\(users.more_flags, 'drinker'\) IS TRUE/)
+    expect(UserMultiFlags.not_drinker.to_sql).to match(/defined\(users.more_flags, 'drinker'\) IS NOT TRUE/)
+  end
+
+  it "updates changes with new bit values" do
+    u = User.new
+    expect(u.changes[:fighter]).to eq(nil)
+    u.fighter = true
+    expect(u.changes[:fighter]).to eq([false, true])
+    u.fighter = false
+    expect(u.changes[:fighter]).to eq([true, false]) # this is wrong, it should disappear
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+if ENV['VERSION']
+  gem 'activesupport', ENV['VERSION']
+  gem 'activerecord',  ENV['VERSION']
+end
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require 'active_record'
+require 'hstore_flags'
+require 'database'

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: hstore_flags
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Zachery Hostens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-09 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: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord-postgres-hstore
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: pg
+  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: 
+email: zachery.hostens@countrystone.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- hstore_flags.gemspec
+- lib/hstore_flags.rb
+- lib/hstore_flags/version.rb
+- spec/database.rb
+- spec/hstore_flags_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/infinitysw/hstore_flags
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1999031587017127090
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1999031587017127090
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Store many boolean flags in an hstore column in PostgreSQL
+test_files: []