rails-i18nterface 0.1.0

data/spec/lib/file_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe RailsI18nterface::File do
+  describe "write" do
+    before(:each) do
+      @file = RailsI18nterface::File.new(file_path)
+    end
+
+    after(:each) do
+      FileUtils.rm(file_path)
+    end
+
+    it "writes all I18n messages for a locale to YAML file" do
+      @file.write(translations)
+      @file.read.should == RailsI18nterface::File.deep_stringify_keys(translations)
+    end
+
+    def translations
+      {
+        :en => {
+          :article => {
+            :title => "One Article"
+          },
+          :category => "Category"
+        }
+      }
+    end
+  end
+
+  describe "deep_stringify_keys" do
+    it "should convert all keys in a hash to strings" do
+      RailsI18nterface::File.deep_stringify_keys({
+        :en => {
+          :article => {
+            :title => "One Article"
+          },
+          :category => "Category"
+        }
+      }).should == {
+        "en" => {
+          "article" => {
+            "title" => "One Article"
+          },
+          "category" => "Category"
+        }
+      }
+    end
+  end
+
+  def file_path
+    File.join(File.dirname(__FILE__), "files", "en.yml")
+  end
+end

data/spec/lib/keys_spec.rb

@@ -0,0 +1,179 @@
+require 'spec_helper'
+
+describe RailsI18nterface::Keys do
+  before(:each) do
+    #I18n.stub!(:default_locale).and_return(:en)
+    #RailsI18nterface::Storage.stub!(:root_dir).and_return(i18n_files_dir)
+    @keys = RailsI18nterface::Keys.new
+  end
+
+  describe "to_a" do
+    it "extracts keys from I18n lookups in .rb, .html.erb, and .rhtml files" do
+      @keys.to_a.map(&:to_s).sort.should == ['article.key1', 'article.key2', 'article.key3', 'article.key4', 'article.key5',
+        'category_erb.key1', 'category_html_erb.key1', 'category_rhtml.key1', 'js.alert']
+    end
+  end
+
+  describe "to_hash" do
+    it "return a hash with I18n keys and file lists" do
+      @keys.to_hash[:'article.key3'].should == ["app/models/article.rb"]
+    end
+  end
+
+  describe "i18n_keys" do
+    before(:each) do
+      I18n.backend.send(:init_translations) unless I18n.backend.initialized?
+    end
+
+    it "should return all keys in the I18n backend translations hash" do
+      I18n.backend.should_receive(:translations).and_return(translations)
+      @keys.i18n_keys(:en).should == ['articles.new.page_title', 'categories.flash.created', 'empty', 'home.about']
+    end
+
+  describe "untranslated_keys" do
+    before(:each) do
+      I18n.backend.stub!(:translations).and_return(translations)
+    end
+
+    it "should return a hash with keys with missing translations in each locale" do
+      @keys.untranslated_keys.should == {
+        :sv => ['articles.new.page_title', 'categories.flash.created', 'empty'],
+        :no => ["articles.new.page_title", "categories.flash.created", "empty", "home.about"]
+      }
+    end
+  end
+
+  describe "missing_keys" do
+    before(:each) do
+      @file_path = File.join(i18n_files_dir, "config", "locales", "en.yml")
+      RailsI18nterface::File.new(@file_path).write({
+        :en => {
+          :home => {
+            :page_title => false,
+            :intro => {
+              :one => "intro one",
+              :other => "intro other"
+            }
+          }
+        }
+      })
+    end
+
+    after(:each) do
+      FileUtils.rm(@file_path)
+    end
+
+    it "should return a hash with keys that are not in the locale file" do
+      @keys.stub!(:files).and_return({
+        :'home.page_title' => "app/views/home/index.rhtml",
+        :'home.intro' => 'app/views/home/index.rhtml',
+        :'home.signup' => "app/views/home/_signup.rhtml",
+        :'about.index.page_title' => "app/views/about/index.rhtml"
+      })
+      @keys.missing_keys.should == {
+        :'home.signup' => "app/views/home/_signup.rhtml",
+        :'about.index.page_title' => "app/views/about/index.rhtml"
+      }
+    end
+  end
+
+  describe "contains_key?" do
+    it "works" do
+      hash = {
+        :foo => {
+          :bar => {
+            :baz => false
+          }
+        }
+      }
+      RailsI18nterface::Keys.contains_key?(hash, "").should be_false
+      RailsI18nterface::Keys.contains_key?(hash, "foo").should be_true
+      RailsI18nterface::Keys.contains_key?(hash, "foo.bar").should be_true
+      RailsI18nterface::Keys.contains_key?(hash, "foo.bar.baz").should be_true
+      RailsI18nterface::Keys.contains_key?(hash, :"foo.bar.baz").should be_true
+      RailsI18nterface::Keys.contains_key?(hash, "foo.bar.baz.bla").should be_false
+    end
+  end
+
+  describe "translated_locales" do
+    before(:each) do
+      I18n.stub!(:default_locale).and_return(:en)
+      I18n.stub!(:available_locales).and_return([:sv, :no, :en, :root])
+    end
+
+    it "returns all avaiable except :root and the default" do
+      RailsI18nterface::Keys.translated_locales.should == [:sv, :no]
+    end
+  end
+
+  describe "to_deep_hash" do
+    it "convert shallow hash with dot separated keys to deep hash" do
+      RailsI18nterface::Keys.to_deep_hash(shallow_hash).should == deep_hash
+    end
+  end
+
+  describe "to_shallow_hash" do
+    it "converts a deep hash to a shallow one" do
+      RailsI18nterface::Keys.to_shallow_hash(deep_hash).should == shallow_hash
+    end
+  end
+
+  ##########################################################################
+  #
+  # Helper Methods
+  #
+  ##########################################################################
+
+    def translations
+      {
+        :en => {
+          :home => {
+            :about => "This site is about making money"
+          },
+          :articles => {
+           :new => {
+             :page_title => "New Article"
+            }
+          },
+          :categories => {
+            :flash => {
+             :created => "Category created"
+            }
+          },
+          :empty => nil
+        },
+        :sv => {
+          :home => {
+            :about => false
+          }
+        }
+      }
+    end
+  end
+
+  def shallow_hash
+    {
+      'pressrelease.label.one' => "Pressmeddelande",
+      'pressrelease.label.other' => "Pressmeddelanden",
+      'article' => "Artikel",
+      'category' => ''
+    }
+  end
+
+  def deep_hash
+    {
+      :pressrelease => {
+        :label => {
+          :one => "Pressmeddelande",
+          :other => "Pressmeddelanden"
+        }
+      },
+      :article => "Artikel",
+      :category => ''
+    }
+  end
+
+  def i18n_files_dir
+    File.expand_path(File.join("..", "..", "..", "spec", "internal"), __FILE__)
+  end
+end

