backend_translator 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,19 @@
+# BackendTranslator
+
+Provides a web interface for manage Rails I18n texts, storing translations in a key-value store.
+
+## Installation
+
+In Rails, add it to your Gemfile:
+
+```ruby
+gem 'backend_translator'
+```
+
+Run the bundle command to install it.
+
+After you install BackendTranslator, you need to run the generator:
+
+```console
+rails generate backend_translator:install
+```

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BackendTranslator'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/backend_translator/app.rb

@@ -0,0 +1,139 @@
+#---
+# Excerpted from "Crafting Rails Applications",
+# published by The Pragmatic Bookshelf.
+# Copyrights apply to this code. It may not be used to create training material, 
+# courses, books, articles, and the like. Contact us if you are in doubt.
+# We make no guarantees that this code is fit for any purpose. 
+# Visit http://www.pragmaticprogrammer.com/titles/jvrails for more book information.
+#---
+require 'sinatra/base'
+require 'haml'
+
+module BackendTranslator
+  class App < Sinatra::Base
+    set :environment, Rails.env
+    enable :inline_templates
+
+    #before do
+     # env["warden"].authenticate!(:scope => "admin")
+    #end
+
+    get "/:from/:to" do |from, to|
+      exhibit_translations(from, to)
+    end
+
+    post "/:from/:to" do |from, to|
+      I18n.backend.store_translations to, decoded_translations, :escape => false
+      BackendTranslator.store.save
+      @message = "Translations stored with success!"
+      exhibit_translations(from, to)
+    end
+
+    get "/:to" do |to|
+    	new_translation(to)
+    end
+
+    post "/:to" do |to|
+			I18n.backend.store_translations to, {params[:key] => params[:value]}, :escape => false
+      BackendTranslator.store.save
+      @message = "Added translations"
+      new_translation(to)
+    end
+
+    protected
+
+    # Get all translations sent through the form and decode
+    # their JSON values to check validity.
+    def decoded_translations
+      translations = params.except("from", "to")
+      translations.each do |key, value|
+        translations[key] = ActiveSupport::JSON.decode(value) rescue nil
+      end
+    end
+
+    # Store from and to locales in variables and retrieve
+    # all keys available for translation.
+    def exhibit_translations(from, to)
+      @from, @to = from, to
+      @keys = available_keys(from)
+      haml :index
+    end
+
+    # Get all keys for a given locale removing the locale from
+    # the key and sorting them alphabetically. If a key is named
+    # "en.foo.bar", this method will return it as "foo.bar".
+    def available_keys(locale)
+      keys  = BackendTranslator.store.keys("#{locale}.*")
+      range = Range.new(locale.size + 1, -1)
+      keys.map { |k| k.slice(range) }.sort!
+    end
+
+    # Get the stored value in the translator store for a given
+    # locale. This method needs to decode values and check if they
+    # are a hash, because we don't want subtrees available for
+    # translation since they are managed automatically by I18n.
+    def locale_value(locale, key)
+      value = BackendTranslator.store["#{locale}.#{key}"]
+      value if value && !ActiveSupport::JSON.decode(value).is_a?(Hash)
+    end
+
+    def new_translation(to)
+    	@to = to
+    	haml :new
+    end
+  end
+end
+
+__END__
+
+@@ index
+!!!
+%html
+  %head
+    %title
+      BackendTranslator::App
+  %body
+    %h2= "From #{@from} to #{@to}"
+
+    %p(style="color:green")= @message
+
+    - if @keys.empty?
+      No translations available for #{@from}
+    - else
+      %form(method="post" action="")
+        - @keys.each do |key|
+          - from_value = locale_value(@from, key)
+          - next unless from_value
+          - to_value = locale_value(@to, key) || from_value
+
+          %p
+            %label(for=key)
+              %small= key
+              = from_value
+            %br
+            %input(id=key name=key type="text" value=to_value size="120")
+
+        %p
+          %input(type="submit" value="Store translations")
+
+@@ new
+!!!
+%html
+	%head
+		%title
+			Translator::App
+	%body
+		%h2= "Create #{@to}"
+		
+		%p(style="color:green")= @message
+		
+		%form(method="post" action="")
+			%label(for="key") CLAVE
+			%br
+			%input(id="key" name="key")
+			%br
+			%label(for="value") VALOR
+			%br
+			%input(id="value" name="value")
+			%br
+			%input(type="submit" value="Store translations")

data/lib/backend_translator/version.rb

@@ -0,0 +1,3 @@
+module BackendTranslator
+  VERSION = "0.0.1"
+end

data/lib/backend_translator.rb

@@ -0,0 +1,28 @@
+require 'redis'
+
+module BackendTranslator
+	autoload :App, "backend_translator/app"
+
+  DATABASES = {
+    "development" => 0,
+    "test" => 1,
+    "production" => 2
+  }
+
+  def self.store
+    @store ||= Redis.new(:db => DATABASES[Rails.env.to_s])
+  end
+
+  def self.reload!
+    BackendTranslator.store.flushdb
+    I18n.backend.load_translations
+  end
+
+  class Backend < I18n::Backend::KeyValue 
+    include I18n::Backend::Memoize
+
+    def initialize
+      super(BackendTranslator.store)
+    end
+  end
+end

data/lib/generators/backend_translator/install_generator.rb

@@ -0,0 +1,22 @@
+module BackendTranslator
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a BackendTranslator initializer and add routes to your routes.rb."
+
+      def copy_initializer
+        template "backend_translator.rb", "config/initializers/backend_translator.rb"
+      end
+ 
+      def add_route
+        backend_translator_route  = "mount BackendTranslator::App, :at => \"/translator\""
+        route backend_translator_route
+      end
+      
+      #def copy_locale
+       # copy_file "../../../config/locales/en.yml", "config/locales/backend_translator.en.yml"
+      #end
+    end
+  end
+end

data/lib/generators/templates/backend_translator.rb

@@ -0,0 +1,5 @@
+#BackendTranslator.setup do |config|
+#	# Update i18n backend of Rails
+#	config.i18n.backend = BackendTranslator::Backend.new
+#end
+Rails.application.config.i18n.backend = BackendTranslator::Backend.new

data/lib/tasks/backend_translator_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :backend_translator do
+#   # Task goes here
+# end

data/test/backend_translator_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class BackendTranslatorTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, BackendTranslator
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.