freeling-client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22175d4562553eaba3d4d095df0cf9277813cfb7
-  data.tar.gz: 3e62780a11bab00955217a164a8aa1dfa342b952
+  metadata.gz: 62a4acda4bd1089ad98e20cab65faed5e708cf02
+  data.tar.gz: c8d8cce46008af061eb11129376d7cc12563b2b0
 SHA512:
-  metadata.gz: b4042283e88acaa32d476ce2575bef9f7611a798acb0b00d8c061bfec78c2aed66b8fa0b9295053d484b5a5fd8e25323f70a137a5a5a3205b3e54e349a1c2a69
-  data.tar.gz: 249cf116647b29dba7a8b5d6286cf6a53edf4d1d6cd58ae016ebc5a5afe696e34627c13c6d7831e1c6e18bec73ad5e3f1379a91e6688a281e71626cb3a5c2c01
+  metadata.gz: a8a56248656d3176eef293c7dd121838e889605f88f0b1d4a913f0e0698afbc4aa771455174dc838e9faccd9648968f0440aa8c598a929a575288bfe56f775e0
+  data.tar.gz: 7ae997ecc681f90b20e36679c58d898f6c3f3af7a5bc9d68cfe0b8f4191bf622cee5aab7310cfd28c085d80be9d8206faa436261ef3e1ebfcd34c1e5ae9300d9

data/Gemfile.lock

@@ -1,13 +1,11 @@
 PATH
   remote: .
   specs:
