awesome_translations 0.0.2

data/lib/awesome_translations/handlers/validations_handler.rb

@@ -0,0 +1,70 @@
+class AwesomeTranslations::Handlers::ValidationsHandler < AwesomeTranslations::Handlers::BaseHandler
+  def groups
+    ArrayEnumerator.new do |yielder|
+      AwesomeTranslations::ModelInspector.model_classes.each do |model_inspector|
+        yielder << AwesomeTranslations::Group.new(
+          id: model_inspector.clazz.name,
+          handler: self
+        )
+      end
+    end
+  end
+
+  def translations_for_group(group)
+    ArrayEnumerator.new do |yielder|
+      model_inspector = AwesomeTranslations::ModelInspector.model_classes.select { |model_inspector| model_inspector.clazz.name == group.name }.first
+      raise "No inspector by that name: #{model_inspector.clazz.name}" unless model_inspector
+
+      model_inspector.clazz._validators.each do |attribute_name, validators|
+        validators.each do |validator|
+          translations_for_length_validator(validator, model_inspector, attribute_name, yielder) if validator.is_a?(ActiveModel::Validations::LengthValidator)
+          translations_for_format_validator(validator, model_inspector, attribute_name, yielder) if validator.is_a?(ActiveModel::Validations::FormatValidator)
+          translations_for_uniqueness_validator(validator, model_inspector, attribute_name, yielder) if validator.is_a?(ActiveRecord::Validations::UniquenessValidator)
+          translations_for_presence_validator(validator, model_inspector, attribute_name, yielder) if validator.is_a?(ActiveRecord::Validations::PresenceValidator)
+          translations_for_email_validator(validator, model_inspector, attribute_name, yielder) if validator.class.name == "EmailValidator"
+        end
+      end
+    end
+  end
+
+private
+
+  def translations_for_length_validator(validator, model_inspector, attribute_name, yielder)
+    if validator.options[:minimum].present?
+      add_translation("too_short", model_inspector, attribute_name, yielder) # "is too short. The minimum is %{count}"
+    end
+
+    if validator.options[:maximum].present?
+      add_translation("too_long", model_inspector, attribute_name, yielder) # "is too long. The maximum is %{count}"
+    end
+
+    if validator.options[:is].present?
+      add_translation("wrong_length", model_inspector, attribute_name, yielder) # "is not the correct length: %{count}"
+    end
+  end
+
+  def translations_for_format_validator(validator, model_inspector, attribute_name, yielder)
+    add_translation("invalid", model_inspector, attribute_name, yielder) # "is invalid"
+  end
+
+  def translations_for_uniqueness_validator(validator, model_inspector, attribute_name, yielder)
+    add_translation("taken", model_inspector, attribute_name, yielder) # "has already been taken"
+  end
+
+  def translations_for_presence_validator(validator, model_inspector, attribute_name, yielder)
+    add_translation("blank", model_inspector, attribute_name, yielder) # "cannot be blank"
+  end
+
+  def translations_for_email_validator(validator, model_inspector, attribute_name, yielder)
+    add_translation("invalid", model_inspector, attribute_name, yielder) # "is invalid"
+  end
+
+  def add_translation(key, model_inspector, attribute_name, yielder)
+    snake_clazz_name = StringCases.camel_to_snake(model_inspector.clazz.name)
+
+    yielder << AwesomeTranslations::Translation.new(
+      key: "activerecord.errors.models.#{snake_clazz_name}.attributes.#{attribute_name}.#{key}",
+      dir: "#{Rails.root}/config/locales/awesome_translations/models/#{snake_clazz_name}"
+    )
+  end
+end

data/lib/awesome_translations/model_inspector.rb

