k_contactable 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ffd79c301fdd888b204191f066c84a716d8a36d523a18007fd98aaf5476460e
+  data.tar.gz: d977d0aef013ff105d2886ec36719feb539ede56dc220ae610f48fb230381bb3
+SHA512:
+  metadata.gz: 34592d53da8778bf68bc8bafeb100e9b100100fd7353c3ad76d3ba71a059c8623eeab76f222d9f1795d00fbb363361d8d4c21f8a293e1df2c856bb5e78546e8f
+  data.tar.gz: acbf5366f93ac863e3e38fd262d5d6fbf57f0a17c89da440a62631723d1d26f6e2664b22ea49702457b17b1e8288df47f11d4bb4a89e977d2792fa2d3a79e1c3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Otoniel Reyes
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,25 @@
+# Taxable
+Add contact support to your rails application.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'k-contactable', '~> 0.1.0'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Generate the installation:
+```bash
+$ bin/rails g contactable:install
+```
+
+## Contributing
+To contribute, just fork this repository, add/edit the code, and make a pull request. All contribution are welcome.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/stylesheets/contacts.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/contacts_controller.rb

@@ -0,0 +1,58 @@
+class ContactsController < ApplicationController
+  before_action :set_contact, only: [:show, :edit, :update, :destroy]
+
+  # GET /contacts
+  def index
+    @contacts = Contact.all
+  end
+
+  # GET /contacts/1
+  def show
+  end
+
+  # GET /contacts/new
+  def new
+    @contact = Contact.new
+  end
+
+  # GET /contacts/1/edit
+  def edit
+  end
+
+  # POST /contacts
+  def create
+    @contact = Contact.new(contact_params)
+
+    if @contact.save
+      redirect_to @contact, notice: 'Contact was successfully created.'
+    else
+      render :new
+    end
+  end
+
+  # PATCH/PUT /contacts/1
+  def update
+    if @contact.update(contact_params)
+      redirect_to @contact, notice: 'Contact was successfully updated.'
+    else
+      render :edit
+    end
+  end
+
+  # DELETE /contacts/1
+  def destroy
+    @contact.destroy
+    redirect_to contacts_url, notice: 'Contact was successfully destroyed.'
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_contact
+      @contact = Contact.find(params[:id])
+    end
+
+    # Only allow a list of trusted parameters through.
+    def contact_params
+      params.require(:contact).permit(:salutation, :firstname, :lastname, :work_phone, :mobile, :email)
+    end
+end

data/app/helpers/contacts_helper.rb

@@ -0,0 +1,10 @@
+module ContactsHelper
+  def salutations
+    return [
+      [I18n.translate('mr'), 'mr'],
+      [I18n.translate('mrs'), 'mrs'],
+      [I18n.translate('miss'), 'miss'],
+      [I18n.translate('dr'), 'dr']
+    ]
+  end
+end

data/app/models/contact.rb

@@ -0,0 +1,3 @@
+class Contact < ApplicationRecord
+  belongs_to :contactable, polymorphic: true
+end

data/app/views/contacts/_contact.html.erb

@@ -0,0 +1,23 @@
+<tr>
+  <td><%= contact.salutation %></td>
+  <td><%= contact.firstname %></td>
+  <td><%= contact.lastname %></td>
+  <td><%= link_to contact.work_phone, 'tel:' + contact.work_phone %></td>
+  <td><%= link_to contact.mobile, 'tel:' + contact.mobile %></td>
+  <td><%= link_to contact.email, 'mailto:' + contact.email %></td>
+  <td>
+    <div class="d-grid gap2">
+      <%= link_to t('show'), contact, class: 'btn btn-sm btn-outline-secondary' %>
+    </div>
+  </td>
+  <td>
+    <div class="d-grid gap2">
+      <%= link_to t('edit'), edit_contact_path(contact), class: 'btn btn-sm btn-outline-info' %>
+    </div>
+  </td>
+  <td>
+    <div class="d-grid gap2">
+      <%= link_to t('destroy'), contact, method: :delete, data: { confirm: 'Are you sure?' }, class: 'btn btn-sm btn-outline-danger' %>
+    </div>
+  </td>
+</tr>

data/app/views/contacts/_form.html.erb

@@ -0,0 +1,70 @@
+<%= form_with(model: contact) do |form| %>
+  <% if contact.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(contact.errors.count, "error") %> prohibited this contact from being saved:</h2>
+
+      <ul>
+        <% contact.errors.each do |error| %>
+          <li><%= error.full_message %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="row row-cols-1 row-cols-md-3">
+    <div class="col">
+      <div class="input-group mb-3">
+        <span class="input-group-text">
+          <%= form.label :salutation, t('.salutation') %>
+        </span>
+        <%= form.select :salutation, salutations, {}, {class: 'form-control'} %>
+      </div>
+    </div>
+    <div class="col">
+      <div class="input-group mb-3">
+        <span class="input-group-text">
+          <%= form.label :firstname, t('.firstname') %>
+        </span>
+        <%= form.text_field :firstname, class: 'form-control' %>
+      </div>
+    </div>
+    <div class="col">
+      <div class="input-group mb-3">
+        <span class="input-group-text">
+          <%= form.label :lastname, t('.lastname') %>
+        </span>
+        <%= form.text_field :lastname, class: 'form-control' %>
+      </div>
+    </div>
+  </div>
+
+  <div class="row row-cols-1 row-cols-md-2">
+    <div class="col">
+      <div class="input-group mb-3">
+        <span class="input-group-text">
+          <%= form.label :work_phone, t('.work_phone') %>
+        </span>
+        <%= form.telephone_field :work_phone, class: 'form-control' %>
+      </div>
+    </div>
+    <div class="col">
+      <div class="input-group mb-3">
+        <span class="input-group-text">
+          <%= form.label :mobile, t('.mobile') %>
+        </span>
+        <%= form.telephone_field :mobile, class: 'form-control' %>
+      </div>
+    </div>
+  </div>
+
+  <div class="input-group mb-3">
+    <span class="input-group-text">
+      <%= form.label :email, t('.email') %>
+    </span>
+    <%= form.email_field :email, class: 'form-control' %>
+  </div>
+
+  <div class="mb-3">
+    <%= form.submit t('save'), data: { disable_with: t('saving') }, class: 'btn btn-primary' %>
+  </div>
+<% end %>

data/app/views/contacts/edit.html.erb

@@ -0,0 +1,6 @@
+<h1><%= t('.editing_contact') %></h1>
+
+<%= render 'form', contact: @contact %>
+
+<%= link_to t('show'), @contact, class: 'btn btn-outline-info' %>
+<%= link_to t('back'), contacts_path, class: 'btn btn-outline-secondary' %>

data/app/views/contacts/index.html.erb

@@ -0,0 +1,20 @@
+<h1><%= t('.contacts') %></h1>
+
+<table class="table table-hover table-striped my-3">
+  <thead>
+    <tr>
+      <th><%= t('.salutation') %></th>
+      <th><%= t('.firstname') %></th>
+      <th><%= t('.lastname') %></th>
+      <th><%= t('.work_phone') %></th>
+      <th><%= t('.mobile') %></th>
+      <th><%= t('.email') %></th>
+      <th colspan="3"></th>
+    </tr>
+  </thead>
+  <tbody>
+    <%= render @contacts %>
+  </tbody>
+</table>
+
+<%= link_to t('new_contact'), new_contact_path, class: 'btn btn-primary' %>

data/app/views/contacts/new.html.erb

@@ -0,0 +1,5 @@
+<h1><%= t('.new_contact') %></h1>
+
+<%= render 'form', contact: @contact %>
+
+<%= link_to t('back'), contacts_path, class: 'btn btn-outline-secondary' %>

data/app/views/contacts/show.html.erb

@@ -0,0 +1,34 @@
+<h1><%= t('contact_details') %></h1>
+
+<div class="my-3">
+  <strong><%= t('.salutation') %>:</strong>
+  <p><%= @contact.salutation %></p>
+</div>
+
+<div class="my-3">
+  <strong><%= t('.firstname') %>:</strong>
+  <p><%= @contact.firstname %></p>
+</div>
+
+<div class="my-3">
+  <strong><%= t('.lastname') %>:</strong>
+  <p><%= @contact.lastname %></p>
+</div>
+
+<div class="my-3">
+  <strong><%= t('.work_phone') %>:</strong>
+  <p><%= link_to @contact.work_phone, 'tel:' + @contact.work_phone %></p>
+</div>
+
+<div class="my-3">
+  <strong><%= t('.mobile') %>:</strong>
+  <p><%= link_to @contact.mobile, 'tel:' + @contact.mobile %></p>
+</div>
+
+<div class="my-3">
+  <strong><%= t('.email') %>:</strong>
+  <p><%= link_to @contact.email, 'mailto:' + @contact.email %></p>
+</div>
+
+<%= link_to t('edit'), edit_contact_path(@contact), class: 'btn btn-outline-info' %>
+<%= link_to t('back'), contacts_path, class: 'btn btn-outline-secondary' %>

data/config/locales/en.yml

@@ -0,0 +1,38 @@
+en:
+  back: 'Back'
+  show: 'Show'
+  save: 'Save'
+  mr: 'Mr.'
+  mrs: 'Mrs.'
+  miss: 'Miss'
+  dr: 'Dr'
+  saving: 'Saving...'
+  destroy: 'Delete'
+  contacts:
+    form:
+      salutation: 'Salutation'
+      firstname: 'First Name'
+      lastname: 'Last Name'
+      work_phone: 'Work Phone'
+      mobile: 'Mobile'
+      email: 'Email'
+    index:
+      contacts: 'Contacts'
+      salutation: 'Salutation'
+      firstname: 'First Name'
+      lastname: 'Last Name'
+      work_phone: 'Work Phone'
+      mobile: 'Mobile'
+      email: 'Email'
+    edit:
+      editing_contact: 'Editing Contact'
+    new:
+      new_contact: 'New Contact'
+    show:
+      contact_details: 'Contact Details'
+      salutation: 'Salutation'
+      firstname: 'First Name'
+      lastname: 'Last Name'
+      work_phone: 'Work Phone'
+      mobile: 'Mobile'
+      email: 'Email'

data/config/locales/es.yml

@@ -0,0 +1,38 @@
+es:
+  back: 'Atrás'
+  show: 'Mostrar'
+  save: 'Guardar'
+  mr: 'Sr.'
+  mrs: 'Sra.'
+  miss: 'Srta.'
+  dr: 'Dr'
+  saving: 'Guardando...'
+  destroy: 'Eliminar'
+  contacts:
+    form:
+      salutation: 'Saludo'
+      firstname: 'Nombre(s)'
+      lastname: 'Apellido(s)'
+      work_phone: 'Teléfono del Trabajo'
+      mobile: 'Celular'
+      email: 'Email'
+    index:
+      contacts: 'Contactos'
+      salutation: 'Saludo'
+      firstname: 'Nombre(s)'
+      lastname: 'Apellido(s)'
+      work_phone: 'Teléfono del Trabajo'
+      mobile: 'Celular'
+      email: 'Email'
+    edit:
+      editing_contact: 'Editando Contacto'
+    new:
+      new_contact: 'Registrar Contacto'
+    show:
+      contact_details: 'Detalles del Contacto'
+      salutation: 'Saludo'
+      firstname: 'Nombre(s)'
+      lastname: 'Apellido(s)'
+      work_phone: 'Teléfono del Trabajo'
+      mobile: 'Celular'
+      email: 'Email'

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  resources :contacts
+end

data/db/migrate/20210822232510_create_contacts.rb

@@ -0,0 +1,15 @@
+class CreateContacts < ActiveRecord::Migration[6.1]
+  def change
+    create_table :contacts do |t|
+      t.string :salutation
+      t.string :firstname
+      t.string :lastname
+      t.string :work_phone
+      t.string :mobile
+      t.string :email
+      t.references :contactable, polymorphic: true
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/k_contactable/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/base'
+
+module KContactable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_migrations
+        rake "k_contactable_engine:install:migrations"
+        rake "db:migrate"
+      end
+
+      def copy_locales
+        copy_file "../../../../config/locales/en.yml", "config/locales/contactable.en.yml"
+        copy_file "../../../../config/locales/es.yml", "config/locales/contactable.es.yml"
+      end
+
+      def add_route
+        # Sisnce this engine isn't mountable, don't need to be mounted, so remove this line
+        # route "mount Contactable::Engine => '/contacts'"
+      end
+    end
+  end
+end

data/lib/k_contactable.rb

@@ -0,0 +1,6 @@
+require "k_contactable/version"
+require "k_contactable/engine"
+
+module KContactable
+  # Your code goes here...
+end

data/lib/k_contactable/engine.rb

@@ -0,0 +1,4 @@
+module KContactable
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/k_contactable/version.rb

@@ -0,0 +1,3 @@
+module KContactable
+  VERSION = '0.1.2'
+end

data/lib/tasks/k-contactable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :contactable do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: k_contactable
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- kenliten
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+description: Simple contact management engine for rails applications
+email:
+- kenliten@otonielreyes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/contactable_manifest.js
+- app/assets/stylesheets/contacts.css
+- app/controllers/contacts_controller.rb
+- app/helpers/contacts_helper.rb
+- app/models/contact.rb
+- app/views/contacts/_contact.html.erb
+- app/views/contacts/_form.html.erb
+- app/views/contacts/edit.html.erb
+- app/views/contacts/index.html.erb
+- app/views/contacts/new.html.erb
+- app/views/contacts/show.html.erb
+- config/locales/en.yml
+- config/locales/es.yml
+- config/routes.rb
+- db/migrate/20210822232510_create_contacts.rb
+- lib/generators/k_contactable/install_generator.rb
+- lib/k_contactable.rb
+- lib/k_contactable/engine.rb
+- lib/k_contactable/version.rb
+- lib/tasks/k-contactable_tasks.rake
+homepage: https://contactable.kenliten.website
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://contactable.kenliten.website
+  source_code_uri: https://github.com/kenliten/contactable
+  changelog_uri: https://github.com/kenliten/contactable/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: Add contact management capabilities to your rails application
+test_files: []