map-kit-wrapper 0.0.4 → 0.0.5

data/README.md

@@ -29,11 +29,8 @@ class FooViewController < UIViewController
 	  map = MapView.new
 	  map.frame = self.view.frame
 	  map.delegate = self
-	  region = CoordinateRegion.new([56, 10.6], [3.1, 3.1])
-	  map.region = region
-	  # Alternatively use set_region
-	  # map.set_region(region, :animated => true)
-	  map.showsUserLocation = true
+	  map.region = CoordinateRegion.new([56, 10.6], [3.1, 3.1])
+	  map.shows_user_location = true
 	  view.addSubview(map)
 	end
 	
@@ -150,7 +147,7 @@ Methods on `LocationCoordinate`
 => [10, 15]
 >> lc.to_h
 => {:latitude => 10, :longitude => 15}
->> lc.sdk
+>> lc.api
 => CLLocationCoordinate2D
 ```
 
@@ -187,7 +184,7 @@ Methods on `CoordinateSpan`
 => [1, 2]
 >> cs.to_h
 => {:latitude_delta => 1, :longitude_delta => 2}
->> cs.sdk
+>> cs.api
 => MKCoordinateSpan
 ```
 
@@ -215,7 +212,7 @@ Methods on `CoordinateRegion`
 => CoordinateSpan([3.1, 5.1])
 >> cs.to_h
 => {:center => {:latitude => 56, :longitude => 10.6}, :span => {:latitude_delta => 3.1, :longitude_delta => 5.1}}
->> cs.sdk
+>> cs.api
 => MKCoordinateRegion
 ```
 
@@ -244,7 +241,7 @@ Methods on `MapPoint`
 => [50, 45]
 >> mp.to_h
 => {:x => 50, :y => 45}
->> mp.sdk
+>> mp.api
 => MKMapPoint
 ```
 
@@ -273,7 +270,7 @@ Methods on `MapSize`
 => [50, 45]
 >> ms.to_h
 => {:width => 50, :height => 45}
->> ms.sdk
+>> ms.api
 => MKMapSize
 ```
 
@@ -302,7 +299,7 @@ Methods on `MapRect`
 => MapSize([10, 12])
 >> mr.to_h
 => {:origin => {:x => 2, :y => 3}, :size => {:width => 10, :height => 12}}
->> mr.sdk
+>> mr.api
 => MKMapRect
 ```
 

data/lib/map-kit-wrapper/core_location_data_types.rb

@@ -1,19 +1,34 @@
+##
+# Wrappers for Core Location
+#
 module CoreLocation
+
   ##
   # Wrappers for the Core Location Data Types
   # http://developer.apple.com/library/mac/#documentation/CoreLocation/Reference/CoreLocationDataTypesRef/Reference/reference.html
   module DataTypes
+
     ##
     # Ruby wrapper for CLLocationCoordinate2D
     class LocationCoordinate
+
+      ##
+      # Attribute reader
+      #
       attr_reader :latitude, :longitude
 
       ##
-      # LocationCoordinate.new(1,2)
-      # LocationCoordinate.new([1,2])
-      # LocationCoordinate.new({:latitude => 1, :longitude => 2})
-      # LocationCoordinate.new(LocationCoordinate)
-      # LocationCoordinate.new(CLLocationCoordinate2D)
+      # Initializer for LocationCoordinate
+      #
+      # * *Args*    :
+      # The initializer takes a variety of arguments
+      #
+      #    LocationCoordinate.new(1,2)
+      #    LocationCoordinate.new([1,2])
+      #    LocationCoordinate.new({:latitude => 1, :longitude => 2})
+      #    LocationCoordinate.new(LocationCoordinate)
+      #    LocationCoordinate.new(CLLocationCoordinate2D)
+      #
       def initialize(*args)
         args.flatten!
         self.latitude, self.longitude =
@@ -31,26 +46,58 @@ module CoreLocation
             end
       end
 
-      def sdk
+      ##
+      # Returns the wrapped iOS CLLocationCoordinate2D object
+      def api
         CLLocationCoordinate2DMake(@latitude, @longitude)
       end
 
+      ##
+      # Setter for latitude
+      #
+      # * *Args*    :
+      #   - +latitude+ -> Int or Float
+      #
       def latitude=(latitude)
         @latitude = latitude.to_f
       end
 
