yaroslav-yandex_inflect 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Yaroslav Markin
+
+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,33 @@
+= YandexInflect
+
+Yandex.Inflect webservice client (provides Russian language pluralization)
+
+Клиент сервиса Яндекс.Склонятор (склонение слов на русском языке)
+
+* http://nano.yandex.ru/project/inflect/
+* http://nano.yandex.ru/post/27/
+
+== Установка
+
+Установка в качестве gem с GitHub:
+
+  gem sources -a http://gems.github.com
+  gem install yaroslav-yandex_inflect
+  
+== Использование
+
+  > YandexInflect.inflections("рубин")
+  => ["рубин", "рубина", "рубину", "рубин", "рубином", "рубине"]
+  > YandexInflect.inflections("ЭтогоСловаНетВСловаре")
+  => ["ЭтогоСловаНетВСловаре", "ЭтогоСловаНетВСловаре", "ЭтогоСловаНетВСловаре", 
+      "ЭтогоСловаНетВСловаре", "ЭтогоСловаНетВСловаре", "ЭтогоСловаНетВСловаре"]
+  
+Если во время общения с веб-сервисом произошла ошибка, возвращается массив, забитый оригинальной строкой.
+
+Успешные ответы от веб-сервиса кешируются, кеш можно очистить с помощью
+
+  > YandexInflect.clear_cache
+
+== Автор
+
+* Ярослав Маркин <yaroslav@markin.net>

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'rubygems/specification'
+require 'date'
+
+GEM = "yandex_inflect"
+GEM_VERSION = "0.0.2"
+AUTHOR = "Yaroslav Markin"
+EMAIL = "yaroslav@markin.net"
+HOMEPAGE = "http://github.com/yaroslav/yandex_inflect/"
+SUMMARY = "Yandex.Inflect webservice client (Russian language inflection)"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  # Uncomment this to add a dependency
+  s.add_dependency "httparty"
+  
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(LICENSE README.rdoc Rakefile TODO init.rb) + Dir.glob("{lib,spec}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+task :default => :spec
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/init.rb

@@ -0,0 +1,3 @@
+# Rails plugin init
+require 'yandex_inflect'
+

data/lib/yandex_inflect.rb

@@ -0,0 +1,75 @@
+$KCODE = 'u'
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'httparty'
+
+module YandexInflect
+  # Число доступных вариантов склонений
+  INFLECTIONS_COUNT = 6
+  
+  # Класс для получения данных с веб-сервиса Яндекса.
+  class Inflection
+    include HTTParty
+    base_uri 'http://export.yandex.ru/'
+
+    # Получить склонения для имени <tt>name</tt>
+    def get(name)
+      options = {}
+      options[:query] = { :name => name }
+      inflections = self.class.get("/inflect.xml", options)
+      
+      return inflections["inflections"]["inflection"]
+    end
+  end
+  
+  # Кеширование успешных результатов запроса к веб-сервису
+  @@cache = {}
+  
+  # Возвращает массив склонений (размером <tt>INFLECTIONS_COUNT</tt>) для слова <tt>word</tt>.
+  #
+  # Если слово не найдено в словаре, будет возвращен массив размерностью <tt>INFLECTIONS_COUNT</tt>,
+  # заполненный этим словом.
+  def self.inflections(word)
+    inflections = []
+    
+    # TODO ugly
+    lookup = cache_lookup(word) 
+    return lookup if lookup
+    
+    get = Inflection.new.get(word) rescue nil # если поднято исключение, переходим к третьему варианту и не кешируем
+    case get
+      when Array then 
+        # Яндекс вернул массив склонений
+        inflections = get
+        # Кладем в кеш
+        cache_store(word, inflections)
+      when String then 
+        # Яндекс не вернул массива склонений (слово не найдено в словаре),
+        # а только строку, то забиваем этой строкой весь массив 
+        inflections.fill(get, 0..INFLECTIONS_COUNT-1)
+        # Кладем в кеш
+        cache_store(word, inflections)
+      else
+        # Забиваем варианты склонений оригиналом
+        inflections.fill(word, 0..INFLECTIONS_COUNT-1)
+    end
+ 
+    inflections
+  end
+  
+  def self.clear_cache
+    @@cache.clear
+  end
+  
+  private
+    def self.cache_lookup(word)
+      @@cache[word.to_s]
+    end
+  
+    def self.cache_store(word, value)
+      @@cache[word.to_s] = value
+    end
+end

data/lib/yandex_inflect/version.rb

@@ -0,0 +1,9 @@
+module YandexInflect
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'yandex_inflect'

data/spec/yandex_inflect_spec.rb

@@ -0,0 +1,77 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe YandexInflect do
+  before(:all) do
+    @sample_inflection = ["рубин", "рубина", "рубину", "рубин", "рубином", "рубине"]
+  end
+  
+  before(:each) do
+    @inflection = mock(:inflection)
+    YandexInflect::clear_cache
+  end
+
+  it "should return an array of inflections when webservice returns an array" do
+    @inflection.stub!(:get).and_return(@sample_inflection)
+    YandexInflect::Inflection.should_receive(:new).and_return(@inflection)
+    YandexInflect.inflections("рубин").should == @sample_inflection
+  end
+
+  it "should return an array filled with identical strings when webservice returns a string" do
+    @inflection.stub!(:get).and_return("рубин1")
+    YandexInflect::Inflection.should_receive(:new).and_return(@inflection)
+    YandexInflect.inflections("рубин").should == %w(рубин1 рубин1 рубин1 рубин1 рубин1 рубин1)
+  end
+
+  it "should return an array filled with identical strings of original word when webservice does not return anything meaningful or throws an exception" do
+    @inflection.stub!(:get).and_return(nil)
+    YandexInflect::Inflection.should_receive(:new).and_return(@inflection)
+    YandexInflect.inflections("рубин").should == %w(рубин рубин рубин рубин рубин рубин)
+  end
+end
+
+describe YandexInflect, "with caching" do
+  before(:each) do
+    @inflection = mock(:inflection)
+    YandexInflect::clear_cache
+  end
+
+  it "should cache successful lookups" do
+    sample = ["рубин", "рубина", "рубину", "рубин", "рубином", "рубине"]
+    @inflection.stub!(:get).and_return(sample)
+    YandexInflect::Inflection.should_receive(:new).once.and_return(@inflection)
+    
+    2.times { YandexInflect.inflections("рубин") }
+  end
+  
+  it "should NOT cache unseccussful lookups" do
+    sample = nil
+    @inflection.stub!(:get).and_return(sample)
+    YandexInflect::Inflection.should_receive(:new).twice.and_return(@inflection)
+    
+    2.times { YandexInflect.inflections("рубин") }
+  end
+  
+  it "should allow to clear cache" do
+    sample = "рубин"
+    @inflection.stub!(:get).and_return(sample)
+    YandexInflect::Inflection.should_receive(:new).twice.and_return(@inflection)
+    
+    YandexInflect.inflections("рубин")
+    YandexInflect.clear_cache
+    YandexInflect.inflections("рубин")
+  end
+end
+
+describe YandexInflect::Inflection do
+  before(:all) do
+    @sample_answer = {
+      "inflections"=>{"inflection"=>["рубин", "рубина", "рубину", "рубин", "рубином", "рубине"], "original"=>"рубин"}
+    }
+    @sample_inflection = ["рубин", "рубина", "рубину", "рубин", "рубином", "рубине"]
+  end
+  
+  it "should get inflections for a word" do
+    YandexInflect::Inflection.should_receive(:get).and_return(@sample_answer)
+    YandexInflect::Inflection.new.get("рубин").should == @sample_inflection
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: yaroslav-yandex_inflect
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Yaroslav Markin
+autorequire: yandex_inflect
+bindir: bin
+cert_chain: []
+
+date: 2008-09-09 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Yandex.Inflect webservice client (Russian language inflection)
+email: yaroslav@markin.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- init.rb
+- lib/yandex_inflect
+- lib/yandex_inflect/version.rb
+- lib/yandex_inflect.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/yandex_inflect_spec.rb
+has_rdoc: true
+homepage: http://github.com/yaroslav/yandex_inflect/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Yandex.Inflect webservice client (Russian language inflection)
+test_files: []
+