simple_roles 0.0.6 → 0.0.7

data/README.md

@@ -1,24 +1,23 @@
 # SimpleRoles
 
-SimpleRoles is a Rails Engine providing simple Role System for any Rails 3 app. It was created as demo role-system to accompany [CanTango gem](https://github.com/kristianmandrup/cantango) initial installiation and usage. Intended to be very easy to setup & use.
+SimpleRoles is a Rails Engine providing simple Role System for any Rails 3 app. 
 
-It even seems to be good for being used as a real role system inspite of (or due to ;)) its almost maximum simplicity.
+Initially, it was created as demo role-system to accompany [CanTango gem](https://github.com/kristianmandrup/cantango) initial installiation and usage, and intended to be very easy to setup & use.
 
-If you are looking for a real serious roles system solution try [Troles](https://github.com/kristianmandrup/troles) gem created by [Kristian Mandrup](https://github.com/kristianmandrup)
+Now it is good to be used as a real role system inspite of or due to its almost maximum simplicity.
 
 ## Installiation
 
 ### Prerequisites
 
-SimpleRoles requires you have User model. That's all.
+SimpleRoles requires you have have User model in your Rails app. That's all.
 
-### Not a Gem yet
+### It is a Gem
 
 include in Gemfile:
 
 ```ruby
-gem 'simple_roles', :git => "git://github.com/stanislaw/simple_roles.git"
-bundle update
+gem 'simple_roles' 
 ```
 
 ### Set up valid roles you're gonna have in your app and choose a Strategy. 
@@ -134,6 +133,34 @@ end
 
 ## Usage example
 
+### One
+
+```ruby
+user = User.create
+
+user.role # => nil
+
+user.role = :admin
+user.role # => :admin
+user.admin? # => true
+user.is_admin? # => true
+
+# Accepts strings too 
+user.role = 'instructor'
+user.role # => :instructor
+
+# #set_role and #update_role are persistent - #save is called also
+user.set_role(:editor)
+user.reload
+user.role # => :editor
+
+user.update_role(:user)
+user.reload
+user.role # => :user
+```
+
+### Many
+
 ```ruby
 user = User.new
 user.roles # => []

data/lib/simple_roles/one/persistence.rb

@@ -2,11 +2,22 @@ module SimpleRoles
   module One
     module Persistence
       def role
-        super.to_sym
+        (r = super) ? r.to_sym : nil
       end
 
       def role= r
-        super r.to_s
+        check_role r
+        r ? super(r.to_s) : super(nil)
+      end
+
+      private
+
+      def check_role role
+        return unless role
+
+        valid_roles = SimpleRoles.config.valid_roles
+
+        raise "Not a valid role! Try on of: #{valid_roles.join(', ')}" if ([role.to_sym] - valid_roles).size > 0
       end
     end
   end

data/lib/simple_roles/one/roles_methods.rb

@@ -13,6 +13,7 @@ module SimpleRoles
         self.role= r
         save!
       end
+      alias_method :update_role, :set_role
 
       module DynamicMethods
         class << self

data/lib/simple_roles/version.rb

@@ -1,3 +1,3 @@
 module SimpleRoles
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/simple_roles.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "simple_roles"
-  s.version = "0.0.6"
+  s.version = "0.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["stanislaw"]
@@ -134,6 +134,7 @@ Gem::Specification.new do |s|
     "spec/integration/requests/main_spec.rb",
     "spec/simple_roles/configuration_spec.rb",
     "spec/simple_roles/integration_many_spec.rb",
+    "spec/simple_roles/integration_one_spec.rb",
     "spec/simple_roles/macros_spec.rb",
     "spec/simple_roles/many/persistence_spec.rb",
     "spec/simple_roles/many_spec.rb",

data/spec/dummy/app/models/user.rb

@@ -3,8 +3,8 @@ class User < ActiveRecord::Base
 
   simple_roles
 
-  devise :database_authenticatable, :registerable,
-         :recoverable, :rememberable, :trackable, :validatable
+  # devise :database_authenticatable, :registerable,
+  #        :recoverable, :rememberable, :trackable, :validatable
 
   # Setup accessible (or protected) attributes for your model
   # DEVISE

data/spec/dummy/config/initializers/simple_roles.rb

@@ -1,4 +1,4 @@
 SimpleRoles.configure do |config|
-  strategy :many
+  strategy :one
   valid_roles :user, :admin, :editor
 end

data/spec/dummy/db/migrate/010_devise_create_users.rb

@@ -1,10 +1,10 @@
 class DeviseCreateUsers < ActiveRecord::Migration
   def self.up
     create_table(:users) do |t|
-      t.database_authenticatable :null => false
-      t.recoverable
-      t.rememberable
-      t.trackable
+      # t.database_authenticatable :null => false
+      # t.recoverable
+      # t.rememberable
+      # t.trackable
       # t.encryptable
       # t.confirmable
       # t.lockable :lock_strategy => :failed_attempts, :unlock_strategy => :both
@@ -12,12 +12,13 @@ class DeviseCreateUsers < ActiveRecord::Migration
 
       t.string  :name
       t.string  :username
-       
+      t.string  :role
+
       t.timestamps
     end
 
-    add_index :users, :email,                :unique => true
-    add_index :users, :reset_password_token, :unique => true
+    # add_index :users, :email,                :unique => true
+    # add_index :users, :reset_password_token, :unique => true
     # add_index :users, :confirmation_token,   :unique => true
     # add_index :users, :unlock_token,         :unique => true
     # add_index :users, :authentication_token, :unique => true

data/spec/dummy/db/schema.rb

@@ -15,37 +15,25 @@ ActiveRecord::Schema.define(:version => 20110925210727) do
 
   create_table "roles", :force => true do |t|
     t.string   "name"
-    t.datetime "created_at"
-    t.datetime "updated_at"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
   end
 
   create_table "user_roles", :force => true do |t|
     t.integer  "user_id"
     t.integer  "role_id"
-    t.datetime "created_at"
-    t.datetime "updated_at"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
   end
 
   add_index "user_roles", ["user_id", "role_id"], :name => "index_user_roles_on_user_id_and_role_id"
 
   create_table "users", :force => true do |t|
-    t.string   "email",                                 :default => "", :null => false
-    t.string   "encrypted_password",     :limit => 128, :default => "", :null => false
-    t.string   "reset_password_token"
-    t.datetime "reset_password_sent_at"
-    t.datetime "remember_created_at"
-    t.integer  "sign_in_count",                         :default => 0
-    t.datetime "current_sign_in_at"
-    t.datetime "last_sign_in_at"
-    t.string   "current_sign_in_ip"
-    t.string   "last_sign_in_ip"
     t.string   "name"
     t.string   "username"
-    t.datetime "created_at"
-    t.datetime "updated_at"
+    t.string   "role"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
   end
 
-  add_index "users", ["email"], :name => "index_users_on_email", :unique => true
-  add_index "users", ["reset_password_token"], :name => "index_users_on_reset_password_token", :unique => true
-
 end

data/spec/simple_roles/integration_one_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+SimpleRoles.configure do |config|
+  config.valid_roles = [:user, :admin, :editor]
+end
+
+describe 'Integration for SimpleRoles::One' do
+  before do
+    setup_roles
+    SimpleRoles::Packager.package OneUser, :one
+  end
+
+  it "should all work" do
+    user = create :one_user, :role => nil
+    user.role.should be_nil
+
+    user.role = :admin
+    user.role.should == :admin
+    user.admin?.should be_true
+    user.is_admin?.should be_true
+
+    user.role = 'admin' # Accepts strings too
+    user.role.should == :admin
+
+    user.set_role(:editor)
+    user.role.should == :editor
+
+    user.update_role(:user)
+    user.role.should == :user
+
+    user.user?.should be_true
+    user.is_user?.should be_true
+
+    user.admin?.should be_false
+    user.is_admin?.should be_false
+  end
+end

data/spec/simple_roles/one_spec.rb

@@ -4,72 +4,97 @@ describe SimpleRoles::One do
   subject { SimpleRoles::One }
   let(:user) { create :one_user, :role => 'user' }
   
-  describe ".package" do
-    before(:all) do
-      SimpleRoles::Packager.package OneUser, :one
-    end
+  before(:all) do
+    SimpleRoles::Packager.package OneUser, :one
+  end
+
+  describe "Persistence" do
+    describe "#role" do
+      it "should return nil if there is no role for user" do
+        user.role = nil
+        user.role.should == nil
+      end
 
-    describe "Persistence" do
       it "should read role as symbol" do
         user.update_attribute :role, 'user'
         user.role.should == :user
       end
+    end
 
+    describe "#role=" do
       it "should set roles" do
         user.role = :admin
         user.role.should == :admin
       end
 
-      it "should persist roles" do
-        user.role = :admin
-        user.save
+      it "should also accept strings" do
+        user.role = 'admin'
         user.role.should == :admin
       end
+
+      it "should not persist roles" do
+        user.role = :admin
+        user.reload
+        user.role.should == :user
+      end
+
+      it "should not allow non-valid role" do
+        expect {
+          user.role = :wrong!
+        }.to raise_error
+      end
     end
+  end
 
-    describe "Roles methods" do
-      describe "#set_role" do
-        it "should set role" do
-          user.set_role(:admin)
-          user.role.should == :admin
-        end
+  describe "Roles methods" do
+    describe "#set_role" do
+      it "should set role" do
+        user.set_role(:admin)
+        user.role.should == :admin
+      end
 
-        it "should persist role" do
-          user.set_role(:admin)
-          user.reload
-          user.role.should == :admin
-        end
+      it "should persist role" do
+        user.set_role(:admin)
+        user.reload
+        user.role.should == :admin
+      end
+    end
+    
+    describe "#update_role" do
+      it "should set role" do
+        user.update_role(:admin)
+        user.role.should == :admin
       end
 
-      describe "Dynamic scopes" do
-        SimpleRoles.config.valid_roles.each do |r|
-          specify { OneUser.should respond_to :"#{r}s" }
-        end
+      it "should persist role" do
+        user.update_role(:admin)
+        user.reload
+        user.role.should == :admin
       end
+    end
 
-      describe "Dynamic methods" do
-        SimpleRoles.config.valid_roles.each do |r|
-          specify { user.should respond_to :"#{r}?" }
-        end
+    describe "Dynamic methods" do
+      SimpleRoles.config.valid_roles.each do |r|
+        specify { user.should respond_to :"#{r}?" }
+      end
 
-        describe "#user?, #admin?, ..." do
-          specify do
-            user.set_role(:admin)
-            user.admin?.should == true
+      describe "#user?, #admin?, ..." do
+        specify do
+          user.set_role(:admin)
+          user.admin?.should == true
 
-            user.set_role(:user)
-            user.user?.should == true
-          end
+          user.set_role(:user)
+          user.user?.should == true
         end
-        
-        describe "#is_user?, #is_admin?, ..." do
-          specify do
-            user.set_role(:admin)
-            user.is_admin?.should == true
+      end
+      
+      describe "#is_user?, #is_admin?, ..." do
+        specify do
+          user.set_role(:admin)
+          user.is_admin?.should == true
 
-            user.set_role(:user)
-            user.is_user?.should == true
-          end
+          user.set_role(:user)
+          user.is_user?.should == true
         end
       end
     end

data/spec/spec_helper.rb

@@ -47,12 +47,12 @@ RSpec.configure do |config|
     with ActiveRecord::Base.connection do
       # tables.each {|t| drop_table t }
 
-      # with ActiveRecord::Migrator do
-      #   # SimpleRoles's own migrations
-      #   migrate File.expand_path('../../db/migrate', __FILE__)
-      #   # Helper migration - users table
-      #   migrate File.expand_path('../support/migrations', __FILE__)
-      # end if tables.empty?
+      with ActiveRecord::Migrator do
+        # SimpleRoles's own migrations
+        migrate File.expand_path('../../db/migrate', __FILE__)
+        # Helper migration - users table
+        migrate File.expand_path('../support/migrations', __FILE__)
+      end if tables.empty?
 
       # (tables - ['schema_migrations']).map do |table|
       #   table_count = execute("SELECT COUNT(*) FROM #{table}").first.first

data/spec/support/setup_roles.rb

@@ -1,5 +1,5 @@
 def setup_roles
   SimpleRoles::Configuration.valid_roles.each do |role|
-    Role.create(:name => role.to_s)
+    Role.create(:name => role.to_s) if Role.where(:name => role.to_s).empty?
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_roles
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -312,6 +312,7 @@ files:
 - spec/integration/requests/main_spec.rb
 - spec/simple_roles/configuration_spec.rb
 - spec/simple_roles/integration_many_spec.rb
+- spec/simple_roles/integration_one_spec.rb
 - spec/simple_roles/macros_spec.rb
 - spec/simple_roles/many/persistence_spec.rb
 - spec/simple_roles/many_spec.rb
@@ -343,7 +344,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -387698285
+      hash: -398652943
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: