gettext_simple_rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f86be4cc31cf06bfca2ded7ec383931acf7bbee
+  data.tar.gz: b08add1067098dfc01d24c2a9eebd25e56f47006
+SHA512:
+  metadata.gz: 8b13ef7dcfa94085a1d76f4575a35c91f59a946a6a750c54d28f5d484777b619bc7661e2d11ac19e5a293e827e9368b60398ef85f863a89661a62abe1dfa065b
+  data.tar.gz: 6470cd0e81c04a29d14f46f4cd6a1422ec20b90d52c43c1e992e466a939f449dd7e2621e59c154514511826dfcd312e278068853d28df8b032d62468984830a7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 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/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GettextSimpleRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+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/app/assets/javascripts/gettext_simple_rails/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/gettext_simple_rails/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/gettext_simple_rails/application_controller.rb

@@ -0,0 +1,4 @@
+module GettextSimpleRails
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/gettext_simple_rails/application_helper.rb

@@ -0,0 +1,4 @@
+module GettextSimpleRails
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/gettext_simple_rails/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>GettextSimpleRails</title>
+  <%= stylesheet_link_tag    "gettext_simple_rails/application", media: "all" %>
+  <%= javascript_include_tag "gettext_simple_rails/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+GettextSimpleRails::Engine.routes.draw do
+end

data/lib/gettext_simple_rails.rb

@@ -0,0 +1,14 @@
+require "gettext_simple_rails/engine"
+require "string-cases"
+
+module GettextSimpleRails
+  def self.const_missing(name)
+    require "#{::File.dirname(__FILE__)}/gettext_simple_rails/#{::StringCases.camel_to_snake(name)}"
+    raise LoadError, "Still not loaded: '#{name}'." unless ::GettextSimpleRails.const_defined?(name)
+    return ::GettextSimpleRails.const_get(name)
+  end
+  
+  def self.translation_dir
+    return "#{Rails.root}/lib/gettext_simple_rails"
+  end
+end

data/lib/gettext_simple_rails/engine.rb

@@ -0,0 +1,5 @@
+module GettextSimpleRails
+  class Engine < ::Rails::Engine
+    isolate_namespace GettextSimpleRails
+  end
+end

data/lib/gettext_simple_rails/i18n_injector.rb

@@ -0,0 +1,69 @@
+class GettextSimpleRails::I18nInjector
+  def initialize(args = {})
+    @debug = args[:debug]
+  end
+  
+  def inject_model_translations(gettext_simple)
+    i18n_backend = I18n.config.backend
+    
+    GettextSimpleRails::ModelInspector.model_classes do |inspector|
+      model = {}
+      attributes = {}
+      
+      data = {
+        "activerecord" => {
+          "models" => {
+            inspector.snake_name => model
+          },
+          "attributes" => {
+            inspector.snake_name => attributes
+          }
+        }
+      }
+      
+      I18n.available_locales.each do |locale|
+        locale = locale.to_s
+        
+        unless gettext_simple.locale_exists?(locale)
+          debug "Skipping locale because it hasn't been loaded into GettextSimple: #{locale}" if @debug
+          next
+        end
+        
+        debug "Loading locale: #{locale}" if @debug
+        
+        one_translation = gettext_simple.translate_with_locale(locale, inspector.gettext_key_one)
+        if one_translation != inspector.gettext_key_one
+          model["one"] = one_translation
+        end
+        
+        other_translation = gettext_simple.translate_with_locale(locale, inspector.gettext_key_other)
+        if other_translation != inspector.gettext_key_other
+          model["other"] = other_translation
+        end
+        
+        inspector.attributes do |attribute|
+          attribute_translation = gettext_simple.translate_with_locale(locale, attribute.gettext_key)
+          if attribute_translation != attribute.gettext_key
+            debug "Translating #{inspector.snake_name}.#{attribute.name} to #{attribute_translation}" if @debug
+            attributes[attribute.name.to_s] = attribute_translation
+          else
+            debug "Skipping #{inspector.snake_name}.#{attribute.name}" if @debug
+          end
+        end
+        
+        inspector.relationships do |name, reflection|
+          relationship_translation = gettext_simple.translate_with_locale(locale, inspector.relationship_gettext_key(name))
+          if relationship_translation != inspector.relationship_gettext_key(name)
+            attributes[name.to_s] = relationship_translation
+          end
+        end
+        
+        i18n_backend.store_translations(locale.to_sym, data)
+      end
+    end
+  end
+  
+  def debug(str)
+    $stderr.puts str if @debug
+  end
+end

data/lib/gettext_simple_rails/model_inspector.rb

@@ -0,0 +1,66 @@
+class GettextSimpleRails::ModelInspector
+  def self.model_classes
+    clazzes = []
+    
+    ::Rails.application.eager_load!
+    
+    ::Object.constants.each do |clazz|
+      clazz = clazz.to_s.constantize
+      next unless clazz.class == Class
+      next unless clazz < ActiveRecord::Base
+      yield ::GettextSimpleRails::ModelInspector.new(clazz)
+    end
+  end
+  
+  attr_reader :clazz
+  
+  def initialize(clazz)
+    @clazz = clazz
+  end
+  
+  def attributes
+    @clazz.attribute_names.each do |attribute_name|
+      yield ::GettextSimpleRails::ModelInspector::Attribute.new(self, attribute_name)
+    end
+  end
+  
+  def snake_name
+    return ::StringCases.camel_to_snake(clazz.name)
+  end
+  
+  def gettext_key
+    return "models.name.#{snake_name}"
+  end
+  
+  def gettext_key_one
+    return "#{gettext_key}.one"
+  end
+  
+  def gettext_key_other
+    return "#{gettext_key}.other"
+  end
+  
+  # TODO: Maybe this should yield a ModelInspector::Relationship instead?
+  def relationships
+    @clazz.reflections.each do |key, reflection|
+      yield key, reflection
+    end
+  end
+  
+  def relationship_gettext_key(name)
+    return "models.attributes.#{snake_name}.#{name}"
+  end
+  
+  class Attribute
+    attr_reader :name
+    
+    def initialize(clazz_inspector, name)
+      @clazz_inspector = clazz_inspector
+      @name = name
+    end
+    
+    def gettext_key
+      return "models.attributes.#{@clazz_inspector.snake_name}.#{@name}"
+    end
+  end
+end

data/lib/gettext_simple_rails/version.rb

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

data/lib/tasks/gettext_simple_rails_tasks.rake

@@ -0,0 +1,41 @@
+# desc "Explaining what the task does"
+# task :gettext_simple_rails do
+#   # Task goes here
+# end
+
+namespace :gettext_simple_rails do
+  task "generate_model_translation_files" => :environment do
+    GettextSimpleRails::ModelInspector.model_classes do |inspector|
+      translation_path = "#{GettextSimpleRails.translation_dir}/models/#{inspector.snake_name}_model_translations.rb"
+      FileUtils.mkdir_p(File.dirname(translation_path)) unless File.exists?(File.dirname(translation_path))
+      
+      File.open(translation_path, "w") do |fp|
+        fp.puts "class GettextSimpleRails::UserModelTranslations"
+        fp.puts "  def self.attribute_translations"
+        
+        inspector.attributes do |attribute|
+          fp.puts "    puts _('#{attribute.gettext_key}')"
+        end
+        
+        fp.puts "  end"
+        
+        fp.puts ""
+        fp.puts "  def self.relationship_translations"
+        
+        inspector.relationships do |name, relationship|
+          fp.puts "    puts _('#{inspector.relationship_gettext_key(name)}')"
+        end
+        
+        fp.puts "  end"
+        
+        fp.puts ""
+        fp.puts "  def self.model_name"
+        fp.puts "    puts _('#{inspector.gettext_key}.one')"
+        fp.puts "    puts _('#{inspector.gettext_key}.other')"
+        fp.puts "  end"
+        
+        fp.puts "end"
+      end
+    end
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/role.rb

@@ -0,0 +1,3 @@
+class Role < ActiveRecord::Base
+  belongs_to :user
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_many :roles
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>