refinerycms-contacts 0.1.0

data/db/migrate/3_create_contact_pages.rb

@@ -0,0 +1,20 @@
+class CreateContactPages < ActiveRecord::Migration
+
+  def up
+    create_table :refinery_contact_pages do |t|
+      t.integer :contact_id
+      t.integer :page_id
+      t.string  :page_type, :default => "Refinery::Page"
+      t.boolean :contact_info, :default=> false
+    end
+
+    add_index :refinery_contact_pages, :contact_id
+    add_index :refinery_contact_pages, :page_id
+
+  end
+
+  def down
+    drop_table :refinery_contact_pages
+  end
+
+end

data/db/migrate/4_add_homepage_to_contacts.rb

@@ -0,0 +1,11 @@
+class AddHomepageToContacts < ActiveRecord::Migration
+
+  def up
+    add_column :refinery_contacts, :homepage, :string
+  end
+
+  def down
+    remove_column :refinery_contacts, :homepage, :string
+  end
+
+end

data/db/seeds.rb

@@ -0,0 +1,13 @@
+(Refinery.i18n_enabled? ? Refinery::I18n.frontend_locales : [:en]).each do |lang|
+  I18n.locale = lang
+
+  if defined?(Refinery::User)
+    Refinery::User.all.each do |user|
+      if user.plugins.where(:name => 'refinerycms-contacts').blank?
+        user.plugins.create(:name => 'refinerycms-contacts',
+                            :position => (user.plugins.maximum(:position) || -1) +1)
+      end
+    end
+  end
+end
+

data/lib/generators/refinery/contacts_generator.rb

@@ -0,0 +1,28 @@
+module Refinery
+  class ContactsGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def generate_recaptcha_template
+      template 'config/initializers/recaptcha.rb.erb', File.join(destination_root, 'config', 'initializers', 'recaptcha.rb')
+    end
+
+    def generate_contacts_template
+      template 'config/initializers/refinery/contacts.rb.erb', File.join(destination_root, 'config', 'initializers', 'refinery', 'contacts.rb')
+    end
+
+    def rake_db
+      rake("refinery_contacts:install:migrations")
+    end
+
+    def append_load_seed_data
+      create_file 'db/seeds.rb' unless File.exists?(File.join(destination_root, 'db', 'seeds.rb'))
+      append_file 'db/seeds.rb', :verbose => true do
+        <<-EOH
+
+# Added by Refinery CMS Contacts extension
+Refinery::Contacts::Engine.load_seed
+        EOH
+      end
+    end
+  end
+end

data/lib/generators/refinery/templates/config/initializers/recaptcha.rb.erb

@@ -0,0 +1,7 @@
+# Register your key at http://www.google.com/recaptcha/whyrecaptcha
+
+Recaptcha.configure do |config|
+    config.public_key  = ''
+    config.private_key = ''
+    config.proxy = ''
+end

data/lib/generators/refinery/templates/config/initializers/refinery/contacts.rb.erb

@@ -0,0 +1,4 @@
+Refinery::Contacts.configure do |config|
+     # Set to true, if you want to use gem client_side_validations. After that you need to correctly setup gem client_side_validations as it is written in Readme of this gem
+     # config.client_side_validations = <%= Refinery::Contacts.client_side_validations.inspect %>
+end

data/lib/refinery/contacts.rb

@@ -0,0 +1,23 @@
+require 'refinerycms-core'
+
+module Refinery
+  autoload :ContactsGenerator, 'generators/refinery/contacts_generator'
+
+  module Contacts
+    class << self
+      attr_writer :root
+
+      def root
+        @root ||= Pathname.new(File.expand_path('../../../', __FILE__))
+      end
+
+      def factory_paths
+        @factory_paths ||= [ root.join('spec', 'factories').to_s ]
+      end
+    end
+
+    require 'refinery/contacts/engine'
+    require 'refinery/contacts/configuration'
+    require 'refinery/contacts/extensions/pages_extension'
+  end
+end

data/lib/refinery/contacts/configuration.rb

@@ -0,0 +1,10 @@
+module Refinery
+  module Contacts
+    include ActiveSupport::Configurable
+
+    config_accessor :client_side_validations
+
+
+    self.client_side_validations = false
+  end
+end

data/lib/refinery/contacts/engine.rb

@@ -0,0 +1,44 @@
+module Refinery
+  module Contacts
+    class Engine < Rails::Engine
+      include Refinery::Engine
+      isolate_namespace Refinery::Contacts
+
+      engine_name :refinery_contacts
+
+      def self.register(tab)
+        tab.name = tab.name = ::I18n.t(:'refinery.plugins.contacts.tab_name')
+        tab.partial = "/refinery/admin/pages/tabs/contacts/contacts"
+      end
+
+      initializer "register refinerycms_contacts plugin" do
+        Refinery::Plugin.register do |plugin|
+          plugin.name = "contacts"
+          plugin.url = proc { Refinery::Core::Engine.routes.url_helpers.contacts_admin_contacts_path }
+          plugin.pathname = root
+          plugin.activity = {
+            :class_name => :'refinery/contacts/contact'
+          }
+          
+        end
+      end
+
+      config.to_prepare do
+        require 'refinerycms-pages'
+        Refinery::Page.send :has_one_contact
+      end
+
+      config.before_initialize do
+        require 'recaptcha/rails'
+      end
+
+      config.after_initialize do
+        Refinery::Pages::Tab.register do |tab|
+          register tab
+        end
+        Refinery.register_extension(Refinery::Contacts)
+      end
+
+    end
+  end
+end

data/lib/refinery/contacts/extensions/pages_extension.rb

@@ -0,0 +1,40 @@
+module Refinery
+  module Contacts
+    module Extensions
+      module Pages
+        def has_one_contact
+          has_one :contact_page, :as => :page, :dependent=> :destroy
+          has_one :contact, :through => :contact_page
+          has_many :mails, :class_name => Refinery::Contacts::Mail, :through => :contact
+
+
+          accepts_nested_attributes_for :contact_page
+
+          module_eval do
+            def contact_page=(contact_page_params)
+              # new
+              if self.contact_page.nil?
+                self.build_contact_page
+              end
+
+              # destroy
+              if contact_page_params[:contact_id].blank?
+                self.contact_page.destroy
+
+              # create or update if changed
+              elsif (self.contact_page.contact_id.to_s != contact_page_params[:contact_id]) || (self.contact_page.contact_info != contact_page_params[:contact_info] )
+                self.contact_page.update_attributes( contact_page_params)
+                self.contact_page.save
+              end
+
+            end
+          end
+
+          attr_accessible :contact_page
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:extend, Refinery::Contacts::Extensions::Pages)

data/lib/refinery/contacts/version.rb

@@ -0,0 +1,17 @@
+module Refinery
+  module Contacts
+    class Version
+      @major = 0
+      @minor = 1
+      @tiny  = '0'
+
+      class << self
+        attr_reader :major, :minor, :tiny
+
+        def to_s
+          [@major, @minor, @tiny].compact.join('.')
+        end
+      end
+    end
+  end
+end

data/lib/refinerycms-contacts.rb

@@ -0,0 +1 @@
+require 'refinery/contacts'

data/lib/tasks/refinery/contacts.rake

@@ -0,0 +1,13 @@
+namespace :refinery do
+
+  namespace :contacts do
+
+    # call this task by running: rake refinery:contacts:my_task
+    # desc "Description of my task below"
+    # task :my_task => :environment do
+    #   # add your logic here
+    # end
+
+  end
+
+end

data/readme.md

@@ -0,0 +1,170 @@
+# Refinery CMS Contacts
+
+__Contacts engine for Refinery CMS.__
+
+Attach contact form to any page with contact information
+
+## Requirements
+
+This version supports Rails 3.2.x and Refinery CMS ~> 2.0.9. (Should work with ~> 2.0.0, not tested)
+
+## Features
+
+* create contact, contact has many email address
+* contact can be attached to many pages
+* rendering contact form with contact info ( optional )
+* send email
+* server side validation, client side validation ( optional )
+* recaptcha
+
+
+## Screenshots
+
+All screenshots are in [branch screenshots](https://github.com/Matho/refinerycms-contacts/tree/screenshots)
+
+![Edit contact](https://raw.github.com/Matho/refinerycms-contacts/screenshots/0.1.x/01_edit_contact.png)
+![Attach contact to page](https://raw.github.com/Matho/refinerycms-contacts/screenshots/0.1.x/03_attach_contact_to_page.png)
+![Frontend show](https://raw.github.com/Matho/refinerycms-contacts/screenshots/0.1.x/06_frontend_client_side_validation.png)
+
+## Language
+
+Gem is translated to slovak and english.
+
+
+## Installation
+### Gem + migrations
+
+Open up your ``Gemfile`` and add at the bottom this line:
+
+```ruby
+gem 'refinerycms-contacts', '~> 0.1.0'
+```
+
+Now, run
+
+```ruby
+bundle install
+```
+
+Next, to install run:
+
+```ruby
+ rails g refinery:contacts
+```
+
+Run database migrations:
+
+```ruby
+rake db:migrate
+```
+
+Seed your database:
+
+```ruby
+rake db:seed
+```
+
+### Assets + views
+
+If you don't have Chosen JS included in your backend yet, append this code to your_app/config/initializers/refinery/core.rb
+
+```ruby
+ config.register_javascript "refinery/contacts/admin/jquery.chosen.min.js"
+ config.register_stylesheet "refinery/contacts/admin/chosen.css"
+```
+
+To ``view/refinery/pages/show.html.erb`` add ``<%= render "/refinery/contacts/contacts/show" %>``
+
+To your app stylesheet manifest add ``*= require refinery/contacts/contacts``
+To your app javascript manifest add ``//= require refinery/contacts/contacts``
+
+### reCaptcha
+
+Register your reCaptcha code at http://www.google.com/recaptcha/whyrecaptcha and set-up it in ``config/initializers/recaptcha.rb``
+If you want, add that initializer file to .gitignore or rewrite it to use ENV variables from gitignored YAML file
+
+### Send mail testing
+
+If you want to test mail sending in development I recommend to use gem letter_opener.
+In ``app/config/environments/development.rb`` add these lines:
+
+```ruby
+config.action_mailer.delivery_method = :letter_opener
+config.action_mailer.raise_delivery_errors = true
+```
+If you have set-up ActionMailer::Base.smtp_settings block for development mode, comment it.
+
+### Configure mailers
+
+You can override mailer views from folder ``views/refinery/contacts/contact_mailer`` and edit.
+
+### Client side validations
+
+Client side validations gem is not installed by default by refinerycms-contacts gem! You need to install it:
+
+Include ClientSideValidations in your Gemfile
+```ruby
+gem 'client_side_validations', '~> 3.2.1'
+```
+
+Then run the install generator
+```ruby
+rails g client_side_validations:install
+```
+
+This will install the initializer:
+```
+config/initializers/client_side_validations.rb
+```
+**ATTENTION!!!**
+
+Because of [some issues](https://github.com/refinery/refinerycms/issues/961#issuecomment-4594545) we must
+delete that initializer and write this code into file ``config/application.rb`` :
+```ruby
+config.to_prepare do
+      ActionView::Base.field_error_proc = Proc.new do |html_tag, instance|
+        unless html_tag =~ /^<label/
+          %{<div class="field_with_errors">#{html_tag}<label for="#{instance.send(:tag_id)}" class="message">#{instance.error_message.first}</label></div>}.html_safe
+        else
+          %{<div class="field_with_errors">#{html_tag}</div>}.html_safe
+        end
+      end
+    end
+```
+
+Add JS to your manifest:
+```ruby
+//= require rails.validations
+```
+In file ``config/initializers/refinery/contacts.rb `` set client_side_validations to true to don't show server-side validation error in errorExplanations div
+```ruby
+config.client_side_validations = true
+```
+### Precompile assets
+
+Before production, don't forget to precompile assets by:
+
+```ruby
+rake assets:precompile
+```
+
+## Todo list
+
+* add js pop-up in page's tab to allow create contact "in-place" instead of clicking through menu
+* tests :(
+
+## Code
+
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/Matho/refinerycms-contacts)
+
+## Known bugs
+
+* WymEditor tab name don't show title in correct current_locale
+* reCaptcha validation shows errors both for incorrect-captcha-sol and verification_failed key
+
+## Testing
+TODO
+
+## License
+
+Refinery CMS Contacts engine is released under the MIT license. Created by Martin Markech

data/refinerycms-contacts.gemspec

@@ -0,0 +1,27 @@
+# Encoding: UTF-8
+$:.push File.expand_path('../lib', __FILE__)
+require 'refinery/contacts/version'
+
+version = Refinery::Contacts::Version.to_s
+
+Gem::Specification.new do |s|
+  s.platform          = Gem::Platform::RUBY
+  s.name              = 'refinerycms-contacts'
+  s.version           =  version
+  s.description       = 'Ruby on Rails Contacts extension for Refinery CMS'
+  s.summary           = 'Attach contact form to any page in Refinery CMS'
+  s.email             = %q{martin.markech@matho.sk}
+  s.homepage          = %q{http://github.com/Matho/refinerycms-contacts}
+  s.authors           = 'Martin Markech'
+  s.require_paths     = %w(lib)
+
+  s.files             = `git ls-files`.split("\n")
+  #s.test_files        = `git ls-files -- spec/*`.split("\n")
+
+  # Runtime dependencies
+  s.add_dependency             'refinerycms-core',    '~> 2.0.9' # should work ~> 2.0.0 , not tested
+  s.add_dependency             'recaptcha'
+
+  # Development dependencies (usually used for testing)
+  # s.add_development_dependency 'refinerycms-testing', '~> 2.0.9'
+end