nif 0.0.2

data/LICENSE

@@ -0,0 +1,13 @@
+(The MIT License)
+
+Copyright © 2011 Pedro Carrico
+
+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.
+
+website: http://pedrocarrico.net
+blog:    http://blog.pedrocarrico.net
+twitter: @pedro_carrico

data/README.md

@@ -0,0 +1,41 @@
+# Nif - Portuguese NIF generator and validator
+
+[![Build Status](https://secure.travis-ci.org/pedrocarrico/nif.png)](http://travis-ci.org/pedrocarrico/nif)
+
+### Instalation
+Just:
+	# gem install nif
+
+### How does it work?
+	irb> require 'nif'
+	=> true
+	# generate a nif
+	irb> Nif::Generator.generate
+	=> "943935784"
+	# generate an unique nif (it will not be generated anymore during this session)
+	irb> Nif::Generator.generate_unique
+	=> "812627318"
+	# validate a nif
+	irb> Nif::Validator.validate '812627318'
+	=> true
+
+### Description
+
+This is a simple project used to learn and teach the basics of ruby syntax, unit testing and code coverage.
+It covers the generation and validation of the Portuguese Fiscal Code (or NIF).
+If you want to contribute be sure to make a test covering your changes.
+
+Have fun!
+
+### Testing
+	# test unit
+	rake test
+	# rspec
+	rake spec
+	# cucumber features
+	rake cucumber
+	# check coverage
+	rake rcov # open coverage/index.html for the results
+
+### TODO
+Make a CustomValidator for rails.

data/features/nif.feature

@@ -0,0 +1,19 @@
+Feature: NifGenerator
+  In order to start validating nifs
+  As a user of the NifGenerator
+  I want a NifGenerator to start validating
+
+  Scenario: NifGenerator validates a valid nif
+    Given a NifGenerator
+    When I validate a nif like "502874210"
+    Then I should see "true"
+
+  Scenario: NifGenerator validates an invalid nif
+    Given a NifGenerator
+    When I validate a nif like "502874211"
+    Then I should see "false"
+
+  Scenario: NifGenerator generates a valid nif
+    Given a NifGenerator
+    When I generate a valid nif
+    Then I should see "true"

data/features/step_definitions/nif_steps.rb

@@ -0,0 +1,23 @@
+require 'lib/nif'
+
+Given /^a NifGenerator$/ do
+  #TODO: get a valid instance?
+end
+
+When /^I validate a valid nif$/ do
+  valid_nif = '502874210'
+  result = Nif::Validator.validate(valid_nif)
+end
+
+When /^I validate a nif like "([^"]*)"$/ do |nif|
+  result = Nif::Validator.validate(nif)
+end
+
+When /^I generate a valid nif$/ do
+  nif = Nif::Generator.generate
+  result = Nif::Validator.validate(nif)
+end
+
+Then /^I should see "([^"]*)"$/ do |result|
+  result.should == "#{result}"
+end

data/lib/nif.rb

@@ -0,0 +1,60 @@
+module Nif
+  class Generator
+    def self.generate
+      generated_nif = (1 + rand(9)).to_s
+
+      (1..7).to_a.each { generated_nif += (rand(10)).to_s }
+
+      generated_nif += NifGenerator.calculate_check_digit(generated_nif).to_s
+    end
+
+    def self.generate_unique
+      if NifGenerator.instance.nifs_generated.nil?
+        NifGenerator.instance.nifs_generated = []
+      end
+
+      generated_nif = generate
+
+      while NifGenerator.instance.nifs_generated.include? generated_nif
+        generated_nif = generate
+      end
+
+      NifGenerator.instance.nifs_generated << generated_nif
+
+      generated_nif
+    end
+  end
+
+  class Validator
+    def self.validate value
+      return false unless NifGenerator.is_integer? value
+      return false if value.length != 9
+      NifGenerator.calculate_check_digit(value)  == value[8,1].to_i
+    end
+  end
+
+  class NifGenerator
+    @@instance = new
+    private_class_method :new
+
+    attr_accessor :nifs_generated
+
+    private
+
+    def self.instance
+      @@instance
+    end
+
+    def self.is_integer? value
+      value =~ /\A(?:0|[1-9]\d*)\z/
+    end
+
+    def self.calculate_check_digit value
+      control_sum  = 9*value[0,1].to_i + 8*value[1,1].to_i + 7*value[2,1].to_i + 6*value[3,1].to_i + 5*value[4,1].to_i + 4*value[5,1].to_i + 3*value[6,1].to_i + 2*value[7,1].to_i
+      control_mod  = control_sum % 11
+      check_number = 11 - control_mod
+      check_number > 9 ? 0 : check_number
+    end
+  end
+
+end

data/lib/nif/version.rb

@@ -0,0 +1,3 @@
+module Nif
+  VERSION = Version = '0.0.2'
+end

data/spec/nif_spec.rb

@@ -0,0 +1,24 @@
+require 'lib/nif'
+
+describe "NifGenerator" do
+  it "should validate a valid nif" do
+    valid_nif = '502874210'
+    result = Nif::Validator.validate(valid_nif)
+
+    result.should == true
+  end
+
+  it "should not validate an invalid nif" do
+    invalid_nif = '502874211'
+    result = Nif::Validator.validate(invalid_nif)
+
+    result.should == false
+  end
+
+  it "should generate a valid nif" do
+    nif = Nif::Generator.generate
+    result = Nif::Validator.validate(nif)
+
+    result.should == true
+  end
+end

data/test/nif_test.rb

@@ -0,0 +1,24 @@
+require 'test/unit'
+require 'lib/nif'
+
+class NifTest < Test::Unit::TestCase
+  def test_should_validate_correct_nif
+    valid_nif = '502874210'
+    assert_equal true, Nif::Validator.validate(valid_nif), "Nif #{valid_nif} should be valid"
+  end
+
+  def test_should_not_validate_incorrect_nif
+    invalid_nif = '2024230'
+    assert_equal false, Nif::Validator.validate(invalid_nif), "Nif #{invalid_nif} should not be valid"
+  end
+
+  def test_should_generate_valid_nif
+    generated_nif = Nif::Generator.generate
+    assert_equal true, Nif::Validator.validate(generated_nif), "Nif #{generated_nif} should be valid"
+  end
+
+  def test_should_generate_valid_unique_nif
+    generated_nif = Nif::Generator.generate_unique
+    assert_equal true, Nif::Validator.validate(generated_nif), "Nif #{generated_nif} should be valid"
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: nif
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- "Pedro Carri\xC3\xA7o"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-22 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: This is a simple project that covers the generation and validation of the Portuguese Fiscal Code (or NIF).
+email: pedro.carrico@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/nif.rb
+- lib/nif/version.rb
+- README.md
+- LICENSE
+- features/nif.feature
+- features/step_definitions/nif_steps.rb
+- spec/nif_spec.rb
+- test/nif_test.rb
+has_rdoc: true
+homepage: http://github.com/pedrocarrico/nif
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Nif - Portuguese NIF generator and validator
+test_files: 
+- features/nif.feature
+- features/step_definitions/nif_steps.rb
+- spec/nif_spec.rb
+- test/nif_test.rb