bitroleable 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10f67c0fc1f2251121f9a9bee55f6e0bacd159af
-  data.tar.gz: f4545cab4d688a0919b95db4d565037fff03b28f
+  metadata.gz: c82952010fd76f5d26974f680d0dc06283b16f25
+  data.tar.gz: 4e3f57ad48c624f40264fa6371e5a55e943d3ad7
 SHA512:
-  metadata.gz: 3d3bfa99d5f81f5ea7796f4e94433cbd8b514e6c6456c90e5c9e1be95c401f69207acb4978014a70f488ae364df4a7fb37f084b5a315de9cbfb6e1aad0c7c7c7
-  data.tar.gz: 395dfa76bca47f97858af6f27213c4debd9690fc25ec1ac643f3a19fe0f10ccd6793df06995c7a065fdbb79a64cdfbdf63912e95fe2e3e709597a829df5665af
+  metadata.gz: 41cd27583e08e15b74cc750407ab8b985f895c674287d7a65ababd8898456fcc99ea8ae2ba59749bc60833ed7e9c29ee2949104b15a007bd4eb14e97e9a86dc9
+  data.tar.gz: 86ba561bff04dc96d786ebc70f803221305d693666f257e27ea7ea7771af8cde1d3795483b460eb1c55814f4fb39d2063f1060de4d273568e7dff7c874f4f256

data/README.md

@@ -1,6 +1,8 @@
 # Bitroleable
 
-Store user's roles in an integer column of database. Have ability to store multi-roles for users.
+Manage user roles. Each user's role is stored as a bit in an integer 
+column of database. Also provides user ability to have one role and 
+some roles.
 
 ## Installation
 
@@ -23,7 +25,7 @@ Or install it yourself as:
 Add a column which will store role/roles as integer:
 
 ```ruby
-add_column :user, :role, :integer, null: false
+add_column :user, :roles, :integer, null: false
 ```
 
 And then tell a model that you use this gem functionality:
@@ -31,15 +33,21 @@ And then tell a model that you use this gem functionality:
 ```ruby
 # app/models/user.rb
 class User < ActiveRecord::Base
-  roleable :role, [:user, :moderator, :admin], multi: true
+  roleable :roles, [:user, :moderator, :admin], multi: true
 end
 ```
 
-So you can do this:
+### Options
+
+For now it has only one option:
+
+- `multi` (boolean) - when it equals `true` an entity could have many roles, otherwise only one role
+
+### Example
 
 ```ruby
 user = User.first
-user.admin!
+user.admin! # => user becomes an admin
 user.admin? # => true
 user.user? # => false
 user.role # => [:admin]
@@ -50,6 +58,9 @@ user.save!
 User.where_role(:admin).count # => 0
 User.where_role(:user).count # => 1
 User.where_role(:moderator).count # => 1
+User.roles_list # => [:user, :moderator, :admin]
+User.role?(:user) # => true
+User.role?(:fake) # => false
 ```
 
 ## Contributing

data/bitroleable.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   spec.version       = Bitroleable::VERSION
   spec.authors       = ['Eugene Kondratiuk']
   spec.email         = ['ekondr@gmail.com']
-  spec.summary       = "Store user's roles in an integer column of database"
-  spec.description   = "Store user's roles in an integer column of database. Have ability to store multi-roles for users."
+  spec.summary       = "Manage user roles. Each user's role is stored as a bit in an integer column of database."
+  spec.description   = "Manage user roles. Each user's role is stored as a bit in an integer column of database. Also provides user ability to have one role and some roles."
   spec.homepage      = ''
   spec.license       = 'MIT'
 

data/lib/bitroleable/version.rb

@@ -1,3 +1,3 @@
 module Bitroleable
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/bitroleable.rb

@@ -70,6 +70,14 @@ module Bitroleable
         2**index
       end
 
+      define_singleton_method :roles_list do
+        roles_list
+      end
+
+      define_singleton_method :role? do |role|
+        roles_list.include?(role.to_sym)
+      end
+
       define_singleton_method :where_role do |*roles|
         roles = roles.flatten.compact.map(&:to_sym)
         tbl_column = "#{self.table_name}.#{column}"

data/spec/dummy/config/application.rb

@@ -20,7 +20,6 @@ module Dummy
     # config.i18n.default_locale = :de
 
     # Do not swallow errors in after_commit/after_rollback callbacks.
-    config.active_record.raise_in_transactional_callbacks = true
   end
 end
 

data/spec/dummy/config/environments/production.rb

@@ -22,7 +22,7 @@ Rails.application.configure do
 
   # Disable serving static files from the `/public` folder by default since
   # Apache or NGINX already handles this.
-  config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
+  config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
 
   # Compress JavaScripts and CSS.
   config.assets.js_compressor = :uglifier

data/spec/dummy/config/environments/test.rb

@@ -13,8 +13,8 @@ Rails.application.configure do
   config.eager_load = false
 
   # Configure static file server for tests with Cache-Control for performance.
-  config.serve_static_files   = true
-  config.static_cache_control = 'public, max-age=3600'
+  config.public_file_server.enabled   = true
+  config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
 
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true

data/spec/models/bitroleable_spec.rb

@@ -16,6 +16,17 @@ RSpec.describe Bitroleable, type: :model do
       expect(User.where_role(:moderator).count).to eq 0
     end
 
+    it 'should have a list of roles' do
+      expect(User.roles_list).to eq [:user, :moderator, :admin]
+    end
+
+    it 'should have ability to check roles' do
+      expect(User.role?(:user)).to eq true
+      expect(User.role?(:moderator)).to eq true
+      expect(User.role?(:admin)).to eq true
+      expect(User.role?(:guest)).to eq false
+    end
+
     context 'when a role is changed' do
       before { user.moderator! }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitroleable
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Eugene Kondratiuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-28 00:00:00.000000000 Z
+date: 2016-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,8 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Store user's roles in an integer column of database. Have ability to
-  store multi-roles for users.
+description: Manage user roles. Each user's role is stored as a bit in an integer
+  column of database. Also provides user ability to have one role and some roles.
 email:
 - ekondr@gmail.com
 executables: []
@@ -152,10 +152,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Store user's roles in an integer column of database
+summary: Manage user roles. Each user's role is stored as a bit in an integer column
+  of database.
 test_files:
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile