refinerycms-copywriting 1.0

data/app/controllers/admin/copywriting_phrases_controller.rb

@@ -0,0 +1,46 @@
+module Admin
+  class CopywritingPhrasesController < Admin::BaseController
+    before_filter :find_all_locales, :find_locale, :find_scope, :find_all_scopes
+
+    crudify :copywriting_phrase, :searchable => false,
+            :title_attribute => 'name', :xhr_paging => true, :sortable => false
+
+    protected
+
+    def find_all_copywriting_phrases
+      @copywriting_phrases = CopywritingPhrase.where(:page_id => nil).order([:scope, :name])
+
+      if find_scope
+        @copywriting_phrases = @copywriting_phrases.where(:scope => find_scope)
+      end
+    end
+
+    def find_locale
+      @current_locale ||= (params[:switch_locale].try(:to_sym) || Thread.current[:globalize_locale] || default_locale).to_sym
+    end
+
+    def find_all_locales
+      @locales ||= ::Refinery::I18n.frontend_locales
+    end
+
+    def find_scope
+      @scope ||= params[:filter_scope]
+    end
+
+    def find_all_scopes
+      @scopes ||= CopywritingPhrase.select(:scope).where(:page_id => nil).map(&:scope).uniq
+    end
+
+    def default_locale
+      ::Refinery::I18n.default_frontend_locale
+    end
+
+    def globalize!
+      super
+      if params[:switch_locale]
+        Thread.current[:globalize_locale] = (params[:switch_locale] || default_locale).try(:to_sym)
+      end
+    end
+
+  end
+end

data/app/helpers/copywriting_helper.rb

@@ -0,0 +1,11 @@
+module CopywritingHelper
+  def copywriting(name, options = {}, &block)
+    scope   = options[:scope] || 'default'
+    page_id = options[:page_id] || options[:page].try(:id) || nil
+    default = block_given? ? capture(&block) : options[:default]
+
+    result = ::CopywritingPhrase.for(name, scope, default, page_id)
+    result = result.html_safe if options[:html_safe]
+    result
+  end
+end

data/app/models/copywriting_phrase.rb

@@ -0,0 +1,31 @@
+class CopywritingPhrase < ActiveRecord::Base
+  acts_as_indexed :fields => [:name, :default]
+
+  belongs_to :page
+
+  translates :value if self.respond_to?(:translates)
+
+  validates :name, :presence => true
+  
+
+  attr_accessible :locale, :name, :default, :value, :scope, :page_id
+
+  def self.for(name, scope, default, page_id)
+    name = name.to_s.downcase
+    scope = scope.to_s.downcase
+
+    if phrase = self.where(:name => name).first
+      phrase.default_or_value
+    else
+      if phrase = self.create(:name => name, :scope => scope, :default => default, :page_id => page_id)
+        phrase.default
+      else
+        "<span>Copywriting error: #{phrase.to_a.join(', ')}<span>"
+      end
+    end
+  end
+
+  def default_or_value
+    value.blank? ? default : value 
+  end
+end

data/app/views/admin/copywriting_phrases/_actions.html.erb

@@ -0,0 +1,2 @@
+<%= render 'locale_filters' if defined?(::Refinery::I18n) %>
+<%= render 'scope_filters' %>

data/app/views/admin/copywriting_phrases/_copywritings.html.erb

@@ -0,0 +1,4 @@
+<%= will_paginate @copywriting_phrases %>
+<ul id='phrases'>
+  <%= render :partial => 'admin/copywriting_phrases/phrase', :collection => @copywriting_phrases %>
+</ul>

data/app/views/admin/copywriting_phrases/_form.html.erb

@@ -0,0 +1,21 @@
+<%= form_for [:admin, @copywriting_phrase] do |f| -%>
+  <%= hidden_field_tag :switch_locale, @current_locale %>
+
+  <%= render :partial => "/shared/admin/error_messages", :locals => {
+          :object => @copywriting_phrase,
+          :include_object_name => true
+        } %>
+  
+  <div class='field'>
+    <%= f.label :value, f.object.name.capitalize -%>
+    <%= f.text_area :value, :rows => 12, :class => 'widest' -%>
+  </div>
+
+  <%= render :partial => "/shared/admin/form_actions",
+              :locals => {
+                :f => f,
+                :continue_editing => false,
+                :delete_title => t('delete', :scope => 'admin.copywriting.phrase'),
+                :delete_confirmation => t('message', :scope => 'shared.admin.delete', :title => @copywriting_phrase.name)
+              } %>
+<% end -%>

data/app/views/admin/copywriting_phrases/_locale_filters.html.erb

@@ -0,0 +1,26 @@
+<% if defined?(::Refinery::I18n) and ::Refinery::I18n.enabled? %>
+<% locales = ::Refinery::I18n.locales.reject {|locale, title| !@locales.include?( locale ) } %>
+<ul class='collapsible_menu closed'>
+
+  <% if @current_locale %>
+    <% current_locale = @current_locale %>
+    <% current_locale_title = locales[current_locale] %>
+      <li>
+        <%= link_to "#", :style => "background-image: url('/images/refinery/icons/flags/#{current_locale}.png');" do %>
+          <%= current_locale_title.respond_to?(:force_encoding) ? 
+              current_locale_title.force_encoding('utf-8') : current_locale_title %>
+          <span><%= t('.change_language') %></span>
+          <span style='display:none;'><%= t('cancel', :scope => 'shared.admin.form_actions') %></span>
+        <% end %>
+      </li>
+  <% end %>
+
+  <% locales.sort_by{|key, value| value}.each do |locale, locale_title| %>
+    <li>
+      <%= link_to locale_title, params.dup.tap { |p| p[:switch_locale] = locale },
+                  :style => "background-image: url('/images/refinery/icons/flags/#{locale}.png');" %>
+    </li>
+  <% end %>
+</ul>
+
+<% end %>

data/app/views/admin/copywriting_phrases/_phrase.html.erb

@@ -0,0 +1,20 @@
+<li class='clearfix record <%= cycle("on", "on-hover") %>' id="<%= dom_id(phrase) -%>">
+  <span class='title'>
+    <% if @scope.nil? and phrase.scope %>
+      <%= link_to phrase.scope.capitalize, params.dup.tap { |p| p[:filter_scope] = phrase.scope } %>
+    <% end %>
+    <b><%= phrase.name %></b>
+    <span class="preview">- <%= truncate(phrase.default_or_value, :length => 40) %></span>
+  </span>
+  <span class='actions'>
+    <%= link_to refinery_icon_tag("application_edit.png"), edit_admin_copywriting_phrase_path(phrase, :dialog => true),
+         :title => t('.edit') %>
+
+    <%= link_to refinery_icon_tag("delete.png"), admin_copywriting_phrase_path(phrase),
+         :title => t('.delete'),
+         :class => "cancel confirm-delete",
+         :confirm => t('message', :scope => 'shared.admin.delete', :title => phrase.name.capitalize),
+         :method => :delete %>
+
+  </span>
+</li>

data/app/views/admin/copywriting_phrases/_records.html.erb

@@ -0,0 +1,15 @@
+<% if @copywriting_phrases.any? %>
+  <div class='pagination_container'>
+    <%= render :partial => 'copywritings', :copywriting_phrases => @copywriting_phrases %>
+  </div>
+<% else %>
+  <p>
+    <% unless searching? %>
+      <strong>
+        <%= t('.no_items_yet') %>
+      </strong>
+    <% else %>
+      <%= t('no_results', :scope => 'shared.admin.search') %>
+    <% end %>
+  </p>
+<% end %>

data/app/views/admin/copywriting_phrases/_scope_filters.html.erb

@@ -0,0 +1,16 @@
+<ul class='collapsible_menu closed'>
+  <li>
+    <% title = @scope ? t('.filtered_by', :filter_scope => @scope.capitalize) : t('.filter_by_scope') %>
+    <%= link_to title, '#', :style => 'background-image: url(\'/images/refinery/icons/zoom.png\');' %>
+  </li>
+  <% if @scope %>
+  <li>
+    <%= link_to t('.clear_scope_filter'), params.dup.tap { |p| p[:filter_scope] = nil } %>
+  </li>
+  <% end %>
+  <% (@scopes - [@scope]).each do |s| %>
+    <li class='<%= s == @scope ? 'selected' : 'closed' %>'>
+      <%= link_to s.capitalize, params.dup.tap { |p| p[:filter_scope] = s } %>
+    </li>
+  <% end %>
+</ul>

data/app/views/admin/copywriting_phrases/edit.html.erb

@@ -0,0 +1 @@
+<%= render :partial => "form" %>

data/app/views/admin/copywriting_phrases/index.html.erb

@@ -0,0 +1,7 @@
+<section id='records'>
+  <%= render :partial => 'records' %>
+</section>
+<aside id='actions'>
+  <%= render :partial => 'actions' %>
+</aside>
+

data/app/views/admin/pages/tabs/_copywriting.html.erb

@@ -0,0 +1,25 @@
+<% copywriting_phrases = @page.copywriting_phrases %>
+<% if copywriting_phrases and copywriting_phrases.any? %>
+  <div class='wym_skin_refinery page_part' id='copywritting-tab'>
+    <ul>
+      <% copywriting_phrases.each do |phrase| %>
+        <li>
+          <% f.fields_for :copywriting_phrases, phrase do |p|%>
+          <div class='field'>
+            <%= p.label :value, p.object.name.capitalize -%>
+            <%= p.text_field :value, :class => 'widest' -%>
+          </div>
+          <% end %>
+        </li>
+      <% end %>
+    </ul>
+  </div>
+<% else %>
+  <div class='wym_skin_refinery page_part' id='copywritting-tab'>
+    <p><%= t('.no_copywriting_yet') %></p>
+  </div>
+<% end %>
+
+<% content_for :stylesheets do %>
+  <%= stylesheet_link_tag 'refinerycms-copywritting-tab' %>
+<% end %>

data/config/locales/en.yml

@@ -0,0 +1,21 @@
+en:
+  plugins:
+    refinerycms_copywriting:
+      title: Copywriting
+  admin:
+    copywriting_phrases:
+      locale_filters:
+        change_language: Change language
+      scope_filters:
+        filter_by_scope: Filter by scope
+        filtered_by: "Filtered by '%{filter_scope}'"
+        clear_scope_filter: Clear
+      records:
+        no_items_yet: There are no Phrase yet.
+      phrase:
+        edit: Edit this phrase
+        delete: Remove this phrase
+    pages:
+      tabs:
+        copywriting:
+          no_copywriting_yet: No copywriting for this page

data/config/routes.rb

@@ -0,0 +1,9 @@
+Refinery::Application.routes.draw do
+  scope(:path => 'refinery', :as => 'admin', :module => 'admin') do
+    resources :copywriting_phrases, :path => 'copywriting', :except => [:show, :new, :create] do
+      collection do
+        post :update_positions
+      end
+    end
+  end
+end

data/db/migrate/1_create_copywritings.rb

@@ -0,0 +1,25 @@
+class CreateCopywritings < ActiveRecord::Migration
+
+  def self.up
+    create_table :copywriting_phrases do |t|
+      t.string :name
+      t.text :default
+      t.text :value
+      t.string :scope
+      t.integer :page_id
+
+      t.timestamps
+    end
+
+    add_index :copywriting_phrases, :name, :scope
+
+    load(Rails.root.join('db', 'seeds', 'copywritings.rb'))
+  end
+
+  def self.down
+    UserPlugin.destroy_all({:name => "refinerycms_copywriting"})
+
+    drop_table :copywriting_phrases
+  end
+
+end

data/db/migrate/2_create_copywriting_translation_table.rb

@@ -0,0 +1,16 @@
+class CreateCopywritingTranslationTable < ActiveRecord::Migration
+
+  def self.up
+    ::CopywritingPhrase.create_translation_table!({
+        :value => :string
+      }, {
+        :migrate_data => true
+      })
+    end
+  end
+
+  def self.down
+    ::CopywritingPhrase.drop_translation_table! :migrate_data => true
+  end
+
+end

data/db/seeds/copywritings.rb

@@ -0,0 +1,6 @@
+User.all.each do |user|
+  if user.plugins.where(:name => 'refinerycms_copywriting').blank?
+    user.plugins.create(:name => 'refinerycms_copywriting',
+                        :position => (user.plugins.maximum(:position) || -1) +1)
+  end
+end

data/features/manage_copywriting.feature

@@ -0,0 +1,36 @@
+@copywritings
+Feature: Copywritings
+  In order to have copywritings on my website
+  As an administrator
+  I want to manage copywritings
+
+  Background:
+    Given I am a logged in refinery user
+    And I have no copywritings
+
+  @copywritings-list @list
+  Scenario: Copywritings List
+   Given I have copywritings titled slogan, subtitle
+   When I go to the list of copywritings
+   Then I should see "slogan"
+   And I should see "subtitle"
+
+  @copywritings-edit @edit
+  Scenario: Edit Existing Copywriting
+    Given I have copywritings titled "slogan"
+    When I go to the list of copywritings
+    And I follow "Edit this copywriting" within ".actions"
+    Then I fill in "value" with "A different slogan"
+    And I press "Save"
+    Then I should see "'slogan' was successfully updated."
+    And I should be on the list of copywritings
+    And I should see "A different slogan"
+
+  @copywritings-delete @delete
+  Scenario: Delete Copywriting
+    Given I only have copywritings titled slogan
+    When I go to the list of copywritings
+    And I follow "Remove this phrase"
+    Then I should see "'slogan' was successfully removed."
+    And I should have 0 copywritings
+ 

data/features/step_definitions/copywriting_steps.rb

@@ -0,0 +1,14 @@
+Given /^I have no copywritings$/ do
+  CopywritingPhrase.delete_all
+end
+
+Given /^I (only )?have copywritings titled "?([^\"]*)"?$/ do |only, titles|
+  CopywritingPhrase.delete_all if only
+  titles.split(', ').each do |title|
+    CopywritingPhrase.create(:name => title)
+  end
+end
+
+Then /^I should have ([0-9]+) copywritings?$/ do |count|
+  CopywritingPhrase.count.should == count.to_i
+end

