lucky

Tujuannya: Cegah bug, lupakan sebagian besar masalah kinerja, dan habiskan lebih banyak waktu untuk kode daripada men -debug dan memperbaiki tes.

Singkatnya, buat penulisan aplikasi web yang menakjubkan dengan cepat, menyenangkan, dan mudah.

Berasal dari rel?

• Ruby on Rails to Lucky On Crystal: Berkembang api cepat, lebih sedikit bug, dan bahkan lebih menyenangkan.

Cobalah beruntung

Lucky memiliki serangkaian pemandu baru yang membuatnya mudah untuk memulai.

Jangan ragu untuk menyapa atau mengajukan pertanyaan di ruang obrolan kami.

Atau Anda dapat menyalin aplikasi yang berfungsi nyata dengan Lucky Jumpstart.

Menginstal Lucky

Untuk menginstal Lucky, baca pemasangan Lucky Guides untuk sistem operasi Anda. Panduan ini akan memandu Anda melalui pemasangan utilitas baris perintah yang digunakan untuk menghasilkan aplikasi keberuntungan baru.

Tetap up-to-date

Tetap up to date dengan mengikuti @luckyframework di Twitter.

Dokumentasi

API (Utama)

Seperti apa itu?

JSON Endpoint:

 class Api::Users::Show < ApiAction
  get " /api/users/:user_id " do
    user = UserQuery .find(user_id)
    json UserSerializer .new(user)
  end
end

• Jika Anda mau, Anda dapat mengatur rute khusus seperti get "/sign_in" untuk rute non istirahat.
• Metode user_id dihasilkan karena ada parameter rute user_id .
• Gunakan json untuk membuat JSON. Ekstrak Serializer untuk tanggapan JSON yang dapat digunakan kembali.

Model Basis Data

 # Set up the model
class User < BaseModel
  table do
    column last_active_at : Time
    column last_name : String
    column nickname : String ?
  end
end

• Mengatur kolom yang ingin Anda gunakan, bersama dengan tipe mereka
• Anda bisa menambahkan ? ke jenis saat kolom bisa nil . Crystal kemudian akan membantu Anda ingat untuk tidak memanggil metode yang tidak akan berhasil.
• Lucky akan mengatur validasi kehadiran untuk bidang yang diperlukan ( last_active_at dan last_name karena mereka tidak ditandai sebagai nilable).

Menanyakan database

 # Add some methods to help query the database
class UserQuery < User::BaseQuery
  def recently_active
    last_active_at.gt( 1 .week.ago)
  end

  def sorted_by_last_name
    last_name.lower.desc_order
  end
end

# Query the database
UserQuery .new.recently_active.sorted_by_last_name

• User::BaseQuery dihasilkan secara otomatis saat Anda mendefinisikan model. Mewarisi dari itu untuk menyesuaikan kueri.
• Mengatur bernama SCOPES dengan metode instan.
• Lucky mengatur metode untuk semua kolom sehingga jika Anda salah type nama kolom itu akan memberi tahu Anda pada waktu kompilasi.
• Gunakan metode lower pada kolom String untuk memastikan Postgres mengurutkan semuanya dalam huruf kecil.
• Gunakan gt untuk membuat pengguna aktif lebih besar dari 1 minggu yang lalu. Lucky memiliki banyak abstraksi yang kuat untuk membuat kueri yang kompleks, dan mengetik metode spesifik (seperti lower ).

Rendering html:

 class Users::Index < BrowserAction
  get " /users " do
    users = UserQuery .new.sorted_by_last_name
    render IndexPage , users: users
  end
end

class Users::IndexPage < MainLayout
  needs users : UserQuery

  def content
    render_new_user_button
    render_user_list
  end

  private def render_new_user_button
    link " New User " , to: Users :: New
  end

  private def render_user_list
    ul class: " user-list " do
      users.each do | user |
        li do
          link user.name, to: Users :: Show .with(user.id)
          text " - "
          text user.nickname || " No Nickname "
        end
      end
    end
  end
end

• needs users : UserQuery memberi tahu kompiler bahwa itu harus dilewati pengguna tipe UserQuery .
• Jika Anda lupa melewati sesuatu yang dibutuhkan halaman, itu akan memberi tahu Anda pada waktu kompilasi. Lebih sedikit bug dan debugging lebih cepat .
• Tulis tag dengan metode kristal. Tag ditutup secara otomatis dan whitespace dihapus.
• Ekstrak Metode Bernama dengan Mudah Karena Halaman dibuat dari kelas dan metode reguler. Ini membuat halaman HTML Anda sangat mudah dibaca.
• Tautan ke halaman lain dengan mudah. Cukup gunakan nama tindakan: Users::New . Pass params menggunakan with : Users::Show.with(user.id) . Tidak ada lagi yang mencoba mengingat pembantu jalur dan apakah penolong itu terbiasa atau tidak - jika Anda lupa untuk melewati param ke rute, Lucky akan memberi tahu Anda pada waktu kompilasi.
• Karena kami mendefinisikan column nickname : String? Sebagai nilable, Lucky akan gagal mengkompilasi halaman jika Anda baru saja melakukan text user.nickname nil Jadi alih -alih kami menambahkan Fallback "No Nickname" . Tidak ada lagi yang secara tidak sengaja mencetak teks kosong di HTML!

Pengujian

Anda perlu memastikan untuk memasang dependensi kristal.

1. Jalankan shards install
2. Jalankan crystal spec dari Root Proyek.

Berkontribusi

Lihat Contributing.md

Beruntung memilikimu!

Kami menyukai semua anggota masyarakat yang telah bekerja keras untuk membuat Lucky lebih baik. Jika Anda salah satu dari orang-orang itu, kami ingin memberi Anda t-shirt!

Untuk mendapatkan kemeja, kami meminta Anda telah memberikan kontribusi yang signifikan bagi Lucky. Ini termasuk hal -hal seperti mengirimkan PR dengan perbaikan bug dan implementasi fitur, membantu anggota lain mengatasi masalah, dan menggunakan aplikasi dunia nyata menggunakan Lucky!

Untuk mengklaim baju Anda, isi formulir ini.

Kontributor

Paulcsmith Paul Smith - Pencipta Asli Lucky

Dibuat dengan contrib.rocks.

Terima kasih & atribusi

• SessionHandler, CookiHandler dan FlashHandler didasarkan pada Amber. Terima kasih kepada tim Amber!
• Berkat Rails karena menginspirasi banyak ide yang mudah diterima begitu saja. Konvensi atas konfigurasi, menghilangkan boilerplate, dan yang paling penting - berfokus pada kebahagiaan pengembang.
• Terima kasih kepada Phoenix, ECTO dan ELIXIR karena menginspirasi operasi simpan Avram, tindakan dan pipa dasar Lucky, dan fokus pada pesan kesalahan yang bermanfaat.
• lucky watch sangat didasarkan pada Sentry. Terima kasih @samueleaton!