Yet Another Data Definition Language for Rails + Active Record
Ruby HTML Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
Gemfile
Gemfile.lock
MIT-LICENSE
README.md
Rakefile
yaddl.gemspec

README.md

Yaddl

This project rocks and uses MIT-LICENSE.

Usage

gem 'yaddl'

rake yaddl:models
rake yaddl:migrations

Example Input

/db/schema.yaddl

TestModel(name:string)
  =to_s{name}
  *RelatedModel

Output

/app/models/test_model.rb

class TestModel < ActiveRecord::Base
  has_many :related_models, dependent: :destroy

  attr_accessible :name

  accepts_nested_attributes_for :related_models

  # returns: string
  def to_s
    name
  end
end

/app/models/related_model.rb

class RelatedModel < ActiveRecord::Base
  belongs_to :test_model

  attr_accessible :test_model_id
end

Syntax

Legend:

  • attribute:type - a model attribute; inline format will create 'primary references' for display ex: Model(name:string)
  • =function - an property that is calculated not stored =value{ "ruby code" }
  • ==setter - a property setter ex: ==value{ self.database_value = value; self.save }
  • &cached - a value or model that is cached until a condition is met &cached{ 'condition summary' }
  • Reference - has_one
  • +Reference - belongs_to
  • *Multiplicity - has_many
  • **ManyToMany:OptionalBackingTable(join_model:attributes) - has and belongs to many
  • attribute:*Reference - polymorphic association reference entry
  • .SubDocument - local/sub document, entry, ex: .SubDocument, .*SubDocumentArray, .sub_name:NamedSubDocument
  • @Mixin - define or use mixin
  • ___ - mixin name placeholder for named:@Mixin (these work in mixin code blocks and mixin attribute names)
  • mmm/MMM(s) - model name placeholders (these work in any code blocks and mixin attribute names)
  • {ruby_code} - ruby_code will be added to model
  • !controller{ruby_code} - ruby_code will be added to controller
  • !!{ruby_code} - unique ruby_code will be added to model only once
  • if, unless, def, module, class - ruby code blocks (else and elsif are not currently supported at root)
  • include, require, has_many, serialize, etc. - single line ruby methods

Example Yaddl File

/db/photo_gallery.yaddl

Gallery(name:string)
  @Describable
  @Commentable

  User

  *Photo(name:string)
    @Describable
    @Commentable

    User

    photographer:User
    *participant:User

    taken_at:datetime

    -image_src:text
    -thumb_src:text

    before_save :generate_thumbnail
    def generate_thumbnail
      # generate a thumbnail from image_drc for thumb_src
    end

User(email:string)
  !!{has_secure_password}
  name:string
  email:string
  password_digest:string
  attr_accessible :password
  =to_s{email}

@Describable
  description:text

@Commentable
  *Comment
    @Commentable
    User
    approved:boolean
    def approve!
      self.update_columns(approved: true)
    end

Example Output

Migrations

/db/schema.rb

ActiveRecord::Schema.define(version: 20140318005217) do

  create_table "comments", force: true do |t|
    t.boolean  "approved"
    t.integer  "gallery_id"
    t.integer  "photo_id"
    t.integer  "comment_id"
    t.datetime "created_at"
    t.datetime "updated_at"
  end

  add_index "comments", ["comment_id"], name: "index_comments_on_comment_id"
  add_index "comments", ["gallery_id"], name: "index_comments_on_gallery_id"
  add_index "comments", ["photo_id"], name: "index_comments_on_photo_id"

  create_table "galleries", force: true do |t|
    t.string   "name"
    t.text     "description"
    t.datetime "created_at"
    t.datetime "updated_at"
  end

  create_table "photos", force: true do |t|
    t.string   "name"
    t.datetime "taken_at"
    t.text     "image_src"
    t.text     "thumb_src"
    t.text     "description"
    t.integer  "gallery_id"
    t.integer  "photographer_id"
    t.datetime "created_at"
    t.datetime "updated_at"
  end

  add_index "photos", ["gallery_id"], name: "index_photos_on_gallery_id"
  add_index "photos", ["photographer_id"], name: "index_photos_on_photographer_id"

  create_table "users", force: true do |t|
    t.string   "email"
    t.string   "name"
    t.string   "password_digest"
    t.integer  "gallery_id"
    t.integer  "photo_id"
    t.integer  "participants_id"
    t.integer  "comment_id"
    t.datetime "created_at"
    t.datetime "updated_at"
  end

  add_index "users", ["comment_id"], name: "index_users_on_comment_id"
  add_index "users", ["gallery_id"], name: "index_users_on_gallery_id"
  add_index "users", ["participants_id"], name: "index_users_on_participants_id"
  add_index "users", ["photo_id"], name: "index_users_on_photo_id"

end

/app/models/photo.rb

class Photo < ActiveRecord::Base
  belongs_to :gallery
  belongs_to :photographer, class_name: "User", dependent: :destroy
  has_one :user, dependent: :destroy
  has_many :participants, class_name: "User", dependent: :destroy, foreign_key: :participant_id
  has_many :comments, dependent: :destroy

  attr_accessible :gallery_id, :photographer_id
  attr_accessible :name, :taken_at, :image_src, :thumb_src, :description

  accepts_nested_attributes_for :user
  accepts_nested_attributes_for :participants, :comments

  before_save :generate_thumbnail

  def generate_thumbnail
    # generate a thumbnail from image_drc for thumb_src
  end
end

/app/models/gallery.rb

class Gallery < ActiveRecord::Base
  has_one :user, dependent: :destroy
  has_many :photos, dependent: :destroy
  has_many :comments, dependent: :destroy

  attr_accessible :name, :description

  accepts_nested_attributes_for :user
  accepts_nested_attributes_for :photos, :comments
end

/app/models/comment.rb

class Comment < ActiveRecord::Base
  belongs_to :gallery
  belongs_to :photo
  belongs_to :comment
  has_one :user, dependent: :destroy
  has_many :comments, dependent: :destroy

  attr_accessible :gallery_id, :photo_id, :comment_id
  attr_accessible :approved

  accepts_nested_attributes_for :user
  accepts_nested_attributes_for :comments

  def approve!
    self.update_columns(approved: true)
  end
end

/app/models/user.rb

class User < ActiveRecord::Base
  belongs_to :gallery
  belongs_to :photo
  belongs_to :participants, class_name: "Photo"
  belongs_to :comment
  has_many :photographer_photos, class_name: "Photo", foreign_key: :photographer_id, dependent: :destroy

  attr_accessible :gallery_id, :photo_id, :participants_id, :comment_id
  attr_accessible :email, :name, :password_digest

  accepts_nested_attributes_for :photographer_photos

  has_secure_password
  attr_accessible :password

  # returns: string
  def to_s
    email
  end
end