autocomplete_zipcode 0.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dcba0f183cd507240edbdf8339df464e59f45b72
-  data.tar.gz: 196b2ca58e9871903acfd9c66aac2df6caa4ca0f
+SHA256:
+  metadata.gz: f8b7aefc93d38da2a23783246342051799bae1e0cee0beb842e80c85e10afde8
+  data.tar.gz: f0a528f4432d060b5c3518cc268a8278facf36bfae9ce8c8e1e701a8db282373
 SHA512:
-  metadata.gz: bb922c16004b3de26cde88f3bd3de274cb07a1eaf31debc5a8abb82728e963977effc7fa0eee7e4c6449927fcfb2c5708d6f87fd97e8a511957903b23c5f30ae
-  data.tar.gz: d7de550a5b1ea2982e873fe6e7dfd2f0816f2e7e87fd30b364b7dd483e51cdb21d98a6e2e9d4654e2121689aff655f24d4577ce485acd5e93622eb8232ffec8d
+  metadata.gz: 5aaa4ea4c71395e3b013f101f69590f9c94f453ff220169957627f6f894039bc571fe9a11e436114d1fde4873fed8f9ef69c7fea7f277b19a171b06862e2a3a7
+  data.tar.gz: '0893608e98e986999b174ded384a14f881be7e2113074691293d3d5f8021fb920748ddc68e96df20e0a62f8c75f0ef57e188eb57d9402b39181133cb87c1d2bd'

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/support/helpers"

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.0.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)
+  rails (>= 4.2.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

@@ -0,0 +1,123 @@
+# AutocompleteZipcode
+
+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.org/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
+
+Add the following gems to your application's Gemfile:
+
+```ruby
+gem 'autocomplete_zipcode'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## 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
+
+$(document).on('ready', () => {
+  AutocompleteZipcode.mount();
+});
+```
+
+## Basic Example
+
+```erb
+<%= simple_form_for :example do |f| %>
+  ...
+  <%= f.input :zipcode, as: :zipcode %>
+  <%= f.input :street, as: :street %>
+  <%= f.input :neighborhood, as: :neighborhood %>
+  <%= f.input :city, as: :city %>
+  <%= f.input :state, as: :state %>
+  ...
+<% end %>
+```
+
+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| %>
+  ...
+  <%= f.text_field :zipcode, data: { autocomplete_zipcode_provider: :zipcode } %>
+  <%= f.text_field :street, data: { autocomplete_zipcode_provider: :street }  %>
+  ...
+<% end %>
+```
+
+## Handle invalid zipcodes
+
+Simply add an event listener callback to `zipcode.error`, for example:
+
+```js
+// 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 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
+
+1. Fork it
+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`)
+5. Create new Pull Request

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