axeml 0.0.3 → 0.0.4

data/README.md

@@ -1,6 +1,10 @@
-# AxML
+# AxeML
 
-AxML is a notation for Nokogiri XML documents inspired by [SXML](http://okmij.org/ftp/Scheme/SXML.html).
+AxeML is a notation for Nokogiri XML documents inspired by [SXML](http://okmij.org/ftp/Scheme/SXML.html).
+
+## Installation
+
+    gem install axeml
 
 ## Syntax
 
@@ -11,31 +15,45 @@ treated as the node's content, hashes representing this node's
 attributes or further arrays which are then made into child nodes by
 the same rules.
 
-The syntax can be described by the following rammar:
+The syntax can be described by the following grammar:
 
-    node       ::= [node-name, (node | attributes | content) ...]
-    node-name  ::= Symbol
-    attributes ::= Hash
-    content    ::= String | Fixnum | Float
+    node       ::= [<node-name>, (<node> | <attributes> | <content>) ...]
+    node-name  ::= <Symbol>
+    attributes ::= <Hash>
+    content    ::= <String> | <Fixnum> | <Float>
 
 
 ## Example
 
-    AxML.transform([:ul, { :class => 'menu' },
-                    [:li, [:a, { :href => '/foo' }, 'foo']],
-                    [:li, [:a, { :href => '/bar' }, 'bar']]]).to_s
+    AxeML.transform([:ul, { :class => 'menu' },
+                     [:li, [:a, { :href => '/foo' }, 'foo']],
+                     [:li, [:a, { :href => '/bar' }, 'bar']]]).to_s
 
     =>
 
     <?xml version="1.0"?>
     <ul class="menu">
       <li>
-	<a href="/foo">foo</a>
+        <a href="/foo">foo</a>
       </li>
       <li>
-	<a href="/bar">bar</a>
+        <a href="/bar">bar</a>
       </li>
     </ul>
+    
+
+Note that since `AxeML.transform` returns an instance of
+`Nokogiri::XML::Document` you can directly use its search facilities
+for example:
+
+    AxeML.transform([:foo, [:bar, [:baz, "very well"]]]).search('foo baz').text
+    => "very well"
+
+    
+## ToDo
+
+* actually implement transformation rules :-)
+* support XML namespaces
 
 ## Copyright
 

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.homepage = "http://github.com/DerGuteMoritz/axeml"
     gem.authors = ["Moritz Heidkamp"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency 'nokogiri'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/axeml.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{axeml}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Moritz Heidkamp"]
@@ -44,11 +44,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
   end
 end
 

data/lib/axeml.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'nokogiri'
 
 module AxeML
@@ -10,24 +9,32 @@ module AxeML
   end
 
   def self.transform_element(axeml, doc, parent = doc)
-    el = parent.add_child(Nokogiri::XML::Element.new(axeml[0].to_s, doc))
-    
-    axeml[1..-1].each do |e|
-      case e 
-      when Array
-        el.add_child(transform_element(e, doc, el))
-      when String
-        el.content += e
-      when Fixnum, Float
-        el.content += e.to_s
-      when Hash
-        e.each do |k,v|
-          el[k.to_s] = v
+    case axeml[0]
+    when Symbol
+      el = parent.add_child(Nokogiri::XML::Element.new(axeml[0].to_s, doc))
+
+      axeml[1..-1].each do |e|
+        case e 
+        when Array
+          transform_element(e, doc, el)
+        when String
+          el.content += e
+        when Fixnum, Float
+          el.content += e.to_s
+        when Hash
+          e.each do |k,v|
+            el[k.to_s] = v
+          end
         end
       end
-    end
 
-    el
+      el
+    when Array
+      axeml.each do |a|
+        transform_element(a, doc, parent)
+      end
+    end
+    
   end
 
 end

data/spec/basic_spec.rb

@@ -40,5 +40,11 @@ describe AxeML do
     doc.root.attributes['bar'].content.should == 'heh!'
     doc.root.attributes['qux'].content.should == '123'
   end
+
+  it 'should allow arbitrary list wrapping' do
+    doc = AxeML.transform([:foo, [[[:foo, 'bar']], [:foo, 'baz']]])
+    doc.search('foo foo:first').text.should == 'bar'
+    doc.search('foo foo:last').text.should == 'baz'
+  end
   
 end

data/spec/spec_helper.rb

@@ -1 +1,2 @@
+require 'rubygems'
 require Pathname.new(__FILE__).dirname.join('..', 'lib', 'axeml')

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: axeml
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Moritz Heidkamp
@@ -34,6 +34,20 @@ dependencies:
         version: 1.2.9
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
 description: AxeML is a notation for Nokogiri XML documents inspired by SXML
 email: moritz.heidkamp@bevuta.com
 executables: []