map-kit-wrapper 0.0.2 → 0.0.3

data/README.md

@@ -1,9 +1,9 @@
 MapKitWrapper
 =============
 
-This is a MapKit wrapper for RubyMotion. It's purpose is to make make dealing with MapKit less painfull
+This is a MapKit wrapper for RubyMotion. It's purpose is to make make dealing with MapKit less painful.
 
-It is still work in progress, but right now there are wrappers for the Map Kit Data Types and the Core Location Data Types. Those will save you a lot of typing.
+MapKitWrapper is work in progress. Right now there are wrappers for the Map Kit Data Types and the Core Location Data Types. Those will save you a lot of typing.
 
 ## Installation
 ```ruby
@@ -33,14 +33,248 @@ def loadView
   # map.set_region(region, :animated => true)
   map.showsUserLocation = true
   self.view.addSubview(map)
+  map.set_zoom_level = 3
 end
-```    
-Check if the users location has been found
+```
+
+## MapView: Convenient subclass of MKMapView
+
+Include the module
+```ruby
+include MapKit
+```
+
+Initializer
+
+```ruby
+MapView.new
+```
+
+### Methods on MapView
+
+Zoom methods
+
+```ruby
+>> map = MapView.new
+=> MapView
+>> map.zoom_enabled?
+=> false
+>> map.zoom_enabled = true
+=> true
+```
+
+Scroll methods
+
+```ruby
+>> map = MapView.new
+=> MapView
+>> map.scroll_enabled?
+=> false
+>> map.scroll_enabled = true
+=> true
+```
+
+Location methods
+
+```ruby
+>> map.user_located?
+=> false
+>> map.shows_user_location?
+=> false
+>> map.user_coordinates
+=> nil
+>> map.shows_user_location = true
+=> true
+# wait for a bit
+>> map.user_located?
+=> true
+>> map.user_coordinates
+=> LocationCoordinate
+```
+
+### MapView zoom level methods
+
+MapView includes calculations to easily get and set the zoom level as seen on Google Maps.
+It's a Ruby adaption of http://troybrant.net/blog/2010/01/set-the-zoom-level-of-an-mkmapview/
+
+```ruby
+>> map.zoom_level
+=> 5
+>> map.set_zoom_level(13)
+=> 13
+# set the zoom level with animation
+>> map.set_zoom_level(13, true)
+=> 13
+```
+
+## Wrappers for the CoreLocation data types
+
+Include the module
+```ruby
+include CoreLocation::DataTypes
+```
+
+### LocationCoordinate: The wrapper for CLLocationCoordinate2D
+
+The `LocationCoordinate` initializer takes a variety of argument types
+```ruby
+LocationCoordinate.new(1,2)
+LocationCoordinate.new([1,2])
+LocationCoordinate.new(LocationCoordinate)
+LocationCoordinate.new(CLLocationCoordinate2D)
+```
+
+Methods on `LocationCoordinate`
+```ruby
+>> lc = LocationCoordinate.new(1, 2)
+=> [1, 2]
+>> lc.latitude
+=> 1
+>> lc.latitude = 10
+=> 10
+>> lc.longitude
+=> 2
+>> lc.longitude = 15
+=> 15
+>> lc.to_array
+=> [10, 15]
+>> lc.sdk
+=> CLLocationCoordinate2D
+```
+
+## Wrappers for the MapKit data types
+
+Include the module
+
+```ruby
+include MapKit::DataTypes
+```
+
+### CoordinateSpan: The wrapper for MKCoordinateSpan
+
+The `CoordinateSpan` initializer takes a variety of argument types
+
+```ruby
+CoordinateSpan.new(1, 2)
+CoordinateSpan.new([1, 2])
+CoordinateSpan.new(MKCoordinateSpan)
+```
+
+Methods on `CoordinateSpan`
+
+```ruby
+>> cs = CoordinateSpan.new(1, 2)
+=> [1, 2]
+>> cs.latitude_delta
+=> 1
+>> cs.longitude_delta
+=> 2
+>> cs.to_array
+=> [1, 2]
+>> cs.sdk
+=> MKCoordinateSpan
+```
+
+### CoordinateRegion: The wrapper for MKCoordinateRegion
+
+The `CoordinateRegion` initializer takes a variety of argument types
+
 ```ruby
-@map.user_located?
-```    
-Get the users coordinates
+CoordinateRegion.new(CoordinateRegion)
+CoordinateRegion.new(MKCoordinateRegion)
+CoordinateRegion.new([56, 10.6], [3.1, 3.1])
+CoordinateRegion.new(LocationCoordinate, CoordinateSpan)
+CoordinateRegion.new(CLLocationCoordinate2D, MKCoordinateSpan)
+```
+
+Methods on `CoordinateRegion`
+
 ```ruby
-@map.user_coordinates
-```    
+>> cr = CoordinateRegion.new([56, 10.6], [3.1, 5.1])
+=> {:center => [56, 10.6], :span => [3.1, 5.1]}
+>> cs.center
+=> LocationCoordinate([56, 10.6])
+>> cs.region
+=> CoordinateSpan([3.1, 5.1])
+>> cs.to_hash
+=> {:center => [56, 10.6], :span => [3.1, 5.1]}
+>> cs.sdk
+=> MKCoordinateRegion
+```
+
+### MapPoint: The wrapper for MKMapPoint
+
+The `MapPoint` initializer takes a variety of argument types
+
+```ruby
+MapPoint.new(50, 45)
+MapPoint.new([50, 45])
+MapPoint.new(MKMapPoint)
+```
+
+Methods on `MapPoint`
+
+```ruby
+>> mp = MapPoint.new(50, 45)
+=> [50, 45]
+>> mp.x
+=> 50
+>> mp.y
+=> 45
+>> mp.to_array
+=> [50, 45]
+>> mp.sdk
+=> MKMapPoint
+```
+
+### MapSize: The wrapper for MKMapSize
+
+The `MapSize` initializer takes a variety of argument types
+
+```ruby
+MapSize.new(10, 12)
+MapSize.new([10, 12])
+MapSize.new(MKMapSize)
+```
+
+Methods on `MapSize`
+
+```ruby
+>> ms = MapSize.new(10, 12)
+=> [10, 12]
+>> ms.width
+=> 10
+>> ms.height
+=> 12
+>> ms.to_array
+=> [50, 45]
+>> ms.sdk
+=> MKMapSize
+```
+
+### MapRect: The wrapper for MKMapRect
+
+The `MapRect` initializer takes a variety of argument types
+
+```ruby
+MapRect.new(x, y, width, height)
+MapRect.new([x, y], [width, height])
+MapRect.new(MapPoint, MapSize)
+MapRect.new(MKMapPoint, MKMapSize)
+```
+
+Methods on `MapRect`
+
+```ruby
+>> mr = MapRect.new(2, 3, 10, 12)
+=> {:origin => [2, 3], :size => [10, 12]}
+>> mr.origin
+=> MapRect([2, 3])
+>> mr.size
+=> MapSize([10, 12])
+>> mr.to_hash
+=> {:origin => [2, 3], :size => [10, 12]}
+>> mr.sdk
+=> MKMapRect
+```
 

data/lib/map-kit-wrapper.rb

@@ -7,7 +7,7 @@ Motion::Project::App.setup do |app|
   base_path = "#{File.dirname(__FILE__)}/map-kit-wrapper"
   graph = Codependency::Graph.new("#{base_path}/map_view.rb")
 
-  files = (graph.files + Dir.glob(File.join(File.dirname(__FILE__), 'map-kit-wrapper/*.rb')).map { |file| file }).uniq
+  files = (graph.files + Dir.glob(File.join(File.dirname(__FILE__), 'map-kit-wrapper/*.rb'))).uniq
   files.reverse.each do |file|
     app.files.unshift(file)
   end

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

@@ -1,12 +1,14 @@
 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
       attr_reader :sdk
 
+      ##
       # LocationCoordinate.new(1,2)
       # LocationCoordinate.new([1,2])
       # LocationCoordinate.new(LocationCoordinate)

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

@@ -1,14 +1,15 @@
 # require core_location_data_types
 
 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
       attr_reader :sdk
-
+      ##
       # CoordinateSpan.new(1,2)
       # CoordinateSpan.new([1,2])
       # CoordinateSpan.new(MKCoordinateSpan)
@@ -33,12 +34,12 @@ module MapKit
         [latitude_delta, longitude_delta]
       end
     end
-
+    ##
     # Wrapper for MKCoordinateRegion
     class CoordinateRegion
       include CoreLocation::DataTypes
       attr_reader :sdk
-
+      ##
       # CoordinateRegion.new(CoordinateRegion)
       # CoordinateRegion.new(MKCoordinateRegion)
       # CoordinateRegion.new([56, 10.6], [3.1, 3.1])
@@ -70,11 +71,11 @@ module MapKit
         {:center => center.to_array, :span => span.to_array}
       end
     end
-
+    ##
     # Wrapper for MKMapPoint
     class MapPoint
       attr_reader :sdk
-
+      ##
       # MapPoint.new(50,45)
       # MapPoint.new([50,45])
       # MapPoint.new(MKMapPoint)
@@ -99,11 +100,11 @@ module MapKit
         [x, y]
       end
     end
-
+    ##
     # Wrapper for MKMapSize
     class MapSize
       attr_reader :sdk
-
+      ##
       # MapSize.new(10,12)
       # MapSize.new([10,12])
       # MapSize.new(MKMapSize)
@@ -128,11 +129,11 @@ module MapKit
         [width, height]
       end
     end
-
+    ##
     # Wrapper for MKMapRect
     class MapRect
       attr_reader :sdk
-
+      ##
       # MapRect.new(x, y, width, height)
       # MapRect.new([x, y], [width, height])
       # MapRect.new(MapPoint, MapSize)

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

@@ -8,6 +8,8 @@ module MapKit
           :satellite
         when MKMapTypeHybrid
           :hybrid
+        else
+          raise "Unknown map type: #{map_type.inspect}"
       end
     end
 
@@ -19,6 +21,8 @@ module MapKit
           MKMapTypeSatellite
         when :hybrid
           MKMapTypeHybrid
+        else
+          raise "Unknown map type: #{map_type.inspect}"
       end
     end
   end

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

@@ -6,6 +6,7 @@ module MapKit
   include CoreLocation::DataTypes
   include MapKit::DataTypes
 
+  ##
   # Wrapper for MKMapView
   class MapView < MKMapView
     include CoreLocation::DataTypes
@@ -16,58 +17,74 @@ module MapKit
       self.alloc.init
     end
 
-    # zoom methods
-
+    ##
+    # Show if zoom is enabled
     def zoom_enabled?
       self.isZoomEnabled
     end
 
+    ##
+    # Set zoom on/off
     def zoom_enabled=(enabled)
       self.setZoomEnabled(enabled)
     end
 
-    # scroll methods
-
+    ##
+    # Show if scroll is enbaled
     def scroll_enabled?
       self.isScrollEnabled
     end
 
+    ##
+    # Set scroll on/off
     def scroll_enabled=(enabled)
       self.setScrollEnabled(enabled)
     end
 
-    # user location methods
-
+    ##
+    # Show if the users location is on the map
     def shows_user_location?
       self.showsUserLocation
     end
 
+    ##
+    # Set visible user location on/off
     def shows_user_location=(enabled)
       self.showsUserLocation = enabled
     end
 
+    ##
+    # Show if the users has been located yet
     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
     def user_coordinates
       self.user_located? ? LocationCoordinate.new(self.userLocation.location.coordinate) : nil
     end
 
-    # region methods
-
+    ##
+    # Get the maps region
     def get_region
       CoordinateRegion.new(self.region.center, self.region.span)
     end
 
+    ##
+    # Set the maps region
     def region=(*args)
       self.set_region(CoordinateRegion.new(args.first), false)
     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])
+      self.setRegion(coordinate_region.sdk, animated: opts[:animated])
     end
   end
 end

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

@@ -1,3 +1,3 @@
 module MapKit
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

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

@@ -1,13 +1,15 @@
 module MapKit
-  # Ruby conversion of http://troybrant.net/blog/2010/01/set-the-zoom-level-of-an-mkmapview/
+  ##
+  # Ruby adaption of http://troybrant.net/blog/2010/01/set-the-zoom-level-of-an-mkmapview/
   module ZoomLevel
     include Math
     MERCATOR_OFFSET = 268435456.0
     MERCATOR_RADIUS = 85445659.44705395
 
+    ##
+    # Map conversion methods
     module ClassMethods
       include Math
-      # Map conversion methods
 
       def longitude_to_pixel_space_x(longitude)
         (MERCATOR_OFFSET + MERCATOR_RADIUS * longitude * PI / 180.0).round
@@ -63,6 +65,7 @@ module MapKit
         MKCoordinateSpanMake(latitude_delta, longitude_delta)
       end
 
+      ##
       # KMapView cannot display tiles that cross the pole
       # This would involve wrapping the map from top to bottom, something that a Mercator projection just cannot do.
       def coordinate_region_with_map_view(map_view, center_coordinate, zoom_level)
@@ -127,9 +130,9 @@ module MapKit
 
     # Public methods
 
-    def set_center_coordinates(center_coordinate, zoom_level, animated)
-      # clamp large numbers to 28
-      zoom_level = [zoom_level, 28].min
+    def set_center_coordinates(center_coordinate, zoom_level, animated = false)
+      # clamp large numbers to 18
+      zoom_level = [zoom_level, 18].min
 
       # use the zoom level to compute the region
       span = self.class.coordinate_span_with_map_view(self, center_coordinate, zoom_level)
@@ -139,11 +142,14 @@ module MapKit
       self.setRegion(region, animated: animated)
     end
 
-    def set_map_lat_lon(latitude, longitude, zoom_level, animated)
+    def set_map_lat_lon(latitude, longitude, zoom_level, animated = false)
       coordinates = CLLocationCoordinate2DMake(latitude, longitude)
       self.set_center_coordinates(coordinates, zoom_level, animated)
     end
 
+    ##
+    # Get the current zoom level
+
     def zoom_level
       region = self.region
 
@@ -158,5 +164,12 @@ module MapKit
       zoom_level
     end
 
+    ##
+    # Set the current zoom level
+
+    def set_zoom_level(zoom_level, animated = false)
+      self.set_center_coordinates(self.region.center, zoom_level, animated)
+    end
+
   end
 end

data/spec/lib/zoom_level_spec.rb

@@ -40,6 +40,8 @@ describe 'ZoomLevel' do
     span.longitude_delta.should.equal 56.25
     center.latitude.should.equal 55.9737854003906
     center.longitude.should.equal 10.01953125
+    @map.set_center_coordinates(CLLocationCoordinate2DMake(0, 0), 50, false)
+    @map.zoom_level.should.equal 18
   end
 
   it 'should return set_map_lat_lon' do
@@ -68,4 +70,9 @@ describe 'ZoomLevel' do
   it 'should have a zoom_level' do
     @map.zoom_level.should.equal 5.00000381469727
   end
+
+  it 'should set a zoom_level' do
+    @map.set_zoom_level(15, false)
+    @map.zoom_level.should.equal 15
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: map-kit-wrapper
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Kasper Weibel Nielsen-Refs