quill-rails 0.1.1 → 0.1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjlhMmRkMDFlNzFmNWZhMjc5YTQ5NTBmOGQ4YzU5YjM4MDk2NWQ1YQ==
+    M2VhOTUxMDI0MGU0MWZhYjZhODJjNjUzNDFkNzVjYjE4ZmVlZDhkOA==
   data.tar.gz: !binary |-
-    ZWJlYmYyZTQwZjY1Y2QwMGI4YzI0ZWViYjc0M2NlNmQwZWM5ZjcwMA==
+    YTdiOTRjMmQ4ZWJlZWY1YjI2NTA1MDQ0YzVmYjE0NzcyZGNiOGMwZQ==
 SHA512:
   metadata.gz: !binary |-
-    MDQ4ZTYzMWRlYmVkMzVhYWZhNjRmZWE2NmZlODU3NGVhYTBmNjYyZGRhZDQw
-    Y2I3M2ViZDNhMTAxYmJmODY4YWVmMDM0OTFkMDE0ODYwNmM0YmVhMmQ1ZmJl
-    NTZkYWM4MzU0ZTdhYTlmN2E4ZGE5OTdlYTQxNTE2YmRmNDQ2NWQ=
+    ZDExZDA2YjJmNDNhZjM1NmVlNDk4ODVhMTg0ODY0NzZlYTdlYmJmMmY5MDRi
+    OWVlZWExODA0MzZhZWJhZDhjMGZmMmU3NzRlMzhjNDQ5NmZkYTU3NjhjOTZm
+    OGExNTA2NWMzNjc5NmQ5NmFhMjI0OThlNTc0MGY1NDQ1ZDRjOTE=
   data.tar.gz: !binary |-
-    NmQ0ZWMxOGRmNTE3YzNhN2NiMGU0ODc0MmU0YzJjMjFiZjE4ZGM5N2RlNzZl
-    YjM5ZTYyYWM5MDBhMjkyNTZlN2JkMThmZDZlNmY5NzVlNjBhNGVmMzM2NGFl
-    ZDMzODAwODRkZWJhYmY3NzE2ZDM1N2U5ZTY0NWQ5ODkwMWIwMGM=
+    NzQzMzIyMTdkM2E1NmNlODk2MmY0ZGJiNzc5YmQ4YjRiZDBmNGUxODgwMzJi
+    MTYyY2FhYjc5NjYyODc4YjVkMjI4MGQ4YTEwMGRlZjI1MGMzZjJkNmE5ZDYy
+    NjAwNDk0MTI3ZmRiOThkYzBmMTNlMTljZTFlMDUyOGIwNGQ0Y2I=

data/README.md

@@ -5,7 +5,10 @@ This gem provides Rails 3/4 asset pipeline loading for [Quill](http://quilljs.co
 
 Add the following lines to your applications Gemfile:
 
+```
 gem 'quill-rails', '~> 0.1.0'
+```
+
 Then run bundle install to update your application's bundle.
 
 Add Quill to your manifest in app/assets/javascripts/application.js:
@@ -24,6 +27,8 @@ You can make the original Quill Snow theme available by adding the following to
 
 # Usage
 
+## Quick Start
+
 This gem provides a View Helper to automatically create the ['Full Example' demo seen here](http://quilljs.com/examples/#full-example). Just add the following to your view:
 
 ```
@@ -32,12 +37,38 @@ This gem provides a View Helper to automatically create the ['Full Example' demo
 
 and a sexy looking Quill editor will be there!
 
+## Useage in Forms
+
+YO! - This is in development and is may change as more functionality is added.
+
+For use in forms, the quill_editor helper creates a hidden field tag whose value is in sync with the text in the editor. By default, it has an id and name of 'quill-value'.
+
+To change both the id or name, just pass a string as the first argument:
+
+```
+<%= quill_editor 'my-name-and-id' %>
+```
+
+To have an id that's different from the name:
+
+```
+<%= quill_editor nil, { name: 'my-name', id: 'my-id' } %>
+```
+
+## Custom Functionality
+
 Because this includes Quill assets, you can also refer to the [Quill Documentation](http://quilljs.com/docs/editor/) to use other, more custom, features.
 
 # Roadmap
 
 The following features would be nice to have:
 
-- Configuring the default quill_editor e.g. pass in content, change wrapper id, etc.
-- Add and sync a hidden tag field so the text can be submitted in forms
+- Configuring the default quill_editor e.g. pass in content, change wrapper, change theme, etc.
+- Have a form helper tag (f.quill_editor)
 - Parse any RTE input for malicious tags
+
+# Contributing
+
+Contributors are very welcome! Fork it, branch it, change it, push it, pull request it, and [bop it](https://www.youtube.com/watch?v=fH4XHwefPVY). 
+
+If you have an idea for new features or improving existing features, let me know!

data/lib/quill/rails/templates/template.html.erb

@@ -112,15 +112,20 @@
   </div>
   <div id="full-editor" class="editor">
   </div>
-</div>
+  <input type='hidden' name='<%= @input_name %>' id='<%= @input_id %>' value=''/>
+
+  <script type='text/javascript'>
+    // Initialize editor with custom theme and modules
+    var fullEditor = new Quill('#full-editor', {
+      modules: {
+        'toolbar': { container: '#full-toolbar' },
+        'link-tooltip': true
+      },
+      theme: 'snow'
+    });
 
-<script type='text/javascript'>
-  // Initialize editor with custom theme and modules
-  var fullEditor = new Quill('#full-editor', {
-    modules: {
-      'toolbar': { container: '#full-toolbar' },
-      'link-tooltip': true
-    },
-    theme: 'snow'
-  });
-</script>
+    fullEditor.on('text-change', function(delta, source) {
+      document.getElementById('<%= @input_id %>').value = fullEditor.getContents()
+    });
+  </script>
+</div>

data/lib/quill/rails/version.rb

@@ -1,6 +1,6 @@
 module Quill
   module Rails
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
     QUILL_VERSION = '0.13.4'
   end
 end

data/lib/quill/rails/view_helpers.rb

@@ -8,7 +8,10 @@ module Quill
       end
       # A link helper to create a 'default' Quill text edit
       #  
-      def quill_editor(options={})
+      def quill_editor(name=nil, options={})
+        mod_options = { name: 'quill-value', id: 'quill-value' }.merge options
+        @input_name = (name || mod_options[:name])
+        @input_id   = (name || mod_options[:id])   
         ERB.new(File.read(File.join(source_root, 'template.html.erb'))).result(binding).html_safe
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quill-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Robert Wiegmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties