llt-core 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99ad6c4858497e80179b2537f7e945f41972b79e
-  data.tar.gz: 6647133228668feb869b4c846525d2345e5da2e9
+  metadata.gz: e1f24fb2e3f840c885ba1156442dd42cc21eacd7
+  data.tar.gz: ea0e69af62b090a427f163cfa545c6f0bc5a84a1
 SHA512:
-  metadata.gz: 920a2015f453e256c3769381852df4329eba586b1aa3f16c3fb725fde00d58db48964154b4cb07c41ee2167bf077a27e6bbce30eba02a6b41a30fed28df6b9cd
-  data.tar.gz: b1787c797c2af8da0e8e1d1311304cd2a6369d7679cde3c8d3bb0100317ed34bb4200e4a704d1b47d850edc2435439a8c8d110bf8b19d592c534ae32984ebd6e
+  metadata.gz: 6ac77f13805196d581a12fba96cdf3dde2f51a8e999ad21018eb2954a715bee0c2ca9b08ed13c823e32aa2bb9912c54fdfd577a67d3737892e5e0f457e789fa5
+  data.tar.gz: b797df93991e0b930305ed47a4fc8eb03d7c3a40be69f0a9f93aad356fc122bf7ee3a08f74084283d129cf8be9f766d1d95401cbf14f5abc5935ded756be446e

data/lib/llt/core/api/helpers.rb

@@ -1,28 +1,29 @@
 require 'cgi'
+require 'xml_escape'
 
 module LLT
   module Core
     module Api
       module Helpers
-        def uu(text)
-          CGI.unescape(text)
-        end
-
-        def u(text)
-          CGI.escape(text)
-        end
+        include XmlEscape
 
         # tries to resolve an uri or a text included in the params
+        #
+        # strips any incoming xml declaration because it gets added back in at
+        # the end and otherwise will be duped
+        # if an xml declaration is included, the xml param is set to true
         def extract_text(params)
-          if uri = params[:uri]
-            get_from_uri(uri)
+          text = get_text(params)
+          if has_xml_declaration?(text)
+            params[:xml] = true
+            text.sub(XML_DECLARATION_REGEXP, '')
           else
-            params[:text]
+            text
           end
         end
 
         def extract_markup_params(params)
-          mu_params = %i{ recursive indexing inline }
+          mu_params = %i{ recursive indexing inline id_as }
           extracted = [params[:tags]]
           relevant = mu_params.each_with_object({}) do |param, h|
             val = params[param]
@@ -57,8 +58,21 @@ module LLT
 
         private
 
+        XML_DECLARATION_REGEXP = /<\?xml.*?\?>/
         XML_DECLARATION = %{<?xml version="1.0" encoding="UTF-8"?>}
 
+        def has_xml_declaration?(txt)
+          txt.match(XML_DECLARATION_REGEXP)
+        end
+
+        def get_text(params)
+          if uri = params[:uri]
+            get_from_uri(uri)
+          else
+            params[:text]
+          end
+        end
+
         def typecast(val)
           if val.kind_of?(Array)
             val.map { |e| typecast(e) }

data/lib/llt/core/containable.rb

@@ -28,6 +28,7 @@ module LLT
       def to_xml(tags = nil, indexing: true,
                              recursive: true,
                              inline: false,
+                             id_as: 'n',
                              attrs: {})
 
         # for easier recursion it's solved in a way that might
@@ -37,17 +38,17 @@ module LLT
         end_of_recursion = false
 
         val = if recursive && all? { |e| e.respond_to?(:to_xml)}
-                attrs.merge!(inline_id(tag)) if inline && indexing
-                recursive_xml(tags, indexing, inline, attrs)
+                attrs.merge!(inline_id(tag, id_as)) if inline && indexing
+                recursive_xml(tags, indexing, inline, id_as, attrs)
               else
                 end_of_recursion = true
                 as_xml
               end
 
         if inline
-          end_of_recursion ? wrap_with_xml(tag, val, indexing, attrs) : val
+          end_of_recursion ? wrap_with_xml(tag, val, indexing, id_as, attrs) : val
         else
-          wrap_with_xml(tag, val, indexing, attrs)
+          wrap_with_xml(tag, val, indexing, id_as, attrs)
         end
       end
 
@@ -89,8 +90,8 @@ module LLT
 
       # id is represented as @n attribute in the xml, as xml:id
       # is reserved for something else
-      def wrap_with_xml(tag, string, indexing, attrs = {})
-        merge_id!(attrs) if indexing && @id
+      def wrap_with_xml(tag, string, indexing, id_as, attrs = {})
+        merge_id!(id_as, attrs) if indexing && @id
         attr = attrs.any? ? " #{to_xml_attrs(attrs)}" : ''
         "<#{tag}#{attr}>#{string}</#{tag}>"
       end
@@ -99,23 +100,19 @@ module LLT
         attrs.map { |k, v| %{#{k}="#{v}"} }.join(' ')
       end
 
-      def recursive_xml(tags, indexing, inline, attrs)
+      def recursive_xml(tags, indexing, inline, id_as, attrs)
         each_with_object('') do |element, s|
           s << element.to_xml(tags.clone, indexing: indexing, recursive: true,
-                                          inline: inline, attrs: attrs)
+                                          inline: inline, id_as: id_as, attrs: attrs)
         end
       end
 
-      def merge_id!(attrs)
-        attrs.merge!(id_as_xml => @id,)
+      def merge_id!(id_as, attrs)
+        attrs.merge!(id_as => @id,)
       end
 
-      def id_as_xml
-        'n'
-      end
-
-      def inline_id(tag)
-        { "#{tag}_#{id_as_xml}" => @id }
+      def inline_id(tag, id_as)
+        { "#{tag}_#{id_as}" => @id }
       end
 
       module ClassMethods

data/lib/llt/core/version.rb

@@ -1,5 +1,5 @@
 module LLT
   module Core
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/llt-core.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov", "~> 0.7"
   spec.add_dependency "sinatra"
   spec.add_dependency "sinatra-contrib"
+  spec.add_dependency "xml_escape"
 end

data/spec/lib/llt/core/api/helpers_spec.rb

@@ -7,22 +7,33 @@ describe LLT::Core::Api::Helpers do
   end
 
   describe "#extract_text" do
-    it "tries to resolve a passed or a given text param" do
-      pending
+    context "text param" do
+      it "tries to resolve a passed or a given text param" do
+       dummy.extract_text(:text => "some text").should == "some text"
+      end
+
+      it "strips away the xml declaration" do
+       dummy.extract_text(:text => %{<?xml version="1.0" encoding="UTF-8"?>some text}).should == "some text"
+      end
     end
-  end
 
-  describe "#uu" do
-    it "unescapes url strings" do
-      url = 'http%3A%2F%2Ftest.com'
-      dummy.uu(url).should == 'http://test.com'
+    context "uri param" do
+      it "calls to the given URI to retrieve the text" do
+        allow(dummy).to receive(:get_from_uri) { "text from uri" }
+        dummy.extract_text(:uri => "some uri").should == "text from uri"
+      end
+
+      it "strips away the xml declaration" do
+        allow(dummy).to receive(:get_from_uri) { %{<?xml version="1.0" encoding="UTF-8"?>text from uri} }
+        dummy.extract_text(:uri => "some uri").should == "text from uri"
+      end
     end
-  end
 
-  describe "#u" do
-    it "escapes url strings" do
-      url = 'http://test.com'
-      dummy.u(url).should == 'http%3A%2F%2Ftest.com'
+    it "sets xml param to true when there is an xml declaration present" do
+      params = { text: %{<?xml version="1.0"?>some text} }
+      dummy.extract_text(params).should == 'some text'
+      params.should have_key(:xml)
+      params[:xml].should be_true
     end
   end
 
@@ -32,6 +43,11 @@ describe LLT::Core::Api::Helpers do
       dummy.extract_markup_params(params).should == [nil, { recursive: true }]
     end
 
+    it "extracts the id_as param" do
+      params = { 'id_as' => 'id' }
+      dummy.extract_markup_params(params).should == [nil, { id_as: 'id'} ]
+    end
+
     it "returns an array that should be exploded when used with #to_xml" do
       params = { recursive: true, tags: %w{ a b }}
       extracted = [%w{ a b }, { recursive: true }]

data/spec/lib/llt/core/containable_spec.rb

@@ -125,7 +125,7 @@ describe LLT::Core::Containable do
         sentence.to_xml(['a', nil, 'c'], recursive: true).should == result
       end
 
-      it "can include the id of an element, as @n attribute" do
+      it "can include the id of an element, as @n attribute by default" do
         dummy.xml_tag 's'
         other_dummy.xml_tag 'w'
 
@@ -136,6 +136,13 @@ describe LLT::Core::Containable do
         sentence.to_xml(indexing: true, recursive: true).should == result
       end
 
+      it "can represent a custom id attribute identifier" do
+        dummy.xml_tag 's'
+        sentence = dummy.new('test', 1)
+        result = '<s id="1">test</s>'
+        sentence.to_xml(id_as: 'id').should == result
+      end
+
       it "recursive representation can be inlined" do
         dummy.xml_tag 's'
         other_dummy.xml_tag 'w'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: llt-core
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - LFDM
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-08 00:00:00.000000000 Z
+date: 2014-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: xml_escape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: LLT::Core classes and modules
 email:
 - 1986gh@gmail.com
@@ -154,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Contains classes and modules that are shared across several llt gems