phrasing 3.2.10 → 4.0.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c4d9f1a1afdcb5aeadf72bdd9582d062a9a2ab0
-  data.tar.gz: d43f499b114f068bea2f8bb1566dae2357e8a110
+  metadata.gz: 75aa378d3f0142b6218e526c92f6774dea7fdab4
+  data.tar.gz: 44392541b00771fd8ace7a7e8a2997cc5742139d
 SHA512:
-  metadata.gz: c981b81e3069c339740450619dcfdf72125fd2b9944f55ca83928da625ad066efdedbe1162a930ff8837b0aeaf26bfc152d8addee10fb60d531bd7693534fea3
-  data.tar.gz: 2e56e2910c3009017daf98ad51371a88957052f0333e6ae55108456b99b2e7c36bb86b9313c4eaed790c8e48a2bd798d59b444cbb48ee0b1731050dd9e951895
+  metadata.gz: 3ff1aa31583ef783238cac57b9c601a0d57c2a0a52ccc38696c2239c5619f6a7470dbfcd5219ce99f9ebe0255e995dc95e5f29aaf1448efd2abd926d62e34893
+  data.tar.gz: 8c4a00598712079d7a1c7d99ba8898a1510ba916d2494da18409bcbe0bbdcfcf65511bbc8d1d225b27045af0fe0c690f6feaf85e715a7c06f06b4579c768c852

data/.travis.yml

@@ -1,12 +1,9 @@
 language: ruby
-
-matrix:
-  include:
-    - rvm: 1.9.3
-      env: "RAILS_VERSION=3.2.0"
-    - rvm: 2.0.0
-      env: "RAILS_VERSION=4.0.0"
-    - rvm: 2.1.2
-      env: "RAILS_VERSION=4.1.0"
-    - rvm: 2.2.0
-      env: "RAILS_VERSION=4.2.0"
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+env:
+  - "RAILS_VERSION=3.2.0"
+  - "RAILS_VERSION=4.0.0"
+  - "RAILS_VERSION=4.1.0"

data/CHANGELOG.md

@@ -1,25 +1,5 @@
 # Phrasing Change Log
 
-## 3.2.10 (October 2nd, 2015)
-
-Change order parameters in PhrasingPhrases#index to support SQLServer.
-
-## 3.2.9 (January 7th, 2015)
-
-Require only haml, not haml-rails.
-
-## 3.2.8 (January 6th, 2015)
-
-Fix confirm dialogs when deleting phrases and phrase versions.
-
-## 3.2.7 (October 3rd, 2014)
-
-Add a config option to set a parent controller to Phrasing Engine Controllers.
-
-## 3.2.6 (September 15th, 2014)
-
-Show Home page only when view responds to :root_path.
-
 ## 3.2.5 (June 17th, 2014)
 
 Added index for phrasing_phrase_id in versions table.

data/Gemfile

@@ -8,7 +8,10 @@ rails_version = ENV["RAILS_VERSION"] || "4.1.4"
 gem "rails", "~> #{rails_version}"
 
 gem 'factory_girl_rails'
+gem 'haml-rails'
 gem 'sqlite3'
 gem 'rspec-rails'
-gem 'capybara', '~> 2.2.0'
+gem 'capybara', '~> 2.3.0'
 gem 'jasmine-rails'
+gem 'pry-rails'
+gem 'sass', '3.4.0'

data/README-3.md

@@ -0,0 +1,134 @@
+# Phrasing!
+
+[![Build Status](https://travis-ci.org/infinum/phrasing.png)](https://travis-ci.org/infinum/phrasing)
+
+![Phrasing](http://www.miataturbo.net/attachments/miata-parts-sale-trade-5/74257-lots-leftovers-near-boston-archer-phrasing2-300x225-jpg?dateline=1366600534)
+
+Phrasing is a gem for live editing phrases (copy) on websites.
+
+## Installation
+
+Include the gem in your Gemfile
+
+```ruby
+gem "phrasing"
+```
+
+Bundle the Gemfile
+
+```ruby
+bundle install
+```
+
+Run the install script which will create a migration file and a config file.
+
+```ruby
+rake phrasing:install
+```
+
+Migrate your database
+```ruby
+rake db:migrate
+```
+
+## Setup
+
+The rake task will also generate <tt>phrasing_helper.rb</tt> in your <tt>app/helpers</tt> folder. Here you will need to implement the <tt>can_edit_phrases?</tt> method. Use this to hook-up your existing user authentication system to work with Phrasing.
+
+For example:
+
+```ruby
+module PhrasingHelper
+
+  def can_edit_phrases?
+    current_user.is_admin?
+  end
+
+end
+```
+Include the phrasing **html** initializer at the top of your application layout file.
+
+```haml
+= render 'phrasing/initializer'
+```
+
+Include the required **javascript** file:
+
+```javascript
+//= require phrasing
+```
+
+Include the required **stylesheet** file:
+
+```css
+*= require phrasing
+```
+
+## How to use phrasing?
+
+You can start adding new phrases by simply adding them in your view file:
+
+  = phrase('my-first-phrase')
+
+Aside from editing phrases (basically, Rails translations) you can also edit model attributes inline. Use the same `phrase` method, with the first attribute being the record in question, and the second one the attribute you wish to make editable:
+
+    = phrase(@post, :title)
+
+In the above example, <tt>@post</tt> is the record with a <tt>title</tt> attribute.
+
+## Security
+
+Since Phrasing can be used to update any attribute in any table (using the model_phrase method), special care must be taken into consideration from a security standpoint.
+
+By default, Phrasing doesn't allow updating of any attribute apart from <tt>PhrasingPhrase.value</tt>. To be able to work with other attributes, you need to whitelist them.
+
+In the <tt>config/initializers/phrasing.rb</tt> file you can whitelist your model attributes like this:
+
+```ruby
+Phrasing.white_list = ["Post.title", "Post.body"]
+```
+
+or you can whitelist all of them (not recommended) with:
+
+```ruby
+Phrasing.allow_update_on_all_models_and_attributes = true
+```
+
+## Upgrading from version 2.x to 3.x
+
+In versions 3.0.0 and above we have added the Phrasing Versioning System which requires an additional table, so if you are upgrading to a 3.x release, run <tt>rake phrasing:install</tt> to get the additional migration file, then run <tt>rake db:migrate</tt>.
+
+## Turbolinks
+
+If you're experiencing problems with Rails apps using Turbolinks, include the [jQuery-turbolinks](https://github.com/kossnocorp/jquery.turbolinks) gem in your application and simply require it in the following order:
+
+```javascript
+//= require jquery
+//= require jquery.turbolinks
+//= require phrasing
+//= require turbolinks
+```
+
+## Phrasing Appearance
+
+The `phrase` view helper can take the `options` hash as the last parameter. Features:
+```ruby
+url: custom_url # point Phrasing to other actions in other controllers
+inverse: true # change the hovered background and underline colors to better fit darker backgrounds
+class: custom_class # add custom CSS classes to your phrases to change the appearance of phrases in your application
+interpolation: { %min: 10 } # add variables to your translations just like w/ I18n
+scope: 'homepage.footer' # add scopes just like you would w/ I18.n. If the first argument is 'test', than the key would be 'homepage.footer.test'
+```
+
+## Credits
+
+Phrasing is maintained and sponsored by
+[Infinum] (http://www.infinum.co).
+
+![Infinum](https://www.infinum.co/assets/logo_pic-2e19713f50692ed9b0805b199676c19a.png)
+
+Phrasing leverages parts of [Copycat](https://github.com/Zorros/copycat) and [ZenPen](https://github.com/tholman/zenpen/tree/master/).
+
+## License
+
+Phrasing is Copyright © 2013 Infinum. It is free software, and may be redistributed under the terms specified in the LICENSE file.

data/README.md

@@ -6,7 +6,7 @@
 
 Phrasing is a gem for live editing phrases (copy) on websites.
 
-**Phrasing is currently iterating over release candidates for a major update: 4.0. The Readme for those versions can be found** [here](https://github.com/infinum/phrasing/tree/new-release-4)
+**Notice:** If using Phrasing version 3, checkout the [old README](https://github.com/infinum/phrasing/blob/new-release-4/README-3.md).
 
 ## Installation
 
@@ -18,18 +18,18 @@ gem "phrasing"
 
 Bundle the Gemfile
 
-```ruby
+```shell
 bundle install
 ```
 
 Run the install script which will create a migration file and a config file.
 
-```ruby
-rake phrasing:install
+```shell
+rails generate phrasing
 ```
 
 Migrate your database
-```ruby
+```shell
 rake db:migrate
 ```
 
@@ -45,7 +45,7 @@ module PhrasingHelper
   def can_edit_phrases?
     current_user.is_admin?
   end
-  
+
 end
 ```
 Include the phrasing **html** initializer at the top of your application layout file.
@@ -54,7 +54,7 @@ Include the phrasing **html** initializer at the top of your application layout
 = render 'phrasing/initializer'
 ```
 
-Include the required **javascript** file:
+Include the required **javascript** files:
 
 ```javascript
 //= require phrasing
@@ -87,19 +87,15 @@ By default, Phrasing doesn't allow updating of any attribute apart from <tt>Phra
 In the <tt>config/initializers/phrasing.rb</tt> file you can whitelist your model attributes like this:
 
 ```ruby
-Phrasing.white_list = ["Post.title", "Post.body"]
+config.white_list = ["Post.title", "Post.body"]
 ```
 
 or you can whitelist all of them (not recommended) with:
 
 ```ruby
-Phrasing.allow_update_on_all_models_and_attributes = true
+config.allow_update_on_all_models_and_attributes = true
 ```
 
-## Upgrading from version 2.x to 3.x
-
-In versions 3.0.0 and above we have added the Phrasing Versioning System which requires an additional table, so if you are upgrading to a 3.x release, run <tt>rake phrasing:install</tt> to get the additional migration file, then run <tt>rake db:migrate</tt>.
-
 ## Turbolinks
 
 If you're experiencing problems with Rails apps using Turbolinks, include the [jQuery-turbolinks](https://github.com/kossnocorp/jquery.turbolinks) gem in your application and simply require it in the following order:
@@ -117,7 +113,7 @@ The `phrase` view helper can take the `options` hash as the last parameter. Feat
 ```ruby
 url: custom_url # point Phrasing to other actions in other controllers
 inverse: true # change the hovered background and underline colors to better fit darker backgrounds
-class: custom_class # add custom CSS classes to your phrases to change the appearance of phrases in your application 
+class: custom_class # add custom CSS classes to your phrases to change the appearance of phrases in your application
 interpolation: { %min: 10 } # add variables to your translations just like w/ I18n
 scope: 'homepage.footer' # add scopes just like you would w/ I18.n. If the first argument is 'test', than the key would be 'homepage.footer.test'
 ```

data/Release_notes_version_4.md

@@ -0,0 +1,26 @@
+# Changes
+
+This document contains instructions for upgrading from Phrasing version 3 to Phrasing version 4.
+
+## Separation of I18n and Phrasing:
+
+Phrasing no longer does monkeypatching over the I18n gem, so the I18n and Phrasings behaviors are completely separate.
+When using the I18n.t() method, Phrasing will no longer copy the data from the translations file and continue to use translations from the database.
+
+However, when using the phrase(key) method, if the key doesn't currently exist in the PhrasingPhrase table, it will do a lookup in the translations file and copy the data from there to the database.
+
+## Interpolation
+
+Try not to use the interpolation option anymore since it will probably be kicked out in the first stable release.
+
+The problem with the interpolation option is that most clients won't understand what's happening when they see something like "Hi, my name is %{name}" once they are editing data.
+
+If they try to erase parts of it, the developer also might end up being confused and the UI might get broken or at least ugly for some time until the developer fixes the issue.
+
+## HTML Sanitization
+
+There is a posibility we might add html sanitization to prevent ugly copy-pasted html insertion (as well as XSS attacks).
+
+## Switching rake tasks with Rails generators
+
+Since Rails comes with outofbox generators that enable easy existing file detection and similar behaviors, Phrasing 4 will use Rails generators instead of the old rake tasks.

data/app/assets/javascripts/phrasing.js.erb

@@ -3,7 +3,30 @@
 //= require jquery_ujs
 //= require jquery.cookie
 
+function StatusBubble(){
+  var $headline = $('#phrasing-edit-mode-bubble #phrasing-saved-status-headline p');
+  var $circle = $('#phrasing-saved-status-indicator-circle');
+
+  var alterStatus = function(text, color){
+    $headline.text(text);
+    $circle.css('background-color', color);
+  }
+
+  this.saving = function(){
+    alterStatus('Saving', 'orange');
+  }
+
+  this.saved = function(){
+    alterStatus('Saved', '#56AE45');
+  }
+
+  this.error = function(){
+    alterStatus('Error', 'red');
+  }
+}
+
 var phrasing_setup = function(){
+  var status = new StatusBubble();
 
   // Initialize the editing bubble
   editor.init();
@@ -27,17 +50,15 @@ var phrasing_setup = function(){
   var timer_status = {}
 
   $('.phrasable').on('DOMNodeInserted DOMNodeRemoved DOMCharacterDataModified', function(e){
+    status.saving();
 
-    $('#phrasing-edit-mode-bubble #phrasing-saved-status-headline p').text("Saving")
-    $('#phrasing-saved-status-indicator-circle').css('background-color', 'orange')
-    
     if (trigger_binded_events_for_phrasable_class == 1){
 
       var record = this;
-      
+
       clearTimeout(timer[$(record).data("url")]);
       timer_status[$(record).data("url")] = 0;
-      
+
       timer[$(record).data("url")] = setTimeout(function(){
         savePhraseViaAjax(record);
         delete timer_status[$(record).data("url")]
@@ -49,13 +70,13 @@ var phrasing_setup = function(){
 
   // AJAX Request
   function savePhraseViaAjax(record){
-    
+
     var url = $(record).data("url");
 
     var content = record.innerHTML;
-    
+
     if(content.length == 0){
-      content= "Empty"
+      content = "Empty"
     }
 
     $.ajax({
@@ -64,21 +85,20 @@ var phrasing_setup = function(){
       data: { new_value: content },
       success: function(e){
         trigger_binded_events_for_phrasable_class = 0;
-        if(content == "Empty"){
+        if(content === "Empty"){
           $('span.phrasable[data-url="'+ url +'"]').html(content)
         }else{
+          // Not to lose the cursor on the current contenteditable element
           $('span.phrasable[data-url="'+ url +'"]').not(record).html(content)
         }
         trigger_binded_events_for_phrasable_class = 1;
 
         if (Object.size(timer_status) == 0){
-          $('#phrasing-edit-mode-bubble #phrasing-saved-status-headline p').text("Saved")
-          $('#phrasing-saved-status-indicator-circle').css('background-color', '#56AE45')
+          status.saved();
         }
       },
       error: function(e){
-        $('#phrasing-edit-mode-bubble #phrasing-saved-status-headline p').text("Error")
-        $('#phrasing-saved-status-indicator-circle').css('background-color', 'red')
+        status.error();
       }
     });
   }
@@ -95,14 +115,14 @@ var phrasing_setup = function(){
     }
   });
 
-  if($.cookie("editing_mode") == null){
+  if($.cookie("editing_mode") === null){
     $.cookie("editing_mode", "true");
-    $('#edit-mode-onoffswitch').prop('checked', true)
+    $('#edit-mode-onoffswitch').prop('checked', true).change();
   }
   else if($.cookie("editing_mode") == "true"){
-    $('#edit-mode-onoffswitch').prop('checked', true)
+    $('#edit-mode-onoffswitch').prop('checked', true).change();
   }else{
-    $('#edit-mode-onoffswitch').prop('checked', false)
+    $('#edit-mode-onoffswitch').prop('checked', false).change();
   }
 
 };

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

@@ -23,7 +23,7 @@
   p{
     line-height:20px;
   }
-  ::selection{ color: grey;  background: white; } 
+  ::selection{ color: grey;  background: white; }
 
   #phrasing-edit-mode, #phrasing-saved-status, #phrasing-edit-all-phrases{
     height:32px;
@@ -81,7 +81,7 @@
       border: 3px solid #CCCCCC; border-radius: 5px;
       position: absolute; top: 0; bottom: 0; right: 29px;
       -moz-transition: all 0.3s ease-in 0s; -webkit-transition: all 0.3s ease-in 0s;
-      -o-transition: all 0.3s ease-in 0s; transition: all 0.3s ease-in 0s; 
+      -o-transition: all 0.3s ease-in 0s; transition: all 0.3s ease-in 0s;
       background-image: -moz-linear-gradient(center top, rgba(0,0,0,0.1) 0%, rgba(0,0,0,0) 100%);
       background-image: -webkit-linear-gradient(center top, rgba(0,0,0,0.1) 0%, rgba(0,0,0,0) 100%);
       background-image: -o-linear-gradient(center top, rgba(0,0,0,0.1) 0%, rgba(0,0,0,0) 100%);
@@ -112,7 +112,7 @@
     float:left;
   }
   #phrasing-saved-status-indicator-circle{
-    background-color:green;
+    background-color: #56AE45;
     width:20px;
     height:20px;
     -webkit-border-radius: 10px;