address_picker-rails 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,23 @@
+source 'http://rubygems.org'
+
+# ------------------------------------------------------------------------------
+# Dependencies required to use the gem.
+gem 'rails', '~> 3.2.0'
+
+
+
+# ------------------------------------------------------------------------------
+# Dependencies to develop the gem.
+# Everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'bundler',      '~> 1.1.0'
+  gem 'capybara',     '~> 1.1.0'
+  gem 'guard',        '~> 1.3.0'
+  gem 'guard-rspec',  '~> 1.2.0'
+  gem 'guard-spork',  '~> 1.1.0'
+  gem 'jeweler',      '~> 1.8.4'
+ #gem 'rcov',         '>= 0'
+  gem 'rdoc',         '~> 3.12'
+  gem 'rspec-rails',  '~> 2.11.0'
+  gem 'sqlite3',      '~> 1.3.0'
+end

data/Gemfile.lock

@@ -0,0 +1,155 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.8)
+      actionpack (= 3.2.8)
+      mail (~> 2.4.4)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.3.2)
+    arel (3.0.2)
+    builder (3.0.0)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.5)
+      ffi (~> 1.0, >= 1.0.6)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    ffi (1.1.5)
+    git (1.2.5)
+    guard (1.3.2)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-rspec (1.2.1)
+      guard (>= 1.1)
+    guard-spork (1.1.0)
+      guard (>= 1.1)
+      spork (>= 0.8.4)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    journey (1.0.4)
+    json (1.7.5)
+    libwebsocket (0.1.5)
+      addressable
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    nokogiri (1.5.5)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.8)
+      actionmailer (= 3.2.8)
+      actionpack (= 3.2.8)
+      activerecord (= 3.2.8)
+      activeresource (= 3.2.8)
+      activesupport (= 3.2.8)
+      bundler (~> 1.0)
+      railties (= 3.2.8)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    rspec-rails (2.11.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.11.0)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.25.0)
+      childprocess (>= 0.2.5)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
+    spork (0.9.2)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.0)
+  capybara (~> 1.1.0)
+  guard (~> 1.3.0)
+  guard-rspec (~> 1.2.0)
+  guard-spork (~> 1.1.0)
+  jeweler (~> 1.8.4)
+  rails (~> 3.2.0)
+  rdoc (~> 3.12)
+  rspec-rails (~> 2.11.0)
+  sqlite3 (~> 1.3.0)

data/Guardfile

@@ -0,0 +1,37 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'spork', :cucumber_env => { 'RAILS_ENV' => 'test' }, :rspec_env => { 'RAILS_ENV' => 'test' } do
+  watch('config/application.rb')
+  watch('config/environment.rb')
+  watch('config/environments/test.rb')
+  watch(%r{^config/initializers/.+\.rb$})
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb') { :rspec }
+  watch('test/test_helper.rb') { :test_unit }
+  watch(%r{features/support/}) { :cucumber }
+end
+
+#guard 'rspec', :version => 2 do
+guard 'rspec', :cli => "--color --drb", :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^spec/dummy/app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/dummy/app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^spec/dummy/app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('spec/dummy/app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara request specs
+  watch(%r{^spec/dummy/app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 David DIDIER
+
+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/README.md

@@ -0,0 +1,212 @@
+# address_picker-rails
+
+An address picker for Rails with autocompletion and map picking.
+This library is built upon [jquery-addresspicker](https://github.com/sgruhier/jquery-addresspicker) and adds convenient features such as:
+
+* integration with the assets pipeline
+* auto loading of the Google Maps API
+* auto discovery of the address picker fields
+* JavaScript object wrappers
+* (TODO) form builders
+
+## Installation
+
+Add it to your Gemfile:
+
+`gem 'address_picker-rails'`
+
+Run the following command to install it:
+
+`bundle install`
+
+In your JavaScript manifest `application.js` add:
+
+`//= require address_picker-rails`
+
+Since `jquery-addresspicker` uses jQuery-UI themes, you may use [jquery-ui-themes-rails](https://github.com/fatdude/jquery-ui-themes-rails) instead of defining your own theme:
+
+* add to your Gemfile: `gem 'jquery-ui-themes'`
+* add to you CSS manifest `application.css`: ` *= require jquery-ui/<theme_name>`
+
+## Usage
+
+You may also refer to this little [demo application](http://address-picker-rails-demo.herokuapp.com) on Heroku.
+
+### Model
+
+In your migration:
+
+    class CreatePonds < ActiveRecord::Migration
+      def change
+
+        create_table :ponds do |t|
+
+          t.string :address
+          t.string :address_latitude
+          t.string :address_longitude
+          t.string :address_locality
+          t.string :address_country
+
+          t.timestamps
+        end
+
+      end
+    end
+
+In your model:
+
+    class Pond < ActiveRecord::Base
+      attr_accessible :address, :address_latitude, :address_longitude, :address_locality, :address_country
+    end
+
+### View
+
+Consider the following example:
+
+    <div class="field">
+      <%= f.label :address %><br />
+      <%= f.text_field :address, :class => 'address-picker-input' %>
+    </div>
+
+    <div class="field">
+      <%= f.label :address_latitude %><br />
+      <%= f.text_field :address_latitude, :readonly => true, :class => 'address-picker-latitude' %> </div>
+
+    <div class="field">
+      <%= f.label :address_longitude %><br />
+      <%= f.text_field :address_longitude, :readonly => true, :class => 'address-picker-longitude' %>
+    </div>
+
+    <div class="field">
+      <%= f.label :address_locality %><br />
+      <%= f.text_field :address_locality, :readonly => true, :class => 'address-picker-locality' %>
+    </div>
+
+    <div class="field">
+      <%= f.label :address_country %><br />
+      <%= f.text_field :address_country, :readonly => true, :class => 'address-picker-country' %>
+    </div>
+
+    <div class="field">
+      <%= f.label :address_map %><br />
+
+      <!-- *** Pay attention to the IDs *** -->
+      <div id="pond_address_map_wrapper" class="address-picker-map-wrapper">
+        <div class="address-picker-legend">You can drag and drop the marker to the correct location</div>
+        <div id="pond_address_map" class="address-picker-map"></div>
+      </div>
+    </div>
+
+#### IDs
+
+Pay attention to the IDs of the fields: all related fields must have an ID beginning with the same prefix (here that's `pond_address` since we are using a form builder). The default prefix is `address`.
+
+<table>
+  <tr>
+    <th>ID</th>
+    <th>Required</th>
+    <th>Read only</th>
+  </tr>
+  <tr>
+    <td>[prefix]</td>
+    <td>X</td>
+    <td></td>
+  </tr>
+  <tr>
+    <td>[prefix]_latitude</td>
+    <td></td>
+    <td>X</td>
+  </tr>
+  <tr>
+    <td>[prefix]_longitude</td>
+    <td></td>
+    <td>X</td>
+  </tr>
+  <tr>
+    <td>[prefix]_locality</td>
+    <td></td>
+    <td>X</td>
+  </tr>
+  <tr>
+    <td>[prefix]_country</td>
+    <td></td>
+    <td>X</td>
+  </tr>
+  <tr>
+    <td>[prefix]_map</td>
+    <td></td>
+    <td>X</td>
+  </tr>
+</table>
+
+NB: In the above example, the ID of the map field is `pond_address_map` since it's not set by a builder.
+
+#### CSS
+
+The CSS classes are optional unless you're planning to use the auto-discovery feature (see below).
+If you do, the address field must have the `address-picker-input` class.
+
+### Scripts
+
+There are several ways to initialize the address pickers.
+
+#### Auto discovery
+
+The simplest one is to use auto discovery which:
+
+* (optionally) waits for the DOM to be loaded, then
+* searches for all fields having the `address-picker-input` CSS class, then
+* uses each ID of these fields as a prefix to apply an address picker
+
+So you can just add to your `application.js` or to your view:
+
+    AddressPickerRails.Pickers.applyOnReady();
+
+You can provide a callback which will be called after each address picker has been applied:
+
+    AddressPickerRails.Pickers.applyOnReady({
+      'onLoad':function (picker) {
+        console.debug("callback for a single pond with ID '%s'", picker.getIdPrefix());
+      }
+    });
+
+The not deferred version:
+
+    AddressPickerRails.Pickers.apply();
+
+#### Manual
+
+The ID prefix default is `address`:
+
+    new AddressPickerRails.Picker().apply();
+
+You can use a custom ID prefix:
+
+    new AddressPickerRails.Picker({idPrefix:"pond_address"}).apply();
+
+You can provide a callback which will be called after the address picker has been applied:
+
+    var picker = new AddressPickerRails.Picker({idPrefix:"pond_address"});
+    picker.apply(function (railsPicker) {
+        console.debug("callback for a single pond with ID '%s'", railsPicker.getIdPrefix());
+    });
+
+## Requirements
+
+Tested with Rails 3.2 but it should work with Rails 3.1, or anything that uses the asset pipeline.
+
+## Contributing to address_picker-rails
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 David DIDIER. See LICENSE.txt for further details.
+
+[Sébastien Gruhier@https://github.com/sgruhier/jquery-addresspicker](https://github.com/sgruhier/jquery-addresspicker)