ProMotion-map 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd1631631482aaab778c200a08fd9da073ff2a09
-  data.tar.gz: 449e6a458a2f7f4bb6ecd065e72a59da1478d541
+  metadata.gz: 8240e335c3b662a901157fbb77f9ebb3e2e687db
+  data.tar.gz: c56b64500694327784914a24deed09373615ccb9
 SHA512:
-  metadata.gz: e65b08bce584b7641b8cb5f3e119f17527633dbe0e46eb15855ab0f1c2c4dbbfd34ea080807651c03c920a4629c7684ba397acf4def2b39fe8d7817759f64d4b
-  data.tar.gz: 2cff95504df81f9658bd8dd225bd5d4d1669a384e4994c90c143878be425556ac103f85caf2e42ececbc225e4a9e67ceeb9cc4178377b2f835f54316a59ee8e1
+  metadata.gz: bfbd94ade841e4def1627d3c54f96e2a81b3d1967d24652efc19e2ee3e0a69e6374d1870d7e0561ec9f8f101a70e1f87de463d7247cb66bc42a7307123939592
+  data.tar.gz: fb25b102018267b8ef5a57081c1e59fcd869f3f5435543546a3f1486ce67b38fa56d67a777bf431b1ef4247a3546afea5c54abef9d39fd4461981f7b6cac3ef1

data/README.md

@@ -22,46 +22,51 @@ class MyMapScreen < PM::MapScreen
   title "My Map"
   start_position latitude: 35.090648651123, longitude: -82.965972900391, radius: 4
 
-  def on_appear
-    update_annotation_data
-  end
-
   def annotation_data
     [{
       longitude: -82.965972900391,
       latitude: 35.090648651123,
       title: "Rainbow Falls",
-      subtitle: "Nantahala National Forest"
+      subtitle: "Nantahala National Forest",
+      action: :show_forest
     },{
       longitude: -82.966093558105,
       latitude: 35.092520895652,
       title: "Turtleback Falls",
-      subtitle: "Nantahala National Forest"
+      subtitle: "Nantahala National Forest",
+      action: :show_forest
     },{
       longitude: -82.95916,
       latitude: 35.07496,
-      title: "Windy Falls"
+      title: "Windy Falls",
+      action: :show_forest
     },{
       longitude: -82.943031505056,
       latitude: 35.102516828489,
       title: "Upper Bearwallow Falls",
-      subtitle: "Gorges State Park"
+      subtitle: "Gorges State Park",
+      action: :show_forest
     },{
       longitude: -82.956244328014,
       latitude: 35.085548421623,
       title: "Stairway Falls",
       subtitle: "Gorges State Park",
-      your_param: "CustomWhatever"
+      your_param: "CustomWhatever",
+      action: :show_forest
     }, {
       longitude: -82.965972900391,
       latitude: 35.090648651123,
       title: "Rainbow Falls",
       subtitle: "Nantahala National Forest",
-      image: UIImage.imageNamed("custom-pin")
+      image: UIImage.imageNamed("custom-pin"),
+      action: :show_forest
     }]
   end
 
-
+  def show_forest
+    selected = selected_annotations.first
+    # Do something with the selected annotation.
+  end
 end
 ```
 
@@ -82,54 +87,19 @@ end
 
 Method that is called to get the map's annotation data and build the map. If you do not want any annotations, simply return an empty array.
 
-```ruby
-def annotation_data
-  [{
-    longitude: -82.965972900391,
-    latitude: 35.090648651123,
-    title: "Rainbow Falls",
-    subtitle: "Nantahala National Forest"
-  },{
-    longitude: -82.965972900391,
-    latitude: 35.090648651123,
-    title: "Rainbow Falls",
-    subtitle: "Nantahala National Forest",
-    image: "custom-pin" # Use your own custom image. It will be converted to a UIImage automatically.
-  },{
-    longitude: -82.966093558105,
-    latitude: 35.092520895652,
-    title: "Turtleback Falls",
-    subtitle: "Nantahala National Forest"
-  },{
-    longitude: -82.95916,
-    latitude: 35.07496,
-    title: "Windy Falls"
-  },{
-    longitude: -82.943031505056,
-    latitude: 35.102516828489,
-    title: "Upper Bearwallow Falls",
-    subtitle: "Gorges State Park"
-  },{
-    longitude: -82.956244328014,
-    latitude: 35.085548421623,
-    title: "Stairway Falls",
-    subtitle: "Gorges State Park",
-    your_param: "CustomWahtever"
-  }]
-end
-```
-
 All possible properties:
 
 ```ruby
 {
-    longitude: -82.956244328014,
-    latitude: 35.085548421623,
-    title: "Stairway Falls",
+    longitude: -82.956244328014, # REQUIRED
+    latitude: 35.085548421623, # REQUIRED
+    title: "Stairway Falls", # REQUIRED
     subtitle: "Gorges State Park",
     image: "my_custom_image",
     left_accessory: my_button,
-    right_accessory: my_other_button
+    right_accessory: my_other_button,
+    action: :my_action, # Overrides :right_accessory
+    action_button_type: UIButtonTypeContactAdd # Defaults to UIButtonTypeDetailDisclosure
 }
 ```
 
@@ -139,12 +109,18 @@ Use `:image` to specify a custom image. Pass in a string to conserve memory and
 
 Use `:left_accessory` and `:right_accessory` to specify a custom accessory, like a button.
 
-You can access annotation data you've arbitrarily stored in the hash by calling `annotation_instance.annotation_params[:your_param]`.
+You can access annotation data you've arbitrarily stored in the hash by calling `annotation_instance.params[:your_param]`.
+
+The `:action` parameter specifies a method that should be run when the detail button is tapped on the annotation. It automatically adds a `UIButtonTypeDetailDisclosure` button to the `:left_accessory`. In your method you can find out which annotation's accessory was tapped by calling `selected_annotations.first`.
 
 #### update_annotation_data
 
 Forces a reload of all the annotations
 
+#### annotations
+
+Returns an array of all the annotations.
+
 #### center
 
 Returns a `CLLocation2D` instance with the center coordinates of the map.
@@ -153,9 +129,25 @@ Returns a `CLLocation2D` instance with the center coordinates of the map.
 
 Sets the center of the map. `animated` property defaults to `true`.
 
-#### annotations
+#### show_user_location
 
-Returns an array of all the annotations.
+Shows the user's location on the map.
+
+#### hide_user_location
+
+Hides the user's location on the map.
+
+#### showing_user_location?
+
+Returns a `Boolean` of whether or not the map view is currently showing the user's location.
+
+#### user_location
+
+Returns a `CLLocation2D` object of the user's location or `nil` if the user location is not being tracked
+
+#### zoom_to_user(radius = 0.05, animated=true)
+
+Zooms to the user's location. If the user's location is not currently being shown on the map, it will show it first. `radius` is a `CLLocationDegrees` of the latitude and longitude deltas. _See Apple documentation for `MKCoordinateSpan` for more information._
 
 #### select_annotation(annotation, animated=true)
 

data/lib/ProMotion/map/map_screen_annotation.rb

@@ -1,5 +1,6 @@
 module ProMotion
   class MapScreenAnnotation
+    attr_reader :params
 
     # Creates the new annotation object
     def initialize(params = {})
@@ -47,11 +48,6 @@ module ProMotion
       end
     end
 
-    # Allows for retrieving your own custom values on the annotation
-    def annotation_params
-      @params
-    end
-
     def method_missing(meth, *args)
       if @params[meth.to_sym]
         @params[meth.to_sym]
@@ -61,5 +57,11 @@ module ProMotion
       end
     end
 
+    # Deprecated
+    def annotation_params
+      PM.logger.warn("annotation.annotation_params is deprecated and will be removed soon. Please use annotation.params instead.")
+      @params
+    end
+
   end
 end

data/lib/ProMotion/map/map_screen_module.rb

@@ -38,7 +38,7 @@ module ProMotion
     def center=(params={})
       PM.logger.error "Missing #:latitude property in call to #center=." unless params[:latitude]
       PM.logger.error "Missing #:longitude property in call to #center=." unless params[:longitude]
-      params[:animated] = true
+      params[:animated] ||= true
 
       # Set the new region
       self.mapview.setCenterCoordinate(
@@ -116,26 +116,38 @@ module ProMotion
     def annotation_view(map_view, annotation)
       return if annotation.is_a? MKUserLocation
 
-      identifier = annotation.annotation_params[:identifier]
+      params = annotation.params
+
+      identifier = params[:identifier]
       if view = map_view.dequeueReusableAnnotationViewWithIdentifier(identifier)
         view.annotation = annotation
       else
         # Set the pin properties
-        if annotation.annotation_params[:image]
+        if params[:image]
           view = MKAnnotationView.alloc.initWithAnnotation(annotation, reuseIdentifier:identifier)
         else
           view = MKPinAnnotationView.alloc.initWithAnnotation(annotation, reuseIdentifier:identifier)
         end
       end
-      view.image = annotation.annotation_params[:image] if view.respond_to?("image=") && annotation.annotation_params[:image]
-      view.animatesDrop = annotation.annotation_params[:animates_drop] if view.respond_to?("animatesDrop=")
-      view.pinColor = annotation.annotation_params[:pin_color] if view.respond_to?("pinColor=")
-      view.canShowCallout = annotation.annotation_params[:show_callout] if view.respond_to?("canShowCallout=")
-      if annotation.annotation_params[:left_accessory]
-        view.leftCalloutAccessoryView = annotation.annotation_params[:left_accessory]
+      view.image = params[:image] if view.respond_to?("image=") && params[:image]
+      view.animatesDrop = params[:animates_drop] if view.respond_to?("animatesDrop=")
+      view.pinColor = params[:pin_color] if view.respond_to?("pinColor=")
+      view.canShowCallout = params[:show_callout] if view.respond_to?("canShowCallout=")
+
+      if params[:left_accessory]
+        view.leftCalloutAccessoryView = params[:left_accessory]
+      end
+      if params[:right_accessory]
+        view.rightCalloutAccessoryView = params[:right_accessory]
       end
-      if annotation.annotation_params[:right_accessory]
-        view.rightCalloutAccessoryView = annotation.annotation_params[:right_accessory]
+
+      if params[:action]
+        button_type = params[:action_button_type] || UIButtonTypeDetailDisclosure
+
+        action_button = UIButton.buttonWithType(button_type)
+        action_button.addTarget(self, action: params[:action], forControlEvents:UIControlEventTouchUpInside)
+
+        view.rightCalloutAccessoryView = action_button
       end
       view
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ProMotion-map
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mark Rickert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-03 00:00:00.000000000 Z
+date: 2014-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ProMotion
@@ -105,4 +105,3 @@ signing_key:
 specification_version: 4
 summary: Adds PM::MapScreen support to ProMotion. Extracted from ProMotion.
 test_files: []
-has_rdoc: