russial 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12a9817811bb18c4db5e3e76a55a30b40314f3cd
+  data.tar.gz: 388f5d2fbc99e206752af8149deda298ebb3ebb7
+SHA512:
+  metadata.gz: 36bded35eeaee2eefdf0a1f513c5fbaf726b32cab1bebea1abc6450dd9dc8482c74b88160793290706e60936aa2053e44bb13e6b0ce42baf3f725ca2de7ba073
+  data.tar.gz: d2ea1c6472e0ecdb0dc4eef1d2ceb9aaf35fc10e74442ccfdf0cb31d63d3587c05071123236a2b500b2bc42c1c83b2aa90f148c277be6efdd46ec3312f735f6b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - "**/Rakefile"
+    - "**/Gemfile"
+    - "**/*.gemspec"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3.0
+  - 2.2.0
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in russial.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mesto.ru
+
+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.md

@@ -0,0 +1,151 @@
+# Russial
+
+An easy way to make word declension.
+
+## Installation
+
+Add this line to your application's Gemfile:
+~~~
+gem "russial"
+~~~
+
+And then execute:
+~~~
+$ bundle
+~~~
+
+Or install it yourself as:
+
+~~~
+$ gem install russial
+~~~
+
+**Note:** for Rubies less than 2.3.0 we use `backport_dig` gem, but we strongly recommend you to upgrade your Ruby version to the last one.
+
+## Usage
+
+The Russial gem automatically works with any structures that you pass as dictionary. You can use it with plain Ruby or I18n/Rails.
+
+### Plain Ruby
+
+With plain Ruby it's looks like:
+
+~~~
+ruby_dictionary = {
+  ruby: {
+    singular: {
+      nominative: "рубин",
+      genitive: "рубина",
+      dative: "рубину",
+      accusative: "рубин",
+      instrumental: "рубином",
+      prepositional: "рубине"
+    },
+    plural: {
+      nominative: "рубины",
+      genitive: "рубинов",
+      dative: "рубинам",
+      accusative: "рубины",
+      instrumental: "рубинами",
+      prepositional: "рубинах"
+    }
+  }   
+}
+
+word = Russial.new("ruby", dictionary: ruby_dictionary)
+
+# Default state is singular
+word.dative # "рубину"
+
+# Save state
+plural_word = word.plural
+
+# Get cases of plural form
+plural_word.genitive # "рубинов"
+plural_word.instrumental # "рубинами"
+~~~
+
+### With I18n/Rails
+
+With I18n/Rails support you need to add dictionary to locales. For example in file *`russial.yml`*:
+
+~~~
+ru:
+  russial:
+    идти:
+      future: пройдёт
+      past:
+        singular:
+          male: прошёл
+          female: прошла
+        plural: прошли
+      present: проходит
+~~~
+
+And then:
+
+~~~
+# Rails wiil do this automatically
+I18n.tap do |c|
+  c.available_locales = [:ru]
+  c.locale = :ru
+  c.load_path = ["russial.yml"]
+end
+
+word = Russial.new("идти")
+
+word.future # "пройдёт"
+word.reset.past.singular.male # "прошёл"
+word.reset.past.singular.female # "прошла"
+~~~
+
+## Settings
+
+You can configure this gem. Add settings to initializers.
+
+### Aliases
+
+Add shorthands for any keys you want.
+
+~~~
+Russial.configure do |c|
+  c.aliases = {
+    n: :nominative,
+    g: :genitive,
+    d: :dative,
+    a: :accusative,
+    i: :instrumental,
+    p: :prepositional
+  }.freeze
+end
+~~~
+
+And then:
+
+~~~
+word = Russial.new("ruby", dictionary: ruby_dictionary)
+
+word.d # "рубину"
+word.plural.g # "рубинов"
+word.reset.plural.i # "рубинами"
+~~~
+
+### Scope for I18n
+
+Change the root scope for I18n search.
+
+~~~
+described_class.configure do |c|
+  c.i18n_scope = "russial"
+end
+~~~
+
+Default is `russial`.
+
+## Contribute
+
+Feel free to add pull requests and issues.
+
+## License
+  
+See LICENSE for license information.

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "russial"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/russial.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require "backport_dig" unless {}.respond_to?(:dig)
+
+require "russial/version"
+require "russial/config"
+require "russial/config/configuration"
+require "russial/dictionary/default_scope"
+require "russial/dictionary/dynamic_methods"
+require "russial/dictionary/initializer"
+require "russial/dictionary/i18n"
+
+class Russial
+  include Dictionary::DefaultScope
+  include Dictionary::I18n if defined?(I18n)
+  prepend Dictionary::DynamicMethods
+  prepend Dictionary::Initializer
+  extend  Config::Configuration
+
+  def initialize(word, dictionary: {})
+    @word = word.to_sym
+    @dictionary = prepare_dictionary(dictionary)
+    @path = []
+  end
+
+  def reset
+    reset_path
+    self
+  end
+
+  private
+
+  attr_reader :dictionary, :word
+  attr_accessor :path
+
+  def soft_reset_path
+    path.pop
+  end
+
+  def reset_path
+    self.path = []
+  end
+
+  def result
+    dictionary.dig(*path) || super
+  end
+end

data/lib/russial/config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+class Russial
+  class Config
+    attr_accessor :aliases, :i18n_scope
+
+    def initialize
+      @aliases = {}
+      @i18n_scope = :russial
+    end
+  end
+end

data/lib/russial/config/configuration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+class Russial
+  class Config
+    module Configuration
+      attr_writer :config
+
+      def config
+        @config ||= Config.new
+      end
+
+      def reset
+        @config = Config.new
+      end
+
+      def configure
+        yield(config)
+      end
+    end
+  end
+end

data/lib/russial/dictionary/default_scope.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+class Russial
+  module Dictionary
+    module DefaultScope
+      def default_scope
+        @default_scope ||= keys.first.scope
+      end
+
+      def result
+        dictionary.dig(*default_scope, path.last)
+      end
+    end
+  end
+end

data/lib/russial/dictionary/dynamic_methods.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+class Russial
+  module Dictionary
+    module DynamicMethods
+      def initialize(*)
+        super
+        generate_methods
+        generate_aliases
+      end
+
+      private
+
+      def generate_methods
+        keys.each do |key|
+          name = key.name
+          define_singleton_method(name) do
+            path << name unless path.include? name
+            get
+          end
+        end
+      end
+
+      def generate_aliases
+        singleton_class.class_eval do
+          superclass.config.aliases.each { |a, m| alias_method a, m }
+        end
+      end
+
+      def get
+        case (memoized_result = result)
+        when Hash
+          self
+        when String
+          soft_reset_path
+          memoized_result
+        end
+      end
+
+      def keys
+        @keys ||= extract_keys(dictionary).flatten
+      end
+
+      def extract_keys(hash, scope = [])
+        hash.map do |k, v|
+          if v.is_a? Hash
+            extract_keys(v, scope + [k]) << Key.new(k, scope)
+          else
+            [Key.new(k, scope)]
+          end
+        end
+      end
+
+      Key = Struct.new(:name, :scope)
+    end
+  end
+end

data/lib/russial/dictionary/i18n.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require "i18n"
+
+class Russial
+  module Dictionary
+    module I18n
+      private
+
+      def prepare_dictionary(*)
+        ::I18n.t(word, scope: self.class.config.i18n_scope)
+      end
+    end
+  end
+end

data/lib/russial/dictionary/initializer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+class Russial
+  module Dictionary
+    module Initializer
+      private
+
+      def prepare_dictionary(dictionary)
+        dictionary[word] || super
+      rescue NoMethodError
+        {}
+      end
+    end
+  end
+end

data/lib/russial/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+class Russial
+  VERSION = "0.5.0"
+end

data/russial.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "russial/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "russial"
+  spec.version       = Russial::VERSION
+  spec.authors       = ["Mesto.ru"]
+  spec.email         = ["jt@mesto.ru"]
+
+  spec.summary       = "Plain interface for word declension."
+  spec.description   = "Get a simple way for case inflection."
+  spec.homepage      = "https://github.com/mestoru/russial"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.2.0"
+
+  spec.add_dependency "backport_dig", "0.0.2" if RUBY_VERSION < "2.3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "i18n", "~> 0.7.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: russial
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Mesto.ru
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+description: Get a simple way for case inflection.
+email:
+- jt@mesto.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/russial.rb
+- lib/russial/config.rb
+- lib/russial/config/configuration.rb
+- lib/russial/dictionary/default_scope.rb
+- lib/russial/dictionary/dynamic_methods.rb
+- lib/russial/dictionary/i18n.rb
+- lib/russial/dictionary/initializer.rb
+- lib/russial/version.rb
+- russial.gemspec
+homepage: https://github.com/mestoru/russial
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Plain interface for word declension.
+test_files: []