localeapp 0.4.3 → 0.5.0

data/.travis.yml

@@ -6,6 +6,3 @@ gemfile:
   - Gemfile.i18n_037
   - Gemfile.i18n_050
   - Gemfile.i18n_060
-branches:
-  only:
-    - master

data/CHANGELOG.md

@@ -1,12 +1,19 @@
-# HEAD
+# Version 0.5.0
 
-# Version 0.4.2
+* Post translations with default values
+* Change how Psych outputs yaml (for Psych versions >= 1.1.0)
+* Add a --github option when installing to help setup public projects
+
+# Version 0.4.3
 
 * Make sure Psych is fully loaded before using it (Thanks @tenderlove) 
 
-# Version 0.4.1
+# Version 0.4.2
 
 * Improve compatibility of Psych with ruby 1.9.2 (Thanks @ardpac)
+
+# Version 0.4.1
+
 * Ignore HUP when backgrounded. (Thanks @xijo)
 * Add --standalone option to install to generate a .localeapp/ config
   directory. This enables usage outside of rails.

data/Gemfile.github_project.rb

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", ">= 2.4.0"
+  gem "bundler", "~> 1.1.2"
+  gem "jeweler", "> 1.6.4"
+  gem 'i18n-spec'
+  gem 'localeapp'
+end

data/README.md

@@ -48,6 +48,18 @@ Install the gem and run:
     
 This will create a `.localeapp` directory for your configuration files.
 
+### Public projects
+
+Install the gem and run:
+
+    localeapp install --github <YOUR_API_KEY>
+
+This will create a skeleton project you can push to `<your_gem>-i18n` on
+github.  You get a `.localeapp` directory for your configuration files, a
+`locales` directory for the yaml, a `.gitignore` file that ignores `.localeapp`
+and a `README.md` explaining to translators how to find the project on
+localeapp.com.
+
 ## Importing existing content
 
 You can import via localeapp.com or with the command line tool. To import

data/bin/localeapp

@@ -31,11 +31,16 @@ arg_name "<api_key>"
 command :install do |c|
   c.desc "install configuration files in .localeapp/"
   c.switch [:s, 'standalone']
+  
+  c.desc "install a skeleton project suitable for Github"
+  c.switch [:g, 'github']
 
   c.action do |global_options, options, args|
     key = args.first
     installer = Localeapp::CLI::Install.new
-    installer.config_type = options[:standalone] ? :standalone : :rails
+    installer.config_type = :standalone if options[:standalone]
+    installer.config_type = :github if options[:github]
+    installer.config_type ||= :rails
     unless installer.execute(key)
       exit_now! "", 1
     end

data/features/localeapp_binary.feature

@@ -50,6 +50,25 @@ Feature: localeapp executable
     And a file named ".localeapp/config.rb" should exist
     And the exit status should be 0
 
+  Scenario: Running github install
+    In order to configure my public github project and check my api key is correct
+    When I have a valid project on localeapp.com with api key "MYAPIKEY"
+    And I run `localeapp install --github MYAPIKEY`
+    Then the output should contain:
+    """
+    Localeapp Install
+
+    Checking API key: MYAPIKEY
+    Success!
+    Project: Test Project
+    Default Locale: en (English)
+    """
+    And help should not be displayed
+    And a file named ".localeapp/config.rb" should exist
+    And a file named ".gitignore" should exist
+    And a file named "README.md" should exist
+    And the exit status should be 0
+
 
   Scenario: Running install with bad api key
     In order to configure my project and check my api key is correct

data/lib/localeapp/cli/install.rb

@@ -29,12 +29,19 @@ module Localeapp
             config_file_path = "config/initializers/localeapp.rb"
             data_directory   = "config/locales"
           else
-            output.puts "NOTICE: you probably want to add .localeapp to your .gitignore file"
+            if config_type == :standalone
+              output.puts "NOTICE: you probably want to add .localeapp to your .gitignore file"
+            end
             config_file_path = ".localeapp/config.rb"
             data_directory   = "locales"
           end
+
           output.puts "Writing configuration file to #{config_file_path}"
-          write_configuration_file config_file_path
+          if config_type == :github
+            write_github_configuration_file config_file_path, project_data
+          else
+            write_configuration_file config_file_path
+          end
 
           unless File.directory?(data_directory)
             output.puts "WARNING: please create the #{data_directory} directory. Your translation data will be stored there."
@@ -58,6 +65,10 @@ module Localeapp
           Localeapp.configuration.write_standalone_configuration(path)
         end
       end
+
+      def write_github_configuration_file(path, project_data)
+          Localeapp.configuration.write_github_configuration(path, project_data)
+      end
     end
   end
 end

data/lib/localeapp/configuration.rb

@@ -171,6 +171,29 @@ Localeapp.configure do |config|
   config.synchronization_data_file  = '.localeapp/log.yml'
   config.daemon_pid_file            = '.localeapp/localeapp.pid'
 end
+CONTENT
+      end
+    end
+
+    def write_github_configuration(path, project_data)
+      write_standalone_configuration(path)
+      FileUtils.mkdir_p('locales')
+      File.open('.gitignore', 'a+') do |file|
+        file.write ".localeapp"
+      end
+      File.open('README.md', 'w+') do |file|
+        file.write <<-CONTENT
+# #{project_data['name']}
+
+A ruby translation project managed on [Locale](http://www.localeapp.com/) that's open to all!
+
+## Contributing to #{project_data['name']}
+
+- Edit the translations directly on the [#{project_data['name']}](http://www.localeapp.com/projects/public?search=#{project_data['name']}) project on Locale.
+- **That's it!**
+- The maintainer will then pull translations from the Locale project and push to Github.
+
+Happy translating!
 CONTENT
       end
     end

data/lib/localeapp/default_value_handler.rb

@@ -0,0 +1,17 @@
+module I18n::Backend::Base
+  alias_method :default_without_handler, :default
+
+  def default(locale, object, subject, options = {})
+    result = default_without_handler(locale, object, subject, options)
+    return result if ::Localeapp.configuration.sending_disabled?
+
+    if result
+      sender = Localeapp::Sender.new
+
+      # Make the default value a complete translation
+      sender.post_translation(locale, object, options, result)
+    end
+
+    return result
+  end
+end

data/lib/localeapp/sender.rb

@@ -8,6 +8,8 @@ module Localeapp
 
     def post_translation(locale, key, options, value = nil)
       options ||= {}
+      options.delete(:default)
+      options.delete(:scope)
       translation = { :key => key, :locale => locale, :substitutions => options.keys.sort, :description => value}
       @data = { :translation => translation }
       api_call :create_translation,

data/lib/localeapp/updater.rb

@@ -35,7 +35,7 @@ module Localeapp
 
     def generate_yaml(translations)
       if defined? Psych
-        Psych.dump(translations)[4..-1]
+        Psych.dump(translations, :line_width => -1)[4..-1]
       else
         translations.ya2yaml[5..-1]
       end

data/lib/localeapp/version.rb

@@ -1,3 +1,3 @@
 module Localeapp
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

data/lib/localeapp.rb

@@ -33,6 +33,7 @@ require 'localeapp/poller'
 require 'localeapp/updater'
 require 'localeapp/key_checker'
 require 'localeapp/missing_translations'
+require 'localeapp/default_value_handler'
 
 require 'localeapp/cli/install'
 require 'localeapp/cli/pull'

data/spec/localeapp/cli/install_spec.rb

@@ -61,4 +61,11 @@ describe Localeapp::CLI::Install, '.execute(key, output = $stdout)' do
     @command.execute('API_KEY', @output)
     @output.string.should_not match(/Your translation data will be stored there./)
   end
+
+  it "asks the github configuration to write itself" do
+    @command.stub!(:check_key).and_return([true, valid_project_data])
+    @command.config_type = :github
+    @command.should_receive(:write_github_configuration_file).with('.localeapp/config.rb', valid_project_data)
+    @command.execute('API_KEY', @output)
+  end
 end

data/spec/localeapp/configuration_spec.rb

@@ -340,3 +340,20 @@ CONTENT
     configuration.write_standalone_configuration(path)
   end
 end
+
+
+describe Localeapp::Configuration, "#write_github_configuration(path, project_data)" do
+  let(:configuration) { Localeapp::Configuration.new }
+  let(:project_data) { {"name"=>"Test Project", "default_locale"=>{"name"=>"English", "code"=>"en"}} }
+  let(:path) { '.localeapp/config.rb' }
+
+  it "writes github configuration files" do
+    configuration.should_receive(:write_standalone_configuration).with(path)
+    file = stub('file')
+    file.should_receive(:write).exactly(2).times.and_return('content')
+    FileUtils.should_receive(:mkdir_p).with('locales')
+    File.should_receive(:open).with('.gitignore', 'a+').and_yield(file)
+    File.should_receive(:open).with('README.md', 'w+').and_yield(file)
+    configuration.write_github_configuration(path, project_data)
+  end
+end

data/spec/localeapp/default_value_handler_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+class Klass
+  include I18n::Backend::Base
+end
+
+describe I18n::Backend::Base, '#default' do
+  let(:klass) { Klass.new }
+
+  it "posts translations to Locale" do
+    with_configuration(:sending_environments => ['my_env'], :environment_name => 'my_env' ) do
+      sender = Localeapp::Sender.new
+      Localeapp::Sender.should_receive(:new).and_return(sender)
+      sender.should_receive(:post_translation)
+      klass.default('locale', 'object', 'subject')
+    end
+  end
+
+  it "doesn't post when sending is disabled" do
+    with_configuration(:sending_environments => []) do
+      Localeapp::Sender.should_not_receive(:new)
+      klass.default('locale', 'object', 'subject')
+    end
+  end
+end

data/spec/localeapp/sender_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Localeapp::Sender, "#post_translation(locale, key, options, value = nil)" do
   before(:each) do
-    with_configuration(:api_key => "TEST_KEY") do
+    with_configuration(:api_key => "TEST_KEY", :sending_environments => ['my_env'], :environment_name => 'my_env') do
       @sender = Localeapp::Sender.new
     end
   end
@@ -24,7 +24,28 @@ describe Localeapp::Sender, "#post_translation(locale, key, options, value = nil
         :x_localeapp_gem_version => Localeapp::VERSION,
         :content_type => :json },
       :method => :post)).and_return(double('response', :code => 200))
-    @sender.post_translation('en', 'test.key', { 'foo' => 'foo', 'bar' => 'bar' }, 'test content')
+    @sender.post_translation('en', 'test.key', { 'foo' => 'foo', 'bar' => 'bar', :default => 'default', :scope => 'scope' }, 'test content')
+  end
+
+  it "posts default translation data to the backend" do
+    data = {
+      :translation => {
+        :key => 'absolutely.missing',
+        :locale => 'en',
+        :substitutions => ['bar', 'foo'],
+        :description => 'a sensible default'
+      }
+    }
+
+    RestClient::Request.should_receive(:execute).with(hash_including(
+      :url => @sender.translations_url,
+      :payload => data.to_json,
+      :headers => {
+        :x_localeapp_gem_version => Localeapp::VERSION,
+        :content_type => :json },
+      :method => :post)).and_return(double('response', :code => 200))
+
+    I18n.t('absolutely.missing', { 'foo' => 'foo', 'bar' => 'bar', :default => 'a sensible default' })
   end
 end
 

data/spec/localeapp/updater_spec.rb

@@ -129,4 +129,17 @@ JA
     })
     File.exist?(File.join(@yml_dir, 'ja.yml')).should be_false
   end
+
+  if defined?(Psych) && Psych::VERSION >= "1.1.0"
+    it "doesn't try to wrap long lines in the output" do
+      do_update({
+        'translations' => {
+          'en' => { 'foo' => ('bar ' * 30) }
+         },
+         'locales' => ['en'],
+         'deleted' => []
+      })
+      File.read(File.join(@yml_dir, 'en.yml')).should match(/foo: ! 'bar bar bar bar bar bar bar bar bar bar bar bar bar bar bar bar bar bar bar bar bar bar bar bar bar bar bar bar bar bar '/m)
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: localeapp
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 11
   prerelease: 
   segments: 
   - 0
-  - 4
-  - 3
-  version: 0.4.3
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Christopher Dell
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-01 00:00:00 Z
+date: 2012-07-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: i18n
@@ -200,6 +200,7 @@ files:
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
+- Gemfile.github_project.rb
 - Gemfile.i18n_037
 - Gemfile.i18n_050
 - Gemfile.i18n_060
@@ -221,6 +222,7 @@ files:
 - lib/localeapp/cli/push.rb
 - lib/localeapp/cli/update.rb
 - lib/localeapp/configuration.rb
+- lib/localeapp/default_value_handler.rb
 - lib/localeapp/exception_handler.rb
 - lib/localeapp/i18n_shim.rb
 - lib/localeapp/key_checker.rb
@@ -247,6 +249,7 @@ files:
 - spec/localeapp/cli/push_spec.rb
 - spec/localeapp/cli/update_spec.rb
 - spec/localeapp/configuration_spec.rb
+- spec/localeapp/default_value_handler_spec.rb
 - spec/localeapp/exception_handler_spec.rb
 - spec/localeapp/key_checker_spec.rb
 - spec/localeapp/missing_translations_spec.rb
@@ -308,6 +311,7 @@ test_files:
 - spec/localeapp/cli/push_spec.rb
 - spec/localeapp/cli/update_spec.rb
 - spec/localeapp/configuration_spec.rb
+- spec/localeapp/default_value_handler_spec.rb
 - spec/localeapp/exception_handler_spec.rb
 - spec/localeapp/key_checker_spec.rb
 - spec/localeapp/missing_translations_spec.rb