ymaps 0.0.2 → 0.0.3

data/README.rdoc

@@ -1,6 +1,8 @@
-= ymaps
+= YMaps
 
-Description goes here.
+Helpers for using Yandex Maps service.
+
+It includes Geokit-based Geocoder and helper for generating YMapsML files with data for Yandex Maps.
 
 == Note on Patches/Pull Requests
  
@@ -12,6 +14,4 @@ Description goes here.
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Copyright
-
-Copyright (c) 2010 Alexander Semyonov. See LICENSE for details.
+© Alexander Semyonov, 2010. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/geokit/geocoders/yandex_geocoder.rb

@@ -1,13 +1,48 @@
 require 'geokit'
+require 'geokit/inflector'
 require 'geokit/geocoders'
 
 module Geokit
   self.default_units = :kms
 
   class LatLng
-    def pos
+    def gml_pos
       "#{lng} #{lat}"
     end
+
+    def ymaps_lnglat
+      "#{lng},#{lat}"
+    end
+
+    def ymaps_lnglat=(lnglat)
+      self.lng, self.lat = lnglat[0], lnglat[1]
+    end
+  end
+
+  class GeoLoc
+    attr_accessor :kind
+    attr_writer :street_number, :street_name
+
+    # Extracts the street number from the street address if the street address
+    # has a value.
+    def street_number
+      @street_number ||= street_address && street_address[/(\d*)/]
+    end
+
+    # Returns the street name portion of the street address.
+    def street_name
+      @street_name ||= street_address && street_address[street_number.length, street_address.length].strip
+    end
+
+    # Do not use ugly Geokit::Inflector::titleize when set city’s name
+    def city=(city)
+      @city = city
+    end
+
+    # Do not use ugly Geokit::Inflector::titleize when set street address
+    def street_address=(address)
+      @street_address = address
+    end
   end
 
   module Geocoders
@@ -20,6 +55,23 @@ module Geokit
     end
 
     class YandexGeocoder < Geocoder
+      KIND_ACCURACY_MAP = {
+        'country'   => 1,
+        'province'  => 2,
+        'area'      => 3,
+        # 5 postal code
+        'locality'  => 4,
+        'street'    => 6,
+        'route'     => 6,
+        # 7 kreuzung
+        'house'     => 8,
+        'metro'     => 8,
+        'railway'   => 8,
+        # 9 building
+        # district hydro vegetation cemetery bridge km other
+        #  0 #unknown
+      }
+      PRECISIONS = %w{unknown country state state city zip zip+4 street address building}
 
     private
       def self.call_geocoder_service(geocode)
@@ -30,18 +82,18 @@ module Geokit
         end
 
         xml = res.body
-        logger.debug "Yandex geocoding: '#{geocode}'. Result: #{xml}"
+        logger.debug("Yandex geocoding: '#{geocode}'. Result: #{xml}")
         return xml2GeoLoc(xml)
       end
 
       def self.do_reverse_geocode(latlng)
         latlng = LatLng.normalize(latlng)
-        call_geocoder_service(latlng.ll)
+        call_geocoder_service(latlng.ymaps_lnglat) || GeoLoc.new
       end
 
       def self.do_geocode(address, options = {})
         address_str = address.is_a?(GeoLoc) ? address.to_geocodable_s : address
-        call_geocoder_service(address_str)
+        call_geocoder_service(address_str) || GeoLoc.new
       end
 
       def self.xml2GeoLoc(xml, address="")
@@ -63,7 +115,7 @@ module Geokit
 
           return geoloc
         else
-          logger.ingo "Yandex was unable to geocode address: #{address}"
+          logger.info("Yandex was unable to geocode address: #{address}")
           return GeoLoc.new
         end
       end
@@ -73,21 +125,22 @@ module Geokit
         res.provider = 'yandex'
 
         # basics
-        coordinates = doc.elements['.//Point/pos'].text.to_s.split(' ')
-        res.lng = coordinates[0]
-        res.lat = coordinates[1]
+        res.ymaps_lnglat  = doc.elements['.//Point/pos'].text.to_s.split(' ')
 
         # extended -- false if not available
-        res.city = doc.elements['.//LocalityName'].try(:text)
-        res.state = doc.elements['.//AdministrativeAreaName'].try(:text)
-        res.province = doc.elements['.//SubAdministrativeAreaName'].try(:text)
-        res.full_address = doc.elements['.//GeocoderMetaData/text'].try(:text)
-        res.zip = doc.elements['.//PostalCodeNumber'].try(:text)
-        res.street_address = doc.elements['.//ThoroughfareName'].try(:text)
-        res.country = doc.elements['.//CountryName'].try(:text)
-        res.district = doc.elements['.//DependentLocalityName'].try(:text)
-
-        # TODO: translate accuracy into Yahoo-style token address, street, zip, zip+4, city, state, country
+        res.full_address  = doc.elements['.//GeocoderMetaData/text'].try(:text)
+        res.country       = doc.elements['.//CountryName'].try(:text)
+        res.state         = doc.elements['.//AdministrativeAreaName'].try(:text)
+        res.province      = doc.elements['.//SubAdministrativeAreaName'].try(:text)
+        res.city          = doc.elements['.//LocalityName'].try(:text)
+        res.district      = doc.elements['.//DependentLocalityName'].try(:text)
+        res.street_name   = doc.elements['.//ThoroughfareName'].try(:text)
+        res.street_number = doc.elements['.//PremiseNumber'].try(:text)
+        res.zip           = doc.elements['.//PostalCodeNumber'].try(:text)
+
+        res.kind = doc.elements['.//GeocoderMetaData/kind'].try(:text)
+        res.accuracy = KIND_ACCURACY_MAP.fetch(res.kind) { 0 } if res.kind.present?
+        res.precision = PRECISIONS[res.accuracy]
 
         if suggested_bounds = doc.elements['.//boundedBy']
           res.suggested_bounds = Bounds.normalize(
@@ -97,7 +150,6 @@ module Geokit
         end
 
         res.success = true
-
         res
       end
     end

data/lib/geokit/inflector.rb

@@ -0,0 +1,22 @@
+require 'geokit/geocoders'
+
+module Geokit
+  module Inflector
+    if ''.respond_to?(:bytesize)  # Ruby 1.9
+      def bytesize(string)
+        string.bytesize
+      end
+    else                          # Ruby 1.8
+      def bytesize(string)
+        string.size
+      end
+    end
+    module_function :bytesize
+
+    def url_escape(s)
+      s.gsub(/([^ a-zA-Z0-9_.-]+)/nu) {
+        '%' + $1.unpack('H2' * bytesize($1)).join('%').upcase
+      }.tr(' ', '+')
+    end
+  end
+end

data/lib/ymaps.rb

@@ -6,6 +6,14 @@ module YMaps
 
   def self.geocode(query)
     require 'geokit/geocoders/yandex_geocoder'
-    Geokit::Geocoders::Yandex.geocode(query)
+    Geokit::Geocoders::YandexGeocoder.geocode(query)
   end
 end
+
+if defined? ActionView
+  ActionView::Base.send(:include, YMaps::ActionView::Helpers)
+end
+
+if defined? Mime
+  Mime::Type.register 'application/xml', :ymapsml
+end

data/lib/ymaps/action_view/html_helper.rb

@@ -3,15 +3,15 @@ module YMaps
     module HtmlHelper
       class StaticMapPoint < Struct.new('MapPoint', :style, :color, :size, :number, :lat, :lng)
         def to_s
-          "#{ll},#{style}#{color}#{size}#{number}"
+          "#{ymaps_lnglat},#{style}#{color}#{size}#{number}"
         end
 
-        def ll
-          @ll ||= "#{lat},#{lng}"
+        def ymaps_lnglat
+          @ymaps_lnglat ||= "#{lng},#{lat}"
         end
 
-        def ll=(latlng)
-          @ll = latlng
+        def ymaps_lnglat=(latlng)
+          @ymaps_lnglat = latlng
         end
 
         def attributes=(attrs)
@@ -24,10 +24,13 @@ module YMaps
       def map_link(resource = nil, options = {})
         resource, options = nil, resource if resource.is_a?(Hash)
 
+        url_params = options.delete(:url) { {} }
         href = if resource
-                 polymorphic_url(resource, :format => :ymapsml)
+                 polymorphic_url(resource, {:format => :ymapsml}.merge(url_params))
                else
-                 url_for(:format => :ymapsml, :only_path => false, :time => Time.now)
+                 url_for({:format => :ymapsml,
+                          :only_path => false,
+                          :time => Time.now}.merge(url_params))
                end
 
         tag(:link,
@@ -37,14 +40,22 @@ module YMaps
                            :type => 'application/ymapsml+xml'))
       end
 
-      def ymaps_include_tag(key = nil)
+      def ymaps_javascript_path(key = nil)
         key ||= YMaps.key
-        javascript_include_tag("http://api-maps.yandex.ru/1.1/index.xml?key=#{key}")
+        "http://api-maps.yandex.ru/1.1/index.xml?key=#{key}"
+      end
+
+      def ymaps_include_tag(key = nil)
+        javascript_include_tag(ymaps_javascript_path)
       end
 
       def static_map(resources, options = {})
         title = options.delete(:title) { resources.to_s }
         map_type = options.delete(:map) { 'map' }
+        width = options.delete(:width) { 600 }
+        height = options.delete(:height) { 450 }
+        map_size = "#{width},#{height}"
+        zoom     = options.delete(:zoom) { 16 }
 
         common_point = StaticMapPoint.new(
           options.delete(:style) { 'pm' },
@@ -54,18 +65,20 @@ module YMaps
         )
 
         collection = Array(resources).inject([]) do |result, resource|
-          common_point.ll = resource.latlng.ll
+          common_point.ymaps_lnglat = resource.latlng.ymaps_lnglat
           common_point.number += 1
           result << common_point.to_s
           result
         end.join('~')
 
         content_tag(:div, :class => 'b-map') do
-          image_tag("http://static-maps.yandex.ru/1.x/?key=#{YMaps.key}&l=#{map_type}&pt=#{collection}",
-                    :title => title,
-                    :alt => title,
-                    :class => 'static'
-                   )
+          image_tag("http://static-maps.yandex.ru/1.x/?key=#{YMaps.key}&l=#{map_type}&pt=#{collection}&size=#{map_size}&z=#{zoom}", options.merge(
+            :title => title,
+            :alt => title,
+            :class => 'static',
+            :width => width,
+            :height => height
+          ))
         end
       end
 

data/lib/ymaps/action_view/ymapsml_helper.rb

@@ -28,7 +28,7 @@ module YMaps
     class Builder
       YMAPS_TAG_NAMES = %w(GeoObject GeoObjectCollection style ymaps AnyMetaData).map(&:to_sym)
       GML_TAG_NAMES = %w(boundedBy description Envelope exterior featureMember
-        featureMembers interior LineString LinearString lowerCorner
+        featureMembers interior LineString LinearRing lowerCorner
         metaDataProperty name Point Polygon pos posList upperCorner).map(&:to_sym)
       REPR_TAG_NAMES = %w(balloonContentStyle fill fillColor hintContentStyle iconContentStyle
         lineStyle href iconStyle mapType offset outline parentStyle polygonStyle
@@ -39,9 +39,18 @@ module YMaps
         @xml = xml
       end
 
+    protected
+      def prefixed_method(method, *arguments, &block)
+        @xml.__send__(*xmlns_prefix!(method, arguments), &block)
+      end
+
+      def link_to(name, href)
+        prefixed_method(name, "\##{href}")
+      end
+
     private
       def method_missing(method, *arguments, &block)
-        @xml.__send__(*xmlns_prefix!(method, arguments), &block)
+        prefixed_method(method, *arguments, &block)
       end
 
       def xmlns_prefix!(method, arguments)
@@ -56,6 +65,15 @@ module YMaps
     end
 
     class YMapsReprBuilder < Builder
+      ACCEPTABLE_STYLES = {
+        :balloon_content => [:template],
+        :hint_content => [:template],
+        :icon => [:href, :offset, :shadow, :size, :template],
+        :icon_content => [:template],
+        :line => [:stroke_color, :stroke_width],
+        :polygon => [:fill, :fill_color, :outline, :stroke_color, :stroke_width],
+      }
+
       def view(options = {})
         View {
           if options[:type]
@@ -65,12 +83,28 @@ module YMaps
         }
       end
 
+      # Add style definition
+      # @param [Symbol, String] id      style name
+      # @param [Hash]           options style options
       def style(id, options = {})
+        options[:hasBalloon]  = options.delete(:balloon)  if options.key?(:balloon)
+        options[:hasHint]     = options.delete(:hint)     if options.key?(:hint)
+        parent                = options.delete(:parent) { false  }
         Style(options.merge('gml:id' => id.to_s)) {
+          link_to(:parentStyle, parent) if parent
           yield
         }
       end
 
+      ACCEPTABLE_STYLES.each do |name, values|
+        define_method(name) do |options|
+          tag_name = "#{ActiveSupport::Inflector.camelize(name.to_s, false)}Style"
+          send(tag_name) do
+            style_options(options, values)
+          end
+        end
+      end
+
       def template(id, template_text = nil)
         Template('gml:id' => id.to_s) do
           text do
@@ -79,10 +113,42 @@ module YMaps
         end
       end
 
-      def balloon_content(template)
-        balloonContentStyle {
-          @xml.repr(:template, "\##{template}")
-        }
+      protected
+
+      def style_options(options = {}, acceptable = nil)
+        if acceptable
+          options.assert_valid_keys(acceptable)
+        end
+        # Filling options
+        fill(options[:fill] ? 1 : 0)            if options.key?(:fill)
+        fillColor(options[:fill_color])         if options.key?(:fill_color)
+
+        # Outline options
+        outline(options[:outline] ? 1 : 0)      if options.key?(:outline)
+        strokeColor(options[:stroke_color])     if options.key?(:stroke_color)
+        strokeWidth(options[:stroke_width])     if options.key?(:stroke_width)
+
+        href(options[:href])                    if options.key?(:href)
+        size(*Array(options[:size]))            if options.key?(:size)
+        offset(*Array(options[:offset]))        if options.key?(:offset)
+        link_to(:template, options[:template])  if options.key?(:template)
+        shadow do
+          style_options(options[:shadow], [:href, :size, :template, :offset])
+        end if options.key?(:shadow)
+      end
+
+      def size(x, y = nil)
+        if x.is_a?(Hash)
+          x, y = x[:x], x[:y]
+        end
+        prefixed_method(:size, :x => x, :y => y)
+      end
+
+      def offset(x, y = nil)
+        if x.is_a?(Hash)
+          x, y = x[:x], x[:y]
+        end
+        prefixed_method(:offset, :x => x, :y => y)
       end
     end
 
@@ -113,7 +179,7 @@ module YMaps
 
       def point(latlng)
         Point {
-          pos(latlng.pos)
+          pos(latlng.gml_pos)
         }
       end
 

data/ymaps.gemspec

@@ -1,53 +1,52 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{ymaps}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alexander Semyonov"]
-  s.date = %q{2010-04-03}
+  s.date = %q{2011-01-27}
   s.description = %q{Different helpers for generating YMapsML, using YMaps widgets and geocoding via Yandex.Maps}
   s.email = %q{rotuka@rotuka.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.rdoc"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "init.rb",
-     "lib/geokit/geocoders/yandex_geocoder.rb",
-     "lib/ymaps.rb",
-     "lib/ymaps/action_view.rb",
-     "lib/ymaps/action_view/html_helper.rb",
-     "lib/ymaps/action_view/ymapsml_helper.rb",
-     "test/helper.rb",
-     "test/test_ymaps.rb",
-     "ymaps.gemspec"
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "init.rb",
+    "lib/geokit/geocoders/yandex_geocoder.rb",
+    "lib/geokit/inflector.rb",
+    "lib/ymaps.rb",
+    "lib/ymaps/action_view.rb",
+    "lib/ymaps/action_view/html_helper.rb",
+    "lib/ymaps/action_view/ymapsml_helper.rb",
+    "test/helper.rb",
+    "test/test_ymaps.rb",
+    "ymaps.gemspec"
   ]
   s.homepage = %q{http://github.com/rotuka/ymaps}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Helpers for using YMaps}
   s.test_files = [
     "test/helper.rb",
-     "test/test_ymaps.rb"
+    "test/test_ymaps.rb"
   ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_runtime_dependency(%q<geokit>, ["= 1.5.0"])

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Alexander Semyonov
@@ -14,13 +14,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-03 00:00:00 +04:00
+date: 2011-01-27 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -33,6 +34,7 @@ dependencies:
   name: yard
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -45,6 +47,7 @@ dependencies:
   name: geokit
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
@@ -66,13 +69,13 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
-- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - init.rb
 - lib/geokit/geocoders/yandex_geocoder.rb
+- lib/geokit/inflector.rb
 - lib/ymaps.rb
 - lib/ymaps/action_view.rb
 - lib/ymaps/action_view/html_helper.rb
@@ -85,11 +88,12 @@ homepage: http://github.com/rotuka/ymaps
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -97,6 +101,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -106,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Helpers for using YMaps

data/.gitignore

@@ -1,23 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-doc
-pkg
-.yardoc
-
-## PROJECT::SPECIFIC