Model creation / addition / update

This section describes how to add a new table and add a column to an existing Model using the souls command.

When adding a new table in the SOULs framework, there are four steps you need to do:

1. Migration file creation, migration,
2. Executing the souls db migrate
3. Model, FactoryBot definition,
4. Executing the souls test

Whether you're creating a new Model or adding a column to an existing table, this step doesn't change.

SOULs will add new tests as new APIs grow.

Create a User Model

$ souls db create_migration user
db/migrate/20210818082734_create_users.rb
🎉  Done!

class CreateUsers < ActiveRecord::Migration[6.1]
  def change
    create_table :users do |t|
      t.string :uid, null: false, unique: true
      t.string :username, null: false, default: ""
      t.string :screen_name, null: false, default: ""
      t.string :last_name, null: false, default: ""
      t.string :first_name, null: false, default: ""
      t.string :last_name_kanji, null: false, default: ""
      t.string :first_name_kanji, null: false, default: ""
      t.string :last_name_kana, null: false, default: ""
      t.string :first_name_kana, null: false, default: ""
      t.string :email, null: false, unique: true
      t.string :tel, null: false, default: ""
      t.string :icon_url, null: false, default: ""
      t.string :birthday, null: false, default: ""
      t.string :gender, null: false, default: ""
      t.string :lang, null: false, default: "ja"
      t.string :category, null: false, default: "user"
      t.integer :roles_mask, null: false, default: 1
      t.boolean :is_deleted, null: false, default: false
      t.timestamps
    end
    add_index :users, :uid
    add_index :users, :screen_name
    add_index :users, :email, unique: true
    add_index :users, :username
    add_index :users, :is_deleted
  end
end

Run souls db migrate

$ souls db migrate
== 20210818082734 CreateUsers: migrating ======================================
-- create_table(:users)
   -> 0.0223s
-- add_index(:users, :uid)
   -> 0.0054s
-- add_index(:users, :screen_name)
   -> 0.0050s
-- add_index(:users, :email, {:unique=>true})
   -> 0.0050s
-- add_index(:users, :username)
   -> 0.0068s
-- add_index(:users, :is_deleted)
   -> 0.0049s
== 20210818082734 CreateUsers: migrated (0.0498s) =============================

Executing the souls g scaffold command

$ souls g scaffold user
Created file! : ./app/models/user.rb
Created file! : ./app/graphql/types/user_type.rb
Created file! : ./app/graphql/types/edges/user_edge.rb
Created file! : ./app/graphql/types/connections/user_connection.rb
Created file! : ./app/graphql/resolvers/user_search.rb
Created file! : ./spec/factories/users.rb
Created file! : ./spec/models/user_spec.rb
Created file! : ./spec/mutations/base/user_spec.rb
Created file! : ./spec/queries/user_spec.rb
Created file! : ./spec/resolvers/user_search_spec.rb
Created file! : ./app/graphql/queries/user.rb
Created file! : ./app/graphql/queries/users.rb
Created file! : ./app/graphql/mutations/base/user/create_user.rb
Created file! : ./app/policies/user_policy.rb
Created file! : ./spec/policies/user_policy_spec.rb
🎉  Generated SOULs CRUD Files

User Model definition

Next, define User

class User < ActiveRecord::Base
  include RoleModel
  has_many :article

  VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i
  private_constant :VALID_EMAIL_REGEX
  validates :email, presence: true, uniqueness: true, format: { with: VALID_EMAIL_REGEX }

  roles :normal, :user, :admin, :master
  before_create :assign_initial_roles

  # Scope
  default_scope -> { order(created_at: :desc) }

  def assign_initial_roles
    roles << [:normal]
  end
end

FactoryBot definition

require "gimei"
FactoryBot.define do
  factory :user do
    uid { Faker::Internet.password }
    username { Gimei.kanji }
    screen_name { Faker::Internet.unique.username }
    last_name { Gimei.last.hiragana }
    first_name { Gimei.first.hiragana }
    last_name_kanji { Gimei.last.kanji }
    first_name_kanji { Gimei.first.kanji }
    last_name_kana { Gimei.last.katakana }
    first_name_kana { Gimei.last.katakana }
    email { Faker::Internet.unique.email }
    tel { Faker::PhoneNumber.subscriber_number(length: 10) }
    icon_url { "https://picsum.photos/200" }
    birthday { Faker::Date.birthday(min_age: 18, max_age: 65) }
    gender { Gimei.male }
    lang { "ja" }
    category { "user" }
    roles_mask { 1 }
    is_deleted { false }
  end
end

Executing the souls test command

Now that we've defined the Model and Factory, let's test the status of the app.

$ souls test
User Model テスト
  User データを書き込む
    valid User Model

UserSearch Resolver テスト
  削除フラグ false の User を返却する
    return User Data

User Query テスト
  User データを取得する
    return User Data

User Mutation テスト
  User データを登録する
    return User Data

Finished in 0.92612 seconds (files took 1.28 seconds to load)
9 examples, 0 failures

Randomized with seed 15544

All nine tests were successful.

Add a column to the User table

Next, let's add a column to User

member_name , member_rank , is_membership , member_badges columns to the User table.

souls db add_column command.

$ souls db add_column user
db/migrate/20210816092410_add_column_to_users.rb.
🎉  Done!

Define a new column in the created Migration file.

class AddColumnToUsers < ActiveRecord::Migration[6.1]
  def change
    add_column :users, :member_name, :string, null: false, default: ""
    add_column :users, :member_rank, :integer, null: false, default: 0
    add_column :users, :member_badges, :string, null: false, array: true, default: []
    add_column :users, :is_membership, :boolean, null: false, default: false
  end
end

Run the souls db migrate command

$ souls db migrate
== 20210816092410 AddColumnToUsers: migrating =================================
-- add_column(:users, :member_name, :string, {:null=>false, :default=>""})
   -> 0.0019s
-- add_column(:users, :member_rank, :integer, {:null=>false, :default=>0})
   -> 0.0012s
-- add_column(:users, :member_badges, :string, {:null=>false, :array=>true, :default=>[]})
   -> 0.0012s
-- add_column(:users, :is_membership, :boolean, {:null=>false, :default=>false})
   -> 0.0013s
== 20210816092410 AddColumnToUsers: migrated (0.0058s) ========================

Run souls update

You need to add new columns to all CRUD related files created with the souls g scaffold user

souls update command to automatically add newly added columns to the required files.

$ souls update scaffold user
Updated file! : ./app/graphql/mutations/base/user/create_user.rb
Updated file! : ./app/graphql/mutations/base/user/update_user.rb
Updated file! : ./app/graphql/resolvers/user_search.rb
Updated file! : ./app/graphql/types/user_type.rb
Updated file! : ./spec/factories/users.rb
Updated file! : ./spec/mutations/base/user_spec.rb
Updated file! : ./spec/resolvers/user_search_spec.rb
🎉  Done!

Seven files dealing with parameters have been updated.

Executing the souls test command

Always test your app when new changes are made.

$ souls test
    return User Data

User Model テスト
  User データを書き込む
    valid User Model

User Mutation テスト
  User データを登録する
    return User Data

Finished in 0.92958 seconds (files took 1.33 seconds to load)
9 examples, 0 failures

Randomized with seed 55205

You have successfully added a column.