+      ##
+      # Setter for longitude
+      #
+      # * *Args*    :
+      #   - +longitude+ -> Int or Float
+      #
       def longitude=(longitude)
         @longitude = longitude.to_f
       end
 
+      ##
+      # Get self as an Array
+      #
+      # * *Returns* :
+      #   - <tt>[latitude, longitude]</tt>
+      #
       def to_a
         [@latitude, @longitude]
       end
 
+      ##
+      # Get self as a Hash
+      #
+      # * *Returns* :
+      #   - <tt>{:latitude => latitude, :longitude => longitude}</tt>
+      #
       def to_h
         {:latitude => @latitude, :longitude => @longitude}
       end
 
+      ##
+      # Get self as a String
+      #
+      # * *Returns* :
+      #   - <tt>"{:latitude => latitude, :longitude => longitude}"</tt>
+      #
       def to_s
         to_h.to_s
       end

data/lib/map-kit-wrapper/map_kit_data_types.rb

@@ -1,20 +1,35 @@
 #= require core_location_data_types
 
+##
+# Wrappers for MapKit
+#
 module MapKit
+
   ##
   # Wrappers for the Map Kit Data Types
   # http://developer.apple.com/library/ios/#documentation/MapKit/Reference/MapKitDataTypesReference/Reference/reference.html
   module DataTypes
+
     ##
     # Wrapper for MKCoordinateSpan
     class CoordinateSpan
+
+      ##
+      # Attribute reader
+      #
       attr_reader :latitude_delta, :longitude_delta
+
       ##
-      # CoordinateSpan.new(1,2)
-      # CoordinateSpan.new([1,2])
-      # CoordinateSpan.new({:latitude_delta => 1, :longitude_delta => 2})
-      # CoordinateSpan.new(CoordinateSpan)
-      # CoordinateSpan.new(MKCoordinateSpan)
+      # Initializer for CoordinateSpan
+      #
+      # * *Args*    :
+      # The initializer takes a variety of arguments
+      #
+      #    CoordinateSpan.new(1,2)
+      #    CoordinateSpan.new([1,2])
+      #    CoordinateSpan.new({:latitude_delta => 1, :longitude_delta => 2})
+      #    CoordinateSpan.new(CoordinateSpan)
+      #    CoordinateSpan.new(MKCoordinateSpan)
       def initialize(*args)
         args.flatten!
         self.latitude_delta, self.longitude_delta =
@@ -34,42 +49,91 @@ module MapKit
             end
       end
 
-      def sdk
+      ##
+      # Returns the wrapped iOS MKCoordinateSpan object
+      #
+      # * *Returns* :
+      #   - A MKCoordinateSpan representation of self
+      #
+      def api
         MKCoordinateSpanMake(@latitude_delta, @longitude_delta)
       end
 
+      ##
+      # Setter for latitude_delta
+      #
+      # * *Args*    :
+      #   - +delta+ -> Int or Float
+      #
       def latitude_delta=(delta)
         @latitude_delta = delta.to_f
       end
 
+      ##
+      # Setter for longitude_delta
+      #
+      # * *Args*    :
+      #   - +delta+ -> Int or Float
+      #
       def longitude_delta=(delta)
         @longitude_delta = delta.to_f
       end
 
+      ##
+      # Get self as an Array
+      #
+      # * *Returns* :
+      #   - <tt>[latitude_delta, longitude_delta]</tt>
+      #
       def to_a
         [@latitude_delta, @longitude_delta]
       end
 
+      ##
+      # Get self as a Hash
+      #
+      # * *Returns* :
+      #   - <tt>{:latitude_delta => latitude_delta, :longitude_delta => longitude_delta}</tt>
+      #
       def to_h
         {:latitude_delta => @latitude_delta, :longitude_delta => @longitude_delta}
       end
 
+      ##
+      # Get self as a String
+      #
+      # * *Returns* :
+      #   - <tt>"{:latitude_delta => latitude_delta, :longitude_delta => longitude_delta}"</tt>
+      #
       def to_s
         to_h.to_s
       end
     end
+
     ##
     # Wrapper for MKCoordinateRegion
     class CoordinateRegion
       include CoreLocation::DataTypes
+
+      ##
+      # Attribute reader
+      #
       attr_reader :center, :span
+
       ##
-      # CoordinateRegion.new(CoordinateRegion)
-      # CoordinateRegion.new(MKCoordinateRegion)
-      # CoordinateRegion.new([56, 10.6], [3.1, 3.1])
-      # CoordinateRegion.new({:center => {:latitude => 56, :longitude => 10.6}, :span => {:latitude_delta => 3.1, :longitude_delta => 3.1}}
-      # CoordinateRegion.new(LocationCoordinate, CoordinateSpan)
-      # CoordinateRegion.new(CLLocationCoordinate2D, MKCoordinateSpan)
+      # Initializer for CoordinateRegion
+      #
+      # * *Args*    :
+      # The initializer takes a variety of arguments
+      #
+      #    CoordinateRegion.new(CoordinateRegion)
+      #    CoordinateRegion.new(MKCoordinateRegion)
+      #    CoordinateRegion.new([56, 10.6], [3.1, 3.1])
+      #    CoordinateRegion.new({:center => {:latitude => 56, :longitude => 10.6},
+      #                          :span => {:latitude_delta => 3.1, :longitude_delta => 3.1}}
+      #    CoordinateRegion.new(LocationCoordinate, CoordinateSpan)
+      #    CoordinateRegion.new(CLLocationCoordinate2D, MKCoordinateSpan)
+      #
       def initialize(*args)
         self.center, self.span =
             case args.size
@@ -86,35 +150,76 @@ module MapKit
             end
       end
 
-      def sdk
-        MKCoordinateRegionMake(@center.sdk, @span.sdk)
+      ##
+      # Returns the wrapped iOS MKCoordinateRegion object
+      #
+      # * *Returns* :
+      #   - A MKCoordinateRegion representation of self
+      #
+      def api
+        MKCoordinateRegionMake(@center.api, @span.api)
       end
 
+      ##
+      # Assigns a CoreLocation::DataTypes::LocationCoordinate to center.
+      #
+      # * *Args* :
+      #   - +center+ -> accepts a variety of argument types. See docs for the CoreLocation::DataTypes::LocationCoordinate initializer
+      #
       def center=(center)
         @center = LocationCoordinate.new(center)
       end
 
+      ##
+      # Assigns a MapKit::DataTypes::CoordinateSpan to span
+      #
+      # * *Args* :
+      #   - +span+ -> accepts a variety of argument types. See docs for the MapKit::DataTypes::CoordinateSpan initializer
+      #
       def span=(span)
         @span = CoordinateSpan.new(span)
       end
 
+      ##
+      # Get self as a Hash
+      #
+      # * *Returns* :
+      #   - <tt>{:center => {:latitude => latitude, :longitude => longitude}, :span => {:latitude_delta => latitude_delta, :longitude_delta => longitude_delta}}</tt>
+      #
       def to_h
         {:center => @center.to_h, :span => @span.to_h}
       end
 
+      ##
+      # Get self as a String
+      #
+      # * *Returns* :
+      #   - <tt>"{:center => {:latitude => latitude, :longitude => longitude}, :span => {:latitude_delta => latitude_delta, :longitude_delta => longitude_delta}}"</tt>
+      #
       def to_s
         to_h.to_s
       end
     end
+
     ##
     # Wrapper for MKMapPoint
     class MapPoint
+
+      ##
+      # Attribute reader
+      #
       attr_reader :x, :y
+
       ##
-      # MapPoint.new(50,45)
-      # MapPoint.new([50,45])
-      # MapPoint.new({:x => 50, :y => 45})
-      # MapPoint.new(MKMapPoint)
+      # Initializer for MapPoint
+      #
+      # * *Args*    :
+      # The initializer takes a variety of arguments
+      #
+      #    MapPoint.new(50,45)
+      #    MapPoint.new([50,45])
+      #    MapPoint.new({:x => 50, :y => 45})
+      #    MapPoint.new(MKMapPoint)
       def initialize(*args)
         args.flatten!
         self.x, self.y =
@@ -132,40 +237,88 @@ module MapKit
             end
       end
 
-      def sdk
+      ##
+      # Returns the wrapped iOS MKMapPoint object
+      #
+      # * *Returns* :
+      #   - A MKMapPoint representation of self
+      #
+      def api
         MKMapPointMake(@x, @y)
       end
 
+      ##
+      # Setter for x
+      #
+      # * *Args*    :
+      #   - +x+ -> Int or Float
+      #
       def x=(x)
         @x = x.to_f
       end
 
+      ##
+      # Setter for y
+      #
+      # * *Args*    :
+      #   - +y+ -> Int or Float
+      #
       def y=(y)
         @y = y.to_f
       end
 
+      ##
+      # Get self as an Array
+      #
+      # * *Returns* :
+      #   - <tt>[x, y]</tt>
+      #
       def to_a
         [@x, @y]
       end
 
+      ##
+      # Get self as a Hash
+      #
+      # * *Returns* :
+      #   - <tt>{:x => x, :y => y}</tt>
+      #
       def to_h
         {:x => @x, :y => @y}
       end
 
+      ##
+      # Get self as a String
+      #
+      # * *Returns* :
+      #   - <tt>"{:x => x, :y => y}"</tt>
+      #
       def to_s
         to_h.to_s
       end
     end
+
     ##
     # Wrapper for MKMapSize
     class MapSize
+
+      ##
+      # Attribute reader
+      #
       attr_reader :width, :height
+
       ##
-      # MapSize.new(10,12)
-      # MapSize.new([10,12])
-      # MapSize.new({:width => 10, :height => 12})
-      # MapSize.new(MKMapSize)
-      # MapSize.new(MapSize)
+      # Initializer for MapSize
+      #
+      # * *Args*    :
+      # The initializer takes a variety of arguments
+      #
+      #    MapSize.new(10,12)
+      #    MapSize.new([10,12])
+      #    MapSize.new({:width => 10, :height => 12})
+      #    MapSize.new(MKMapSize)
+      #    MapSize.new(MapSize)
+      #
       def initialize(*args)
         args.flatten!
         self.width, self.height =
@@ -183,42 +336,90 @@ module MapKit
             end
       end
 
-      def sdk
+      ##
+      # Returns the wrapped iOS MKMapSize object
+      #
+      # * *Returns* :
+      #   - A MKMapSize representation of self
+      #
+      def api
         MKMapSizeMake(@width, @height)
       end
 
+      ##
+      # Setter for width
+      #
+      # * *Args*    :
+      #   - +width+ -> Int or Float
+      #
       def width=(width)
         @width = width.to_f
       end
 
+      ##
+      # Setter for height
+      #
+      # * *Args*    :
+      #   - +height+ -> Int or Float
+      #
       def height=(height)
         @height = height.to_f
       end
 
+      ##
+      # Get self as an Array
+      #
+      # * *Returns* :
+      #   - <tt>[@width, @height]</tt>
+      #
       def to_a
         [@width, @height]
       end
 
+      ##
+      # Get self as a Hash
+      #
+      # * *Returns* :
+      #   - <tt>{:width => width, :height => height}</tt>
+      #
       def to_h
         {:width => @width, :height => @height}
       end
 
+      ##
+      # Get self as a String
+      #
+      # * *Returns* :
+      #   - <tt>"{:width => width, :height => height}"</tt>
+      #
       def to_s
         to_h.to_s
       end
     end
+
     ##
     # Wrapper for MKMapRect
     class MapRect
+
+      ##
+      # Attribute reader
+      #
       attr_reader :origin, :size
+
       ##
-      # MapRect.new(x, y, width, height)
-      # MapRect.new([x, y], [width, height])
-      # MapRect.new({:origin => {:x => 5.0, :y => 8.0}, :size => {:width => 6.0, :height => 9.0}})
-      # MapRect.new(MapPoint, MapSize)
-      # MapRect.new(MKMapPoint, MKMapSize)
-      # MapRect.new(MapRect)
-      # MapRect.new(MKMapRect)
+      # Initializer for MapRect
+      #
+      # * *Args*    :
+      # The initializer takes a variety of arguments
+      #
+      #    MapRect.new(x, y, width, height)
+      #    MapRect.new([x, y], [width, height])
+      #    MapRect.new({:origin => {:x => 5.0, :y => 8.0}, :size => {:width => 6.0, :height => 9.0}})
+      #    MapRect.new(MapPoint, MapSize)
+      #    MapRect.new(MKMapPoint, MKMapSize)
+      #    MapRect.new(MapRect)
+      #    MapRect.new(MKMapRect)
+      #
       def initialize(*args)
         self.origin, self.size =
             case args.size
@@ -237,22 +438,52 @@ module MapKit
             end
       end
 
-      def sdk
+      ##
+      # Returns the wrapped iOS MKMapRect object
+      #
+      # * *Returns* :
+      #   - A MKMapRect representation of self
+      #
+      def api
         MKMapRectMake(@origin.x, @origin.y, @size.width, @size.height)
       end
 
+      ##
+      # Assigns a MapKit::DataTypes::MapPoint to center.
+      #
+      # * *Args* :
+      #   - +origin+ -> accepts a variety of argument types. See docs for the MapKit::DataTypes::MapPoint initializer
+      #
       def origin=(origin)
         @origin = MapPoint.new(origin)
       end
 
+      ##
+      # Assigns a MapKit::DataTypes::MapSize to center.
+      #
+      # * *Args* :
+      #   - +size+ -> accepts a variety of argument types. See docs for the MapKit::DataTypes::MapSize initializer
+      #
       def size=(size)
         @size = MapSize.new(size)
       end
 
+      ##
+      # Get self as a Hash
+      #
+      # * *Returns* :
+      #   - <tt>{:origin => {:x => x, :y => y}, :size => {:width => width, :height => height}}</tt>
+      #
       def to_h
         {:origin => @origin.to_h, :size => @size.to_h}
       end
 
+      ##
+      # Get self as a String
+      #
+      # * *Returns* :
+      #   - <tt>"{:origin => {:x => x, :y => y}, :size => {:width => width, :height => height}}"</tt>
+      #
       def to_s
         to_h.to_s
       end

data/lib/map-kit-wrapper/map_type.rb

@@ -1,5 +1,22 @@
+##
+# Wrappers for MapKit
+#
 module MapKit
+
+  ##
+  # Class for dealing with MKMapView map type constants
+  #
   class MapType
+
+    ##
+    # Convert from MKMapView to MapView
+    #
+    # * *Args*    :
+    #   - +map_type+ -> Map type as MKMapView constant
+    #
+    # * *Returns* :
+    #   - map type as symbol
+    #
     def self.mkmap_to_rmap(map_type)
       case map_type
         when MKMapTypeStandard
@@ -13,6 +30,15 @@ module MapKit
       end
     end
 
+    ##
+    # Convert from MapView to MKMapView
+    #
+    # * *Args*    :
+    #   - +map_type+ -> Map type as symbol
+    #
+    # * *Returns* :
+    #   - Map type as MKMapView constant
+    #
     def self.rmap_to_mkmap(map_type)
       case map_type
         when :standard

data/lib/map-kit-wrapper/map_view.rb

@@ -13,78 +13,132 @@ module MapKit
     include MapKit::DataTypes
     include MapKit::ZoomLevel
 
+    ##
+    # Initializer for MapView
+    #
     def initialize
       self.alloc.init
     end
 
     ##
-    # Show if zoom is enabled
+    # Is zoom enabled
+    #
+    # * *Returns* :
+    #   - Bool
+    #
     def zoom_enabled?
       self.isZoomEnabled
     end
 
     ##
     # Set zoom on/off
+    #
+    # * *Args*    :
+    #   - +enabled+ -> Bool
+    #
     def zoom_enabled=(enabled)
       self.setZoomEnabled(enabled)
     end
 
     ##
-    # Show if scroll is enbaled
+    # Is scroll enbabled?
+    #
+    # * *Returns* :
+    #   - Bool
+    #
     def scroll_enabled?
       self.isScrollEnabled
     end
 
     ##
     # Set scroll on/off
+    #
+    # * *Args*    :
+    #   - +enabled+ -> Bool
+    #
     def scroll_enabled=(enabled)
       self.setScrollEnabled(enabled)
     end
 
     ##
-    # Show if the users location is on the map
+    # Is the users location shown on the map
+    #
+    # * *Returns* :
+    #   - Bool
+    #
     def shows_user_location?
       self.showsUserLocation
     end
 
     ##
     # Set visible user location on/off
+    #
+    # * *Args*    :
+    #   - +enabled+ -> Bool
+    #
     def shows_user_location=(enabled)
       self.showsUserLocation = enabled
     end
 
     ##
-    # Show if the users has been located yet
+    # Has the user been located yet?
+    #
+    # * *Returns* :
+    #   - Bool
+    #
     def user_located?
       self.shows_user_location? && self.userLocation.location ? true : false
     end
 
     ##