data/features/support/paths.rb

@@ -0,0 +1,14 @@
+module NavigationHelpers
+  module Refinery
+    module Copywritings
+      def path_to(page_name)
+        case page_name
+        when /the list of copywritings/
+          admin_copywriting_phrases_path
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/generators/refinerycms_copywriting_generator.rb

@@ -0,0 +1,6 @@
+class RefinerycmsCopywritingGenerator < Refinery::Generators::EngineInstaller
+
+  source_root File.expand_path('../../../', __FILE__)
+  engine_name "refinerycms_copywriting"
+
+end

data/lib/refinerycms-copywriting.rb

@@ -0,0 +1,39 @@
+require 'refinerycms-base'
+
+module Refinery
+  module Copywriting
+    class Engine < Rails::Engine
+      initializer "static assets" do |app|
+        app.middleware.insert_after ::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/public"
+      end
+
+      config.to_prepare do
+        Page.module_eval do
+          has_many :copywriting_phrases, :dependent => :destroy
+          accepts_nested_attributes_for :copywriting_phrases, :allow_destroy => false
+          attr_accessible :copywriting_phrases_attributes
+        end
+      end
+
+      config.to_prepare do
+        ::ApplicationController.helper(CopywritingHelper)
+      end
+
+      config.after_initialize do
+        ::Refinery::Pages::Tab.register do |tab|
+          tab.name = 'copywriting'
+          tab.partial = '/admin/pages/tabs/copywriting'
+        end
+        Refinery::Plugin.register do |plugin|
+          plugin.name = 'refinerycms_copywriting'
+          plugin.url = {:controller => '/admin/copywriting_phrases', :action => 'index'}
+          plugin.menu_match = /copywriting/
+          plugin.activity = {
+            :class => CopywritingPhrase,
+            :title => 'Key'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/tasks/copywritings.rake

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

data/spec/models/copywriting_phrase_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe CopywritingPhrase do
+
+  context "validations" do
+    
+    it "rejects empty name" do
+      copy = CopywritingPhrase.new
+      copy.save.should be_false
+    end
+    
+  end
+
+  context "for" do
+
+    it "should return the default string if value is not set" do
+      CopywritingPhrase.for('name', 'scope', 'default', nil).should == 'default'
+    end
+
+    it "should not duplicate copywriting phrases" do
+      2.times { CopywritingPhrase.for('name', 'scope', 'default', nil) }
+      CopywritingPhrase.where(:name => 'name').count.should == 1
+    end
+
+    it "should return the string the value once its set" do
+      CopywritingPhrase.for('name', 'scope', 'default', nil).should == 'default'
+      copy = CopywritingPhrase.where(:name => 'name').first
+      copy.value = 'updated!'
+      copy.save
+
+      CopywritingPhrase.for('name', 'scope', 'default', nil).should == 'updated!'
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: refinerycms-copywriting
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Charles Barbier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-30 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Copywriting engine for Refinery CMS
+email: unixcharles@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/generators/refinerycms_copywriting_generator.rb
+- lib/refinerycms-copywriting.rb
+- lib/tasks/copywritings.rake
+- config/locales/en.yml
+- config/routes.rb
+- app/controllers/admin/copywriting_phrases_controller.rb
+- app/helpers/copywriting_helper.rb
+- app/models/copywriting_phrase.rb
+- app/views/admin/copywriting_phrases/_actions.html.erb
+- app/views/admin/copywriting_phrases/_copywritings.html.erb
+- app/views/admin/copywriting_phrases/_form.html.erb
+- app/views/admin/copywriting_phrases/_locale_filters.html.erb
+- app/views/admin/copywriting_phrases/_phrase.html.erb
+- app/views/admin/copywriting_phrases/_records.html.erb
+- app/views/admin/copywriting_phrases/_scope_filters.html.erb
+- app/views/admin/copywriting_phrases/edit.html.erb
+- app/views/admin/copywriting_phrases/index.html.erb
+- app/views/admin/pages/tabs/_copywriting.html.erb
+- db/migrate/1_create_copywritings.rb
+- db/migrate/2_create_copywriting_translation_table.rb
+- db/seeds/copywritings.rb
+- spec/models/copywriting_phrase_spec.rb
+- features/manage_copywriting.feature
+- features/step_definitions/copywriting_steps.rb
+- features/support/paths.rb
+has_rdoc: true
+homepage: http://github.com/unixcharles/refinerycms-copywriting
+licenses: []
+
+post_install_message: 
+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: Refinery CMS engine to manage copywriting, application wide or per pages, with i18n.
+test_files: []
+