Pr0d1r2-geokit-cached 0.1.1

data/History.txt

@@ -0,0 +1,3 @@
+== 0.1.0 2009-06-01
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,23 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/geokit-cached.rb
+lib/geokit-cached/geocodable.rb
+lib/geokit-cached/model.rb
+script/console
+script/destroy
+script/generate
+spec/geokit-cached_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake
+generators/geokit_cached
+generators/geokit_cached/geokit_cached_generator.rb
+generators//geokit_cached/templates
+generators/geokit_cached/templates/model.rb
+generators/geokit_cached/templates/model_spec.rb
+generators/geokit_cached/geokit_cached_generator.rb
+generators/geokit_cached/templates/model.rb
+generators/geokit_cached/templates/model_spec.rb

data/PostInstall.txt

@@ -0,0 +1,3 @@
+
+For more information on geokit-cached, see http://geokit-cached.rubyforge.org
+

data/README.rdoc

@@ -0,0 +1,67 @@
+= geokit-cached
+
+* http://github.com/Pr0d1r2/geokit-cached
+
+== DESCRIPTION:
+
+Caching support to Geokit. It prevents from exceeding limit of queres to geocoding services.
+
+== FEATURES/PROBLEMS:
+
+* Store cached locations in database.
+* Use ActiveRecord
+* only address, lat, lng and provider are stored.
+* FIX: convince ./script/generate geokit_cached  to create complete model
+
+== SYNOPSIS:
+
+./script/generate geokit_cached
+
+# table which locations are stored (./script/generate geokit-cached)
+class CachedLocation < ActiveRecord::Base
+  include Geokit::Cached::Model
+end
+
+# table for which locations will be cached
+class Profile < ActiveRecord::Base
+  include Geokit::Cached::Geocodable
+  before_save :geocode_address_cached
+  cache_locations true
+  default_country 'Poland'
+end
+
+== REQUIREMENTS:
+
+* geokit gem
+* rails
+* rspec
+* rspec-rails
+
+== INSTALL:
+
+* sudo gem install geokit-cached
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+%w[rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/geokit-cached'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('geokit-cached', Geokit::Cached::VERSION) do |p|
+  p.developer('Marcin Nowicki', 'pr0d1r2@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+    ['rspec-rails','>= 1.1.12'],
+    ['rspec','>= 1.1.12'],
+    ['geokit','>= 1.2.6'],
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/generators/geokit_cached/geokit_cached_generator.rb

@@ -0,0 +1,8 @@
+class GeokitCachedGenerator < RspecModelGenerator
+
+  def initialize(runtime_args, runtime_options = {})
+    runtime_args = ['CachedLocation', 'address:string', 'provider:string', 'lng:float', 'lat:float']
+    super
+  end
+
+end

data/generators/geokit_cached/templates/model.rb

@@ -0,0 +1,5 @@
+class <%= class_name %> < ActiveRecord::Base
+
+  include Geokit::Cached::Model
+
+end

data/generators/geokit_cached/templates/model_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../spec_helper')
+
+describe <%= class_name %> do
+  before(:each) do
+    @valid_attributes = {
+<% attributes.each_with_index do |attribute, attribute_index| -%>
+      :<%= attribute.name %> => <%= attribute.default_value %><%= attribute_index == attributes.length - 1 ? '' : ','%>
+<% end -%>
+    }
+  end
+
+  it "should create a new instance given valid attributes" do
+    <%= class_name %>.create!(@valid_attributes)
+  end
+end

data/lib/geokit-cached.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'geokit-cached/geocodable'
+require 'geokit-cached/model'
+
+module Geokit
+  module Cached
+    VERSION = '0.1.1'
+  end
+end

data/lib/geokit-cached/geocodable.rb

@@ -0,0 +1,67 @@
+module Geokit
+  module Cached
+    module Geocodable
+
+      @@cache_locations = true
+      @@default_country = 'Poland'
+
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.class_eval do
+          attr_accessor :provider
+        end
+      end
+
+      def selected_country
+        country || @@default_country
+      end
+
+      def complete_address
+        "%s, %s" % [address, selected_country]
+      end
+
+      def cached_location_for_address
+        CachedLocation.find_by_address(complete_address)
+      end
+
+      def cached_location_for_address?
+        !cached_location_for_address.nil?
+      end
+
+      def cached_location
+        cached_location_for_address || CachedLocation.new(:address => complete_address)
+      end
+
+      def cache_locations?
+        @@cache_locations
+      end
+
+      def cache_location!
+        cached_location.cache!(:lat => lat, :lng => lng, :provider => provider) if cache_locations?
+      end
+
+      def geocode_address_cached
+        if cached_location_for_address?
+          self.lat, self.lng, self.provider = cached_location.lat, cached_location.lng, cached_location.provider
+        else
+          @geo = Geokit::Geocoders::MultiGeocoder.geocode(complete_address)
+          if @geo.success
+            self.lat, self.lng, self.provider = @geo.lat, @geo.lng, @geo.provider
+            cache_location! if cache_locations?
+          end
+        end
+      end
+
+      module ClassMethods
+        def cache_locations(value)
+          @@cache_locations = value
+        end
+
+        def default_country(value)
+          @@default_country = value
+        end
+      end
+
+    end
+  end
+end

data/lib/geokit-cached/model.rb

@@ -0,0 +1,24 @@
+module Geokit
+  module Cached
+    module Model
+
+      def cache!(attributes)
+        self.attributes = attributes
+        save if new_record? || changed?
+      end
+
+      def by_google?
+        provider == 'google'
+      end
+
+      def changed_to_google?
+        by_google? && provider_changed?
+      end
+
+      def changed?
+        lat_changed? || lng_changed? || changed_to_google?
+      end
+
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/geokit-cached.rb'}"
+puts "Loading geokit-cached gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/geokit-cached_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Place your specs here" do
+  
+  it "find this spec in spec directory" do
+    # violated "Be sure to write your specs"
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'geokit-cached'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: Pr0d1r2-geokit-cached
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Marcin Nowicki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.12
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.12
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: geokit
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Caching support to Geokit. It prevents from exceeding limit of queres to geocoding services.
+email: 
+- pr0d1r2@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/geokit-cached.rb
+- lib/geokit-cached/geocodable.rb
+- lib/geokit-cached/model.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/geokit-cached_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+- generators/geokit_cached
+- generators/geokit_cached/geokit_cached_generator.rb
+- generators/geokit_cached/templates
+- generators/geokit_cached/templates/model.rb
+- generators/geokit_cached/templates/model_spec.rb
+has_rdoc: true
+homepage: http://github.com/Pr0d1r2/geokit-cached
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: geokit-cached
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Caching support to Geokit
+test_files: []
+