radiant-vcard_part-extension 1.0.0

data/README

@@ -0,0 +1,11 @@
+Radiant Vcard Part Extension
+----------------------------
+
+This extension builds on Josh French's PageParts extension.
+It adds a new page part type "VcardPagePart", which aids in making valid hCard-formatted markup.
+
+## Still to do
+
+* Revise markup and/or CSS for backend; make things look better.
+* Revise attributes; are these really all of the most-used fields when displaying addresses?
+* Make vcard fields dynamic? I.e. so someone can add more than 1 URL or telephone number.

data/Rakefile

@@ -0,0 +1,109 @@
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => [:spec, :features]
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :features => 'spec:integration'
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  desc "Run the Cucumber features"
+  Cucumber::Rake::Task.new(:integration) do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+    # t.feature_pattern = "#{extension_root}/features/**/*.feature"
+    t.profile = "default"
+  end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the vcard_part extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'VcardPartExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/app/models/vcard.rb

@@ -0,0 +1,4 @@
+class Vcard < ActiveRecord::Base
+  belongs_to :page
+  
+end

data/app/models/vcard_page_part.rb

@@ -0,0 +1,62 @@
+class VcardPagePart < PagePart
+  part_name "vCard"
+  show_filters false
+    
+  def render_content
+    %{<div class="vcard">
+        #{vcard_address_fields}
+        #{vcard_tel_fields}
+        #{vcard_email_and_url_fields}
+      </div>}
+  end
+  
+  private
+  
+  def vcard_address_fields
+    vcard = self.page.vcard
+    result = ""
+    result << "<span class=\"org\">#{vcard.org}</span><br />" unless vcard.org.blank?
+    result << "<span class=\"fn n\">#{vcard.fn} #{vcard.n}</span><br />" unless (vcard.n.blank? && vcard.fn.blank?)
+    unless(vcard.street_address.blank? && vcard.postal_code.blank? && vcard.locality.blank?)
+      result << "<span class=\"adr\">"
+        %w(street-address postal-code locality).each do |attrib|
+          result << "<span class=\"#{attrib}\">#{vcard.send(attrib.gsub(/-/,'_'))}</span>" unless vcard.send(attrib.gsub(/-/, '_')).blank?
+        end
+      result << "</span>"
+    end
+    "<p>#{result}</p>"
+  end
+
+  def vcard_tel_fields
+    vcard = self.page.vcard
+    return if vcard.tel.blank? && vcard.fax.blank?
+    result = ""
+    unless vcard.tel.blank?
+      result << %{
+      <span class="tel">
+  	    <abbr class="type" title="Work">Tel.:</abbr>
+  	    <span class="value">#{vcard.tel}</span>
+  	  </span><br />
+      }
+    end
+    unless vcard.fax.blank?
+      result << %{
+      <span class="tel">
+  	    <abbr class="type" title="Fax">Fax:</abbr>
+  	    <span class="value">#{vcard.fax}</span>
+  	  </span>
+      }
+    end
+    "<p>#{result}</p>"
+  end
+
+  def vcard_email_and_url_fields
+    vcard = self.page.vcard
+    result = ""
+    return result if vcard.email.blank? && vcard.url.blank?
+    result << %{<a class="email" href="mailto:#{vcard.email}">#{vcard.email}</a><br />} unless vcard.email.blank?
+    result << %{<a class="url" href="http://#{vcard.url.gsub(/http(s)?:\/\//,'')}">#{vcard.url}</a><br />} unless vcard.url.blank?
+    "<p>#{result}</p>"
+  end
+
+end

data/app/views/admin/page_parts/_vcard_page_part.html.haml

@@ -0,0 +1,37 @@
+.part.vcard
+  .name
+    %label{:for => "page_vcard_attributes_org"}= t('vcard.organisation')
+    = text_field_tag "page[vcard_attributes][org]", @page.try(:vcard).try(:org)
+    %br
+    %label{:for => "page_vcard_attributes_fn"}= t('vcard.first_name')
+    = text_field_tag "page[vcard_attributes][fn]", @page.try(:vcard).try(:fn)
+    %br
+    %label{:for => "page_vcard_attributes_n"}= t('vcard.name')
+    = text_field_tag "page[vcard_attributes][n]", @page.try(:vcard).try(:n)
+    %br
+
+  .address
+    %label{:for => "page_vcard_attributes_street_address"}= t('vcard.street_address')
+    = text_field_tag "page[vcard_attributes][street_address]", @page.try(:vcard).try(:street_address)
+    %br
+    %label{:for => "page_vcard_attributes_postal_code"}= t('vcard.postal_code')
+    = text_field_tag "page[vcard_attributes][postal_code]", @page.try(:vcard).try(:postal_code)
+    %br
+    %label{:for => "page_vcard_attributes_locality"}= t('vcard.locality')
+    = text_field_tag "page[vcard_attributes][locality]", @page.try(:vcard).try(:locality)
+
+  .telephone
+    %label{:for => "page_vcard_attributes_tel"}= t('vcard.telephone')
+    = text_field_tag "page[vcard_attributes][tel]", @page.try(:vcard).try(:tel)
+    %br
+    %label{:for => "page_vcard_attributes_fax"}= t('vcard.fax')
+    = text_field_tag "page[vcard_attributes][fax]", @page.try(:vcard).try(:fax)
+
+  .online
+    %label{:for => "page_vcard_attributes_email"}= t('vcard.email')
+    = text_field_tag "page[vcard_attributes][email]", @page.try(:vcard).try(:email)
+    %br
+    %label{:for => "page_vcard_attributes_url"}= t('vcard.url')
+    = text_field_tag "page[vcard_attributes][url]", @page.try(:vcard).try(:url)
+    
+    

data/config/initializers/radiant_config.rb

@@ -0,0 +1,3 @@
+Radiant.config do |config|
+  # config.define "setting.name", :default => 'value', :select_from => ['foo', 'bar']
+end

data/config/locales/en.yml

@@ -0,0 +1,13 @@
+---
+en:
+  vcard:
+    email: Email
+    fax: Fax
+    first_name: First name
+    locality: Locality
+    name: Name
+    organisation: Organisation
+    postal_code: Postal code
+    street_address: Street address
+    telephone: Telephone
+    url: Website URL

data/config/locales/nl.yml

@@ -0,0 +1,13 @@
+---
+nl:
+  vcard:
+    email: Email
+    fax: Fax
+    first_name: Voornaam
+    locality: Gemeente
+    name: Naam
+    organisation: Organisatie
+    postal_code: Postcode
+    street_address: Straat
+    telephone: Telefoon
+    url: Website URL

data/config/routes.rb

@@ -0,0 +1,5 @@
+ActionController::Routing::Routes.draw do |map|
+  # map.namespace :admin, :member => { :remove => :get } do |admin|
+  #   admin.resources :vcard_part
+  # end
+end

data/cucumber.yml

@@ -0,0 +1 @@
+default: --format progress features --tags ~@proposed,~@in_progress

data/db/migrate/20110703153748_create_vcards.rb

@@ -0,0 +1,26 @@
+class CreateVcards < ActiveRecord::Migration
+  def self.up
+    create_table :vcards do |t|
+      t.string :fn
+      t.string :n
+      t.string :org
+      t.string :street_address
+      t.string :postal_code
+      t.string :locality
+      t.string :tel
+      t.string :fax
+      t.string :email
+      t.string :url
+      
+      t.integer :page_id
+
+      t.timestamps
+    end
+    
+    add_index :vcards, :page_id
+  end
+
+  def self.down
+    drop_table :vcards
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,11 @@
+# Sets up the Rails environment for Cucumber
+ENV["RAILS_ENV"] = "test"
+# Extension root
+extension_env = File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
+require extension_env+'.rb'
+
+Dir.glob(File.join(RADIANT_ROOT, "features", "**", "*.rb")).each {|step| require step unless step =~ /datasets_loader\.rb$/}
+ 
+Cucumber::Rails::World.class_eval do
+  dataset :vcard_part
+end

data/features/support/paths.rb

@@ -0,0 +1,22 @@
+module NavigationHelpers
+  
+  # Extend the standard PathMatchers with your own paths
+  # to be used in your features.
+  # 
+  # The keys and values here may be used in your standard web steps
+  # Using:
+  #
+  #   When I go to the "vcard_part" admin page
+  # 
+  # would direct the request to the path you provide in the value:
+  # 
+  #   admin_vcard_part_path
+  # 
+  PathMatchers = {} unless defined?(PathMatchers)
+  PathMatchers.merge!({
+    # /vcard_part/i => 'admin_vcard_part_path'
+  })
+  
+end
+
+World(NavigationHelpers)

data/lib/radiant-vcard_part-extension.rb

@@ -0,0 +1,2 @@
+module RadiantVcardPartExtension
+end

data/lib/radiant-vcard_part-extension/version.rb

@@ -0,0 +1,3 @@
+module RadiantVcardPartExtension
+  VERSION = '1.0.0'
+end

data/lib/tasks/vcard_part_extension_tasks.rake

@@ -0,0 +1,55 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :vcard_part do
+      
+      desc "Runs the migration of the Vcard Part extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          VcardPartExtension.migrator.migrate(ENV["VERSION"].to_i)
+          Rake::Task['db:schema:dump'].invoke
+        else
+          VcardPartExtension.migrator.migrate
+          Rake::Task['db:schema:dump'].invoke
+        end
+      end
+      
+      desc "Copies public assets of the Vcard Part to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from VcardPartExtension"
+        Dir[VcardPartExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(VcardPartExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+        unless VcardPartExtension.root.starts_with? RAILS_ROOT # don't need to copy vendored tasks
+          puts "Copying rake tasks from VcardPartExtension"
+          local_tasks_path = File.join(RAILS_ROOT, %w(lib tasks))
+          mkdir_p local_tasks_path, :verbose => false
+          Dir[File.join VcardPartExtension.root, %w(lib tasks *.rake)].each do |file|
+            cp file, local_tasks_path, :verbose => false
+          end
+        end
+      end  
+      
+      desc "Syncs all available translations for this ext to the English ext master"
+      task :sync => :environment do
+        # The main translation root, basically where English is kept
+        language_root = VcardPartExtension.root + "/config/locales"
+        words = TranslationSupport.get_translation_keys(language_root)
+        
+        Dir["#{language_root}/*.yml"].each do |filename|
+          next if filename.match('_available_tags')
+          basename = File.basename(filename, '.yml')
+          puts "Syncing #{basename}"
+          (comments, other) = TranslationSupport.read_file(filename, basename)
+          words.each { |k,v| other[k] ||= words[k] }  # Initializing hash variable as empty if it does not exist
+          other.delete_if { |k,v| !words[k] }         # Remove if not defined in en.yml
+          TranslationSupport.write_file(filename, basename, comments, other)
+        end
+      end
+    end
+  end
+end

data/lib/vcard_part_extension/page_extensions.rb

@@ -0,0 +1,10 @@
+module VcardPartExtension::PageExtensions
+  def self.included(base)
+    base.class_eval do
+      has_one :vcard
+      accepts_nested_attributes_for :vcard, :allow_destroy => true
+      
+    end
+  end
+  
+end

data/radiant-vcard_part-extension.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "radiant-vcard_part-extension/version"
+
+Gem::Specification.new do |s|
+  s.name        = "radiant-vcard_part-extension"
+  s.version     = RadiantVcardPartExtension::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Benny Degezelle"]
+  s.email       = ["hi@mokeypatch.be"]
+  s.homepage    = "https://github.com/jomz/radiant-vcard_part-extension"
+  s.summary     = %q{Vcard Part for Radiant CMS}
+  s.description = %q{Adds a vCardPagePart type. Requires radiant-page_parts-extension.}
+  
+  ignores = if File.exist?('.gitignore')
+    File.read('.gitignore').split("\n").inject([]) {|a,p| a + Dir[p] }
+  else
+    []
+  end
+  s.files         = Dir['**/*'] - ignores
+  s.test_files    = Dir['test/**/*','spec/**/*','features/**/*'] - ignores
+  # s.executables   = Dir['bin/*'] - ignores
+  s.require_paths = ["lib"]
+  
+  s.post_install_message = %{
+  Add this to your radiant project with:
+    config.gem 'radiant-vcard_part-extension', :version => '~>#{RadiantVcardPartExtension::VERSION}'
+  }
+end

data/spec/models/vcard_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Vcard do
+  before(:each) do
+    @vcard = Vcard.new
+  end
+
+  it "should be valid" do
+    @vcard.should be_valid
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{RADIANT_ROOT}/spec/spec_helper"
+
+Dataset::Resolver.default << (File.dirname(__FILE__) + "/datasets")
+
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

data/vcard_part_extension.rb

@@ -0,0 +1,19 @@
+# Uncomment this if you reference any of your controllers in activate
+# require_dependency 'application_controller'
+require 'radiant-vcard_part-extension/version'
+class VcardPartExtension < Radiant::Extension
+  version RadiantVcardPartExtension::VERSION
+  description "Adds a vCardPagePart type."
+  url "https://github.com/jomz/radiant-vcard_part-extension"
+  
+  extension_config do |config|
+  #   config.gem 'radiant-page_parts-extension'
+  end
+  
+  def activate
+    Page.send :include, VcardPartExtension::PageExtensions
+    # tab 'Content' do
+    #   add_item "Vcard Part", "/admin/vcard_part", :after => "Pages"
+    # end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-vcard_part-extension
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Benny Degezelle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-04 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Adds a vCardPagePart type. Requires radiant-page_parts-extension.
+email: 
+- hi@mokeypatch.be
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/models/vcard.rb
+- app/models/vcard_page_part.rb
+- app/views/admin/page_parts/_vcard_page_part.html.haml
+- config/initializers/radiant_config.rb
+- config/locales/en.yml
+- config/locales/nl.yml
+- config/routes.rb
+- cucumber.yml
+- db/migrate/20110703153748_create_vcards.rb
+- features/support/env.rb
+- features/support/paths.rb
+- lib/radiant-vcard_part-extension/version.rb
+- lib/radiant-vcard_part-extension.rb
+- lib/tasks/vcard_part_extension_tasks.rake
+- lib/vcard_part_extension/page_extensions.rb
+- radiant-vcard_part-extension.gemspec
+- Rakefile
+- README
+- spec/models/vcard_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- vcard_part_extension.rb
+has_rdoc: true
+homepage: https://github.com/jomz/radiant-vcard_part-extension
+licenses: []
+
+post_install_message: "\n  Add this to your radiant project with:\n    config.gem 'radiant-vcard_part-extension', :version => '~>1.0.0'\n  "
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Vcard Part for Radiant CMS
+test_files: 
+- spec/models/vcard_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- features/support/env.rb
+- features/support/paths.rb