bitmask_attributes_helpers 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,11 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+\#*
+.#*
+*.gem
+/nbproject
+.idea/
+.bundle

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@bitmask_attributes_helpers --create --install

data/.travis.yml

@@ -0,0 +1,4 @@
+script: 'bundle exec rspec'
+language: ruby
+rvm:
+  - 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+Changelog
+=========
+
+## Version 0.0.1 - June 26th, 2013 ##
+* Initial commits on bitmask_attributes_helpers, adding:
+  * Model.<_VALUE_> scopes
+  * Model.not_<_VALUE_> scopes
+  * Model#<_VALUE_>? checker
+  * Model#<_VALUE_> virtual attributes and setters

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'sqlite3', '>=1.3.5'
+gem 'turn'
+gem 'squeel'
+gem 'bitmask_attributes'

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    bitmask_attributes_helpers (0.0.1)
+      bitmask_attributes
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    ansi (1.4.2)
+    arel (3.0.2)
+    bitmask_attributes (0.4.0)
+      activerecord (~> 3.0)
+    builder (3.0.4)
+    diff-lcs (1.2.4)
+    i18n (0.6.1)
+    multi_json (1.7.7)
+    polyamorous (0.5.0)
+      activerecord (~> 3.0)
+    rake (0.9.2.2)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    sqlite3 (1.3.5)
+    squeel (1.0.18)
+      activerecord (~> 3.0)
+      activesupport (~> 3.0)
+      polyamorous (~> 0.5.0)
+    turn (0.8.3)
+      ansi
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bitmask_attributes
+  bitmask_attributes_helpers!
+  rake
+  rspec
+  sqlite3 (>= 1.3.5)
+  squeel
+  turn

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Ryan Chan
+
+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,68 @@
+BitmaskAttributesHelpers
+========================
+
+Quick and simple helpers for Joel Moss' bitmask_attributes gem. These
+helpers include frequently used checkers, setters, getters, and scopes
+pertaining to the bitmasks.
+
+
+## Installation ##
+
+The best way to install is with RubyGems:
+
+    $ [sudo] gem install bitmask_attributes_helpers
+
+Or better still, just add it to your Gemfile:
+
+    gem 'bitmask_attributes_helpers'
+
+
+## Examples/Usage ##
+
+There are four class methods we use to install the requisite helpers:
+`bitmask_presence_methods`, `bitmask_scopes`, `bitmask_virtual_attributes`,
+and `bitmask_helpers`. Each takes the name of the bitmask as an argument.
+
+```Ruby
+  class Model < ActiveRecord::Base
+    bitmask :colors, as: [:red, :blue, :green]
+
+    bitmask_presence_methods :colors
+    # Enables value checkers, i.e.
+    # model.red? => true if model has the red bitmask attribute set
+
+    bitmask_scopes :colors
+    # Enables scopes to search Model by bitmask values, i.e.
+    # Model.red => all models which have the red bit set to true
+    # Model.not_red => all models which have the red bit set to false
+
+    bitmask_virtual_attributes :colors
+    # Creates a virtual attribute on the model for each value of the bitmask,
+      i.e.
+    # model.red = true => sets the red bitmask to true
+    # model.red => true, as we've sets the bitmask to true
+
+    bitmask_helpers :colors
+    # This is a macro to enable all of the above for a specific bitmask
+  ...
+```
+
+=== Contributing
+
+1. Fork it.
+2. Create a branch (`git checkout -b new-feature`)
+3. Make your changes
+4. Run the tests (`bundle install` then `bundle exec rake`)
+5. Commit your changes (`git commit -am "Created new feature"`)
+6. Push to the branch (`git push origin new-feature`)
+7. Create a {pull request}[http://help.github.com/send-pull-requests/] from your branch.
+8. Promote it. Get others to drop in and +1 it.
+
+
+=== Credits
+
+{Joel Moss}[https://github.com/joelmoss] deserves all the credit for his wonderful bitmask_attributes gem
+
+=== Copyright
+
+Copyright (c) 2013 Ryan Chan

data/Rakefile

@@ -0,0 +1,144 @@
+# encoding: UTF-8
+
+require "bundler"
+Bundler::GemHelper.install_tasks
+Bundler.setup
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}/version.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+require 'rdoc/task'
+require 'sdoc'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.options << '-f' << 'sdoc'
+  rdoc.options << '-a'
+  rdoc.options << '--markup' << 'tomdoc'
+  rdoc.options << '-m' << 'README.rdoc'
+  rdoc.rdoc_files.include('CHANGELOG*')
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+#############################################################################
+#
+# Changeling
+#
+#############################################################################
+
+namespace :changeling do
+  # desc "Bumps the version by a minor or patch version, depending on what was passed in."
+  task :bump, :part do |t, args|
+    unless `git branch` =~ /^\* master$/
+      puts "You must be on the master branch to bump the version!"
+      exit!
+    end
+
+    # Thanks, Jeweler!
+    if BitmaskAttributesHelper::VERSION  =~ /^(\d+)\.(\d+)\.(\d+)(?:\.(.*?))?$/
+      major = $1.to_i
+      minor = $2.to_i
+      patch = $3.to_i
+
+      if $4 =~ /([a-z]+)(\d+)?/i
+        pre_name    = $1
+        pre_version = ($2 || 0).to_i
+      end
+    else
+      abort
+    end
+
+    case args[:part]
+    when /minor/
+      minor += 1
+      patch = 0
+    when /patch/
+      patch += 1
+    when /pre/
+      pre_version += 1
+      pre = "#{pre_name}#{pre_version}"
+    else
+      abort
+    end
+
+    version = [major, minor, patch, pre].compact.join('.')
+
+    File.open(File.join("lib", name, "version.rb"), "w") do |f|
+      f.write <<EOF
+module BitmaskAttributesHelper
+  VERSION = "#{version}".freeze
+end
+EOF
+    end
+  end
+
+  # desc "Writes out the new CHANGELOG and prepares the release"
+  task :change do
+    unless `git branch` =~ /^\* master$/
+      puts "You must be on the master branch to update changelog!"
+      exit!
+    end
+
+    load "lib/#{name}/version.rb"
+    file    = "CHANGELOG.md"
+    old     = File.read(file)
+    message = "Bumping to version #{version}"
+
+    File.open(file, "w") do |f|
+      f.write <<EOF
+## Version #{version} - #{Time.now} ##
+
+#{`git log $(git tag | tail -1)..HEAD | git shortlog`.gsub /\s{6}/, "\n*"}
+#{old}
+EOF
+    end
+
+    Rake::Task['build'].invoke
+    exec ["#{ENV["EDITOR"]} #{file}",
+          "git commit -aqm '#{message}'",
+          "git tag -a -m '#{message}' v#{version}",
+          "git push origin master",
+          "git push origin $(git tag | tail -1)",
+          "gem push pkg/#{name}-#{version}.gem",
+          "echo '\n\033[32mReleased v#{version} /' `git show-ref -s refs/heads/master` '.\033[0m\n'"].join(' && ')
+  end
+
+  desc "Bump by a minor version (1.2.3 => 1.3.0)"
+  task :minor do |t|
+    Rake::Task['changeling:bump'].invoke(t.name)
+    Rake::Task['changeling:change'].invoke
+  end
+
+  desc "Bump by a patch version, (1.2.3 => 1.2.4)"
+  task :patch do |t|
+    Rake::Task['changeling:bump'].invoke(t.name)
+    Rake::Task['changeling:change'].invoke
+  end
+
+  desc "Bump by a pre-release version, (1.0.0.pre1 => 1.0.0.pre2)"
+  task :pre do |t|
+    Rake::Task['changeling:bump'].invoke(t.name)
+    Rake::Task['changeling:change'].invoke
+  end
+end

data/bitmask_attributes_helpers.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bitmask_attributes_helpers/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "bitmask_attributes_helpers"
+  gem.summary       = %Q{Getters, setters, and scopes for Joel Moss's bitmask_attributes gem}
+  gem.email         = "ryan@ryanlchan"
+  gem.homepage      = "http://github.com/ryanlchan/bitmask_attributes_helpers"
+  gem.authors       = ['Ryan Chan']
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ['lib']
+  gem.version       = BitmaskAttributesHelpers::VERSION.dup
+
+  gem.add_dependency 'bitmask_attributes'
+end

data/info/exclude

@@ -0,0 +1,6 @@
+# git ls-files --others --exclude-from=.git/info/exclude
+# Lines that start with '#' are comments.
+# For a project mostly in C, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~

data/lib/bitmask_attributes_helpers.rb

@@ -0,0 +1,57 @@
+module BitmaskAttributesHelpers
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    # Helps set up presence + scopes for bitmasked attributes
+
+    # Setup presence checking methods for Bitmask attributes
+    #
+    # Presence attributes are setup as the possible values suffixed by a
+    # question mark, and return true or false
+    # @arg [Symbol] bitmask the name of the bitmask attribute
+    def bitmask_presence_methods(bitmask)
+      send("values_for_#{bitmask}").each do |value|
+        define_method "#{value}?" do
+          send("#{bitmask}?", value)
+        end
+      end
+    end
+
+    # Setup scopes for Bitmask attributes
+    #
+    # Scopes are setup with the same name as the value, and include both
+    # .value and .not_value versions
+    # @arg [Symbol] bitmask the name of the bitmask attribute
+    def bitmask_scopes(bitmask)
+      send("values_for_#{bitmask}").each do |value|
+        scope value, send("with_#{bitmask}", value)
+        scope "not_#{value}", send("without_#{bitmask}", value)
+      end
+    end
+
+    # Setup virtual attributes for Bitmask attributes
+    #
+    # Allows you to set and read Bitmask attributes using #value= and
+    # #value methods
+    # @arg [Symbol] bitmask the name of the bitmask attribute
+    def bitmask_virtual_attributes(bitmask)
+      send("values_for_#{bitmask}").each do |value|
+        define_method("#{value}") { send("#{bitmask}?", value) }
+        define_method("#{value}=") { |arg| send("#{bitmask}=", arg.blank? || arg == "0" ? send("#{bitmask}") - [value] : send("#{bitmask}") << value) }
+      end
+    end
+
+    ##
+    # Set up all bitmask helpers: Virtual Attributes, scopes, and presence
+    # checkers
+    #
+    # @arg [Symbol] bitmask the name of the bitmask attribute
+    def bitmask_helpers(bitmask)
+      bitmask_presence_methods(bitmask)
+      bitmask_scopes(bitmask)
+      bitmask_virtual_attributes(bitmask)
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, BitmaskAttributesHelpers

data/lib/bitmask_attributes_helpers/version.rb

@@ -0,0 +1,3 @@
+module BitmaskAttributesHelpers
+  VERSION = "0.0.1".freeze
+end

data/spec/bitmask_attributes_helpers_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+# Shared examples
+
+##
+# Shared examples for checker methods
+# @arg [Model] model_class the model class to run the presence methods on
+# @arg [String] bitmask the name of the bitmask
+# @arg [String] true_value the name of the value which should be true
+# @arg [String] false_value the name of the value which should be false
+shared_examples_for "a bitmask with presence methods" do
+  describe '#value?' do
+    let(:model) { model_class.new({ "#{bitmask}" => [true_value.to_sym] }) }
+    context 'if the model has the bitmask attribute set' do
+      it 'returns true' do
+        model.send("#{true_value}?").should be
+      end
+    end
+
+    context 'if the model does not have the bitmask attribute set' do
+      it 'returns false' do
+        model.send("#{false_value}?").should_not be
+      end
+    end
+  end
+end
+
+##
+# Shared examples for scope methods
+# @arg [Model] model_class the model class to run the checkers on
+# @arg [String] true_value the name of the value which should be true
+# @arg [String] false_value the name of the value which should be false
+shared_examples_for "a bitmask with scopes" do
+  describe '.value' do
+    context 'when there are models with the value set' do
+      before(:each) { model_class.create({ "#{bitmask}" => [true_value.to_sym] }) }
+      it 'returns those models' do
+        model_class.send(true_value).should have_at_least(1).result
+      end
+    end
+
+    context 'when there are no models with the value set' do
+      before(:each) { model_class.create({ "#{bitmask}" => [true_value.to_sym] }) }
+      it 'returns an empty array' do
+        model_class.send(false_value).should have(0).results
+      end
+    end
+  end
+end
+
+##
+# Shared examples for virtual attributes
+# @arg [Model] model_class the model class to run the checkers on
+# @arg [String] true_value the name of the value which should be true
+# @arg [String] false_value the name of the value which should be false
+shared_examples_for "a bitmask with virtual attributes" do
+  describe '#value' do
+    let(:model) { model_class.new({ "#{bitmask}" => [true_value.to_sym] }) }
+    context 'if the model has the bitmask attribute set' do
+      it 'returns true' do
+        model.send("#{true_value}").should be
+      end
+    end
+
+    context 'if the model does not have the bitmask attribute set' do
+      it 'returns false' do
+        model.send("#{false_value}").should_not be
+      end
+    end
+  end
+
+  describe '#value=' do
+    let(:model) { model_class.new }
+    it 'can set the bitmask attribute to true' do
+      model.send("#{false_value}=", true)
+      model.send("#{false_value}").should be
+    end
+
+    it 'can set the bitmask attribute to false' do
+      model.send("#{true_value}=", false)
+      model.send("#{true_value}").should_not be
+    end
+  end
+end
+
+# Running tests
+
+describe BitmaskAttributesHelpers do
+  let(:bitmask) { :colors }
+  let(:true_value) { :raw_umber }
+  let(:false_value) { :pet_shop }
+
+  context 'with a bitmask with presence methods' do
+    let(:model_class) { CrayonWithPresenceMethods }
+    it_behaves_like 'a bitmask with presence methods'
+  end
+
+  context 'with a bitmask with scopes' do
+    let(:model_class) { CrayonWithScopes }
+    it_behaves_like 'a bitmask with scopes'
+  end
+
+  context 'with a bitmask with virtual attributes' do
+    let(:model_class) { CrayonWithVirtualAttributes }
+    it_behaves_like 'a bitmask with virtual attributes'
+  end
+
+  context 'with a bitmask with helpers' do
+    let(:model_class) { CrayonWithHelpers }
+    it_behaves_like 'a bitmask with presence methods'
+    it_behaves_like 'a bitmask with scopes'
+    it_behaves_like 'a bitmask with virtual attributes'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'active_record'
+require 'squeel'
+begin; require 'turn'; rescue LoadError; end
+
+require 'bitmask_attributes'
+require 'bitmask_attributes_helpers'
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => ':memory:'
+)
+
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/spec/support/models.rb

@@ -0,0 +1,28 @@
+ActiveRecord::Schema.define do
+  create_table :crayons do |t|
+    t.integer :colors
+    t.string :type # STI
+  end
+end
+
+# Pseudo models for testing purposes
+
+class Crayon < ActiveRecord::Base
+  bitmask :colors, as: [:raw_umber, :pet_shop, :super_green, :periwinkle, :fuzzy_wuzzy_brown]
+end
+
+class CrayonWithPresenceMethods < Crayon
+  bitmask_presence_methods :colors
+end
+
+class CrayonWithScopes < Crayon
+  bitmask_scopes :colors
+end
+
+class CrayonWithVirtualAttributes < Crayon
+  bitmask_virtual_attributes :colors
+end
+
+class CrayonWithHelpers < Crayon
+  bitmask_helpers :colors
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: bitmask_attributes_helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Chan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bitmask_attributes
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: ryan@ryanlchan
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rvmrc
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- bitmask_attributes_helpers.gemspec
+- info/exclude
+- lib/bitmask_attributes_helpers.rb
+- lib/bitmask_attributes_helpers/version.rb
+- spec/bitmask_attributes_helpers_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+homepage: http://github.com/ryanlchan/bitmask_attributes_helpers
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Getters, setters, and scopes for Joel Moss's bitmask_attributes gem
+test_files:
+- spec/bitmask_attributes_helpers_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb