simple_flaggable_column 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0b33b7ddfccc8f03c443d21df4e69420c4c8139
+  data.tar.gz: 58541615a542b6e7a01684f9ad8d8cf4d5929119
+SHA512:
+  metadata.gz: 6103bc6649aea9593036de95463703967b3bbd2403da77d585c4868f999515637210e97cd74e6648e92d93218da43da1b136ee24dd2c6ec5fab54aa6f464d0d7
+  data.tar.gz: de63367fb7acc0938556b359b63a99c818275a95dc19e12e6262308019955d4b591937f01afc0a20352117c5c578a04b7183b69b2f5ffe46201c029cac0577bf

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/vendor
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_flaggable_column.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Zequez
+
+MIT License
+
+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,63 @@
+# SimpleFlaggableColumn
+
+Allows you to add really simple binary flag column to an ActiveRecord model.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_flaggable_column'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_flaggable_column
+
+## Usage example
+
+Migration:
+
+```ruby
+add_column(:games, :platforms, :integer, default: 0, null: false)
+```
+
+Model:
+
+```ruby
+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:
+
+```ruby
+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.
+
+## 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

data/lib/simple_flaggable_column/version.rb

@@ -0,0 +1,3 @@
+module SimpleFlaggableColumn
+  VERSION = "0.0.1"
+end

data/lib/simple_flaggable_column.rb

@@ -0,0 +1,40 @@
+require 'active_support'
+require 'simple_flaggable_column/version'
+
+module SimpleFlaggableColumn
+  extend ActiveSupport::Concern
+
+  def self.symbols_to_flags(symbols, symbols_flags)
+    symbols.map{|s| symbols_flags[s]}.compact.reduce(:|) || 0
+  end
+
+  def self.flags_to_symbols(flags, symbols_flags)
+    symbols_flags.each_pair.inject([]){|all, v| (flags & v[1] != 0) ? (all << v[0]) : all}
+  end
+
+  module ClassMethods
+    def flag_column(name, symbols_flags)
+      flags_symbols = symbols_flags.invert
+
+      define_singleton_method :"#{name}_flags" do |*symbols|
+        if symbols.empty?
+          symbols_flags
+        else
+          SimpleFlaggableColumn.symbols_to_flags(symbols, symbols_flags)
+        end
+      end
+
+      define_singleton_method :"flags_#{name}" do
+        flags_symbols
+      end
+
+      define_method "#{name}=" do |symbols|
+        write_attribute name, SimpleFlaggableColumn.symbols_to_flags(symbols, symbols_flags)
+      end
+
+      define_method name do
+        SimpleFlaggableColumn.flags_to_symbols(read_attribute(name), symbols_flags)
+      end
+    end
+  end
+end

data/simple_flaggable_column.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_flaggable_column/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_flaggable_column'
+  spec.version       = SimpleFlaggableColumn::VERSION
+  spec.authors       = ['Zequez']
+  spec.email         = ['zequez@gmail.com']
+  spec.summary       = 'Simple binary flags columns'
+  spec.description   = 'This gem adds a concern to allow you to use binary flags columns in ActiveRecord models'
+  spec.homepage      = 'https://github.com/Zequez/simple_flaggable_column'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 4.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'with_model', '~> 1.2'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+end

data/spec/simple_flaggable_column/simple_flaggable_column_spec.rb

@@ -0,0 +1,55 @@
+describe SimpleFlaggableColumn do
+  with_model :GameModel do
+    table do |t|
+      t.integer :platforms, default: 0, null: false
+    end
+
+    model do
+      include SimpleFlaggableColumn
+
+      flag_column :platforms, {
+        win:   0b001,
+        mac:   0b010,
+        linux: 0b100
+      }
+    end
+  end
+
+  it 'should be empty by default' do
+    expect(GameModel.new.platforms).to eq []
+  end
+
+  it 'should let you save data' do
+    game = GameModel.new
+    game.platforms = [:mac, :linux]
+    expect(game.read_attribute(:platforms)).to eq 0b110
+    expect(game.platforms).to match_array [:mac, :linux]
+  end
+
+  it "should ignore items that aren't on the list" do
+    game = GameModel.new
+    game.platforms = [:mac, :linux, :potato]
+    expect(game.read_attribute(:platforms)).to eq 0b110
+    expect(game.platforms).to match_array [:mac, :linux]
+  end
+
+  it 'should define the list of flags' do
+    expect(GameModel.platforms_flags).to eq({
+      win:   0b001,
+      mac:   0b010,
+      linux: 0b100
+    })
+  end
+
+  it 'should let you get a join list of flags' do
+    expect(GameModel.platforms_flags(:win, :linux)).to eq 0b101
+  end
+
+  it 'should define the reverse list of flags' do
+    expect(GameModel.flags_platforms).to eq({
+      0b001 => :win,
+      0b010 => :mac,
+      0b100 => :linux
+    })
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'simple_flaggable_column'
+require 'with_model'
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+ActiveRecord::Migration.verbose = false
+
+RSpec.configure do |config|
+  config.extend WithModel
+
+  config.expect_with :rspec do |expectations|
+    # Default in RSpec 4
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Default in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: simple_flaggable_column
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zequez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: with_model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: This gem adds a concern to allow you to use binary flags columns in ActiveRecord
+  models
+email:
+- zequez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/simple_flaggable_column.rb
+- lib/simple_flaggable_column/version.rb
+- simple_flaggable_column.gemspec
+- spec/simple_flaggable_column/simple_flaggable_column_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Zequez/simple_flaggable_column
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Simple binary flags columns
+test_files:
+- spec/simple_flaggable_column/simple_flaggable_column_spec.rb
+- spec/spec_helper.rb