confetti 0.7.3 → 0.7.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    confetti (0.7.3)
+    confetti (0.7.4)
       mustache (~> 0.11.2)
 
 GEM

data/lib/confetti.rb

@@ -39,3 +39,4 @@ require 'confetti/template_helper'
 
 require 'confetti/config'
 require 'confetti/config/feature'
+require 'confetti/config/image'

data/lib/confetti/config.rb

@@ -37,7 +37,6 @@ module Confetti
     Name        = Class.new Struct.new(:name, :shortname)
     License     = Class.new Struct.new(:text, :href)
     Content     = Class.new Struct.new(:src, :type, :encoding)
-    Image       = Class.new Struct.new(:src, :height, :width, :extras)
     Feature     = Class.new Struct.new(:name, :required)
     Preference  = Class.new Struct.new(:name, :value, :readonly)
     Access      = Class.new Struct.new(:origin, :subdomains)
@@ -96,8 +95,7 @@ module Confetti
           when "description"
             @description = ele.text.nil? ? "" : ele.text.strip
           when "icon"
-            extras = grab_extras attr
-            @icon_set << Image.new(attr["src"], attr["height"], attr["width"], extras)
+            @icon_set << Image.new(attr["src"], attr["height"], attr["width"], attr)
             # used for the info.plist file
             @plist_icon_set << attr["src"]
           when "feature"
@@ -117,8 +115,7 @@ module Confetti
           case ele.name
           when "splash"
             next if attr["src"].nil? or attr["src"].empty?
-            extras = grab_extras attr
-            @splash_set << Image.new(attr["src"], attr["height"], attr["width"], extras)
+            @splash_set << Image.new(attr["src"], attr["height"], attr["width"], attr)
           end
         end
       end
@@ -149,14 +146,6 @@ module Confetti
       end
     end
 
-    def grab_extras(attributes)
-      extras = attributes.keys.inject({}) do |hash, key|
-        hash[key] = attributes[key] unless Image.public_instance_methods.include? key
-        hash
-      end
-      extras
-    end
-
     # helper to retrieve a preference's value
     # returns nil if the preference doesn't exist
     def preference name
@@ -175,5 +164,58 @@ module Confetti
     def full_access?
       @access_set.detect { |a| a.origin == '*' }
     end
+
+    def find_best_fit_img images, opts = {}
+      opts['width']     ||= nil
+      opts['height']    ||= nil
+      opts['role']      ||= nil
+      opts['platform']  ||= nil
+
+      # filters to look through sets for
+      filters = [
+        {'height' => opts['height'], 'width' => opts['width']},
+        {'platform' => opts['platform'], 'role' => opts['role']},
+        {'platform' => opts['platform']}
+      ]
+
+      matches = nil
+
+      filters.each do |filter|
+        matches = filter_images(images, filter)
+
+        if matches.length == 1
+          break
+        end
+      end
+
+      matches.first unless matches.empty?
+    end
+
+    def default_icon
+      @icon_set.each do |icon|
+        return icon unless !File.basename(icon.src).match(/icon\.png$/i)
+      end
+      nil
+    end
+
+    def default_splash
+      @splash_set.each do |splash|
+        return splash unless !File.basename(splash.src).match(/splash\.png$/i)
+      end
+      nil
+    end
+
+    def filter_images images, filter
+      imgs = images.clone
+
+      # filter can have multiple criteria
+      filter.each_pair do |name, value|
+        imgs = imgs.reject do |img|
+          !img.respond_to?(name) || img.send(name) != value
+        end
+      end
+
+      imgs
+    end
   end
 end

data/lib/confetti/config/image.rb

@@ -0,0 +1,22 @@
+module Confetti
+  class Config
+    class Image 
+      attr_accessor :src, :width, :height, :extras, :role, :platform, :main
+
+      def initialize *args
+        @src = args.shift
+        @height = args.shift
+        @width = args.shift
+
+        @extras   = (args.shift || {}).reject do |name, val|
+          %w{src height width}.include?(name)
+        end
+
+        @role     = @extras['role']
+        @platform = @extras['platform']
+        @main     = @extras['main']
+      end
+    end
+  end
+end
+

data/lib/confetti/version.rb

@@ -1,3 +1,3 @@
 module Confetti
-  VERSION = "0.7.3"
+  VERSION = "0.7.4"
 end

data/spec/config_spec.rb

@@ -265,10 +265,13 @@ describe Confetti::Config do
         describe "with custom splash screen attributes" do
           before do
             @config = Confetti::Config.new
-            @config.populate_from_xml(fixture_dir + "/config-icons-custom-attribs.xml")
+            @config.populate_from_xml(
+              fixture_dir + "/config-icons-custom-attribs.xml"
+              )
           end
 
           it "should populate splash screen non-standards attributes to extras field" do
+            p @config.splash_set
             @config.splash_set.size.should be 1
             @config.splash_set.first.extras.should_not == nil
             @config.splash_set.first.extras.length.should be 1
@@ -531,4 +534,87 @@ describe Confetti::Config do
       @config.full_access?.should be_false
     end
   end
+
+  describe "platform and role helpers" do
+    before do
+      file = "#{fixture_dir}/config-icons-custom-attribs-extended.xml"
+      @config = Confetti::Config.new file 
+    end
+
+    it "should return all blackberry icons with hover" do
+      match = @config.filter_images(
+          @config.icon_set,
+          { 
+            'platform' => 'blackberry',
+            'role' => 'hover'
+          }
+        )
+      match.length.should == 1
+      match.first.src.should == 'icons/icon_hover.png'
+    end
+
+    it "should return all icons" do
+      match = @config.filter_images(@config.icon_set,{})
+      match.length.should == 11
+    end
+
+    it "should find the best fit image for bb" do
+      match = @config.find_best_fit_img(
+        @config.icon_set,
+        {
+          'platform' => 'blackberry',
+          'role' => 'hover'
+        }
+      )
+      match.src.should == "icons/icon_hover.png"
+    end
+
+    it "should find the best fit icon for winphone" do
+      # we will find a 68pixel image as it fits out platform
+      # specification
+      match = @config.find_best_fit_img(
+        @config.send(:icon_set),
+        {
+          'height' => '54',
+          'width' => '54',
+          'platform' => 'winphone',
+          'role' => 'default'
+        }
+      )
+      match.src.should == "icons/icon-68.png"
+    end
+
+    it "should find the best fit splash for android" do
+      # we will find a 68pixel image as it fits out platform
+      # specification
+      match = @config.find_best_fit_img(
+        @config.send(:splash_set),
+        {
+          'height' => '54',
+          'width' => '54',
+          'platform' => 'android',
+          'role' => 'default'
+        }
+      )
+      match.src.should == "splashes/splash-android.png"
+    end
+
+    it "should return the default icon: icon.png" do
+      @config.default_icon.src.should == "icons/icon.png"
+    end
+
+    it "should fail to return the default icon: icon.png" do
+      @config = Confetti::Config.new
+      @config.default_icon.should != nil 
+    end
+
+    it "should return the default splash: splash.png" do
+      @config.default_splash.src.should == "splashes/splash.png"
+    end
+
+    it "should fail to return the default splash: splash.png" do
+      @config = Confetti::Config.new
+      @config.default_splash.should != nil 
+    end
+  end
 end

data/spec/fixtures/config-icons-custom-attribs-extended.xml

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<widget xmlns		= "http://www.w3.org/ns/widgets"
+    xmlns:gap	= "http://phonegap.com/ns/1.0"
+	id		= "com.alunny.confetti"
+	version 	= "1.0.0">
+
+	<name>Confetti Sample App</name>
+
+	<description>
+		This is a sample config.xml for integration testing with Confetti
+	</description>
+
+	<author href="http://alunny.github.com"
+		email="hardeep.shoker@nitobi.com">
+		Hardeep Shoker
+	</author>
+
+    <icon src="icons/icon.png" />
+    <gap:splash src="splashes/splash.png" />
+
+    <icon src="icons/icon.png" gap:platform="blackberry" />
+    <icon src="icons/icon_hover.png" gap:platform="blackberry" gap:role="hover"/>
+
+    <icon src="icons/icon-57.png" width="57" height="57"/>
+	<icon src="icons/icon-iphone-72.png" height="72" width="72" gap:platform="ios"/>
+    <icon src="icons/icon-114.png" width="114" height="114"/>
+
+    <icon src="icons/icon-36.png" width="36" height="36"/>
+    <icon src="icons/icon-48.png" width="48" height="48"/>
+	<icon src="icons/icon-android-72.png" height="72" width="72" gap:platform="android"/>
+    <gap:splash src="splashes/splash-android.png" gap:platform="android"/>
+
+	<icon src="icons/icon-173.png" width="173" height="173"/>
+	<icon src="icons/icon-68.png" gap:platform="winphone"/>
+
+	<feature name="http://api.phonegap.com/1.0/geolocation"/>
+	<feature name="http://api.phonegap.com/1.0/network"/>
+</widget>

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 7
-  - 3
-  version: 0.7.3
+  - 4
+  version: 0.7.4
 platform: ruby
 authors: 
 - Andrew Lunny
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-29 00:00:00 -07:00
+date: 2012-04-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,6 +67,7 @@ files:
 - lib/confetti.rb
 - lib/confetti/config.rb
 - lib/confetti/config/feature.rb
+- lib/confetti/config/image.rb
 - lib/confetti/error.rb
 - lib/confetti/helpers.rb
 - lib/confetti/phonegap.rb
@@ -115,6 +116,7 @@ files:
 - spec/fixtures/blackberry/blackberry_widget_config_no_version_or_id.xml
 - spec/fixtures/blackberry/blackberry_widget_config_spec.xml
 - spec/fixtures/blackberry/blackberry_widget_config_spec_with_expected_orientation.xml
+- spec/fixtures/config-icons-custom-attribs-extended.xml
 - spec/fixtures/config-icons-custom-attribs.xml
 - spec/fixtures/config-icons.xml
 - spec/fixtures/config.xml
@@ -204,6 +206,7 @@ test_files:
 - spec/fixtures/blackberry/blackberry_widget_config_no_version_or_id.xml
 - spec/fixtures/blackberry/blackberry_widget_config_spec.xml
 - spec/fixtures/blackberry/blackberry_widget_config_spec_with_expected_orientation.xml
+- spec/fixtures/config-icons-custom-attribs-extended.xml
 - spec/fixtures/config-icons-custom-attribs.xml
 - spec/fixtures/config-icons.xml
 - spec/fixtures/config.xml