tm-flagged 0.0.1.beta

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/CHANGELOG.rdoc

@@ -0,0 +1,9 @@
+== master
+
+== 0.0.1.alpha / 2010-11-10
+
+* fixed key checking
+
+== 0.0.1 / 2010-11-09
+
+* Initial version

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tom Meinlschmidt
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,56 @@
+= tm-flagged
+
+Original idea by github.com/xing/flag_shin_tzu
+
+warning:
+
+  NOT FOR PRODUCTION USE NOW
+
+==Installation
+
+  gem install tm-flagged
+
+==Usage
+
+===ActiveRecord
+
+You have to add one field to your model, eg. named +flags+
+
+  add_column :transactions, :flags, :integer, :default => 0
+
+===DataMapper
+
+just add new property
+  
+  property :flags, Integer, :default => 0
+
+===In model
+
+just add this +has_flags+ to your model to define flags
+
+  has_flags 1 => :sun,
+            2 => :clouds,
+            3 => :rain,
+            4 => :frogs,
+            5 => :ufo
+
+Then you could use autogenerated methods like
+
+  model.sun?   # => true/false
+  model.sun=true
+  model.sun    # => true/false
+
+If you want to use another column than +flags+, use +:column+ option
+
+  property :weather, Integer, :default => 0
+
+  has_flags 1 => :sun,
+            2 => :clouds,
+            :column => :weather
+
+  model.clouds?
+
+==License
+
+Copyright (c) 2010 Tom Meinlschmidt, see LICENSE file
+

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  require './lib/version.rb'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tm-flagged"
+    gem.summary = %Q{Add flags support to your model}
+    gem.description = %Q{Do not create more boolean fields :)}
+    gem.email = "tomas@meinlschmidt.com"
+    gem.homepage = "http://github.com/tmeinlschmidt/tm-flagged"
+    gem.authors = ["Tom Meinlschmidt"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.version = FlaggedModel::Version::STRING
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tm-flagged #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require 'tm-flagged'

data/lib/tm-flagged.rb

@@ -0,0 +1,160 @@
+# flagged model
+# original idea from xing/flag_shin_tzu
+# add fields "flags" as :integer
+# add "include FlaggedModel"
+# add has_flags 1 => :active, 2 => :common, 3 => :another, :column => 'flags'
+module FlaggedModel
+  
+  TRUE_VALUES = [true, 1, '1', 't', 'T', 'true', 'TRUE']
+  
+ # def self.included(base)
+ #   base.extend ClassMethods
+ # end
+
+  module ClassMethods
+
+    def has_flags(*args)
+      # process options
+      flag_hash, options = parse_options(*args)
+      options = {:named_scopes => true, :column => 'flags'}.update(options)
+      
+      # create class variables
+      class_inheritable_reader :flag_column
+      write_inheritable_attribute(:flag_column, options[:column])
+      flag_column = options[:column]
+      # check column
+     
+      raise ArgumentError, "has_flags: column named '#{flag_column}' doesn't exist" unless check_column_presence
+
+      # mappings
+      class_inheritable_hash :flag_mapping
+      write_inheritable_attribute(:flag_mapping, {}) unless flag_mapping
+      flag_mapping[flag_column] ||= {}
+    
+      # check & set the mappings values
+      flag_hash.each do |key, name|
+        # invalid attributes
+        raise ArgumentError, "has_flags: invalid key '#{name}'" unless valid_key?(key)
+        raise ArgumentError, "has_flags: invalid name '#{name}'" unless valid_name?(name)
+        raise ArgumentError, "has_flags: name exists '#{name}'" if method_defined?(name)
+        flag_mapping[flag_column][name] = to_bits(key)
+        
+        class_eval <<-EVAL
+          def #{name}
+            flag_enabled?(:#{name})
+          end
+
+          def #{name}?
+            flag_enabled?(:#{name})
+          end
+
+          def #{name}=(value)
+            FlaggedModel::TRUE_VALUES.include?(value) ? enable_flag(:#{name}) : disable_flag(:#{name})
+          end
+        EVAL
+      end
+      # pretty print
+      class_eval <<-EVAL
+        def pp_#{flag_column.to_s}
+          pretty_print_flags
+        end
+      EVAL
+    end
+
+    private
+  
+    def to_bits(key)
+      (1 << (key-1))
+    end
+
+    def check_column_presence
+      # ActiveRecord
+      if respond_to?(:columns) && defined?(ActiveRecord)
+        return columns.any?{|col| (col.name == flag_column.to_s && col.type == :integer)}
+      end
+      if respond_to?(:properties)
+        return (properties[flag_column.to_sym] && properties[flag_column.to_sym].class == DataMapper::Property::Integer)
+      end
+      false
+    end
+
+    # is key valid?
+    # suppose 64bit bigint ("select ~0;")
+    def valid_key?(key)
+      (key > 0 && key<=64 && key == key.to_i && !flag_mapping[flag_column].values.include?(to_bits(key)))
+    end
+
+    # is name valid?
+    def valid_name?(name)
+      (name.is_a?(Symbol) && !flag_mapping[flag_column].keys.include?(name))
+    end
+  
+    # parse options
+    def parse_options(*args)
+      options = args.shift
+      if args.size >= 1
+        add_options = args.shift
+      else
+        add_options = options.keys.select {|key| !key.is_a?(Fixnum)}.inject({}) do |hash, key|
+          hash[key] = options.delete(key)
+          hash
+        end
+      end
+      return options, add_options
+    end
+
+  end
+  
+  # pretty print flags set
+  def pretty_print_flags
+    get_flags.each do |name, val|
+      STDERR.puts "%1d :%s" % [flag_enabled?(name)?1:0, name] 
+    end
+    nil
+  end
+
+  # returns true if specified flag is TRUE
+  def flag_enabled?(flag)
+    (_flags & get_flag(flag)) == get_flag(flag)
+  end
+
+  # !dtto
+  def flag_disabled?(flag)
+    !flag_enabled?(flag)
+  end
+
+  # set flag to 1
+  def enable_flag(flag)
+    set_flags(_flags | get_flag(flag))
+  end
+
+  # reset flag to 0
+  def disable_flag(flag)
+    set_flags(_flags & ~get_flag(flag))
+  end
+
+  # get all the flags
+  def get_flags
+    self.class.flag_mapping[self.class.flag_column]
+  end
+
+  # get specified flag
+  def get_flag(flag)
+    get_flags[flag]
+  end
+
+  # get flag column
+  def _flags
+    self[self.class.flag_column] || 0
+  end
+  
+  # get flags
+  def set_flags(value)
+    self[self.class.flag_column] = value
+  end
+end
+
+Class.class_eval do
+  include FlaggedModel::ClassMethods
+end
+

data/lib/version.rb

@@ -0,0 +1,10 @@
+module FlaggedModel
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+    BUILD = 'beta'
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tm-flagged'
+
+class Test::Unit::TestCase
+end

data/test/test_tm-flagged.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestTmFlagged < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/tm-flagged.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tm-flagged}
+  s.version = "0.0.1.beta"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tom Meinlschmidt"]
+  s.date = %q{2010-11-10}
+  s.description = %q{Do not create more boolean fields :)}
+  s.email = %q{tomas@meinlschmidt.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGELOG.rdoc",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "init.rb",
+     "lib/tm-flagged.rb",
+     "lib/version.rb",
+     "test/helper.rb",
+     "test/test_tm-flagged.rb",
+     "tm-flagged.gemspec"
+  ]
+  s.homepage = %q{http://github.com/tmeinlschmidt/tm-flagged}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Add flags support to your model}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_tm-flagged.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: tm-flagged
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 0
+  - 0
+  - 1
+  - beta
+  version: 0.0.1.beta
+platform: ruby
+authors: 
+- Tom Meinlschmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-10 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Do not create more boolean fields :)
+email: tomas@meinlschmidt.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- CHANGELOG.rdoc
+- LICENSE
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/tm-flagged.rb
+- lib/version.rb
+- test/helper.rb
+- test/test_tm-flagged.rb
+- tm-flagged.gemspec
+has_rdoc: true
+homepage: http://github.com/tmeinlschmidt/tm-flagged
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Add flags support to your model
+test_files: 
+- test/helper.rb
+- test/test_tm-flagged.rb