-    # Show the users coordinates
-    # defaults to nil if the functionality is turned off
-    # or the location has not yet been found
+    # Show the users coordinates. Defaults to nil if the functionality is turned off or the location has not yet been found
+    #
+    # * *Returns* :
+    #   - LocationCoordinate
+    #
     def user_coordinates
       self.user_located? ? LocationCoordinate.new(self.userLocation.location.coordinate) : nil
     end
 
     ##
-    # Get the maps region
-    def get_region
-      CoordinateRegion.new(self.region.center, self.region.span)
+    # Set the maps region
+    #
+    # * *Args*    :
+    #    region = CoordinateRegion.new([56, 10.6], [3.1, 3.1])
+    #    region = {:region => CoordinateRegion.new([56, 10.6], [3.1, 3.1]), :animated => false}
+    #
+    def region=(args)
+      case args
+        when Hash
+          self.setRegion(CoordinateRegion.new(args[:region]).api, animated: args[:animated])
+        else
+          self.setRegion(CoordinateRegion.new(args).api, animated: false)
+      end
     end
 
     ##
-    # Set the maps region
-    def region=(*args)
-      self.set_region(CoordinateRegion.new(args.first), false)
+    # Deprecated
+    #
+    def set_region
+      raise 'set_region has been deprecated. Please review the docs on region=()'
     end
 
     ##
-    # Set the maps region including animation
-    def set_region(coordinate_region, *args)
-      opts = {:animated => false}
-      opts.merge!(args.first) if args.first
-      self.setRegion(coordinate_region.sdk, animated: opts[:animated])
+    # Trick to override methods on the iOS APi and to get super on those methods
+    #
+    module OverriddenMethods
+      include MapKit::DataTypes
+      ##
+      # Get the maps region
+      #
+      # * *Returns* :
+      #   - CoordinateRegion
+      #
+      def region
+        CoordinateRegion.new(super)
+      end
     end
+
+    include OverriddenMethods
   end
 end

data/lib/map-kit-wrapper/test_suite_delegate.rb

@@ -1,6 +1,15 @@
+##
+# Dummy class used for tests
+#
 class TestSuiteDelegate
+  ##
+  # Attribute accessor
+  #
   attr_accessor :window
 
+  ##
+  # Init App
+  #
   def application(application, didFinishLaunchingWithOptions: launchOptions)
     @window = UIWindow.alloc.initWithFrame(UIScreen.mainScreen.bounds)
     @window.rootViewController = UIViewController.alloc.init

data/lib/map-kit-wrapper/version.rb

@@ -1,3 +1,7 @@
 module MapKit
-  VERSION = '0.0.4'
+
+  ##
+  # Current gem version
+  #
+  VERSION = '0.0.5'
 end

data/lib/map-kit-wrapper/zoom_level.rb

@@ -1,21 +1,51 @@
 module MapKit
+
   ##
   # Ruby adaption of http://troybrant.net/blog/2010/01/set-the-zoom-level-of-an-mkmapview/
+  #
   # More here http://troybrant.net/blog/2010/01/mkmapview-and-zoom-levels-a-visual-guide/
+  #
   module ZoomLevel
     include Math
+
+    ##
+    # Total map width in pixels
+    #
     MERCATOR_OFFSET = 268435456.0
+
+    ##
+    # Map radius in pixels
+    #
     MERCATOR_RADIUS = MERCATOR_OFFSET / PI
 
     ##
     # Map conversion methods
+    #
     module ClassMethods
       include Math
 
+      ##
+      # Convert longitude to pixel space x
+      #
+      # * *Args*    :
+      #   - +longitude+ -> Int or Float
+      #
+      # * *Returns* :
+      #   - Pixel space x as Int
+      #
       def longitude_to_pixel_space_x(longitude)
         (MERCATOR_OFFSET + MERCATOR_RADIUS * longitude * PI / 180.0).round
       end
 
+      ##
+      # Convert latitude to pixel space y
+      #
+      # * *Args*    :
+      #   - +latitude+ -> Int or Float
+      #
+      # * *Returns* :
+      #   - Pixel space y as Int
+      #
       def latitude_to_pixel_space_y(latitude)
         if latitude == 90.0
           0
@@ -26,14 +56,43 @@ module MapKit
         end
       end
 
+      ##
+      # Convert pixel space x to longitude
+      #
+      # * *Args*    :
+      #   - +pixel_x+ -> Int
+      #
+      # * *Returns* :
+      #   - Longitude as float
+      #
       def pixel_space_x_to_longitude(pixel_x)
         ((pixel_x.round - MERCATOR_OFFSET) / MERCATOR_RADIUS) * 180.0 / PI
       end
 
+      ##
+      # Convert pixel space y to latitude
+      #
+      # * *Args*    :
+      #   - +pixel_y+ -> Int
+      #
+      # * *Returns* :
+      #   - Latitude as float
+      #
       def pixel_space_y_to_latitude(pixel_y)
         (PI / 2.0 - 2.0 * atan(exp((pixel_y.round - MERCATOR_OFFSET) / MERCATOR_RADIUS))) * 180.0 / PI
       end
 
+      ##
+      # Get the coordiante span for the given zoom level
+      #
+      # * *Args*    :
+      #   - +map_view+ -> A MKMapView
+      #   - +center_coordinates+ -> Coordinates as MKMapPoint
+      #   - +zoom_level+ -> Zoom level as Int
+      #
+      # * *Returns* :
+      #   - Span as MKCoordinateSpan
+      #
       def coordinate_span_with_map_view(map_view, center_coordinate, zoom_level)
         # convert center coordiate to pixel space
         center_pixel_x = self.longitude_to_pixel_space_x(center_coordinate.longitude)
@@ -67,8 +126,18 @@ module MapKit
       end
 
       ##
-      # KMapView cannot display tiles that cross the pole
+      # Get the coordiante region for the given zoom level
+      #
       # This would involve wrapping the map from top to bottom, something that a Mercator projection just cannot do.
+      #
+      # * *Args*    :
+      #   - +map_view+ -> A MKMapView
+      #   - +center_coordinates+ -> Coordinates as MKMapPoint
+      #   - +zoom_level+ -> Zoom level as Int
+      #
+      # * *Returns* :
+      #   - Region as MKCoordinateRegion
+      #
       def coordinate_region_with_map_view(map_view, center_coordinate, zoom_level)
 
         # clamp lat/long values to appropriate ranges
@@ -125,12 +194,21 @@ module MapKit
       end
     end
 
+    ##
+    # Include class methods
+    #
     def self.included(base)
       base.extend(ClassMethods)
     end
 
-    # Public methods
-
+    ##
+    # Set the views center coordinates with a given zoom level
+    #
+    # * *Args*    :
+    #   - +center_coordinate+ -> A MKMapPoint
+    #   - +zoom_level+ -> Zoom level as Int
+    #   - +animated+ -> bool
+    #
     def set_center_coordinates(center_coordinate, zoom_level, animated = false)
       # clamp large numbers to 18
       zoom_level = [zoom_level, 18].min
@@ -143,17 +221,28 @@ module MapKit
       self.setRegion(region, animated: animated)
     end
 
+    ##
+    # Set the views latitude and longitude with a given zoom level
+    #
+    # * *Args*    :
+    #   - +latitude+ -> Float
+    #   - +longitude+ -> Float
+    #   - +zoom_level+ -> Zoom level as Int
+    #   - +animated+ -> bool
+    #
     def set_map_lat_lon(latitude, longitude, zoom_level, animated = false)
       coordinates = CLLocationCoordinate2DMake(latitude, longitude)
-      self.set_center_coordinates(coordinates, zoom_level, animated)
+      set_center_coordinates(coordinates, zoom_level, animated)
     end
 
     ##
     # Get the current zoom level
-
+    #
+    # * *Returns* :
+    #   - Zoom level as a Float
+    #
     def zoom_level
-      region = self.region
-
+      region = self.region.api
       center_pixel_x = self.class.longitude_to_pixel_space_x(region.center.longitude)
       top_left_pixel_x = self.class.longitude_to_pixel_space_x(region.center.longitude - region.span.longitudeDelta / 2)
 
@@ -167,9 +256,13 @@ module MapKit
 
     ##
     # Set the current zoom level
-
+    #
+    # * *Args*    :
+    #   - +zoom_level+ -> Int or Float
+    #   - +animated+ -> Bool
+    #
     def set_zoom_level(zoom_level, animated = false)
-      self.set_center_coordinates(self.region.center, zoom_level, animated)
+      set_center_coordinates(self.region.api.center, zoom_level, animated)
     end
 
   end

data/spec/lib/core_location_data_types_spec.rb

@@ -54,7 +54,7 @@ describe 'LocationCoordinate' do
 
   it 'should contain a CLLocationCoordinate2D' do
     @array.each do |lc|
-      lc.sdk.is_a?(CLLocationCoordinate2D).should.equal true
+      lc.api.is_a?(CLLocationCoordinate2D).should.equal true
     end
   end
 end

data/spec/lib/map_kit_data_types_spec.rb

@@ -35,7 +35,7 @@ describe 'MapKitDataTypes' do
 
     it 'should contain a MKCoordinateSpan' do
       @array.each do |o|
-        o.sdk.is_a?(MKCoordinateSpan).should.equal true
+        o.api.is_a?(MKCoordinateSpan).should.equal true
       end
     end
   end
@@ -78,7 +78,7 @@ describe 'MapKitDataTypes' do
 
     it 'should contain a MKCoordinateRegion' do
       @array.each do |o|
-        o.sdk.is_a?(MKCoordinateRegion).should.equal true
+        o.api.is_a?(MKCoordinateRegion).should.equal true
       end
     end
   end
@@ -118,7 +118,7 @@ describe 'MapKitDataTypes' do
 
     it 'should contain a MKMapPoint' do
       @array.each do |o|
-        o.sdk.is_a?(MKMapPoint).should.equal true
+        o.api.is_a?(MKMapPoint).should.equal true
       end
     end
   end
@@ -158,7 +158,7 @@ describe 'MapKitDataTypes' do
 
     it 'should contain a MKMapSize' do
       @array.each do |o|
-        o.sdk.is_a?(MKMapSize).should.equal true
+        o.api.is_a?(MKMapSize).should.equal true
       end
     end
   end
@@ -173,7 +173,7 @@ describe 'MapKitDataTypes' do
       o_4 = MapKit::DataTypes::MapRect.new(MKMapPointMake(5, 8), MKMapSizeMake(6, 9))
       o_5 = MapKit::DataTypes::MapRect.new({:origin => {:x => 5.0, :y => 8.0}, :size => {:width => 6.0, :height => 9.0}})
       o_6 = MapKit::DataTypes::MapRect.new(o_5)
-      o_7 = MapKit::DataTypes::MapRect.new(o_5.sdk)
+      o_7 = MapKit::DataTypes::MapRect.new(o_5.api)
       @array = [o_1, o_2, o_3, o_4, o_5, o_6, o_7]
     end
 
@@ -201,7 +201,7 @@ describe 'MapKitDataTypes' do
 
     it 'should contain a MKMapRect' do
       @array.each do |o|
-        o.sdk.is_a?(MKMapRect).should.equal true
+        o.api.is_a?(MKMapRect).should.equal true
       end
     end
   end

data/spec/lib/map_view_spec.rb

@@ -64,17 +64,17 @@ describe 'MapView' do
   # region
 
   it 'should show get_region' do
-    @map.get_region.should.satisfy { |object| object.is_a? MapKit::DataTypes::CoordinateRegion }
+    @map.region.should.satisfy { |object| object.is_a? MapKit::DataTypes::CoordinateRegion }
   end
 
   it 'should set region=' do
     @map.region = MapKit::CoordinateRegion.new([56, 10.6], [3.1, 3.1])
-    @map.get_region.should.satisfy { |object| object.is_a? MapKit::DataTypes::CoordinateRegion }
+    @map.region.should.satisfy { |object| object.is_a? MapKit::DataTypes::CoordinateRegion }
   end
 
-  it 'should set_region(coordinate_region, *args)' do
-    @map.set_region(MapKit::CoordinateRegion.new([56, 10.6], [3.1, 3.1]), false)
-    @map.get_region.should.satisfy { |object| object.is_a? MapKit::DataTypes::CoordinateRegion }
+  it 'should set region = (coordinate_region, *args)' do
+    @map.region = {:region => MapKit::CoordinateRegion.new([56, 10.6], [3.1, 3.1]), :animated => false}
+    @map.region.should.satisfy { |object| object.is_a? MapKit::DataTypes::CoordinateRegion }
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: map-kit-wrapper
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-24 00:00:00.000000000 Z
+date: 2013-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codependency