geohash36 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 432211005ee057c31a81fbf7367e43f425aecaf5
-  data.tar.gz: b10ff8a92d40cd22a10096998998cf7758742982
+  metadata.gz: 9e9125eee74fa553d17038f5a61e83545bd978a5
+  data.tar.gz: 9dba53c12cc8097ae6cf76de5c618232c7ad1a92
 SHA512:
-  metadata.gz: 43366a468241e83d6ba28ca5e46aecc8d6f3d481635fb84f00af9b706e51906051cc6c68ec16aa7800f97aaa06822fcb11922c7c64dec5e57ae97d822852264a
-  data.tar.gz: a9ef919392973868982ff6c42421a222f4062f180bc78bed685ea042a1dac4b08824aa7e9fb3e415a811e272f998d7ca4960d518f6ef4b0a3f2a76b744fb03d8
+  metadata.gz: 7549cccdb826d55ae820d5d87d592040ba71822b54b160be3cf23f50fcac5569068e48f00299e123b51380bfe10b4d55a3ef52ab6ec549a0b2dd1f992ddd1a39
+  data.tar.gz: c0edded79c561df5d92b89f0104d5d399b0ba3aad04c86880f241f79646e60e243ee518a42bc96b4f6729282ce5e605346e2361c05ca1872b119fbc693735cbb

data/.project.yaml

@@ -0,0 +1,8 @@
+---
+
+# These values are consumed by Thor and Rake
+gem_name:         geohash36
+author:           Bjoern Rennhak
+organization:     Clothes Network
+
+

data/FAQ.md

@@ -0,0 +1,11 @@
+
+Q: Why do you have a Gemfile and a gemspec if this is a gem?
+A: For local development its quite convenient to have a Gemfile and Gemfile.lock, but once done for
+   publishing etc. you just need the gemspec. This kind of hybrid approach is a bit unorthodox but
+   useful. Once the software is mature its ok to remove gemfile, lock file, and other pinnings since
+   your gem is supposed to run everywhere.
+
+Q: How is this different from Geohash 32?
+A: Geohash 36 utilizes radix 36 format, which allows a slightly better precision then geohash 32
+   radix format. Also, the entire purpose is for machine readability in urls not human readability.
+

data/Gemfile

@@ -65,6 +65,9 @@ group :test do # {{{
   # Fixture helper
   gem 'randexp'
 
+  # Spice up testing
+  gem 'nyan-cat-formatter'
+
 end # }}}
 
 group :security do # {{{

data/README.md

@@ -1,12 +1,18 @@
 # Geohash36
-Version 0.3.0-9-g34a816a
+Version 0.3.1-18-g41749f0
 
-Geohash36 is a complete solution for geohashing coordinates. What is geohash?
-For example, the coordinate pair 40.689167, -74.044444 (NY City) produces a slightly shorter hash 9LVB4BH89g, which can be used in the URL http://geo36.org/9LVB4BH89g
+[![Gem Version](https://badge.fury.io/rb/geohash36.svg)](http://badge.fury.io/rb/geohash36)
+[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://img.shields.io/badge/license-MIT-brightgreen.svg)
+
+Geohash36 is a complete solution for geohashing coordinates. What is a geohash? For example, the
+coordinate pair 40.689167, -74.044444 (NY City) produces a slightly shorter hash 9LVB4BH89g, which
+can be used in the URL http://geo36.org/9LVB4BH89g
 
 The main usages of Geohashes are
-* as a unique identifier.
-* represent point data e.g. in databases.
+
+  * as a unique identifier
+  * represent point data e.g. in databases
+
 
 ## More about geohashing
 
@@ -37,9 +43,11 @@ typefaces.
 Alphabet conversion table [2]
 
 Decimal     0   1   2   3   4   5   6   7   8   9   10  11  12  13  14  15  16  17
+
 Geohash-36  2   3   4   5   6   7   8   9   b   B   C   d   D   F   g   G   h   H
 
 Decimal     18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35
+
 Geohash-36  j   J   K   l   L   M   n   N   P   q   Q   r   R   t   T   V   W   X
 
 Each character represents a further subdivision in a 6 by 6 grid - starting at the North-West
@@ -49,9 +57,13 @@ The Statue of Liberty, at coordinates 40.689167, -74.044444, is encoded as 9LVB4
 decoding equates to 40.689168,-74.044445.
 
 [1] http://geohash.org/
+
 [2] http://en.wikipedia.org/wiki/Geohash
+
 [2] http://en.wikipedia.org/wiki/Geohash-36
+
 [3] http://geo36.org/
+
 [4] http://www.pubnub.com/blog/wp-content/uploads/2014/05/ProximityChat1.jpg
 
 
@@ -71,8 +83,57 @@ gem 'geohash36', git: 'https://github.com/clothesnetwork/geohash36'
 
 ## Usage
 
-Basic usage can be found in demo.rb file
+As library
+
+
+```ruby
+2.1.2 :001 > require 'geohash36'
+ => true
+2.1.2 :002 > coordinates = { latitude: 40.689167, longitude: -74.044444 }
+ => {:latitude=>40.689167, :longitude=>-74.044444}
+2.1.2 :004 > hash = Geohash36.to_geohash( coordinates )
+ => "9LVB4BH89g"
+2.1.2 :005 > resolved = Geohash36.to_coords( hash )
+ => {:latitude=>40.689168, :longitude=>-74.044445}
+```
+
+or from the command line
+
+```sh
+~# geohash36
+
+Commands:
+  geohash36 coords GEOHASH [ACCURACY]  # Get coordinates for geohash with specified accuracy
+  geohash36 hash LATITUDE LONGITUDE    # Get geohash36 from coordinates
+  geohash36 help [COMMAND]             # Describe available commands or one specific command
+```
+
+```sh
+~# geohash36 hash 40.689167 -74.044445
+
+9LVB4BH89g
+```
+```sh
+~# geohash36 coords 9LVB4BH89g
+
+Latitude: 40.689
+Longitude: -74.044
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/clothesnetwork/geohash36/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+## Authors
+
+* [Oleg Orlov](https://github.com/OrelSokolov)
+* [Bjoern Rennhak](https://github.com/rennhak)
 
-## Copyright
+## Copyright & License
 
-Please refer to the COPYRIGHT file
+Please refer to the COPYING.md and LICENSE.md file.

data/geohash36.gemspec

@@ -43,9 +43,11 @@ Gem::Specification.new do |spec|
                                   COPYING.md
                                   LICENSE.md
                                   MAINTAINERS.md
+                                  FAQ.md
                                   Gemfile
                                   README.md
                                   Rakefile
+                                  .project.yaml
                                   geohash36.gemspec
                                 ]
 
@@ -79,31 +81,17 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'thor'
   spec.add_runtime_dependency 'ruby-try', '~> 1.1.1'
 
-  # Package building
-  spec.add_runtime_dependency 'fpm'
-
   # Shell
   spec.add_runtime_dependency 'ptools'
   spec.add_runtime_dependency 'os'
 
-  # Data RPCs and Messaging
-  spec.add_runtime_dependency 'msgpack'
-  # spec.add_runtime_dependency 'xmpp4r'
-  # spec.add_runtime_dependency 'xmpp4r-simple' # , :git => 'git://github.com/blaine/xmpp4r-simple.git'
-  spec.add_runtime_dependency 'amqp'
-
-  spec.add_runtime_dependency 'mime-types'
-
-  # l10n
-  spec.add_runtime_dependency 'gettext'
-
   # Monadic/Functional
   spec.add_runtime_dependency 'andand'
-  spec.add_runtime_dependency 'ick'
+  # spec.add_runtime_dependency 'ick'
 
   # Misc System
-  spec.add_runtime_dependency 'awesome_print'
-  spec.add_runtime_dependency 'uuid'
+  # spec.add_runtime_dependency 'awesome_print'
+  # spec.add_runtime_dependency 'uuid'
 
   ## System libraries needed (info for the user)
   # spec.requirements 'iconv zlib libmagic'

data/lib/geohash36.rb

@@ -1,13 +1,14 @@
 #!/usr/bin/env ruby
 
-
 # Standard includes
 require 'bundler'
 require 'thor'
 require 'rake'
 require 'ruby-try'
 
-# Provides complete solution for geohashing
+
+# @class    Geohash36
+# @brief    Provides complete solution for geohashing
 class Geohash36
 
   # Geocode-36 matrix for map
@@ -19,85 +20,101 @@ class Geohash36
     ['n', 'N', 'P', 'q', 'Q', 'r'],
     ['R', 't', 'T', 'V', 'W', 'X']
   ]
+
   # Needed for inversion direction of latitude
   GEOMATRIX_MAX_INDEX = 5
+
   # Standart length of geocode
-  GEOCODE_LENGTH = 10
+  GEOCODE_LENGTH      = 10
+
   # Accuracy for coordinates when converting from geohash
-  DEFAULT_ACCURACY = 6
+  DEFAULT_ACCURACY    = 6
 
-  attr_reader :coords
-  attr_reader :hash
+  attr_reader   :coords, :hash
   attr_accessor :accuracy
 
-  # Create new Geohash object from geohash or coordinates.
+  # @fn       def initialize obj = { latitude: 0, longitude: 0 } {{{
+  # @brief    Create new Geohash object from geohash or coordinates.
   #
-  # @param object [Hash, String]
-  # @example Pass geohash
-  #   Geohash36.new "l222222222222"
-  # @example Pass coordinates
-  #   Geohash36.new latitude: 80, longitude: 20
-  def initialize(obj = { latitude: 0, longitude: 0 })
+  # @param    [Hash or String]    object    Either Hash {latitude: value, longitude: value} or "geohash string"
+  #
+  # @example  Pass geohash
+  #           Geohash36.new "l222222222222"
+  # @example  Pass coordinates
+  #           Geohash36.new latitude: 80, longitude: 20
+  #
+  def initialize obj = { latitude: 0, longitude: 0 }
     @accuracy = DEFAULT_ACCURACY
+
     if obj.kind_of? Hash
-      Geohash36.validate_coords(obj)
-      @hash = Geohash36.to_geohash(obj)
+      Geohash36.validate_coords( obj )
+      @hash   = Geohash36.to_geohash( obj )
       @coords = obj
     elsif obj.kind_of? String
-      Geohash36.validate_geohash(obj)
-      @hash = obj
-      @coords = Geohash36.to_coords(obj, @accuracy)
+      Geohash36.validate_geohash( obj )
+      @hash   = obj
+      @coords = Geohash36.to_coords( obj, @accuracy )
     else
       raise ArgumentError, "Argument type should be hash or string"
     end
-  end
+  end # of def initialize }}}
 
+  # @fn       def hash=(geohash) {{{
   # Update geohash value. Coordinates will update automatically
   def hash=(geohash)
-    raise ArgumenError unless geohash.kind_of? String
-    @hash = geohash
-    @coords = Geohash36.to_coords(geohash, @accuracy)
-  end
+    raise ArgumenError unless( geohash.kind_of?( String ) )
+    @hash   = geohash
+    @coords = Geohash36.to_coords( geohash, @accuracy )
+  end # of def hash= }}}
 
-  # Update coordinates values. Geohash will update automatically
+  # @fn       def coords=(coords) {{{
+  # @brief    Update coordinates values. Geohash will update automatically
+  #
+  # @param    [Hash]      coords      Hash containing keys longitude, latitude with corresponding values.
+  #
   def coords=(coords)
-    raise ArgumenError unless coords.kind_of? Hash
-    @hash = Geohash36.to_geohash(coords)
+    raise ArgumenError unless( coords.kind_of?( Hash ) )
+    @hash = Geohash36.to_geohash( coords )
     @coords.merge! coords
-  end
-
+  end # }}}
 
-  # Convert coordinates pair to geohash without creating an object
+  # @fn       def self.to_geohash coords {{{
+  # @brief    Convert coordinates pair to geohash without creating an object
+  #
+  # @param    [Hash]    coords      Coordinates to convert
   #
-  # @param coords [Hash] coordinates to convert
-  # @return [String] geohash
-  # @example
-  #   Geohash36.to_geohash(latitude: 0, longitude: 0)
-  #   # => "l222222222"
-  def self.to_geohash(coords)
+  # @return   [String]  Returns a geohash from given coordinates
+  #
+  # @example  Geohash36.to_geohash(latitude: 0, longitude: 0)
+  #           # => "l222222222"
+  def self.to_geohash coords
     Geohash36.validate_coords(coords)
     lon_interval = Geohash36.basic_lon_interval
     lat_interval = Geohash36.basic_lat_interval
 
     (0...GEOCODE_LENGTH).map{Geohash36.geohash_symbol!(lon_interval, lat_interval, coords)}.join
-  end
-
-  # Convert geohash to coords without creating an object.
-  #
-  # @param [String] geohash
-  # @param accuracy [Fuxnum] accuracy for coordinates values
-  # @return [Hash] coordinates
-  # @example With default accuracy
-  #   Geohash36.to_coords("l222222222")
-  #   # => {:latitude=>-1.0e-06, :longitude=>3.0e-06}
-  # @example With accuracy 3
-  #   Geohash36.to_coords("l222222222", 3)
-  #   # => {:latitude=>0.0, :longitude=>0.0}
-  def self.to_coords(geohash, accuracy = DEFAULT_ACCURACY)
+  end # }}}
+
+  # @fn       def self.to_coords(geohash, accuracy = DEFAULT_ACCURACY) {{{
+  # @brief    Convert geohash to coords without creating an object.
+  #
+  # @param    [String]      geohash       Given geohash string
+  # @param    [Fixnum]      accuracy      Accuracy for coordinates values
+  #
+  # @return   [Hash]        Returns coordinates from given hash
+  #
+  # @example  With default accuracy
+  #           Geohash36.to_coords("l222222222")
+  #             => {:latitude=>-1.0e-06, :longitude=>3.0e-06}
+  # @example  With accuracy 3
+  #           Geohash36.to_coords("l222222222", 3)
+  #             => {:latitude=>0.0, :longitude=>0.0}
+  #
+  def self.to_coords geohash, accuracy = DEFAULT_ACCURACY
     Geohash36.validate_geohash(geohash)
 
-    lon_interval = Geohash36.basic_lon_interval
-    lat_interval = Geohash36.basic_lat_interval
+    lon_interval    = Geohash36.basic_lon_interval
+    lat_interval    = Geohash36.basic_lat_interval
 
     geohash.each_char do |c|
       lon_intervals = Geohash36::Interval.convert_array(lon_interval.split)
@@ -106,7 +123,7 @@ class Geohash36
       lat_index, lon_index = 0, 0
 
       GEOCODE_MATRIX.each_with_index do |row, row_index|
-        if row.include? c
+        if row.include?( c )
           lat_index = GEOMATRIX_MAX_INDEX-row_index
           lon_index = row.index(c)
           break
@@ -119,46 +136,72 @@ class Geohash36
 
     { latitude:  lat_interval.middle.round(accuracy) ,
       longitude: lon_interval.middle.round(accuracy) }
-  end
+  end # }}}
 
-  private
-    def self.basic_lon_interval
-      Geohash36::Interval.new [-180, 180]
-    end
 
-    def self.basic_lat_interval
-      Geohash36::Interval.new [-90, 90]
-    end
+  private
 
-    def self.validate_geohash(geohash)
-      unless geohash =~ /\A[23456789bBCdDFgGhHjJKlLMnNPqQrRtTVWX]+{1,10}\z/
-        raise ArgumentError, "It is not Geohash-36."
-      end
-    end
+  # @fn       def self.basic_lon_interval {{{
+  # @brief    Returns basic Longitude interval allowed
+  #
+  # @return   [Interval]      Returns correctly initialized Interval class for Longitude
+  def self.basic_lon_interval
+    Geohash36::Interval.new [-180, 180]
+  end # }}}
 
-    def self.validate_coords(coords)
-      keys = coords.keys
-      raise ArgumentError, "Invalid hash" unless keys.length == 2 && keys.include?(:latitude) && keys.include?(:longitude)
-      lat_inclusion = Geohash36.basic_lat_interval.include? coords[:latitude]
-      lon_inclusion = Geohash36.basic_lon_interval.include? coords[:longitude]
-      raise ArgumentError, "Invalid hash values" unless lat_inclusion && lon_inclusion
+  # @fn       def self.basic_lat_interval {{{
+  # @brief    Returns basic Latitude interval allowed
+  #
+  # @return   [Interval]      Returns correctly initialized Interval class for Latitude
+  def self.basic_lat_interval
+    Geohash36::Interval.new [-90, 90]
+  end # }}}
+
+  # @fn       def self.validate_geohash geohash {{{
+  # @brief    Validate given geohash36 against ranges and alphabet
+  def self.validate_geohash geohash
+    unless geohash =~ /\A[23456789bBCdDFgGhHjJKlLMnNPqQrRtTVWX]+{1,10}\z/
+      raise ArgumentError, "Sorry, it doesn't seem to be Geohash-36"
     end
+  end # }}}
 
-    def self.geohash_symbol!(lon_interval, lat_interval, coords)
-      lon_intervals = Geohash36::Interval.convert_array(lon_interval.split, include_right: false)
-      lat_intervals = Geohash36::Interval.convert_array(lat_interval.split, include_left: false)
+  # @fn       def self.validate_coords coords # {{{
+  # @brief    Validate given latitude, longitude coordinates against valid ranges
+  #
+  # @param    [Hash]      coords      Geospartial coordinates hash (latitude, longitude)
+  #
+  def self.validate_coords coords
+    keys = coords.keys
+    raise ArgumentError, "Invalid hash" unless keys.length == 2 && keys.include?(:latitude) && keys.include?(:longitude)
+    lat_inclusion = Geohash36.basic_lat_interval.include? coords[:latitude]
+    lon_inclusion = Geohash36.basic_lon_interval.include? coords[:longitude]
+    raise ArgumentError, "Invalid hash values" unless lat_inclusion && lon_inclusion
+  end # }}}
+
+  # @fn       def self.geohash_symbol! lon_interval, lat_interval, coords {{{
+  # @brief    FIXME
+  #
+  # @param    [FIXME]     lon_interval      FIXME
+  # @param    [FIXME]     lat_interval      FIXME
+  # @param    [Hash]      coords            Geospartial coordinate hash containing latitude, longitude
+  #
+  def self.geohash_symbol! lon_interval, lat_interval, coords
+    lon_intervals   = Geohash36::Interval.convert_array(lon_interval.split, include_right: false)
+    lat_intervals   = Geohash36::Interval.convert_array(lat_interval.split, include_left: false)
 
-      lon_index = lon_intervals.index {|interval| interval.include? coords[:longitude] }
-      lat_index = lat_intervals.index {|interval| interval.include? coords[:latitude]  }
+    lon_index       = lon_intervals.index {|interval| interval.include? coords[:longitude] }
+    lat_index       = lat_intervals.index {|interval| interval.include? coords[:latitude]  }
 
-      lon_interval.update lon_intervals[lon_index]
-      lat_interval.update lat_intervals[lat_index]
+    lon_interval.update lon_intervals[lon_index]
+    lat_interval.update lat_intervals[lat_index]
 
-      GEOCODE_MATRIX[GEOMATRIX_MAX_INDEX-lat_index][lon_index]
-    end
+    GEOCODE_MATRIX[GEOMATRIX_MAX_INDEX-lat_index][lon_index]
+  end # }}}
 
 end # of module Geohash36
 
-Dir[File.dirname(__FILE__) + '/geohash36/library/*.rb'].each {|file| require file }
+# Load other library files
+Dir[ File.dirname(__FILE__) + '/geohash36/library/*.rb' ].each { |file| require file }
+
 
 # vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/geohash36/interface/rake/rspec.rb

@@ -1,8 +1,31 @@
 #!/usr/bin/env ruby
 
-require 'rspec/core/rake_task'
 
-desc "RSpec Core Tasks"
-RSpec::Core::RakeTask.new(:spec)
+## Handle RSpec 1.x and 2.x branches # {{{
+#
+# dm-redis-adapter and others maybe need 1.x while we want 2.x is possible.
+begin
 
+  require 'rspec/core/rake_task'
 
+  desc "RSpec Core Tasks" # {{{
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = '--format NyanCatWideFormatter --color --fail-fast --order random'
+  end # }}}
+
+rescue LoadError
+
+  puts "(WW) Could not load RSpec 2.x branch, falling back to 1.x."
+
+  require 'spec/rake/spectask'
+
+  desc "Run specs" # {{{
+  Spec::Rake::SpecTask.new do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = %w(-fs --color)
+  end # }}}
+
+end # }}}
+
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/geohash36/interface/thor/info.thor

@@ -3,7 +3,6 @@
 
 # System includes
 require 'ostruct'
-require 'awesome_print'
 require 'andand'
 require 'tempfile'
 require 'os'

data/lib/geohash36/library/interval.rb

@@ -1,128 +1,170 @@
-# Designed to provide additional functionality for arrays
-# to handle geographical intervals.
+#!/usr/bin/env ruby
+
+# @class      class Geohash36::Interval < Array
+# @brief      Designed to provide additional functionality for arrays to handle geographical intervals.
 class Geohash36::Interval < Array
 
-  # @param array [Array<Fixnum, Float>] array with length 2.
-  # @param options [Hash]
-  #   options affects borders in interval. By default, all borders are included.
-  #   If you want to exclude left border, pass: `include_left: false`
-  #   If you want to exclude right border, pass: `include_right: false`
-  # @example With default args
-  #   Geohash36::Interval.new
-  # @example With array and options
-  #    Geohash36::Interval.new([0, 6], include_right: false)
+  # @fn       def initialize array = [0, 0], options = {} {{{
+  # @brief    Default constructor for Interval class
+  #
+  # @param    [Array<Fixnum, Float>]    array       Array with length 2.
+  # @param    [Hash]                    options     Hash containing default opts
+  #
+  # @info     Options affects borders in interval. By default, all borders are included.
+  #           If you want to exclude left border, pass: `include_left: false`
+  #           If you want to exclude right border, pass: `include_right: false`
+  #
+  # @example  With default args
+  #           Geohash36::Interval.new
+  # @example  With array and options
+  #           Geohash36::Interval.new([0, 6], include_right: false)
+  #
   def initialize array = [0, 0], options = {}
-    array.try(:compact!)
-    validate_array(array)
-    array.each{|element| self.push element}
-    defaults = {include_right: true, include_left: true }
-    @opts = defaults.merge options
-  end
-
-  # Replace old interval options with new one
+    array.try( :compact! )
+    validate_array( array )
+    array.each{ |element| self.push element }
+    defaults  = { include_right: true, include_left: true }
+    @opts     = defaults.merge options
+  end # of def initialize }}}
+
+  # @fn       def configure options = {} {{{
+  # @brief    Replace old interval options with new one
   #
-  # @param options [Hash] new options for interval
+  # @param    [Hash]    options     New options for interval
   def configure options = {}
     @opts.merge! options
-  end
+  end # of def configure }}}
 
-  # Check if `number` between left and right border.
+  # @fn       def include? number {{{
+  # @brief    Check if `number` between left and right border
   #
-  # @param number [Float, Fixmum] number to check
+  # @param    [Numeric]     number      Number to check
   def include? number
     for_left_border  = (@opts[:include_left] == true)  ? first  <= number : first < number
     for_right_number = (@opts[:include_right] == true) ? number <= last  : number < last
     for_left_border && for_right_number
-  end
+  end # }}}
 
-  # Split interval into 6 parts
-  # @return array of 6 intervals
+  # @fn       def split {{{
+  # @brief    Split interval into 6 parts
+  #
+  # @return   [Array]     Array of 6 intervals
   def split
     split3.each_with_object([]){|interval, result| result.concat interval.split2}
-  end
+  end # }}}
 
-  # Change values of interval
-  # @example
-  #   my_interval = Geohash36::Interval.new([0, 1])
-  #   my_interval.update [0,6]
-  #   my_interval # => [0, 6]
+  # @fn       def update array {{{
+  # @brief    Change values of interval
+  #
+  # @param    [Array]     array     FIXME
+  #
+  # @example  my_interval = Geohash36::Interval.new([0, 1])
+  #           my_interval.update [0,6]
+  #           my_interval # => [0, 6]
   def update array
     array.try(:compact!)
     validate_array(array)
     self.clear
     array.each{|element| self.push element}
-  end
+  end # }}}
 
-  # @return string representation of object
+  # @fn       def inspect {{{
+  # @brief    Returns string for easy inspection of self on print
+  #
+  # @return   [String]      String representation of object
   def inspect
     left_br  = @opts[:include_left]  ? "[" : "("
     right_br = @opts[:include_right] ? "]" : ")"
+
     "#{left_br}#{first}, #{last}#{right_br}"
-  end
+  end # }}}
 
-  # @return string representation of object
+  # @fn       def to_s {{{
+  # @brief    Returns string representation of self for print
+  #
+  # @return   [String]    String representation of object
   def to_s
     inspect
-  end
+  end # }}}
 
-  # @return middle of the interval
-  # @example
-  #   Geohash36::Interval.new([0, 6]).middle
-  #   # => 3.0
+  # @fn       def middle {{{
+  # @brief    Average of given interval (middle)
+  #
+  # @return   [Numeric]     Returns average of the given interval
+  #
+  # @example  Geohash36::Interval.new([0, 6]).middle
+  #             => 3.0
   def middle
     (first + last)/2.0
-  end
+  end # }}}
 
-  # @return third part of interval (only positive values)
-  # @example
-  #   Geohash36::Interval.new([-2, 4]).third
-  #   # => 2.0
+  # @fn       def third {{{
+  # @brief    Computes third part of given interval and returns absolute result
+  #
+  # @return   [Numeric]     Third part of interval (absolute, returns only positive values)
+  #
+  # @example  Geohash36::Interval.new([-2, 4]).third
+  #             => 2.0
+  #
   def third
     ((last - first)/3.0).abs
-  end
+  end # }}}
 
-  # Split interval into 2 parts
-  # @return array of 2 intervals
+  # @fn       def split2 {{{
+  # @brief    Split interval into 2 parts
+  #
+  # @return   [Array]       Array of 2 intervals
   def split2
     [[first, middle], [middle, last]].map{|interval| Geohash36::Interval.new interval}
-  end
+  end # }}}
 
-  # Split interval into 3 parts
-  # @return array of 3 intervals
+  # @fn       def split3 {{{
+  # @brief    Split interval into 3 parts
+  #
+  # @return   [Array]     Returns array of 3 intervals
   def split3
     result = [[self.first, self.first+third], [self.first+third, self.first+2*third], [self.first+2*third, self.last]]
     result.map{|array| Geohash36::Interval.new array}
-  end
-
-  # Convert array of arrays to array of `Geohash36::Interval`s
-  #
-  # @param array [Array] array to convert
-  # @param options [Hash] options for `Geohash36::Interval` object
-  #   but it works a little different. It is not affect first\last elements in array.
-  #   For example, if we do not want to include left border, only first element
-  #   will include left border because this class designed to handle geographical coordinates.
-  #   It is not designed for abstract intervals.
-  # @example
-  #   # for example, we don't want to include left border of interval,
-  #   # so we will have array like `[[0, 0], [0, 0], [0, 0]] ->> [[0, 0], (0, 0], (0, 0]]`
-  #
-  #   my_array = [[0, 2], [2, 6], [6, 10]]
-  #   Geohash36.convert_array(my_array, include_left: false)
-  #   # => [[0, 2], (2, 6], (6, 10]]
+  end # }}}
+
+  # @fn       def self.convert_array array, options = {} {{{
+  # @brief    Convert array of arrays to array of `Geohash36::Interval`s
+  #
+  # @param    [Array]     array       Array to convert
+  # @param    [Hash]      options     Options for `Geohash36::Interval` object
+  #
+  # @info     It works a little different. It is not affect first\last elements in array.
+  #           For example, if we do not want to include left border, only first element
+  #           will include left border because this class designed to handle geographical coordinates.
+  #           It is not designed for abstract intervals.
+  #
+  # @example  e.g. We don't want to include left border of interval,
+  #           so we will have array like `[[0, 0], [0, 0], [0, 0]] ->> [[0, 0], (0, 0], (0, 0]]`
+  #
+  #           my_array = [[0, 2], [2, 6], [6, 10]]
+  #           Geohash36.convert_array(my_array, include_left: false)
+  #             => [[0, 2], (2, 6], (6, 10]]
+  #
   def self.convert_array array, options = {}
     intervals = array.map{|interval| Geohash36::Interval.new interval, options }
     intervals.first.configure(include_left: true) unless options[:include_left]
     intervals.last.configure(include_right: true) unless options[:include_right]
     intervals
-  end
+  end # }}}
+
 
   private
-    # Check if array has valid values
-    def validate_array(array)
-      unless array.length == 2 && ( array.try(:first) <= array.try(:last) )
-        raise ArgumentError, "Not valid array for geohash interval"
-      end
+
+  # @fn       def validate_array array # {{{
+  # @brief    Check if array has valid values
+  #
+  # @param    [Array]     array     FIXME
+  def validate_array array
+    unless array.length == 2 && ( array.try(:first) <= array.try(:last) )
+      raise ArgumentError, "Not valid array for geohash interval"
     end
+  end # }}}
+
 
 end # of class Geohash36::Interval
 

data/spec/spec_helper.rb

@@ -23,7 +23,7 @@ RSpec.configure do |config|
   config.tty = true
 
   # Use the specified formatter
-  config.formatter = :documentation # :progress, :html, :textmate
+  # config.formatter =  # :documentation # :progress, :html, :textmate
 
   config.expect_with :rspec do |c|
     c.syntax = [:should, :expect] # Disable warnings

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geohash36
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Bjoern Rennhak
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-15 00:00:00.000000000 Z
+date: 2014-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -39,20 +39,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.1
-- !ruby/object:Gem::Dependency
-  name: fpm
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: ptools
   requirement: !ruby/object:Gem::Requirement
@@ -81,62 +67,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: msgpack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: amqp
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mime-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: gettext
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: andand
   requirement: !ruby/object:Gem::Requirement
@@ -151,48 +81,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: ick
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: uuid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Commandline interface and library to the Geohash36 Algorithm
 email:
 - bjoern@clothesnetwork.com
@@ -202,17 +90,19 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".project.yaml"
 - AUTHORS.md
 - CHANGELOG.md
 - COPYING.md
+- FAQ.md
 - Gemfile
 - LICENSE.md
 - MAINTAINERS.md
 - README.md
 - Rakefile
 - bin/geohash36
+- examples/demo.rb
 - geohash36.gemspec
-- lib/demo.rb
 - lib/geohash36.rb
 - lib/geohash36/interface/rake/cucumber.rb
 - lib/geohash36/interface/rake/default.rb
@@ -247,7 +137,7 @@ post_install_message: |2
       | |  _|  _|| | | | |_| | / _  ___ | |_| | |_ | '_     | |_| | |__| |_| |  _  |/ ___  ___) |  _  |___) | (_) |
        ____|________/|_| |_/_/   _____/|_| |_|____/ ___/
 
-      (c) 2014-08-15 00:00:00 UTC, All rights reserved
+      (c) 2014-08-17 00:00:00 UTC, All rights reserved
       Clothes Network Ltd., Bjoern Rennhak
 
       Don't forget to configure $HOME/.geohash36/config.