Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

initial readme

  • Loading branch information...
commit 9d3c7e5ca92bd46cdea9fbf04adf90b3ef98f9e6 1 parent c34186a
@netskin-ci netskin-ci authored
Showing with 133 additions and 0 deletions.
  1. +76 −0 README.rdoc
  2. +57 −0 sequel_mappable.gemspec
View
76 README.rdoc
@@ -0,0 +1,76 @@
+=About
+
+Mappable provides geo distance-based filters and distance calculation functionality for
+model. It requires the geokit gem and was heavily inspired by the
+{geokit-rails gem}[http://github.com/andre/geokit-rails].
+
+==Install
+
+Simply install it as any other gem:
+
+ gem install sequel_mappable
+
+Or when using bundler, add it got your Gemfile:
+
+ gem sequel_mappable
+
+This should also install the geokit gem.
+
+==Quick Start
+
+In your model:
+
+ class User < Sequel::Model
+ plugin :mappable
+ end
+
+In your migrations:
+
+ class AddGeoDataToUser < Sequel::Migration
+ def up
+ alter_table :users do
+ add_column :lng, Float
+ add_column :lat, Float
+ end
+ end
+
+ def down
+ alter_table :users do
+ drop_column :lng
+ drop_column :lat
+ end
+ end
+ end
+
+Now add some records with valid geo data.
+
+In your controller you can then do:
+
+ def index
+ users_near_to_me = User.f_origin(User[1], 10)
+ end
+
+==Filters
+
+Please have a look at the source to get a full list of all available functionality.
+
+==Todo
+
+* Source documentation (rdoc)
+* Source cleanup (no hardcoding of column names)
+* Better support for :km, :miles, :sphere, :flat, etc.
+* Tests
+
+==Contributing
+
+If you'd like to contribute a feature or bugfix: Thanks! To make sure your
+fix/feature has a high chance of being included, please read the following
+guidelines:
+
+1. Fork the project.
+2. Make your feature addition or bug fix.
+3. Add tests for it. This is important so we don’t break anything in a future version unintentionally.
+4. Commit, do not mess with rakefile, version, or history. (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)
+5. Send me a pull request. Bonus points for topic branches.
+
+
View
57 sequel_mappable.gemspec
@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+ s.name = %q{sequel_mappable}
+ s.version = "0.0.1"
+
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+ s.authors = ["Corin Langosch"]
+ s.date = %q{2010-08-31}
+ s.description = %q{Sequel plugin which provides geo distance-based filters and distance calculation functionality for model.}
+ s.email = %q{info@netskin.com}
+ s.extra_rdoc_files = [
+ "LICENSE",
+ "README.rdoc"
+ ]
+ s.files = [
+ ".document",
+ ".gitignore",
+ "LICENSE",
+ "README.rdoc",
+ "Rakefile",
+ "VERSION",
+ "lib/sequel_mappable.rb",
+ "spec/sequel_mappable_spec.rb",
+ "spec/spec.opts",
+ "spec/spec_helper.rb"
+ ]
+ s.homepage = %q{http://github.com/gucki/sequel_mappable}
+ s.rdoc_options = ["--charset=UTF-8"]
+ s.require_paths = ["lib"]
+ s.rubygems_version = %q{1.3.7}
+ s.summary = %q{Usefull geo data filters for Sequel}
+ s.test_files = [
+ "spec/spec_helper.rb",
+ "spec/sequel_mappable_spec.rb"
+ ]
+
+ if s.respond_to? :specification_version then
+ current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+ s.specification_version = 3
+
+ if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+ s.add_runtime_dependency(%q<geokit>, [">= 1.5.0"])
+ s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+ else
+ s.add_dependency(%q<geokit>, [">= 1.5.0"])
+ s.add_dependency(%q<rspec>, [">= 1.2.9"])
+ end
+ else
+ s.add_dependency(%q<geokit>, [">= 1.5.0"])
+ s.add_dependency(%q<rspec>, [">= 1.2.9"])
+ end
+end
+
Please sign in to comment.
Something went wrong with that request. Please try again.