autocomplete_zipcode 0.1.2 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 80a0dae6b23729364949a833b8072dbfaa75a587
-  data.tar.gz: 955c6d77c5efb151d998e2ec17f2b73f88d2bd29
+SHA256:
+  metadata.gz: 0bfef5ece6adb70826e8aaf5cb4de07334fef2895b25c1f1e26f24da8cb900bd
+  data.tar.gz: 1a8d54f3e9243df143b578d160a397e1495cc6ed031a532d7fcc94252d2aa060
 SHA512:
-  metadata.gz: c690142e7826bfdd683ff77833801ea46c6bfcab0360373bae7991809845f2039e5bb125173d20d03cecf98d417f1a696f8d8f523923c320b2f6034c1b1479b4
-  data.tar.gz: 74b0616c607da31c3dc02f5c47b56808161de998ddf4314a6c1792556c339bd6b95f49f6744f52b690bfce14fa05523830e8b2345e89608f51955d86a39a28ba
+  metadata.gz: 7b21f6f15b7a15d200996f65be233065e6da0b5905fddf253026dfc2d356c0896137409dc0af6598f346905fe86f578d12af2553ffae4b073bd4ffe0f94995ee
+  data.tar.gz: f08065a0337b9befbe5bc24015faeff49c80a12f82e47535884ba7dddb8ed45b76c895412facade5c17f94be9b8166f130c664b7eb820a6ead9c7d0cca09f3ff

data/.codeclimate.yml

@@ -0,0 +1,10 @@
+version: "2"
+plugins:
+  rubocop:
+    enabled: true
+    channel: rubocop-0-60
+    config:
+      file: ".rubocop.yml"
+exclude_patterns:
+  - "spec/"
+  - "spec/**/*"

data/.github/pull_request_template.md

@@ -0,0 +1,19 @@
+# Overview
+
+## Implementation Details
+
+## Required Documentation Updates
+
+None.
+
+## Testing Notes
+
+None.
+
+## API Changes
+
+None.
+
+## External Dependency Changes
+
+None.

data/.gitignore

@@ -1,9 +1,13 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
+
+spec/dummy/log/*.log
+spec/dummy/tmp
+spec/dummy/test
+spec/dummy/db/*.sqlite3

data/.rspec

@@ -1,2 +1 @@
---format documentation
---color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  SuggestExtensions: false
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'spec/dummy/**/*'
+Style/Documentation:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+autocomplete_zipcode

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.travis.yml

@@ -1,3 +1,15 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=$CODE_CLIMATE_TOKEN
 language: ruby
 rvm:
-  - 2.2.1
+  - 2.6.3
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+  - gem install bundler:2.1.4
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 # Specify your gem's dependencies in autocomplete_zipcode.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,209 @@
+PATH
+  remote: .
+  specs:
+    autocomplete_zipcode (2.1.1)
+      rails (>= 3.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.3.1)
+      actionview (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.3.1)
+      activesupport (= 6.1.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.3.1)
+      activesupport (= 6.1.3.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activerecord (6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activestorage (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      marcel (~> 1.0.0)
+      mini_mime (~> 1.0.2)
+    activesupport (6.1.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    jquery-rails (4.4.0)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    loofah (2.9.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.1)
+    method_source (1.0.0)
+    mini_mime (1.0.3)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
+    nio4r (2.5.7)
+    nokogiri (1.11.2)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.3.1)
+      actioncable (= 6.1.3.1)
+      actionmailbox (= 6.1.3.1)
+      actionmailer (= 6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actiontext (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
+    rubocop (1.12.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    simple_form (5.1.0)
+      actionpack (>= 5.2)
+      activemodel (>= 5.2)
+    simplecov (0.20.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autocomplete_zipcode!
+  jquery-rails (~> 4.4.0)
+  pry (~> 0.14.0)
+  rake (~> 13.0.3)
+  rspec-rails (~> 5.0.0)
+  rubocop (~> 1.12.0)
+  simple_form (>= 5.1.0)
+  simplecov (~> 0.20.0)
+  sqlite3 (~> 1.4.2)
+
+BUNDLED WITH
+   2.1.4

data/Makefile

@@ -0,0 +1,2 @@
+default:
+	./bin/console

data/README.md

@@ -2,6 +2,16 @@
 
 This gem was built to "automagically" fills an address form, for Rails version >= 3.1.
 
+## Status
+
+[![Build Status](https://api.travis-ci.com/marcelobarreto/autocomplete_zipcode.svg?branch=master)](https://travis-ci.com/marcelobarreto/autocomplete_zipcode)
+[![Maintainability](https://api.codeclimate.com/v1/badges/37008f3eeaaf2ea47122/maintainability)](https://codeclimate.com/github/marcelobarreto/autocomplete_zipcode/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/37008f3eeaaf2ea47122/test_coverage)](https://codeclimate.com/github/marcelobarreto/autocomplete_zipcode/test_coverage)
+[![RubyGems](http://img.shields.io/gem/dt/autocomplete_zipcode.svg?style=flat)](http://rubygems.org/gems/autocomplete_zipcode)
+
+## Try it
+
+[Online](http://autocompletezipcode.herokuapp.com)
 
 ## Installation
 
@@ -14,23 +24,29 @@ gem 'autocomplete_zipcode'
 And then execute:
 
 ```bash
-$ bundle install
+bundle install
 ```
 
-## Usage
+## Simple Usage
 
 In app/assets/javascripts/application.js, you should add as follows:
 
 ```js
+// app/assets/javascripts/application.js
 //= require ...
+//= require turbolinks
+//= require jquery
 //= require autocomplete_zipcode
-//= require ...
+
+$(document).on('ready', () => {
+  AutocompleteZipcode.mount();
+});
 ```
 
-Basic Example:
+## Basic Example
 
 ```erb
-<%= simple_form_for :example do | f | %>
+<%= simple_form_for :example do |f| %>
   ...
   <%= f.input :zipcode, as: :zipcode %>
   <%= f.input :street, as: :street %>
@@ -44,10 +60,10 @@ Basic Example:
 If you are not using simple_form, then simply add the `data-provider="zipcode"` and the other fields name to the input field yourself.
 
 ```erb
-<%= form_for :example do | f | %>
+<%= form_for :example do |f| %>
   ...
-  <%= f.text_field :zipcode, data: {provider: :zipcode} %>
-  <%= f.text_field :street, data: {provider: :street}  %>
+  <%= f.text_field :zipcode, data: { autocomplete_zipcode_provider: :zipcode } %>
+  <%= f.text_field :street, data: { autocomplete_zipcode_provider: :street }  %>
   ...
 <% end %>
 ```
@@ -57,14 +73,46 @@ If you are not using simple_form, then simply add the `data-provider="zipcode"`
 Simply add an event listener callback to `zipcode.error`, for example:
 
 ```js
-document.addEventListener('zipcode.error', function(e) {
+// app/assets/javascripts/application.js
+
+document.addEventListener('zipcode.error', () => {
   alert('Invalid zipcode!!!')
 });
 ```
 
+## Advanced Usage
+
+```js
+// app/assets/javascripts/application.js
+//= require ...
+//= require turbolinks
+//= require jquery
+//= require autocomplete_zipcode
+
+$(document).on('ready', () => {
+  AutocompleteZipcode.mount({
+    onSuccess: (containerEl, zipcodeEl) => {
+      console.log(containerEl, zipcodeEl);
+    },
+    onFail: (containerEl, zipcodeEl) => {
+      console.log(containerEl, zipcodeEl);
+    },
+  });
+
+  document.addEventListener('zipcode.success', () => {
+    console.log('zipcode fetched successfully');
+  });
+
+  document.addEventListener('zipcode.error', () => {
+    console.log('zipcode fetch failed');
+  });
+});
+```
+
 ## Sample projects
 
-For an example, take a look at the `example` folder in this repository.
+For an online example, take a look at [this repository](https://github.com/marcelobarreto/autocomplete_zipcode_example).
+You can also see it working on the dummy application (`spec/dummy`)
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,8 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec