vat-siren-siret 0.1.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84a274a6614d2d7ade87cbc8f82a9de6402598bf
-  data.tar.gz: 4727797c0a4db7ad5c5ea3594b5101a61ec56887
+  metadata.gz: af2cb7ca61545eed52b9ee5ed9845025e4b8087b
+  data.tar.gz: fa74bbba8cc0d95afd52915aadb28cef877f5ae9
 SHA512:
-  metadata.gz: 7e9fc36f1ba3224d9ccb9e4deacbe17a4a40b8b6ea0caffb92f07c301090826503caf1e904740babeb196f7ad389a9e566d7a759c349591921ee610e0e79b332
-  data.tar.gz: 3fcad2c9423f46a44d176ec9581189ec0b96bb623687a8d8880fcdaff53b5ce6d33aba73d41c744acdb7d160b36784b5ce124411d12e078706bdf7663e875939
+  metadata.gz: 265ebb38a93247fe4f8758f81c8b8202b62f0de745ed18b9e2aef4ab95bfbf25f9a1566dda3f5688ff5c4cf5da3735f21d275274fa59489e11478029c688ed78
+  data.tar.gz: a4983a086efdf75c22d72f0ddd743da645336d6e4cfd5202c12640a6f678b70bfdd4512d4b725d63eba97ef12aff8b4b9ca1784ea74fb6e5934732b0c2b26f35

data/.travis.yml

@@ -1,7 +1,6 @@
 sudo: false
 language: ruby
 rvm:
