0.0
No release in over a year
ActiveRecord like models for the Baza database framework
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Project Readme

Code Climate Test Coverage Build Status

BazaModels

An attempt to recreate 90% of the ActiveRecord functionality in a very simple way.

The examples in this readme actually work.

Relationships

has_many

class User < BazaModels::Model
  has_many :roles
  has_many :admin_roles, -> { where(role: "administrator") }, class_name: "Role", dependent: :restrict_with_error # :destroy-dependent also works
end

has_one

class User < BazaModels::Model
  has_one :person, dependent: :restrict_with_error # :destroy-dependent also works
end

belongs_to

class Role < BazaModels::Model
  belongs_to :user
end

Validations

Presence

class User < BazaModels::Model
  validates :email, presence: true
end

Queries

Where

users = User.where(email: "myemail@example.com").to_a

Group

users = User.group(:email).to_a

Order

users = User.order(:email).to_a

Includes / autoloading / eager loading

users = User.includes(:roles)

Joins

users = User.joins(:roles).where(roles: {role: 'administrator'})

Other methods...

User.where(email: "myemail@example.com").to_sql #=> "SELECT `users`.* FROM..."
User.any? #=> true
User.all #=> BazaModels::Query<...>
User.select(:email)
User.limit(5)
User.to_enum
User.first
User.last
User.order(:id).reverse_order
Role.joins(:user).select("roles.*, users.email AS user_email").first.user_email #=> "test@example.com"

Ransack

Person.ransack(user_organization_name_cont: "test").result.to_a #=> [user]

Setting and saving attributes

Setting

role.assign_attributes(user: user, role: "administrator")
role.save! #=> true || raising error

role.update_attributes!(user: user, role: "administrator") #=> true || raising error
role.role = "administrator"
role.save #=> true || false

Getting

role.role #=> "administrator"
role.user #=> [some user]
role.has_attribute?(:created_at) #=> true

Contributing to baza_models

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2015 kaspernj. See LICENSE.txt for further details.