acts_as_user 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90bfdd9cb45c244ae3087b564cce23ef6eee4d53
-  data.tar.gz: 9bf166511ff5cd2d8244b92591b8a4e1b269f79a
+  metadata.gz: 7a7e5bcbb549bcaee0d7e66f93759c2bc3061b5d
+  data.tar.gz: f4f9c9205329ceb26c70427beecf1d8a72fb1215
 SHA512:
-  metadata.gz: 172d296773b4bb9721d48a814f538f7ce3f88fd1e436d99f869ceb6bd04314c8f4f61076d31a8dcd008f2d3ba8ba749abf307e20690111c2d00a45ebdc30d052
-  data.tar.gz: 770efc66d86120ff5ef8496b322879f7e623c13313407ddfd2f63d1d57938f8328c6bbba837474bc1385599da47a9949a8a812e673e194321f7f3ced0853dbce
+  metadata.gz: 5b88ebfdb46ed4f836bb96ad0df2714f76fe286ea2d6e80b73fb4af015b7004c5e6a19134a409a716096eb9e3ff740fef64b0c28bb38404c7c0fdccb74c71c29
+  data.tar.gz: 298b5b4a6c8b97cb073bbf38de14d4177f83524340559849b086daaff45a7935d47b8bbf6abb1216c8709d05135cee0f37aa38bf596f39228dbc650679043b03

data/README.md

@@ -1,24 +1,74 @@
-# ActsAsUser
+#Acts as user
 
-TODO: Write a gem description
+Acts as user handles multiple user roles on a rails app. It uses polymorphic associations to relate other models and behave like a user.
 
-## Installation
 
-Add this line to your application's Gemfile:
+## Getting started
 
-    gem 'acts_as_user'
+ActsAsUser 1.0.0 works with rails 3 onwards. You can add it to your Gemfile with:
 
-And then execute:
+```ruby
+gem 'acts_as_user'
+```
 
-    $ bundle
+Then run the bundle command to install it.
 
-Or install it yourself as:
+After you install ActsAsUser you need to run the generator:
 
-    $ gem install acts_as_user
+```console
+rails g acts_as_user:install
+```
 
-## Usage
+The generator will install in initializer which describes all the ActsAsUser configuration options, so we recommend you take a look at it. When you are done you are ready to start your user model:
 
-TODO: Write usage instructions here
+```console
+rails g acts_as_user User <attributes>
+```
+
+Next you'll probably want to run the migrations "rake db:migrate", as the generator will create a migration file (open it modify if you need to).
+
+##Configuration
+
+For the models you want to inherit to you just have to add this line of code into them:
+
+```ruby
+class Member
+	acts_as_user
+end
+```
+
+A little note on the User model...just in case!
+
+```ruby
+class User
+	is_user
+end
+```
+
+###Ignore attributes to delegate from the user
+
+If you want to ignore some attributes from your user model to the childs, you can do it on the ```acts_as_user.rb``` initializer like so:
+
+```ruby
+ActsAsUser.setup do |config|
+	config.ignored_attributes = ["name", "bio"]
+end
+```
+
+By default it ignores the following attributes:
+
+```ruby
+["created_at", "updated_at", "id", "userable_type", "userable_id"]
+```
+
+
+##Devise support
+
+Yes we do!
+
+Acts as a user plays well with Devise as it ignores and adds the corresponding attributes to delegate to.
+
+When using devise, ActsAsUser will also ignore the ```encrypted_password``` attribute from the user. No further configuration needs to be done.
 
 ## Contributing
 
@@ -27,3 +77,33 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+
+###Psst! Here is a live example in rails
+
+[Rails acts as user example](https://github.com/IcaliaLabs)
+
+### Devs
+
+* Abraham Kuri (https://github.com/kurenn)
+* Patricio Beltrán (https://github.com/patobeltran)
+
+### Future
+
+* Add tests
+* Support for Mongoid
+* Add wiki
+
+
+## Credits
+Icalia Labs - weare@icalialabs.com
+
+[Follow us](http://twitter.com/icalialabs "Follow us")
+
+
+[Like us on Facebook](https://www.facebook.com/icalialab "Like us on Facebook")
+
+
+### License
+
+MIT License. Copyright 2012-2013 IcaliaLabs. http://icalialabs.com

data/lib/acts_as_user/version.rb

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

data/lib/generators/active_record/templates/existing_migration.rb

@@ -1,4 +1,4 @@
-class AddActsAsUser<%= table_name.camelize %> < ActiveRecord::Migration
+class AddActsAsUserTo<%= table_name.camelize %> < ActiveRecord::Migration
   def self.up
     change_table(:<%= table_name %>) do |t|
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_user
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Abraham Kuri