sketchily 1.0.3 → 1.1.0

data/README.md

@@ -56,17 +56,28 @@ This gem also adds a helper method that can be called to display the resulting S
 
 Currently available options are:
 
-- `width` (total width of editor)
-- `height` (total height of editor)
-- `canvas_width` (initial canvas width)
-- `canvas_height` (initial canvas height)
-- `canvas_expansion` (0 if you want to disable scrolling)
-- `hide_rulers` (true if you want to hide the canvas rulers)
-- `hide_menu` (true if you want svg-edit's menu to be hidden)
-- `hide_image_tool` (true if you want to hide the image tool button)
-- `hide_hyperlink_tool` (true if you want to hide the hyperlink tool button)
+- `width` total width of editor
+- `height` total height of editor
+
+- `canvas_width` initial canvas width
+- `canvas_height` initial canvas height
+- `canvas_expansion` 0 if you want to disable scrolling
+
+- `hide_rulers` true if you want to hide the canvas rulers
+- `hide_menu` true if you want svg-edit's menu to be hidden
+- `hide_image_tool` true if you want to hide the image tool button
+- `hide_hyperlink_tool` true if you want to hide the hyperlink tool button
+
+- `id` override the default id (see explanation below)
+- `value` override the default value (the svg itself; can be useful when using form_for)
+- `index` override the default index (affects the tag name; can be useful when using form_for)
+
 - other standard html attributes for the input tag
 
+Sketchily requires a unique `id` (by default, this is set in the same way as hidden_field) each time it is called in the same page.
+However, some uses of `form_for` can generate repeated ids (e.g. multiple `form_for @my_object.new` in the same page).
+In those cases, you need to generate and specify your own unique ids. A possible solution is to use one of the many uuid generator gems.
+
 It is recommended that the database entries associated with sketchily form elements be of type `text`.
 
 The following examples assume that the database table for `@my_object` has a `sketch` column of type `text`.

data/app/views/sketchily/_sketchily.html.erb

@@ -4,13 +4,13 @@
    # method
    # options %>
 
-<% sketchily_tag = ActionView::Helpers::InstanceTag.new(object_name, method, template, options.delete(:object)) %>
+<% sketchily_tag = ActionView::Helpers::InstanceTag.new(object_name, method, template, options.delete(:object))
+   options = {:id => sketchily_tag.send(:tag_id),
+              :value => sketchily_tag.value(sketchily_tag.object)}.merge(options) %>
 
 <%= render :partial => "sketchily/embed",
            :formats => :html,
-           :locals => options.slice(*Sketchily::OPTIONS).merge(
-                        {:id => sketchily_tag.send(:tag_id),
-                         :value => sketchily_tag.value(sketchily_tag.object)}) %>
+           :locals => options.slice(*Sketchily::OPTIONS) %>
 
-<%= sketchily_tag.to_input_field_tag("hidden", options.except(*Sketchily::OPTIONS)) %>
+<%= sketchily_tag.to_input_field_tag("hidden", options.except(*Sketchily::SKETCHILY_OPTIONS)) %>
 

data/app/views/sketchily/_sketchily.html.erb~

@@ -4,12 +4,14 @@
    # method
    # options %>
 
-<% sketchily_tag = ActionView::Helpers::InstanceTag.new(object_name, method, template, options.delete(:object)) %>
+<% sketchily_tag = ActionView::Helpers::InstanceTag.new(object_name, method, template, options.delete(:object))
+   options = {:id => sketchily_tag.send(:tag_id),
+              :value => sketchily_tag.value(sketchily_tag.object)}.merge(
+              options) %>
 
 <%= render :partial => "sketchily/embed",
            :formats => :html,
-           :locals => {:id => sketchily_tag.send(:tag_id),
-                       :value => sketchily_tag.value(sketchily_tag.object)}.merge(options.slice(*Sketchily::OPTIONS)) %>
+           :locals => options.slice(*Sketchily::OPTIONS) %>
 
-<%= sketchily_tag.to_input_field_tag("hidden", options.except(*Sketchily::OPTIONS)) %>
+<%= sketchily_tag.to_input_field_tag("hidden", options.except(*Sketchily::SKETCHILY_OPTIONS)) %>
 

data/app/views/sketchily/_sketchily_tag.html.erb

@@ -4,11 +4,12 @@
    # value
    # options %>
 
+<% options = {:id => id,
+              :value => value}.merge(options) %>
+
 <%= render :partial => "sketchily/embed",
            :formats => :html,
-           :locals => options.slice(*Sketchily::OPTIONS).merge(
-                        {:id => id,
-                         :value => value}) %>
+           :locals => options.slice(*Sketchily::OPTIONS) %>
 
-<%= tag :input, { "type" => "hidden", "name" => name, "id" => id, "value" => value }.update(options.except(*Sketchily::OPTIONS).stringify_keys) %>
+<%= tag :input, {"type" => "hidden", "name" => name}.update(options.except(*Sketchily::SKETCHILY_OPTIONS).stringify_keys) %>
 

data/app/views/sketchily/_sketchily_tag.html.erb~

@@ -4,10 +4,13 @@
    # value
    # options %>
 
+<% options = {:id => id,
+              :value => value}.merge(
+              options.slice(*Sketchily::OPTIONS)) %>
+
 <%= render :partial => "sketchily/embed",
            :formats => :html,
-           :locals => {:id => id,
-                       :value => value}.merge(options.slice(*Sketchily::OPTIONS)) %>
+           :locals => options %>
 
-<%= tag :input, { "type" => "hidden", "name" => name, "id" => id, "value" => value }.update(options.except(*Sketchily::OPTIONS).stringify_keys) %>
+<%= tag :input, {"type" => "hidden", "name" => name}.update(options.except(*Sketchily::SKETCHILY_OPTIONS).stringify_keys) %>
 

data/lib/sketchily/sketchily.rb

@@ -3,7 +3,7 @@ module Sketchily
     def sketchily(method, options = {})
       Sketchily.render(:partial => "sketchily/sketchily",
         :locals => {:template => @template, :object_name => @object_name,
-                    :method => method, :options => objectify_options(options)}).html_safe
+                    :method => method, :options => objectify_options(options)})
     end
 
     def svg_edit(method, options = {})
