i18n_backend_mongoid 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93fea5a9ab62b8f821275ecea2b4f56f95fc6eb0
+  data.tar.gz: 0f87be98b29aa663a0faedce12fd093a4131edb1
+SHA512:
+  metadata.gz: 3bf1cc45cddf867c0446dfdd6e4b0d13f22cb36b94a844a52eefa4c3589b8c4a3c400928434f40f2786002118344094ee0a06eb45ede784dfe97ebb7087918cb
+  data.tar.gz: b489b454f8b59b4d990b5414bc3e64caec84fd9cc9e93c06600589e329ea72b2f00c87137c770bfbb3e22a91e686c987846bfc8b1c0a0486fbf66264504e1750

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.1

data/Gemfile

@@ -0,0 +1 @@
+source 'https://rubygems.org'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alexandr Turchyn, Victor Rubych
+
+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,46 @@
+# i18n_backend_mongoid
+
+Store I18n translations in MongoDB
+
+## Dependency
+
+```ruby
+gem 'rails-i18n'
+gem 'mongoid'
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'i18n_backend_mongoid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install i18n_backend_mongoid
+
+## Usage
+
+    rails g i18n_backend_mongoid:install TRANSLATION_TABLE_NAME
+
+## Uninstall
+
+    rails d i18n_backend_mongoid:install TRANSLATION_TABLE_NAME
+
+## Contributing
+
+    1. Fork it ( https://github.com/webmil/i18n_backend_mongoid/fork )
+    2. Create your feature branch (`git checkout -b my-new-feature`)
+    3. Commit your changes (`git commit -am 'Add some feature'`)
+    4. Push to the branch (`git push origin my-new-feature`)
+    5. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+Dir.glob('lib/tasks/*.rake').each { |rake| import rake }
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'i18n_backend_mongoid'
+
+# 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 'irb'
+IRB.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/i18n_backend_mongoid.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'i18n_backend_mongoid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'i18n_backend_mongoid'
+  spec.version       = I18nBackendMongoid::VERSION
+  spec.authors       = ['Alexandr Turchyn', 'Victor Rubych']
+  spec.email         = ['lexfox777@gmail.com', 'rubych@webmil.eu']
+
+  spec.summary       = 'United I18n backend simple with mongoid provider.'
+  spec.description   = 'United I18n backend simple with mongoid provider'
+  spec.homepage      = 'https://github.com/webmil/i18n_backend_mongoid'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency 'rspec', '~> 3.4.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'bundler', '~> 1.7'
+  # spec.add_dependency 'rails_admin', '~> 1.0'
+  spec.add_dependency 'mongoid'
+  spec.add_dependency 'rails-i18n'
+end

data/lib/generators/i18n_backend_mongoid/install_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators/base'
+require 'generators/utils'
+
+module I18nBackendMongoid
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include I18nBackendMongoid::Generators::Utils::InstanceMethods
+      source_root File.expand_path('../../templates', __FILE__)
+
+      argument :translation_table_name, type: :string
+
+      def copy_initializer
+        if libraries_available?('mongoid', 'rails-i18n')
+          template 'translation.rb.erb', "app/models/#{table_name.downcase}.rb"
+          template 'locale.rb.erb', 'config/initializers/locale.rb'
+        else
+          say('Mongoid or rails-i18n aren\'t installed!', :yellow)
+        end
+      end
+
+      private
+
+      def table_name
+        translation_table_name.downcase.capitalize
+      end
+    end
+  end
+end

data/lib/generators/templates/locale.rb.erb

@@ -0,0 +1 @@
+I18n.backend = I18n::Backend::Chain.new(I18n::Backend::Mongoid.new(<%= table_name %>), I18n::Backend::Simple.new)

data/lib/generators/templates/translation.rb.erb

@@ -0,0 +1,6 @@
+class <%= table_name %>
+  include Mongoid::Document
+  include I18nBackendMongoid::Translateble
+
+  store_in collection: 'i18n'
+end

data/lib/generators/utils.rb

@@ -0,0 +1,77 @@
+require 'pathname'
+require 'fileutils'
+require 'tempfile'
+include FileUtils
+
+module I18nBackendMongoid
+  module Generators
+    module Utils
+      module InstanceMethods
+        @@gemfile_path = "#{Rails.root}/Gemfile"
+
+        def yes_no(question)
+          is_valid = true
+          question += ' [Y/N] '
+          while is_valid
+            answer = ask(question, :yellow) do |yn|
+              yn.limit = 1, yn.validate = /[yn]/i
+            end
+            answer.downcase!
+            is_valid = (answer == 'y' || answer == 'n') ? false : true
+          end
+          answer
+        end
+
+        def library_available?(gem_name)
+          require gem_name
+          return true
+        rescue LoadError
+          return false
+        end
+
+        def libraries_available?(*gems)
+          is_available = true
+          gems.each do |gem|
+            return false unless library_available?(gem)
+          end
+          is_available
+        end
+
+        def file?(path)
+          File.exist?(path)
+        end
+
+        def install_gem(_gem_name, version = nil)
+          gem = "gem '" + gem_configurename + "'"
+          gem += (", '~> " + version + "'") if version
+
+          unless file_include?(@@gemfile_path, gem)
+            open(@@gemfile_path, 'a') { |f| f.puts gem }
+          end
+
+          system 'bundle install'
+        end
+
+        def replace(path, pattern, new_line)
+          t_file = Tempfile.new('temp.rb')
+          File.open(path, 'r') do |f|
+            f.each_line do |line|
+              t_file.puts(line.include?(pattern)) ? new_line : line
+            end
+          end
+          t_file.close
+          FileUtils.mv(t_file.path, path)
+        end
+
+        def file_include?(path, include)
+          File.open(path, 'r') do |f|
+            f.each_line do |line|
+              return true if line.include? include
+            end
+          end
+          false
+        end
+      end
+    end
+  end
+end

data/lib/i18n_backend_mongoid.rb

@@ -0,0 +1,13 @@
+require 'i18n_backend_mongoid/i18n/backend/mongoid'
+require 'i18n_backend_mongoid/translateble'
+
+module I18nBackendMongoid
+end
+
+begin
+  require 'rails'
+rescue LoadError
+  #do nothing
+end
+
+require 'i18n_backend_mongoid/version'

data/lib/i18n_backend_mongoid/i18n/backend/mongoid.rb

@@ -0,0 +1,91 @@
+require 'i18n/backend/base'
+
+module I18n
+  module Backend
+    class Mongoid
+      module Implementation
+        attr_accessor :model
+        include Base, Flatten
+
+        def initialize(model)
+          @model = model
+          init_translations
+        end
+
+        def initialized?
+          @initialized ||= false
+        end
+
+        # Stores translations for the given locale in memory.
+        # This uses a deep merge for the translations hash, so existing
+        # translations will be overwritten by new ones only at the deepest
+        # level of the hash.
+        def store_translations(locale, data, options = {})
+          locale = locale.to_sym
+          translations[locale] ||= {}
+          data = data.deep_symbolize_keys
+          translations[locale].deep_merge!(data)
+        end
+
+        # Get available locales from the translations hash
+        def available_locales
+          init_translations unless initialized?
+          translations.inject([]) do |locales, (locale, data)|
+            locales << locale unless (data.keys - [:i18n]).empty?
+            locales
+          end
+        end
+
+        # Clean up translations hash and set initialized to false on reload!
+        def reload!
+          @initialized = false
+          @translations = nil
+          init_translations
+        end
+
+        protected
+
+        def init_translations
+          load_translations
+          @initialized = true
+        end
+
+        def load_translations
+          @translations = {}
+          @model.all.each do |record|
+            I18n.available_locales.each do |loc|
+              next unless record.value_translations.key?(loc)
+              k = I18n.normalize_keys(loc, record.key, [])
+              k.shift
+              store_translations(loc, k.reverse.inject(record.value_translations[loc]) { |a, n| { n => a } })
+            end
+          end
+        end
+
+        def translations
+          @translations ||= {}
+        end
+
+        # Looks up a translation from the translations hash. Returns nil if
+        # eiher key is nil, or locale, scope or key do not exist as a key in the
+        # nested translations hash. Splits keys or scopes containing dots
+        # into multiple keys, i.e. <tt>currency.format</tt> is regarded the same as
+        # <tt>%w(currency format)</tt>.
+        def lookup(locale, key, scope = [], options = {})
+          init_translations unless initialized?
+          keys = I18n.normalize_keys(locale, key, scope, options[:separator])
+
+          keys.inject(translations) do |result, k|
+            k = k.to_sym
+            return nil unless result.is_a?(Hash) && result.key?(k)
+            result = result.is_a?(Symbol) ? resolve(locale, k, result, options.merge(scope: nil)) : result[k]
+
+            result
+          end
+        end
+      end
+
+      include Implementation
+    end
+  end
+end

data/lib/i18n_backend_mongoid/translateble.rb

@@ -0,0 +1,15 @@
+module I18nBackendMongoid
+  module Translateble
+    extend ActiveSupport::Concern
+    included do
+      after_save do
+        I18n.backend.reload!
+      end
+
+      field :key, type: String
+      field :value, type: String, localize: true
+
+      validates :key, presence: true, uniqueness: true
+    end
+  end
+end

data/lib/i18n_backend_mongoid/version.rb

@@ -0,0 +1,3 @@
+module I18nBackendMongoid
+  VERSION = '0.1.1'.freeze
+end

data/lib/tasks/i18n_backend_mongoid.rake

@@ -0,0 +1,11 @@
+namespace :i18n_backend_mongoid do
+  desc 'Install i18n_backend_mongoid'
+  task :install do
+    system 'rails g i18n_backend_mongoid:install'
+  end
+
+  desc 'Uninstall i18n_backend_mongoid'
+  task :uninstall do
+    system 'rails d i18n_backend_mongoid:install'
+  end
+end

data/spec/i18n_backend_mongoid_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe I18nBackendMongoid do
+  it 'has a version number' do
+    expect(I18nBackendMongoid::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'i18n'
+require 'active_support'
+require 'i18n_backend_mongoid'

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: i18n_backend_mongoid
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alexandr Turchyn
+- Victor Rubych
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails-i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: United I18n backend simple with mongoid provider
+email:
+- lexfox777@gmail.com
+- rubych@webmil.eu
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- i18n_backend_mongoid.gemspec
+- lib/generators/i18n_backend_mongoid/install_generator.rb
+- lib/generators/templates/locale.rb.erb
+- lib/generators/templates/translation.rb.erb
+- lib/generators/utils.rb
+- lib/i18n_backend_mongoid.rb
+- lib/i18n_backend_mongoid/i18n/backend/mongoid.rb
+- lib/i18n_backend_mongoid/translateble.rb
+- lib/i18n_backend_mongoid/version.rb
+- lib/tasks/i18n_backend_mongoid.rake
+- spec/i18n_backend_mongoid_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/webmil/i18n_backend_mongoid
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: United I18n backend simple with mongoid provider.
+test_files: []
+has_rdoc: