x-editable-rails 1.5.1 → 1.5.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f211902f307559fafdeb55542265063b6aed1b74
-  data.tar.gz: b01c23c18a006cd2079bf562621df7774830942c
+  metadata.gz: fee9739c77324495b6e7a6227d85fdb2f77c972b
+  data.tar.gz: fd6565d1908e346778674f1f42f95f235c335f01
 SHA512:
-  metadata.gz: 9fe4a918b0d2e3da58d6105c8646f757780855011bd347c814d3b7b073abb6d6e40b77d52dc7dde206fb7d3d61b1d792b28ddc9521605ceeac297c4e8fd90842
-  data.tar.gz: da69e8902b82d4f9fe578e02a9bb2f2e8b17598a346168b198cd2dc57f8cac572406bdf90436a6f15290c490bbd9f2b547943fc35000b46f661fa2aa8d4c21fa
+  metadata.gz: 5d3c95a332e7da5252af57f86fb0ae39d171566d7f616b09f9d691073fbd1051e64b53e35ff9f13dbd124f57b55901e2a2cbc3295451749f1a2997627b55ff05
+  data.tar.gz: d43ebe0f3957a31e1c8c6476494f869f37bd456af8878d4993363130de8b41795df1dd9012ed1948e32c1ba74fdad34af06085062a03a4e46368d0b703a6740a

data/README.md

@@ -1,7 +1,13 @@
 # X::Editable::Rails
 
+[![Build Status](https://travis-ci.org/werein/x-editable-rails.svg)](https://travis-ci.org/werein/x-editable-rails)  [![Code Climate](https://codeclimate.com/github/werein/x-editable-rails/badges/gpa.svg)](https://codeclimate.com/github/werein/x-editable-rails) [![Test coverage](https://codeclimate.com/github/werein/x-editable-rails/badges/coverage.svg)](https://codeclimate.com/github/werein/x-editable-rails) [![Version](https://badge.fury.io/rb/x-editable-rails.svg)](https://badge.fury.io/rb/x-editable-rails) [![Dependencies](https://gemnasium.com/werein/x-editable-rails.svg)](https://gemnasium.com/werein/x-editable-rails)
+
 X-editable for Rails
 
+## Live demo
+
+Checkout live demo [here](https://x-editable-rails.herokuapp.com/?denied=true) 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -75,8 +81,8 @@ And related stylesheets:
 
 ### Making Things Editable
 
-`x-editable-rails` provides a helper method in your view to make your model values editable. 
-By default, you need to specify the model and property that should be editable. 
+`x-editable-rails` provides a helper method in your view to make your model values editable.
+By default, you need to specify the model and property that should be editable.
 A `span` element is rendered with `data-*` attributes used by `x-editable`.
 
 ```ruby
@@ -120,7 +126,7 @@ classes = { "Active" => "label-success", "Disabled" => "label-default" }
 editable @model, :enabled, source: source, classes: classes, class: "label"
 ```
 
-* **nested** - Name of a nested attributes (such as [gobalize](https://github.com/globalize/globalize)'s `translations`)
+* **nested** - Name of a nested attributes (such as [globalize](https://github.com/globalize/globalize)'s `translations`)
 * **nid** - ID of the nested attribute
 
 ```ruby
@@ -135,18 +141,16 @@ editable @model, :enabled, source: source, classes: classes, class: "label"
 Add a helper method to your controllers to indicate if `x-editable` should be enabled.
 
 ```ruby
-def xeditable?
+def xeditable? object = nil
   true # Or something like current_user.xeditable?
 end
 ```
 
-This gem requires [CanCan](https://github.com/ryanb/cancan) and checks the `:edit` permission for the model being edited.
+You can use [CanCan](https://github.com/ryanb/cancan) and checks the `:edit` permission for the model being edited.
 
 ```ruby
-if xeditable? && can?(:edit, model)
-  ... output x-editable HTML ...
-else
-  ... output uneditable value ...
+def xeditable? object = nil
+  can?(:edit, object) ? true : false
 end
 ```
 
@@ -154,14 +158,14 @@ end
 
 ### "Don't Repeat Yourself" Templates
 
-To make your views cleaner, you can specify all your options for each class and attribute in a YAML configuration file. 
+To make your views cleaner, you can specify all your options for each class and attribute in a YAML configuration file.
 Attributes where the `title` or `placeholder` are not different except maybe capitalized can be left out because they are automatically capitalized when rendered (see above).
 
-This example uses the `MailingList` class and its attributes. 
-The attribute value can be a string, which is used as the `title` and `placeholder`. 
+This example uses the `MailingList` class and its attributes.
+The attribute value can be a string, which is used as the `title` and `placeholder`.
 If you want to specify other options, create a hash of options.
 
-Install configuration file like this: `rails g x_editable_rails:install`, this step is not necessary 
+Install configuration file like this: `rails g x_editable_rails:install`, this step is not necessary
 
 ```yaml
 class_options:

data/lib/x-editable-rails/version.rb

@@ -1,7 +1,7 @@
 module X
   module Editable
     module Rails
-      VERSION = "1.5.1"
+      VERSION = "1.5.5.1"
     end
   end
-end
+end

data/lib/x-editable-rails/view_helpers.rb

@@ -1,3 +1,5 @@
+require 'base64'
+
 module X
   module Editable
     module Rails
@@ -16,63 +18,86 @@ module X
         #       - enumerable shorthand ['Yes', 'No', 'Maybe'] becomes { 'Yes' => 'Yes', 'No' => 'No', 'Maybe' => 'Maybe' }
         #     classes: a Hash of classes to add based on the value (same format and shorthands as source)
         #   value: override the object's value
-        #   
+        #
         def editable(object, method, options = {})
           options = Configuration.method_options_for(object, method).deep_merge(options).with_indifferent_access
           # merge data attributes for backwards-compatibility
           options.merge! options.delete(:data){ Hash.new }
-          
+
           url     = options.delete(:url){ polymorphic_path(object) }
           object  = object.last if object.kind_of?(Array)
           value   = options.delete(:value){ object.send(method) }
           source  = options[:source] ? format_source(options.delete(:source), value) : default_source_for(value)
           classes = format_source(options.delete(:classes), value)
           error   = options.delete(:e)
-          
-          if xeditable? and can?(:edit, object)
-            model   = object.class.name.split('::').last.underscore
+          html_options = options.delete(:html){ Hash.new }
+
+          if xeditable?(object)
+            model   = object.class.model_name.param_key
             nid     = options.delete(:nid)
             nested  = options.delete(:nested)
             title   = options.delete(:title) do
-              klass = nested ? object.class.const_get(nested.to_s.singularize.capitalize) : object.class
+              klass = nested ? object.class.const_get(nested.to_s.classify) : object.class
               klass.human_attribute_name(method)
             end
-            
+
             output_value = output_value_for(value)
-            css_list = options.delete(:class).to_s.split(/s+/).unshift('editable')
+            css_list = options.delete(:class).to_s.split(/\s+/).unshift('editable')
             css_list << classes[output_value] if classes
-            
+            type = options.delete(:type){ default_type_for(value) }
             css   = css_list.compact.uniq.join(' ')
             tag   = options.delete(:tag){ 'span' }
             placeholder = options.delete(:placeholder){ title }
-            
+
             # any remaining options become data attributes
             data  = {
-              type:   options.delete(:type){ default_type_for(value) }, 
-              model:  model, 
-              name:   method, 
-              value:  output_value, 
-              placeholder: placeholder, 
-              classes: classes, 
-              source: source, 
-              url:    url, 
-              nested: nested, 
+              type:   type,
+              model:  model,
+              name:   method,
+              value:  ( type == 'wysihtml5' ? Base64.encode64(output_value) : output_value ), 
+              placeholder: placeholder,
+              classes: classes,
+              source: source,
+              url:    url,
+              nested: nested,
               nid:    nid
-            }.merge(options)
-            
+            }.merge(options.symbolize_keys)
+
             data.reject!{|_, value| value.nil?}
-            
-            content_tag tag, class: css, title: title, data: data do
-              source_values_for(value, source).join('<br/>').html_safe
+
+            html_options.update({
+              class: css,
+              title: title,
+              data: data
+            })
+
+            content_tag tag, html_options do
+              if %w(select checklist).include?(data[:type].to_s) && !source.is_a?(String)
+                source = normalize_source(source)
+                content = source.detect { |t| output_value == output_value_for(t[0]) }
+                content.present? ? content[1] : ""
+              else
+                safe_join(source_values_for(value, source), tag(:br))
+              end
             end
           else
-            # create a friendly value using the source to display a default value (if no error message given)
-            error || source_values_for(value, source).join('<br/>').html_safe
+            error || safe_join(source_values_for(value, source), tag(:br))
           end
         end
-        
+
         private
-        
+
+        def normalize_source(source)
+          return [] unless source
+          source.map do |el|
+            if el.is_a? Array
+              el
+            else
+              [el[:value], el[:text]]
+            end
+          end
+        end
+
         def output_value_for(value)
           value = case value
           when TrueClass
@@ -86,22 +111,22 @@ module X
           else
             value.to_s
           end
-          
-          value.html_safe
+
+          value
         end
-        
+
         def source_values_for(value, source = nil)
           source ||= default_source_for value
-          
+
           values = Array.wrap(value)
-          
-          if source
+
+          if source && ( source.first.is_a?(String) || source.kind_of?(Hash) )
             values.map{|item| source[output_value_for item]}
           else
             values
           end
         end
-        
+
         def default_type_for(value)
           case value
           when TrueClass, FalseClass
@@ -112,14 +137,14 @@ module X
             'text'
           end
         end
-        
+
         def default_source_for(value)
           case value
           when TrueClass, FalseClass
             { '1' => 'Yes', '0' => 'No' }
           end
         end
-        
+
         # helper method that take some shorthand source definitions and reformats them
         def format_source(source, value)
           formatted_source = case value
@@ -127,15 +152,15 @@ module X
               if source.is_a?(Array) && source.first.is_a?(String) && source.size == 2
                 { '1' => source[0], '0' => source[1] }
               end
-            when String
+            else
               if source.is_a?(Array) && source.first.is_a?(String)
-                source.inject({}){|hash, key| hash.merge(key => key)}
+                source.map { |v| { value: v, text: v } }
               end
             end
-          
+
           formatted_source || source
         end
-        
+
       end
     end
   end