ActsAsResource

This gem handle whether user can access the resources. Resource cab be project, document, etc.

Installation

Add this line to your application's Gemfile:

gem 'acts_as_resource'

And then execute:

$ bundle

Generate migration and run it

rails g acts_as_resource:migration
rake db:migrate

Usage

class User < ActiveRecord::Base
  acts_as_accessable resources: [ :projects ]
  # resources option help to define has_many :projects
  # resources option is optional
end

class Project < ActiveRecord::Base
  acts_as_resource accessors: [ :users ]
  # accessors option help to define has_many :users association
  # accessors option is optional
end

user = User.create!
project = Project.create!

user.projects
# => [ ]
project.users
# => [ ]
user.can_access?(project)
# => false
project.accessible_by?(user)
# => false

user.projects << project # or project.users << user
user.projects
# => [ project ]
project.users
# => [ user ]
user.can_access?(project)
# => true
project.accessible_by?(user)
# => true

another_user = User.create!
another_user.can_access?(project)
# => false

How it works?

In install step, migration will create resourceships table. This table help to store accessors and resources' relation.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/darren987469/acts_as_resource. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Resource project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.