ffi-aspell 0.0.3 → 1.0.0

data/.gitignore

@@ -1,3 +0,0 @@
-pkg/*.gem
-doc
-Gemfile.lock

data/.ruby-version

@@ -1 +0,0 @@
-1.9.3-p194

data/Gemfile

@@ -1,3 +0,0 @@
-source :rubygems
-
-gemspec

data/README.md

@@ -1,65 +0,0 @@
-# FFI::Aspell
-
-FFI::Aspell is an FFI binding for the Aspell library. It was mainly written as
-[Raspell][raspell], a C binding for Aspell, is buggy and no longer maintained by
-the main author as of April 2012.
-
-## Requirements
-
-* FFI: `gem install ffi`
-* Aspell (`sudo pacman -S aspell` if you're on Arch Linux)
-* Dutch and Greek language packs for Aspell.
-
-## Usage
-
-Install the gem:
-
-    $ gem install ffi-aspell
-
-Load it:
-
-    require 'ffi/aspell'
-
-The primary class is `FFI::Aspell::Speller`, this class can be used to check for
-spelling errors and the like:
-
-    speller = FFI::Aspell::Speller.new('en_US')
-
-    if speller.correct?('cookie')
-      puts 'The word "cookie" is correct'
-    else
-      puts 'The word "cookie" is incorrect'
-    end
-
-For more information see the YARD documentation.
-
-## Hacking & Contributing
-
-1. Make sure that Aspell and the English and Dutch dictionaries for it are
-   installed as well. On Arch Linux this can be done by running `sudo pacman -S
-   aspell aspell-en aspell-nl`.
-2. Install the gems: `bundle install`
-3. Run the tests to see if everything is working: `rake test`
-4. Hack away!
-
-## Coding Standards
-
-* FFI functions go in FFI::Aspell
-* Attached function names should resemble the C function names as much as
-  possible.
-* No more than 80 characters per line of code.
-* Document your code, pull requests with big changes but without documentation
-  will be rejected.
-* Git commits should be signed off, this can be done by running `git commit
-  --sign`. Commits that are not signed off will be rejected.
-* Follow the Git commit standards are described here:
-  <http://ramaze.net/documentation/file.contributing.html#Commit_Messages>.
-* Test your code! Pull requests without tests will not be accepted.
-
-## License
-
-The code in this repository is licensed under the MIT license. A copy of this
-license can be found in the file "LICENSE" in the root directory of this
-repository.
-
-[raspell]: https://github.com/evan/raspell

data/Rakefile

@@ -1,3 +0,0 @@
-Dir['./task/*.rake'].each { |task| import(task) }
-
-task :default => :test

data/ffi-aspell.gemspec

@@ -1,21 +0,0 @@
-require File.expand_path('../lib/ffi/aspell/version', __FILE__)
-
-Gem::Specification.new do |s|
-  s.name        = 'ffi-aspell'
-  s.version     = FFI::Aspell::VERSION
-  s.date        = '2012-07-07'
-  s.authors     = ['Yorick Peterse']
-  s.email       = 'yorickpeterse@gmail.com'
-  s.summary     = 'FFI bindings for Aspell'
-  s.homepage    = 'https://github.com/YorickPeterse/ffi-aspell'
-  s.description = s.summary
-  s.files       = `git ls-files`.split("\n")
-  s.has_rdoc    = 'yard'
-
-  s.add_dependency('ffi', ['>= 1.0.11'])
-
-  s.add_development_dependency('rake', ['>= 0.9.2.2'])
-  s.add_development_dependency('yard',['>= 0.7.5'])
-  s.add_development_dependency('redcarpet', ['>= 2.1.1'])
-  s.add_development_dependency('bacon', ['>= 1.1.0'])
-end

data/spec/ffi/aspell/speller.rb

@@ -1,107 +0,0 @@
-# -*- coding: utf-8 -*-
-
-require File.expand_path('../../../helper', __FILE__)
-
-describe 'FFI::Aspell::Speller' do
-  it 'Set the language in the constructor' do
-    FFI::Aspell::Speller.new.get('lang').should       == 'en_US'
-    FFI::Aspell::Speller.new('en').get('lang').should == 'en'
-    FFI::Aspell::Speller.new('nl').get('lang').should == 'nl'
-  end
-
-  it 'Set options in the constructor' do
-    FFI::Aspell::Speller.new.get('personal').should == '.aspell.en_US.pws'
-
-    FFI::Aspell::Speller.new('en', :personal => 'foo') \
-      .get(:personal).should == 'foo'
-  end
-
-  it 'Raise when setting a non existing option' do
-    should.raise(FFI::Aspell::ConfigError) do
-      FFI::Aspell::Speller.new.set('foo', 'bar')
-    end
-  end
-
-  it 'Raise when retrieving a non existing option' do
-    should.raise(FFI::Aspell::ConfigError) do
-      FFI::Aspell::Speller.new.get('foo')
-    end
-  end
-
-  it 'Retrieve the default value of an option' do
-    FFI::Aspell::Speller.new.get_default('personal') \
-      .should == '.aspell.en_US.pws'
-  end
-
-  it 'Reset an option to its default value' do
-    speller = FFI::Aspell::Speller.new
-
-    speller.set('personal', 'foo')
-
-    speller.get('personal').should == 'foo'
-
-    speller.reset('personal')
-
-    speller.get('personal').should == '.aspell.en_US.pws'
-  end
-
-  it 'Validate various English words' do
-    speller = FFI::Aspell::Speller.new('en')
-
-    speller.correct?('cookie').should == true
-    speller.correct?('werld').should  == false
-    speller.correct?('house').should  == true
-    speller.correct?('huis').should   == false
-  end
-
-  it 'Validate various Dutch words' do
-    speller = FFI::Aspell::Speller.new('nl')
-
-    speller.correct?('koekje').should == true
-    speller.correct?('werld').should  == false
-    speller.correct?('huis').should   == true
-  end
-
-  it 'Validate some UTF-8 (Greek) words' do
-    speller = FFI::Aspell::Speller.new('el')
-
-    speller.correct?('χταπόδι').should == true
-    speller.correct?('οιρανός').should  == false
-  end
-
-  it 'Change the language of an existing speller object' do
-    speller = FFI::Aspell::Speller.new
-
-    speller.correct?('house').should == true
-    speller.correct?('huis').should  == false
-
-    speller.set('lang', 'nl')
-
-    speller.correct?('house').should == true
-    speller.correct?('huis').should  == true
-  end
-
-  it 'Use an English personal word list' do
-    speller = FFI::Aspell::Speller.new('en')
-
-    speller.correct?('github').should == false
-    speller.correct?('nodoc').should  == false
-
-    speller.set(:personal, File.join(FIXTURES, 'personal.en.pws'))
-
-    speller.correct?('github').should == true
-    speller.correct?('nodoc').should  == true
-  end
-
-  it 'Use a Dutch personal word list' do
-    speller = FFI::Aspell::Speller.new('nl')
-
-    speller.correct?('github').should == false
-    speller.correct?('nodoc').should  == false
-
-    speller.set(:personal, File.join(FIXTURES, 'personal.nl.pws'))
-
-    speller.correct?('github').should == true
-    speller.correct?('nodoc').should  == true
-  end
-end

data/spec/ffi/aspell/suggestions.rb

@@ -1,57 +0,0 @@
-# -*- coding: utf-8 -*-
-
-require File.expand_path('../../../helper', __FILE__)
-
-describe 'FFI::Aspell::Speller#suggestions' do
-  it 'Return a list of word suggestions using the default mode' do
-    speller     = FFI::Aspell::Speller.new
-    suggestions = speller.suggestions('cookei')
-
-    suggestions.include?('coke').should   == true
-    suggestions.include?('cookie').should == true
-    suggestions.include?('cooked').should == true
-  end
-
-  it 'Return a list of UTF-8 words' do
-    with_internal_encoding('UTF-8') do
-      speller     = FFI::Aspell::Speller.new('el')
-      suggestions = speller.suggestions('χταπίδι')
-
-      suggestions.include?('χταπόδι').should  == true
-      suggestions.include?('απίδι').should    == true
-    end
-  end
-
-  it 'Return a list of word suggestions using the "bad-spellers" mode' do
-    speller = FFI::Aspell::Speller.new
-
-    # Get the amount of suggestions for the normal mode. The "bad-spellers" mode
-    # should result in a lot more possible suggestions.
-    normal_length = speller.suggestions('cookei').length
-
-    speller.suggestion_mode = 'bad-spellers'
-    suggestions             = speller.suggestions('cookei')
-
-    suggestions.include?('coke').should   == true
-    suggestions.include?('cookie').should == true
-    suggestions.include?('cooked').should == true
-
-    suggestions.length.should > normal_length
-  end
-
-  it 'Raise an error when an invalid suggestion mode is used' do
-    speller = FFI::Aspell::Speller.new
-
-    should.raise(FFI::Aspell::ConfigError) do
-      speller.suggestion_mode = 'does-not-exist'
-    end
-
-    speller.suggestion_mode.should == 'normal'
-
-    should.not.raise(FFI::Aspell::ConfigError) do
-      speller.suggestion_mode = 'ultra'
-    end
-
-    speller.suggestion_mode.should == 'ultra'
-  end
-end

data/spec/fixtures/personal.en.pws

@@ -1,3 +0,0 @@
-personal_ws-1.1 en 2 utf-8
-github
-nodoc

data/spec/fixtures/personal.nl.pws

@@ -1,3 +0,0 @@
-personal_ws-1.1 nl 2 utf-8
-github
-nodoc

data/spec/helper.rb

@@ -1,24 +0,0 @@
-require 'bacon'
-require File.expand_path('../../lib/ffi/aspell', __FILE__)
-
-Bacon.extend(Bacon::TapOutput)
-Bacon.summary_on_exit
-
-FIXTURES = File.expand_path('../fixtures', __FILE__)
-
-##
-# Used to change default internal encoding for certain tests.
-# Ruby uses default_internal (amongst others) when presenting
-# strings and when calling encode! without argument.
-# Rails explicitly sets it to UTF-8 on bootup
-#
-# @param [String] enc The encoding to switch to
-#
-def with_internal_encoding(enc)
-  if defined?(Encoding)
-    old_enc = Encoding.default_internal
-    Encoding.default_internal = enc
-    yield
-    Encoding.default_internal = old_enc
-  end
-end

data/task/build.rake

@@ -1,15 +0,0 @@
-namespace :build do
-  desc 'Builds a new Gem'
-  task :gem do
-    root    = File.expand_path('../../', __FILE__)
-    gemspec = Gem::Specification.load(File.join(root, 'ffi-aspell.gemspec'))
-    name    = "#{gemspec.name}-#{gemspec.version.version}.gem"
-    path    = File.join(root, name)
-    pkg     = File.join(root, 'pkg', name)
-
-    # Build and install the gem
-    sh('gem', 'build', File.join(root, 'ffi-aspell.gemspec'))
-    sh('mv' , path, pkg)
-    sh('gem', 'install', pkg)
-  end
-end

data/task/memory.rake

@@ -1,50 +0,0 @@
-# Cheap way of benchmarking the memory usage of various parts of the FFI
-# binding.
-def benchmark_block(amount = 10000)
-  require File.expand_path('../../lib/ffi/aspell', __FILE__)
-
-  start_mem = `ps -o rss= #{Process.pid}`.to_f
-
-  amount.times { yield }
-
-  mem = ((`ps -o rss= #{Process.pid}`.to_f - start_mem) / 1024).round(2)
-
-  puts "Memory increase in Megabytes: #{mem} MB"
-end
-
-namespace :memory do
-  memory = proc { `ps -o rss= #{Process.pid}`.to_i }
-
-  desc 'Show memory usage of Aspell.speller_new'
-  task :speller, [:amount] do |task, args|
-    args.with_defaults(:amount => 10000)
-
-    benchmark_block(args.amount) do
-      speller = FFI::Aspell.speller_new(FFI::Aspell.config_new)
-
-      FFI::Aspell.speller_delete(speller)
-    end
-  end
-
-  desc 'Show memory usage of Speller#correct?'
-  task :correct, [:amount] do |task, args|
-    args.with_defaults(:amount => 10000)
-
-    benchmark_block(args.amount) do
-      speller = FFI::Aspell::Speller.new
-
-      speller.correct?('cookie')
-    end
-  end
-
-  desc 'Show memory usage of Speller#suggestions'
-  task :suggestions, [:amount] do |task, args|
-    args.with_defaults(:amount => 10000)
-
-    benchmark_block(args.amount) do
-      speller = FFI::Aspell::Speller.new
-
-      speller.suggestions('cookei')
-    end
-  end
-end

data/task/test.rake

@@ -1,4 +0,0 @@
-desc 'Runs all the tests using Bacon'
-task :test do
-  Dir['./spec/ffi/aspell/**/*.rb'].sort.each { |spec| require(spec) }
-end