bit_settings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 512e7b80ce38905f3f4cc93067101dcab4c95944
+  data.tar.gz: fb88a885f6fea1017186bc276c12d01fe322f4c2
+SHA512:
+  metadata.gz: 3d2cdf43903e2aaeae374886fcea7605bc253e91ef90fe1b24df9de2b9c3294d3bdcde32e67634b6c7def5ff9b4f5c3505a05737e864ec80c0e3d95894ed76bf
+  data.tar.gz: 8e352ee9e476c829624ffd7b129b474dfebc77f0c7d8fd18c37b85c4ecd67a30dc280405ff16de2d31fb4abe762c75b841c58ee84c4b8bf605ccb43bd071d536

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 pioz
+
+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,81 @@
+# BitSettings
+
+BitSettings is a plugin for ActiveRecord that transform a column of your model in a set of boolean settings.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bit_settings'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bit_settings
+
+## Usage
+
+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
+    add_column :users, :settings, 'INT UNSIGNED', null: false, default: 0
+  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`.
+
+Then in your model:
+
+```
+class User extends ActiveRecord::Base
+  include BitSettings
+  add_settings settings: [:disable_notifications, :help_tour_shown]
+end
+```
+
+Now you can do:
+
+```
+user.disable_notifications? # => false
+user.help_tour_shown? # => false
+user.disable_notifications = true # => true
+user.save
+```
+
+Other options are `:column` and `:prefix`:
+
+```
+class User extends ActiveRecord::Base
+  add_settings 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
+
+```
+user.setting_disable_notifications? # => false
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+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

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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

data/bit_settings.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bit_settings/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bit_settings"
+  spec.version       = BitSettings::VERSION
+  spec.authors       = ["pioz"]
+  spec.email         = ["enrico@megiston.it"]
+
+  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.}
+  spec.homepage      = "https://github.com/pioz/bit_settings"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  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_dependency "activerecord", ">= 1.0.0"
+end

data/lib/bit_settings/version.rb

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

data/lib/bit_settings.rb

@@ -0,0 +1,30 @@
+require 'bit_settings/version'
+
+module BitSettings
+
+  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))
+          end
+        end
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: bit_settings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pioz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-29 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bit_settings.gemspec
+- lib/bit_settings.rb
+- lib/bit_settings/version.rb
+homepage: https://github.com/pioz/bit_settings
+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: BitSettings is a plugin for ActiveRecord that transform a column of your
+  model in a set of boolean settings.
+test_files: []