data/spec/lib/log_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe RailsI18nterface::Log do
+  describe "write_to_file" do
+    before(:each) do
+      I18n.locale = :sv
+      I18n.backend.store_translations(:sv, from_texts)
+      keys = RailsI18nterface::Keys.new
+      @log = RailsI18nterface::Log.new(:sv, :en, RailsI18nterface::Keys.to_shallow_hash(from_texts).keys)
+      @log.stub!(:file_path).and_return(file_path)
+      FileUtils.rm_f file_path
+    end
+
+    after(:each) do
+      FileUtils.rm_f file_path
+    end
+
+    it "writes new log file with from texts" do
+      File.exists?(file_path).should be_false
+      @log.write_to_file
+      File.exists?(file_path).should be_true
+      RailsI18nterface::File.new(file_path).read.should == RailsI18nterface::File.deep_stringify_keys(from_texts)
+    end
+
+    it "merges from texts with current texts in log file and re-writes the log file" do
+      @log.write_to_file
+      I18n.backend.store_translations(:sv, {:category => "Kategori ny"})
+      @log.keys = ['category']
+      @log.write_to_file
+      RailsI18nterface::File.new(file_path).read['category'].should == "Kategori ny"
+    end
+
+    def file_path
+      File.join(File.dirname(__FILE__), "files", "from_sv_to_en.yml")
+    end
+
+    def from_texts
+      {
+        :article => {
+          :title => "En artikel"
+        },
+        :category => "Kategori"
+      }
+    end
+  end
+end

data/spec/lib/storage_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe RailsI18nterface::Storage do
+  describe "write_to_file" do
+    before(:each) do
+      @storage = RailsI18nterface::Storage.new(:en)
+    end
+
+    it "writes all I18n messages for a locale to YAML file" do
+      I18n.backend.should_receive(:translations).and_return(translations)
+      @storage.stub!(:file_path).and_return(file_path)
+      file = mock(:file)
+      file.should_receive(:write).with(translations)
+      RailsI18nterface::File.should_receive(:new).with(file_path).and_return(file)
+      @storage.write_to_file
+    end
+
+    def file_path
+      File.join(File.dirname(__FILE__), "files", "en.yml")
+    end
+
+    def translations
+      {
+        :en => {
+          :article => {
+            :title => "One Article"
+          },
+          :category => "Category"
+        }
+      }
+    end
+  end
+end

