Merge pull request #1510 from fatfreecrm/improve-hooks

Add codespell to devcontainer

Author: CloCkWeRX

.codespellrc

@@ -0,0 +1,6 @@
+# https://github.com/codespell-project/codespell#using-a-config-file
+[codespell]
+skip = *.log,*.cache,./tmp/*,./config/locales/*,./vendor/*,./lib/tasks/ffcrm/update_data.rake
+
+# Comma separated list of words to be ignored. Words must be lowercased.
+ignore-words-list = uncomplete,outter,isnt,rememberable

.devcontainer/install.sh

@@ -4,10 +4,13 @@ sudo add-apt-repository -y ppa:mozillateam/ppa
 
 echo -e "Package: firefox*\nPin: release o=LP-PPA-mozillateam-ppa\nPin-Priority: 550\n\nPackage: firefox*\nPin: release o=Ubuntu\nPin-Priority: -1" | sudo tee /etc/apt/preferences.d/99-mozillateamppa
 
+cp script/sample_hooks/pre-commit/ .git/hooks/
+
 sudo apt-get update
 
 sudo apt install -y libpq-dev # Not strictly needed, but easier than explaining to users to constantly pass DB=sqlite
 sudo apt install -y firefox 
+sudo apt install -y codespell
 
 bundle
 

CHANGELOG.md

@@ -248,7 +248,7 @@ Sat Apr 21, 2018 (0.18.0)
 #665 Support for Ruby 2.3 has been dropped, with test coverage for 2.4 and 2.5 enabled.
 
 #### Swap to FactoryBot
-If you consume fat free crm as an engine and re-use any factories, you'll need to [upgrade to FactoryBot](https://github.com/thoughtbot/factory_bot/blob/4-9-0-stable/UPGRADE_FROM_FACTORY_GIRL.md).
+If you consume fat free crm as an engine and reuse any factories, you'll need to [upgrade to FactoryBot](https://github.com/thoughtbot/factory_bot/blob/4-9-0-stable/UPGRADE_FROM_FACTORY_GIRL.md).
 
 #### Removed methods
 `Lead.update_with_permissions` is removed, use user_ids and group_ids inside attributes instead and call lead.update_with_account_and_lead_counters
@@ -366,7 +366,7 @@ Be aware of https://github.com/rails/sprockets/issues/426 if you were using FFCR
 
 Thu Feb 23, 2017 (0.15.0-beta.2)
 ---------------------------------------------------------------------
-This release is aimed at minor updates and ruby 2.4 compatability via
+This release is aimed at minor updates and ruby 2.4 compatibility via
 the relevant rails updates.
 
 Other improvements include:
@@ -460,7 +460,7 @@ https://github.com/fatfreecrm/fat_free_crm/compare/v0.13.2...v0.13.3
 ---------------------------------------------------------------------
  - Lock down routes.
  - Remove stub hook
- - Remove unneccessary function
+ - Remove unnecessary function
  - Don't spam gmail by default
  - consider_all_requests_local should be off by default in production mode
  - Remove pysch by default (optimise for ruby 2 now)
@@ -694,7 +694,7 @@ Thu, Aug 5, 2010
 
 Wed, Aug 4, 2010
 ---------------------------------------------------------------------
-- Made dropbox email address comparision was case-insensitve (thanks, Ralf!)
+- Made dropbox email address comparison was case-insensitive (thanks, Ralf!)
 - Removed duplicate association Opportunity#account (was: has_one + belongs_to) (thanks, Ralf!)
 - Multiple fixes for Rails 2.3.8 upgrade (thanks, Ralf!)
 
@@ -772,7 +772,7 @@ Tue, Jun 8, 2010
 
 Fri, Jun 4, 2010
 ---------------------------------------------------------------------
-- Initial prototype of seleting related asset from the asset's landing page.
+- Initial prototype of selecting related asset from the asset's landing page.
 - Added discard action related specs.
 
 Fri, May 28, 2010
@@ -2340,7 +2340,7 @@ Sun, Dec 14, 2008
 
 Sat, Dec 13, 2008
 ---------------------------------------------------------------------
-- Insalled [annotate_models] plugin and generated model annotations.
+- Installed [annotate_models] plugin and generated model annotations.
 - Generated campaign fixtures.
 - Updated [Campaign] model to include actual vs. targets.
 - Added permissions to [Campaign/New].
@@ -2359,7 +2359,7 @@ Wed, Dec 10, 2008
 
 Tue, Dec 9, 2008
 ---------------------------------------------------------------------
-- Implemented [Campaing/New] with dates validation and status set.
+- Implemented [Campaign/New] with dates validation and status set.
 
 Mon, Dec 8, 2008
 ---------------------------------------------------------------------

Gemfile

@@ -115,7 +115,7 @@ gem 'mini_magick'
 gem 'image_processing', '~> 1.2'
 gem 'jquery-ui-rails', git: 'https://github.com/jquery-ui-rails/jquery-ui-rails.git', tag: 'v7.0.0' # See https://github.com/jquery-ui-rails/jquery-ui-rails/issues/146
 
-# Ruby 3.4 explict dependencies
+# Ruby 3.4 explicit dependencies
 gem 'bigdecimal'
 gem 'mutex_m'
 gem 'drb'

app/controllers/comments_controller.rb

@@ -59,7 +59,7 @@ def create
 
   # PUT /comments/1
   # PUT /comments/1.json
-  # PUT /comments/1.xml                                          not implemened
+  # PUT /comments/1.xml                                         not implemented
   #----------------------------------------------------------------------------
   def update
     @comment = Comment.find(params[:id])

app/controllers/home_controller.rb

@@ -130,7 +130,7 @@ def activity_event
 
   #----------------------------------------------------------------------------
   # TODO: this is ugly, ugly code. It's being security patched now but urgently
-  # needs refactoring to use user id instead. Permuations based on name or email
+  # needs refactoring to use user id instead. Permutations based on name or email
   # yield incorrect results.
   def activity_user
     return nil if current_user.pref[:activity_user] == "all_users"

app/controllers/users_controller.rb

@@ -6,7 +6,7 @@
 # See MIT-LICENSE file or http://www.opensource.org/licenses/mit-license.php
 #------------------------------------------------------------------------------
 class UsersController < ApplicationController
-  before_action :set_current_tab, only: %i[show opportunities_overview] # Don't hightlight any tabs.
+  before_action :set_current_tab, only: %i[show opportunities_overview] # Don't highlight any tabs.
 
   check_authorization
 

app/helpers/application_helper.rb

@@ -319,7 +319,7 @@ def size_from_style!(options)
 
   # Entities can have associated avatars or gravatars. Only calls Gravatar
   # in production env. Gravatar won't serve default images if they are not
-  # publically available: https://en.gravatar.com/site/implement/images
+  # public: https://en.gravatar.com/site/implement/images
   #----------------------------------------------------------------------------
   def avatar_for(model, args = {})
     args = { class: 'gravatar', size: :large }.merge(args)

app/mailers/subscription_mailer.rb

@@ -14,7 +14,7 @@ def comment_notification(user, comment)
     @comment = comment
     @user = comment.user
 
-    # If entity has tags, join them and wrap in parantheses
+    # If entity has tags, join them and wrap in parentheses
     subject = "RE: [#{@entity_type.downcase}:#{@entity.id}] #{@entity_name}"
     subject += " (#{@entity.tags.join(', ')})" if @entity.tags.any?
 

app/models/observers/opportunity_observer.rb

@@ -25,7 +25,7 @@ def after_update(item)
         update_campaign_revenue(item.campaign, item.amount.to_f - item.discount.to_f)
         item.update_attribute(:probability, 100) # Set probability to 100% if won
         log_activity(item, :won)
-      elsif original.stage == "won" && item.stage != "won" # :won to :other -- substract from total campaign revenue.
+      elsif original.stage == "won" && item.stage != "won" # :won to :other -- subtract from total campaign revenue.
         update_campaign_revenue(original.campaign, -(original.amount.to_f - original.discount.to_f))
       elsif original.stage != "lost" && item.stage == "lost"
         item.update_attribute(:probability, 0) # Set probability to 0% if lost