br_documents 0.0.15 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85b3dba0a5cb19581015f983a1ec5f186521756d
-  data.tar.gz: f4166ebcf7711bc8849438bd317649ce0c02a5a4
+  metadata.gz: ac405ceecbb3815bf47f64f9e72a5c879668e810
+  data.tar.gz: dba3e8eed8d0799421ba07870157cdf39dabfe74
 SHA512:
-  metadata.gz: 74be958176462d91c7eeb8779b0976191dd34fdf361b086717806d1462ffcb9d89b08c63fc2efb20513986e70ac8056e9876531d16c391793dabcc340b2109d2
-  data.tar.gz: 69fc04d5fa9cc32d5b52544b094281fa923cec602c11a92f7ea58752e9d4f0400e2b08a2141104e8b356e49e3d2d0b969b05b117337a917d4e1e46ce787aff0f
+  metadata.gz: 1c31e91f3559a125a625df02fb4b2f7ae81bd404c5fb565c5d50dc588efc30aaefb08a9756fd424ebb79f691b3a397f75705a7b60b51d483fc0a49cf12961770
+  data.tar.gz: 16504c4a406c49fc0eced2158fd5e9c6a43084428eeab94e3cc93ecfb8e9099fbc1f3773dc34d91c286c9da4a62345ac1389f7c236840d86e945eb8ef3bfeb07

data/.circleci/config.yml

@@ -0,0 +1,42 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.5.1
+    steps:
+      - checkout
+      - restore_cache:
+          key: br-documents-cache-v1-{{ checksum "Gemfile.lock" }}
+      - run: bundle check || bundle install
+      - save_cache:
+          key: br-documents-cache-v1-{{ .Environment.CIRCLE_SHA1 }}
+          paths:
+            - .
+      - save_cache:
+          key: br-documents-cache-v1-{{ checksum "Gemfile.lock" }}
+          paths:
+            - ./vendor/bundle
+  rspec:
+    docker:
+      - image: circleci/ruby:2.5.1
+    steps:
+      - restore_cache:
+          key: br-documents-cache-v1-{{ .Environment.CIRCLE_SHA1 }}
+      - restore_cache:
+          key: br-documents-cache-v1-{{ checksum "Gemfile.lock" }}
+      - run:
+          name: Install Test Coverage for CodeClimate
+          command: |
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+            chmod +x ./cc-test-reporter
+      - run: ./cc-test-reporter before-build
+      - run: bundle exec rspec
+      - run: ./cc-test-reporter after-build --exit-code $?
+workflows:
+  version: 2
+  main:
+    jobs:
+      - build
+      - rspec:
+          requires:
+            - build

data/.gitignore

@@ -4,7 +4,7 @@
 .config
 .yardoc
 .idea/
-Gemfile.lock
+.byebug_history
 InstalledFiles
 _yardoc
 coverage

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    br_documents (0.1.0)
+      activemodel (>= 4.0.0)
+      i18n (>= 0.6.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    byebug (10.0.2)
+    codeclimate-test-reporter (1.0.7)
+      simplecov
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    json (2.0.3)
+    minitest (5.11.3)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    simplecov (0.14.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  br_documents!
+  bundler (>= 1.3)
+  byebug (= 10.0.2)
+  codeclimate-test-reporter
+  rake (>= 10.1.0)
+  rspec (>= 3.0.0)
+  simplecov (>= 0.9.0)
+
+BUNDLED WITH
+   1.16.4

data/README.md

@@ -147,9 +147,33 @@ ie.formatted # => "254.062.407"
 ie.valid?    # => true
 ```
 
+## Environment variables
+
+The following variables are necessary to be set:
+
+Environment var                | Development? | Test? | CI  | Production? | Data
+-------------------------------|--------------|-------|-----|-------------|-----
+TZ                             | no           | no    | yes | no          | America/Sao_Paulo
+BUNDLE_PATH                    | no           | no    | yes | no          | ./vendor/bundle
+CC_TEST_REPORTER_ID            | no           | no    | yes | no          | get at codeclimate
+RAILS_ENV                      | no           | no    | yes | no          | test
+
+## Deploy to Rubygems
+
+    $ bundle exec rake release  # Create tag vX.X.X, build and push br_documents-X.X.X.gem to Rubygems
+
+You can build or install using one of the above tasks
+
+    $ bundle exec rake build    # Build br_documents-X.X.X.gem into the pkg directory
+    $ bundle exec rake install  # Build and install br_documents-X.X.X.gem into system gems
+
+#### Login
+    $ gem signin
+    $ gem signout
+
 ## How to add contributors
 
-		gem owner --add leandrolourenci@gmail.com br_documents
+    gem owner --add leandrolourenci@gmail.com br_documents
 
 ## Contributing
 

data/br_documents.gemspec

@@ -26,5 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", ">= 3.0.0"
   spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "simplecov", ">= 0.9.0"
-  spec.add_development_dependency "byebug", "4.0.1" if RUBY_VERSION >= "2.0"
+  spec.add_development_dependency "byebug", "10.0.2" if RUBY_VERSION >= "2.0"
 end

data/lib/br_documents/gtin/gtin.rb

@@ -0,0 +1,28 @@
+module BrDocuments
+  class Gtin
+    def initialize(code)
+      @code = code
+    end
+
+    def valid?
+      valid_length? && valid_checksum?
+    end
+
+    private
+
+    def valid_length?
+      [8, 12, 13, 14].include?(@code.length)
+    end
+
+    def valid_checksum?
+      numbers = @code.chars[0, @code.length - 1].reverse
+      odd = even = 0
+
+      numbers.each_with_index do |number, i|
+        (i + 1).even? ? (even += number.to_i) : (odd += number.to_i * 3)
+      end
+
+      @code.chars.last.to_i == (10 - (odd + even) % 10)
+    end
+  end
+end

data/lib/br_documents/gtin_validator.rb

@@ -0,0 +1,8 @@
+class GtinValidator  < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    if value.present?
+      gtin = BrDocuments::Gtin.new(value)
+      record.errors.add(attribute, :invalid) if not gtin.valid?
+    end
+  end
+end

data/lib/br_documents/version.rb

@@ -1,3 +1,3 @@
 module BrDocuments
-  VERSION = "0.0.15"
+  VERSION = "0.1.0"
 end

data/spec/gtin/gtin_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe BrDocuments::Gtin do
+  describe "#valid?" do
+    context 'when the checksum is valid' do
+      context 'when the GTIN has 8 digits' do
+        subject { described_class.new('12345618') }
+
+        it { is_expected.to be_valid }
+      end
+
+      context 'when the GTIN has 12 digits' do
+        subject { described_class.new('114567854874') }
+
+        it { is_expected.to be_valid }
+      end
+
+      context 'when the GTIN has 13 digits' do
+        subject { described_class.new('1145678548719') }
+
+        it { is_expected.to be_valid }
+      end
+
+      context 'when the GTIN has 14 digits' do
+        subject { described_class.new('1234567891125') }
+
+        it { is_expected.to be_valid }
+      end
+
+      context 'when the number of digits is different of 8, 13 or 14' do
+        subject { described_class.new('12345678901234560') }
+
+        it { is_expected.to_not be_valid }
+      end
+    end
+
+    context 'when the checksum is invald' do
+      subject { described_class.new('1145678548712') }
+
+      it { is_expected.to_not be_valid }
+    end
+  end
+end

data/spec/gtin_validator_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe GtinValidator do
+  let(:record) { double("model") }
+
+  before do
+    allow(record).to receive(:errors).and_return([])
+    allow(record.errors).to receive(:messages).and_return({})
+    allow(record.errors).to receive(:add) do | attribute, error |
+      record.errors.messages[attribute] = [error]
+    end
+  end
+
+  subject { GtinValidator.new(attributes: "gtin") }
+
+  context "when GTIN code is valid" do
+    before { subject.validate_each(record, "gtin", "1243658721548") }
+
+    it "doesn't add errors in model" do
+      expect(record.errors.messages).to be_empty
+    end
+  end
+
+  context "when GTIN is blank" do
+    before { subject.validate_each(record, "gtin", "") }
+
+    it "doesn't add errors in model" do
+      expect(record.errors.messages).to be_empty
+    end
+  end
+
+  context "when GTIN is nil" do
+    before { subject.validate_each(record, "gtin", nil) }
+
+    it "doesn't add errors in model" do
+      expect(record.errors.messages).to be_empty
+    end
+  end
+
+  context "when GTIN is invalid" do
+    before { subject.validate_each(record, "gtin", "253667853") }
+
+    it "adds errors in model" do
+      expect(record.errors.messages).to include 'gtin' => [:invalid]
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: br_documents
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.1.0
 platform: ruby
 authors:
 - ASSEINFO - Sistemas de Informação
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-15 00:00:00.000000000 Z
+date: 2019-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 10.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 10.0.2
 description: Validates brazilian documents like CPF, CNPJ and IE.
 email:
 - asseinfo@asseinfo.com.br
@@ -129,14 +129,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - br_documents.gemspec
-- circle.yml
 - config/locales/pt-BR.yml
 - lib/br_documents.rb
 - lib/br_documents/cnpj_cpf/cnpj.rb
@@ -145,6 +145,8 @@ files:
 - lib/br_documents/cnpj_validator.rb
 - lib/br_documents/commons/mod11.rb
 - lib/br_documents/cpf_validator.rb
+- lib/br_documents/gtin/gtin.rb
+- lib/br_documents/gtin_validator.rb
 - lib/br_documents/ie/ac.rb
 - lib/br_documents/ie/al.rb
 - lib/br_documents/ie/am.rb
@@ -182,6 +184,8 @@ files:
 - spec/cnpj_cpf/cpf_spec.rb
 - spec/cnpj_validator_spec.rb
 - spec/cpf_validator_spec.rb
+- spec/gtin/gtin_spec.rb
+- spec/gtin_validator_spec.rb
 - spec/ie/ac_spec.rb
 - spec/ie/al_spec.rb
 - spec/ie/am_spec.rb
@@ -235,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Validates brazilian documents like CPF, CNPJ and IE. It can be used with
@@ -245,6 +249,8 @@ test_files:
 - spec/cnpj_cpf/cpf_spec.rb
 - spec/cnpj_validator_spec.rb
 - spec/cpf_validator_spec.rb
+- spec/gtin/gtin_spec.rb
+- spec/gtin_validator_spec.rb
 - spec/ie/ac_spec.rb
 - spec/ie/al_spec.rb
 - spec/ie/am_spec.rb

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.2
-  - 2.2.5
-gemfile:
-  - Gemfile

data/circle.yml

@@ -1,3 +0,0 @@
-machine:
-  ruby:
-    version: 2.2.5