ballonizer 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b70575ef73f0f6eb75c78152bc2528cf5b265f8
-  data.tar.gz: ee3aca3f015051952cf27d02f566ba82db4d9202
+  metadata.gz: 780ce40c1dc740975c9efab98d89424a0b985fc3
+  data.tar.gz: 59e8ef21b8d41b5ecf3967f9d970ff9128980856
 SHA512:
-  metadata.gz: 3e2c3f7d30a6e276d71cbb2cbd3b024e537fb0cd1701afa191a240bbab4d74d7a474ced17b23a5d2a8ebf2cce38939b9787ce1455eaecd6a695dd4be50a03209
-  data.tar.gz: 4314720810323104e83f0cc6b9c9049966b75de5df711126aead63092900a3d9e3824b8ab2b85794898e106e964340f21ef94daeebf581add700087b00d29a1f
+  metadata.gz: 6a326072d5470694d5be5130b74adea5ce2099c2b0ccb1c0943bcffcb93b7f8054e6e2b51a878ced816e238d3c5e2dbfab2ecee1f61dbdc3279866ef2b75e180
+  data.tar.gz: c82f1c4356ffe12dcdf2cf8a3ec483f143c8930bab14c9513114a3bd127e497a7df25dc47b360cfe8609d58a0667c2553c0e7d82783e06c78250a7f28d796019

data/lib/ballonizer.rb

@@ -55,6 +55,16 @@ require 'sprockets'
 # ballonized_image_ballons.
 #
 # Changelog:
+#  v0.5.1:
+#   * js_load_snippet can take a settings arg too. Fixed ballonize_page to
+#     use the :form_handler_url from the settings argument.
+#  v0.5.0:
+#   * The *_html_links methods can take a settings argument.
+#   * Fixed bug where passing a new asset path to the ballonize_page don't
+#     settings parameter change the asset path that it uses.
+#   * Asset path settings now are parsed as real URIs (need to have a
+#     trailing slash if the intent is use as a dir).
+#   * Updated the rspec version used by the gem (fixed deprecation).
 #  v0.4.0: 
 #   * Changed the way the Javascript module add containers in the page
 #     to avoid creating invalid HTML4.0.1/XHTML1.1/HTML5 documents.
@@ -403,7 +413,7 @@ class Ballonizer
   # @raise [Ballonizer::Error] If the mime-type don't match either 'text/html'
   #   or 'application/xhtml+xml'.
   def ballonize_page(page, page_url, mime_type, settings = {})
-    settings = self.settings.merge(settings)
+    settings = @settings.merge(settings)
 
     # can raise Ballonizer::Error if the mime-type is invalid
     parsed_page = Workaround.parse_html_or_xhtml(page, mime_type)
@@ -437,7 +447,7 @@ class Ballonizer
         head.children.last.add_next_sibling(js_libs_html_links(settings))
       end
       if settings[:add_js_for_edition]
-        head.children.last.add_next_sibling(self.js_load_snippet)
+        head.children.last.add_next_sibling(js_load_snippet(settings))
       end
     end
     
@@ -481,17 +491,20 @@ class Ballonizer
   end
 
   # Return a String with the snippet added to the pages to allow edition in them.
+  # @param settings [Hash{Symbol => String}] Optional. Hash to be merged with
+  #   the instance #settings (this argument override the #settings ones).
   # @return [String] The added snippet. Already with the <script/> tag around it.
-  def js_load_snippet
-    <<-end
+  def js_load_snippet(settings = {})
+    settings = @settings.merge(settings)
+    <<-EOF
       <script type="text/javascript">
         $(document).ready(function() {
-          Ballonizer('#{self.settings[:form_handler_url]}',
+          Ballonizer('#{settings[:form_handler_url]}',
                      '.ballonizer_image_container',
                      $('body'));
         })
       </script>
-    end
+    EOF
   end
 
   # Executes the create_table operations over the Sequel::Database argument.
@@ -536,7 +549,7 @@ class Ballonizer
   # @return [String,NilClass] A String when the :css_asset_path_for_link is
   #   defined, nil otherwise.
   def css_html_links(settings = {})
-    settings = self.settings.merge(settings)
+    settings = @settings.merge(settings)
     return nil unless settings[:css_asset_path_for_link]
 
     link_template = '<link rel="stylesheet" type="text/css" href="PATH" />'

data/spec/ballonizer_spec.rb

@@ -4,6 +4,7 @@ require 'rspec-html-matchers'
 require 'equivalent-xml'
 require 'stringio'
 require 'rexml/document'
+require 'nokogiri'
 
 # make the changes in the BD restricted to the example
 RSpec.configure do |c|
@@ -108,6 +109,7 @@ describe Ballonizer do
   # definitions to be overriden in need, but who doesn't need a *_example
   # counterpart (are so simple that clone and change isn't pratical)
   let (:mime_type) { 'application/xhtml+xml' }
+  let (:ballonize_page_settings_arg) { {} }
 
   # Definitions ending with '_example' are to be cloned and defined in a
   # context without the sufix. Definitions without the sufix are used in the
@@ -163,9 +165,6 @@ describe Ballonizer do
   let (:page_url_example) do
     'http://comic-translation.com/tr/pt-BR/a_comic/'
   end
-  let (:settings_example) do
-    {}
-  end
   let (:submit_json_example) do
     '{"http://imgs.xkcd.com/comics/cells.png":[{"left":0,"top":0,"width":1,"height":0.23837209302325582,"font_size":15,"text":"When you see a claim that a common drug or vitamin \"kills cancer cells in a petri dish\", keep in mind:"},{"left":0.0963302752293578,"top":0.9273255813953488,"width":0.7798165137614679,"height":0.055232558139534885,"font_size":16,"text":"So does a handgun."}]}'
   end
@@ -180,14 +179,15 @@ describe Ballonizer do
   let (:env)                 { env_example }
   let (:original_page)       { original_page_example.to_s }
   let (:page_url)            { page_url_example }
-  let (:settings)            { settings_example }
   let (:submit_json)         { submit_json_example }
   let (:submit_hash)         { submit_hash_example }
 
   # Definition who need others (no *_example)
   let (:instance) { described_class.new(*ballonizer_new_args) }
   let (:ballonize_page_call) do
-    lambda { instance.ballonize_page(original_page, page_url, mime_type, settings) }
+    lambda { instance.ballonize_page(
+      original_page, page_url, mime_type, ballonize_page_settings_arg
+    )}
   end
   let (:ballonized_page) do
     ballonize_page_call.call
@@ -273,10 +273,24 @@ describe Ballonizer do
             })
           end
 
-          it do
+          it 'insert the link tag (with the correct path)' do
             # the example html don't have any link tag, so if there one
             # it was added by the method
             should have_tag('link', :with => { type: 'text/css' })
+            # we are using xhtml, so we parse as xml
+            link_href = Nokogiri::XML(subject).at_css('link').attr('href')
+            expect(link_href).to match(/^\/assets\/css\//)
+          end
+
+          context 'but the settings argument override the path' do
+            let (:ballonize_page_settings_arg) do
+              { css_asset_path_for_link: '/other_assets/css/' }
+            end
+            it 'use the settings argument path' do
+              # we are using xhtml, so we parse as xml
+              link_href = Nokogiri::XML(subject).at_css('link').attr('href')
+              expect(link_href).to match(/^\/other_assets\/css\//)
+            end
           end
         end
         context 'and the settings define to insert js' do
@@ -289,8 +303,35 @@ describe Ballonizer do
             })
           end
 
-          it do
+          it 'insert the script tag (with the correct src)' do
             should have_tag('script', :with => { type: 'text/javascript' })
+            # we are using xhtml, so we parse as xml
+            script_src = Nokogiri::XML(subject).at_css('script').attr('src')
+            expect(script_src).to match(/^\/assets\/js\//)
+          end
+
+          context 'but the settings argument override the path' do
+            let (:ballonize_page_settings_arg) do
+              { js_asset_path_for_link: '/other_assets/js/' }
+            end
+            it 'use the settings argument path' do
+              # we are using xhtml, so we parse as xml
+              script_src = Nokogiri::XML(subject).at_css('script').attr('src')
+              expect(script_src).to match(/^\/other_assets\/js\//)
+            end
+          end
+        end
+        context 'and the settings argument override the form_handler_url' do
+          let (:ballonize_page_settings_arg) do
+            { form_handler_url: '/other_request_handler',
+              add_js_for_edition: true,
+              add_required_js_libs_for_edition: false
+            }
+          end
+          it 'change the js snippet to use the argument one' do
+            # we are using xhtml, so we parse as xml
+            script_text = Nokogiri::XML(subject).at_css('script').text
+            expect(script_text).to match(/\/other_request_handler/)
           end
         end
       end
@@ -652,7 +693,32 @@ describe Ballonizer do
     end
   end
 
-  # to be used with #css_html_links and #js_libs_html_links
+  describe '#js_load_snippet' do
+    subject { instance.js_load_snippet(settings_arg) }
+
+    let (:settings_arg) { Hash.new }
+    let (:ballonizer_settings) do
+      ballonizer_settings_example.merge({
+        form_handler_url: '/request_handler'
+      })
+    end
+
+    it 'return contains the :form_handler_url setting' do
+      should match(instance.settings[:form_handler_url])
+    end
+
+    context 'when the settings argument is passed' do
+      let (:settings_arg) do
+        { form_handler_url: '/other_request_handler' }
+      end
+
+      it 'use the argument one' do
+        should match(settings_arg[:form_handler_url])
+        should_not match(instance.settings[:form_handler_url])
+      end
+    end
+  end
+
   describe '#css_html_links' do
     shared_examples 'using settings parameter' do
       context 'and a path is passed by the settings hash argument' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ballonizer
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Henrique Becker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-17 00:00:00.000000000 Z
+date: 2013-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri