rails-contact 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da9e560dd16bfddaae191d2951cdb891d1c81a5c03e854fa608ce698bad0f4ed
-  data.tar.gz: be80125cfbca594d514a43701f0468a083868d74cb77a5a7e9fdb9bfa1b92cb3
+  metadata.gz: 3f8cf546cda0f081e8da876f17377f8d71f384c41c868cfda1d19af009c6fd63
+  data.tar.gz: 307ce9285a133f372d09aa503235620ab669a6ef94a60cbdd132486dc3086cc5
 SHA512:
-  metadata.gz: b2e6b507b3e9b1eb0bb4a06a9784ce5965937d3625a74b81749ea60785918f3afeb752f2ae8ca530ff47c4211907e49d9d91e0ea1cf281c8daefdabee92c0a55
-  data.tar.gz: 7ef76b8f5e22865f80b36a05665c3dd25105ccba061fb5810b6d79c3a530bb2d68d6d9fe1d4464383f76d33989666e1622db2754063e868c6ec9fa715b4f9152
+  metadata.gz: 721d2f5d8a7b111d6139069bd9af461278e385dca6080fbed28521fc582ba9ad8a4ecee3f1d4b6f5f9bae241ce94f22a18f61757b16aa290ec9c1bd6e495dec1
+  data.tar.gz: 15b1587cd03cdc1b5d090b7f972c2c2d84e9313d7f7ae07e070d86bf14bbcd630ed4fb1e390d2a92cc164a5564663edbc59e4a296616195478053b53bb14047d

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.1.1
+
+- Fix mounted route shape to avoid `/contacts/contacts` duplication.
+- Improve README quick-start and generator documentation.
+- Add controller override generator (`rails generate rails:contact:controllers`).
+- CI/test command hardening and Ruby 3.2 dependency compatibility fixes.
+
 ## 0.1.0
 
 - Initial release of `rails-contact`.

data/README.md

@@ -1,13 +1,17 @@
 # rails-contact
 
-`rails-contact` is a mountable Rails engine for Google-shaped contact management with:
+`rails-contact` is a mountable Rails engine to manage contacts in your app, with optional Elasticsearch search and Google Contacts sync.
 
-- local source-of-truth data model
-- Elasticsearch-powered search/filter (with DB fallback)
-- CSV import pipeline
-- capped rolling-window Google Contacts sync hooks
+## What you get
 
-## Install
+- 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
+
+## 1) Install the gem
 
 ```ruby
 gem "rails-contact"
@@ -15,46 +19,78 @@ gem "rails-contact"
 
 ```bash
 bundle install
+```
+
+## 2) Run generators
+
+```bash
 rails generate rails:contact:install
 rails generate rails:contact:contact Contact
+```
+
+Optional override generators (Devise-style customization):
+
+```bash
+rails generate rails:contact:views
+rails generate rails:contact:controllers
+```
+
+Then migrate:
+
+```bash
 rails db:migrate
 ```
 
-## Configure
+## 3) Mount routes (clean paths)
+
+Use either:
+
+```ruby
+mount Rails::Contact::Engine => "/contacts", as: "rails_contact"
+```
+
+or:
+
+```ruby
+rails_contact_for :contacts
+```
+
+With this setup, paths are:
+- `/contacts` (index)
+- `/contacts/new`
+- `/contacts/:id`
 
-Initializer: `config/initializers/rails_contact.rb`
+No `/contacts/contacts` duplication.
+
+## 4) Configure
+
+Generated initializer: `config/initializers/rails_contact.rb`
 
 ```ruby
 Rails::Contact.configure do |config|
   config.search_backend = :elasticsearch
   config.elasticsearch_url = ENV.fetch("ELASTICSEARCH_URL", "http://127.0.0.1:9200")
-  config.google_sync_enabled = true
+  config.google_sync_enabled = false
   config.google_max_contacts = 25_000
   config.rolling_window_sort = :updated_at
 end
 ```
 
-## Mount
+## CSV import
 
-```ruby
-mount Rails::Contact::Engine => "/contacts", as: "rails_contact"
+```bash
+rake rails_contact:import_csv CSV_PATH=/absolute/path/to/eq.csv
 ```
 
-## Features
+## Utility tasks
 
-- Contact CRUD with nested emails/phones/addresses
-- Filter and full-text search by name, email, and phone
-- CSV import mapping for fields like Enquirer First Name / Enquirer Email / country-code phones
-- Google payload mapping and sync service scaffolding
-- Reindex and sync tasks:
-  - `rake rails_contact:reindex`
-  - `rake rails_contact:sync_google`
-  - `rake rails_contact:import_csv CSV_PATH=/path/to/file.csv`
+- `rake rails_contact:reindex`
+- `rake rails_contact:sync_google`
 
 ## Test
 
 ```bash
-bundle exec ruby -Itest test/**/*_test.rb
+bundle exec ruby -Itest -e 'Dir["test/**/*_test.rb"].sort.each { |f| require File.expand_path(f) }'
 ```
 
 ## Release
@@ -64,8 +100,4 @@ bundle exec rake build
 bundle exec rake release
 ```
 
-Ensure RubyGems MFA is enabled for maintainers.
-
-## License
-
-MIT.
+RubyGems MFA is required.

data/config/routes.rb

@@ -1,4 +1,11 @@
 Rails::Contact::Engine.routes.draw do
-  resources :contacts
+  get "/", to: "contacts#index", as: :contacts
+  get "/new", to: "contacts#new", as: :new_contact
+  post "/", to: "contacts#create"
+  get "/:id", to: "contacts#show", as: :contact
+  get "/:id/edit", to: "contacts#edit", as: :edit_contact
+  patch "/:id", to: "contacts#update"
+  put "/:id", to: "contacts#update"
+  delete "/:id", to: "contacts#destroy"
   root to: "contacts#index"
 end

data/lib/generators/rails/contact/controllers_generator.rb

@@ -0,0 +1,15 @@
+require "rails/generators/base"
+
+module Rails
+  module Contact
+    module Generators
+      class ControllersGenerator < ::Rails::Generators::Base
+        source_root File.expand_path("templates", __dir__)
+
+        def copy_controllers
+          template "contacts_controller.rb.tt", "app/controllers/rails/contact/contacts_controller.rb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/rails/contact/templates/contacts_controller.rb.tt

@@ -0,0 +1,9 @@
+module Rails
+  module Contact
+    class ContactsController < Rails::Contact::ContactsController
+      layout "application"
+
+      # Override actions here when needed.
+    end
+  end
+end

data/lib/rails/contact/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module Contact
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-contact
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kshitiz Sinha
@@ -133,8 +133,10 @@ files:
 - bin/rubocop
 - config/routes.rb
 - lib/generators/rails/contact/contact_generator.rb
+- lib/generators/rails/contact/controllers_generator.rb
 - lib/generators/rails/contact/install/install_generator.rb
 - lib/generators/rails/contact/install/templates/rails_contact.rb.tt
+- lib/generators/rails/contact/templates/contacts_controller.rb.tt
 - lib/generators/rails/contact/templates/create_rails_contact_contact_addresses.rb.tt
 - lib/generators/rails/contact/templates/create_rails_contact_contact_emails.rb.tt
 - lib/generators/rails/contact/templates/create_rails_contact_contact_phones.rb.tt