phrasing 2.1.0

data/app/assets/stylesheets/phrasing_fonts.css.scss

@@ -0,0 +1,60 @@
+@font-face {
+	font-family: 'icomoon';
+	src:asset-url('icomoon.eot');
+	src:asset-url('icomoon.eot?#iefix') format('embedded-opentype'),
+		asset-url('icomoon.woff') format('woff'),
+		asset-url('icomoon.ttf') format('truetype'),
+		asset-url('icomoon.svg#icomoon') format('svg');
+	font-weight: normal;
+	font-style: normal;
+}
+
+/* Use the following CSS code if you want to use data attributes for inserting your icons */
+[data-icon]:before {
+	font-family: 'icomoon';
+	content: attr(data-icon);
+	speak: none;
+	font-weight: normal;
+	font-variant: normal;
+	text-transform: none;
+	line-height: 1;
+	-webkit-font-smoothing: antialiased;
+}
+
+/* Use the following CSS code if you want to have a class per icon */
+/*
+Instead of a list of all class selectors,
+you can use the generic selector below, but it's slower:
+[class*="icon-"] {
+*/
+.icon-expand, .icon-target, .icon-contrast, .icon-floppy, .icon-contract, .icon-link, .icon-download-alt {
+	font-family: 'icomoon';
+	speak: none;
+	font-style: normal;
+	font-weight: normal;
+	font-variant: normal;
+	text-transform: none;
+	line-height: 1;
+	-webkit-font-smoothing: antialiased;
+}
+.icon-expand:before {
+	content: "\e000";
+}
+.icon-target:before {
+	content: "\e001";
+}
+.icon-contrast:before {
+	content: "\e002";
+}
+.icon-floppy:before {
+	content: "\e003";
+}
+.icon-contract:before {
+	content: "\e004";
+}
+.icon-link:before {
+	content: "\e005";
+}
+.icon-download-alt:before {
+	content: "\e006";
+}

data/app/controllers/phrasing_phrases_controller.rb

@@ -0,0 +1,126 @@
+class PhrasingPhrasesController < ActionController::Base
+
+  layout 'phrasing'
+
+  include PhrasingHelper
+
+  before_filter :authorize_editor
+
+  def index
+    params[:locale] ||= I18n.default_locale
+    query = PhrasingPhrase
+    query = query.where(locale: params[:locale]) unless params[:locale].blank?
+
+    if params[:search] and !params[:search].blank?
+        key_like = PhrasingPhrase.arel_table[:key].matches("%#{params[:search]}%")
+        value_like = PhrasingPhrase.arel_table[:value].matches("%#{params[:search]}%")
+        @phrasing_phrases = query.where(key_like.or(value_like)).order(:key)
+    else
+      @phrasing_phrases = query.order(:key)
+    end
+    
+    @locale_names = PhrasingPhrase.uniq.pluck(:locale)
+  end
+
+  def edit
+    @phrasing_phrase = PhrasingPhrase.find(params[:id])
+  end
+
+  def update
+    @phrasing_phrase = PhrasingPhrase.find(params[:id])
+    @phrasing_phrase.value = params[:phrasing_phrase][:value]
+    @phrasing_phrase.save!
+
+    respond_to do |format|
+      format.html do
+        redirect_to phrasing_phrases_path, notice: "#{@phrasing_phrase.key} updated!"    
+      end
+
+      format.js do
+        render :json => @phrasing_phrase
+      end
+    end
+  end
+
+  def import_export
+  end
+
+  def download
+    app_name = Rails.application.class.to_s.split("::").first
+    app_env = Rails.env
+    filename = "phrasing_phrases_#{app_name}_#{app_env}_#{Time.now.strftime("%Y_%m_%d_%H_%M_%S")}.yml"
+    send_data PhrasingPhrase.export_yaml, filename: filename
+  end
+
+  def upload
+      PhrasingPhrase.import_yaml(params["file"].tempfile)
+      redirect_to phrasing_phrases_path, notice: "YAML file uploaded successfully!"
+    rescue Exception => e
+      logger.info "\n#{e.class}\n#{e.message}"
+      flash[:alert] = "There was an error processing your upload! ##{e.message}"
+      render action: 'import_export', status: 400
+  end
+
+  def destroy
+    @phrasing_phrase = PhrasingPhrase.find(params[:id])
+    @phrasing_phrase.destroy
+    redirect_to phrasing_phrases_path, notice: "#{@phrasing_phrase.key} deleted!"
+  end
+
+  def help
+  end
+
+  def sync
+    if Phrasing.staging_server_endpoint.nil?
+      redirect_to :back, alert: "You didn't set your source server"
+    else
+      yaml = read_remote_yaml(Phrasing.staging_server_endpoint)
+
+      if yaml
+        PhrasingPhrase.import_yaml(yaml)
+        redirect_to :back, notice: "Translations synced from source server"
+      else
+        redirect_to :back
+      end
+
+    end
+  end
+
+  def remote_update_phrase
+    klass, attribute = params[:klass], params[:attribute]
+    
+    if Phrasing.is_whitelisted?(klass, attribute)
+      class_object = klass.classify.constantize
+      @object = class_object.where(id: params[:id]).first
+      @object.send("#{attribute}=",params[:new_value])
+      @object.save!
+      render :json => @object
+    else
+      render status: 403, text: "#{klass}.#{attribute} not whitelisted."
+    end    
+
+    rescue ActiveRecord::RecordInvalid => e
+      render status: 403, text: e
+  end
+
+  protected
+
+    def read_remote_yaml(url)
+      output = nil
+      begin
+        open(url, http_basic_authentication: [Phrasing.username, Phrasing.password]) do |remote|
+          output = remote.read()
+        end
+      rescue Exception => e
+        logger.fatal e
+        flash[:alert] = "Syncing failed: #{e}"
+      end
+      output
+    end
+
+
+    def authorize_editor
+      redirect_to root_path unless can_edit_phrases?
+    end
+
+end

data/app/helpers/inline_helper.rb

@@ -0,0 +1,47 @@
+module InlineHelper
+
+  def phrase(key, options = {}, *args)
+    key = key.to_s
+    if can_edit_phrases?
+      @record = PhrasingPhrase.where(key: key).first || PhrasingPhrase.create_phrase(key)
+      inline(@record, :value, options)
+    else
+      t(key, *args).html_safe
+    end
+  end
+
+  def inline(record, field_name, options={})
+    return record.send(field_name).to_s.html_safe unless can_edit_phrases?
+
+    klass = 'phrasable'
+    klass += ' phrasable_on' if edit_mode_on?
+    klass += ' inverse' if options[:inverse]
+
+    url = phrasing_polymorphic_url(record, field_name)
+
+    content_tag(:span, { class: klass, contenteditable: edit_mode_on?, spellcheck: false,   "data-url" => url}) do 
+      (record.send(field_name) || record.try(:key) || "#{field_name}-#{record.id}").to_s.html_safe
+    end
+
+  end
+
+  alias_method :model_phrase, :inline
+
+  private
+
+    def edit_mode_on?
+      if cookies["editing_mode"].nil?
+        cookies['editing_mode'] = "true"
+        true
+      else  
+        cookies['editing_mode'] == "true"
+      end
+    end
+
+
+    def phrasing_polymorphic_url(record, attribute)
+      resource = Phrasing.route
+      "#{root_url}#{resource}/remote_update_phrase?klass=#{record.class.to_s}&id=#{record.id}&attribute=#{attribute}"
+    end
+
+end

data/app/models/phrasing_phrase.rb

@@ -0,0 +1,97 @@
+class PhrasingPhrase < ActiveRecord::Base
+  require 'phrasing/ambiguous_phrases_error'
+
+  unless ENV['PHRASING_DEBUG']
+    self.logger = Logger.new('/dev/null')
+  end
+
+  validates_presence_of :key, :locale
+
+  before_create :check_ambiguity
+
+  def self.create_phrase(key)
+    phrasing_phrase = PhrasingPhrase.new
+    phrasing_phrase.key = key
+    phrasing_phrase.value = key.to_s.humanize
+    phrasing_phrase.locale = I18n.locale
+    phrasing_phrase.save!
+    phrasing_phrase
+  end
+
+  module Serialize
+
+    def import_yaml(yaml)
+      hash = YAML.load(yaml)
+      hash.each do |locale, data|
+        hash_flatten(data).each do |key, value|
+          c = where(key: key, locale: locale).first
+          c ||= new(key: key, locale: locale)
+          c.value = value
+          c.save
+        end
+      end
+    end
+
+    # {"foo"=>{"a"=>"1", "b"=>"2"}} ----> {"foo.a"=>1, "foo.b"=>2}
+    def hash_flatten(hash)
+      result = {}
+      hash.each do |key, value|
+        if value.is_a? Hash
+          hash_flatten(value).each { |k,v| result["#{key}.#{k}"] = v }
+        else
+          result[key] = value
+        end
+      end
+      result
+    end
+
+    def export_yaml
+      hash = {}
+      where("value is not null").each do |c|
+        hash_fatten!(hash, [c.locale].concat(c.key.split(".")), c.value)
+      end
+      hash.to_yaml
+    end
+
+    # ({"a"=>{"b"=>{"e"=>"f"}}}, ["a","b","c"], "d") ----> {"a"=>{"b"=>{"c"=>"d", "e"=>"f"}}}
+    def hash_fatten!(hash, keys, value)
+      if keys.length == 1
+        hash[keys.first] = value
+      else
+        head = keys.first
+        rest = keys[1..-1]
+        hash[head] ||= {}
+        hash_fatten!(hash[head], rest, value)
+      end
+    end
+
+  end
+
+  extend Serialize
+
+
+  private
+
+    def check_ambiguity
+      check_ambiguity_on_ancestors
+      check_ambiguity_on_successors
+    end
+
+    def check_ambiguity_on_ancestors
+      stripped_key = key
+      while stripped_key.include?('.')
+        stripped_key = stripped_key.split('.')[0..-2].join('.')
+        if PhrasingPhrase.where(key: stripped_key).count > 0
+            raise Phrasing::AmbiguousPhrasesError, "Ambiguous calling! There exists a '#{stripped_key}' key, unable to call a new key '#{key}'"
+        end
+      end
+    end
+
+    def check_ambiguity_on_successors
+      key_successor = "#{key}."
+      if PhrasingPhrase.where(PhrasingPhrase.arel_table[:key].matches("%#{key_successor}%")).count > 0
+        raise Phrasing::AmbiguousPhrasesError, "Ambiguous calling! There exists one or multiple keys beginning with '#{key_successor}', unable to call a new key '#{key}'"
+      end
+    end
+
+end

data/app/views/layouts/phrasing.html.haml

@@ -0,0 +1,12 @@
+!!!
+%html
+  %head
+    %title Phrasing
+    = stylesheet_link_tag "phrasing_engine", :media => "all"
+    %meta{:content => "text/html; charset=utf-8", "http-equiv" => "Content-Type"}/
+  %body
+    #page
+      = render 'phrasing/production_warning' if Rails.env.production?
+      = render 'phrasing/menu'
+      = render 'phrasing/messages'
+      = yield

data/app/views/phrasing/_initializer.html.haml

@@ -0,0 +1,25 @@
+- if can_edit_phrases?
+  .text-options#zenpenbubble
+    .options
+      %span.no-overflow
+        %span.lengthen.ui-inputs 
+          %button.url.useicons 
+          %input.url-input{placeholder: "Type or Paste URL here", type: "text"}/
+          %button.bold b
+          %button.italic i
+
+  #phrasing-edit-mode-bubble
+    %p#edit-mode-headline Edit mode:
+    .onoffswitch
+      %input#edit-mode-onoffswitch.onoffswitch-checkbox{checked: "checked", name: "onoffswitch", type: "checkbox"}/
+      %label.onoffswitch-label{for: "edit-mode-onoffswitch"}
+        .onoffswitch-inner
+        .onoffswitch-switch
+    #phrasing-spinner
+      %p No changes made.
+    #view-all-phrases
+      %p= link_to "All phrases", phrasing_phrases_path
+    #phrasing-info-icon-container
+      = image_tag "phrasing_information_icon.png", class: "phrasing-info-icon"
+    #phrasing-info-container
+      %p Your content will be saved automatically 3 seconds after you stop typing.

data/app/views/phrasing/_menu.html.haml

@@ -0,0 +1,8 @@
+#header
+  %h1= link_to "Phrasing", phrasing_phrases_path
+  %ul
+    - if root_path
+      %li= link_to "Home page", root_path
+    %li= link_to "Phrases", phrasing_phrases_path
+    %li= link_to "Import / Export", import_export_phrasing_phrases_path
+    %li= link_to "Help", help_phrasing_phrases_path

data/app/views/phrasing/_messages.html.haml

@@ -0,0 +1,4 @@
+- if notice
+  .notice= notice
+- if alert
+  .alert=alert

data/app/views/phrasing/_production_warning.html.haml

@@ -0,0 +1,4 @@
+.alert
+  %h1 You're in production!
+  - unless Phrasing.staging_server_endpoint.nil?
+    %p You should do your changes in #{link_to("staging", Phrasing.staging_server_endpoint.gsub("/download", ""))} and then #{link_to("sync them",sync_phrasing_phrases_path)}.

data/app/views/phrasing_phrases/edit.html.haml

@@ -0,0 +1,7 @@
+.edit
+  %h2= @phrasing_phrase.key
+  = button_to "Delete this item", phrasing_phrase_path(@phrasing_phrase), :method => :delete, :onclick => "return confirm('Are you sure?');"
+  = form_for @phrasing_phrase, :url => { :action => "update" } do |f|
+    = f.text_area :value, :rows => 12
+    = f.submit "Update"
+  = link_to "Cancel", phrasing_phrases_path

data/app/views/phrasing_phrases/help.html.haml

@@ -0,0 +1,17 @@
+%div
+  %div
+    %p Phrasing is a Ruby on Rails engine that allows you to edit live website copy.
+  %div
+    %h2 How to use
+    %p Search for the copy text you want to edit. If Phrasing is currently controlling that content, it will appear when you search. If not, ask a developer to add it to Phrasing. You can filter by locale to control what copy is displayed in different languages.
+    %p Once copy appears, click the left hand side links to edit. Values with keys ending in "_html" will be parsed as literal html, so you can insert tags. All other values are parsed as plain text.
+  %div
+    %h2 Exporting and Importing
+    %p Phrasing text is data--not code. By default, it is stored in your server's database, and not the codebase that powers your website. Therefore, you may have to download/upload Phrasing data to transfer your copy edits between servers, or to safeguard them between database wipes. Phrasing exports (and is able to re-import) all of its data in a plaintext format called "YAML."
+    %h4 Exporting
+    %p You can get a YAML file of all your copy by clicking "Download" on the Import/Export page.
+    %h4 Importing
+    %p You can upload copy to Phrasing by uploading a properly formatted YAML file on the Import/Export page. Uploading copy won't delete any entries from Phrasing, but it may update them or create new ones. Use this feature to mass-update your copy from between servers -- e.g., make changes to copy on a test server, and then when you're satisfied, download the YAML file and upload it to your production site. Downloading your copy as YAML and then immediately re-uploading it will leave your copy unchanged.
+    %h4 Commiting copy to code
+    %p
+      If your copy has reached a stable state and you don't need to update it live anymore, you can download your copy as YAML and include it as part of the Ruby on Rails application underneath your main website. You can then remove Phrasing from the application entirely, and the website will still run exactly as before--it interfaces with Ruby on Rails's built-in translation mechanisms in a very unobtrusive way.

data/app/views/phrasing_phrases/import_export.html.haml

@@ -0,0 +1,18 @@
+%h2 Import
+%div
+  %p
+    Upload a YAML (.yml) file following
+    = succeed "." do
+      %a{:href => "http://guides.rubyonrails.org/i18n.html"} I18n conventions
+  = form_tag 'upload', :multipart => true, :'accept-charset' => 'UTF-8' do
+    = file_field_tag "file"
+    = submit_tag "Upload"
+
+- unless Phrasing.staging_server_endpoint.nil? || Rails.env.staging?
+  %h2 Staging syncing
+  %div
+    = link_to "Sync from staging server", sync_phrasing_phrases_path
+
+%h2 Export
+%div
+  = link_to "Download as YAML", download_phrasing_phrases_path

data/app/views/phrasing_phrases/index.html.haml

@@ -0,0 +1,17 @@
+#search
+  = form_tag phrasing_phrases_path, :method => :get do
+    - locale_options = options_for_select([nil] + @locale_names.map{|l| [l,l]}, params[:locale])
+    = select_tag 'locale', locale_options
+    = text_field_tag :search, params[:search], :placeholder => 'Search for keys or values', :size => 40
+    = submit_tag 'Search'
+- if @phrasing_phrases.any?
+  %table
+    %tr
+      %th Key
+      %th Value
+    - @phrasing_phrases.each do |t|
+      %tr
+        %td.key
+          = link_to "#{t.key}", edit_phrasing_phrase_path(t)
+        %td.value
+          = t.value.try(:html_safe)