google_static_maps_helper 1.2.2 → 1.2.3

data/README.rdoc

@@ -18,7 +18,7 @@ Then install this gem
     marker :lng => 3, :lat => 4
   end
 
-This will return the url for map with these markers. Place note that if you do use this approach you have to set key, size and sensor setting.
+This will return the url for map with these markers. Please note that if you do use this approach you have to set key, size and sensor setting.
 You do this by:
   GoogleStaticMapsHelper.key = 'your google key'
   GoogleStaticMapsHelper.size = '300x600'
@@ -60,6 +60,12 @@ zoom and center. More info can be found here: http://code.google.com/apis/maps/d
 When building a map object you have to supply key, sensor and size. Other options are optional.
   map = GoogleStaticMapsHelper::Map.new(:key => YOUR_GOOGLE_KEY, :sensor => false, :size => '200x300')
 
+Or, if you have set default options on GoogleStaticMapsHelper, you can skip the required keys when creating a map
+  GoogleStaticMapsHelper.key = 'your google key'
+  GoogleStaticMapsHelper.size = '300x600'
+  GoogleStaticMapsHelper.sensor = false
+  map = GoogleStaticMapsHelper::Map.new
+
 
 == Generate static map URL
 With the map object made, we are ready to add some markers to it:

data/VERSION

@@ -1 +1 @@
-1.2.2
+1.2.3

data/changelog.txt

@@ -0,0 +1,23 @@
+= v.1.2.3
+* It is no longer needed to send in key, sensor and size to the Map's constructor as long as these values are set on GoogleStaticMapsHelper.
+* A map does now respond to width and height.
+* The map can now receive size as string, array or hash.
+* The map will raise an error if width/height is above the limit which Google currently has (640 pixels).
+
+= v.1.2.2
+* It is now possible to chain the pushing of markers on to map.
+
+= v.1.2.1
+* Bugfix: Sensor wasn't included in the generated URL if it was false.
+
+= v.1.2.0
+* Added a simple DSL interface which should make it easier to use.
+* Fixed a missing escape of an get parameter.
+
+= v.1.1.0
+* Refactored Map class. No longer using internal hash to store the options, but instance variables
+* Refactored Marker class. Same as above.
+* Wrote better test for testing params the URL returned.
+
+= v.1.0.0
+First release. Basic functionality in place which makes usable.

data/google_static_maps_helper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{google_static_maps_helper}
-  s.version = "1.2.2"
+  s.version = "1.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Thorbj\303\270rn Hermansen"]
-  s.date = %q{2009-10-15}
+  s.date = %q{2009-10-25}
   s.description = %q{This gem provides a simple interface to the Google Static Maps V2 API.}
   s.email = %q{thhermansen@gmail.com}
   s.extra_rdoc_files = [
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "changelog.txt",
      "google_static_maps_helper.gemspec",
      "lib/google_static_maps_helper.rb",
      "lib/google_static_maps_helper/map.rb",

data/lib/google_static_maps_helper.rb

@@ -13,7 +13,7 @@ module GoogleStaticMapsHelper
     attr_accessor :key, :size, :sensor
 
     def url_for(map_options = {}, &block)
-      map = Map.new({:key => key, :size => size, :sensor => sensor}.merge(map_options))
+      map = Map.new(map_options)
       block.arity < 1 ? map.instance_eval(&block) : block.call(map)
       map.url
     end

data/lib/google_static_maps_helper/map.rb

@@ -5,16 +5,21 @@ module GoogleStaticMapsHelper
   class Map
     include Enumerable
 
+    MAX_WIDTH = 640
+    MAX_HEIGHT = 640
+
     REQUIRED_OPTIONS = [:key, :size, :sensor]
     OPTIONAL_OPTIONS = [:center, :zoom, :format, :maptype, :mobile, :language]
     
     attr_accessor *(REQUIRED_OPTIONS + OPTIONAL_OPTIONS)
+    attr_accessor :width, :height
 
     # Initialize a new Map object
     #
     # Takes a hash of options where :key, :size and :sensor are required.
     # Other options are center, zoom, format, maptype, mobile and language
     def initialize(options)
+      inject_defaults_from_module_class_attribute!(options)
       validate_required_options(options)
       validate_options(options)
 
@@ -73,7 +78,38 @@ module GoogleStaticMapsHelper
       marker = Marker.new(*args)
       self << marker
     end
+    
+    def size=(size)
+      unless size.nil?
+        case size
+        when String
+          width, height = size.split('x')
+        when Array
+          width, height = size
+        when Hash
+          width = size[:width]
+          height = size[:height]
+        else
+          raise "Don't know how to set size from #{size.class}!"
+        end
+
+        self.width = width if width
+        self.height = height if height
+      end
+    end
 
+    def size
+      [@width, @height].join('x')
+    end
+
+    [:width, :height].each do |name|
+      define_method "#{name}=" do |dimension|
+        dimension = dimension.to_i
+        max_dimension = self.class.const_get("MAX_#{name.to_s.upcase}")
+        raise "Incomming dimension (#{dimension}) above max limit (#{max_dimension})." if dimension > max_dimension
+        instance_variable_set("@#{name}", dimension)
+      end
+    end
 
     private
     def can_build?
@@ -89,5 +125,13 @@ module GoogleStaticMapsHelper
       invalid_options = options.keys - REQUIRED_OPTIONS - OPTIONAL_OPTIONS
       raise OptionNotExist, "The following options does not exist: #{invalid_options.join(', ')}" unless invalid_options.empty?
     end
+
+    def inject_defaults_from_module_class_attribute!(options)
+      REQUIRED_OPTIONS.each do |option_key|
+        next if options.has_key? option_key
+        value_from_modul = GoogleStaticMapsHelper.send(option_key)
+        options[option_key] = value_from_modul unless value_from_modul.nil?
+      end
+    end
   end
 end

data/spec/google_static_maps_helper_spec.rb

@@ -22,11 +22,11 @@ describe GoogleStaticMapsHelper do
       end
 
       it "should be possible to override the default map construction values" do
-        out = GoogleStaticMapsHelper.url_for(:size => '800x800') do
+        out = GoogleStaticMapsHelper.url_for(:size => '600x400') do
           marker :lat => 1, :lng => 2
         end
 
-        out.should include('size=800x800')
+        out.should include('size=600x400')
       end
 
       it "should be possible to use inside a class, using attributes of that class" do

data/spec/map_spec.rb

@@ -2,13 +2,16 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe GoogleStaticMapsHelper::Map do
   @@require_options = {
-    :size => '800x600',
+    :size => '600x400',
     :key => 'MY_GOOGLE_KEY',
     :sensor => false
   }
 
-
   describe "initialize" do
+    before do
+      @@require_options.each_key {|k| GoogleStaticMapsHelper.send("#{k}=", nil)}
+    end
+
     @@require_options.each_key do |key|
       it "should raise OptionMissing if #{key} is not given" do
         option_with_missing_option = @@require_options.dup
@@ -24,6 +27,15 @@ describe GoogleStaticMapsHelper::Map do
     it "should be able to read initialized key option from object" do
       GoogleStaticMapsHelper::Map.new(@@require_options).key.should == @@require_options[:key]
     end
+    
+    @@require_options.each_key do |key|
+      it "should use #{key} from GoogleStaticMapsHelper class attribute if set" do
+        option_with_missing_option = @@require_options.dup
+        GoogleStaticMapsHelper.send("#{key}=", option_with_missing_option.delete(key))
+        map = GoogleStaticMapsHelper::Map.new(option_with_missing_option)
+        map.send(key).should == GoogleStaticMapsHelper.send(key)
+      end
+    end
   end
 
   describe "markers" do
@@ -76,6 +88,58 @@ describe GoogleStaticMapsHelper::Map do
   end
 
 
+  describe "size" do
+    before do
+      @map = GoogleStaticMapsHelper::Map.new(@@require_options)
+      @map.size = '300x400'
+    end
+
+    it "should return map's width" do
+      @map.width.should == 300
+    end
+
+    it "should return map's height" do
+      @map.height.should == 400
+    end
+
+    it "should be able to set width with width :-)" do
+      @map.width = '300'
+      @map.width.should == 300
+    end
+
+    it "should be able to set height" do
+      @map.height = '300'
+      @map.height.should == 300
+    end
+
+    it "should be able to set width and height via size as an array" do
+      @map.size = [200, 300]
+      @map.size.should == '200x300'
+    end
+
+    it "should be able to set width and height via size as a hash" do
+      @map.size = {:width => 100, :height => 500}
+      @map.size.should == '100x500'
+    end
+
+    it "should be possible to only set height via size as a hash" do
+      @map.size = {:height => 500}
+      @map.size.should == '300x500'
+    end
+
+    it "should be possible to only set width via size as a hash" do
+      @map.size = {:width => 500}
+      @map.size.should == '500x400'
+    end
+
+    it "should raise an error if width is above 640px as it is not supported by Google Maps" do
+      lambda {@map.width = 641}.should raise_error
+    end
+
+    it "should raise an error if height is above 640px as it is not supported by Google Maps" do
+      lambda {@map.height = 641}.should raise_error
+    end
+  end
 
   describe "URL" do
     before :each do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: google_static_maps_helper
 version: !ruby/object:Gem::Version 
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors: 
 - "Thorbj\xC3\xB8rn Hermansen"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-15 00:00:00 +02:00
+date: 2009-10-25 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -38,6 +38,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- changelog.txt
 - google_static_maps_helper.gemspec
 - lib/google_static_maps_helper.rb
 - lib/google_static_maps_helper/map.rb