-  - 1.9
   - 2.0
   - 2.1
   - 2.2

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.1] - 2020-03-28
+
+**breaking changes :**
+- drop support for ruby 1.9 (incompatible with rake 12.3.3)
+- to_siren/to_vat returns `nil` (instead of `false`) when input string is neither a VAT / SIREN / SIRET
+- format_siren/format_siret/format_vat returns `nil` (instead of raising an error) when input string is neither a VAT / SIREN / SIRET
+
+### Added
+- gem can be required with "require 'vat-siren-siret'"
+- This CHANGELOG file to hopefully serve as an evolving example of a
+  standardized open source project CHANGELOG.
+
+### Changed
+- update rake (to fix CVE-2020-8130)
+- to_siren/to_vat returns `nil` (instead of `false`) when input string is neither a VAT / SIREN / SIRET
+- format_siren/format_siret/format_vat returns `nil` (instead of raising an error) when input string is neither a VAT / SIREN / SIRET
+
+### Removed
+- support for ruby 1.9
+
+## [0.1.1] - 2018-02-11
+### Changed
+- rubygems description
+
+## [0.1.0] - 2018-02-08
+### Added
+- API : Vss namespace with all methods
+  (siren?, siret?, vat?, to_siren, to_vat,
+  generate_siren, generate_siret, generate_vat,
+  format_siren, format_siret, format_vat)
+- unit tests
+
+[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.1...v1.0.1
+
+[0.1.1]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.1.0

data/README.md

@@ -68,14 +68,12 @@ Evaluate if the `value` is a french VAT and return a `boolean`.
 ### Vss.to_vat(value)
 
 Generate the french VAT from a SIREN or a SIRET and return a `string`
-Return `false` when value is neither a SIREN, SIRET or VAT.
-Return `value` if it already is a VAT.
+Return `nil` when value is neither a SIREN, SIRET or VAT.
 
 ### Vss.to_siren(value)
 
 Generate the SIREN from a VAT or a SIRET and return a `string`
-Return `false` when value is neither a SIREN, SIRET or VAT.
-Return `value` if it already is a SIREN.
+Return `nil` when value is neither a SIREN, SIRET or VAT.
 
 ### Vss.generate_siren
 

data/lib/vat-siren-siret.rb

@@ -0,0 +1 @@
+require 'vss'

data/lib/vss.rb

@@ -1,7 +1,7 @@
 # French VAT / SIRET / SIREN numbers validation and generation as described here:
 # https://fr.wikipedia.org/wiki/Syst%C3%A8me_d%27identification_du_r%C3%A9pertoire_des_%C3%A9tablissements#Calcul_et_validit.C3.A9_d.27un_num.C3.A9ro_SIRET
 module Vss
-  VERSION = '0.1.1'.freeze
+  VERSION = '1.0.1'.freeze
 
   REGEXPS = {
     SIREN: /^\d{9}$/,
@@ -32,14 +32,17 @@ module Vss
     return string if siren?(string)
     return string[0..8] if siret?(string)
     return string[4..-1] if vat?(string)
-    false
+
+    nil
   end
 
   # Convert a SIREN / SIRET / VAT to a VAT
   def self.to_vat(string)
     return string if vat?(string)
+
     siren = siret?(string) ? to_siren(string) : string
-    return false unless siren?(siren)
+    return unless siren?(siren)
+
     key = vat_key(siren)
     "FR#{format('%02d', key)}#{siren}"
   end
@@ -57,17 +60,20 @@ module Vss
   end
 
   def self.format_siren(siren)
-    raise 'Not a valid SIREN' unless siren?(siren)
+    return unless siren?(siren)
+
     siren.gsub(REGEXPS[:formatSIREN], '\1 ')
   end
 
   def self.format_siret(siret)
-    raise 'Not a valid SIRET' unless siret?(siret)
+    return unless siret?(siret)
+
     siret.gsub(REGEXPS[:formatSIRET], '\1 \2 \3 \4')
   end
 
   def self.format_vat(vat)
-    raise 'Not a valid VAT number' unless vat?(vat)
+    return unless vat?(vat)
+
     vat.gsub(REGEXPS[:formatVAT], '\1 \2 \3 \4 \5')
   end
 
@@ -75,6 +81,7 @@ module Vss
 
   def self.match?(re, str) # :nodoc:
     return re.match?(str) if re.respond_to?(:match?) # ruby >= 2.4
+
     !(re =~ str).nil?
   end
 

data/vat-siren-siret.gemspec

@@ -6,22 +6,35 @@ Gem::Specification.new do |spec|
   spec.name          = 'vat-siren-siret'
   spec.version       = Vss::VERSION
   spec.authors       = ['MathieuDerelle']
-  spec.email         = ['mathieu@purchease.com']
+  spec.email         = ['mathieu.derelle@gmail.com']
 
-  spec.summary       = 'Library to check or generate french VAT / SIRET / SIREN'
-  spec.description   = 'Library to check or generate french VAT / SIRET / SIREN'
+  spec.summary       = 'Library to check or generate french VAT / SIREN / SIRET'
+  spec.description   = 'Library to check or generate french VAT / SIREN / SIRET'
   spec.homepage      = 'https://github.com/MathieuDerelle/vat-siren-siret'
   spec.license       = 'MIT'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = 'bin'
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.extra_rdoc_files = ['README.md']
+
+  spec.metadata = {
+    'documentation_uri' => 'http://www.rubydoc.info/gems/vat-siren-siret/',
+    'source_code_uri'   => 'https://github.com/MathieuDerelle/vat-siren-siret',
+    # 'wiki_uri'          => 'https://github.com/MathieuDerelle/vat-siren-siret/wiki',
+    # 'changelog_uri'     => 'https://github.com/MathieuDerelle/vat-siren-siret/CHANGELOG.md',
+    'ci_uri'            => 'https://travis-ci.org/MathieuDerelle/vat-siren-siret',
+    'coverage_uri'      => 'https://coveralls.io/github/MathieuDerelle/vat-siren-siret',
+  }
+
+  spec.required_ruby_version = '>= 2.0'
+
   spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'coveralls'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vat-siren-siret
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.1
 platform: ruby
 authors:
 - MathieuDerelle
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-02-11 00:00:00.000000000 Z
+date: 2020-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,30 +80,37 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Library to check or generate french VAT / SIRET / SIREN
+description: Library to check or generate french VAT / SIREN / SIRET
 email:
-- mathieu@purchease.com
+- mathieu.derelle@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- lib/vat-siren-siret.rb
 - lib/vat/siren/siret.rb
 - lib/vss.rb
 - vat-siren-siret.gemspec
 homepage: https://github.com/MathieuDerelle/vat-siren-siret
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: http://www.rubydoc.info/gems/vat-siren-siret/
+  source_code_uri: https://github.com/MathieuDerelle/vat-siren-siret
+  ci_uri: https://travis-ci.org/MathieuDerelle/vat-siren-siret
+  coverage_uri: https://coveralls.io/github/MathieuDerelle/vat-siren-siret
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -112,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -120,8 +127,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Library to check or generate french VAT / SIRET / SIREN
+summary: Library to check or generate french VAT / SIREN / SIRET
 test_files: []