bitten 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 049eab1bdcc6e4d2f84daaa744708f2db48ab702
+  data.tar.gz: 5f349da0d0d4d5b3aa9a33bb88ffaca824b8e194
+SHA512:
+  metadata.gz: 035373de93a1063cf9ef6478d5c32315f32dee039aab2bd3054f637347d148226ee467cb1ec0e71cd5d8bdc9c76fc2bd1bccb0535accea7c93948250fc07db23
+  data.tar.gz: 9cc59ca19e8c214312ceec74096f88b9e89983a4dc39be9e047321f48c6e439732b5b93fab53dbeb41bdfe92e7cb0a52f2b12a0a19bec9d9ae34cfa10558ec96

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+.bundle
+.yardoc
+doc

data/.rspec

@@ -0,0 +1,6 @@
+--format progress
+--color
+--order rand
+-Ilib
+-Ispec
+-r spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - rbx-19mode

data/.yardopts

@@ -0,0 +1,8 @@
+--no-private
+--title "Bitten"
+--readme README.md
+--markup markdown
+--markup-provider kramdown
+-
+HISTORY.md
+LICENSE

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    bitten (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.0)
+    atomic (1.1.14)
+    builder (3.1.4)
+    diff-lcs (1.2.4)
+    i18n (0.6.5)
+    kramdown (1.2.0)
+    minitest (4.7.5)
+    multi_json (1.8.0)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    sqlite3 (1.3.8)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.37)
+    yard (0.8.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  bitten!
+  kramdown
+  rake
+  rspec
+  sqlite3
+  yard

data/HISTORY.md

@@ -0,0 +1,6 @@
+# HISTORY
+
+## 0.0.1
+
+* Initial release
+

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2013 Arjan van der Gaag
+
+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.md

@@ -0,0 +1,89 @@
+# Bitten [![Build Status](https://secure.travis-ci.org/avdgaag/bitten.png?branch=master)](http://travis-ci.org/avdgaag/bitten)
+
+## Introduction
+
+Bitten is a simple module for adding multiple boolean flags to any Ruby object,
+that internally get stored as a single integer attribute. If your Ruby object
+is an ActiveRecord object, it also provides some convenience scopes for you.
+
+The advantage is a simple data model, with a single attribute containing many
+bits of information. You can keep adding more flags to the list of tracked
+flags, as long as the order of existing flags is kept intact.
+
+## Installation
+
+Bitten is distributed as a Ruby gem, which should be installed on most Macs and
+Linux systems. Once you have ensured you have a working installation of Ruby
+and Ruby gems, install the gem as follows from the command line:
+
+    gem install bitten
+
+TO use it in projects using Bundler, add the gem to your `Gemfile`:
+
+    gem 'bitten'
+
+Then, install your gems:
+
+    bundle install
+
+## Usage
+
+Here's an example of how to use Bitten:
+
+     ActiveRecord::Migration.create_table do |t|
+       t.integer :bits, null: false, default: 0
+     end
+  
+     class User < ActiveRecord::Base
+       include Bitten
+       has_bits :editor, :author, :reviewer
+     end
+  
+     user = User.new editor: true
+     user.editor? # => true
+     user.author? # => false
+     user.reviewer? # => false
+     user.author = true
+     user.author? # => true
+     user.save
+     User.author # => [user]
+     User.editor # => [user]
+     User.reviewer # => []
+     User.not_reviewer # => [user]
+
+### Documentation
+
+See the inline [API
+docs](http://rubydoc.info/github/avdgaag/bitten/master/frames) for more
+information.
+
+## Other
+
+### Note on Patches/Pull Requests
+
+1. Fork the project.
+2. Make your feature addition or bug fix.
+3. Add tests for it. This is important so I don't break it in a future version
+   unintentionally.
+4. Commit, do not mess with rakefile, version, or history. (if you want to have
+   your own version, that is fine but bump version in a commit by itself I can
+   ignore when I pull)
+5. Send me a pull request. Bonus points for topic branches.
+
+### Issues
+
+Please report any issues, defects or suggestions in the [Github issue
+tracker](https://github.com/avdgaag/bitten/issues).
+
+### What has changed?
+
+See the [HISTORY](https://github.com/avdgaag/bitten/blob/master/HISTORY.md) file
+for a detailed changelog.
+
+### Credits
+
+Created by: Arjan van der Gaag  
+URL: [http://arjanvandergaag.nl](http://arjanvandergaag.nl)  
+Project homepage: [http://avdgaag.github.com/bitten](http://avdgaag.github.com/bitten)  
+Date: september 2013  
+License: [MIT-license](https://github.com/avdgaag/bitten/blob/master/LICENSE) (same as Ruby)

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+require 'bundler'
+Bundler::GemHelper.install_tasks
+Bundler.setup
+
+desc 'Default: run specs.'
+task :default => :spec
+
+require 'rspec/core/rake_task'
+desc 'Run specs'
+RSpec::Core::RakeTask.new
+
+require 'yard'
+desc 'Generate API docs'
+YARD::Rake::YardocTask.new

data/bitten.gemspec

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/bitten/version', __FILE__)
+
+Gem::Specification.new do |s|
+  # Metadata
+  s.name        = 'bitten'
+  s.version     = Bitten::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Arjan van der Gaag']
+  s.email       = %q{arjan@arjanvandergaag.nl}
+  s.description = %q{A simple implementation of a bit fields attribute for Ruby objects.}
+  s.homepage    = %q{http://avdgaag.github.com/bitten}
+  s.summary     = <<-EOS
+Bitten is a simple module for adding multiple boolean flags to any Ruby object,
+that internally get stored as a single integer attribute. If your Ruby object
+is an ActiveRecord object, it also provides some convenience scopes for you.
+
+The advantage is a simple data model, with a single attribute containing many
+bits of information. You can keep adding more flags to the list of tracked
+flags, as long as the order of existing flags is kept intact.
+EOS
+
+  # Files
+  s.files         = `git ls-files`.split("
+")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("
+")
+  s.executables   = `git ls-files -- bin/*`.split("
+").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Rdoc
+  s.rdoc_options = ['--charset=UTF-8']
+  s.extra_rdoc_files = [
+     'LICENSE',
+     'README.md',
+     'HISTORY.md'
+  ]
+
+  # Dependencies
+  s.add_development_dependency 'kramdown'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'activerecord'
+  s.add_development_dependency 'sqlite3'
+end

data/lib/bitten.rb

@@ -0,0 +1,98 @@
+require 'bitten/version'
+
+module Bitten
+  # Lower-case string values that should be considered truthy. This allows us
+  # to handle both actual `true` and `false` values as well as truthy string
+  # values coming from HTML forms.
+  TRUE_VALUES = %w[true 1 t].freeze
+
+  # Define the different flags to be stored in the host model's `bits` column.
+  # Every flag given gets its own query method (e.g. `published?`) and setter
+  # method (e.g. `published=`). All flags are stored in a single integer column
+  # in the host object.
+  #
+  # Note that you can add more flags to the model if you want. If you do, it
+  # will default to false unless explicitly set otherwise. Do make sure to only
+  # add new flags to the end of the list, as order is vitally important.
+  #
+  # Note: this assumes the host object defines `bits` and `bits=`, with a
+  # default value of `0`. This does not have to be an ActiveRecord attribute,
+  # any `attr_accessor` will do, as longs as the default value is set.
+  #
+  # To use the convenience scopes, the host object has to be an ActiveRecord
+  # object in order to define the class-level `scope` method. To disable these,
+  # pass the `scopes: false` option.
+  #
+  # @example Basic usage
+  #   ActiveRecord::Migration.create_table do |t|
+  #     t.integer :bits, null: false, default: 0
+  #   end
+  #
+  #   class User < ActiveRecord::Base
+  #     include Bitten
+  #     has_bits :editor, :author, :reviewer
+  #   end
+  #
+  #   user = User.new editor: true
+  #   user.editor? # => true
+  #   user.author? # => false
+  #   user.reviewer? # => false
+  #   user.author = true
+  #   user.author? # => true
+  #   user.save
+  #   User.author # => [user]
+  #   User.editor # => [user]
+  #   User.reviewer # => []
+  #   User.not_reviewer # => [user]
+  #
+  # @example Provide options
+  #   class User < ActiveRecord::Base
+  #     include Bitten
+  #     has_bits :admin, :manager, scopes: false
+  #   end
+  def has_bits(*flags)
+    options = flags.last.is_a?(Hash) ? flags.pop : {}
+    options = { scopes: true, column: 'bits' }.merge(options)
+
+    if options[:scopes]
+      flags.each_with_index do |flag, index|
+        define_scopes flag, options[:column], 1 << index
+      end
+    end
+
+    mod = Module.new do
+      define_method :bitten_bits do
+        send options[:column]
+      end
+
+      define_method :bitten_bits= do |val|
+        send :"#{options[:column]}=", val
+      end
+
+      flags.each_with_index do |flag, index|
+        bit = 1 << index
+
+        define_method :"#{flag}?" do
+          bitten_bits & bit != 0
+        end
+
+        define_method :"#{flag}=" do |value|
+          if TRUE_VALUES.include? value.to_s.downcase
+            self.bitten_bits |= bit
+          else
+            self.bitten_bits &= ~bit
+          end
+        end
+      end
+    end
+
+    include mod
+  end
+
+  private
+
+  def define_scopes(flag, column, bit)
+    scope flag,           -> { where(['(?.? & ?) != 0', table_name, column, bit]) }
+    scope :"not_#{flag}", -> { where(['(?.? & ?) = 0',  table_name, column, bit]) }
+  end
+end

data/lib/bitten/version.rb

@@ -0,0 +1,3 @@
+module Bitten
+  VERSION = '0.0.1'
+end

data/spec/bitten_spec.rb

@@ -0,0 +1,52 @@
+describe Bitten do
+
+  before do
+    Post.has_bits :published, :featured, :sponsored
+  end
+
+  subject(:post) { Post.new }
+
+  it { should_not be_published }
+  it { should_not be_featured }
+  it { should_not be_sponsored }
+  it { should respond_to(:published=) }
+  it { should respond_to(:featured=) }
+  it { should respond_to(:sponsored=) }
+
+  its(:class) { should respond_to(:published) }
+  its(:class) { should respond_to(:featured) }
+  its(:class) { should respond_to(:sponsored) }
+  its(:class) { should respond_to(:not_published) }
+  its(:class) { should respond_to(:not_featured) }
+  its(:class) { should respond_to(:not_sponsored) }
+
+  it 'can toggle a flag' do
+    subject.published = true
+    expect(post).to be_published
+    subject.published = false
+    expect(post).not_to be_published
+  end
+
+  describe 'scopes' do
+    let!(:post1) { Post.create! published: true }
+    let!(:post2) { Post.create! featured: true }
+
+    it 'finds a record by flag' do
+      expect(Post.published).to include(post1)
+      expect(Post.published).not_to include(post2)
+      expect(Post.featured).not_to include(post1)
+      expect(Post.featured).to include(post2)
+      expect(Post.sponsored).not_to include(post1)
+      expect(Post.sponsored).not_to include(post2)
+    end
+
+    it 'finds a record by not having a flag' do
+      expect(Post.not_published).not_to include(post1)
+      expect(Post.not_published).to include(post2)
+      expect(Post.not_featured).to include(post1)
+      expect(Post.not_featured).not_to include(post2)
+      expect(Post.not_sponsored).to include(post1)
+      expect(Post.not_sponsored).to include(post2)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'bitten'
+
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }

data/spec/support/activerecord.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Migration.create_table :posts do |t|
+  t.integer :bits, null: false, default: 0
+  t.timestamps
+end
+
+class Post < ActiveRecord::Base
+  extend Bitten
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: bitten
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Arjan van der Gaag
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple implementation of a bit fields attribute for Ruby objects.
+email: arjan@arjanvandergaag.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+- HISTORY.md
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- .yardopts
+- Gemfile
+- Gemfile.lock
+- HISTORY.md
+- LICENSE
+- README.md
+- Rakefile
+- bitten.gemspec
+- lib/bitten.rb
+- lib/bitten/version.rb
+- spec/bitten_spec.rb
+- spec/spec_helper.rb
+- spec/support/activerecord.rb
+homepage: http://avdgaag.github.com/bitten
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.5
+signing_key: 
+specification_version: 4
+summary: Bitten is a simple module for adding multiple boolean flags to any Ruby object,
+  that internally get stored as a single integer attribute. If your Ruby object is
+  an ActiveRecord object, it also provides some convenience scopes for you.  The advantage
+  is a simple data model, with a single attribute containing many bits of information.
+  You can keep adding more flags to the list of tracked flags, as long as the order
+  of existing flags is kept intact.
+test_files:
+- spec/bitten_spec.rb
+- spec/spec_helper.rb
+- spec/support/activerecord.rb
+has_rdoc: