/virtual_view

Describe a view in code to back ActiveRecord models

Primary LanguageRubyMIT LicenseMIT

Version      Build Status Code Climate Test Coverage Dependencies

VirtualView

VirtualView unlocks the ability to back your models with in-code views, best described in Arel.

Requirements

Ruby 2.3+ ActiveRecord 4.2+

Installation

Add this line to your application's Gemfile:

gem 'virtual_view'

And then execute:

$ bundle

Or install it yourself as:

$ gem install virtual_view

Usage

Invoking with_virtual_view sets the class up to use the virtual_view functionality.

class User < ActiveRecord::Base
  # the rest of your model code...
end

class Admin < User
  arel_view do
    arel_table.where(arel_table[:role].eq(1))
  end

  # the rest of your model code...
end

Development

After checking out the repo, run bundle to install dependencies. Then, run bundle exec rspec to run the tests.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/TwilightCoders/virtual_view. 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.