autochthon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a1f254369355f08917225c85eaddcdcefb8bd9c
+  data.tar.gz: 30406f867d0a4ace7af61e00eea0a72db6fd1cdc
+SHA512:
+  metadata.gz: a26e383f6411d3fa116d19ff66f6296f48942e43cd90c75542c7bafc49b7f28864192b87179b1d18765c38c7c1dba5e9202c5f7348f2c5161fc5e60f74448a3f
+  data.tar.gz: 762f221b17a4b6d5e11d5c506d0ac7bdc74cea6a2bbaf9f44f7b890cf454e5332bb3426388f53dc85f0457b649fdcb784585147092200f740445f1955793e4f8

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/web/node_modules/
+*.tern-port
+.ruby-version
+local
+capybara-*

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+gem 'activerecord'
+gem 'actionview'
+
+gem 'i18n'
+
+gem 'i18n-active_record',
+    :require => 'i18n/active_record'
+
+gem 'redis-i18n', '~> 0.6.5'
+
+group :test do
+  gem "pry"
+  gem "byebug"
+  gem "sqlite3"
+  gem "rspec"
+  gem 'capybara-webkit'
+  gem 'selenium-webdriver'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Adam Sokolnicki
+
+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,160 @@
+# Autochthon
+
+A simple Sinatra app for managing translations stored in YAML files, database or Redis.
+
+Look at this as [localeapp](https://www.localeapp.com/) hosted in your application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'autochthon', github: 'asok/autochthon
+```
+
+## Usage
+
+### Rails application with ActiveRecord backend
+
+#### Setup backend
+
+Add this to your Gemfile:
+
+```rb
+gem 'i18n-active_record', :require => 'i18n/active_record'
+```
+
+Create file `config/initializers/autochthon.rb` with content:
+
+```rb
+require 'i18n/backend/active_record'
+
+I18n.backend = Autochthon.backend = Autochthon::Backend::ActiveRecord.new
+
+Autochthon.mount_point = "your_mount_point"
+```
+
+Probably you will want to use memoize so you don't generate a bunch of queries on each request:
+
+```rb
+require 'i18n/backend/active_record'
+
+if I18n::Backend::ActiveRecord::Translation.table_exists?
+  I18n.backend = Autochthon.backend = Autochthon::Backend::ActiveRecord.new
+  I18n.backend.class.include(I18n::Backend::Memoize)
+end
+
+Autochthon.mount_point = "your_mount_point"
+```
+
+NOTE: this will not work when you have your web server running several ruby processes.
+That is the process in which you'll update the translation will see the new value for it. But other requests might be served by another process which will have the old value.
+If that's the case consider:
+* not using memoization
+* caching the translation with an expiration option
+* using redis backend without memoization
+
+#### Create table
+
+Create the translations table:
+
+```
+bundle exec rake autochthon:create
+```
+
+### Rails application with Redis backend
+
+#### Setup backend
+
+Add this to your Gemfile:
+
+```rb
+gem 'redis-i18n'
+```
+
+Create file `config/initializers/autochthon.rb` with content:
+
+```rb
+require 'i18n/backend/redis'
+
+I18n.backend = Autochthon.backend = Autochthon::Backend::Redis.new
+
+Autochthon.mount_point = "your_mount_point"
+```
+
+### Rails application with Simple (YAML) backend
+
+NOTE: this backend operates in memory only. Meaning that your translations will not be persisted anywhere.
+
+Create file `config/initializers/autochthon.rb` with content:
+
+```rb
+I18n.backend = Autochthon.backend = Autochthon::Backend::Simple.new
+
+Autochthon.mount_point = "your_mount_point"
+```
+
+### Mount
+
+Add this to the routes:
+
+```rb
+mount Autochthon::Web => Autochthon.mount_point, :as => 'autochthon''
+```
+
+Probably you will want to authenticate. In case you are using [devise](https://github.com/plataformatec/devise) you can do:
+
+```rb
+authenticate(:admin) do
+  mount Autochthon::Web => '/autochthon', :as Autochthon.mount_point
+end
+```
+
+### Import
+
+You can import existing translations from the I18n's simple backend (YAML files):
+
+```
+rake autochthon:import
+```
+
+If you want to only import specific locales you can do so:
+
+```
+LOCALES="en,fr" rake autochthon:import
+```
+
+### Filling missing translations via right click
+
+In your `app/assets/javascripts/application.js` file do:
+
+```js
+//= require 'autochthon/application'
+```
+
+Now you can right click on the missing translations to fill them in.
+
+## Examples
+
+* rails application using ActiveRecord backend https://github.com/asok/autochthon_rails_example_app
+
+## Development
+
+In the dir `web/` run `npm install` fallowed by `npm run watch`.
+
+That will compile the js files and put them in `public/bundle.js`.
+
+Note: for a release you can run `npm run build`.
+
+### Testing
+
+`bundle exec rspec`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/asok/autochthon.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/autochthon.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'autochthon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "autochthon"
+  spec.version       = Autochthon::VERSION
+  spec.authors       = ["Adam Sokolnicki"]
+  spec.email         = ["adam.sokolnicki@gmail.com"]
+
+  spec.summary       = %q{Sinatra app for managing I18n translations}
+  spec.description   = %q{Sinatra app for managing I18n translations stored in YAML files, database or Redis}
+  spec.homepage      = "https://github.com/asok/autochthon"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "sinatra"
+  spec.add_dependency "sinatra-contrib"
+  spec.add_dependency "i18n"
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "local"
+
+require "pry"
+Pry.start

data/config.ru

@@ -0,0 +1,3 @@
+require './lib/autochthon/web'
+
+run Autochthon::Web

data/lib/autochthon.rb

@@ -0,0 +1,28 @@
+require "autochthon/version"
+require "autochthon/web"
+require 'autochthon/engine'
+require 'autochthon/backend/simple'
+require 'autochthon/backend/active_record'
+require 'autochthon/backend/redis'
+
+module Autochthon
+  module Methods
+    def backend=(backend)
+      @@backend = backend
+    end
+
+    def backend
+      @@backend
+    end
+
+    def mount_point=(mount_point)
+      @@mount_point = mount_point
+    end
+
+    def mount_point
+      @@mount_point
+    end
+  end
+
+  extend Methods
+end

data/lib/autochthon/backend/active_record.rb

@@ -0,0 +1,36 @@
+require 'autochthon/backend/fetching_all'
+
+begin
+  require 'i18n/backend/active_record'
+
+  module Autochthon
+    module Backend
+      class ActiveRecord
+        include I18n::Backend::ActiveRecord::Implementation
+
+        include FetchingAll
+
+        def all_for_locale(locale)
+          Hash[I18n::Backend::ActiveRecord::Translation
+                 .where(locale: locale)
+                 .pluck(:key, :value)]
+        end
+
+        class Migration < ::ActiveRecord::Migration
+          def change
+            create_table :translations do |t|
+              t.string :locale
+              t.string :key
+              t.text   :value
+              t.text   :interpolations
+              t.boolean :is_proc, default: false
+
+              t.timestamps null: false
+            end
+          end
+        end
+      end
+    end
+  end
+rescue LoadError
+end

data/lib/autochthon/backend/fetching_all.rb

@@ -0,0 +1,20 @@
+module Autochthon
+  module Backend
+    module FetchingAll
+      include I18n::Backend::Flatten
+
+      def all(locales = available_locales)
+        locales.inject([]) do |out, locale|
+          flatten_keys(all_for_locale(locale), false) do |key, value|
+            out << {key: key, value: value, locale: locale}
+          end
+          out
+        end
+      end
+
+      def all_for_locale(locale)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/autochthon/backend/redis.rb

@@ -0,0 +1,19 @@
+begin
+  require 'i18n/backend/redis'
+
+  module Autochthon
+    module Backend
+      class Redis < I18n::Backend::Redis
+        include FetchingAll
+
+        def all_for_locale(locale)
+          store.keys("#{locale}.*").inject({}) do |translations, key|
+            main_key = key[(locale.size+1)..-1]
+            translations.merge(main_key => translate(locale, main_key))
+          end
+        end
+      end
+    end
+  end
+rescue LoadError
+end

data/lib/autochthon/backend/simple.rb

@@ -0,0 +1,15 @@
+require 'autochthon/backend/fetching_all'
+
+module Autochthon
+  module Backend
+    class Simple
+      include I18n::Backend::Simple::Implementation
+
+      include FetchingAll
+
+      def all_for_locale(locale)
+        translate(locale, ".")
+      end
+    end
+  end
+end

data/lib/autochthon/engine.rb

@@ -0,0 +1,9 @@
+module Autochthon
+  class Engine < ::Rails::Engine
+    isolate_namespace Autochthon
+
+    rake_tasks do
+      load 'autochthon/tasks/rails.rake'
+    end
+  end
+end if defined?(::Rails)

data/lib/autochthon/tasks/rails.rake

@@ -0,0 +1,28 @@
+require 'autochthon/backend/active_record'
+
+namespace :autochthon do
+  desc "Create translations table"
+  task create: :environment do
+    Autochthon::Backend::ActiveRecord::Migration.new.change
+  end
+
+  desc "Reads all translations from yml files and inserts them into db"
+  task import: :environment do
+    backend = Autochthon::Backend::Simple.new
+
+    locales = (ENV['LOCALES'] || '').split(',')
+    locales = backend.available_locales if locales.empty?
+
+    fn = -> do
+      backend.all(locales).each do |t|
+        Autochthon.backend.store_translations(t[:locale], {t[:key] => t[:value]})
+      end
+    end
+
+    if Autochthon.backend.class == Autochthon::Backend::ActiveRecord
+      ActiveRecord::Base.transaction(&fn)
+    else
+      fn.call
+    end
+  end
+end