phrasing 3.2.10 → 4.0.0rc1

data/app/controllers/phrasing_phrase_versions_controller.rb

@@ -1,9 +1,9 @@
-class PhrasingPhraseVersionsController < Phrasing.parent_controller.constantize
+class PhrasingPhraseVersionsController < ActionController::Base
 
   def destroy
-    @phrasing_phrase_version = PhrasingPhraseVersion.find(params[:id])
-    @phrasing_phrase_version.destroy
-    redirect_to edit_phrasing_phrase_path(@phrasing_phrase_version.phrasing_phrase.id)
+    phrase_version = PhrasingPhraseVersion.find(params[:id])
+    phrase_version.destroy
+    redirect_to edit_phrasing_phrase_path(phrase_version.phrasing_phrase.id)
   end
 
 end

data/app/controllers/phrasing_phrases_controller.rb

@@ -1,4 +1,4 @@
-class PhrasingPhrasesController < Phrasing.parent_controller.constantize
+class PhrasingPhrasesController < ActionController::Base
 
   layout 'phrasing'
 
@@ -8,18 +8,21 @@ class PhrasingPhrasesController < Phrasing.parent_controller.constantize
 
   before_filter :authorize_editor
 
+  def import_export; end
+  def help; end
+
   def index
     params[:locale] ||= I18n.default_locale
-    query = PhrasingPhrase
-    query = query.order(:key)
-    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))
+    query = PhrasingPhrase.order("phrasing_phrases.key")
+    query = query.where(locale: params[:locale]) if params[:locale].present?
+
+    @phrasing_phrases = if params[:search].present?
+      key_like   = PhrasingPhrase.arel_table[:key].matches("%#{params[:search]}%")
+      value_like = PhrasingPhrase.arel_table[:value].matches("%#{params[:search]}%")
+      query.where(key_like.or(value_like))
     else
-      @phrasing_phrases = query.where("value is not null") + query.where("value is null")
+      # because we want to have non nil values first.
+      query.where("value is not null") + query.where("value is null")
     end
 
     @locale_names = PhrasingPhrase.uniq.pluck(:locale)
@@ -30,24 +33,13 @@ class PhrasingPhrasesController < Phrasing.parent_controller.constantize
   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
+    if request.xhr?
+      xhr_phrase_update
+    else
+      phrase_update
     end
   end
 
-  def import_export
-  end
-
   def download
     app_name = Rails.application.class.to_s.split("::").first
     app_env = Rails.env
@@ -58,7 +50,7 @@ class PhrasingPhrasesController < Phrasing.parent_controller.constantize
   def upload
       number_of_changes = Phrasing::Serializer.import_yaml(params["file"].tempfile)
       redirect_to phrasing_phrases_path, notice: "YAML file uploaded successfully! Number of phrases changed: #{number_of_changes}."
-    rescue Exception => e
+    rescue => e
       logger.info "\n#{e.class}\n#{e.message}"
       message = if params[:file].nil?
         "Please choose a file."
@@ -71,65 +63,40 @@ class PhrasingPhrasesController < Phrasing.parent_controller.constantize
   end
 
   def destroy
-    @phrasing_phrase = PhrasingPhrase.find(params[:id])
-    @phrasing_phrase.destroy
-    redirect_to phrasing_phrases_path, notice: "#{@phrasing_phrase.key} deleted!"
+    phrasing_phrase = PhrasingPhrase.find(params[:id])
+    phrasing_phrase.destroy
+    redirect_to phrasing_phrases_path, notice: "#{phrasing_phrase.key} deleted!"
   end
 
-  def help
-  end
+  private
 
-  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
-        Phrasing::Serializer.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: "Attribute not whitelisted!"
+    def authorize_editor
+      redirect_to root_path unless can_edit_phrases?
     end
 
-    rescue ActiveRecord::RecordInvalid => e
-      render status: 403, text: e
-  end
+    def xhr_phrase_update
+      klass, attribute = params[:klass], params[:attribute]
 
-  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}"
+      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: "Attribute not whitelisted!"
       end
-      output
+
+      rescue ActiveRecord::RecordInvalid => e
+        render status: 403, text: e
     end
 
+    def phrase_update
+      phrase = PhrasingPhrase.find(params[:id])
+      phrase.value = params[:phrasing_phrase][:value]
+      phrase.save!
 
-    def authorize_editor
-      redirect_to root_path unless can_edit_phrases?
+      redirect_to phrasing_phrases_path, notice: "#{phrase.key} updated!"
     end
 
 end

data/app/helpers/inline_helper.rb

@@ -3,58 +3,51 @@ module InlineHelper
 # phrase("headline", url: www.infinum.co/yabadaba, inverse: true, interpolation: {min: 15, max: 20}, scope: "models.errors")
 
 # Data model phrase
-# phrase(@record, :title, inverse: true, class: phrase-record-title)
+# phrase(record, :title, inverse: true, class: phrase-record-title)
 
   def phrase(*args)
     if args[0].class == String or args[0].class == Symbol
       key, options = args[0].to_s, args[1]
       phrasing_phrase(key,options || {})
     else
-      record, field_name, options = args[0], args[1], args[2]
-      inline(record, field_name, options || {})
+      record, attribute, options = args[0], args[1], args[2]
+      inline(record, attribute, options || {})
     end
   end
 
-  def inline(record, field_name, options={})
-    return record.send(field_name).to_s.html_safe unless can_edit_phrases?
+  private
 
-    klass = 'phrasable'
-    klass += ' phrasable_on' if edit_mode_on?
-    klass += ' inverse' if options[:inverse]
-    klass += options[:class] if options[:class]
+    def inline(record, attribute, options={})
+      return uneditable_phrase(record, attribute, options) unless can_edit_phrases?
 
-    url = phrasing_polymorphic_url(record, field_name)
+      klass  = 'phrasable phrasable_on'
+      klass += ' inverse'      if options[:inverse]
+      klass += options[:class] if options[:class]
 
-    content_tag(:span, { class: klass, contenteditable: edit_mode_on?, spellcheck: false,   "data-url" => url}) do
-      (record.send(field_name) || record.try(:key)).to_s.html_safe
-    end
-  end
+      url = phrasing_polymorphic_url(record, attribute)
 
-  alias_method :model_phrase, :inline
-
-  private
+      content_tag(:span, { class: klass, contenteditable: true, spellcheck: false, "data-url" => url }) do
+        (record.send(attribute) || record.try(:key)).to_s.html_safe
+      end
+    end
 
     def phrasing_phrase(key, options = {})
-      key = options[:scope] ? "#{options[:scope]}.#{key}" : key.to_s
-      if can_edit_phrases?
-        @record = PhrasingPhrase.where(key: key, locale: I18n.locale.to_s).first || PhrasingPhrase.search_i18n_and_create_phrase(key)
-        inline(@record, :value, options)
-      else
-        options.try(:[], :interpolation) ? t(key, options[:interpolation]).html_safe : t(key).html_safe
-      end
+      key = options[:scope] ? "#{options[:scope]}.#{key}" : key
+      record = PhrasingPhrase.find_phrase(key)
+      inline(record, :value, options)
     end
 
-    def edit_mode_on?
-      if cookies["editing_mode"].nil?
-        cookies['editing_mode'] = "true"
-        true
+    def uneditable_phrase(record, attribute, options={})
+      record_value = if options[:interpolation]
+        I18n.interpolate(record.send(attribute), options[:interpolation])
       else
-        cookies['editing_mode'] == "true"
+        record.send(attribute)
       end
+      record_value.to_s.html_safe
     end
 
     def phrasing_polymorphic_url(record, attribute)
-      remote_update_phrase_phrasing_phrases_path(klass: record.class.to_s, id: record.id, attribute: attribute)
+      phrasing_phrase_path(klass: record.class.to_s, id: record.id, attribute: attribute)
     end
 
-end
+end

data/app/models/phrasing_phrase.rb

@@ -1,39 +1,45 @@
 class PhrasingPhrase < ActiveRecord::Base
 
   validates_presence_of :key, :locale
+  # validate :uniqueness_of_key_on_locale_scope, on: :create
+  validates_uniqueness_of :key, scope: [:locale]
 
-  validate :uniqueness_of_key_on_locale_scope, on: :create
-
-  has_many :versions, dependent: :destroy, class_name: "PhrasingPhraseVersion"
+  has_many :versions, dependent: :destroy, class_name: PhrasingPhraseVersion
 
   after_update :version_it
 
-  def self.search_i18n_and_create_phrase key
-    begin
-      value = I18n.t key, raise: true
-      PhrasingPhrase.where(key: key, locale: I18n.locale).first
-    rescue I18n::MissingTranslationData
-      create_phrase(key)
-    end
-  end
-
-  def self.create_phrase key, value = nil
-    phrasing_phrase = PhrasingPhrase.new
-    phrasing_phrase.locale = I18n.locale.to_s
-    phrasing_phrase.key = key.to_s
-    phrasing_phrase.value = value || key.to_s
-    phrasing_phrase.save
-    phrasing_phrase
+  def self.find_phrase(key)
+    where(key: key, locale: I18n.locale.to_s).first || search_i18n_and_create_phrase(key)
   end
 
   private
 
+    def self.search_i18n_and_create_phrase(key)
+      begin
+        value = I18n.t(key, raise: true)
+        create_phrase(key, value)
+      rescue I18n::MissingTranslationData
+        create_phrase(key)
+      end
+    end
+
+    def self.create_phrase(key, value=nil)
+      phrasing_phrase = PhrasingPhrase.new
+      phrasing_phrase.locale = I18n.locale.to_s
+      phrasing_phrase.key    = key.to_s
+      phrasing_phrase.value  = value || key.to_s
+      phrasing_phrase.save
+      phrasing_phrase
+    end
+
     def uniqueness_of_key_on_locale_scope
-      errors.add(:key, "Duplicate entry #{key} for locale #{locale}") unless PhrasingPhrase.where(key: key, locale: locale).empty?
+      if PhrasingPhrase.where(key: key, locale: locale).any?
+        errors.add(:key, "Duplicate entry #{key} for locale #{locale}")
+      end
     end
 
     def version_it
-      PhrasingPhraseVersion.create_version(id, value) if value_was != value
+      PhrasingPhraseVersion.create_version(id, value_was) if value_was != value
     end
-    
-end
+
+end

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

@@ -1,4 +1,2 @@
 .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

@@ -1,6 +1,6 @@
 .edit
   %h2= @phrasing_phrase.key
-  = link_to "Delete Phrase", phrasing_phrase_path(@phrasing_phrase), class: "btn btn-danger delete-phrase", method: :delete, data: { confirm: 'Are you sure?' }
+  = link_to "Delete Phrase", phrasing_phrase_path(@phrasing_phrase), class: "btn btn-danger delete-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", class: "btn btn-success submit-edit-phrase"
@@ -20,4 +20,4 @@
           %td.phrasing-version-value= version.value.html_safe
           %td.phrasing-version-created_at= version.created_at.strftime("%d-%m-%Y %H:%M:%S")
           %td= link_to "Revert", phrasing_phrase_path(@phrasing_phrase.id, phrasing_phrase: {value: version.value}), class: "btn btn-success", method: :put
-          %td= link_to "Delete", phrasing_phrase_version_path(version.id), class: "btn btn-danger", method: :delete, data: { confirm: 'Are you sure?' }
+          %td= link_to "Delete", phrasing_phrase_version_path(version.id), class: "btn btn-danger", method: :delete, onclick: "return confirm('Are you sure?');"

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

@@ -8,11 +8,6 @@
     = 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/config/routes.rb

@@ -1,13 +1,15 @@
 Rails.application.routes.draw do
-  resources Phrasing.route, as: 'phrasing_phrases', controller: 'phrasing_phrases', only: [:index, :edit, :update, :destroy] do
+  resources Phrasing.route,
+            as: :phrasing_phrases,
+            controller: :phrasing_phrases,
+            only: [:index, :edit, :update, :destroy] do
     collection do
-      get 'help'
-      get 'import_export'
-      get 'sync'
-      get 'download'
-      post 'upload'
-      put 'remote_update_phrase'
+      get  :help
+      get  :import_export
+      get  :download
+      post :upload
     end
   end
-  resources :phrasing_phrase_versions, as: 'phrasing_phrase_versions', controller: 'phrasing_phrase_versions', only: [:destroy]
-end
+
+  resources :phrasing_phrase_versions, only: :destroy
+end

data/lib/generators/phrasing/phrasing_generator.rb

@@ -0,0 +1,26 @@
+class PhrasingGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_initializer_file
+    initializer_location = "config/initializers/phrasing.rb"
+    copy_file initializer_location, initializer_location
+  end
+
+  def create_helper_file
+    helper_location = "app/helpers/phrasing_helper.rb"
+    copy_file helper_location, helper_location
+  end
+
+  def create_migrations
+    phrasing_phrase_migration = "db/migrate/create_phrasing_phrases.rb"
+    migration_template phrasing_phrase_migration, phrasing_phrase_migration
+    phrase_versions_migration = "db/migrate/create_phrasing_phrase_versions.rb"
+    migration_template phrase_versions_migration, phrase_versions_migration
+  end
+
+  def self.next_migration_number(path)
+    sleep 1 # migration numbers should differentiate
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+end

data/lib/generators/phrasing/templates/app/helpers/phrasing_helper.rb

@@ -0,0 +1,12 @@
+module PhrasingHelper
+  # You must implement the can_edit_phrases? method.
+  # Example:
+  #
+  # def can_edit_phrases?
+  #  current_user.is_admin?
+  # end
+
+  def can_edit_phrases?
+    raise NotImplementedError.new("You must implement the can_edit_phrases? method")
+  end
+end

data/lib/generators/phrasing/templates/config/initializers/phrasing.rb

@@ -0,0 +1,11 @@
+Phrasing.setup do |config|
+  config.route = 'phrasing'
+
+  # List all the model attributes you wish to edit with Phrasing, example:
+  # config.whitelist = ["Post.title", "Post.description"]
+  config.whitelist = []
+
+  # You can whitelist all models, but it's not recommended.
+  # Read here: https://github.com/infinum/phrasing#security
+  config.allow_update_on_all_models_and_attributes = false
+end

data/{db/migrate/20131010101010_create_phrasing_phrase_versions.rb → lib/generators/phrasing/templates/db/migrate/create_phrasing_phrase_versions.rb}

@@ -1,10 +1,10 @@
 class CreatePhrasingPhraseVersions < ActiveRecord::Migration
   def change
-    create_table :phrasing_phrase_versions do |t|    
+    create_table :phrasing_phrase_versions do |t|
       t.integer :phrasing_phrase_id
       t.text :value
       t.timestamps
     end
     add_index :phrasing_phrase_versions, :phrasing_phrase_id
   end
-end
+end