phrasing 2.1.3 → 3.0.0

data/app/controllers/phrasing_phrase_versions_controller.rb

@@ -0,0 +1,9 @@
+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)
+  end
+
+end

data/app/controllers/phrasing_phrases_controller.rb

@@ -16,7 +16,7 @@ class PhrasingPhrasesController < ActionController::Base
         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)
+      @phrasing_phrases = query.where("value is not null").order(:key) + query.where("value is null").order(:key)
     end
     
     @locale_names = PhrasingPhrase.uniq.pluck(:locale)
@@ -53,11 +53,17 @@ class PhrasingPhrasesController < ActionController::Base
   end
 
   def upload
-      PhrasingPhrase.import_yaml(params["file"].tempfile)
-      redirect_to phrasing_phrases_path, notice: "YAML file uploaded successfully!"
+      number_of_changes = PhrasingPhrase.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
       logger.info "\n#{e.class}\n#{e.message}"
-      flash[:alert] = "There was an error processing your upload! ##{e.message}"
+      message = if params[:file].nil?
+        "Please choose a file."
+      else
+        "Please upload a valid YAML file."
+      end
+
+      flash[:alert] = "There was an error processing your upload! #{message}"
       render action: 'import_export', status: 400
   end
 

data/app/helpers/inline_helper.rb

@@ -1,12 +1,17 @@
 module InlineHelper
+# Normal phrase
+# phrase("headline", url: www.infinum.co/yabadaba, inverse: true, interpolation: {min: 15, max: 20})
 
-  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)
+# Data model phrase
+# 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
-      t(key, *args).html_safe
+      record, field_name, options = args[0], args[1], args[2]
+      inline(record, field_name, options || {})
     end
   end
 
@@ -16,18 +21,28 @@ module InlineHelper
     klass = 'phrasable'
     klass += ' phrasable_on' if edit_mode_on?
     klass += ' inverse' if options[:inverse]
+    klass += options[:class] if options[:class]
 
     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
+      (record.send(field_name) || record.try(:key)).to_s.html_safe
     end
-
   end
 
   alias_method :model_phrase, :inline
 
   private
+  
+    def phrasing_phrase(key, options = {})
+      key = key.to_s
+      if can_edit_phrases?
+        @record = PhrasingPhrase.where(key: key).first || PhrasingPhrase.create_phrase(key)
+        inline(@record, :value, options || {})
+      else
+        options.try(:[], :interpolation) ? t(key, options[:interpolation]).html_safe : t(key).html_safe
+      end
+    end
 
     def edit_mode_on?
       if cookies["editing_mode"].nil?
@@ -38,7 +53,6 @@ module InlineHelper
       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}"

data/app/models/phrasing_phrase.rb

@@ -1,20 +1,18 @@
 class PhrasingPhrase < ActiveRecord::Base
 
-  unless ENV['PHRASING_DEBUG']
-    self.logger = Logger.new('/dev/null')
-  end
-
   validates_presence_of :key, :locale
 
-  # These validation methods are used so the YAML file can be exported/imported properly.
-  validate :check_ambiguity, on: :create, :unless => Proc.new { |phrase| phrase.key.nil? }
-  validate :key_muts_not_end_with_a_dot, on: :create, :unless => Proc.new { |phrase| phrase.key.nil? }
+  validate :uniqueness_of_key_on_locale_scope, on: :create
+
+  has_many :versions, dependent: :destroy, class_name: "PhrasingPhraseVersion"
+
+  after_update :version_it
 
   def self.create_phrase(key)
     phrasing_phrase = PhrasingPhrase.new
-    phrasing_phrase.key = key.to_s
-    phrasing_phrase.value = key.to_s.humanize
     phrasing_phrase.locale = I18n.locale
+    phrasing_phrase.key = key.to_s
+    phrasing_phrase.value = key.to_s
     phrasing_phrase.save!
     phrasing_phrase
   end
@@ -22,80 +20,43 @@ class PhrasingPhrase < ActiveRecord::Base
   module Serialize
 
     def import_yaml(yaml)
+      number_of_changes = 0
       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
+        data.each do |key, value|
+          phrase = where(key: key, locale: locale).first || new(key: key, locale: locale)
+          if phrase.value != value
+            phrase.value = value
+            number_of_changes += 1
+            phrase.save
+          end
         end
       end
-      result
+      number_of_changes
     end
 
     def export_yaml
       hash = {}
-      where("value is not null").each do |c|
-        hash_fatten!(hash, [c.locale].concat(c.key.split(".")), c.value)
+      where("value is not null").each do |phrase|
+        hash[phrase.locale] ||= {}
+        hash[phrase.locale][phrase.key] = phrase.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
-            errors.add(:key, "can't be named '#{key}', there already exists a key named '#{stripped_key}'. Ambiguous calling!")
-        end
-      end
+    def uniqueness_of_key_on_locale_scope
+      errors.add(:key, "Duplicate entry #{key} for locale #{locale}") unless PhrasingPhrase.where(key: key).where(locale: locale).empty?
     end
 
-    def check_ambiguity_on_successors
-      key_successor = "#{key}."
-      if PhrasingPhrase.where(PhrasingPhrase.arel_table[:key].matches("#{key_successor}%")).count > 0
-        errors.add(:key, "can't be named '#{key}', there already exists one or multiple keys beginning with '#{key_successor}'. Ambiguous calling!")
+    def version_it
+      if value_was != value
+        PhrasingPhraseVersion.create(phrasing_phrase_id: id,value: value)
       end
     end
-
-    def key_muts_not_end_with_a_dot
-      errors.add(:key, "mustn't end with a dot") if key[-1] == "."
-    end
-
 end

data/app/models/phrasing_phrase_version.rb

@@ -0,0 +1,3 @@
+class PhrasingPhraseVersion < ActiveRecord::Base
+  belongs_to :phrasing_phrase
+end

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

@@ -3,6 +3,7 @@
   %head
     %title Phrasing
     = stylesheet_link_tag "phrasing_engine", :media => "all"
+    = javascript_include_tag "phrasing_engine"
     %meta{:content => "text/html; charset=utf-8", "http-equiv" => "Content-Type"}/
   %body
     #page

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

@@ -1,8 +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
+    %li= link_to "Help", help_phrasing_phrases_path
+    - if root_path
+      %li= link_to "Home page", root_path

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

@@ -1,7 +1,23 @@
 .edit
   %h2= @phrasing_phrase.key
-  = button_to "Delete this item", phrasing_phrase_path(@phrasing_phrase), :method => :delete, :onclick => "return 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"
-  = link_to "Cancel", phrasing_phrases_path
+    = f.submit "Update", class: "btn btn-success submit-edit-phrase"
+  %br
+  - unless @phrasing_phrase.versions.empty?
+    %br
+    %h2 Previous Versions
+    %br
+    %table.phrase-versions
+      %tr
+        %th Value
+        %th Created_at
+        %th
+        %th
+      - @phrasing_phrase.versions.reverse.each do |version|
+        %tr
+          %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, onclick: "return confirm('Are you sure?');"

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

@@ -3,15 +3,18 @@
     - 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'
+    = submit_tag 'Search', class: "btn btn-success"
 - if @phrasing_phrases.any?
-  %table
-    %tr
-      %th Key
-      %th Value
-    - @phrasing_phrases.each do |t|
+  %table.all-phrases
+    %thead
       %tr
-        %td.key
-          = link_to "#{t.key}", edit_phrasing_phrase_path(t)
-        %td.value
-          = t.value.try(:html_safe)
+        %th Key
+        %th Value
+    %tbody
+      - @phrasing_phrases.each do |t|
+        %tr{onclick: "document.location = '/#{Phrasing.route}/#{t.id}/edit'"}
+          %td.key
+            = link_to edit_phrasing_phrase_path(t) do
+              = t.key
+          %td.value
+            = t.value.try(:html_safe)

data/config/routes.rb

@@ -9,4 +9,5 @@ Rails.application.routes.draw do
       put 'remote_update_phrase'
     end
   end
+  resources :phrasing_phrase_versions, :as => 'phrasing_phrase_versions', :controller => 'phrasing_phrase_versions', only: [:destroy]
 end

data/db/migrate/20120313191745_create_phrasing_phrases.rb

@@ -6,6 +6,5 @@ class CreatePhrasingPhrases < ActiveRecord::Migration
       t.text :value
       t.timestamps
     end
-    add_index :phrasing_phrases, [:locale, :key], :unique => true
   end
 end

data/db/migrate/20131010101010_create_phrasing_phrase_versions.rb

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

data/lib/phrasing.rb

@@ -1,6 +1,8 @@
 require 'phrasing'
 require "phrasing/implementation"
 require "phrasing/simple"
+require 'jquery-rails'
+require 'jquery-cookie-rails'
 
 module Phrasing
   module Rails
@@ -8,7 +10,7 @@ module Phrasing
       initializer :assets, :group => :all do
         ::Rails.application.config.assets.paths << ::Rails.root.join('app', 'assets', 'fonts')
         ::Rails.application.config.assets.paths << ::Rails.root.join('app', 'assets', 'images')
-        ::Rails.application.config.assets.precompile += ['editor.js', 'phrasing_engine.css', 'icomoon.dev.svg', 'icomoon.svg', 'icomoon.eot', 'icomoon.ttf', 'icomoon.woff', 'phrasing_information_icon.png']
+        ::Rails.application.config.assets.precompile += ['editor.js', 'phrasing_engine.css', 'phrasing_engine.js', 'icomoon.dev.svg', 'icomoon.svg', 'icomoon.eot', 'icomoon.ttf', 'icomoon.woff', 'phrasing_information_icon.png']
       end
     end
   end

data/lib/phrasing/implementation.rb

@@ -11,7 +11,11 @@ module Phrasing
 
       value = super(locale, key, scope, options)
       if value.is_a?(String) || value.nil?
-        PhrasingPhrase.create(locale: locale.to_s, key: scoped_key, value: value)
+        phrasing_phrase = PhrasingPhrase.new
+        phrasing_phrase.locale = locale.to_s
+        phrasing_phrase.key = scoped_key
+        phrasing_phrase.value = value
+        phrasing_phrase.save
       end
       value
     end

data/lib/phrasing/version.rb

@@ -1,3 +1,3 @@
 module Phrasing
-  VERSION = "2.1.3"
+  VERSION = "3.0.0"
 end

data/lib/tasks/phrasing_tasks.rake

@@ -3,14 +3,17 @@ namespace :phrasing do
   task :install do
     Rake::Task["phrasing_rails_engine:install:migrations"].invoke
     Rake::Task["phrasing:install_initializer"].invoke
-    Rake::Task["phrasing:phrasable_creator"].invoke
+    Rake::Task["phrasing:install_phrasing_helper"].invoke
   end
 
   desc "Create the initializer file"
   task :install_initializer do
     filepath = Rails.root.join *%w(config initializers phrasing.rb)
-    File.open(filepath, 'w') do |f|
-      f << <<-CONFIG
+    if File.exists?(filepath)
+      alert "Phrasing config file already exists.\n"
+    else
+      File.open(filepath, 'w') do |f|
+        f << <<-CONFIG
 Phrasing.setup do |config|
   config.route = 'phrasing'
 end
@@ -20,17 +23,21 @@ end
 Phrasing.whitelist = []
 # Phrasing.allow_update_on_all_models_and_attributes = true;
 CONFIG
+      end
+      notice("created")
+      puts " config/intiializers/phrasing.rb"
     end
-    greenify("You can change the default route and whitelist editable attributes in the phrasing initializer created in the config/intiializers folder.")
   end
 
 
   desc "Create the PhrasingHelper file"
-  task :phrasable_creator do
+  task :install_phrasing_helper do
     filepath = Rails.root.join *%w(app helpers phrasing_helper.rb)
-
-    File.open(filepath, 'w') do |f|
-      f << <<-MODULE 
+    if File.exists?(filepath)
+      alert "Phrasing helper file already exists.\n"
+    else    
+      File.open(filepath, 'w') do |f|
+        f << <<-MODULE 
 module PhrasingHelper
   # You must implement the can_edit_phrases? method.
   # Example:
@@ -44,14 +51,20 @@ module PhrasingHelper
   end
 end
       MODULE
-    end
-    greenify("A PhrasingHelper has been created in your app/helper folder. Please implement the can_edit_phrases? method.")
-    greenify("Now run 'rake db:migrate'.")
+      end
+      notice("created")
+      puts " app/helpers/phrasing_helper.rb" 
+      notice "Now run 'rake db:migrate'.\n"
+    end 
   end
 
 
 end
 
-def greenify(text)
-  puts "\033[#{32}m#{text}\033[0m"
+def notice(text)
+  print "\033[#{32}m#{text}\033[0m"
+end
+
+def alert(text)
+  print "\033[#{31}m#{text}\033[0m"
 end