@@ -15,7 +15,7 @@ module Sketchily
     def sketchily(object_name, method, options = {})
       Sketchily.render(:partial => "sketchily/sketchily",
         :locals => {:template => self, :object_name => object_name,
-                    :method => method, :options => options}).html_safe
+                    :method => method, :options => options})
     end
 
     def svg_edit(object_name, method, options = {})

data/lib/sketchily/sketchily.rb~

@@ -26,3 +26,4 @@ end
 
 ActionView::Helpers::FormBuilder.send :include, Sketchily::FormBuilderInstanceMethods
 ActionView::Base.send :include, Sketchily::ActionViewBaseInstanceMethods
+

data/lib/sketchily/sketchily_tag.rb

@@ -3,7 +3,7 @@ module SketchilyTag
     def sketchily_tag(name, value = nil, options = {})
       Sketchily.render(:partial => "sketchily/sketchily_tag",
         :locals => {:name => name, :id => sanitize_to_id(name),
-                    :value => value, :options => options}).html_safe
+                    :value => value, :options => options})
     end
 
     def svg_edit_tag(name, value = nil, options = {})

data/lib/sketchily/sketchily_tag.rb~

@@ -13,3 +13,4 @@ module SketchilyTag
 end
 
 ActionView::Base.send :include, SketchilyTag::ActionViewBaseInstanceMethods
+

data/lib/sketchily/version.rb

@@ -1,3 +1,3 @@
 module Sketchily
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/lib/sketchily/version.rb~

@@ -1,3 +1,3 @@
 module Sketchily
-  VERSION = "1.0.2"
+  VERSION = "1.0.4"
 end

data/lib/sketchily.rb

@@ -5,7 +5,9 @@ require "sketchily/sketchily_tag"
 module Sketchily
   ASSET_FILES = %w(sketchily.css sketchily.js sketchily_embed.js canvg/canvg.js canvg/rgbcolor.js extensions/ext-*.js locale/lang.*.js)
 
-  OPTIONS = [:width, :height, :canvas_width, :canvas_height, :canvas_expansion, :hide_rulers, :hide_menu, :hide_image_tool, :hide_hyperlink_tool]
+  SKETCHILY_OPTIONS = [:width, :height, :canvas_width, :canvas_height, :canvas_expansion, :hide_rulers, :hide_menu, :hide_image_tool, :hide_hyperlink_tool]
+  TAG_OPTIONS = [:id, :value, :index]
+  OPTIONS = SKETCHILY_OPTIONS + TAG_OPTIONS
 
   ROOT = File.expand_path('../..', __FILE__)
 
@@ -17,7 +19,7 @@ module Sketchily
   end
 
   def self.render(options = {}, local_assigns = {}, &block)
-    VIEW.render(options, local_assigns, &block)
+    VIEW.render(options, local_assigns, &block).html_safe
   end
 end
 

data/lib/sketchily.rb~

@@ -5,7 +5,9 @@ require "sketchily/sketchily_tag"
 module Sketchily
   ASSET_FILES = %w(sketchily.css sketchily.js sketchily_embed.js canvg/canvg.js canvg/rgbcolor.js extensions/ext-*.js locale/lang.*.js)
 
-  OPTIONS = [:width, :height, :canvas_width, :canvas_height, :canvas_expansion, :hide_rulers, :hide_menu, :hide_image_tool, :hide_hyperlink_tool]
+  SKETCHILY_OPTIONS = [:width, :height, :canvas_width, :canvas_height, :canvas_expansion, :hide_rulers, :hide_menu, :hide_image_tool, :hide_hyperlink_tool]
+  TAG_OPTIONS = [:id, :value]
+  OPTIONS = SKETCHILY_OPTIONS + TAG_OPTIONS
 
   ROOT = File.expand_path('../..', __FILE__)
 
@@ -17,9 +19,7 @@ module Sketchily
   end
 
   def self.render(options = {}, local_assigns = {}, &block)
-    VIEW.render(options, local_assigns, &block)
+    VIEW.render(options, local_assigns, &block).html_safe
   end
 end
 
-
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sketchily
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors: