anystyle-parser 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9723d7ea8fd46588c2487a72357c29fc9b1811ce
+  data.tar.gz: bfe339c9e7ab8883cbef7d8ad4de1a6aba433b53
+SHA512:
+  metadata.gz: 18591aa6d5ab49057b57308ff4a38b0e99aa07b45acf244998b47e51653b892ca442a5def2f3ed547f74c4cf338355070749cd31ca44dec08d41d21b2f23912b
+  data.tar.gz: 2790d3bd5f4fa9a86aae3be03b3dbb9847816911a173186c898def47f28c243f3bf12ccdedb34e914bd5549f3bdaeed24fcc47c014b628f71b96dacc0d39846e

data/Gemfile

@@ -1,19 +1,19 @@
 source 'https://rubygems.org'
 gemspec
 
-group :development do
-	gem 'debugger', :platforms => [:mri_19]	
-	gem 'simplecov'
-	gem 'yard'
+group :development, :test do
+  gem 'rake'
+  gem 'cucumber'
+  gem 'rspec'
+  gem 'simplecov', '~>0.8', :require => false
+  gem 'rubinius-coverage', :platform => :rbx
+  gem 'coveralls', :require => false
 end
 
-group :test  do
-	gem 'rake'
-	gem 'racc', '~>1.4'
-
-	gem 'cucumber'
-	gem 'rspec'
-	gem 'ZenTest'
+group :debug do
+  gem 'debugger', '~>1.6', :require => false, :platform => :mri
+  gem 'rubinius-compiler', '~>2.0', :require => false, :platform => :rbx
+  gem 'rubinius-debugger', '~>2.0', :require => false, :platform => :rbx
 end
 
 group :profile do
@@ -22,6 +22,22 @@ group :profile do
 end
 
 group :extra do
+	gem 'autotest-fsevent', :require => false
+  gem 'yard'
+	gem 'ZenTest'
+end
+
+group :redis do
+  gem 'redis'
+  gem 'hiredis'
+end
+
+group :kyoto do
 	gem 'kyotocabinet-ruby', :require => 'kyotocabinet'
-	gem 'autotest-fsevent', :require => false  
+end
+
+platform :rbx do
+  gem 'rubysl', '~>2.0'
+  gem 'json', '~>1.8'
+  gem 'racc'
 end

data/HISTORY.md

@@ -1,3 +1,9 @@
+0.3.0 / 2014-02-14
+==================
+* Update dependencies
+* Added raw output format
+* Enforce Ruby 1.9.3 or later requirement
+
 0.2.0 / 2012-10-29
 ==================
 * Use Namae for name normalization

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2011-2012 Sylvester Keil. All rights reserved.
+Copyright 2011-2014 Sylvester Keil. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
@@ -23,4 +23,4 @@ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 The views and conclusions contained in the software and documentation are
 those of the authors and should not be interpreted as representing official
-policies, either expressed or implied, of the copyright holder.
+policies, either expressed or implied, of the copyright holder.

data/README.md

@@ -1,5 +1,7 @@
 Anystyle-Parser
 ===============
+[![Build Status](https://travis-ci.org/inukshuk/anystyle-parser.png?branch=master)](https://travis-ci.org/inukshuk/anystyle-parser)
+[![Coverage Status](https://coveralls.io/repos/inukshuk/anystyle-parser/badge.png)](https://coveralls.io/r/inukshuk/anystyle-parser)
 
 Anystyle-Parser is a very fast and smart parser for academic references. It
 is inspired by [ParsCit](http://aye.comp.nus.edu.sg/parsCit/) and
@@ -18,7 +20,7 @@ Installation
     $ [sudo] gem install anystyle-parser
 
 During the statistical analysis of reference strings, Anystyle-Parser relies
-on a large feature dictionary; by default, Anystyle-Parser creates a 
+on a large feature dictionary; by default, Anystyle-Parser creates a
 [Kyoto Cabinet](http://fallabs.com/kyotocabinet/) file-based hash database
 from the dictionary file that ships with the parser. If Kyoto Cabinet is
 not installed on your system, Anystyle-Parser uses a simple Ruby Hash as a
@@ -26,7 +28,7 @@ fall-back; this Hash has to be re-created every time you load the parser
 and takes up a lot of memory in your Ruby process; it is therefore strongly
 recommended to install Kyoto Cabinet and the `kyotocabinet-ruby` gem.
 
-    $ [sudo] gem install kyotocabinet-ruby 
+    $ [sudo] gem install kyotocabinet-ruby
 
 The database file will be created the first time you access the dictionary;
 note that you will need write permissions in the directory where the file
@@ -39,8 +41,8 @@ Starting with version 0.1.0, Anystyle-Parser also supports
 [Redis](http://redis.io); to use Redis as the data store you need to install
 the `redis` gem (and, optionally, the `hiredis` gem).
 
-    $ [sudo] gem install hiredis 
-    $ [sudo] gem install redis 
+    $ [sudo] gem install hiredis
+    $ [sudo] gem install redis
 
 To see which data store modes are available in you current environment,
 check the output of `Dictionary.modes`:
@@ -52,7 +54,7 @@ To select one of the available modes, use the dictionary instance options:
 
     > Anystyle::Parser::Dictionary.instance.options[:mode]
     => :kyoto
-    
+
 To use [Redis](http://redis.io) you also need to set the host or unix socket
 where your redis server is available. For example:
 
@@ -84,7 +86,7 @@ Anystyle-Parser are `#parse` and `#train` that both accept two arguments.
 `#parse` parses the passed-in input (either a filename, your reference strings,
 or an array of your reference strings) and returns the parsed data in the
 format specified as the second argument (supported formats include: *:hash*,
-*:bibtex*, *:citeproc*, and *:tags*).
+*:bibtex*, *:citeproc*, *:tags*, and *:raw*).
 
 `#train` allows you to easily train the Parser's CRF model. The first argument
 is either a filename or your data as a string; the format of training data
@@ -113,7 +115,7 @@ The following irb sessions illustrates some parser goodness:
       year = {1997}
     }
     => nil
-    
+
 ### Unhappy with the results?
 
 Citation references come in many forms, so, inevitably, you will find data
@@ -159,11 +161,10 @@ data again:
     => [{:author=>"John Lafferty and Andrew McCallum and Fernando Pereira", :title=>"Conditional random fields: probabilistic models for segmenting and labeling sequence data", :booktitle=>"Proceedings of the International Conference on Machine Learning", :pages=>"282--289", :publisher=>"Morgan Kaufmann", :location=>"San Francisco, CA", :year=>2001, :type=>:inproceedings}]
 
 If you want to make Anystyle-Parser smarter, please consider sending us your
-tagged references (see below). 
+tagged references (see below).
 
 Contributing
 ------------
-
 The Anystyle-Parser source code is
 [hosted on GitHub](http://github.com/inukshuk/anystyle-parser/).
 You can check out a copy of the latest code using Git:
@@ -182,8 +183,7 @@ and open a pull request on GitHub.
 
 License
 -------
-
-Copyright 2011-2012 Sylvester Keil. All rights reserved.
+Copyright 2011-2014 Sylvester Keil. All rights reserved.
 
 Some of the code in Anystyle-Parser's post processing (normalizing) routines
 was originally based on the source code of FreeCite and

data/Rakefile

@@ -1,6 +1,6 @@
 require 'bundler'
 begin
-  Bundler.setup(:default, :development, :debug, :test, :extra, :profile)
+  Bundler.setup
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
   $stderr.puts "Run `bundle install` to install missing gems"
@@ -23,6 +23,13 @@ task :release => [:build] do
   system "gem push anystyle-parser-#{Anystyle::Parser::VERSION}.gem"
 end
 
+task :check_warnings do
+  $VERBOSE = true
+  require 'anystyle/parser'
+
+  puts Anystyle::Parser::VERSION
+end
+
 require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
@@ -32,6 +39,10 @@ end
 require 'cucumber/rake/task'
 Cucumber::Rake::Task.new(:features)
 
+require 'coveralls/rake/task'
+Coveralls::RakeTask.new
+task :test_with_coveralls => [:spec, 'coveralls:push']
+
 task :default => :spec
 
 begin
@@ -41,13 +52,13 @@ rescue LoadError
   # ignore
 end
 
-desc 'Run an IRB session with CSL loaded'
+desc 'Run an IRB session with Anystyle-Parser loaded'
 task :console, [:script] do |t, args|
   ARGV.clear
 
   require 'irb'
   require 'anystyle/parser'
-  
+
   IRB.conf[:SCRIPT] = args.script
   IRB.start
 end

data/anystyle-parser.gemspec

@@ -11,22 +11,27 @@ Gem::Specification.new do |s|
   s.authors     = ['Sylvester Keil']
   s.email       = ['http://sylvester.keil.or.at']
   s.homepage    = 'http://github.com/inukshuk/anystyle-parser'
-  s.summary     = 'Parser for academic references.'
-  s.description = 'A sophisticated parser for academic references based on machine learning algorithms using conditional random fields.'
+  s.summary     = 'Smart and fast academic bibliography parser.'
+  s.description = 'A sophisticated parser for academic reference lists and bibliographies based on machine learning algorithms using conditional random fields.'
   s.license     = 'FreeBSD'
-  
-  s.add_runtime_dependency('bibtex-ruby', '~>2.0')
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_runtime_dependency('bibtex-ruby', '~>3.0')
   s.add_runtime_dependency('wapiti', '~>0.0')
-  s.add_runtime_dependency('namae', '~>0.7.1')
+  s.add_runtime_dependency('namae', '~>0.8')
+
+  s.files        = `git ls-files`.split("\n").reject { |path|
+    path.start_with?('.')
+  } - Dir['resources/**/*']
 
-  s.files        = `git ls-files`.split("\n") - Dir['resources/**/*']
   s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables  = []
   s.require_path = 'lib'
 
   s.rdoc_options      = %w{--line-numbers --inline-source --title "Anystyle\ Parser" --main README.md}
   s.extra_rdoc_files  = %w{README.md LICENSE}
-  
+
 end
 
-# vim: syntax=ruby
+# vim: syntax=ruby

data/features/support/env.rb

@@ -1 +1,19 @@
+begin
+  require 'simplecov'
+  require 'coveralls' if ENV['CI']
+rescue LoadError
+  # ignore
+end
+
+begin
+  case
+  when defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+    require 'rubinius/debugger'
+  else
+    require 'debugger'
+  end
+rescue LoadError
+  # ignore
+end
+
 require 'anystyle/parser'

data/lib/anystyle/parser/dictionary.rb

@@ -1,6 +1,6 @@
 module Anystyle
   module Parser
-    
+
     # Dictionary is a Singleton object that provides a key-value store of
     # the Anystyle Parser dictionary required for feature elicitation.
     # This dictionary acts essentially like a Ruby Hash object, but because
@@ -11,8 +11,8 @@ module Anystyle
     #
     # Starting with version 0.1.0 Redis support was added. If you would
     # like to use Redis as the dictionary data store you can do so by
-    # 
-    # 
+    # installing `redis' gem (and optionally the `hiredis' gem).
+    #
     # The database will be automatically created from the dictionary file
     # using the best available DBM the first time it is accessed. Once
     # database file exists, the database will be restored from file.
@@ -46,7 +46,7 @@ module Anystyle
     class Dictionary
 
       include Singleton
-      
+
       @keys = [:male, :female, :surname, :month, :place, :publisher, :journal].freeze
 
       @code = Hash[*@keys.zip(0.upto(@keys.length-1).map { |i| 2**i }).flatten]
@@ -67,42 +67,40 @@ module Anystyle
       rescue LoadError
         # info 'no redis support detected'
       end
-      
+
       begin
         require 'kyotocabinet'
         @modes.unshift :kyoto
       rescue LoadError
         # info 'no kyoto-cabinet support detected'
       end
-      
+
       @defaults = {
         :mode => @modes[0],
         :source => File.expand_path('../support/dict.txt.gz', __FILE__),
         :cabinet => File.expand_path('../support/dict.kch', __FILE__),
         :port => 6379
       }.freeze
-      
-      
+
+
       class << self
-        
         attr_reader :keys, :code, :defaults, :modes
-        
       end
 
       attr_reader :options
-      
+
       def initialize
         @options = Dictionary.defaults.dup
       end
-      
+
       def [](key)
         db[key.to_s].to_i
       end
-      
+
       def []=(key, value)
         db[key.to_s] = value
       end
-      
+
       def create
         case options[:mode]
         when :kyoto
@@ -113,61 +111,61 @@ module Anystyle
           end
           populate
           close
-        
+
         when :redis
           @db ||= Redis.new(options)
           populate
           close
-          
+
         else
           # nothing
         end
       end
-      
+
       def truncate
         close
-        File.unlink(path) if File.exists?(path)       
+        File.unlink(path) if File.exists?(path)
       end
-      
+
       def open
         case options[:mode]
         when :kyoto
           at_exit { ::Anystyle::Parser::Dictionary.instance.close }
 
           create unless File.exists?(path)
-  
+
           @db = KyotoCabinet::DB.new
           unless @db.open(path, KyotoCabinet::DB::OREADER)
             raise DictionaryError, "failed to open cabinet file #{path}: #{@db.error}"
           end
-        
+
         when :redis
           at_exit { ::Anystyle::Parser::Dictionary.instance.close }
           @db = Redis.new(options)
-          
+
           populate if @db.dbsize.zero?
-           
+
         else
           @db = Hash.new(0)
           populate
         end
-        
+
         @db
       end
-      
+
       def open?; !!@db; end
-      
+
       def close
         case
         when @db.respond_to?(:close)
-          @db.close 
+          @db.close
         when @db.respond_to?(:quit)
           @db.quit
         end
-        
+
         @db = nil
       end
-      
+
       def path
         case options[:mode]
         when :kyoto
@@ -178,13 +176,13 @@ module Anystyle
           'hash'
         end
       end
-            
+
       private
-  
+
       def db
         @db || open
       end
-            
+
       def populate
         require 'zlib'
 
@@ -193,7 +191,7 @@ module Anystyle
 
           Zlib::GzipReader.new(f).each do |line|
             line.strip!
-            
+
             if line.start_with?('#')
               case line
               when /^## male/i
@@ -214,7 +212,7 @@ module Anystyle
                 # skip comments
               end
             else
-              key, probability = line.split(/\s+(\d+\.\d+)\s*$/)
+              key = line.split(/\s+(\d+\.\d+)\s*$/)[0]
               value = self[key]
               self[key] = value + mode if value < mode
             end
@@ -222,8 +220,8 @@ module Anystyle
         end
 
       end
-            
+
     end
-  
+
   end
-end
+end