active_admin-cep_auto_complete 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee29d09bb0a517cf7e3ee20b168b6ec7bfbc38cc
+  data.tar.gz: f01eab45e449e4cd1c18ee2c8b72d3852c0949db
+SHA512:
+  metadata.gz: 4781b7af4563d7a3b843b1510a9325de5b4833aa38d119ba9a306c8842dc42431a1783d8554e75d4a962f351c8b3d87df4bd7de50092236bb69fc0d99b3b8ff9
+  data.tar.gz: 5bd3c1d34ca55f0c7f0159276127359e4bbcf5f7e43bdef18ec795ff79430d320758d4779686cf18873b06f43513c138043b04893cb11f0dbec96a6df7f00497

data/.editorconfig

@@ -0,0 +1,13 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+doc
+log
+*.lock

data/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing
+
+## Issues
+
+If you want to request a feature or report a bug, please use the following template.
+
+```markdown
+## Description
+
+[Add feature/bug description here]
+
+## How to reproduce
+
+[Add steps on how to reproduce this issue]
+
+## What do you expect
+
+[Describe what do you expect to happen]
+
+## What happened instead
+
+[Describe the actual results]
+
+## Gem version:
+
+Version: [Add gem version here]
+```
+
+## Writing code
+
+Once you've made your great commits (include tests, please):
+
+1. [Fork](http://help.github.com/forking/) the [original repository](http://github.com/dhyegofernando/active_admin-cep_auto_complete)
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. [Create an Issue](http://github.com/dhyegofernando/active_admin-cep_auto_complete/issues) with a link to your branch
+5. That's it!
+
+Please respect the code style using [editorconfig](http://editorconfig.org/) in your text editor.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in active_admin-cep_auto_complete.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dhyego Fernando
+
+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,93 @@
+# ActiveAdmin CEP Auto Complete (brazilian postal code)
+Auto complete your addresses fields with Brazilian CEP (zip code).
+
+## Installation
+Include to your Gemfile
+```ruby
+gem 'active_admin-cep_auto_complete'
+```
+
+## Usage
+**1. Create a custom page in `app/admin/cep.rb`**
+```ruby
+ActiveAdmin.register_page 'CEP' do
+  include ActiveAdmin::CepAutoComplete::Page
+end
+```
+
+**2. Add a CEP Input**
+```ruby
+f.input :cep, as: :cep
+f.input :street
+f.input :state
+f.input :city
+f.input :neighborhood
+```
+
+*p.s. if you have a different input name, you'll have to change your [URL option](https://github.com/dhyegofernando/active_admin-cep_auto_complete#options).*
+
+**3. It works!!**
+
+## Options
+
+**Input options**
+
+Option        | Type         | Default                                            | Description
+---           | ---          | ---                                                | ---
+`url`         | *string*     | Singular name of the input. e.g. `/cep`            | The route URL that CEP will be fetched from.
+`fields`      | *array*      | `[:street, :state, :city, :neighborhood]`          | The inputs names which will be auto completed.
+
+## Custom fields
+
+If you want to add any custom field to be autocompleted, just do the follow:
+
+**1. Add to the CEP input options**
+```ruby
+f.input :cep, as: :cep, fields: [:state_id]
+f.input :state_id
+```
+
+**2. Add the render method to the controller**
+```ruby
+ActiveAdmin.register_page 'CEP' do
+  setup_cep_auto_complete do
+    # New field
+    field :state_id do |cep|
+      state = State.where("title LIKE '%?%'", cep.state).take
+      
+      if state.any?
+        state.id
+      end
+    end
+    
+    # Another new field that uses a result from other one
+    field :some_other_field do |cep|
+      "State number #{cep.state_id}"
+    end
+    
+    # Override an original field
+    field :street do |cep|
+      "Street #{cep.street}"
+    end
+  end
+end
+```
+
+**3. Now, the javascript will auto trigger the field with something like this:**
+```javascript
+$('#address_state_id').val(cep.state_id);
+```
+
+*p.s. it just a pseudo-code*
+
+**If you want support a different plugin (like [select2](https://github.com/select2/select2)) or any other javascript render method, you can do:**
+
+```javascript
+$('#address_state_id').on('active_admin:cep_auto_complete', function(e, value, cep, input) {
+  $(this).val(cep.state_id);
+  $(this).trigger('change');
+});
+```
+
+## Maintainer
+[Dhyego Fernando](https://github.com/dhyegofernando)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['./test/**/*_test.rb']
+end
+
+task default: :test

data/active_admin-cep_auto_complete.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+require './lib/active_admin/cep_auto_complete/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'active_admin-cep_auto_complete'
+  spec.version     = ActiveAdmin::CepAutoComplete::Version::STRING
+  spec.authors     = ['Dhyego Fernando']
+  spec.email       = ['dhyegofernando@gmail.com']
+
+  spec.summary     = 'Auto complete your addresses fields with Brazilian CEP (zip code).'
+  spec.description = spec.summary
+  spec.homepage    = 'http://github.com/dhyegofernando/active_admin-cep_auto_complete'
+  spec.license     = 'MIT'
+
+  spec.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.add_dependency 'railties'
+  spec.add_dependency 'activeadmin', '>= 1.0.0.pre1'
+  spec.add_dependency 'postmon_ruby'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-utils'
+  spec.add_development_dependency 'pry-meta'
+end

data/app/assets/javascripts/active_admin/cep_auto_complete.js

@@ -0,0 +1,94 @@
+//= require active_admin/utils
+
+(function(scope, $) {
+  'use strict';
+
+  function CepInput(input) {
+    this.input = input;
+    this.form = input.closest('form');
+    this.scope = this.input.data('scope');
+    this.url = this.input.data('url');
+    this.fields = this.input.data('fields').reduce(function(fields, field) {
+      fields[field] = this.findField(field);
+      return fields;
+    }.bind(this), {});
+    this.cepRegex = new RegExp(this.input.data('cepRegex'));
+    this.onChange = scope.Utils.debounce(this.onChange.bind(this), 300);
+    this.lastQuery = null;
+    this.attachEvents();
+  }
+
+  CepInput.attach = function(selector) {
+    $(selector).each(function() {
+      var self = $(this);
+      self.data('cepInput', new CepInput(self));
+    });
+  };
+
+  CepInput.prototype = {
+    attachEvents: function() {
+      this.input.on('keypress', this.onChange);
+    },
+
+    findField: function(field) {
+      return $('#' + this.scope + '_' + field);
+    },
+
+    onChange: function(e) {
+      if (this.isValid(e.delegateTarget.value)) {
+        this.query(e.delegateTarget.value);
+      }
+    },
+
+    isValid: function(value) {
+      return !!value.match(this.cepRegex);
+    },
+
+    query: function(value) {
+      if (this.lastQuery !== null) {
+        this.lastQuery.abort();
+      }
+
+      this.lockFields();
+      this.lastQuery = $.get(this.url, { cep: value })
+        .then(function(data) {
+          this.render(data);
+          this.lastQuery = null;
+          this.unlockFields();
+        }.bind(this))
+        .fail(function() {
+          this.lastQuery = null;
+          this.unlockFields();
+        }.bind(this));
+    },
+
+    render: function(data) {
+      $.each(this.fields, function(field, element) {
+        var value = data[field];
+        element.val(value);
+        element.trigger('change');
+        element.trigger('active_admin:cep_auto_complete', [value, data, this]);
+      }.bind(this));
+    },
+
+    lockFields: function() {
+      this.toggleFields(true);
+    },
+
+    unlockFields: function() {
+      this.toggleFields(false);
+    },
+
+    toggleFields: function(disabled) {
+      $.each(this.fields, function(field, element) {
+        element.prop('disabled', disabled);
+      });
+    }
+  };
+
+  $(document).ready(function() {
+    CepInput.attach('.cep-auto-complete');
+  });
+
+  scope.CepInput = CepInput;
+}(window.ActiveAdmin, jQuery));

data/app/assets/javascripts/active_admin/utils.js

@@ -0,0 +1,19 @@
+(function(scope) {
+  'use strict';
+
+  scope.Utils = scope.Utils || {};
+  scope.Utils.debounce = function debounce(func, wait, immediate) {
+    var timeout;
+    return function() {
+      var context = this, args = arguments;
+      var later = function() {
+        timeout = null;
+        if (!immediate) func.apply(context, args);
+      };
+      var callNow = immediate && !timeout;
+      clearTimeout(timeout);
+      timeout = setTimeout(later, wait);
+      if (callNow) func.apply(context, args);
+    };
+  };
+}(window.ActiveAdmin));

data/lib/active_admin/cep_auto_complete.rb

@@ -0,0 +1,21 @@
+require 'active_support/core_ext'
+require 'active_admin'
+
+module ActiveAdmin
+  module CepAutoComplete
+    DEFAULT_FIELDS = [:state, :city, :neighborhood, :street].freeze
+    CEP_REGEX_BODY = '[0-9]{2}(\.)?[0-9]{3}(\-)?[0-9]{3}'.freeze
+
+    autoload :Version,  'active_admin/cep_auto_complete/version'
+    autoload :Page,     'active_admin/cep_auto_complete/page'
+    autoload :DSL,      'active_admin/cep_auto_complete/dsl'
+    autoload :Query,    'active_admin/cep_auto_complete/query'
+    autoload :Renderer, 'active_admin/cep_auto_complete/renderer'
+  end
+end
+
+require 'active_admin/cep_auto_complete/engine'
+require 'formtastic/inputs/cep_input'
+
+ActiveAdmin::Page.send(:include, ActiveAdmin::CepAutoComplete::Page)
+ActiveAdmin::DSL.send(:include, ActiveAdmin::CepAutoComplete::DSL)

data/lib/active_admin/cep_auto_complete/dsl.rb

@@ -0,0 +1,39 @@
+module ActiveAdmin
+  module CepAutoComplete
+    module DSL
+      def setup_cep_auto_complete(&block)
+        renderer = config.cep_renderer
+        renderer.instance_eval(&block) if block_given?
+
+        controller do
+          require 'postmon_ruby'
+
+          # TODO: Find another to pass down the renderer variable
+          @@renderer = renderer
+
+          def index
+            if is_cep_valid?
+              query = Query.search(parsed_cep)
+
+              if query
+                render json: @@renderer.render(query)
+              else
+                render nothing: true, status: 404
+              end
+            else
+              render nothing: true, status: 404
+            end
+          end
+
+          def is_cep_valid?
+            parsed_cep =~ /\A#{CEP_REGEX_BODY}\z/
+          end
+
+          def parsed_cep
+            @parsed_cep ||= params[:cep].to_s.gsub(/[^\d]/, '')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_admin/cep_auto_complete/engine.rb

@@ -0,0 +1,6 @@
+module ActiveAdmin
+  module CepAutoComplete
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/active_admin/cep_auto_complete/page.rb

@@ -0,0 +1,9 @@
+module ActiveAdmin
+  module CepAutoComplete
+    module Page
+      def cep_renderer
+        @cep_renderer ||= Renderer.new(self)
+      end
+    end
+  end
+end

data/lib/active_admin/cep_auto_complete/query.rb

@@ -0,0 +1,19 @@
+module ActiveAdmin
+  module CepAutoComplete
+    class Query
+      def self.search(cep)
+        address = PostmonRuby::Client.search(:cep, cep)
+
+        unless address.not_found
+          {
+            cep: cep,
+            state: address.estado,
+            city: address.cidade,
+            neighborhood: address.bairro,
+            street: address.logradouro
+          }
+        end
+      end
+    end
+  end
+end

data/lib/active_admin/cep_auto_complete/renderer.rb

@@ -0,0 +1,45 @@
+module ActiveAdmin
+  module CepAutoComplete
+    class Renderer
+      def initialize(page)
+        @page = page
+        @renderers = DEFAULT_FIELDS.map { |field| [field, default_renderer_for(field)] }.to_h.with_indifferent_access
+      end
+
+      def field(field_name, &block)
+        @renderers[field_name] =
+          if block_given?
+            block
+          else
+            default_renderer_for(field_name)
+          end
+      end
+
+      def render(query)
+        object = build_object(query)
+
+        @renderers.keys.map do |field|
+          value = @renderers[field].call(object)
+          object.public_send("#{field}=", value)
+          [field, value]
+        end.to_h
+      end
+
+      protected
+
+      def default_renderer_for(field)
+        lambda { |cep| cep.public_send(field) }
+      end
+
+      private
+
+      def build_object(query)
+        klass.new(*query.values)
+      end
+
+      def klass
+        Struct.new(:cep, *@renderers.keys)
+      end
+    end
+  end
+end

data/lib/active_admin/cep_auto_complete/version.rb

@@ -0,0 +1,10 @@
+module ActiveAdmin
+  module CepAutoComplete
+    module Version
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 0
+      STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+    end
+  end
+end

data/lib/formtastic/inputs/cep_input.rb

@@ -0,0 +1,60 @@
+module Formtastic
+  module Inputs
+    class CepInput < StringInput
+      def input_html_options
+        opts = super
+        data = (opts[:data] || {}).merge(fields: load_fields(input_options[:fields]),
+                                         url: load_url(input_options[:url]),
+                                         scope: load_scope(opts[:id]),
+                                         cep_regex: cep_regex)
+        opts.merge(class: load_class(opts[:class]), data: data)
+      end
+
+      protected
+
+      def load_class(classes)
+        @classes ||= (classes || '').to_s.split(' ').tap { |classes| classes << 'cep-auto-complete' }.join(' ')
+      end
+
+      def load_fields(fields)
+        @fields ||= begin
+          raise "Expected Array got #{fields.class}" if !fields.blank? && !fields.is_a?(Array)
+          (fields || ActiveAdmin::CepAutoComplete::DEFAULT_FIELDS).to_json
+        end
+      end
+
+      def load_url(url)
+        @url ||= begin
+          if url.nil?
+            url = ['/']
+
+            if ActiveAdmin.application.default_namespace.present?
+              url << "#{ActiveAdmin.application.default_namespace}/"
+            end
+
+            url << urlize_method
+            url.join('')
+          else
+            url
+          end
+        end
+      end
+
+      def load_scope(id)
+        id.chomp('_' + method.to_s)
+      end
+
+      def cep_regex
+        "^#{ActiveAdmin::CepAutoComplete::CEP_REGEX_BODY}$"
+      end
+
+      def association_name
+        method.to_s.singularize.chomp('_id')
+      end
+
+      def urlize_method
+        association_name.underscore
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: active_admin-cep_auto_complete
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dhyego Fernando
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre1
+- !ruby/object:Gem::Dependency
+  name: postmon_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-meta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Auto complete your addresses fields with Brazilian CEP (zip code).
+email:
+- dhyegofernando@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- active_admin-cep_auto_complete.gemspec
+- app/assets/javascripts/active_admin/cep_auto_complete.js
+- app/assets/javascripts/active_admin/utils.js
+- lib/active_admin/cep_auto_complete.rb
+- lib/active_admin/cep_auto_complete/dsl.rb
+- lib/active_admin/cep_auto_complete/engine.rb
+- lib/active_admin/cep_auto_complete/page.rb
+- lib/active_admin/cep_auto_complete/query.rb
+- lib/active_admin/cep_auto_complete/renderer.rb
+- lib/active_admin/cep_auto_complete/version.rb
+- lib/formtastic/inputs/cep_input.rb
+homepage: http://github.com/dhyegofernando/active_admin-cep_auto_complete
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Auto complete your addresses fields with Brazilian CEP (zip code).
+test_files: []