compact_flags 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ae649be5e24261937664a2a59eefd82bca91aeb
+  data.tar.gz: 352303d5bdb7711c09fd23f981bfa61b44dc818e
+SHA512:
+  metadata.gz: dd5a6e8a80712b55f348f9138913ad66a66ee0ed8dff6d7477dd1342cbc1e74b9d60b9811888b9381ed577872613cdc023742c8b1d92b684920e7a22b78768e3
+  data.tar.gz: 7965bf9098e8b13cd241017cf231ee5d4d948d8dfd9eaeef7a3cbbf611c665866e2db5a11384851906b4570ea3afc56727e7255c95c2ed515d05a28a24002322

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Dr-Click
+
+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,84 @@
+## Introduction
+
+Ruby Gem to store many boolean flags in an integer column by utilizing bits Edit
+Add topics
+
+CompactFlags comes to serve models with several boolean flags. in large data volumes where the flags can be used to slice the data in several ways. queries tend to be heavier and more indexes are needed by time.
+
+This Gem is made so it can store several flags in one integer attribute through bit wise operations. the attribute represents the state of each record. And is much more performant in database queries
+
+## Compatible
+
+  Compatible with Rails 4 and 5
+
+## Installation
+
+  ```ruby
+  gem 'compact_flags'
+
+  ```
+  Then run bundle to install the Gem:
+  ```sh
+  bundle install
+  ```
+
+
+## Database Migrations
+
+You need to add an integer column only to your model. which will be used later as the flags store, you can just use a migration that adds inter column like below:
+
+  ```ruby
+  class AddRoles < ActiveRecord::Migration
+    def change
+      add_column :users, :roles, :integer, :null=>false, :default=>0
+    end
+  end
+  ```
+
+  Now run migrations:
+  ```sh
+  bundle exec rake db:migrate
+  ```
+
+## Usage example
+
+After adding the gem and creating an integer column, for example: "roles" to your model, add the "compact_flags" lines passing the flags store column name, and the array of flags
+
+  class User < ActiveRecord::Base
+    compact_flags :roles  => [:admin, :moderator, :editor]
+  end
+
+  ```ruby
+  # the corresponding getters and setters for all the boolean flags has been created
+  user = User.new
+  user.admin = true
+  user.admin?            # <=  will return true
+  user.moderator?        # <=  will return false
+  user.save
+  ```
+
+Scopes will also be automatically available for objects retrieval from the database.
+Two names scopes will be available for each flag. with the plural name of the flag, and another one
+preceded with "not_".
+scopes gives a suitable flexibility because they can be used in a cascaded style to build complex conditions
+
+  ```ruby
+  User.admins                               # <=  The pluralize of flag name
+  User.not_moderators                       # <=  The pluralize of flag name with 'not_'
+  User.not_moderators.admins
+  ```
+
+Other methods are also available to return the relevant condition part as a string, for concatenation with a condition string. those comes with the in the form of _where_ and _where_not_
+
+  ```ruby
+  User.admin_value              # => returns associated value to admin => 1
+  User.moderator_value          # => returns associated value to moderator => 2
+  User.where_admin              # => "(roles & 1) > 0"
+  User.where_not_admin          # => "(roles & 1) = 0"
+  User.where_not_moderator      # => "(roles & 2) = 0"
+  ```
+
+## Contributions
+
+* Mahmoud Said aka modsaid (mahmoud@modsaid.com)
+* Mostafa Ragab aka dr-click (ragab.mostafa@gmail.com)

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CompactFlags'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/compact_flags/engine.rb

@@ -0,0 +1,5 @@
+module CompactFlags
+  class Engine < ::Rails::Engine
+    isolate_namespace CompactFlags
+  end
+end

data/lib/compact_flags/version.rb

@@ -0,0 +1,3 @@
+module CompactFlags
+  VERSION = '1.0.1'
+end

data/lib/compact_flags.rb

@@ -0,0 +1,69 @@
+require "compact_flags/engine"
+
+module CompactFlags
+  module HasFlags
+    MAX_FLAGS_MAPPING = 0xFFFFFFFF
+    MAX_FLAGS_COUNT = 31
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def compact_flags(*args)
+        mapping = args.first
+        store_column = mapping.keys.first
+        flags = mapping[store_column]
+
+        raise "No flags defined" if flags.blank?
+        raise "Too many flags, maximum flags count (#{MAX_FLAGS_COUNT})" if flags.size > MAX_FLAGS_COUNT
+
+        @@flags ||={}
+        @@store_columns ||={}
+        i=0
+
+        flags.each do |flag|
+          @@flags[flag] = 1 << i
+          @@store_columns[flag] = store_column
+          i += 1
+
+          # Define instance getter
+          define_method "#{flag}" do
+            return (@@flags[flag] & self.send(store_column)) > 0
+          end
+
+          alias_method "#{flag}?", "#{flag}"
+
+          # Define instance setter
+          define_method "#{flag}=" do |val|
+            self.send("#{store_column}=", (val ?
+                self.send(store_column) | @@flags[flag] :
+                self.send(store_column) & (MAX_FLAGS_MAPPING ^ @@flags[flag]) ))
+          end
+
+          # named scopes to be used in conditions
+          scope "#{flag}".pluralize.to_sym, -> {where("(#{@@store_columns[flag]} & #{@@flags[flag]}) > 0")}
+          scope "not_#{flag}".pluralize.to_sym, -> {where("(#{@@store_columns[flag]} & #{@@flags[flag]}) = 0")}
+        end
+
+        class << self
+          @@flags.each do |key, value|
+            define_method "#{key}_value" do
+              return value
+            end
+
+            define_method "where_#{key}" do
+              return "(#{@@store_columns[key]} & #{@@flags[key]}) > 0"
+            end
+
+            define_method "where_not_#{key}" do
+              return "(#{@@store_columns[key]} & #{@@flags[key]}) = 0"
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, CompactFlags::HasFlags

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: compact_flags
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Dr-Click
+- ModSaid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-13 00:00:00.000000000 Z
+dependencies: []
+description: Ruby Gem to store many boolean flags in an integer column by utilizing
+  bits, CompactFlags comes to serve models with several boolean flags. in large data
+  volumes where the flags can be used to slice the data in several ways. queries tend
+  to be heavier and more indexes are needed by time.
+email:
+- ragab.mostafa@gmail.com
+- mahmoud@modsaid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/compact_flags.rb
+- lib/compact_flags/engine.rb
+- lib/compact_flags/version.rb
+homepage: https://github.com/dr-click/compact-flags
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby Gem to store many boolean flags in an integer column by utilizing bits
+test_files: []