@@ -0,0 +1,137 @@
+class AwesomeTranslations::ModelInspector
+  autoload :Attribute, "#{File.dirname(__FILE__)}/model_inspector/attribute"
+
+  attr_reader :clazz
+
+  # Yields a model-inspector for each model found in the application.
+  def self.model_classes
+    # Make sure all models are loaded.
+    load_models
+
+    @scanned = {}
+    @yielded = {}
+
+    Enumerator.new do |yielder|
+      constants = Module.constants + Object.constants + Kernel.constants
+      constants.sort.each do |constant_name|
+        scan_for_models(::Object, constant_name) do |model_inspector|
+          yielder << model_inspector
+        end
+      end
+    end
+  end
+
+  def initialize(clazz)
+    @clazz = clazz
+  end
+
+  def attributes
+    @clazz.attribute_names.each do |attribute_name|
+      yield ::AwesomeTranslations::ModelInspector::Attribute.new(self, attribute_name)
+    end
+  end
+
+  def paperclip_attachments
+    return [] unless ::Kernel.const_defined?("Paperclip")
+    Paperclip::AttachmentRegistry.names_for(@clazz).each do |name|
+      yield name
+    end
+  end
+
+  def snake_name
+    clazz.name.gsub("::", "/").split("/").map { |part| ::StringCases.camel_to_snake(part) }.join("/")
+  end
+
+  def gettext_key
+    return "activerecord.models.#{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 i18n_key name
+    return "activerecord.attributes.#{snake_name}.#{name}"
+  end
+
+  def to_s
+    "<AwesomeTranslations::ModelInspector class-name: \"#{@clazz.name}\">"
+  end
+
+  def inspect
+    to_s
+  end
+
+private
+
+  # Loads all models for Rails app and all engines.
+  def self.load_models
+    load_models_for(Rails.root)
+    Rails.application.railties.engines.each do |r|
+      load_models_for(r.root)
+    end
+  end
+
+  # Loads models for the given app-directory (Rails-root or engine).
+  def self.load_models_for(root)
+    Dir.glob("#{root}/app/models/**/*.rb") do |model_path|
+      require model_path
+    end
+  end
+
+  def self.scan_for_models(parent_clazz, constant_name, &blk)
+    return unless parent_clazz.const_defined?(constant_name)
+
+    begin
+      clazz = parent_clazz.const_get(constant_name)
+    rescue
+      return
+    end
+
+    return if !clazz.respond_to?(:name) || !clazz.name || !clazz.respond_to?(:constants)
+    return if clazz.name == "ActiveRecord::SchemaMigration"
+    return if clazz.name.end_with?("::Translation")
+
+    clazz.constants.sort.each do |clazz_sym|
+      begin
+        class_current = clazz.const_get(clazz_sym)
+      rescue
+        next
+      rescue RuntimeError, LoadError
+        next
+      end
+
+      if @scanned[class_current]
+        next
+      else
+        @scanned[class_current] = true
+      end
+
+      next if !class_current.is_a?(Class) && !class_current.is_a?(Module)
+
+      scan_for_models(clazz, clazz_sym, &blk)
+    end
+
+    begin
+      return unless clazz < ActiveRecord::Base
+    rescue
+      return
+    end
+
+    unless @yielded[clazz]
+      @yielded[clazz] = true
+      blk.call ::AwesomeTranslations::ModelInspector.new(clazz)
+    end
+  end
+end

data/lib/awesome_translations/model_inspector/attribute.rb

@@ -0,0 +1,12 @@
+class AwesomeTranslations::ModelInspector::Attribute
+  attr_reader :name
+
+  def initialize(clazz_inspector, name)
+    @clazz_inspector = clazz_inspector
+    @name = name
+  end
+
+  def i18n_key
+    return "activerecord.attributes.#{@clazz_inspector.snake_name}.#{@name}"
+  end
+end

data/lib/awesome_translations/object_extensions.rb

@@ -0,0 +1,13 @@
+module AwesomeTranslations::ObjectExtensions
+  def _(str, replaces = nil)
+    str = str.to_s
+
+    if replaces
+      replaces.each do |key, val|
+        str = str.gsub("%{#{key}}", val.to_s)
+      end
+    end
+
+    return str
+  end
+end

data/lib/awesome_translations/version.rb

@@ -0,0 +1,3 @@
+module AwesomeTranslations
+  VERSION = "0.0.2"
+end

data/lib/tasks/awesome_translations_tasks.rake

@@ -0,0 +1,29 @@
+# desc "Explaining what the task does"
+# task :awesome_translations do
+#   # Task goes here
+# end
+
+namespace :awesome_translations do
+  task "install" => :environment do
+    yml_root = "#{Rails.root}/config/locales/awesome_translations"
+
+    dirs = [
+      yml_root,
+      "#{yml_root}/helpers",
+      "#{yml_root}/models",
+      "#{yml_root}/views",
+      "#{yml_root}/controllers"
+    ]
+
+    dirs.each do |dir|
+      unless File.exists?(dir)
+        puts "[AwesomeTranslations] Creating dir: #{dir}"
+        Dir.mkdir(dir)
+      end
+    end
+  end
+
+  task "update" => :environment do
+
+  end
+end

data/spec/controllers/groups_controller_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+describe AwesomeTranslations::GroupsController do
+  let(:model_locales_path) { "#{Rails.root}/config/locales/awesome_translations/models" }
+  let(:user_yml_path) { "#{model_locales_path}/user/da.yml" }
+  let(:role_yml_path) { "#{model_locales_path}/role/da.yml" }
+
+  before do
+    FileUtils.rm_f(model_locales_path) if File.exist?(model_locales_path)
+  end
+
+  render_views
+
+  describe "#update" do
+    it "updates translations" do
+      I18n.load_path.should_not include model_locales_path
+
+      put :update, handler_id: "model_handler", id: "User", use_route: "awesome_translations", t: {
+        "activerecord.attributes.user.password" => {"da" => "Adgangskode", "de" => "Kenwort", "en" => "Password"}
+      }
+
+      danish_user_translations = YAML.load_file(user_yml_path)
+      danish_user_translations["da"]["activerecord"]["attributes"]["user"]["password"].should eq "Adgangskode"
+    end
+
+    it "updates paths" do
+      put :update, handler_id: "model_handler", id: "Role", use_route: "awesome_translations", t: {
+        "activerecord.attributes.role.role" => {"da" => "Rolle", "de" => "Die type", "en" => "Role"}
+      }
+
+      I18n.load_path.should include role_yml_path
+    end
+  end
+end

data/spec/controllers/handlers_controller_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+require "fileutils"
+
+describe AwesomeTranslations::HandlersController do
+  render_views
+
+  it "#index" do
+    get :index, use_route: "awesome_translations"
+    response.should be_success
+  end
+
+  it "#show" do
+    get :show, id: "model_handler", use_route: "awesome_translations"
+    response.should be_success
+  end
+end

data/spec/controllers/users_controller_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe UsersController do
+  let(:user) { create :user }
+
+  render_views
+
+  before do
+    I18n.locale = :en
+  end
+
+  it "#index" do
+    user
+    get :index
+    response.should be_success
+    assigns(:users).should include user
+  end
+end

data/spec/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/spec/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__)
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,15 @@
+// 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 .
+//= require jquery
+//= require jquery_ujs

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

@@ -0,0 +1,13 @@
+/*
+ * 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

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

@@ -0,0 +1,17 @@
+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
+
+  before_filter :set_locale
+
+private
+
+  def set_locale
+    if session[:locale]
+      I18n.locale = session[:locale]
+    else
+      I18n.locale = :en
+    end
+  end
+end

data/spec/dummy/app/controllers/locales_controller.rb

@@ -0,0 +1,6 @@
+class LocalesController < ApplicationController
+  def create
+    session[:locale] = params[:locale]
+    redirect_to root_url
+  end
+end

data/spec/dummy/app/controllers/users_controller.rb

@@ -0,0 +1,32 @@
+class UsersController < ApplicationController
+  before_filter :set_user
+
+  def index
+    @users = User.all
+  end
+
+  def show
+  end
+
+  def new
+  end
+
+  def create
+    if @user.save
+      flash[:notice] = t(".user_was_created")
+      redirect_to user_path(@user)
+    else
+      flash[:error] = @user.errors.full_messages.join(". ")
+      render :new
+    end
+  end
+
+  def edit
+  end
+
+private
+
+  def set_user
+    @user = User.find(params[:id].to_i) if params[:id].to_i > 0
+  end
+end