bankocr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51e9f6ed181fb6340334fb1d1aab02b63fef8ba1
+  data.tar.gz: 63b85e8d8dc37b40d8ff16bfde34cf6457276854
+SHA512:
+  metadata.gz: 52eb966fadec59720b6d2474dbffc5be72a784d4cdc701fbe62c45f1df28bc8f7c7336002f2d710b993d309b77d8b7035e1345e79995995792d5cf0644f147b4
+  data.tar.gz: 29b79b21203e50fce61e8c297efac31ae5c87868b03f45138358539c4578a84f7bd2ddb4d356631be1ffb003acc1819bd0c60381cdac25991a78bbe6e10b8f2d

data/.gitignore

@@ -0,0 +1,2 @@
+*.out
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 2.1.2
+script: bundle exec rspec spec
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'rspec', '~> 3.0.0'

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 3.0.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Javier Cervantes
+
+MIT License
+
+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,32 @@
+# BankOCR Kata
+
+This repository provides a solution for BankOCR kata.
+
+[![Build status](https://travis-ci.org/solojavier/BankOCR.svg)](https://travis-ci.org/solojavier/BankOCR)
+
+## What is it about?
+
+* Description of the problem can be found here: http://code.joejag.com/coding-dojo-bank-ocr/
+* Current implementation covers the first 3 use cases.
+
+## How to run?
+
+Use the following commands:
+
+```
+gem install backocr
+bankocr ./bin/input.in ./bin/output
+```
+
+* It will generate a file under /bin directory with results
+* If you want to modify input edit file /bin/input.in
+
+## Tests
+
+To run test use the following commands:
+
+```
+gem install bundler
+bundle install
+bundle exec rspec spec
+```

data/bankocr.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bankocr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bankocr"
+  spec.version       = BankOCR::VERSION
+  spec.authors       = ["Javier Cervantes"]
+  spec.email         = ["javier@hybridgroup.com"]
+  spec.summary       = %q{Solution to BankOCR Kata}
+  spec.description   = %q{Solution in ruby of BankOCR Kata: http://code.joejag.com/coding-dojo-bank-ocr/}
+  spec.homepage      = "https://github.com/solojavier/bankOCR"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/bankocr

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bankocr'
+
+BankOCR.process(ARGV[0], ARGV[1])
+
+p 'OCR accounts report generated succesfully'

data/bin/input.in

@@ -0,0 +1,48 @@
+ _                         
+  |  |  |  |  |  |  |  |  |  
+  |  |  |  |  |  |  |  |  | 
+
+ _  _  _  _  _  _     _  _ 
+  |  |  |  |  |  |  |  |  | 
+  |  |  |  |  |  |  |  |  | 
+
+ _  _  _  _  _  _  _  _  _ 
+ _|| || ||_|| || || || || | 
+|_ |_||_||_||_||_||_||_||_| 
+
+ _  _  _  _  _  _  _  _  _ 
+ _| _| _| _||_| _| _| _| _| 
+ _| _| _| _| _| _| _| _| _| 
+
+ _  _  _  _  _  _  _  _  _ 
+|_||_||_||_||_||_||_||_||_| 
+|_||_||_||_||_||_||_||_||_| 
+
+ _  _  _  _  _  _  _  _  _ 
+|_ |_ |_ |_ |_ |_ |_ |_ |_ 
+ _| _| _| _| _| _| _| _| _| 
+
+ _  _  _  _  _  _  _  _  _ 
+|_ |_ |_ |_ |_ |_ |_ |_ |_ 
+|_||_||_||_||_||_||_||_||_| 
+
+ _  _  _  _  _  _  _  _  _ 
+|_||_||_||_||_||_||_||_||_| 
+ _| _| _| _| _| _| _| _| _| 
+
+    _  _  _  _  _  _     _ 
+|_||_|| || ||_   |  |  ||_ 
+  | _||_||_||_|  |  |  | _| 
+
+    _  _     _  _  _  _  _ 
+  | _| _||_||_ |_   ||_||_| 
+  ||_  _|  | _||_|  ||_| _| 
+
+ _  _  _  _  _  _  _  _    
+| || || || || || || ||_   |
+|_||_||_||_||_||_||_| _|  | 
+
+    _  _  _  _  _  _     _ 
+|_||_|| ||_||_   |  |  | _ 
+  | _||_||_||_|  |  |  | _| 
+                            

data/lib/account_number.rb

@@ -0,0 +1,31 @@
+module BankOCR
+  class AccountNumber
+
+    attr_reader :error_message, :digits
+
+    def initialize(digits)
+      @digits = digits
+      @valid  = false
+
+      validate!
+    end
+
+    def valid?
+      @valid
+    end
+
+    def validate!
+      @error_message =   'ILL' if @digits.include?('?')
+      @error_message ||= 'ERR' if sum(@digits) % 11 != 0
+
+      @valid = true unless @error_message
+    end
+
+    private
+
+    def sum(account_number)
+      (0..8).map { |i| account_number[i].to_i * (i + 2) }.reduce(:+)
+    end
+
+  end
+end

data/lib/bankocr/version.rb

@@ -0,0 +1,3 @@
+module BankOCR
+  VERSION = "0.0.1"
+end

data/lib/bankocr.rb

@@ -0,0 +1,14 @@
+require "bankocr/version"
+
+module BankOCR
+  autoload :FileParser,      'file_parser'
+  autoload :AccountNumber,   'account_number'
+  autoload :ReportGenerator, 'report_generator'
+
+  def self.process(input, output)
+    digit_strings   = BankOCR::FileParser.new(input).entries
+    account_numbers = digit_strings.map { |d| BankOCR::AccountNumber.new(d) }
+
+    BankOCR::ReportGenerator.new(output, account_numbers).save!
+  end
+end

data/lib/file_parser.rb

@@ -0,0 +1,59 @@
+module BankOCR
+  class FileParser
+
+    def initialize(input_path)
+      @input_path = input_path
+    end
+
+    def entries
+      @entries || read_entries
+    end
+
+    def read_entries
+      @entries = []
+      file     = File.open(@input_path)
+      @entries << parse_entry(file) until file.eof?
+
+      @entries
+    rescue
+      []
+    ensure
+      file.close if file
+    end
+
+    private
+
+    def parse_entry(file)
+      top    = file.readline
+      middle = file.readline
+      bottom = file.readline
+      _blank = file.readline
+
+      entry_to_digits(top, middle, bottom)
+    end
+
+    def entry_to_digits(top, middle, bottom)
+      (0..8).map do |i|
+        low   = (i * 3)
+        high  = ((i + 1) * 3) - 1
+        shape = top[low..high] + middle[low..high] + bottom[low..high]
+
+        conversions[shape] || '?'
+      end.join
+    end
+
+    def conversions
+      { ' _ | ||_|' => '0',
+        '     |  |' => '1',
+        ' _  _||_ ' => '2',
+        ' _  _| _|' => '3',
+        '   |_|  |' => '4',
+        ' _ |_  _|' => '5',
+        ' _ |_ |_|' => '6',
+        ' _   |  |' => '7',
+        ' _ |_||_|' => '8',
+        ' _ |_| _|' => '9' }
+    end
+
+  end
+end

data/lib/report_generator.rb

@@ -0,0 +1,22 @@
+module BankOCR
+  class ReportGenerator
+
+    def initialize(output_path, account_numbers)
+      @output_path     = output_path
+      @account_numbers = account_numbers
+    end
+
+    def save!
+      file = File.open(@output_path, 'w+')
+
+      @account_numbers.each do |account|
+        file.write account.digits
+        file.write " #{account.error_message}" if !account.valid?
+        file.write "\n"
+      end
+
+      file.close
+    end
+
+  end
+end

data/lib/utils.rb

@@ -0,0 +1,84 @@
+# Module for BankOCR Application
+module BankOCR
+  # Utility functions to perform data conversions
+  module Utils
+    # Parses an OCR machine input file and returns an array of account numbers
+    def parse_file(input_path)
+      file    = File.open(input_path)
+      numbers = []
+
+      numbers << next_entry_to_digits(file) until file.eof?
+      numbers
+    rescue
+      []
+    ensure
+      file.close if file
+    end
+
+    # Receives a list of account numbers and returns validation information
+    def validate_accounts(account_numbers)
+      account_numbers.map do |number|
+        valid, message = validate(number.to_s)
+
+        { account_number: number, valid: valid, message: message }
+      end
+    end
+
+    # Creates a file report in ouput path with accounts received
+    def generate_report(output_path, accounts)
+      file = File.open(output_path, 'w+')
+
+      accounts.select { |a| a[:account_number] }.each do |acc|
+        file.write acc[:account_number]
+        file.write " #{acc[:message]}" if !acc[:valid] && acc[:message]
+        file.write "\n"
+      end
+
+      file.close
+    end
+
+    private
+
+    def next_entry_to_digits(file)
+      top    = file.readline
+      middle = file.readline
+      bottom = file.readline
+      _blank = file.readline
+
+      (0..8).map do |i|
+        low   = (i * 3)
+        high  = ((i + 1) * 3) - 1
+        shape = top[low..high] + middle[low..high] + bottom[low..high]
+
+        conversions[shape] || '?'
+      end.join
+    end
+
+    def conversions
+      { ' _ | ||_|' => '0',
+        '     |  |' => '1',
+        ' _  _||_ ' => '2',
+        ' _  _| _|' => '3',
+        '   |_|  |' => '4',
+        ' _ |_  _|' => '5',
+        ' _ |_ |_|' => '6',
+        ' _   |  |' => '7',
+        ' _ |_||_|' => '8',
+        ' _ |_| _|' => '9' }
+    end
+
+    def sum(account_number)
+      (0..8).map { |i| account_number[i].to_i * (i + 2) }.reduce(:+)
+    end
+
+    def validate(number)
+      if number.include?('?')
+        [false, 'ILL']
+      elsif sum(number) % 11 != 0
+        [false, 'ERR']
+      else
+        [true, 'OK']
+      end
+    end
+  end
+end

data/spec/bin/bankocr_spec.rb

@@ -0,0 +1,24 @@
+require 'bankocr'
+
+describe 'Application execution' do
+
+  let(:input)  { File.dirname(__FILE__) + '/input.in' }
+  let(:output) { File.dirname(__FILE__) + '/report.out' }
+
+  let(:report) do
+    "711111111\n777777177\n200800000\n333393333\n888888888 ERR\n" \
+    "555555555 ERR\n666666666 ERR\n999999999 ERR\n490067715 ERR\n" \
+    "123456789\n000000051\n49086771? ILL\n"
+  end
+
+  before do
+    File.delete(output) if File.exists?(output)
+  end
+
+  it 'parses file and creates report', integration: true do
+    BankOCR.process(input, output)
+
+    expect(File.open(output).read).to eq(report)
+  end
+
+end

data/spec/bin/input.in

@@ -0,0 +1,48 @@
+ _                         
+  |  |  |  |  |  |  |  |  |  
+  |  |  |  |  |  |  |  |  | 
+
+ _  _  _  _  _  _     _  _ 
+  |  |  |  |  |  |  |  |  | 
+  |  |  |  |  |  |  |  |  | 
+
+ _  _  _  _  _  _  _  _  _ 
+ _|| || ||_|| || || || || | 
+|_ |_||_||_||_||_||_||_||_| 
+
+ _  _  _  _  _  _  _  _  _ 
+ _| _| _| _||_| _| _| _| _| 
+ _| _| _| _| _| _| _| _| _| 
+
+ _  _  _  _  _  _  _  _  _ 
+|_||_||_||_||_||_||_||_||_| 
+|_||_||_||_||_||_||_||_||_| 
+
+ _  _  _  _  _  _  _  _  _ 
+|_ |_ |_ |_ |_ |_ |_ |_ |_ 
+ _| _| _| _| _| _| _| _| _| 
+
+ _  _  _  _  _  _  _  _  _ 
+|_ |_ |_ |_ |_ |_ |_ |_ |_ 
+|_||_||_||_||_||_||_||_||_| 
+
+ _  _  _  _  _  _  _  _  _ 
+|_||_||_||_||_||_||_||_||_| 
+ _| _| _| _| _| _| _| _| _| 
+
+    _  _  _  _  _  _     _ 
+|_||_|| || ||_   |  |  ||_ 
+  | _||_||_||_|  |  |  | _| 
+
+    _  _     _  _  _  _  _ 
+  | _| _||_||_ |_   ||_||_| 
+  ||_  _|  | _||_|  ||_| _| 
+
+ _  _  _  _  _  _  _  _    
+| || || || || || || ||_   |
+|_||_||_||_||_||_||_| _|  | 
+
+    _  _  _  _  _  _     _ 
+|_||_|| ||_||_   |  |  | _ 
+  | _||_||_||_|  |  |  | _| 
+                            

data/spec/lib/account_number_spec.rb

@@ -0,0 +1,44 @@
+require 'bankocr'
+
+describe BankOCR::AccountNumber do
+
+  context 'when validating account numbers' do
+
+    let(:valid_numbers)   { %w(711111111b 123456789 490867715) }
+    let(:invalid_numbers) { %w(888888888 490067715 012345678) }
+    let(:wrong_numbers)   { %w(86110?356) }
+
+    let(:wrong_accounts) do
+      [ { account_number: '86110??36', valid: false, message: 'ILL' } ]
+    end
+
+    it 'validates valid account numbers' do
+      valid_numbers.each do |n|
+        account = described_class.new(n)
+
+        expect(account.valid?).to eq(true)
+        expect(account.error_message).to eq(nil)
+      end
+    end
+
+    it 'validates invalid account numbers' do
+      invalid_numbers.each do |n|
+        account = described_class.new(n)
+
+        expect(account.valid?).to eq(false)
+        expect(account.error_message).to eq('ERR')
+      end
+    end
+
+    it 'validates wrong account numbers' do
+      wrong_numbers.each do |n|
+        account = described_class.new(n)
+
+        expect(account.valid?).to eq(false)
+        expect(account.error_message).to eq('ILL')
+      end
+    end
+
+  end
+
+end

data/spec/lib/file_parser_spec.rb

@@ -0,0 +1,28 @@
+require 'bankocr'
+
+describe BankOCR::FileParser do
+
+  let(:input_path) { File.dirname(__FILE__) + '/user_story_1.in'  }
+
+  context 'when parsing a file' do
+
+    let(:account_numbers) do
+      %w(000000000 111111111 222222222 333333333 444444444 555555555 666666666
+         777777777 888888888 999999999 123456789 12345678?)
+    end
+
+    it 'returns an array with account numbers' do
+      parser = described_class.new(input_path)
+
+      expect(parser.entries).to eq(account_numbers)
+    end
+
+    it 'returns empty account_numbers if error reading file' do
+      parser = described_class.new('invalid_path')
+
+      expect(parser.entries).to eq([])
+    end
+
+  end
+
+end

data/spec/lib/report_generator_spec.rb

@@ -0,0 +1,38 @@
+require 'bankocr'
+
+describe BankOCR::ReportGenerator do
+
+  let(:accounts) do
+    [
+      BankOCR::AccountNumber.new('457508000'),
+      BankOCR::AccountNumber.new('664371495'),
+      BankOCR::AccountNumber.new('86110??36')
+    ]
+  end
+
+  let(:expected_content) do
+    "457508000\n664371495 ERR\n86110??36 ILL\n"
+  end
+
+  let(:output_path) { File.dirname(__FILE__) + '/user_story_3.out' }
+
+  let(:generated_content) do
+    File.open(output_path).read
+  end
+
+  before do
+    File.delete(output_path) if File.exists?(output_path)
+  end
+
+  it 'creates empty file if accounts are not sent' do
+    described_class.new(output_path, []).save!
+
+    expect(generated_content).to eq('')
+  end
+
+  it 'creates expected content' do
+    described_class.new(output_path, accounts).save!
+
+    expect(generated_content).to eq(expected_content)
+  end
+end

data/spec/lib/user_story_1.in

@@ -0,0 +1,48 @@
+ _  _  _  _  _  _  _  _  _ 
+| || || || || || || || || | 
+|_||_||_||_||_||_||_||_||_| 
+
+                            
+  |  |  |  |  |  |  |  |  | 
+  |  |  |  |  |  |  |  |  | 
+
+ _  _  _  _  _  _  _  _  _ 
+ _| _| _| _| _| _| _| _| _| 
+|_ |_ |_ |_ |_ |_ |_ |_ |_ 
+
+ _  _  _  _  _  _  _  _  _ 
+ _| _| _| _| _| _| _| _| _| 
+ _| _| _| _| _| _| _| _| _| 
+
+                            
+|_||_||_||_||_||_||_||_||_| 
+  |  |  |  |  |  |  |  |  | 
+
+ _  _  _  _  _  _  _  _  _ 
+|_ |_ |_ |_ |_ |_ |_ |_ |_ 
+ _| _| _| _| _| _| _| _| _| 
+
+ _  _  _  _  _  _  _  _  _ 
+|_ |_ |_ |_ |_ |_ |_ |_ |_ 
+|_||_||_||_||_||_||_||_||_| 
+
+ _  _  _  _  _  _  _  _  _ 
+  |  |  |  |  |  |  |  |  | 
+  |  |  |  |  |  |  |  |  | 
+
+ _  _  _  _  _  _  _  _  _ 
+|_||_||_||_||_||_||_||_||_| 
+|_||_||_||_||_||_||_||_||_| 
+
+ _  _  _  _  _  _  _  _  _ 
+|_||_||_||_||_||_||_||_||_| 
+ _| _| _| _| _| _| _| _| _| 
+
+    _  _     _  _  _  _  _ 
+  | _| _||_||_ |_   ||_||_| 
+  ||_  _|  | _||_|  ||_| _| 
+
+    _  _     _  _  _  _  _ 
+  | _| _||_||_ |_   ||_|| | 
+  ||_  _|  | _||_|  ||_| _| 
+                            

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: bankocr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Javier Cervantes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'Solution in ruby of BankOCR Kata: http://code.joejag.com/coding-dojo-bank-ocr/'
+email:
+- javier@hybridgroup.com
+executables:
+- bankocr
+- input.in
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- bankocr.gemspec
+- bin/bankocr
+- bin/input.in
+- lib/account_number.rb
+- lib/bankocr.rb
+- lib/bankocr/version.rb
+- lib/file_parser.rb
+- lib/report_generator.rb
+- lib/utils.rb
+- spec/bin/bankocr_spec.rb
+- spec/bin/input.in
+- spec/lib/account_number_spec.rb
+- spec/lib/file_parser_spec.rb
+- spec/lib/report_generator_spec.rb
+- spec/lib/user_story_1.in
+homepage: https://github.com/solojavier/bankOCR
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Solution to BankOCR Kata
+test_files:
+- spec/bin/bankocr_spec.rb
+- spec/bin/input.in
+- spec/lib/account_number_spec.rb
+- spec/lib/file_parser_spec.rb
+- spec/lib/report_generator_spec.rb
+- spec/lib/user_story_1.in
+has_rdoc: