Merge branch 'main' into devin/1751473200-dividend-monthly-report

Author: slavingia

.prettierignore

@@ -2,4 +2,5 @@ frontend/utils/routes.*
 backend
 vendor
 tmp
-frontend/.next
+frontend/.next
+.github

CONTRIBUTING.md

@@ -0,0 +1,88 @@
+# Contributing to Flexile
+
+Thanks for your interest in contributing! This document will help you get started.
+
+## Quick Start
+
+1. Set up the repository
+
+```bash
+git clone https://github.com/antiwork/flexile.git
+```
+
+2. Set up your development environment
+
+For detailed instructions on setting up your local development environment, please refer to our [README](README.md).
+
+## Development
+
+1. Create your feature branch
+
+```bash
+git checkout -b feature/your-feature
+```
+
+2. Start the development environment
+
+```bash
+bin/dev
+```
+
+3. Run the test suite
+
+```bash
+# Run Rails specs
+bundle exec rspec
+
+# Run Playwright end-to-end tests
+pnpm playwright test
+```
+
+## Testing Guidelines
+
+- Write descriptive test names that explain the behavior being tested
+- Keep tests independent and isolated
+- For API endpoints, test response status, format, and content
+- Use factories for test data instead of creating objects directly
+- Test both happy path and edge cases
+
+## Pull Request
+
+1. Update documentation if you're changing behavior
+2. Add or update tests for your changes
+3. Include screenshots of your test suite passing locally
+4. Make sure all tests pass
+5. Request a review from maintainers
+6. After reviews begin, avoid force-pushing to your branch
+   - Force-pushing rewrites history and makes review threads hard to follow
+   - Don't worry about messy commits - we squash everything when merging to main
+7. The PR will be merged once you have the sign-off of at least one other developer
+
+## Style Guide
+
+- Follow the existing code patterns
+- Use clear, descriptive variable names
+- Write TypeScript for frontend code
+- Follow Ruby conventions for backend code
+
+## Writing Bug Reports
+
+A great bug report includes:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+## Help
+
+- Check existing discussions/issues/PRs before creating new ones
+- Start a discussion for questions or ideas
+- Open an [issue](https://github.com/antiwork/flexile/issues) for bugs or problems
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE.md).

README.md

@@ -16,7 +16,7 @@ The easiest way to set up the development environment is to use the [`bin/setup`
 
 - Set up Ruby (ideally using `rbenv`/`rvm`) and PostgreSQL
 - Install dependencies using `pnpm i` and `cd backend && bundle i`
-- Set up your environment by either using `pnpx vercel env pull` or `cp .env.example .env` and filling in missing values and your own keys
+- Set up your environment by either using `pnpx vercel env pull .env` or `cp .env.example .env` and filling in missing values and your own keys
 - Run `cd backend && gem install foreman`
 
 ## Running the App

backend/app/controllers/concerns/set_current.rb

@@ -45,6 +45,8 @@ def set_current
               default_currency: "USD"
             )
             user.company_administrators.create!(company: company)
+            user.company_administrators.reload
+            user.companies.reload
           end
         end
       end

backend/app/controllers/internal/companies/invoices_controller.rb

@@ -64,7 +64,7 @@ def microdeposit_verification_details
   def export
     authorize Invoice
 
-    body = InvoiceCsv.new(Current.company.invoices.order(created_at: :asc)).generate
+    body = InvoiceCsv.new(Current.company.invoices.alive.order(created_at: :asc)).generate
     response.headers["Content-Disposition"] = "attachment; filename=invoices-#{Time.current.strftime("%Y-%m-%d_%H%M%S")}.csv"
     render body:, content_type: "text/csv"
   end
@@ -99,14 +99,22 @@ def reject
     ).perform
   end
 
+  def destroy
+    invoice = Current.user.invoices.alive.find_by!(external_id: params[:id])
+    authorize invoice
+    invoice.mark_deleted!
+
+    head :no_content
+  end
+
   private
     def load_invoice!
-      @invoice = Current.user.invoices.find_by!(external_id: params[:id])
+      @invoice = Current.user.invoices.alive.find_by!(external_id: params[:id])
     end
 
     def authorize_invoices_for_rejection
       all_invoices_belong_to_company = invoice_external_ids_for_rejection.all? do |invoice_external_id|
-        Current.company.invoices.exists?(external_id: invoice_external_id)
+        Current.company.invoices.alive.exists?(external_id: invoice_external_id)
       end
 
       unless all_invoices_belong_to_company
@@ -117,7 +125,7 @@ def authorize_invoices_for_rejection
     def authorize_invoices_for_approval_and_pay
       ids = invoice_external_ids_for_approval + invoice_external_ids_for_payment
       all_invoices_belong_to_company = ids.all? do |invoice_id|
-        Current.company.invoices.exists?(external_id: invoice_id)
+        Current.company.invoices.alive.exists?(external_id: invoice_id)
       end
 
       unless all_invoices_belong_to_company

backend/app/controllers/internal/companies/workers_controller.rb

@@ -17,16 +17,14 @@ def create
     ).perform
 
     if result[:success]
-      render json: { success: true, new_user_id: result[:company_worker].user_id, document_id: result[:document].id }, status: :ok
+      render json: { success: true, new_user_id: result[:company_worker].user_id, document_id: result[:document]&.id }, status: :ok
     else
       render json: result, status: :unprocessable_entity
     end
   end
 
   private
     def worker_params
-      permitted_keys = %i[email started_at pay_rate_type pay_rate_in_subunits role]
-      permitted_keys << :hours_per_week if params.dig(:contractor, :pay_rate_type) == "hourly"
-      params.require(:contractor).permit(*permitted_keys)
+      params.require(:contractor).permit(:email, :started_at, :pay_rate_in_subunits, :role, :pay_rate_type, :contract_signed_elsewhere)
     end
 end

backend/app/dashboards/company_worker_dashboard.rb

@@ -14,7 +14,6 @@ class CompanyWorkerDashboard < Administrate::BaseDashboard
     user: Field::BelongsTo,
     id: Field::Number,
     started_at: Field::DateTime,
-    hours_per_week: Field::Number,
     pay_rate_in_subunits: Field::Number,
     role: Field::String,
     created_at: Field::DateTime,
@@ -40,7 +39,6 @@ class CompanyWorkerDashboard < Administrate::BaseDashboard
     user
     id
     started_at
-    hours_per_week
     pay_rate_in_subunits
     role
     created_at
@@ -54,7 +52,6 @@ class CompanyWorkerDashboard < Administrate::BaseDashboard
     company
     user
     started_at
-    hours_per_week
     pay_rate_in_subunits
     role
   ].freeze

backend/app/mailers/company_mailer.rb

@@ -28,7 +28,7 @@ def consolidated_invoice_receipt(user_id:, consolidated_payment_id:, processed_d
     user = User.find(user_id)
     consolidated_payment = ConsolidatedPayment.find(consolidated_payment_id)
     @consolidated_invoice = consolidated_payment.consolidated_invoice
-    contractors = User.where(id: @consolidated_invoice.invoices.pluck(:user_id))
+    contractors = User.where(id: @consolidated_invoice.invoices.alive.pluck(:user_id))
     @contractor_count = contractors.count
     @country_count = contractors.pluck(:country_code).uniq.count
     @bank_account_last_four = consolidated_payment.bank_account_last_four

backend/app/mailers/company_worker_mailer.rb

@@ -47,7 +47,8 @@ def invoice_rejected(invoice_id:, reason: nil)
   end
 
   def invoice_approved(invoice_id:)
-    @invoice = Invoice.find(invoice_id)
+    @invoice = Invoice.alive.find_by(id: invoice_id)
+    return if @invoice.nil?
     @company = @invoice.company
     @user = @invoice.user
     @bank_account = @user.bank_account

backend/app/models/company.rb

@@ -26,6 +26,19 @@ class Company < ApplicationRecord
     self.const_set("ACCESS_ROLE_#{access_role.upcase}", access_role)
   end
 
+  ADMIN_CHECKLIST_ITEMS = [
+    { key: "add_company_details", title: "Add company details", description: "Add your company name and basic information" },
+    { key: "add_bank_account", title: "Add bank account", description: "Connect your bank account to enable payments" },
+    { key: "invite_contractor", title: "Invite a contractor", description: "Add your first team member" },
+    { key: "send_first_payment", title: "Send your first payment", description: "Process your first contractor payment" }
+  ].freeze
+
+  WORKER_CHECKLIST_ITEMS = [
+    { key: "fill_tax_information", title: "Fill tax information", description: "Complete your tax details" },
+    { key: "add_payout_information", title: "Add payout information", description: "Set up your payment method" },
+    { key: "sign_contract", title: "Sign contract", description: "Review and sign your contractor agreement" }
+  ].freeze
+
   has_many :company_administrators
   has_many :administrators, through: :company_administrators, source: :user
   has_many :company_lawyers
@@ -98,7 +111,6 @@ def active
   after_create_commit :create_balance!
   after_update_commit :update_convertible_implied_shares, if: :saved_change_to_fully_diluted_shares?
 
-
   accepts_nested_attributes_for :expense_categories
 
   delegate :stripe_setup_intent, :bank_account_last_four, :microdeposit_verification_required?,
@@ -135,7 +147,7 @@ def has_sufficient_balance?(usd_amount)
     account_balance >= (is_trusted? ? 0 : usd_amount)
   end
 
-  def pending_invoice_cash_amount_in_cents = invoices.pending.sum(:cash_amount_in_cents)
+  def pending_invoice_cash_amount_in_cents = invoices.alive.pending.sum(:cash_amount_in_cents)
 
   def create_stripe_setup_intent
     Stripe::SetupIntent.create({
@@ -190,6 +202,28 @@ def json_flag?(flag)
     json_data&.dig("flags")&.include?(flag)
   end
 
+  def checklist_items(user)
+    case user
+    when CompanyAdministrator
+      ADMIN_CHECKLIST_ITEMS.map do |item|
+        item.merge(completed: checklist_item_completed?(item[:key], user))
+      end
+    when CompanyWorker
+      WORKER_CHECKLIST_ITEMS.map do |item|
+        item.merge(completed: checklist_item_completed?(item[:key], user))
+      end
+    else
+      []
+    end
+  end
+
+  def checklist_completion_percentage(user)
+    completed_count = checklist_items(user).count { |item| item[:completed] }
+    return 0 if checklist_items(user).empty?
+
+    (completed_count.to_f / checklist_items(user).size * 100).round
+  end
+
   private
     def update_convertible_implied_shares
       convertible_investments.each do |investment|
@@ -211,4 +245,25 @@ def fetch_or_create_stripe_customer_id!
       update!(stripe_customer_id: stripe_customer.id)
       stripe_customer_id
     end
+
+    def checklist_item_completed?(key, user)
+      case key
+      when "add_company_details"
+        name.present?
+      when "add_bank_account"
+        bank_account_ready?
+      when "invite_contractor"
+        company_workers.active.exists?
+      when "send_first_payment"
+        invoices.where(status: Invoice::PAID_OR_PAYING_STATES).exists?
+      when "fill_tax_information"
+        user.user.compliance_info&.tax_information_confirmed_at.present?
+      when "add_payout_information"
+        user.user.bank_account.present?
+      when "sign_contract"
+        user.contract_signed?
+      else
+        false
+      end
+    end
 end