web_translate_it 1.6.4 → 1.6.5

data/examples/en.yml

@@ -0,0 +1,3 @@
+fr:
+  hello: "Bonjour tout le monde"
+  test: "Ceci est un test."

data/history.md

@@ -1,3 +1,9 @@
+## Version 1.6.5 /2010-04-19
+
+* Enhancement: Remove new line on push/pull result. It now displays `Pulling config/locales/app/fr.yml… 200 OK`.
+* Enhancement: `wti stats` now propose to refresh the stats if the stats displayed are stale.
+* Bug fix: `wti push` used to crash on non-existent files. Close #24.
+
 ## Version 1.6.4 /2010-04-02
 
 * Bug fix: Rake tasks not working

data/lib/web_translate_it/command_line.rb

@@ -44,20 +44,22 @@ OPTION
     end
         
     def self.pull
+      STDOUT.sync = true
       configuration = fetch_configuration
       fetch_locales_to_pull(configuration).each do |locale|
         configuration.files.find_all{ |file| file.locale == locale }.each do |file|
-          puts "Pulling #{file.file_path}…"
+          print "Pulling #{file.file_path}… "
           puts file.fetch(ARGV.index('--force'))
         end
       end
     end
     
     def self.push
+      STDOUT.sync = true
       configuration = fetch_configuration
       fetch_locales_to_push(configuration).each do |locale|
         configuration.files.find_all{ |file| file.locale == locale }.each do |file|
-          puts "Pushing #{file.file_path}…"
+          print "Pushing #{file.file_path}… "
           puts file.upload
         end
       end
@@ -65,15 +67,8 @@ OPTION
     
     def self.autoconf
       puts "We will attempt to configure your project automagically"
-      puts "Please enter your project API Key:"
-      api_key = STDIN.gets.strip
-      if api_key == ""
-        puts "You must enter your project API key provided by Web Translate It"
-        exit
-      end
-      puts "Where should we create the configuration file? (Default: `config/translation.yml`)"
-      path = STDIN.gets.strip
-      path = "config/translation.yml" if path == ""
+      api_key = Util.ask("Please enter your project API Key")
+      path = Util.ask("Where should we create the configuration file?", 'config/translation.yml')
       FileUtils.mkpath(path.split('/')[0..path.split('/').size-1])
       project = YAML.load WebTranslateIt::Project.fetch_info(api_key)
       project_info = project['project']
@@ -103,10 +98,15 @@ OPTION
     def self.stats
       configuration = fetch_configuration
       stats = YAML.load(Project.fetch_stats(configuration.api_key))
+      stale = false
       stats.each do |locale, values|
         percent_translated = Util.calculate_percentage(values['count_strings_to_proofread'] + values['count_strings_done'] + values['count_strings_to_verify'], values['count_strings'])
         percent_completed  = Util.calculate_percentage(values['count_strings_done'], values['count_strings'])
         puts "#{locale}: #{percent_translated}% translated, #{percent_completed}% completed #{values['stale'] ? "Stale" : ""}"
+        stale = true if values['stale']
+      end
+      if stale
+        CommandLine.stats if Util.ask_yes_no("Some statistics displayed above are stale. Would you like to refresh?", true)
       end
     end
     

data/lib/web_translate_it/translation_file.rb

@@ -57,11 +57,15 @@ module WebTranslateIt
     # actually takes place.
     # This is due to the fact that language file imports are handled by background processing.
     def upload
-      File.open(self.file_path) do |file|
-        WebTranslateIt::Util.http_connection do |http|
-          request  = Net::HTTP::Put::Multipart.new(api_url, "file" => UploadIO.new(file, "text/plain", file.path))
-          Util.handle_response(http.request(request))
+      if File.exists?(self.file_path)
+        File.open(self.file_path) do |file|
+          WebTranslateIt::Util.http_connection do |http|
+            request  = Net::HTTP::Put::Multipart.new(api_url, "file" => UploadIO.new(file, "text/plain", file.path))
+            Util.handle_response(http.request(request))
+          end
         end
+      else
+        puts "\nFile #{self.file_path} doesn't exist!"
       end
     end
             

data/lib/web_translate_it/util.rb

@@ -39,14 +39,83 @@ module WebTranslateIt
       if response.code.to_i >= 400 and response.code.to_i < 500
         "We had a problem connecting to Web Translate It with this API key. Make sure it is correct."
       elsif response.code.to_i >= 500
-        "Web Translate It is temporarily unavailable. Please try again shortly."
+        "Web Translate It is temporarily unavailable and has been notified of this issue. Please try again shortly."
       else
-        if return_response
-          response.body
+        return response.body if return_response
+        return "200 OK" if response.code.to_i == 200
+        return "304 Not Modified" if response.code.to_i == 304
+      end
+    end
+    
+    ##
+    # Ask a question. Returns a true for yes, false for no, default for nil.
+    
+    def self.ask_yes_no(question, default=nil)
+      qstr = case default
+             when nil
+               'yn'
+             when true
+               'Yn'
+             else
+               'yN'
+             end
+
+      result = nil
+
+      while result.nil?
+        result = ask("#{question} [#{qstr}]")
+        result = case result
+        when /^[Yy].*/
+          true
+        when /^[Nn].*/
+          false
+        when /^$/
+        when nil
+          default
         else
-          "#{response.code.to_i} OK"
+          nil
         end
       end
+
+      return result
+    end
+    
+    ##
+    # Ask a question. Returns an answer.
+
+    def self.ask(question, default=nil)
+      question = question + " (Default: #{default})" unless default.nil?
+      print(question + "  ")
+      STDOUT.flush
+
+      result = STDIN.gets
+      result.chomp! if result
+      result = default if result.nil? or result == ''
+      result
+    end
+    
+    ##
+    # Choose from a list of options.  +question+ is a prompt displayed above
+    # the list.  +list+ is a list of option strings.  Returns the pair
+    # [option_name, option_index].
+
+    def self.choose_from_list(question, list)
+      STDOUT.puts question
+
+      list.each_with_index do |item, index|
+        STDOUT.puts " #{index+1}. #{item}"
+      end
+
+      STDOUT.print "> "
+      STDOUT.flush
+
+      result = STDIN.gets
+
+      return nil, nil unless result
+
+      result = result.strip.to_i - 1
+      return list[result], result
     end
+    
   end
 end

data/spec/web_translate_it/configuration_spec.rb

@@ -2,9 +2,10 @@ require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
 describe WebTranslateIt::Configuration do
   describe "#initialize" do
+    subject { WebTranslateIt::Configuration::Rails = OpenStruct.new(:root => Pathname.new(File.dirname(__FILE__) + "/../examples")) }
+    
     it "should fetch and not blow up" do
-      WebTranslateIt::Configuration::Rails = OpenStruct.new(:root => Pathname.new(File.dirname(__FILE__) + "/../examples"))
-      lambda{ WebTranslateIt::Configuration.new }.should_not raise_error
+      expect{ WebTranslateIt::Configuration.new }.to_not raise_error
     end
         
     it "should load the content of the YAML file" do
@@ -15,9 +16,8 @@ describe WebTranslateIt::Configuration do
       YAML.should_receive(:load_file).and_return(config_hash)
       WebTranslateIt::Configuration.new(File.dirname(__FILE__) + '/../..', 'examples/translation.yml')
     end
-    
+        
     it "should assign the API key, files" do
-      WebTranslateIt::Configuration::Rails = OpenStruct.new(:root => Pathname.new(File.dirname(__FILE__) + "/../examples"))
       configuration = WebTranslateIt::Configuration.new
       configuration.api_key.should == '4af21ce1fb3a4f7127a60b31ebc41c1446b38bb2'
       configuration.files.first.should be_a(WebTranslateIt::TranslationFile)
@@ -25,40 +25,36 @@ describe WebTranslateIt::Configuration do
   end
   
   describe "#set_locales_to_ignore" do
-    before(:each) do
-      WebTranslateIt::Configuration::Rails = OpenStruct.new(:root => Pathname.new(File.dirname(__FILE__) + "/../examples"))
-      @configuration = WebTranslateIt::Configuration.new
-    end
-      
+    let(:configuration) { WebTranslateIt::Configuration.new }
+    subject { WebTranslateIt::Configuration::Rails = OpenStruct.new(:root => Pathname.new(File.dirname(__FILE__) + "/../examples")) }
+    
     it "should return an array" do
       config_hash = { 'ignore_locales' => 'en' }
-      @configuration.set_locales_to_ignore(config_hash).should be_a(Array)
+      configuration.set_locales_to_ignore(config_hash).should be_a(Array)
     end
     
     it "should not blow up if no locales are given" do
       config_hash = { 'ignore_locales' => nil }
-      @configuration.set_locales_to_ignore(config_hash).should be_a(Array)
-      @configuration.set_locales_to_ignore(config_hash).should == []
+      configuration.set_locales_to_ignore(config_hash).should be_a(Array)
+      configuration.set_locales_to_ignore(config_hash).should == []
     end
     
     it "should return an array of 2 elements if given array of strings" do
       config_hash = { 'ignore_locales' => ['en', 'fr'] }
-      @configuration.set_locales_to_ignore(config_hash).should be_a(Array)
-      @configuration.set_locales_to_ignore(config_hash).should == ['en', 'fr']
+      configuration.set_locales_to_ignore(config_hash).should be_a(Array)
+      configuration.set_locales_to_ignore(config_hash).should == ['en', 'fr']
     end
     
     it "should return an array of 1 element if given a symbol" do
       config_hash = { 'ignore_locales' => :en }
-      @configuration.set_locales_to_ignore(config_hash).should be_a(Array)
-      @configuration.set_locales_to_ignore(config_hash).should == ['en']
+      configuration.set_locales_to_ignore(config_hash).should be_a(Array)
+      configuration.set_locales_to_ignore(config_hash).should == ['en']
     end
     
     it "should return an array of 2 element if given an array of symbol and string" do
       config_hash = { 'ignore_locales' => [:en, 'fr'] }
