rocrad 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.2@rocrad

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "rake", "0.8.7"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  gem "rcov", ">= 0"
+  gem "test-unit", "2.3.0"
+end

data/Gemfile.lock

@@ -0,0 +1,21 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    test-unit (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.0)
+  rake (= 0.8.7)
+  rcov
+  test-unit (= 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ludwig Bratke
+
+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.rdoc

@@ -0,0 +1,19 @@
+= rocrad
+
+Description goes here.
+
+== Contributing to rocrad
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Ludwig Bratke. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rocrad"
+  gem.homepage = "http://github.com/EeCnee/rocrad"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby library for working with Ocrad - The GNU OCR}
+  gem.description = %Q{Ruby library for working with Ocrad - The GNU OCR}
+  gem.email = "EeCnee1@netscape.net"
+  gem.authors = ["Ludwig Bratke"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rocrad #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rocrad/errors.rb

@@ -0,0 +1,6 @@
+class Rocrad
+  class ConversionError < StandardError ;end
+  class ImageNotSelectedError < StandardError ;end
+  class TempFilesNotRemovedError < StandardError ;end
+  class UnsupportedFileTypeError < StandardError ;end
+end

data/lib/rocrad.rb

@@ -0,0 +1,99 @@
+require "pathname"
+require "tempfile"
+
+require "rocrad/errors"
+
+class Rocrad
+
+  attr_accessor :options
+
+  def initialize(src="", options={})
+    @uid                  = options.delete(:uid) || nil
+    @source               = Pathname.new src
+    @clear_console_output = options.delete(:clear_console_output)
+    @clear_console_output = true if @clear_console_output.nil?
+    @value = ""
+  end
+
+  def source= src
+    @value  = ""
+    @source = Pathname.new src
+  end
+
+  #Remove files
+  def remove_file(files=[])
+    files.each do |file|
+      begin
+        File.unlink(file) if File.exist?(file)
+      rescue
+        system "rm -f #{file}"
+      end
+    end
+    true
+  rescue
+    raise Rocrad::TempFilesNotRemovedError
+  end
+
+  def generate_uid
+    @uid = rand.to_s[2, 10] if @uid.nil?
+    @uid
+  end
+
+  #Convert image to pnm
+  def image_to_pnm
+    generate_uid
+    tmp_file    = Pathname.new(Dir::tmpdir).join("#{@uid}_#{@source.sub_ext(".pnm").basename}")
+    redirection = "#{@source} > #{tmp_file} #{clear_console_output}"
+    case @source.extname
+      when ".jpg" then
+        `djpeg -greyscale -pnm #{redirection}`
+      when ".tif" then
+        `tifftopnm #{redirection}`
+      when ".png" then
+        `pngtopnm #{redirection}`
+      when ".bmp" then
+        `bmptopnm #{redirection}`
+      else
+        raise UnsupportedFileTypeError
+    end
+    tmp_file
+  end
+
+  #Convert image to string
+  def convert
+    generate_uid
+    tmp_file  = Pathname.new(Dir::tmpdir).join("#{@uid}_#{@source.sub_ext(".txt").basename}")
+    tmp_image = image_to_pnm
+    begin
+      `gocr #{tmp_image} -o #{tmp_file} #{clear_console_output}`
+      @value = File.read(tmp_file)
+      @uid   = nil
+      remove_file([tmp_image, tmp_file])
+    rescue
+      raise ConversionError
+    end
+  end
+
+  #TODO: Clear console for MacOS or Windows
+  def clear_console_output
+    return "" unless @clear_console_output
+    "2>/dev/null" if File.exist?("/dev/null") #Linux console clear
+  end
+
+  #Output value
+  def to_s
+    return @value if @value != ""
+    if @source.file?
+      convert
+      @value
+    else
+      raise ImageNotSelectedError
+    end
+  end
+
+  #Remove spaces and break-lines
+  def to_s_without_spaces
+    to_s.gsub(" ", "").gsub("\n", "").gsub("\r", "").encode("US-ASCII")
+  end
+
+end

data/rocrad.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rocrad}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ludwig Bratke"]
+  s.date = %q{2011-05-25}
+  s.description = %q{Ruby library for working with Ocrad - The GNU OCR}
+  s.email = %q{EeCnee1@netscape.net}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/rocrad.rb",
+    "lib/rocrad/errors.rb",
+    "rocrad.gemspec",
+    "test/helper.rb",
+    "test/images/mixed.tif",
+    "test/images/test.bmp",
+    "test/images/test.foo",
+    "test/images/test.jpg",
+    "test/images/test.png",
+    "test/images/test.tif",
+    "test/images/test1.tif",
+    "test/test_rocrad.rb"
+  ]
+  s.homepage = %q{http://github.com/EeCnee/rocrad}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.7.2}
+  s.summary = %q{Ruby library for working with Ocrad - The GNU OCR}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, ["= 0.8.7"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<test-unit>, ["= 2.3.0"])
+    else
+      s.add_dependency(%q<rake>, ["= 0.8.7"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<test-unit>, ["= 2.3.0"])
+    end
+  else
+    s.add_dependency(%q<rake>, ["= 0.8.7"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<test-unit>, ["= 2.3.0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rocrad'
+
+class Test::Unit::TestCase
+end

data/test/images/test.foo

@@ -0,0 +1 @@
+file with invalid extension

data/test/test_rocrad.rb

@@ -0,0 +1,73 @@
+begin
+  require "helper"
+rescue LoadError
+  require File.dirname(__FILE__) + '/helper'
+end
+
+class TestRocrad < Test::Unit::TestCase
+
+  def setup
+    @path      = Pathname.new(__FILE__.gsub("test_rocrad.rb", "")).expand_path
+    @image_jpg = @path.join("images", "test.jpg").to_s
+  end
+
+  def test_be_instantiable
+    assert_equal Rocrad, Rocrad.new.class
+    assert_equal Rocrad, Rocrad.new("").class
+    assert_equal Rocrad, Rocrad.new(@image_jpg).class
+  end
+
+  def test_translate_image_to_text
+    assert_equal "3R8Z", Rocrad.new(@image_jpg).to_s_without_spaces
+    assert_equal "43ZZ", Rocrad.new(@path.join("images", "test.tif").to_s).to_s_without_spaces
+  end
+
+  def test_unsupported_file_type_error
+    assert_raise Rocrad::UnsupportedFileTypeError do
+      Rocrad.new(@path.join("images", "test.foo").to_s).to_s_without_spaces
+    end
+  end
+
+  def test_image_not_selected_error
+    assert_raise Rocrad::ImageNotSelectedError do
+      Rocrad.new(@path.join("images", "test.noo").to_s).to_s_without_spaces
+    end
+  end
+
+  def test_translate_images_png_jpg
+    assert_equal "HW9W", Rocrad.new(@path.join("images", "test.png").to_s).to_s_without_spaces
+    assert_equal "3R8Z", Rocrad.new(@path.join("images", "test.jpg").to_s).to_s_without_spaces
+  end
+
+  def test_translate_images_bmp
+    assert_equal "ZLA6", Rocrad.new(@path.join("images", "test.bmp").to_s).to_s_without_spaces
+  end
+
+  def test_translate_mixed_tif
+    assert_equal "43ZZ", Rocrad.new(@path.join("images", "mixed.tif").to_s).to_s_without_spaces
+  end
+
+  def test_translate_test1_tif
+    assert_equal "V2V4", Rocrad.new(@path.join("images", "test1.tif").to_s).to_s_without_spaces
+  end
+
+  def test_change_the_image
+    image = Rocrad.new(@image_jpg)
+    assert_equal "3R8Z", image.to_s_without_spaces
+    image.source = @path.join("images", "test.tif").to_s
+    assert_equal "43ZZ", image.to_s_without_spaces
+  end
+
+  def test_unique_uid
+    assert_not_equal Rocrad.new(@image_jpg).generate_uid, Rocrad.new(@image_jpg).generate_uid
+  end
+
+  def test_generate_a_unique id
+    reg = Rocrad.new(@image_jpg)
+    assert_equal reg.generate_uid, reg.generate_uid
+    value = reg.generate_uid
+    reg.convert
+    assert_not_equal value, reg.generate_uid
+  end
+
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification 
+name: rocrad
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ludwig Bratke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-25 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: Ruby library for working with Ocrad - The GNU OCR
+email: EeCnee1@netscape.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rocrad.rb
+- lib/rocrad/errors.rb
+- rocrad.gemspec
+- test/helper.rb
+- test/images/mixed.tif
+- test/images/test.bmp
+- test/images/test.foo
+- test/images/test.jpg
+- test/images/test.png
+- test/images/test.tif
+- test/images/test1.tif
+- test/test_rocrad.rb
+homepage: http://github.com/EeCnee/rocrad
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2868053043622808966
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Ruby library for working with Ocrad - The GNU OCR
+test_files: []
+