add description

Author: theswamis

app/controllers/base_libraries_controller.rb

@@ -59,6 +59,6 @@ def set_library
 
   # Only allow a list of trusted parameters through.
   def library_params
-    params.require(:library).permit(:name, :source_url, :user_id)
+    params.require(:library).permit(:name, :description, :source_url, :user_id)
   end
 end

app/models/library.rb

@@ -11,7 +11,7 @@ class Library < ApplicationRecord
   has_many :users, through: :library_users
 
   pg_search_scope :search_by_name,
-                  against: %i[name],
+                  against: %i[name description],
                   using: {
                     tsearch: { prefix: true, dictionary: 'english',
                                tsvector_column: 'search_vector' } # This option allows partial matches

app/views/libraries/_form.html.erb

@@ -16,6 +16,11 @@
     <%= form.text_field :name, class: "block shadow rounded-md border border-gray-200 outline-none px-3 py-2 mt-2 w-full" %>
   </div>
 
+  <div class="my-5">
+    <%= form.label :description %>
+    <%= form.text_area :description, rows: 3, class: "block shadow rounded-md border border-gray-200 outline-none px-3 py-2 mt-2 w-full" %>
+  </div>
+
   <div class="my-5">
     <%= form.label 'Help URL (A link to more details about the library documents)' %>
     <%= form.text_field :source_url, class: "block shadow rounded-md border border-gray-200 outline-none px-3 py-2 mt-2 w-full" %>

app/views/libraries/_library.html.erb

@@ -1,6 +1,11 @@
 <div id="<%= dom_id library %>">
   <div class="flex justify-between my-3">
-    <h2 class="w-1/4"><%= link_to library.name, library, class: "hover:underline text-sky-500 font-medium" %></h2>
+    <div class="w-1/2">
+      <h2><%= link_to library.name, library, class: "hover:underline text-sky-500 font-medium" %></h2>
+      <% if library.description.present? %>
+        <p class="text-sm text-gray-600 mt-1"><%= truncate(library.description, length: 100) %></p>
+      <% end %>
+    </div>
     <div>Created <%= time_ago_in_words(library.created_at) %> ago</div>
     <div class="w-1/4">
       <%= link_to library.documents.count.to_s + " documents", library_documents_path(library.id), class:"text-sky-500 hover:underline" %>

app/views/libraries/show.html.erb

@@ -15,6 +15,11 @@
       <%= render partial: 'shared/button_group', locals: { buttons: buttons } %>
     </div>
   </div>
+  <% if @library.description.present? %>
+    <div class="mt-4 p-4 bg-stone-200 rounded-lg text-sm">
+      <p class="text-stone-600"><%= simple_format(@library.description) %></p>
+    </div>
+  <% end %>
   <div class="py-2 text-stone-500 text-xs ">
     Owner <span class="text-stone-500 font-bold "><%= (@library.user.email) %> </span> |
     Created <span class="text-stone-500 font-bold  "><%= time_ago_in_words(@library.created_at) %> ago</span> |

db/migrate/20251010203649_add_description_to_libraries.rb

@@ -0,0 +1,5 @@
+class AddDescriptionToLibraries < ActiveRecord::Migration[7.2]
+  def change
+    add_column :libraries, :description, :text
+  end
+end

db/migrate/20251010203736_update_libraries_search_vector.rb

@@ -0,0 +1,27 @@
+class UpdateLibrariesSearchVector < ActiveRecord::Migration[7.2]
+  def up
+    # Drop the existing search_vector column
+    remove_column :libraries, :search_vector
+
+    # Add the new search_vector column that includes both name and description
+    add_column :libraries, :search_vector, :virtual, type: :tsvector,
+                                                     as: "to_tsvector('english'::regconfig, COALESCE(name, '') || ' ' || COALESCE(description, ''))",
+                                                     stored: true
+
+    # Re-add the index
+    add_index :libraries, :search_vector, using: :gin
+  end
+
+  def down
+    # Drop the current search_vector column
+    remove_column :libraries, :search_vector
+
+    # Add back the original search_vector column (name only)
+    add_column :libraries, :search_vector, :virtual, type: :tsvector,
+                                                     as: "to_tsvector('english'::regconfig, (name)::text)",
+                                                     stored: true
+
+    # Re-add the index
+    add_index :libraries, :search_vector, using: :gin
+  end
+end

db/schema.rb

@@ -5,6 +5,7 @@
     # Define attributes for Library model
     # For example:
     name { 'Main Library' }
+    description { 'A comprehensive collection of documents and resources' }
     association :user
   end
 end

spec/factories/library.rb

@@ -16,6 +16,16 @@
       library = build(:library, name: nil, user:)
       expect(library).not_to be_valid
     end
+
+    it 'is valid with a description' do
+      library = build(:library, description: 'A test library description', user:)
+      expect(library).to be_valid
+    end
+
+    it 'is valid without a description' do
+      library = build(:library, description: nil, user:)
+      expect(library).to be_valid
+    end
   end
 
   describe 'associations' do