acts_as_user 1.0.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a7e5bcbb549bcaee0d7e66f93759c2bc3061b5d
-  data.tar.gz: f4f9c9205329ceb26c70427beecf1d8a72fb1215
+  metadata.gz: 0b9d01203b4d142d091919f8844f314ad807787d
+  data.tar.gz: 7fbedc1dd0d5d844e1d595f70842797a9a81babb
 SHA512:
-  metadata.gz: 5b88ebfdb46ed4f836bb96ad0df2714f76fe286ea2d6e80b73fb4af015b7004c5e6a19134a409a716096eb9e3ff740fef64b0c28bb38404c7c0fdccb74c71c29
-  data.tar.gz: 298b5b4a6c8b97cb073bbf38de14d4177f83524340559849b086daaff45a7935d47b8bbf6abb1216c8709d05135cee0f37aa38bf596f39228dbc650679043b03
+  metadata.gz: 2836d6beee84330632b341a42c8571e89df48c58a957a8ed4b6b59ef37fc1e8977a6305ad7d327cfeba83151a2fc241d786d79fae52901de984442132f9a51e4
+  data.tar.gz: be32e88cb4b9982ebac3df4ab07846a225300bf9cf3d1f3bccff9ebaac50f95083a5997b9f6c3241ce97e3762bce54f29341230d83a13bcf04c174b40375b86f

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .DS_Store
+*.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=d

data/.travis.yml

@@ -0,0 +1,12 @@
+language: 'ruby'
+
+script: "bundle exec rake spec"
+
+rvm: 
+  - 1.9.3
+  - 2.0.0
+
+gemfile:
+  gemfiles/active_record_40.gemfile
+
+

data/README.md

@@ -1,11 +1,15 @@
 #Acts as user
+[![Build Status](https://travis-ci.org/IcaliaLabs/acts_as_user.png?branch=master)](https://travis-ci.org/IcaliaLabs/acts_as_user)
+[![Code Climate](https://codeclimate.com/github/IcaliaLabs/acts_as_user.png)](https://codeclimate.com/github/IcaliaLabs/acts_as_user)
+[![Dependency Status](https://gemnasium.com/IcaliaLabs/acts_as_user.png)](https://gemnasium.com/IcaliaLabs/acts_as_user)
+[![Gem Version](https://badge.fury.io/rb/acts_as_user.png)](http://badge.fury.io/rb/acts_as_user)
 
 Acts as user handles multiple user roles on a rails app. It uses polymorphic associations to relate other models and behave like a user.
 
 
 ## Getting started
 
-ActsAsUser 1.0.0 works with rails 3 onwards. You can add it to your Gemfile with:
+ActsAsUser 1.2.1 works with rails 3 onwards. You can add it to your Gemfile with:
 
 ```ruby
 gem 'acts_as_user'
@@ -70,6 +74,52 @@ Acts as a user plays well with Devise as it ignores and adds the corresponding a
 
 When using devise, ActsAsUser will also ignore the ```encrypted_password``` attribute from the user. No further configuration needs to be done.
 
+##Getting to know the user
+
+ActsAsUser gem now adds some handy instance user methods that returns true or false wheter the current user is a specific type or not, for example:
+
+A simple configuration may look something similar to:
+
+```ruby
+class User < ActiveRecord::Base
+ is_user
+end
+
+class Customer < ActiveRecord::Base
+ acts_as_user
+end
+
+class Admin < ActiveRecord::Base
+ acts_as_user
+end
+```
+
+Just a little configuration is needed, you can do it on the ```acts_as_user.rb``` initializer like so:
+
+```ruby
+ActsAsUser.setup do |config|
+	config.models_acting_as_users = [:admin, :customer]
+end
+```
+
+Now we will instantiate a Customer object:
+
+```console
+customer = Customer.find(1)
+current_user = customer.user
+```
+
+You now should be able to detect in this case if the current_user is wheter an admin or a customer by simply calling:
+
+```console
+current_user.customer?
+ => true
+current_user.admin?
+ => false
+```
+
+Enjoy!
+
 ## Contributing
 
 1. Fork it
@@ -81,7 +131,7 @@ When using devise, ActsAsUser will also ignore the ```encrypted_password``` attr
 
 ###Psst! Here is a live example in rails
 
-[Rails acts as user example](https://github.com/IcaliaLabs)
+[Rails acts as user example](https://github.com/IcaliaLabs/acts_as_user_example)
 
 ### Devs
 
@@ -90,7 +140,6 @@ When using devise, ActsAsUser will also ignore the ```encrypted_password``` attr
 
 ### Future
 
-* Add tests
 * Support for Mongoid
 * Add wiki
 

data/Rakefile

@@ -1 +1,21 @@
-require "bundler/gem_tasks"
+# encoding: utf-8
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => "spec:all"
+
+namespace :spec do
+  desc "Run Tests"
+  task :all do
+    sh "BUNDLE_GEMFILE='gemfiles/active_record_40.gemfile' bundle install --quiet"
+    sh "BUNDLE_GEMFILE='gemfiles/active_record_40.gemfile' bundle exec rake spec"
+  end
+end

data/acts_as_user.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = ActsAsUser::VERSION
   spec.authors       = ["Abraham Kuri", "Patricio Beltrán"]
   spec.email         = ["kurenn@icalialabs.com", "pbeltran@icalialabs.com"]
-  spec.description   = %q{Handles multiple user roles on a rails app}
+  spec.description   = %q{A ruby gem to handle multiple user roles on a Rails app, it also has Devise support}
   spec.summary       = %q{Handles multiple user roles on a rails app}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/IcaliaLabs/acts_as_user"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -21,6 +21,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "shoulda-matchers"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency 'database_cleaner', ['~> 1.2.0']
+  spec.add_development_dependency 'debugger'
 
   spec.add_dependency "orm_adapter", "~> 0.1"
   spec.add_dependency "activerecord", ">= 3.0"

data/gemfiles/active_record_40.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'railties', '>= 4.0.0'
+gem 'activerecord', '>= 4.0.0', :require => 'active_record'
+gem 'rspec-rails', '>= 2.0'
+
+platforms :ruby do
+  gem 'sqlite3'
+end
+
+gemspec :path => '../'

data/lib/acts_as_user.rb

@@ -2,20 +2,55 @@ require "acts_as_user/version"
 require 'orm_adapter'
 
 module ActsAsUser
+  extend ActiveSupport::Autoload
+
+  #Eager loads the modules
+  eager_autoload do
+    autoload :UserDelegate
+    autoload :IsUser
+  end
+
+  # ActiveSupport::Autoload automatically defines
+  # an eager_load! method. In this case, we are
+  # extending the method to also eager load the
+  # ActsAsUser modules.
+  def self.eager_load!
+    super 
+    ActsAsUser::UserDelegate.eager_load!
+    ActsAsUser::IsUser.eager_load!
+  end
+
+  #We ignore some attribues that might cause a collision between models
   @@default_ignored_attributes = ["created_at", "updated_at", "id", "userable_type", "userable_id"]
 
+  #Array to define the models that are inhering from the user
+  @@models_acting_like_users = []
+  mattr_reader :models_acting_like_users
+
+  #We append the extra attributes you want to ignore to the default ones
   mattr_accessor :ignored_attributes
   @@ignored_attributes = @@ignored_attributes.to_a + @@default_ignored_attributes
 
+  mattr_accessor :models_acting_as_users
+  @@models_acting_as_users = []
+
   def self.setup
     yield self    
   end
 
+  #Checking if devise is present
   def self.devise?
     defined?(Devise).present?
   end
+
+  #We add some virtual attributes that dont't play well when devise is present
+  def self.add_devise_attributes_to_ignore
+    if self.devise?
+      devise_ignore_attrs = ['password', 'password_confirmation', 'encrypted_password']
+      self.ignored_attributes << devise_ignore_attrs
+      self.ignored_attributes.flatten!
+    end
+  end
 end
 
-require 'acts_as_user/user_delegate'
-require 'acts_as_user/is_user'
 require 'acts_as_user/railtie'

data/lib/acts_as_user/is_user.rb

@@ -1,7 +1,21 @@
 module ActsAsUser
   module IsUser
+
     def self.included(base)
       base.belongs_to :userable, polymorphic: true
+      base.extend ClassMethods
+      #loads models acting as users when the hook is loaded
+      base.define_models_acting_as_users
+    end
+
+    module ClassMethods
+      def define_models_acting_as_users
+        ActsAsUser.models_acting_as_users.each do |model_class_name|
+          define_method("#{model_class_name.to_s.downcase}?") do
+            self.userable_type.downcase == model_class_name.to_s.downcase
+          end
+        end
+      end
     end
   end
 end

data/lib/acts_as_user/railtie.rb

@@ -1,14 +1,19 @@
 module ActsAsUser
   class Railtie < Rails::Railtie
-    ActiveSupport.on_load :active_record do
-      class ActiveRecord::Base
-        def self.acts_as_user
-          include ActsAsUser::UserDelegate    
-        end
-        def self.is_user
-          include ActsAsUser::IsUser
+      #Adds namespace for eager loading
+      config.eager_load_namespaces << ActsAsUser
+
+      ActiveSupport.on_load :active_record do
+        ActsAsUser.add_devise_attributes_to_ignore
+
+        class ActiveRecord::Base
+          def self.acts_as_user
+            include ActsAsUser::UserDelegate    
+          end
+          def self.is_user
+            include ActsAsUser::IsUser
+          end
         end
       end
-    end
   end
 end

data/lib/acts_as_user/user_delegate.rb

@@ -18,6 +18,7 @@ module ActsAsUser
       super
     end
 
+
     protected
 
     def user_must_be_valid
@@ -31,16 +32,12 @@ module ActsAsUser
     module ClassMethods
 
       def define_user_accessors
+        #We check the user columns to declare them as attributes to delegate
         all_attributes = User.columns.map(&:name)
 
-        if ActsAsUser.devise?
-          all_attributes << "password"
-          all_attributes << "password_confirmation"
-          ActsAsUser.ignored_attributes << "encrypted_password"
-        end
-
         attributes_to_delegate = all_attributes - ActsAsUser.ignored_attributes
 
+        #User method delegation
         attributes_to_delegate.each do |attrib|
           class_eval <<-RUBY
           def #{attrib}

data/lib/acts_as_user/version.rb

@@ -1,3 +1,3 @@
 module ActsAsUser
-  VERSION = "1.0.1"
+  VERSION = "1.2.1"
 end

data/spec/fake_gem.rb

@@ -0,0 +1,2 @@
+class GemDefinedModel < ActiveRecord::Base
+end

data/spec/models/active_record/customer_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Customer do
+  it { should have_one(:user).dependent(:destroy) }
+  it { should respond_to :user }
+  it { should respond_to :email }
+
+  describe 'model valid' do
+    before do
+      @customer = Customer.new
+      @user = User.new
+      @customer.user = @user
+    end
+    it 'throws errors when user has no email is not correct' do
+      @customer.should_not be_valid
+    end
+
+    it 'is valid when user has no errors' do
+      @customer.email = 'test@test.com'
+      @customer.should be_valid
+    end
+  end
+
+  describe 'user autobuild' do
+    before do
+      @customer = Customer.new
+    end
+
+    it 'has to have a user already' do
+      @customer.user.should be_present
+    end
+  end
+
+  describe 'setters' do
+    before do
+      @customer = Customer.new(email: 'test@test.com')
+    end
+    it 'saves the user with its corresponding fields' do
+      @customer.save
+      @customer.user.email.should eql @customer.email
+    end
+  end
+end

data/spec/models/active_record/user_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe User do
+  it { should belong_to :userable }
+  it { should respond_to :userable_type }
+  it { should respond_to :userable_id }
+  it { should respond_to :customer? }
+  it { should respond_to :admin? }
+
+  describe '#customer?' do
+    context 'when is a customer' do
+      before do
+        @customer_user = Customer.create email: 'test@icalialabs.com'
+        @current_user = @customer_user.user
+      end
+      it 'returns true' do
+        @current_user.should be_customer 
+      end
+    end
+    context 'when is not customer' do
+      before do
+        @fake_customer_user = Admin.create email: 'test@icalialabs.com'
+        @current_user = @fake_customer_user.user
+      end
+      it 'returns false' do
+        @current_user.should_not be_customer 
+      end
+    end
+    context 'when is an admin' do
+      before do
+        @admin_user = Admin.create email: 'test@icalialabs.com'
+        @current_user = @admin_user.user
+      end
+      it 'returns true' do
+        @current_user.should be_admin
+      end
+    end
+  end
+end

data/spec/models/config/setup_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe ActsAsUser do
+  let(:acts_as_user) { ActsAsUser }
+  subject { acts_as_user }
+  it { should respond_to :ignored_attributes }
+  it { should respond_to :setup }
+  it { should respond_to :models_acting_as_users }
+
+  describe 'ignored attributes' do
+    context 'when devise is present' do
+      it 'adds the devise fields to ignore' do
+        acts_as_user.should_receive(:devise?).and_return(true)
+        acts_as_user.add_devise_attributes_to_ignore
+        acts_as_user.ignored_attributes.should include 'password'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'active_record'
+require 'shoulda-matchers'
+
+begin
+  require 'rails'
+rescue LoadError
+end
+
+require 'bundler/setup'
+Bundler.require
+
+require 'database_cleaner'
+
+require 'fake_gem' if defined? ActiveRecord
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+#Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+load File.dirname(__FILE__) + '/support/acts_as_user_initializer.rb'
+load File.dirname(__FILE__) + '/support/schema.rb'
+load File.dirname(__FILE__) + '/support/models.rb'
+
+I18n.enforce_available_locales = false

data/spec/support/active_record.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+
+
+#ActiveRecord::Migrator.up "db/migrate"
+
+load File.dirname(__FILE__) + '/acts_as_user_initializer.rb'
+load File.dirname(__FILE__) + '/schema.rb'
+load File.dirname(__FILE__) + '/models.rb'

data/spec/support/acts_as_user_initializer.rb

@@ -0,0 +1,10 @@
+# This hook is use to setup the configuration for creating models through
+# rails generators
+ActsAsUser.setup do |config|
+
+  config.models_acting_as_users = [:admin, :customer]
+
+  # ==> ORM Configuration
+  # Load and configure the ORM. Supports :active_record
+  require 'acts_as_user/orm/active_record'
+end

data/spec/support/database_cleaner.rb

@@ -0,0 +1,12 @@
+DatabaseCleaner[:active_record].strategy = :transaction if defined? ActiveRecord
+RSpec.configure do |config|
+  config.before :suite do
+    DatabaseCleaner.clean_with :truncation if defined? ActiveRecord
+  end
+  config.before :each do
+    DatabaseCleaner.start
+  end
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,12 @@
+class User < ActiveRecord::Base
+  is_user 
+  validates :email, presence: true
+end
+
+class Customer < ActiveRecord::Base
+  acts_as_user
+end
+
+class Admin < ActiveRecord::Base
+  acts_as_user
+end

data/spec/support/schema.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :users do |t|
+    t.string :email
+    t.string :userable_type 
+    t.integer :userable_id
+  end
+  add_index :users, [:userable_id, :userable_type]
+
+  create_table :customers do |t|
+    t.string :name
+    t.string :city
+  end
+
+  create_table :admins do |t|
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_user
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Abraham Kuri
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-12 00:00:00.000000000 Z
+date: 2014-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,6 +53,104 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: orm_adapter
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +179,8 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Handles multiple user roles on a rails app
+description: A ruby gem to handle multiple user roles on a Rails app, it also has
+  Devise support
 email:
 - kurenn@icalialabs.com
 - pbeltran@icalialabs.com
@@ -90,11 +189,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - acts_as_user.gemspec
+- gemfiles/active_record_40.gemfile
 - lib/acts_as_user.rb
 - lib/acts_as_user/is_user.rb
 - lib/acts_as_user/orm/active_record.rb
@@ -108,7 +210,17 @@ files:
 - lib/generators/acts_as_user/install_generator.rb
 - lib/generators/acts_as_user/orm_helpers.rb
 - lib/generators/templates/acts_as_user.rb
-homepage: ''
+- spec/fake_gem.rb
+- spec/models/active_record/customer_spec.rb
+- spec/models/active_record/user_spec.rb
+- spec/models/config/setup_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+- spec/support/acts_as_user_initializer.rb
+- spec/support/database_cleaner.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+homepage: https://github.com/IcaliaLabs/acts_as_user
 licenses:
 - MIT
 metadata: {}
@@ -132,5 +244,15 @@ rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Handles multiple user roles on a rails app
-test_files: []
+test_files:
+- spec/fake_gem.rb
+- spec/models/active_record/customer_spec.rb
+- spec/models/active_record/user_spec.rb
+- spec/models/config/setup_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+- spec/support/acts_as_user_initializer.rb
+- spec/support/database_cleaner.rb
+- spec/support/models.rb
+- spec/support/schema.rb
 has_rdoc: