visit_card 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Pavel Chipiga
+
+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.rdoc

@@ -0,0 +1,31 @@
+= visit_card
+
+Manage visit cards in your app.
+VCard standart (RFC 2426) realization through Rails 3 Engines.
+Supports export to hCard microformat.
+
+== TODO
+* Move out styles and javascript from views.
+* Improve hCard microformat export. Move to Builder.
+* Add I18n support.
+* Add localized_country_select plugin support.
+* Add phone gem support.
+* Import/Export VCard.
+* Test suite.
+* Improve Generators. Add seeds generator.
+* Do something with routes?
+* Improve default views.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Pavel Chipiga. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "visit_card"
+    gem.summary = %Q{VCard implementation for  Rails 3}
+    gem.description = %Q{Rails 3 engines plugin for VCard store and managment}
+    gem.email = "pavel.chipiga@gmail.com"
+    gem.homepage = "http://github.com/chipiga/visit_card"
+    gem.authors = ["Pavel Chipiga"]
+    gem.add_dependency "bitmask-attribute", ">= 1.2.0"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "visit_card #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/controllers/vcards_controller.rb

@@ -0,0 +1,3 @@
+class VcardsController < ApplicationController
+  include VisitCard::Controllers::VcardsController
+end

data/app/helpers/vcards_helper.rb

@@ -0,0 +1,3 @@
+module VcardsHelper
+  include VisitCard::Helpers::VcardsHelper
+end

data/app/models/vcard.rb

@@ -0,0 +1,3 @@
+class Vcard < ActiveRecord::Base
+  include VisitCard::Models::Vcard
+end

data/app/models/vcard_adr.rb

@@ -0,0 +1,3 @@
+class VcardAdr < ActiveRecord::Base
+  include VisitCard::Models::VcardAdr
+end

data/app/models/vcard_categorization.rb

@@ -0,0 +1,3 @@
+class VcardCategorization < ActiveRecord::Base
+  include VisitCard::Models::VcardCategorization
+end

data/app/models/vcard_dictionary.rb

@@ -0,0 +1,3 @@
+class VcardDictionary < ActiveRecord::Base
+  include VisitCard::Models::VcardDictionary
+end

data/app/models/vcard_email.rb

@@ -0,0 +1,3 @@
+class VcardEmail < ActiveRecord::Base
+  include VisitCard::Models::VcardEmail
+end

data/app/models/vcard_tel.rb

@@ -0,0 +1,3 @@
+class VcardTel < ActiveRecord::Base
+  include VisitCard::Models::VcardTel
+end

data/app/views/visit_card/vcard_adrs/_form_fields.html.erb

@@ -0,0 +1,38 @@
+<fieldset class="inputs adr">
+  <legend>Address</legend>
+  <ol>
+    <li class="field">
+      <%= ff.check_box_collection :types, VcardAdr::TYPES %>
+    </li>
+    <li class="field">
+      <%= ff.label :post_office_box %>
+      <%= ff.text_field :post_office_box %>
+    </li>
+    <li class="field">
+      <%= ff.label :extended_address %>
+      <%= ff.text_field :extended_address %>
+    </li>
+    <li class="field">
+      <%= ff.label :street_address %>
+      <%= ff.text_field :street_address %>
+    </li>
+    <li class="field">
+      <%= ff.label :locality %>
+      <%= ff.text_field :locality %>
+    </li>
+    <li class="field">
+      <%= ff.label :region %>
+      <%= ff.text_field :region %>
+    </li>
+    <li class="field">
+      <%= ff.label :postal_code %>
+      <%= ff.text_field :postal_code %>
+    </li>
+    <li class="field">
+      <%= ff.label :country_name %>
+      <%= ff.text_field :country_name %> <!-- TODO select -->
+    </li>
+  </ol>
+  <%= ff.hidden_field :_destroy, :value => '' %>
+  <a href='#' class='remove'>Remove</a>
+</fieldset>

data/app/views/visit_card/vcard_emails/_form_fields.html.erb

@@ -0,0 +1,14 @@
+<fieldset class="inputs email">
+  <legend>Email</legend>
+  <ol>
+    <li class="field">
+      <%= ff.check_box_collection :types, VcardEmail::TYPES %>
+    </li>
+    <li class="field">
+      <%= ff.label :value %>
+      <%= ff.email_field :value %>
+    </li>
+  </ol>
+  <%= ff.hidden_field :_destroy, :value => '' %>
+  <a href='#' class='remove'>Remove</a>
+</fieldset>

data/app/views/visit_card/vcard_tels/_form_fields.html.erb

@@ -0,0 +1,14 @@
+<fieldset class="inputs tel">
+  <legend>Telephone</legend>
+  <ol>
+    <li class="field">
+      <%= ff.check_box_collection :types, VcardTel::TYPES %>
+    </li>
+    <li class="field">
+      <%= ff.label :value %>
+      <%= ff.telephone_field :value %>
+    </li>
+  </ol>
+  <%= ff.hidden_field :_destroy, :value => '' %>
+  <a href='#' class='remove'>Remove</a>
+</fieldset>

data/app/views/visit_card/vcards/_form.html.erb

@@ -0,0 +1,115 @@
+<%= render 'static' %>
+<%= form_for @vcard do |f| %>
+  <% if @vcard.errors.any? %>
+    <div id="errorExplanation">
+      <h2><%= "#{pluralize(@vcard.errors.count, "error")} prohibited this project from being saved:"%></h2>
+      <ul>
+        <% @vcard.errors.full_messages.each do |msg| %>
+          <li><%= msg %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <fieldset class="inputs">
+    <ol>
+      <li class="field required">
+        <%= f.label :family_name %>
+        <%= f.text_field :family_name %>
+      </li>
+      <li class="field required">
+        <%= f.label :given_name %>
+        <%= f.text_field :given_name %>
+      </li>
+      <li class="field">
+        <%= f.label :additional_name %>
+        <%= f.text_field :additional_name %>
+      </li>
+      <li class="field">
+        <%= f.label :honorific_prefix %>
+        <%= f.text_field :honorific_prefix, :size => 10, :maxlength => 10 %>
+      </li>
+      <li class="field">
+        <%= f.label :honorific_suffix %>
+        <%= f.text_field :honorific_suffix, :size => 10, :maxlength => 10 %>
+      </li>
+      <li class="field">
+        <%= f.label :nickname %>
+        <%= f.text_field :nickname %>
+      </li>
+      <li class="field">
+        <%= f.label :photo %>
+        <%= f.url_field :photo %>
+      </li>
+      <li class="field">
+        <%= f.label :bday %>
+        <%= f.date_select :bday, :start_year => Time.now.year - 80, :end_year => Time.now.year, :include_blank => true %>
+      </li>
+
+      <li class="field">
+        <%= f.label :tz %>
+        <%= f.time_zone_select :tz, nil, :include_blank => true %>
+      </li>
+      <li class="field">
+        <%= f.label :latitude %>
+        <%= f.number_field :latitude, :size => 10, :maxlength => 10 %>
+      </li>
+      <li class="field">
+        <%= f.label :longitude %>
+        <%= f.number_field :longitude, :size => 10, :maxlength => 10 %>
+      </li>
+      <li class="field">
+        <%= f.label :title %>
+        <%= f.text_field :title %>
+      </li>
+      <li class="field">
+        <%= f.label :role %>
+        <%= f.text_field :role %>
+      </li>
+      <li class="field">
+        <%= f.label :logo %>
+        <%= f.url_field :logo %>
+      </li>
+      <li class="field">
+        <%= f.label :agent %>
+        <%= f.select :agent_id, Vcard.except(params[:id]).collect {|v| [ v.fn, v.id ] }, :include_blank => true %>
+      </li>
+      <li class="field">
+        <%= f.label :org %>
+        <%= f.text_field :org %>
+      </li>
+      <li class="field">
+        <%= f.check_box_collection :vcard_categories, Hash[ *VcardDictionary.categories.collect { |d| [ d.id, d.name ] }.flatten ] %>
+      </li>
+      <li class="field">
+        <%= f.label :note %>
+        <%= f.text_area :note %>
+      </li>
+      <li class="field">
+        <%= f.label :url %>
+        <%= f.url_field :url %>
+      </li>
+      <li class="field">
+        <%= f.label :klass %>
+        <%= f.select :klass, Vcard::VCARD_KLASSES %>
+      </li>
+
+      <% %w{adrs tels emails extensions}.each do |item| %>
+        <li class="field <%= item %>">
+          <%= f.fields_for :"vcard_#{item}" do |ff| %>
+            <%= render "vcard_#{item}/form_fields", :ff => ff %>
+          <% end %>
+          <a href='#' class='add' title='<%= item.singularize %>'>Add <%= item.singularize.humanize %></a>
+        </li>
+      <% end %>
+    </ol>
+  </fieldset>
+  
+  <fieldset class="buttons">
+    <ol>
+      <li class="actions">
+        <%= f.submit 'Save' %>
+      </li>
+    </ol>
+  </fieldset>
+<% end %>

data/app/views/visit_card/vcards/_hcard.html.erb

@@ -0,0 +1 @@
+<%= @vcard.to_hcard %>

data/app/views/visit_card/vcards/_static.html

@@ -0,0 +1,39 @@
+<!-- TODO move to static files -->
+<style>
+  li.field {clear: both;}
+  li.field > label {display: block;}
+  fieldset ol {list-style-type: none!important; padding: 0!important; margin: 0!important;}
+  fieldset.inputs, fieldset.vcard_categories {border: 1px solid #000000; padding: 10px;}
+  a.add, a.remove {float: right;}
+  .required label:after {content: ' * '; color: red;}
+</style>
+<script>
+$(document).ready(function(){
+  $('a.remove').live('click', function(){
+    //$(this).prev().find('input[type$="hidden"]').val('1');
+    $(this).prev().val('1');
+    $(this).parent().slideUp('slow');
+    return false;
+  });
+  
+  $('a.add').click(function(){
+    var from = $(this).parent().find('fieldset'+($(this).attr('title') ? '.'+$(this).attr('title') : '')+':last'); // source block
+    var id = parseInt(from.find('input:first').attr('id').split('_').sort().shift()) + 1; // parse id and increment
+    var to = from.clone().hide(); // copy block and hide
+    to.find('input,select').attr('id', function(){ // replace id param
+      return this.id.replace(/\d+/, id);
+    });
+    to.find('label').attr('for', function(){ // replace for param
+      return $(this).attr('for').replace(/\d+/, id);
+    });
+    to.find('input,select').attr('name', function(){ // replace name param
+      if ($(this).attr('type') != 'checkbox') { $(this).val(''); } // clear block fields values
+      else { $(this).removeAttr('checked'); } // clear checkboxes
+      return $(this).attr('name').replace(/\d+/, id);
+    });
+    $(this).before(to); // insert block before link
+    to.slideDown('slow'); // show block
+    return false;
+  });
+});
+</script>

data/app/views/visit_card/vcards/edit.html.erb

@@ -0,0 +1,7 @@
+<h1>Edit VCard</h1>
+
+<%= render 'form' %>
+
+<p>
+  <%= link_to 'Back', vcards_path %>
+</p>

data/app/views/visit_card/vcards/index.html.erb

@@ -0,0 +1,20 @@
+<h1>Listing VCards</h1>
+
+<table>
+  <tr>
+    <th>FN</th>
+    <th>ORG</th>
+    <th>Action</th>
+  </tr>
+<% @vcards.each do |vcard| %>
+  <tr>
+    <td><%= link_to(vcard.fga, vcard) %></td>
+    <td><%= vcard.org %></td>
+    <td><%= link_to 'Edit', edit_vcard_path(vcard) %> | <%= link_to 'Destroy', vcard, :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<% end %>
+</table>
+
+<p>
+  <%= link_to 'New VCard', new_vcard_path %>
+</p>

data/app/views/visit_card/vcards/new.html.erb

@@ -0,0 +1,7 @@
+<h1>New VCard</h1>
+
+<%= render 'form' %>
+
+<p>
+  <%= link_to 'Back', vcards_path %>
+</p>

data/app/views/visit_card/vcards/show.html.erb

@@ -0,0 +1,7 @@
+<h1><%= @vcard.fn << (@vcard.nickname? ? " (#{@vcard.nickname})" : '') %></h1>
+
+<%= render 'hcard' %>
+
+<p>
+  <%= link_to 'Edit', edit_vcard_path(@vcard) %> | <%= link_to 'Back', vcards_path %>
+</p>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails::Application.routes.draw do |map| 
+  resources :vcards
+end

data/lib/generators/visit_card/vcard/templates/migration.rb

@@ -0,0 +1,94 @@
+class Create<%= table_name.camelize %>Tables < ActiveRecord::Migration
+  def self.up
+    create_table(:<%= table_name %>) do |t|
+      # t.references :user # additional field for multi-user system
+      t.references :agent
+      # t.boolean :primary # additional flag to set primary user contact
+      # t.string :type # uncomment this if you want use alternative vcard model name through STI
+      t.string :family_name
+      t.string :given_name
+      t.string :additional_name
+      t.string :honorific_prefix, :limit => 10
+      t.string :honorific_suffix, :limit => 10
+      t.string :nickname
+      t.text :photo
+      t.date :bday
+      t.string :tz
+      t.float :latitude
+      t.float :longitude
+      t.string :title
+      t.string :role
+      t.text :logo
+      t.string :org
+      t.text :note
+      t.string :url
+      t.string :klass
+
+      t.timestamps
+    end
+    add_index :<%= table_name %>, :agent_id
+    add_index :<%= table_name %>, :klass
+    # add_index :<%= table_name %>, :user_id
+    # add_index :<%= table_name %>, :primary
+    add_index :<%= table_name %>, [:family_name, :given_name]
+
+    create_table(:vcard_adrs) do |t|
+      t.references :<%= table_name.singularize %>
+      t.integer :types, :default => 0
+      t.string :post_office_box
+      t.string :extended_address
+      t.string :street_address
+      t.string :locality
+      t.string :region
+      t.string :postal_code
+      t.string :country_name
+    end
+    add_index :vcard_adrs, :<%= table_name.singularize %>_id
+
+    create_table(:vcard_tels) do |t|
+      t.references :<%= table_name.singularize %>
+      t.integer :types, :default => 0
+      t.string :value
+    end
+    add_index :vcard_tels, :<%= table_name.singularize %>_id
+
+    create_table(:vcard_emails) do |t|
+      t.references :<%= table_name.singularize %>
+      t.integer :types, :default => 0
+      t.string :value
+    end
+    add_index :vcard_emails, :<%= table_name.singularize %>_id
+
+    create_table(:vcard_dictionaries) do |t|
+      t.string :klass
+      t.string :name
+      t.string :description
+    end
+    add_index :vcard_dictionaries, [:klass, :name], :unique => true
+
+    create_table(:vcard_categorizations) do |t|
+      t.references :<%= table_name.singularize %>
+      t.references :vcard_dictionary
+    end
+    add_index :vcard_categorizations, [:<%= table_name.singularize %>_id, :vcard_dictionary_id], :unique => true
+
+    create_table(:vcard_extensions) do |t|
+      t.references :<%= table_name.singularize %>
+      t.references :vcard_dictionary
+      t.integer :types, :default => 0
+      t.string :value
+    end
+    add_index :vcard_extensions, :<%= table_name.singularize %>_id
+    add_index :vcard_extensions, :vcard_dictionary_id
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+    drop_table :vcard_adrs
+    drop_table :vcard_tels
+    drop_table :vcard_emails
+    drop_table :vcard_dictionaries
+    drop_table :vcard_categorizations
+    drop_table :vcard_extensions
+  end
+end

data/lib/generators/visit_card/vcard/templates/seeds.rb

@@ -0,0 +1,14 @@
+VcardDictionary.create(:klass => 'category', 'name' => 'travel agent')
+VcardDictionary.create(:klass => 'category', 'name' => 'internet')
+VcardDictionary.create(:klass => 'category', 'name' => 'ietf')
+VcardDictionary.create(:klass => 'category', 'name' => 'industry')
+VcardDictionary.create(:klass => 'category', 'name' => 'information technology')
+
+VcardDictionary.create(:klass => 'extension_type', 'name' => 'x-aim', 'description' => 'aim:#{value}')
+VcardDictionary.create(:klass => 'extension_type', 'name' => 'x-icq', 'description' => 'icq:#{value}/') # http://www.icq.com/people/#{value}
+VcardDictionary.create(:klass => 'extension_type', 'name' => 'x-xmpp', 'description' => 'xmpp:#{value}')
+VcardDictionary.create(:klass => 'extension_type', 'name' => 'x-msn', 'description' => 'msn:#{value}')
+VcardDictionary.create(:klass => 'extension_type', 'name' => 'x-yahoo', 'description' => 'yahoo:#{value}')
+VcardDictionary.create(:klass => 'extension_type', 'name' => 'x-twitter', 'description' => 'http://twitter.com/#{value}')
+VcardDictionary.create(:klass => 'extension_type', 'name' => 'x-skype', 'description' => 'skype:#{value}')
+VcardDictionary.create(:klass => 'extension_type', 'name' => 'x-livejournal', 'description' => 'http://#{value}.livejournal.com/')

data/lib/generators/visit_card/vcard/vcard_generator.rb

@@ -0,0 +1,83 @@
+require 'rails/generators/migration'
+
+module VisitCard
+  module Generators
+    class VcardGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+      namespace "visit_card"
+
+      desc "Generates a model with the given NAME (if one does not exist) with vcard " <<
+           "configuration plus a migration file and vcard routes." # TODO routes??
+
+      def self.orm_has_migration?
+        Rails::Generators.options[:rails][:orm] == :active_record
+      end
+
+      def self.next_migration_number(path)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+      class_option :orm
+      class_option :migration, :type => :boolean, :default => orm_has_migration?
+
+      def invoke_orm_model
+        return unless behavior == :invoke
+
+        if model_exists?
+          say "* Model already exists. Adding Vcard behavior."
+        elsif options[:orm].present?
+          invoke "model", [name], :migration => false, :orm => options[:orm]
+
+          unless model_exists?
+            abort "Tried to invoke the model generator for '#{options[:orm]}' but could not find it.\n" <<
+              "Please create your model by hand before calling `rails g vcard #{name}`."
+          end
+        else
+          abort "Cannot create a vcard model because config.generators.orm is blank.\n" <<
+            "Please create your model by hand or configure your generators orm before calling `rails g vcard #{name}`."
+        end
+      end
+
+      def inject_vcard_config_into_model
+        vcard_class_setup = <<-CONTENT
+
+  include VisitCard::Models::Vcard
+
+CONTENT
+
+        case options[:orm].to_s
+        when "mongoid"
+          inject_into_file model_path, vcard_class_setup, :after => "include Mongoid::Document\n"
+        when "data_mapper"
+          inject_into_file model_path, vcard_class_setup, :after => "include DataMapper::Resource\n"
+        when "active_record"
+          inject_into_class model_path, class_name, vcard_class_setup + <<-CONTENT
+  # Setup accessible (or protected) attributes for your model TODO
+  # attr_accessible :given_name, :last_name, :additional_name
+CONTENT
+        end
+      end
+
+      def copy_migration_template
+        return unless options.migration?
+        migration_template "migration.rb", "db/migrate/create_#{table_name}_tables"
+      end
+
+      def add_vcard_routes
+        # route "vcard_for :#{table_name}"
+      end
+
+    protected
+
+      def model_exists?
+        File.exists?(File.join(destination_root, model_path))
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+      end
+    end
+  end
+end