-    freeling-client (0.0.1)
-      hashie (~> 3)
+    freeling-client (0.0.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    hashie (3.3.2)
     minitest (5.4.3)
     rake (10.3.2)
 

data/README.md

@@ -60,3 +60,7 @@ With `nec` analysis:
 
     FREELINGSHARE=/usr/local/share/freeling/ analyzer \
     -f config/freeling/analyzer.cfg --server --port 50005 --inpf plain --outf tagged --nec --noflush
+
+## Testing Freeling stand-alone
+
+    FREELINGSHARE=/usr/local/share/freeling/ analyzer -f config/freeling/analyzer.cfg --inpf plain --locale es_ES.UTF-8 --outf morfo --noflush < file.txt

data/freeling-client.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |s|
   s.test_files  = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.add_dependency "hashie", "~> 3"
   s.add_development_dependency "bundler", "~> 1.7"
   s.add_development_dependency "rake", "~> 10.3"
   s.add_development_dependency "minitest", "~> 5"

data/lib/freeling_client/analyzer.rb

@@ -5,50 +5,27 @@ require "open3"
 require "tempfile"
 require "timeout"
 
-require "hashie/mash"
 require "freeling_client/base"
 
 
 module FreelingClient
   class Analyzer < Base
-
-    Token = Class.new(Hashie::Mash)
-
     def initialize(opt={})
       @config = opt.fetch(:config, 'config/freeling/analyzer.cfg')
-      @port = opt[:port]
-      @server = opt[:server]
       @timeout = opt.fetch(:timeout, 60) # Three hours
     end
 
-    def call(cmd, text)
-      valide_command!(cmd)
-
-      output = []
-      file = Tempfile.new('foo', encoding: 'utf-8')
-      begin
-        file.write(text)
-        file.close
-        stdin, stdout, stderr = Open3.popen3(command(cmd, file.path))
-        Timeout::timeout(@timeout) {
-          until (line = stdout.gets).nil?
-            output << line.chomp
-          end
-
-          message = stderr.readlines
-          unless message.empty?
-            raise ExtractionError, message.join("\n")
-          end
-        }
-      rescue Timeout::Error
-        raise ExtractionError, "Timeout"
-      ensure
-        file.close
-        file.unlink
-      end
-      output
-    end
-
+    # Generate tokens for a given text
+    #
+    # Example:
+    #
+    #   >> analyzer = FreelingClient::Analyzer.new
+    #   >> analyzer.token(:morfo, "Este texto está en español.")
+    #
+    # Arguments:
+    #   cmd: (Symbol)
+    #   text: (String)
+    #
     def tokens(cmd, text)
       valide_command!(cmd)
       Enumerator.new do |yielder|
@@ -58,6 +35,18 @@ module FreelingClient
       end
     end
 
+    # Generate ptokens for a given text
+    # ptokens: Tokens with position
+    #
+    # Example:
+    #
+    #   >> analyzer = FreelingClient::Analyzer.new
+    #   >> analyzer.ptoken(:morfo, "Este texto está en español.")
+    #
+    # Arguments:
+    #   cmd: (Symbol)
+    #   text: (String)
+    #
     def ptokens(cmd, text)
       Enumerator.new do |yielder|
         pos = 0
@@ -79,9 +68,37 @@ module FreelingClient
       end
     end
 
+    def call(cmd, text)
+      valide_command!(cmd)
+
+      output = []
+      file = Tempfile.new('foo', encoding: 'utf-8')
+      begin
+        file.write(text)
+        file.close
+        stdin, stdout, stderr = Open3.popen3(command(cmd, file.path))
+        Timeout::timeout(@timeout) {
+          until (line = stdout.gets).nil?
+            output << line.chomp
+          end
+
+          message = stderr.readlines
+          unless message.empty?
+            raise ExtractionError, message.join("\n")
+          end
+        }
+      rescue Timeout::Error
+        raise ExtractionError, "Timeout"
+      ensure
+        file.close
+        file.unlink
+      end
+      output
+    end
+
     def parse_token_line(str)
       form, lemma, tag, prob = str.split(' ')[0..3]
-      Token.new({
+      FreelingClient::Token.new({
         :form => form,
         :lemma => lemma,
         :tag => tag,

data/lib/freeling_client/client.rb

@@ -4,12 +4,34 @@ require "freeling_client/base"
 
 module FreelingClient
   class Client < Base
+
+    # Initializes the client
+    #
+    # Example:
+    #
+    #   >> client = FreelingClient::Client.new
+    #
+    # Arguments:
+    #   server: (String)
+    #   port: (String)
+    #   timeout: (Integer)
+    #
     def initialize(opt = {})
       @server = opt.fetch(:server, 'localhost')
       @port = opt.fetch(:port, 50005)
       @timeout = opt.fetch(:timeout, 120)
     end
 
+    # Calls the server with a given text
+    #
+    # Example:
+    #
+    #   >> client = FreelingClient::Client.new
+    #   >> client.call("Este texto está en español.")
+    #
+    # Arguments:
+    #   text: (String)
+    #
     def call(text)
       output = []
       file = Tempfile.new('foo', encoding: 'utf-8')
@@ -38,6 +60,8 @@ module FreelingClient
       output
     end
 
+    private
+
     def command(file_path)
       "/usr/local/bin/analyzer_client #{server}:#{port} < #{file_path}"
     end

data/lib/freeling_client/language_detector.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "open3"
 require "freeling_client/base"
 
@@ -10,6 +12,17 @@ module FreelingClient
       @timeout = opt.fetch(:timeout, 120)
     end
 
+    # Detects language
+    #
+    # Example:
+    #
+    #   >> detector = FreelingClient::LanguageDetector.new
+    #   >> detector.detect("Este texto está en español.")
+    #   => "es"
+    #
+    # Arguments:
+    #   text: (String)
+    #
     def detect(text)
       output = []
       file = Tempfile.new('foo', encoding: 'utf-8')
@@ -38,6 +51,8 @@ module FreelingClient
       output[0].to_sym
     end
 
+    private
+
     def command(file_path)
       "/usr/local/bin/analyzer --outf ident --fidn #{ident} -f #{config} < #{file_path}"
     end

data/lib/freeling_client/token.rb

@@ -0,0 +1,18 @@
+module FreelingClient
+  class Token
+
+    attr_accessor :form, :lemma, :tag, :prob, :pos
+
+    def initialize(opt = {})
+      @form = opt[:form]
+      @lemma = opt[:lemma]
+      @tag = opt[:tag]
+      @prob = opt[:tag]
+    end
+
+    def [](key)
+      key = key.to_sym if key.is_a? String
+      self.send(key)
+    end
+  end
+end

data/lib/freeling_client/version.rb

@@ -1,3 +1,3 @@
 module FreelingClient
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/freeling_client.rb

@@ -1,5 +1,6 @@
 require "tempfile"
 require "freeling_client/version"
+require "freeling_client/token"
 require "freeling_client/analyzer"
 require "freeling_client/client"
 require "freeling_client/language_detector"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: freeling-client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Marcos Vanetta
@@ -10,20 +10,6 @@ bindir: bin
 cert_chain: []
 date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -85,6 +71,7 @@ files:
 - lib/freeling_client/base.rb
 - lib/freeling_client/client.rb
 - lib/freeling_client/language_detector.rb
+- lib/freeling_client/token.rb
 - lib/freeling_client/version.rb
 - start-freeling.sh
 - test/lib/freeling_client_test.rb