-      @configuration.set_locales_to_ignore(config_hash).should be_a(Array)
-      @configuration.set_locales_to_ignore(config_hash).should == ['en', 'fr']
+      configuration.set_locales_to_ignore(config_hash).should be_a(Array)
+      configuration.set_locales_to_ignore(config_hash).should == ['en', 'fr']
     end
-    
   end
-  
 end

data/spec/web_translate_it/translation_file_spec.rb

@@ -1,9 +1,6 @@
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
 describe WebTranslateIt::TranslationFile do
-  before(:each) do
-    @translation_file = WebTranslateIt::TranslationFile.new(2267, "examples/en.yml", 'fr', "4af21ce1fb3a4f7127a60b31ebc41c1446b38bb2")
-  end
   
   describe "#initialize" do
     it "should assign id, file_path and api_key" do
@@ -15,44 +12,48 @@ describe WebTranslateIt::TranslationFile do
   end
   
   describe "#fetch" do
+    let(:translation_file) { WebTranslateIt::TranslationFile.new(2267, "examples/en.yml", 'fr', "4af21ce1fb3a4f7127a60b31ebc41c1446b38bb2") }
+    
     it "should prepare a HTTP request and get a 200 OK if the language file is stale" do
       file = mock(File)
       file.stub(:puts => true, :close => true)
       File.stub(:exist? => true, :mtime => Time.at(0), :new => file)
-      @translation_file.fetch.should == "200 OK"
+      translation_file.fetch.should == "200 OK"
     end
     
     it "should prepare a HTTP request and get a 200 OK if the language file is stale using the force download parameter" do
       file = mock(File)
       file.stub(:puts => true, :close => true)
       File.stub(:exist? => true, :mtime => Time.at(0), :new => file)
-      @translation_file.fetch(true).should == "200 OK"
+      translation_file.fetch(true).should == "200 OK"
     end
     
     it "should prepare a HTTP request and get a 304 OK if the language file is fresh" do
       file = mock(File)
       file.stub(:puts => true, :close => true)
       File.stub(:exist? => true, :mtime => Time.now, :new => file)
-      @translation_file.fetch.should == "304 OK"
+      translation_file.fetch.should == "304 Not Modified"
     end
     
     it "should prepare a HTTP request and get a 200 OK if the language file is fresh using the force download parameter" do
       file = mock(File)
       file.stub(:puts => true, :close => true)
       File.stub(:exist? => true, :mtime => Time.now, :new => file)
-      @translation_file.fetch(true).should == "200 OK"
+      translation_file.fetch(true).should == "200 OK"
     end
   end
   
   describe "#upload" do
+    let(:translation_file) { WebTranslateIt::TranslationFile.new(2267, "examples/en.yml", 'fr', "4af21ce1fb3a4f7127a60b31ebc41c1446b38bb2") }
+    
     it "should prepare a HTTP request and get a 200 OK" do
-      @translation_file.stub(:file_path => File.join(File.dirname(__FILE__), '..', 'examples', 'en.yml'))
-      @translation_file.upload
+      translation_file.stub(:file_path => File.join(File.dirname(__FILE__), '..', 'examples', 'en.yml'))
+      translation_file.upload
     end
     
     it "should fail if the file does not exist" do
-      @translation_file.stub(:file_path => File.join('something', 'that', 'does', 'not', 'exist'))
-      lambda { @translation_file.upload }.should raise_error
+      translation_file.stub(:file_path => File.join('something', 'that', 'does', 'not', 'exist'))
+      expect { @translation_file.upload }.to raise_error
     end
   end
 end

data/spec/web_translate_it_spec.rb

@@ -15,7 +15,6 @@ describe WebTranslateIt do
     @file.stub(:fetch => true, :locale => true)
     @configuration.stub(:files => [@file])
     WebTranslateIt::Configuration.stub(:new => @configuration)
-    
   end
   
   describe "WebTranslateIt.fetch_translations" do

data/version.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 1
 :minor: 6
-:patch: 4
+:patch: 5

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 6
-  - 4
-  version: 1.6.4
+  - 5
+  version: 1.6.5
 platform: ruby
 authors: 
 - "\xC3\x89douard Bri\xC3\xA8re"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-02 00:00:00 +02:00
+date: 2010-04-19 00:00:00 +02:00
 default_executable: wti
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,8 +40,8 @@ dependencies:
         segments: 
         - 1
         - 2
-        - 0
-        version: 1.2.0
+        - 9
+        version: 1.2.9
   type: :development
   version_requirements: *id002
 description: A rack middleware and a handful of rake tasks to sync your translations between webtranslateit.com and your rails applications.
@@ -58,6 +58,7 @@ files:
 - MIT-LICENSE
 - README.md
 - version.yml
+- examples/en.yml
 - examples/locale.rb
 - examples/translation.yml
 - lib/web_translate_it/auto_fetch.rb