confetti 0.8.3 → 0.9.0

data/lib/confetti/config.rb

@@ -27,7 +27,7 @@ module Confetti
       end
     end
 
-    def initialize(*args)
+    def initialize( *args )
       @author           = Author.new
       @name             = Name.new
       @license          = License.new
@@ -43,27 +43,43 @@ module Confetti
       @plugin_set       = TypedSet.new Plugin
       @viewmodes        = []
 
-      if args.length > 0 && is_file?(args.first)
-        populate_from_xml args.first
+      return if args.empty?
+
+      input = args.first
+
+      if is_file?( input ) || File.extname( input ) == ".xml"
+        populate_from_xml input
+      elsif input.kind_of?( String )
+        populate_from_string input
       end
     end
 
     def populate_from_xml(xml_file)
       begin
         file = File.read(xml_file)
-        config_doc = REXML::Document.new(file).root
-      rescue REXML::ParseException
-        raise XMLError, "malformed config.xml"
       rescue Errno::ENOENT
         raise FileError, "file #{ xml_file } doesn't exist"
       end
+      
+      populate file 
+    end
+
+    def populate_from_string( xml_str )
+      populate xml_str 
+    end
+
+    def populate( config_doc )
+      begin
+        config_doc = REXML::Document.new( config_doc ).root
+      rescue REXML::ParseException
+        raise XMLError, "malformed config.xml"
+      end
 
       if config_doc.nil?
         raise XMLError, "no doc parsed"
       end
 
-      # save reference to xml doc
-      @xml_doc = config_doc
+      @xml_doc = config_doc # save reference to doc
 
       @package = config_doc.attributes["id"]
       @version_string = config_doc.attributes["version"]
@@ -78,58 +94,37 @@ module Confetti
         when "http://www.w3.org/ns/widgets"
           case ele.name
           when "name"
-            @name = Name.new(
-                ele.text.nil? ? "" : ele.text.strip,
-                attr["shortname"]
-                )
+            @name = Name.new(ele.text.nil? ? "" : ele.text.strip,
+                              attr["shortname"])
 
           when "author"
-            @author = Author.new(
-                ele.text.nil? ? "" : ele.text.strip,
-                attr["href"],
-                attr["email"]
-                )
+            @author = Author.new(ele.text.nil? ? "" : ele.text.strip,
+                                  attr["href"], attr["email"])
 
           when "description"
             @description = ele.text.nil? ? "" : ele.text.strip
 
           when "icon"
-            @icon_set << Image.new(
-                attr["src"],
-                attr["height"],
-                attr["width"],
-                attr
-                )
+            @icon_set << Image.new(attr["src"], attr["height"], attr["width"],
+                                    attr)
             # used for the info.plist file
             @plist_icon_set << attr["src"]
 
           when "feature"
-            @feature_set  << Feature.new(
-                attr["name"],
-                attr["required"]
-                )
+            @feature_set  << Feature.new(attr["name"], attr["required"])
 
           when "preference"
-            @preference_set << Preference.new(
-                attr["name"],
-                attr["value"],
-                attr["readonly"]
-                )
+            @preference_set << Preference.new(attr["name"], attr["value"],
+                                              attr["readonly"])
 
           when "license"
-            @license = License.new(
-                ele.text.nil? ? "" : ele.text.strip,
-                attr["href"]
-                )
+            @license = License.new(ele.text.nil? ? "" : ele.text.strip,
+                                   attr["href"])
 
           when "access"
             sub = boolean_value(attr["subdomains"], true)
             browserOnly = boolean_value(attr["browserOnly"])
-            @access_set << Access.new(
-                attr["origin"],
-                sub,
-                browserOnly
-                )
+            @access_set << Access.new(attr["origin"], sub, browserOnly)
           end
 
         # PhoneGap extensions (gap:)
@@ -137,22 +132,15 @@ module Confetti
           case ele.name
           when "splash"
             next if attr["src"].nil? or attr["src"].empty?
-            @splash_set << Image.new(
-                attr["src"],
-                attr["height"],
-                attr["width"],
-                attr
-                )
+            @splash_set << Image.new(attr["src"], attr["height"], attr["width"],
+                                      attr)
 
           when "plugin"
             next if attr["name"].nil? or attr["name"].empty?
             plugin = Plugin.new(attr["name"], attr["version"])
             ele.each_element('param') do |param|
               p_attr = param.attributes
-              plugin.param_set << Param.new(
-                  p_attr["name"],
-                  p_attr["value"]
-                  )
+              plugin.param_set << Param.new(p_attr["name"], p_attr["value"])
             end
             @plugin_set << plugin
           end
@@ -277,17 +265,103 @@ module Confetti
     def filtered_to_s( xpaths = [] )
       xpaths = [ xpaths ] unless xpaths.kind_of?(Array)
 
-      @xml = @xml_doc.dup
+      xml = @xml_doc.dup unless @xml_doc.nil?
+      xml ||= to_xml
 
       xpaths.each do |path|
-        @xml.root.elements.delete_all path
+        xml.root.elements.delete_all path
       end
 
-      @xml.root.to_s
+      xml.root.to_s
     end
 
     def to_s
       @xml_doc.root.to_s
     end
+
+    def to_xml
+      doc = REXML::Document.new
+
+      widget = REXML::Element.new( "widget" )
+      widget.add_attributes({
+        "xmlns" => "http://www.w3.org/ns/widgets",
+        "xmlns:gap" =>  "http://phonegap.com/ns/1.0",
+        "id" => @package,
+        "version" => @version_string
+        })
+
+      if !@version_code.nil?
+        widget.add_attribute({ "versionCode" => @version_code })
+      end
+
+      name = REXML::Element.new( "name" )
+      name.text = @name.name
+      name.add_attribute({ "shortname" => @name.shortname })
+
+      author = REXML::Element.new( "author" )
+      author.text = @author.name
+      author.add_attributes({
+          "href" => @author.href,
+          "email" => @author.email
+          })
+
+      description = REXML::Element.new( "description" )
+      description.text = @description
+
+      license = REXML::Element.new( "license" )
+      license.text = @license.text
+      license.add_attribute({ "href" => @license.href })
+
+      icons = []
+      @icon_set.each do | icon |
+        ico = REXML::Element.new( "icon" )
+        attrs = icon.defined_attrs
+        ico.add_attributes attrs
+        icons << ico
+      end
+
+      splashes = []
+      @splash_set.each do | splash |
+        spl = REXML::Element.new( "gap:splash" )
+        attrs = splash.defined_attrs
+        spl.add_attributes attrs
+        splashes << spl
+      end
+
+      preferences = []
+      @preference_set.each do | preference |
+        pref = REXML::Element.new( "preference" )
+        pref.add_attributes({
+            "name" => preference.name,
+            "value" => preference.value,
+            "readonly" => preference.readonly
+            })
+        preferences << pref
+      end
+
+      features = []
+      @feature_set.each do | feature |
+        feat = REXML::Element.new( "feature" )
+        feat.add_attributes({
+            "name" => feature.name,
+            "required" => feature.required,
+            })
+        features << feat 
+      end
+
+      widget.elements.add name 
+      widget.elements.add author
+      widget.elements.add description 
+      widget.elements.add license 
+
+      icons.each { | icon | widget.elements.add icon }
+      splashes.each { | splash | widget.elements.add splash }
+      preferences.each { | pref | widget.elements.add pref }
+      features.each { | feat | widget.elements.add feat }
+
+      doc << REXML::XMLDecl.new
+      doc.elements.add widget
+      doc
+    end
   end
 end

data/lib/confetti/config/classes.rb

@@ -5,13 +5,80 @@ module Confetti
     class FiletypeError < Confetti::Error ; end
 
     # classes that represent child elements
-    Author      = Class.new Struct.new(:name, :href, :email)
-    Name        = Class.new Struct.new(:name, :shortname)
-    License     = Class.new Struct.new(:text, :href)
-    Content     = Class.new Struct.new(:src, :type, :encoding)
-    Feature     = Class.new Struct.new(:name, :required)
-    Preference  = Class.new Struct.new(:name, :value, :readonly)
-    Access      = Class.new Struct.new(:origin, :subdomains, :browserOnly)
-    Param       = Class.new Struct.new(:name, :value)
+    class Author < Struct.new(:name, :href, :email)
+      def defined_attrs
+        {
+          "name"  => self[ :name ],
+          "href"  => self[ :href ],
+          "email" => self[ :email ]
+        }
+      end
+    end
+
+    class Name < Struct.new(:name, :shortname)
+      def defined_attrs
+        {
+          "name" => self[ :name ],
+          "shortname" => self[ :shortname ]
+        }
+      end
+    end
+
+    class License < Struct.new(:text, :href)
+      def defined_attrs
+        {
+          "text" => self[ :text ],
+          "href" => self[ :href ]
+        }
+      end
+    end
+
+    class Content < Struct.new(:src, :type, :encoding)
+      def defined_attrs
+        {
+          "src" => self[ :src ],
+          "type" => self[ :type ],
+          "encoding" => self[ :encoding ]
+        }
+      end
+    end
+
+    class Feature < Struct.new(:name, :required)
+      def defined_attrs
+        {
+          "name" => self[ :name ],
+          "required" => self[ :required ]
+        }
+      end
+    end
+
+    class Preference < Struct.new(:name, :value, :readonly)
+      def defined_attrs
+        {
+          "name" => self[ :name ],
+          "value" => self[ :value ],
+          "readonly" => self[ :readonly ]
+        }
+      end
+    end
+
+    class Access < Struct.new(:origin, :subdomains, :browserOnly)
+      def defined_attrs
+        {
+          "origin" => self[ :origin ],
+          "subdomains" => self[ :subdomains ],
+          "browserOnly" => self[ :browserOnly ]
+        }
+      end
+    end
+
+    class Param < Struct.new(:name, :value)
+      def defined_attrs
+        {
+          "name" => self[ :name ],
+          "value" => self[ :value ]
+        }
+      end
+    end
   end
 end

data/lib/confetti/config/image.rb

@@ -19,6 +19,19 @@ module Confetti
         @density     = @extras['density']
         @state     = @extras['state']
       end
+
+      def defined_attrs
+        {
+            "src" => @src,
+            "height" => @height,
+            "width" => @width,
+            "gap:role" => @role,
+            "gap:platform" => @platform,
+            "gap:main" => @main,
+            "gap:density" => @density,
+            "gap:state" => @state
+        }
+      end
     end
   end
 end

data/lib/confetti/version.rb

@@ -1,3 +1,3 @@
 module Confetti
-  VERSION = "0.8.3"
+  VERSION = "0.9.0"
 end

data/spec/config/config_access_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Confetti::Config::Access do
+  before do
+    @access = Confetti::Config::Access.new
+  end
+
+  it "should define a defined_attrs method" do
+    access = Confetti::Config::Access.new( "google.ca", true, false )
+
+    access.defined_attrs.should == {
+      "origin" => "google.ca",
+      "subdomains" => true,
+      "browserOnly" => false
+    }
+  end
+end

data/spec/config/config_author_spec.rb

@@ -11,7 +11,10 @@ describe Confetti::Config::Author do
   end
 
   it "should have a readable and writable href field" do
-    lambda { @author.href = "http://alunny.github.com" }.should_not raise_error
+    lambda {
+        @author.href = "http://alunny.github.com"
+        }.should_not raise_error
+
     @author.href.should == "http://alunny.github.com"
   end
 
@@ -19,4 +22,15 @@ describe Confetti::Config::Author do
     lambda { @author.email = "alunny@gmail.com" }.should_not raise_error
     @author.email.should == "alunny@gmail.com"
   end
+
+  it "should define a defined_attrs method" do
+    author = Confetti::Config::Author.new(
+        "hardeep", "127.0.0.1", "shardeep@adobe.com")
+
+    author.defined_attrs.should == {
+      "name" => "hardeep",
+      "href" => "127.0.0.1",
+      "email" => "shardeep@adobe.com"
+    }
+  end
 end

data/spec/config/config_content_spec.rb

@@ -19,4 +19,13 @@ describe Confetti::Config::Content do
     lambda { @content.encoding = "GB2313" }.should_not raise_error
     @content.encoding.should == "GB2313"
   end
+
+  it "should define a defined_attrs method" do
+    content = Confetti::Config::Content.new(
+      "some/path", "text/html", "utf-8")
+
+    content.defined_attrs.should == {
+        "src" => "some/path", "type" => "text/html", "encoding" => "utf-8"
+    }
+  end
 end

data/spec/config/config_feature_spec.rb

@@ -30,4 +30,13 @@ describe Confetti::Config::Feature do
       }.should raise_error
     end
   end
+
+  it "should define a defined_attrs method" do
+    feature = Confetti::Config::Feature.new( "Geolocation", true )
+    
+    feature.defined_attrs.should == {
+      "name" => "Geolocation",
+      "required" => true 
+    }
+  end
 end

data/spec/config/config_image_spec.rb

@@ -19,4 +19,19 @@ describe Confetti::Config::Image do
     lambda { @image.height = 50 }.should_not raise_error
     @image.height.should == 50
   end
+
+  it "should define a attribute dump method" do
+    img = Confetti::Config::Image.new
+    attrs = img.defined_attrs
+    attrs.should == {
+        "gap:main"=>nil,
+        "gap:platform"=>nil,
+        "gap:state"=>nil,
+        "src"=>nil,
+        "gap:density"=>nil,
+        "height"=>nil,
+        "gap:role"=>nil,
+        "width"=>nil
+        }
+  end
 end

data/spec/config/config_license_spec.rb

@@ -6,12 +6,27 @@ describe Confetti::Config::License do
   end
 
   it "should have a readable and writable text field" do
-    lambda { @license.text = "You can do WTF you want" }.should_not raise_error
+    lambda {
+        @license.text = "You can do WTF you want"
+        }.should_not raise_error
+
     @license.text.should == "You can do WTF you want"
   end
 
   it "should have a readable and writable href field" do
-    lambda { @license.href = "http://apache.org/license" }.should_not raise_error
+    lambda {
+        @license.href = "http://apache.org/license"
+        }.should_not raise_error
+
     @license.href.should == "http://apache.org/license"
   end
+
+  it "should define a defined_attrs method" do
+    license = Confetti::Config::License.new(
+      "Some License", "Some Url")
+
+    license.defined_attrs.should == {
+      "text" => "Some License", "href" => "Some Url"
+    }
+  end
 end

data/spec/config/config_name_spec.rb

@@ -6,7 +6,10 @@ describe Confetti::Config::Name do
   end
 
   it "should have a readable and writable name field" do
-    lambda { @name.name = "Microsoft Windows 7 Ultimate Edition" }.should_not raise_error
+    lambda {
+        @name.name = "Microsoft Windows 7 Ultimate Edition"
+        }.should_not raise_error
+
     @name.name.should == "Microsoft Windows 7 Ultimate Edition"
   end
 
@@ -14,4 +17,12 @@ describe Confetti::Config::Name do
     lambda { @name.shortname = "Windows7" }.should_not raise_error
     @name.shortname.should == "Windows7"
   end
+
+  it "should define a defined_attrs method" do
+    name = Confetti::Config::Name.new( "Long Title", "Short Title" )
+
+    name.defined_attrs.should == {
+      "name" => "Long Title", "shortname" => "Short Title"
+    }
+  end
 end

data/spec/config/config_preference_spec.rb

@@ -19,4 +19,15 @@ describe Confetti::Config::Preference do
     lambda { @pref.readonly = true }.should_not raise_error
     @pref.readonly.should be_true
   end
+
+  it "should define a defined_attrs method" do
+    pref = Confetti::Config::Preference.new(
+        "Some Preference", "Some Setting", false )
+
+    pref.defined_attrs.should == {
+      "name" => "Some Preference",
+      "value" => "Some Setting",
+      "readonly" => false
+    }
+  end
 end

data/spec/config_spec.rb

@@ -151,7 +151,8 @@ describe Confetti::Config do
     end
 
     it "should call #is_file? with an argument passed" do
-      @blank_config.should_receive(:is_file?)
+      @blank_config.stub( :populate_from_xml )
+      @blank_config.should_receive( :is_file? )
       @blank_config.send :initialize, "config.xml"
     end
 
@@ -160,6 +161,18 @@ describe Confetti::Config do
       @blank_config.should_receive(:populate_from_xml).with("config.xml")
       @blank_config.send :initialize, "config.xml"
     end
+
+    it "should call #populate_from_string when a string is passed" do
+      @blank_config.should_receive(
+        :populate_from_string).with("</widget>")
+      @blank_config.send :initialize, "</widget>"
+    end
+
+    it "should throw an exception when a bad config path is passed" do
+      lambda{
+        @blank_config.send :initialize, "config.xml"
+      }.should raise_error Confetti::Config::FileError
+    end
   end
 
   describe "#populate_from_xml" do
@@ -747,7 +760,28 @@ describe Confetti::Config do
 
     it "should serialize when no filters provided" do
       @config.to_s.should match /icon/
+      # this should remove all instances of icons from the string
       @config.filtered_to_s("//icon").should_not match /icon/
     end
+
+    describe "#to_xml" do
+        
+      it "should define a to_xml method" do
+        @config.should respond_to :to_xml
+      end
+
+      it "should render the config as valid xml" do
+        # if given a config object running a to_xml and feeding
+        # it back into a config object should produce the same contents
+        out = ""
+        @config.to_xml.write( out, 2 )
+        config = Confetti::Config.new out
+        config.author.name.should == "Andrew Lunny"
+        config.feature_set.length.should == 3
+        config.preference_set.length.should == 2
+        config.icon_set.length.should == 1
+        config.splash_set.length.should == 1
+      end
+    end
   end
 end

data/spec/fixtures/config-to_xml.xml

@@ -0,0 +1,36 @@
+<?xml version='1.0'?>
+<widget xmlns:gap='http://phonegap.com/ns/1.0' id='com.alunny.confetti' version='1.0.0' xmlns='http://www.w3.org/ns/widgets'>
+  <name>
+    Confetti Sample App
+  </name>
+  <author href='http://alunny.github.com' email='alunny@gmail.com'>
+    Andrew Lunny
+  </author>
+  <description>
+    This is a sample config.xml for integration testing with Confetti
+  </description>
+  <license>
+    The MIT License Copyright (c) 2011 Andrew Lunny Permission is hereby
+    granted, free of charge, to any person obtaining a copy of this software and
+    associated documentation files (the &quot;Software&quot;), to deal in the
+    Software without restriction, including without limitation the rights to
+    use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions: The above copyright
+    notice and this permission notice shall be included in all copies or
+    substantial portions of the Software. THE SOFTWARE IS PROVIDED &quot;AS
+    IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+    NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+    PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+    HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+    ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+  </license>
+  <icon src='icon.png' height='150' width='200'/>
+  <gap:splash src='mainsplash.png' height='480' width='360'/>
+  <preference name='phonegap-version' value='1.3.0'/>
+  <preference name='universal' value='true'/>
+  <feature name='http://api.phonegap.com/1.0/camera' required='true'/>
+  <feature name='http://api.phonegap.com/1.0/notification' required='true'/>
+  <feature name='http://api.phonegap.com/1.0/geolocation' required='true'/>
+</widget>

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 8
-  - 3
-  version: 0.8.3
+  - 9
+  - 0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Andrew Lunny
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-26 00:00:00 -07:00
+date: 2012-07-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -98,6 +98,7 @@ files:
 - lib/confetti/templates/windows_phone7_manifest.rb
 - lib/confetti/version.rb
 - lib/typedset.rb
+- spec/config/config_access_spec.rb
 - spec/config/config_author_spec.rb
 - spec/config/config_content_spec.rb
 - spec/config/config_feature_spec.rb
@@ -123,6 +124,7 @@ files:
 - spec/fixtures/config-icons.xml
 - spec/fixtures/config-long-desc.xml
 - spec/fixtures/config-plugins.xml
+- spec/fixtures/config-to_xml.xml
 - spec/fixtures/config.xml
 - spec/fixtures/config_fullscreen.xml
 - spec/fixtures/config_legacy.xml
@@ -192,6 +194,7 @@ signing_key:
 specification_version: 3
 summary: Generate mobile app config files
 test_files: 
+- spec/config/config_access_spec.rb
 - spec/config/config_author_spec.rb
 - spec/config/config_content_spec.rb
 - spec/config/config_feature_spec.rb
@@ -217,6 +220,7 @@ test_files:
 - spec/fixtures/config-icons.xml
 - spec/fixtures/config-long-desc.xml
 - spec/fixtures/config-plugins.xml
+- spec/fixtures/config-to_xml.xml
 - spec/fixtures/config.xml
 - spec/fixtures/config_fullscreen.xml
 - spec/fixtures/config_legacy.xml