bit_settings 0.1.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 512e7b80ce38905f3f4cc93067101dcab4c95944
-  data.tar.gz: fb88a885f6fea1017186bc276c12d01fe322f4c2
+SHA256:
+  metadata.gz: 22cd583daf1f3c6e6515394137361db2365632c24c62ac6a1527633a467badca
+  data.tar.gz: c076a8a41b3b4f9544e2f86dac2aea93fb5abdd6352d129c7b850c9e17c41a70
 SHA512:
-  metadata.gz: 3d2cdf43903e2aaeae374886fcea7605bc253e91ef90fe1b24df9de2b9c3294d3bdcde32e67634b6c7def5ff9b4f5c3505a05737e864ec80c0e3d95894ed76bf
-  data.tar.gz: 8e352ee9e476c829624ffd7b129b474dfebc77f0c7d8fd18c37b85c4ecd67a30dc280405ff16de2d31fb4abe762c75b841c58ee84c4b8bf605ccb43bd071d536
+  metadata.gz: a2233d4f0fc3fb9ed2a438a4f281f1c6742c125be8a0579ee21b35750456bfc5d5b550515d85710ad16edfc429331dc787531a9ef7dee67002201b6ccab79ea8
+  data.tar.gz: 257e99f707aecd320968bf52e60eb6295b85be6603bd1bbde0c8934d847e51b3975139a6eab186a6264f042c8fc49643a487ca711bf7dff2aab4d9a0dfb87209

data/README.md

@@ -1,6 +1,7 @@
 # BitSettings
 
 BitSettings is a plugin for ActiveRecord that transform a column of your model in a set of boolean settings.
+You can have up to 32 boolean values stored in a single database column.
 
 ## Installation
 
@@ -22,7 +23,6 @@ Or install it yourself as:
 
 First of all add a unsigned int column for your boolean settings with `rails g migration add_settings_to_users settings:integer` and then edit like follow:
 
-
 ```
 class AddSettingsToUsers < ActiveRecord::Migration
   def change
@@ -30,6 +30,7 @@ class AddSettingsToUsers < ActiveRecord::Migration
   end
 end
 ```
+
 The max unsigned integer in 4 bytes is `2^32-1 = 4294967295` so with a column you can have max 32 settings.
 If you want that the default value of your settings is 1 (true) set the default value of the column to `2^32-1`.
 
@@ -38,7 +39,7 @@ Then in your model:
 ```
 class User extends ActiveRecord::Base
   include BitSettings
-  add_settings settings: [:disable_notifications, :help_tour_shown]
+  add_settings :disable_notifications, :help_tour_shown
 end
 ```
 
@@ -51,18 +52,28 @@ user.disable_notifications = true # => true
 user.save
 ```
 
-Other options are `:column` and `:prefix`:
+You can also use the scope `with_settings` which takes a hash as parameter like the example below:
+
+```
+# Get all users with the value of setting disable_notifications equal to true
+# and the settings help_tour_shown equal to false.
+users = User.with_settings(disable_notifications: true, help_tour_shown: false)
+```
+
+Available options are `:column` and `:prefix`:
 
 ```
 class User extends ActiveRecord::Base
-  add_settings settings: [:disable_notifications, :help_tour_shown], column: :my_settings, prefix: :setting
+  add_settings :disable_notifications, :help_tour_shown, column: :my_settings, prefix: :setting
 end
 ```
-* `:column` specify the name of the column to use (default is `settings`)
-* `:prefix` add a prefix to dynamic methods
+
+- `:column` specify the name of the column to use (default is `settings`)
+- `:prefix` add a prefix to dynamic methods
 
 ```
 user.setting_disable_notifications? # => false
+users = User.with_settings(setting_disable_notifications: false)
 ```
 
 ## Development
@@ -75,7 +86,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/pioz/bit_settings.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
-task :default => :spec
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'test' << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task default: :test

data/bit_settings.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "bit_settings"
   spec.version       = BitSettings::VERSION
   spec.authors       = ["pioz"]
-  spec.email         = ["enrico@megiston.it"]
+  spec.email         = ["epilotto@gmx.com"]
 
   spec.summary       = %q{BitSettings is a plugin for ActiveRecord that transform a column of your model in a set of boolean settings.}
   spec.description   = %q{BitSettings is a plugin for ActiveRecord that transform a column of your model in a set of boolean settings.}
@@ -19,8 +19,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 2.1.0"
+  spec.add_development_dependency "rake", ">= 12.3"
+  spec.add_development_dependency "sqlite3", ">= 1.3"
+  spec.add_development_dependency "minitest", ">= 5.11"
 
-  spec.add_dependency "activerecord", ">= 1.0.0"
+  spec.add_dependency "activesupport", ">= 4.2.0"
+  spec.add_dependency "activemodel", ">= 4.2.0"
+  spec.add_dependency "activerecord", ">= 4.2.0"
 end

data/lib/bit_settings/boolean_value.rb

@@ -0,0 +1,21 @@
+module BooleanValue
+
+  FALSE_VALUES = [false, 0, '0', 'f', 'F', 'false', 'FALSE', 'off', 'OFF']
+
+  def self.cast_to_boolean_func
+
+    major, minor, _ = ActiveModel.version.to_s.split('.').map(&:to_i)
+    case major
+    # Rails 5
+    when 5
+      return ->(value) { ActiveModel::Type::Boolean.new.cast(value) }
+    # Rails 4.2
+    when 4
+      if minor >= 2
+        return ->(value) { ActiveRecord::Type::Boolean.new.type_cast_from_user(value) }
+      end
+    end
+    return ->(value) { value == '' ? nil : !FALSE_VALUES.include?(value) }
+  end
+
+end

data/lib/bit_settings/version.rb

@@ -1,3 +1,3 @@
 module BitSettings
-  VERSION = '0.1.0'
+  VERSION = '1.0.4'
 end

data/lib/bit_settings.rb

@@ -1,30 +1,59 @@
 require 'bit_settings/version'
+require 'bit_settings/boolean_value'
 
 module BitSettings
+  extend ActiveSupport::Concern
+  
+  included do
+    class_attribute :bit_settings
+
+    scope :with_settings, lambda { |h|
+      available = self.bit_settings.values.flatten
+      invalid = h.keys - available
+      raise "Settings #{invalid.inspect} do not exist for #{self} model: available settings are #{available.inspect}" if invalid.any?
+      scope = current_scope
+      self.bit_settings.each do |column, settings|
+        true_mask  = h.select{|k, v| settings.include?(k) &&  v}.keys.reduce(0) {|memo, x| memo | (1 << settings.index(x))}
+        false_mask = h.select{|k, v| settings.include?(k) && !v}.keys.reduce(0) {|memo, x| memo | (1 << settings.index(x))}
+        scope = scope.where("#{table_name}.#{column} & #{true_mask} = #{true_mask}") if  true_mask > 0
+        scope = scope.where("#{table_name}.#{column} & #{false_mask} = 0") if false_mask > 0
+      end
+      return scope
+    }
 
-  def self.included(base)
-    base.extend(self)
   end
 
-  def add_settings(settings:, column: :settings, prefix: nil)
-    prefix = prefix ? "#{prefix}_" : ''
-    if settings.size > 32
-      raise 'You can NOT have more than 32 settings (max unsigned int with 4 bytes is 2^32-1)'
-    else
-      settings.each_with_index do |setting, i|
-        define_method "#{prefix}#{setting}" do
-          self.send(column) & (1 << i) > 0
-        end
-        alias_method "#{prefix}#{setting}?", "#{prefix}#{setting}"
-        define_method "#{prefix}#{setting}=" do |value|
-          if ActiveRecord::ConnectionAdapters::Column::TRUE_VALUES.include?(value)
-            self.send("#{column}=", self.send(column) | (1 << i))
-          else
-            self.send("#{column}=", self.send(column) & ~(1 << i))
+  module ClassMethods
+
+    def add_settings(*settings, column: :settings, prefix: nil)
+      prefix = prefix ? "#{prefix}_" : ''
+      if settings.size > 32
+        raise 'You can NOT have more than 32 settings (max unsigned int with 4 bytes is 2^32-1)'
+      else
+
+        self.bit_settings ||= {}
+        self.bit_settings[column] = settings.map{|x| "#{prefix}#{x}".to_sym}
+
+        cast_to_boolean = BooleanValue.cast_to_boolean_func
+
+        settings.each_with_index do |setting, i|
+          define_method "#{prefix}#{setting}" do
+            self.send(column) & (1 << i) > 0
+          end
+          alias_method "#{prefix}#{setting}?", "#{prefix}#{setting}"
+          
+          define_method "#{prefix}#{setting}=" do |value|
+            if cast_to_boolean.call(value)
+              self.send("#{column}=", self.send(column) | (1 << i))
+            else
+              self.send("#{column}=", self.send(column) & ~(1 << i))
+            end
           end
         end
+
       end
     end
+
   end
 
 end

metadata

@@ -1,80 +1,135 @@
 --- !ruby/object:Gem::Specification
 name: bit_settings
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.4
 platform: ruby
 authors:
 - pioz
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-07-29 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 4.2.0
 description: BitSettings is a plugin for ActiveRecord that transform a column of your
   model in a set of boolean settings.
 email:
-- enrico@megiston.it
+- epilotto@gmx.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - bit_settings.gemspec
 - lib/bit_settings.rb
+- lib/bit_settings/boolean_value.rb
 - lib/bit_settings/version.rb
 homepage: https://github.com/pioz/bit_settings
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -89,9 +144,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.29
+signing_key:
 specification_version: 4
 summary: BitSettings is a plugin for ActiveRecord that transform a column of your
   model in a set of boolean settings.

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "bit_settings"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here