rails-contact 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f8cf546cda0f081e8da876f17377f8d71f384c41c868cfda1d19af009c6fd63
-  data.tar.gz: 307ce9285a133f372d09aa503235620ab669a6ef94a60cbdd132486dc3086cc5
+  metadata.gz: b40ac2006fcc2931b47cbc8b339770f3c148bca499cae741ee87c2e756a1a290
+  data.tar.gz: 6be3bc28491e1f20cd6c61409f8d6454db921bf1907b1834e801760d5abb304a
 SHA512:
-  metadata.gz: 721d2f5d8a7b111d6139069bd9af461278e385dca6080fbed28521fc582ba9ad8a4ecee3f1d4b6f5f9bae241ce94f22a18f61757b16aa290ec9c1bd6e495dec1
-  data.tar.gz: 15b1587cd03cdc1b5d090b7f972c2c2d84e9313d7f7ae07e070d86bf14bbcd630ed4fb1e390d2a92cc164a5564663edbc59e4a296616195478053b53bb14047d
+  metadata.gz: 32f9fc983a9c6eea9e37ceb4d3e220ad4f0f14e4ba54d195e5ef1278f3674e598492b242cddde852efc7f51b797280758cf0f4b95ac8e905beb1dd69a2c5f65b
+  data.tar.gz: ca941d755aa4db4679f79a8a7122f3bfa36db04b0ba32f9623d522cdf2afc2df93091dd2f4bc3b7e415f7ef167e563808ffee61ecca190e8fc8f3291f89eeac1

data/.github/workflows/ci.yml

@@ -61,5 +61,5 @@ jobs:
           bundler-cache: true
 
       - name: Run tests
-        run: bundle exec ruby -Itest -e 'Dir["test/**/*_test.rb"].sort.each { |f| require File.expand_path(f) }'
+        run: bundle exec rspec --format progress
 

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format documentation

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 0.1.4
+
+- Default to the host `application` layout when the engine is mounted, with `inherit_host_layout` (default `true`) to opt back into the engine-only layout.
+- Ensure nested field add/remove and bulk checkbox scripts run when the host uses importmap (inline scripts + idempotent global guards; same guard in `nested_fields.js` for the Sprockets bundle).
+- Pull engine stylesheet into each main contact view so styling works without the engine layout’s asset tags.
+
+## 0.1.3
+
+- Flatten view partial paths under `app/views/rails/contact` and remove legacy `contacts/` partial nesting.
+- Add `.gitignore` to keep generated artifacts (including `coverage/`) out of release commits.
+- Update packaging/docs metadata for smoother RubyGems release workflow.
+
+## 0.1.2
+
+- Breaking parity-focused rewrite foundation for richer Google-like contacts.
+- Added label, website, event, merge, and bulk-delete capabilities.
+- Added dynamic nested field add/remove behavior for multi-value rows.
+- Introduced RSpec suite with SimpleCov gates (100% line/branch in tracked critical files).
+- Added parity matrix, roadmap, and migration documentation.
+
 ## 0.1.1
 
 - Fix mounted route shape to avoid `/contacts/contacts` duplication.

data/Gemfile

@@ -11,6 +11,9 @@ gem "minitest-reporters"
 gem "mocha"
 gem "webmock"
 gem "parallel", "~> 1.26.0"
+gem "rspec-rails", "~> 8.0"
+gem "factory_bot"
+gem "simplecov", require: false
 
 # Omakase Ruby styling [https://github.com/rails/rubocop-rails-omakase/]
 gem "rubocop-rails-omakase", require: false

data/README.md

@@ -1,70 +1,125 @@
 # rails-contact
 
-`rails-contact` is a mountable Rails engine to manage contacts in your app, with optional Elasticsearch search and Google Contacts sync.
+`rails-contact` is a mountable Rails engine for Google-Contacts-style contact management.
 
-## What you get
+It provides:
 
-- Contact CRUD screens and controller
-- Local contact schema (emails, phones, addresses)
-- CSV importer
-- Elasticsearch search backend (with DB fallback)
-- Google sync service scaffolding
-- Install, migration, view, and controller generators
+- rich contact profile fields
+- multi-value contact methods (emails/phones/addresses/websites/events)
+- labels/tags
+- dynamic add/remove nested rows
+- Elasticsearch-backed search with DB fallback
+- CSV import and Google sync scaffolding
+- merge and bulk-delete operations
+- Devise-style override generators
 
-## 1) Install the gem
+---
+
+## Quickstart
+
+### 1) Add gem
 
 ```ruby
-gem "rails-contact"
+gem "rails-contact", "~> 0.1.4"
 ```
 
 ```bash
 bundle install
 ```
 
-## 2) Run generators
+### 2) Install and generate schema
 
 ```bash
 rails generate rails:contact:install
 rails generate rails:contact:contact Contact
+rails db:migrate
 ```
 
-Optional override generators (Devise-style customization):
+### 3) Mount engine routes
 
-```bash
-rails generate rails:contact:views
-rails generate rails:contact:controllers
+```ruby
+rails_contact_for :contacts
 ```
 
-Then migrate:
+or explicit mount:
 
-```bash
-rails db:migrate
+```ruby
+mount Rails::Contact::Engine => "/contacts", as: "rails_contact"
 ```
 
-## 3) Mount routes (clean paths)
+`rails_contact_for :contact` is auto-normalized to `/contacts`.
 
-Use either:
+### 4) Visit UI
+
+- `/contacts`
+- `/contacts/new`
+- `/contacts/:id`
+
+### Host layout and importmap
+
+By default the engine uses your host app layout named `application` so contacts pages match the rest of your UI (including Turbo and importmap). Styles for engine markup are included per page via `stylesheet_link_tag`, and nested “add row” / bulk-selection behavior uses small inline scripts so you do **not** need to pin gem JavaScript in the host importmap.
+
+To use the engine’s standalone layout and bundled `javascript_include_tag "rails/contact/application"` instead:
 
 ```ruby
-mount Rails::Contact::Engine => "/contacts", as: "rails_contact"
+Rails::Contact.configure do |config|
+  config.inherit_host_layout = false
+end
 ```
 
-or:
+---
 
-```ruby
-rails_contact_for :contacts
+## Generators
+
+```bash
+rails generate rails:contact:install
+rails generate rails:contact:contact Contact
+rails generate rails:contact:views
+rails generate rails:contact:controllers
 ```
 
-With this setup, paths are:
-- `/contacts` (index)
-- `/contacts/new`
-- `/contacts/:id`
+- `views` copies templates so host apps can customize UI.
+- `controllers` copies an override-ready contacts controller.
+
+---
+
+## Feature map
+
+### Core profile fields
+
+- Prefix, first, middle, last, suffix, nickname
+- Company, job title, department
+- Labels (comma-separated input)
+- Notes and metadata
+- Starred flag
+- Photo URL
+
+### Multi-value sections (dynamic)
+
+- Emails
+- Phones
+- Addresses
+- Websites
+- Events (birthday/custom)
 
-No `/contacts/contacts` duplication.
+Rows can be added/removed dynamically in form UI.
 
-## 4) Configure
+### List/search
 
-Generated initializer: `config/initializers/rails_contact.rb`
+- Search by name/email/phone/company/job title/labels
+- Filter by city/region/sync/starred
+- Sort by recent updates
+
+### Actions
+
+- Bulk delete selected contacts
+- Merge source contact into target contact
+
+---
+
+## Configuration
+
+Initializer: `config/initializers/rails_contact.rb`
 
 ```ruby
 Rails::Contact.configure do |config|
@@ -73,26 +128,38 @@ Rails::Contact.configure do |config|
   config.google_sync_enabled = false
   config.google_max_contacts = 25_000
   config.rolling_window_sort = :updated_at
