has_vcards 0.20.3 → 1.0.0.rc0

data/MIT-LICENSE

@@ -1,4 +1,7 @@
-Copyright (c) 2008 [name of plugin creator]
+Copyright 2007-2014 Simon Hürlimann <simon.huerlimann@cyt.ch>
+Copyright 2009-2014 CyT GmbH <http://www.cyt.ch>
+Copyright 2008 Agrabah GmbH <http://www.agrabah.ch>
+Copyright 2007-2010 ZytoLabor <http://www.zyto-labor.com>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,18 @@
+has_vcards
+==========
+
+[![Build Status](https://secure.travis-ci.org/huerlisi/has_vcards.png)](http://travis-ci.org/huerlisi/has_vcards)
+
+Rails plugin providing VCard like contact and address models and helpers.
+
+Install
+=======
+
+In Rails simply add
+
+    gem 'has_vcards'
+
+License
+=======
+
+Released under the MIT license.

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasVcards'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('{app,config,db,lib}/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+
+task default: :spec

data/app/assets/javascripts/has_vcards/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/has_vcards/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/has_vcards/directory_lookup_controller.rb

@@ -0,0 +1,21 @@
+module HasVcards
+  class DirectoryLookupController < ApplicationController
+    def search
+      @selector = params[:selector]
+      vcard_params = extract_vcard_params(params, @selector)
+
+      @vcard = Vcard.new(vcard_params)
+      render 'vcards/directory_lookup'
+    end
+
+    private
+
+    def extract_vcard_params(params, selector)
+      keys = selector.delete(']').split('[')
+      vcard_params = params
+      keys.each { |key| vcard_params = vcard_params[key] }
+
+      vcard_params
+    end
+  end
+end

data/app/controllers/has_vcards/phone_numbers_controller.rb

@@ -0,0 +1,16 @@
+module HasVcards
+  class PhoneNumbersController < ApplicationController
+    # Use inherited resources logic
+    inherit_resources
+    respond_to :html, :js
+
+    # Relations
+    optional_belongs_to :vcard
+
+    # Optionally support in place editing
+    if respond_to? :in_place_edit_for
+      in_place_edit_for :phone_number, :phone_number_type
+      in_place_edit_for :phone_number, :number
+    end
+  end
+end

data/app/controllers/has_vcards/vcards_controller.rb

@@ -0,0 +1,22 @@
+module HasVcards
+  class VcardsController < ApplicationController
+    # Use inherited resources logic
+    inherit_resources
+    respond_to :html, :js
+
+    def directory_lookup
+      @vcard = Vcard.find(params[:id])
+    end
+
+    def directory_update
+      @vcard = Vcard.find(params[:id])
+      new_params = params[:vcard].select { |key, _| ['family_name', 'given_name', 'street_address', 'postal_code', 'locality'].include?(key) }
+
+      @vcard.update_attributes(new_params)
+
+      @vcard.save
+
+      redirect_to @vcard.reference
+    end
+  end
+end

data/app/helpers/has_vcards/application_helper.rb

@@ -0,0 +1,18 @@
+module HasVcards
+  # View helpers
+  #
+  # These helpers are available by default.
+  module ApplicationHelper
+    def address(vcard, line_separator = '<br/>')
+      vcard.address_lines.map { |line| h(line) }.join(line_separator).html_safe
+    end
+
+    def full_address(vcard, line_separator = '<br/>')
+      vcard.full_address_lines.map { |line| h(line) }.join(line_separator).html_safe
+    end
+
+    def contact(vcard, line_separator = '<br/>', label_separator = ' ')
+      vcard.contact_lines(label_separator).map { |line| h(line) }.join(line_separator).html_safe
+    end
+  end
+end

data/app/input/has_vcards/zip_locality_input.rb

@@ -0,0 +1,16 @@
+module HasVcards
+  class ZipLocalityInput < SimpleForm::Inputs::StringInput
+    def zip_codes
+      SwissMatch.zip_codes.map { |zip| zip.to_s }.inspect
+    end
+
+    def input
+      input_html_options[:type] = 'text'
+      input_html_options[:autocomplete] = 'off'
+      input_html_options['data-provide'] = 'typeahead'
+      input_html_options['data-source'] = zip_codes
+
+      super
+    end
+  end
+end

data/app/models/has_vcards/address.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module HasVcards
+  class Address < ActiveRecord::Base
+    # Access restrictions
+    attr_accessible :extended_address, :street_address, :post_office_box, :postal_code, :locality, :zip_locality if defined?(ActiveModel::MassAssignmentSecurity)
+
+    belongs_to :vcard
+
+    # Validations
+    include I18nHelpers
+
+    def validate_address
+      errors.add_on_blank(:postal_code)
+      errors.add_on_blank(:locality)
+
+      return unless street_address.blank? && extended_address.blank? && post_office_box.blank?
+
+      errors.add(:street_address, "#{t_attr(:street_address, Vcard)} #{I18n.translate('errors.messages.empty')}")
+      errors.add(:extended_address, "#{t_attr(:extended_address, Vcard)} #{I18n.translate('errors.messages.empty')}")
+      errors.add(:post_office_box, "#{t_attr(:post_office_box, Vcard)} #{I18n.translate('errors.messages.empty')}")
+    end
+
+    # Helpers
+    def to_s
+      I18n.translate('has_vcards.address.to_s',
+                     street_address: street_address,
+                     postal_code: postal_code,
+                     locality: locality
+      )
+    end
+
+    # Composed attributes
+    def zip_locality
+      "#{postal_code} #{locality}"
+    end
+
+    def zip_locality=(value)
+      self.postal_code, self.locality = value.split(' ', 2)
+    end
+  end
+end

data/app/models/has_vcards/concerns/has_vcards.rb

@@ -0,0 +1,42 @@
+module HasVcards
+  module Concerns
+    # ActiveRecord extensions
+    #
+    # Including this module in your ActiveRecord classes sets up associations and helpers to integrate Vcards with that model.
+    #
+    # Use something like this to use it:
+    #
+    # class Something < ActiveRecord::Base
+    #   include HasVcards::Concerns::HasVcards
+    # end
+    module HasVcards
+      extend ActiveSupport::Concern
+
+      included do
+        scope :by_name, ->(name) { { include: :vcard, order: 'vcards.full_name', conditions: Vcard.by_name_conditions(name) } }
+
+        # Vcards
+        has_many :vcards, class_name: 'HasVcards::Vcard', as: 'reference', autosave: true, validate: true
+        accepts_nested_attributes_for :vcards
+
+        # Single/Main vcard
+        has_one :vcard, class_name: 'HasVcards::Vcard', as: 'reference', autosave: true, validate: true
+        accepts_nested_attributes_for :vcard
+
+        delegate :full_name, :nickname, :family_name, :given_name, :additional_name, :honorific_prefix, :honorific_suffix, to: :vcard
+        delegate :full_name=, :nickname=, :family_name=, :given_name=, :additional_name=, :honorific_prefix=, :honorific_suffix=, to: :vcard
+
+        def vcard_with_autobuild
+          vcard_without_autobuild || build_vcard
+        end
+        alias_method_chain :vcard, :autobuild
+
+        # Access restrictions
+        if defined?(ActiveModel::MassAssignmentSecurity)
+          attr_accessible :full_name, :nickname, :family_name, :given_name, :honorific_prefix, :honorific_suffix,
+                          :vcard_attributes, :vcards_attributes
+        end
+      end
+    end
+  end
+end

data/app/models/has_vcards/phone_number.rb

@@ -0,0 +1,61 @@
+# Phone Number / Contact model
+#
+# This model holds a contact for a Vcard. It is called PhoneNumber in
+# compliance with the vCard spec, but can hold any kind of contact like mobile
+# phone, email, or homepage.
+#
+# There can be multiple phone numbers be assigned to a vcard, where they are
+# available as the #contacts association.
+#
+# The #label method uses the I18n locales to translate the phone_number_type.
+# You may add additional ones in under the
+# 'activerecord.attributes.has_vcards/phone_number.phone_number_type_enum'
+# scope.
+module HasVcards
+  class PhoneNumber < ActiveRecord::Base
+    # Access restrictions
+    attr_accessible :phone_number_type, :number if defined?(ActiveModel::MassAssignmentSecurity)
+
+    # Vcard association
+    belongs_to :vcard, inverse_of: :contacts
+
+    # Validation
+    validates_presence_of :number
+
+    # phone number types
+    scope :by_type, ->(value) { where(phone_number_type: value) }
+    scope :phone, by_type('phone')
+    scope :fax, by_type('fax')
+    scope :mobile, by_type('mobile')
+    scope :email, by_type('email')
+
+    def label
+      I18n.translate(phone_number_type, scope: 'activerecord.attributes.has_vcards/phone_number.phone_number_type_enum', default: phone_number_type.titleize)
+    end
+
+    # String
+    def to_s(format = :default, separator = ': ')
+      case format
+      when :label
+        return [label, number].compact.join(separator)
+      else
+        return number
+      end
+    end
+
+    # Generate a contact URL
+    def to_url
+      scheme =
+        case phone_number_type
+        when 'phone'  then 'tel'
+        when 'mobile' then 'tel'
+        when 'fax'    then 'fax'
+        when 'email'  then 'mailto'
+        end
+
+      return unless scheme
+
+      "#{scheme}:#{number}"
+    end
+  end
+end

data/app/models/has_vcards/vcard.rb

@@ -0,0 +1,123 @@
+# encoding: utf-8
+
+# Vcard class
+#
+# This is the main model containing vcards information. It can be assigned to
+# any kind of model by assigning the 'reference'.
+#
+# To include in a model, you may use the 'has_vcards' helper:
+#
+# class Something < ActiveRecord::Base
+#   has_vcards
+# end
+module HasVcards
+  class Vcard < ActiveRecord::Base
+    # Reference
+    belongs_to :reference, polymorphic: true
+
+    # Addresses
+    has_one :address, autosave: true, validate: true
+    has_many :addresses, autosave: true, validate: true
+
+    accepts_nested_attributes_for :addresses
+    accepts_nested_attributes_for :address
+
+    delegate :post_office_box, :extended_address, :street_address, :locality, :region, :postal_code, :country_name, :zip_locality, to: :address
+    delegate :post_office_box=, :extended_address=, :street_address=, :locality=, :region=, :postal_code=, :country_name=, :zip_locality=, to: :address
+
+    def address_with_autobuild
+      address_without_autobuild || build_address
+    end
+    alias_method_chain :address, :autobuild
+
+    # Contacts
+    has_many :contacts, class_name: 'PhoneNumber', inverse_of: :vcard do
+      def build_defaults
+        # TODO: i18nify
+        ['Tel. geschäft', 'Tel. privat', 'Handy', 'E-Mail'].each do |phone_number_type|
+          next if select { |contact| contact.phone_number_type == phone_number_type }.present?
+          build(phone_number_type: phone_number_type)
+        end
+      end
+    end
+
+    accepts_nested_attributes_for :contacts,
+                                  reject_if: proc { |attributes| attributes['number'].blank? },
+                                  allow_destroy: true
+
+    # Access restrictions
+    if defined?(ActiveModel::MassAssignmentSecurity)
+      attr_accessible :full_name, :nickname, :address_attributes, :family_name, :given_name,
+                      :post_office_box, :extended_address, :street_address, :locality, :region,
+                      :postal_code, :country_name, :zip_locality, :contacts_attributes,
+                      :honorific_prefix, :honorific_suffix
+    end
+
+    # SwissMatch
+    include Vcard::DirectoryLookup
+
+    scope :active, conditions: { active: true }
+    scope :by_name, ->(name) { { conditions: by_name_conditions(name) } }
+    scope :with_address, joins(:address).includes(:address)
+
+    # Validations
+    include I18nHelpers
+
+    def validate_name
+      return if full_name.present?
+
+      errors.add(:full_name, "#{t_attr(:full_name, Vcard)} #{I18n.translate('errors.messages.empty')}")
+      errors.add(:family_name, "#{t_attr(:family_name, Vcard)} #{I18n.translate('errors.messages.empty')}")
+      errors.add(:given_name, "#{t_attr(:given_name, Vcard)} #{I18n.translate('errors.messages.empty')}")
+    end
+
+    # Convenience accessors
+    def full_name
+      result = read_attribute(:full_name)
+      result ||= [ family_name, given_name ].compact.join(' ')
+
+      result
+    end
+
+    def abbreviated_name
+      return read_attribute(:full_name) if read_attribute(:full_name)
+
+      [given_name.try(:first).try(:upcase), family_name].compact.join('. ')
+    end
+
+    # Advanced finders
+    def self.by_name_conditions(name)
+      ['vcards.full_name LIKE :name OR vcards.family_name LIKE :name OR vcards.given_name LIKE :name OR vcards.nickname LIKE :name', { name: name }]
+    end
+
+    def self.find_by_name(name)
+      find :first, conditions: by_name_conditions(name)
+    end
+
+    def self.find_all_by_name(name)
+      find :all, conditions: by_name_conditions(name)
+    end
+
+    # Helper methods
+    def address_lines
+      lines = [extended_address, street_address, post_office_box, "#{postal_code} #{locality}"]
+
+      # Only return non-empty lines
+      lines.reject(&:blank?).compact.map(&:strip)
+    end
+
+    def full_address_lines
+      lines = [honorific_prefix, full_name] + address_lines
+
+      # Only return non-empty lines
+      lines.reject(&:blank?).compact.map(&:strip)
+    end
+
+    def contact_lines
+      lines = contacts
+
+      # Only return non-empty lines
+      lines.map(&:to_s).reject(&:blank?).compact.map(&:strip)
+    end
+  end
+end