data/spec/requests/search_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe 'searching' do
+
+  describe 'keys' do
+
+    context 'using contains' do
+
+      it 'finds the correct keys' do
+        visit '/translate'
+        select 'Key contains', from: 'key_type'
+        fill_in 'key_pattern', with: 'ey2'
+        click_button 'Search'
+
+        page.should have_content 'key2'
+      end
+
+    end
+
+    context 'using starts with' do
+      it 'finds the correct keys' do
+        visit '/translate'
+        select 'Key starts with', from: 'key_type'
+        fill_in 'key_pattern', with: 'article.k'
+        click_button 'Search'
+
+        page.should have_content 'article.key2'
+      end
+    end
+  end
+
+  describe 'values' do
+
+    context 'using contains' do
+
+      it 'finds the correct values' do
+        visit '/translate'
+        select 'contains', from: 'text_type'
+        fill_in 'text_pattern', with: '1 year'
+        click_button 'Search'
+
+        page.should have_content 'over 1 year'
+      end
+
+    end
+
+    context 'using equals' do
+
+      it 'finds the correct values' do
+        visit '/translate'
+        select 'equals', from: 'text_type'
+        fill_in 'text_pattern', with: 'over 1 year'
+        click_button 'Search'
+
+        page.should have_content 'over 1 year'
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+ENV["RAILS_ENV"] ||= 'test'
+$:<<File.expand_path("../../lib",__FILE__)
+
+require 'rubygems'
+require 'bundler'
+require 'combustion'
+
+Bundler.require :default, :test
+
+require 'capybara/rspec'
+
+Combustion.initialize! :active_record, :action_controller, :action_view, :sprockets
+
+require 'rspec/rails'
+require 'rspec/autorun'
+
+require 'capybara/rails'
+require 'rails-i18nterface'
+
+new_root = File.expand_path(File.join("..", "internal"), __FILE__)
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.use_transactional_fixtures = true
+  config.include Capybara::DSL, example_group: { file_path: /\bspec\/request\// }
+  config.include RailsI18nterface::Engine.routes.url_helpers
+  config.before(:each) do
+    RailsI18nterface::Storage.stub!(:root_dir).and_return(new_root)
+    RailsI18nterface::Keys.stub(:i18n_keys).and_return(:en)
+    I18n.stub!(:default_locale).and_return(:en)
+    I18n.stub!(:available_locales).and_return([:sv, :no, :en, :root])
+  end
+end
+
+# improve the performance of the specs suite by not logging anything
+# see http://blog.plataformatec.com.br/2011/12/three-tips-to-improve-the-performance-of-your-test-suite/
+Rails.logger.level = 4

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: rails-i18nterface
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mose
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A rails 3.1/4 engine adding an interface for translating and writing
+  translation files.
+email:
+- mose@mose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/helpers/rails_i18nterface/application_helper.rb
+- app/helpers/rails_i18nterface/translate_helper.rb
+- app/models/translation.rb
+- app/views/layouts/rails_i18nterface/translate.html.erb
+- app/views/rails_i18nterface/translate/index.html.erb
+- app/views/rails_i18nterface/translate/_pagination.html.erb
+- app/views/rails_i18nterface/translate/_namespaces.html.erb
+- app/assets/stylesheets/rails_i18nterface/application.css
+- app/assets/javascripts/rails_i18nterface/application.js
+- app/assets/javascripts/rails_i18nterface/ender.min.js
+- app/assets/javascripts/rails_i18nterface/ender.js
+- app/assets/javascripts/rails_i18nterface/base.js
+- app/controllers/rails_i18nterface/application_controller.rb
+- app/controllers/rails_i18nterface/translate_controller.rb
+- config/routes.rb
+- db/migrate/20110921112044_create_translations.rb
+- lib/tasks/rails-i18nterface.rake
+- lib/rails-i18nterface/storage.rb
+- lib/rails-i18nterface/engine.rb
+- lib/rails-i18nterface/log.rb
+- lib/rails-i18nterface/version.rb
+- lib/rails-i18nterface/keys.rb
+- lib/rails-i18nterface/file.rb
+- lib/rails-i18nterface.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+- spec/spec_helper.rb
+- spec/internal/log/test.log
+- spec/internal/app/models/article.rb
+- spec/internal/app/views/application/index.html.erb
+- spec/internal/app/views/categories/category.erb
+- spec/internal/app/views/categories/category.rhtml
+- spec/internal/app/views/categories/category.html.erb
+- spec/internal/app/views/categories/category.html
+- spec/internal/app/assets/stylesheets/application.css
+- spec/internal/app/assets/javascripts/application.js
+- spec/internal/app/controllers/application_controller.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/db/combustion_test.sqlite
+- spec/internal/public/favicon.ico
+- spec/lib/log_spec.rb
+- spec/lib/keys_spec.rb
+- spec/lib/file_spec.rb
+- spec/lib/storage_spec.rb
+- spec/requests/search_spec.rb
+- spec/controllers/translate_controller_spec.rb
+homepage: https://github.com/mose/rails-i18nterface
+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.0.0.rc.2
+signing_key: 
+specification_version: 4
+summary: A rails 3.1/4 engine for translating in a web page.
+test_files:
+- spec/spec_helper.rb
+- spec/internal/log/test.log
+- spec/internal/app/models/article.rb
+- spec/internal/app/views/application/index.html.erb
+- spec/internal/app/views/categories/category.erb
+- spec/internal/app/views/categories/category.rhtml
+- spec/internal/app/views/categories/category.html.erb
+- spec/internal/app/views/categories/category.html
+- spec/internal/app/assets/stylesheets/application.css
+- spec/internal/app/assets/javascripts/application.js
+- spec/internal/app/controllers/application_controller.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/db/combustion_test.sqlite
+- spec/internal/public/favicon.ico
+- spec/lib/log_spec.rb
+- spec/lib/keys_spec.rb
+- spec/lib/file_spec.rb
+- spec/lib/storage_spec.rb
+- spec/requests/search_spec.rb
+- spec/controllers/translate_controller_spec.rb