hallo_rails 0.0.3 → 0.0.4

data/README.md

@@ -1,6 +1,6 @@
 # HalloRails
 
-Full readme coming soon...
+Use the Hallo Editor (https://github.com/bergie/hallo) to edit content in place in your Rails app.
 
 ## Installation
 
@@ -12,13 +12,50 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Add this to your javascript manifest file:
 
-    $ gem install hallo_rails
+    //= require rangy-core
+    //= require hallo
+    //= require hallo_rails
 
-## Usage
+## Requirements
 
-TODO: Write usage instructions here
+jQuery and jQuery UI. A good way of including jQuery UI in your rails app is using the jquery-ui-rails gem.
+
+## Basic Usage
+
+Hallo Rails provides 2 view helpers to make Rails model fields editable.
+Say you have an article model with a field 'content'. Outside a form use:
+
+    = editable @article, :content
+
+Within a form use 
+
+    = form_editable @article, :content
+
+And make sure to call 
+
+    HalloRails.init() after the dom has loaded, e.g. like:
+
+    jQuery ->
+      HalloRails.init()
+
+Hallo Rails will save edited content each time the editable area is left, using the default rails url for updating models:
+
+    "#{object_name.pluralize}/#{object.to_param}" 
+
+For the article example this could be for example: "articles/24".
+
+You can change this url by supplying it to the editable helper:
+
+    = editable @article, :content, update_url: "my_own/url/to_update/the/model"
+
+If you use the form_editable helper, the content is only saved once the form is submitted.
+
+
+## Advanced usage
+
+Check the source code ;-)   (for now)
 
 ## Contributing
 

data/lib/hallo_rails/version.rb

@@ -1,3 +1,3 @@
 module HalloRails
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/hallo_rails.rb

@@ -20,13 +20,17 @@ module HalloRails
       object_name = object.class.to_s.underscore
       options.reverse_merge! tag: :div,
                              content: object.send(method).try(:html_safe),
-                             update_url: "#{locale_prefix}/#{object_name.pluralize}/#{object.to_param}",
+                             update_url: "#{object_name.pluralize}/#{object.to_param}",
                              blank_text: "<i>Click to Edit</i>".html_safe
 
       content_tag options[:tag], options[:content].present? ? options[:content] : options[:blank_text],
                   class: "#{'editable' if !options.has_key?(:editable) or options[:editable]}",
                   id: "#{object_name}_#{method.to_s}",
-                  data: { update_url: options[:update_url], model: object_name, method: method.to_s }.merge(options[:params] || {})
+                  data: { update_url: options[:update_url],
+                          model: object_name,
+                          method: method.to_s,
+                          editable_options: options[:hallo_options],
+                          editable_plugins: options[:plugins] }.merge(options[:params] || {})
     end
 
 
@@ -39,7 +43,10 @@ module HalloRails
       content_tag( options[:tag], options[:content].present? ? options[:content] : options[:blank_text],
                    class: 'form_editable',
                    id: "#{object_name}_#{method.to_s}",
-                   data: { model: object_name, method: method.to_s }.merge(options[:params] || {})) +
+                   data: { model: object_name,
+                           method: method.to_s,
+                           editable_options: options[:hallo_options],
+                           editable_plugins: options[:plugins] }.merge(options[:params] || {})) +
         text_area_tag( "#{object_name}[#{method}]", options[:content], style: "display:none" )
     end
 

data/vendor/assets/javascripts/hallo_rails.js.coffee

@@ -9,6 +9,7 @@ default_plugins =
   hallolink: {}
   halloreundo: {}
   hallohtml: {}
+  'hallo-image-insert-edit': {}
 
 init = ->
   $('.editable, .form_editable').each ->

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hallo_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -59,7 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2819323486405819656
+      hash: 4399511932397100775
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2819323486405819656
+      hash: 4399511932397100775
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24