Giter Club home page Giter Club logo

simple_flaggable_column's Introduction

SimpleFlaggableColumn

Allows you to add really simple binary flag column to an ActiveRecord model.

Installation

Add this line to your application's Gemfile:

gem 'simple_flaggable_column'

And then execute:

$ bundle

Or install it yourself as:

$ gem install simple_flaggable_column

Usage example

Migration:

add_column(:games, :platforms, :integer, default: 0, null: false)

Model:

class Game < ActiveRecord::Base
  include SimpleFlaggableColumn

  flag_column :platforms, {
    win:   0b001,
    mac:   0b010,
    linux: 0b100
  }
end

This redefines the platforms method in Game so you can set it and read it as an array:

game = Game.new
game.platforms = [:win, :linux]
# => [:win, :linux]
game.read_attribute :platforms
# => 5
game.read_attribute(:platforms).to_s(2)
# => "101"

Push/Pop and other arrays operations won't work, just simple writing and reading.

:throw_on_missing

If you try to set a non-existing flag it will throw an ArgumentError

game = Game.new
game.platforms = [:potato]
# => <ArgumentError: Flag potato doesn't exists>

To disable this and silently ignore invalid flags define the flags with :throw_on_missing set to false:

class Game < ActiveRecord::Base
  include SimpleFlaggableColumn

  flag_column :platforms, {
    win:   0b001,
    mac:   0b010,
    linux: 0b100
  }, throw_on_missing: false
end

Now invalid flags will be ignored

game = Game.new
game.platforms = [:win, :potato]
# => [:win]

Contributing

  1. Fork it ( https://github.com/Zequez/simple_flaggable_column/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

simple_flaggable_column's People

Contributors

zequez avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.