+  config.default_per_page = 25
 end
 ```
 
-## CSV import
+---
+
+## Rake tasks
 
 ```bash
+rake rails_contact:reindex
+rake rails_contact:sync_google
 rake rails_contact:import_csv CSV_PATH=/absolute/path/to/eq.csv
 ```
 
-## Utility tasks
+---
 
-- `rake rails_contact:reindex`
-- `rake rails_contact:sync_google`
+## Testing and coverage
 
-## Test
+RSpec is the primary framework.
 
 ```bash
-bundle exec ruby -Itest -e 'Dir["test/**/*_test.rb"].sort.each { |f| require File.expand_path(f) }'
+bundle exec rspec
 ```
 
+Coverage is enforced with SimpleCov:
+
+- 100% line coverage target
+- 100% branch coverage target
+- CI fails below thresholds
+
+---
+
 ## Release
 
 ```bash
@@ -100,4 +167,13 @@ bundle exec rake build
 bundle exec rake release
 ```
 
-RubyGems MFA is required.
+RubyGems MFA is required for push.
+
+---
+
+## Extended docs
+
+- `docs/parity_matrix.md`
+- `docs/product_decisions.md`
+- `docs/roadmap.md`
+- `docs/migration_guide.md`

data/app/assets/javascripts/rails/contact/application.js

@@ -0,0 +1 @@
+//= require rails/contact/nested_fields

data/app/assets/javascripts/rails/contact/nested_fields.js

@@ -0,0 +1,49 @@
+(() => {
+  if (window.__railsContactNestedFieldsBound) return;
+  window.__railsContactNestedFieldsBound = true;
+
+  function addRow(event) {
+    const button = event.target.closest("[data-add-nested]");
+    if (!button) return;
+
+    const wrapper = button.closest("[data-nested-wrapper]");
+    const targetSelector = button.dataset.target;
+    const templateSelector = button.dataset.template;
+    if (!wrapper || !targetSelector || !templateSelector) return;
+
+    const container = wrapper.querySelector(targetSelector);
+    const template = wrapper.querySelector(templateSelector);
+    if (!container || !template) return;
+
+    const uniqueId = String(Date.now() + Math.floor(Math.random() * 1000));
+    const html = template.innerHTML.replace(/NEW_RECORD/g, uniqueId);
+    container.insertAdjacentHTML("beforeend", html);
+  }
+
+  function removeRow(event) {
+    const button = event.target.closest("[data-action='nested-fields#remove']");
+    if (!button) return;
+    const row = button.closest("[data-nested-fields-target='row']");
+    if (!row) return;
+
+    const destroyField = row.querySelector("[data-nested-fields-target='destroyField']");
+    if (destroyField) {
+      destroyField.value = "1";
+      row.style.display = "none";
+    } else {
+      row.remove();
+    }
+  }
+
+  document.addEventListener("click", (event) => {
+    if (event.target.closest("[data-add-nested]")) {
+      event.preventDefault();
+      addRow(event);
+      return;
+    }
+    if (event.target.closest("[data-action='nested-fields#remove']")) {
+      event.preventDefault();
+      removeRow(event);
+    }
+  });
+})();

data/app/assets/stylesheets/rails/contact/application.css

@@ -1,15 +1,187 @@
 /*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
  *= require_self
  */
+
+/* Basic reset-ish defaults scoped to engine layout usage */
+html,
+body {
+  margin: 0;
+  padding: 0;
+  background: #f8fafc;
+  color: #111827;
+  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
+}
+
+body {
+  line-height: 1.4;
+}
+
+a {
+  color: #2563eb;
+  text-decoration: none;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+/* Utility classes used in engine views */
+.space-y-6 > * + * {
+  margin-top: 1.5rem;
+}
+
+.space-y-4 > * + * {
+  margin-top: 1rem;
+}
+
+.space-y-3 > * + * {
+  margin-top: 0.75rem;
+}
+
+.mt-1 { margin-top: 0.25rem; }
+.mt-2 { margin-top: 0.5rem; }
+.mt-3 { margin-top: 0.75rem; }
+.mt-4 { margin-top: 1rem; }
+.mb-1 { margin-bottom: 0.25rem; }
+.mb-3 { margin-bottom: 0.75rem; }
+.ml-4 { margin-left: 1rem; }
+.pt-2 { padding-top: 0.5rem; }
+
+.flex { display: flex; }
+.inline-flex { display: inline-flex; }
+.items-center { align-items: center; }
+.items-end { align-items: flex-end; }
+.items-start { align-items: flex-start; }
+.justify-between { justify-content: space-between; }
+.justify-center { justify-content: center; }
+.gap-2 { gap: 0.5rem; }
+.gap-6 { gap: 1.5rem; }
+
+.grid { display: grid; }
+.grid-cols-1 { grid-template-columns: repeat(1, minmax(0, 1fr)); }
+.md\:grid-cols-2 { grid-template-columns: repeat(1, minmax(0, 1fr)); }
+.md\:grid-cols-3 { grid-template-columns: repeat(1, minmax(0, 1fr)); }
+.md\:grid-cols-4 { grid-template-columns: repeat(1, minmax(0, 1fr)); }
+.md\:grid-cols-5 { grid-template-columns: repeat(1, minmax(0, 1fr)); }
+
+.w-full { width: 100%; }
+.w-24 { width: 6rem; }
+.w-28 { width: 7rem; }
+.h-4 { height: 1rem; }
+.w-4 { width: 1rem; }
+.h-24 { height: 6rem; }
+.min-w-full { min-width: 100%; }
+
+.rounded-md { border-radius: 0.375rem; }
+.rounded-lg { border-radius: 0.5rem; }
+.rounded-xl { border-radius: 0.75rem; }
+.rounded-full { border-radius: 9999px; }
+
+.border { border: 1px solid #d1d5db; }
+.border-gray-200 { border-color: #e5e7eb; }
+.border-gray-300 { border-color: #d1d5db; }
+.border-red-200 { border-color: #fecaca; }
+
+.bg-white { background: #fff; }
+.bg-gray-50 { background: #f9fafb; }
+.bg-gray-100 { background: #f3f4f6; }
+.bg-gray-900 { background: #111827; }
+.bg-blue-600 { background: #2563eb; }
+.bg-red-50 { background: #fef2f2; }
+.bg-red-600 { background: #dc2626; }
+
+.text-white { color: #fff; }
+.text-gray-900 { color: #111827; }
+.text-gray-700 { color: #374151; }
+.text-gray-600 { color: #4b5563; }
+.text-gray-500 { color: #6b7280; }
+.text-red-700 { color: #b91c1c; }
+.text-blue-600 { color: #2563eb; }
+
+.text-xs { font-size: 0.75rem; }
+.text-sm { font-size: 0.875rem; }
+.text-2xl { font-size: 1.5rem; }
+.font-medium { font-weight: 500; }
+.font-semibold { font-weight: 600; }
+.font-bold { font-weight: 700; }
+.uppercase { text-transform: uppercase; }
+.tracking-wide { letter-spacing: 0.03em; }
+.text-left { text-align: left; }
+.text-right { text-align: right; }
+.text-center { text-align: center; }
+
+.p-4 { padding: 1rem; }
+.px-2 { padding-left: 0.5rem; padding-right: 0.5rem; }
+.px-3 { padding-left: 0.75rem; padding-right: 0.75rem; }
+.px-4 { padding-left: 1rem; padding-right: 1rem; }
+.py-1 { padding-top: 0.25rem; padding-bottom: 0.25rem; }
+.py-2 { padding-top: 0.5rem; padding-bottom: 0.5rem; }
+.py-3 { padding-top: 0.75rem; padding-bottom: 0.75rem; }
+.py-8 { padding-top: 2rem; padding-bottom: 2rem; }
+.pl-5 { padding-left: 1.25rem; }
+
+.shadow-sm { box-shadow: 0 1px 2px rgba(0, 0, 0, 0.06); }
+.overflow-hidden { overflow: hidden; }
+.object-cover { object-fit: cover; }
+.whitespace-pre-line { white-space: pre-line; }
+.list-disc { list-style: disc; }
+
+.divide-y > * + * {
+  border-top: 1px solid #e5e7eb;
+}
+
+.divide-gray-100 > * + * {
+  border-top-color: #f3f4f6;
+}
+
+.divide-gray-200 > * + * {
+  border-top-color: #e5e7eb;
+}
+
+.hover\:bg-gray-50:hover { background: #f9fafb; }
+.hover\:bg-blue-700:hover { background: #1d4ed8; }
+.hover\:bg-red-700:hover { background: #b91c1c; }
+.hover\:bg-gray-700:hover { background: #374151; }
+.hover\:text-blue-700:hover { color: #1d4ed8; }
+
+input,
+textarea,
+select,
+button {
+  font: inherit;
+}
+
+input[type="text"],
+input[type="email"],
+input[type="url"],
+input[type="number"],
+input[type="date"],
+textarea {
+  box-sizing: border-box;
+}
+
+button,
+input[type="submit"] {
+  cursor: pointer;
+}
+
+table {
+  border-collapse: collapse;
+}
+
+/* Layout breathing room */
+body > * {
+  max-width: 1100px;
+  margin: 1.5rem auto;
+  padding: 0 1rem;
+}
+
+@media (min-width: 768px) {
+  .md\:grid-cols-2 { grid-template-columns: repeat(2, minmax(0, 1fr)); }
+  .md\:grid-cols-3 { grid-template-columns: repeat(3, minmax(0, 1fr)); }
+  .md\:grid-cols-4 { grid-template-columns: repeat(4, minmax(0, 1fr)); }
+  .md\:grid-cols-5 { grid-template-columns: repeat(5, minmax(0, 1fr)); }
+  .md\:items-end { align-items: end; }
+  .md\:col-span-2 { grid-column: span 2 / span 2; }
+  .md\:col-span-3 { grid-column: span 3 / span 3; }
+}

data/app/controllers/concerns/rails/contact/filterable.rb

@@ -0,0 +1,11 @@
+module Rails
+  module Contact
+    module Filterable
+      private
+
+      def normalized_filters(params)
+        params.to_h.compact_blank
+      end
+    end
+  end
+end

data/app/controllers/rails/contact/application_controller.rb

@@ -3,8 +3,14 @@ module Rails
     class ApplicationController < ActionController::Base
       protect_from_forgery with: :exception
 
+      layout :rails_contact_layout
+
       private
 
+      def rails_contact_layout
+        Rails::Contact.configuration.inherit_host_layout ? "application" : "rails/contact/application"
+      end
+
       def t_flash(key, default:)
         I18n.t("rails_contact.flash.#{key}", default: default)
       end

data/app/controllers/rails/contact/contacts_controller.rb

@@ -1,38 +1,51 @@
 module Rails
   module Contact
     class ContactsController < ApplicationController
+      include Rails::Contact::Filterable
+      METADATA_KEYS = %w[
+        prefix middle_name suffix nickname company job_title department website birthday notes
+      ].freeze
+
       before_action :set_contact, only: [ :show, :edit, :update, :destroy ]
 
       def index
         @query = params[:q].to_s.strip
-        @contacts = Search::Query.new(@query, filters: filter_params).call
+        @contacts = Search::Query.new(@query, filters: normalized_filters(filter_params)).call
+        render "rails/contact/index"
       end
 
-      def show; end
+      def show
+        render "rails/contact/show"
+      end
 
       def new
         @contact = Contact.new
         build_default_associations
+        render "rails/contact/new"
       end
 
-      def edit; end
+      def edit
+        render "rails/contact/edit"
+      end
 
       def create
         @contact = Contact.new(contact_params)
+        assign_labels(@contact)
         if @contact.save
           enqueue_index(@contact.id)
           redirect_to contact_path(@contact), notice: "Contact created."
         else
-          render :new, status: :unprocessable_entity
+          render "rails/contact/new", status: :unprocessable_entity
         end
       end
 
       def update
+        assign_labels(@contact)
         if @contact.update(contact_params)
           enqueue_index(@contact.id)
           redirect_to contact_path(@contact), notice: "Contact updated."
         else
-          render :edit, status: :unprocessable_entity
+          render "rails/contact/edit", status: :unprocessable_entity
         end
       end
 
@@ -43,6 +56,21 @@ module Rails
         redirect_to contacts_path, notice: "Contact deleted."
       end
 
+      def bulk_destroy
+        ids = params[:ids].to_s.split(",").map(&:to_i).reject(&:zero?).uniq
+        Contact.where(id: ids).find_each(&:destroy!)
+        redirect_to contacts_path, notice: "#{ids.size} contact(s) deleted."
+      end
+
+      def merge
+        source_id = params[:source_id]
+        target_id = params[:target_id]
+        MergeContactsService.new(source_id: source_id, target_id: target_id).call
+        redirect_to contact_path(target_id), notice: "Contacts merged."
+      rescue StandardError => e
+        redirect_to contacts_path, alert: "Merge failed: #{e.message}"
+      end
+
       private
 
       def set_contact
@@ -51,16 +79,24 @@ module Rails
       end
 
       def contact_params
-        params.require(:contact).permit(
-          :given_name, :family_name, :current_city, :departure_city, :region_name, :biography, :sync_eligible,
+        permitted = params.require(:contact).permit(
+          :given_name, :family_name, :current_city, :departure_city, :region_name, :biography, :sync_eligible, :starred, :photo_url,
+          :labels_csv,
+          metadata: {},
           emails_attributes: [ :id, :value, :label, :primary, :_destroy ],
           phones_attributes: [ :id, :value, :label, :primary, :_destroy ],
-          addresses_attributes: [ :id, :city, :departure_city, :formatted_value, :label, :_destroy ]
+          addresses_attributes: [ :id, :city, :departure_city, :formatted_value, :label, :_destroy ],
+          websites_attributes: [ :id, :url, :label, :_destroy ],
+          events_attributes: [ :id, :event_type, :event_date, :label, :_destroy ]
         )
+
+        metadata = permitted[:metadata].is_a?(ActionController::Parameters) ? permitted[:metadata].to_h : {}
+        permitted[:metadata] = metadata.slice(*METADATA_KEYS)
+        permitted
       end
 
       def filter_params
-        params.permit(:city, :region, :sync_eligible)
+        params.permit(:city, :region, :sync_eligible, :starred)
       end
 
       def enqueue_index(contact_id)
@@ -68,9 +104,17 @@ module Rails
       end
 
       def build_default_associations
-        @contact.emails.build if @contact.emails.empty?
-        @contact.phones.build if @contact.phones.empty?
+        @contact.emails.build(label: "work") while @contact.emails.size < 2
+        @contact.phones.build(label: "mobile") while @contact.phones.size < 2
         @contact.addresses.build if @contact.addresses.empty?
+        @contact.websites.build(label: "profile") if @contact.websites.empty?
+        @contact.events.build(event_type: "birthday") if @contact.events.empty?
+      end
+
+      def assign_labels(contact)
+        return unless params.dig(:contact, :labels_csv).present?
+
+        contact.set_labels_from_csv!(params.dig(:contact, :labels_csv))
       end
     end
   end