Resourced
Resourced adds a missing layer between model and controller. It takes all parameter- and scope-related jobs from the model and makes your model thin. Here is example:
class PostResource
include Resourced::ActiveRecord
model Post
body :post
key :id
attributes do
allow :title, :body
allow :tags, as: :array
allow :category, as: :string, if: -> { scope.admin? }
end
finders do
restrict :search, if: -> { scope.guest? }
finder :title do |val|
chain.where(title: val)
end
finder :search do |val|
chain.where(t[:body].matches("%#{val}%"))
end
finder :limit, as: :integer, default: 20 do |val|
chain.limit(20)
end
end
endNow you can do following:
before_filter do
posts = PostResource.new(params, current_user)
end
# Let params: { title: "My first post", body: "Lorem ipsum" }
post = posts.build
post # => #<Post id: nil, title: "My first post", body: "Lorem ipsum", category: nil>
# Let params: { id: 2, title: "My awesome post" }
posts.update! # Will update title for post with id 2
posts.first # Will find first post with title "My awesome post"
# Let params: { search: "Atlas Shrugged" }
posts.all # Will return all posts which contains "Atlas Shrugged" unless current user is guestInstallation
Add this line to your application's Gemfile:
gem 'resourced', '~> 0.1'
And then execute:
$ bundle
Or install it yourself as:
$ gem install resourced
Usage
Creating Resources
If you are using rails, your resource files will be automatically generated with models or resources.
rails generate resource Something field1:string field2:integer
You can also generate resource file manually:
rails generate resourced Something field1:string field2:integer
This will create folder app/resources if not exists, and basic resource file.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request