itax_code 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f79a865df5d202807046608d8b774ae21b05426d6418815884ff808cae75d79f
+  data.tar.gz: fee682091af5907dce1ef0ac32ddc16fb44cba9956e1c04534ba1505750e2c5f
+SHA512:
+  metadata.gz: 1f4552edfa936dd8224abccd20861236bcc51311d84342e4e9b0516f7b73b0fc7496a957cd5957ead747f6f44885ada49ea38fbfbf96d8444f252472e1eecc73
+  data.tar.gz: 27ae449fc19eef5d2f30e0ca7e581837683ec2353e8003798f40ba23a05b0efa9a6f0d498c1f6927d7e7b0042a85e8940a3f09bfbb6ef8359d011bfc0ea20f97

data/.gitignore

@@ -0,0 +1,12 @@
+*.rbc
+*.swp
+/_yardoc/
+/.bundle/
+/.byebug_history
+/.yardoc
+/coverage/
+/doc/
+/itax_code-*.gem
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,30 @@
+---
+require:
+  - rubocop-minitest
+  - rubocop-performance
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: indented_internal_methods
+
+Layout/LineLength:
+  Enabled: true
+  Max: 80
+
+Metrics/MethodLength:
+  Enabled: true
+  CountAsOne: ['array', 'hash']
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+...

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 0.1.1
+
+- Add credits to README.md
+
+---
+
+# 0.1.0
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mttrss5@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    itax_code (0.1.2)
+      activesupport
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.7)
+    docile (1.3.2)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    mocha (1.11.2)
+    parallel (1.20.0)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rubocop (1.3.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.1.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    rubocop-minitest (0.10.1)
+      rubocop (>= 0.87)
+    rubocop-performance (1.9.0)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.10.1)
+    simplecov (0.19.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  itax_code!
+  minitest
+  mocha
+  rubocop
+  rubocop-minitest
+  rubocop-performance
+  simplecov
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,84 @@
+# ItaxCode
+
+`ItaxCode` is a Ruby Gem to encode and decode Italian tax code (Codice Fiscale).
+
+It handles common operations on Italian tax code like, for instance, encoding, decoding and validation.
+It also handles [omocodia](https://it.wikipedia.org/wiki/Omocodia) complexity.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "itax_code"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install itax_code
+
+## Usage
+
+### Encode
+
+```ruby
+ItaxCode.generate(
+  surname: "Rossi",
+  name: "Mario",
+  gender: "M",           # can be M or F
+  birthdate: "1980-1-1", # can be String, Time, Date or DateTime
+  birthplace: "Milano"
+)
+```
+
+### Decode
+
+```ruby
+ItaxCode.decode("RSSMRA80A01F205X")
+```
+
+### Validate
+
+```ruby
+ItaxCode.valid?(
+  "RSSMRA80A01F205X",
+  {
+    surname: "Rossi",
+    name: "Mario",
+    gender: "M",
+    birthdate: "1980-1-1",
+    birthplace: "Milano"
+  }
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake test` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and tags,
+and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/matteoredz/itax_code.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected
+to adhere to the [code of conduct](https://github.com/matteoredz/itax_code/blob/master/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the ItaxCode project's codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/matteoredz/itax_code/blob/master/CODE_OF_CONDUCT.md).
+
+## Credits
+
+I took my cue from [python-codicefiscale](https://github.com/fabiocaccamo/python-codicefiscale) repo,
+coded by [Fabio Caccamo](https://github.com/fabiocaccamo) to write ItaxCode Gem.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "itax_code"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/itax_code.gemspec

@@ -0,0 +1,36 @@
+require_relative "lib/itax_code/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "itax_code"
+  spec.version = ItaxCode::VERSION
+  spec.licenses = ["MIT"]
+  spec.authors = ["Matteo Rossi"]
+  spec.email = ["mttrss5@gmail.com"]
+  spec.summary = "Encode and decode Italian tax code (Codice Fiscale)."
+  spec.homepage = "https://github.com/matteoredz/itax-code"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/matteoredz/itax-code"
+  spec.metadata["changelog_uri"] = "https://github.com/matteoredz/itax-code/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "rake"
+
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-minitest"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "simplecov"
+end

data/lib/itax_code.rb

@@ -0,0 +1,68 @@
+require "itax_code/version"
+require "active_support/all"
+require "itax_code/utils"
+require "itax_code/encoder"
+require "itax_code/parser"
+require "itax_code/validator"
+
+module ItaxCode
+  class << self
+    ##
+    # This method encodes citizen tax code
+    #
+    # @example
+    #
+    #   ItaxCode.generate({
+    #     surname:    [String]
+    #     name:       [String]
+    #     gender:     [String]
+    #     birthdate:  [Date, DateTime, Time]
+    #     birthplace: [String]
+    #   })
+    #
+    # @param [Hash] data The citizen data attributes
+    #
+    # @return [String]
+
+    def encode(data)
+      Encoder.new(data).encode
+    end
+
+    ##
+    # This method decodes tax code in its components
+    #
+    # @example
+    #
+    #   ItaxCode.decode("CCCFBA85D03L219P")
+    #
+    # @param [String] tax_code The citizen tax code
+    #
+    # @return [Hash]
+
+    def decode(tax_code)
+      Parser.new(tax_code).decode
+    end
+
+    ##
+    # This method check given tax code validity
+    # against new one generated by citizen informations
+    #
+    # @example
+    #
+    #  ItaxCode.valid?(tax_code [String], {
+    #     surname:    [String]
+    #     name:       [String]
+    #     gender:     [String]
+    #     birthdate:  [Date, DateTime, Time]
+    #     birthplace: [String]
+    #  })
+    #
+    # @return [true, false]
+
+    def valid?(tax_code, data)
+      Validator.new(data).valid?(tax_code)
+    end
+  end
+
+  class Error < StandardError; end
+end