bootstrap_pagedown 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 751d8a77576cc1a0de99944b339e62ee363e1e59
-  data.tar.gz: e565e2fe825c7c1978be515cb6ba9cc4b3c3c68b
+  metadata.gz: 730e400d9cbbbe4553ca04e76ce3d3ba68a33e71
+  data.tar.gz: 881011d7ed015a771537f836b37252d2662b555b
 SHA512:
-  metadata.gz: 22ccab361f8819313a9e0aba42937cfb0fbe3c3d2c5318edfc5df716ec0a4677dc3d3f36732634809a04d659c5351ccc4ec6b851e56151cc179cb4bf2dfc04c9
-  data.tar.gz: 807455067bdb58dc6b8fbaa19d0f4b8bb90fdd4ea1e4a8c441bce85ff384dc3b8b75dabe509a9f991cf8d09ca7e81b584caa2ebe98020e4b2e585ce0d976788f
+  metadata.gz: 06174743ff7dec8f7cdc19e997d9f024efdd89c147185937504e072af44b4ff7219b7a1cb1d007fbd6745b8bb50cf5c3ca5d04ba1f73afc44a8bf5378c83b0b8
+  data.tar.gz: f990c0c27882ab147901367eeeb9f1cfdf48d7e3bbfd82e34d23bddba3d7590ec18091fa8a16a823d8d95c4cc089d7fdb8bf379e8ea3418e92bb11963951b9c4

data/README.md

@@ -49,9 +49,48 @@ You may also add attributes to the generated text area as needed by simply addin
 
 The previous example would add `data-name="editor"` to the editor textarea element.
 
-### Note
+### Custom options supported:
 
-You should only use one editor per page since `Pagedown`'s Javascript relies on the HTML id attribute for most of it's behavior.
+By default bootstrap_pagedown will create the needed HTML elements to render a functional editor with a button bar and a preview div.
+However you can change the different element classes, ids and even skip the preview div by passing different options to the `pagedown_editor`
+method, here's the hash with different options and it's default values:
+
+```ruby
+{
+  skip_preview:     false,             # Whether or not we should skip the preview div, skipping this will render an editor without HTML preview
+  panel_id:         '',                # HTML id of the editor panel div
+  panel_class:      'wmd-panel',       # HTML class of the editor panel div
+  button_bar_id:    'wmd-button-bar',  # HTML id of the editor's button bar div
+  button_bar_class: '',                # HTML class of the editor's button bar div
+  editor_id:        'wmd-input',       # HTML if of the editor textarea
+  editor_class:     'wmd-input',       # HTML class of the editor textarea
+  preview_id:       'wmd-preview',     # HTML id of the preview div
+  preview_class:    '',                # HTML class of the preview div
+}
+```
+
+This is a the default generated HTML, note that name will change depending on your form builder and method name.
+
+```html
+<div class="wmd-panel">
+  <div id="wmd-button-bar"></div>
+  <textarea class="wmd-input" id="wmd-input" name="test[test]"></textarea>
+  <div id="wmd-preview"></div>
+</div>
+```
+
+If you change the any of the default ids or classes on the HTML elements the `pagedown_editor` will render the correct HTML, but the editor won't render
+that is because by default Pagedown looks for those element attribute values, however you can still get the editor to render and behave correctly through the
+[Pagedown API](https://code.google.com/p/pagedown/wiki/PageDown). I other words in order to have more than one editor in the same page you'll obviously have to
+change the element attributes and the use the Pagedown API to create every aditional editor.
+
+## Stylesheets
+
+If you need to change something on the stylesheets you don't need to start from scratch, you can simply generate the sass file with the sass generator as follows:
+
+`rails g bootstrap_pagedown:sass`
+
+This will generate a copy of bootstrap_pagedown styles into `app/assets/stylesheets`.
 
 ## Running the test suite
 

data/lib/bootstrap_pagedown/form_builder.rb

@@ -1,10 +1,32 @@
 module BootstrapPagedown
   module FormBuilder
-    def pagedown_editor( method, options={})
-      @template.content_tag( :div, class: 'wmd-panel' ) do
-        @template.content_tag( :div, nil, id: 'wmd-button-bar' ) +
-        @template.text_area( @object_name, method, objectify_options( options ).merge( id: 'wmd-input', class: 'wmd-input' ) )
+    def pagedown_editor(method, options={})
+      options         = pagedown_default_values options
+      custom_options  = pagedown_custom_attributes options
+
+      @template.content_tag( :div, id: options[:panel_id], class: options[:panel_class] ) do
+        @template.content_tag( :div, nil, id: options[:button_bar_id], class: options[:button_bar_class] ) +
+        @template.text_area( @object_name, method, objectify_options( custom_options ).merge( id: options[:editor_id], class: options[:editor_class] ) ) +
+
+        unless options[:skip_preview]
+          @template.content_tag :div, nil, id: options[:preview_id], class: options[:preview_class]
+        end
       end
     end
+
+    def pagedown_default_values( options )
+      options[:skip_preview]  ||= false
+      options[:panel_class]   ||= 'wmd-panel'
+      options[:button_bar_id] ||= 'wmd-button-bar'
+      options[:editor_id]     ||= 'wmd-input'
+      options[:editor_class]  ||= 'wmd-input'
+      options[:preview_id]    ||= 'wmd-preview'
+
+      options
+    end
+
+    def pagedown_custom_attributes( options )
+      options.except :skip_preview, :panel_class, :panel_id, :button_bar_id, :button_bar_class, :editor_id, :editor_class, :preview_id, :preview_class
+    end
   end
 end

data/lib/bootstrap_pagedown/version.rb

@@ -1,3 +1,3 @@
 module BootstrapPagedown
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/lib/generators/bootstrap_pagedown/sass_generator.rb

@@ -0,0 +1,15 @@
+module BootstrapPagedown
+  module Generators
+    class SassGenerator < ::Rails::Generators::Base
+      VENDOR_PATH = File.expand_path( '../../../../vendor/assets/stylesheets/', __FILE__ )
+
+      source_root VENDOR_PATH
+
+      desc "Generates the editor stylesheet"
+
+      def copy_sass
+        directory VENDOR_PATH, 'app/assets/stylesheets'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap_pagedown
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Enrique Vidal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-15 00:00:00.000000000 Z
+date: 2013-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -35,6 +35,7 @@ files:
 - lib/bootstrap_pagedown/form_builder.rb
 - lib/bootstrap_pagedown/version.rb
 - lib/bootstrap_pagedown.rb
+- lib/generators/bootstrap_pagedown/sass_generator.rb
 - lib/tasks/bootstrap_pagedown_tasks.rake
 - vendor/assets/images/Markdown.Editor.Icons.png
 - vendor/assets/javascripts/bootstrap_pagedown/load_editor.coffee