open_location_code 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82d946e05ee8c635c1aea25b7c11bf8309d195a2
-  data.tar.gz: 370f96971c64f1384c387a913ee5494f49e77b18
+  metadata.gz: 071697a22f6df46767823f06f9921bf3b3243907
+  data.tar.gz: ab25d5730ecf2bb1358debcbc79fcdd84f0610e7
 SHA512:
-  metadata.gz: ddc3ec4f227802e24bdd6072055c6987771b6ded212f13ab70e62e7b351e5c1b16e60d67cd47314ad7625ff10e24167d6ee431d616059dda89dbb3719650a393
-  data.tar.gz: 24affbebbf437f9dedf76472ecfda8641345c63709406134fcd8dd007cb88573d2b8ee9ff04431595d8ad16f51188f28275ef7e445b5abfedf57ebc818ab01f3
+  metadata.gz: 3c82c18998888801b588ff27d292a15343f93c264c39efce46907dedac5ee54415c189da5da0591bf834cf4950dc71a4bf2053a0789997d8edf05976b40b5c73
+  data.tar.gz: b00860bd8fbf620b1a6593901101e47d59a3e93eac58eb4c4b296bf0502eeb0bbe7e9bda43737e670d3ac25c94a66661f0b871df147aa07d147184b8dc114c46

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 *.swp
+*.gem

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Jiren
+Copyright (c) 2015 Jiren[jirenpatel@gmail.com]
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,7 @@
 # OpenLocationCode
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/open_location_code`. To experiment with that code, run `bin/console` for an interactive prompt.
+Open Location Codes are a way of encoding location into a form that is
+easier to use than latitude and longitude.
 
 Ref:  https://github.com/google/open-location-code
 
@@ -10,7 +11,7 @@ Ref:  https://github.com/google/open-location-code
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'open_location_code', github: 'jiren/open_location_code'
+gem 'open_location_code'
 ```
 
 And then execute:
@@ -27,10 +28,56 @@ Or install it yourself as:
   code = OpenLocationCode.encode(47.365590, 8.524997) # 8FVC9G8F+6X
   code = OpenLocationCode.encode(47.365590, 8.524997, 12) #8FVC9G8F+6XQH
  
-  code_area = OpenLocationCode.decode(code)
+  code_area = OpenLocationCode.decode('8FVC9G8F+6XQH')
   # #<OpenLocationCode::CodeArea:0x007fe7eb050110 @latitude_lo=47.36557499999997, @longitude_lo=8.524968750000008, @latitude_hi=47.36557499999997, @longitude_hi=8.52500000000001, @code_length=12, @latitude_center=47.36557499999997, @longitude_center=8.52498437500001>
 ```
 
+## Rails
+
+  Include `Olc` module and call `has_olc` method
+
+  `has_olc` has default options `{ field: 'open_location_code', latitude: 'latitude', longitude: 'longitude', code_length: 10 }`
+
+
+- ActiveRecord
+
+  Generate migration to add latitude, longitude and open_location_code fields.
+
+```
+  rails g migration add_olc_fields_to_events latitude:float longitude:float open_location_code:string
+```
+
+  In Model:
+
+```
+  class Event < < ActiveRecord::Base
+    include Olc
+
+    has_olc
+
+    # If fields not same as default options
+    has_olc(field: 'olc', latitude: 'lat', longitude: 'lng', code_length: 10)
+  end
+```
+
+- Mongoid
+
+  `has_olc` will define field based on passed options[:field] value.
+
+```
+  class Event
+     include Mongoid::Document
+     include Olc
+      
+     field :latitude,   type: Float
+     field :longitude,  type: Float
+
+     has_olc
+  end
+```
+
+  
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -39,7 +86,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/open_location_code/fork )
+1. Fork it ( https://github.com/jiren/open_location_code )
 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`)

data/lib/open_location_code.rb

@@ -107,3 +107,8 @@ module OpenLocationCode
   end
 
 end
+
+if defined?(Rails)
+  require 'rails/olc'
+end
+

data/lib/open_location_code/version.rb

@@ -2,5 +2,5 @@ module OpenLocationCode
   #
   # Version of lib
   #
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/rails/olc.rb

@@ -0,0 +1,67 @@
+module Olc
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+
+    # Default Olc options
+    OLC_OPTIONS = {
+      field: 'open_location_code',
+      latitude: 'latitude',
+      longitude: 'longitude',
+      code_length: 10
+    }
+
+    #
+    # Define before_save callback to generate olc code.
+    #
+    # @example
+    #
+    #   has_olc
+    #   # or
+    #   has_olc(field: 'olc', latitude: 'lat', longitude: 'lng', code_length: 10)
+    #
+    #
+    # @params [Hash] options
+    #   Default options
+    #     {
+    #       field: 'open_location_code',
+    #       latitude: 'latitude',
+    #       longitude: 'longitude',
+    #       code_length: 10
+    #     }
+    #
+    def has_olc(options = {})
+      options = OLC_OPTIONS.merge(options)
+
+      if defined?(Mongoid)
+        field options[:field], type: String
+      end
+
+      before_save do |obj|
+        lat_field = options[:latitude]
+        lng_field = options[:longitude]
+
+        changed_attrs = obj.changed_attributes
+
+        if changed_attrs.key?(lat_field) || changed_attrs.key?(lng_field)
+          if obj[lat_field] && obj[lng_field]
+            obj[options[:field]] = obj.olc_encode(options[:code_length])
+          else
+            obj[options[:field]] = nil
+          end
+        end
+      end
+
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def olc_encode(code_length = nil)
+          OpenLocationCode.encode(#{options[:latitude]}, #{options[:longitude]}, code_length)
+        end
+
+        def olc_decode
+          OpenLocationCode.decode(#{options[:field]})
+        end
+      RUBY
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_location_code
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jiren
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-29 00:00:00.000000000 Z
+date: 2015-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,6 +62,7 @@ files:
 - lib/open_location_code/decoder.rb
 - lib/open_location_code/encoder.rb
 - lib/open_location_code/version.rb
+- lib/rails/olc.rb
 - open_location_code.gemspec
 homepage: https://github.com/jiren/open_location_code
 licenses: