localeapp 0.5.2 → 0.6.0

data/lib/localeapp/configuration.rb

@@ -44,33 +44,6 @@ module Localeapp
     # (defaults to 'development')
     attr_accessor :polling_environments
 
-    # @deprecated Use {#sending_environments} instead. This is safer but make sure to reverse your logic if you've changed the defaults
-    # The names of environments where notifications aren't sent (defaults to
-    # 'test', 'cucumber', 'production')
-    attr_accessor :disabled_sending_environments
-    def disabled_sending_environments=(value)
-      @deprecated_environment_config_used = true
-      @disabled_sending_environments = value
-    end
-
-    # @deprecated Use {#reloading_environments} instead. This is safer but make sure to reverse your logic if you've changed the defaults
-    # The names of environments where I18n.reload isn't called for each request
-    # (defaults to 'test', 'cucumber', 'production')
-    attr_accessor :disabled_reloading_environments
-    def disabled_reloading_environments=(value)
-      @deprecated_environment_config_used = true
-      @disabled_reloading_environments = value
-    end
-
-    # @deprecated Use {#polling_environments} instead. This is safer but make sure to reverse your logic if you've changed the defaults
-    # The names of environments where updates aren't pulled (defaults to
-    # 'test', 'cucumber', 'production')
-    attr_accessor :disabled_polling_environments
-    def disabled_polling_environments=(value)
-      @deprecated_environment_config_used = true
-      @disabled_polling_environments = value
-    end
-
     # The logger used by Localeapp
     attr_accessor :logger
 
@@ -94,56 +67,43 @@ module Localeapp
     # The complete path to the directory where translations are stored
     attr_accessor :translation_data_directory
 
-    def deprecated_environment_config_used?
-      @deprecated_environment_config_used
+    def initialize
+      defaults.each do |setting, value|
+        send("#{setting}=", value)
+      end
     end
 
-    def initialize
-      @host                            = 'api.localeapp.com'
-      @secure                          = true
-      @ssl_verify                      = false
-      @disabled_sending_environments   = %w(test cucumber production)
-      @disabled_reloading_environments = %w(test cucumber production)
-      @disabled_polling_environments   = %w(test cucumber production)
-      @sending_environments            = %w(development)
-      @reloading_environments          = %w(development)
-      @polling_environments            = %w(development)
-      @poll_interval                   = 0
-      @synchronization_data_file       = File.join('log', 'localeapp.yml')
-      @daemon_pid_file                 = File.join('tmp', 'pids', 'localeapp.pid')
-      @daemon_log_file                 = File.join('log', 'localeapp_daemon.log')
-      @translation_data_directory      = File.join('config', 'locales')
+    def defaults
+      defaults = {
+        :host                       => 'api.localeapp.com',
+        :secure                     => true,
+        :ssl_verify                 => false,
+        :sending_environments       => %w(development),
+        :reloading_environments     => %w(development),
+        :polling_environments       => %w(development),
+        :poll_interval              => 0,
+        :synchronization_data_file  => File.join('log', 'localeapp.yml'),
+        :daemon_pid_file            => File.join('tmp', 'pids', 'localeapp.pid'),
+        :daemon_log_file            => File.join('log', 'localeapp_daemon.log'),
+        :translation_data_directory => File.join('config', 'locales'),
+      }
       if ENV['DEBUG']
         require 'logger'
-        @logger = Logger.new(STDOUT)
+        defaults[:logger] = Logger.new(STDOUT)
       end
+      defaults
     end
 
     def polling_disabled?
-      if deprecated_environment_config_used?
-        ::Localeapp.log "DEPRECATION: disabled_polling_environments is deprecated and will be removed. Use polling_environments instead and reverse the logic if you've changed the defaults"
-        disabled_polling_environments.map { |v| v.to_s }.include?(environment_name)
-      else
-        !polling_environments.map { |v| v.to_s }.include?(environment_name)
-      end
+      !polling_environments.map { |v| v.to_s }.include?(environment_name)
     end
 
     def reloading_disabled?
-      if deprecated_environment_config_used?
-        ::Localeapp.log "DEPRECATION: disabled_reloading_environments is deprecated and will be removed. Use reloading_environments instead and reverse the logic if you've changed the defaults"
-        disabled_reloading_environments.map { |v| v.to_s }.include?(environment_name)
-      else
-        !reloading_environments.map { |v| v.to_s }.include?(environment_name)
-      end
+      !reloading_environments.map { |v| v.to_s }.include?(environment_name)
     end
 
     def sending_disabled?
-      if deprecated_environment_config_used?
-        ::Localeapp.log "DEPRECATION: disabled_sending_environments is deprecated and will be removed. Use sending_environments instead and reverse the logic if you've changed the defaults"
-        disabled_sending_environments.map { |v| v.to_s }.include?(environment_name)
-      else
-        !sending_environments.map { |v| v.to_s }.include?(environment_name)
-      end
+      !sending_environments.map { |v| v.to_s }.include?(environment_name)
     end
 
     def write_rails_configuration(path)

data/lib/localeapp/default_value_handler.rb

@@ -3,15 +3,7 @@ module I18n::Backend::Base
 
   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
-
+    Localeapp.missing_translations.add(locale, object, subject, options)
     return result
   end
 end

data/lib/localeapp/version.rb

@@ -1,3 +1,3 @@
 module Localeapp
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

data/lib/localeapp.rb

@@ -35,11 +35,13 @@ require 'localeapp/key_checker'
 require 'localeapp/missing_translations'
 require 'localeapp/default_value_handler'
 
+require 'localeapp/cli/command'
 require 'localeapp/cli/install'
 require 'localeapp/cli/pull'
 require 'localeapp/cli/push'
 require 'localeapp/cli/update'
 require 'localeapp/cli/add'
+require 'localeapp/cli/daemon'
 
 # AUDIT: Will this work on ruby 1.9.x
 $KCODE="UTF8" if RUBY_VERSION < '1.9'
@@ -88,27 +90,22 @@ module Localeapp
     # end
     def configure
       self.configuration ||= Configuration.new
-      yield(configuration)
+      yield(configuration) if block_given?
       self.sender  = Sender.new
       self.poller  = Poller.new
       self.updater = Updater.new
       @missing_translations = MissingTranslations.new
     end
 
-    # requires the Localeapp configuration
-    def initialize_config(file_path=nil)
-      file_paths = [ File.join(Dir.pwd, '.localeapp', 'config.rb'),
-                     File.join(Dir.pwd, 'config', 'initializers', 'localeapp.rb') ]
-      file_paths << file_path if file_path
-      file_paths.each do |path|
-        next unless File.exists? path
-        begin
-          require path
-          return true
-        rescue
-        end
-      end
-      false
+    def has_config_file?
+      default_config_file_paths.any? { |path| File.exists?(path) }
+    end
+
+    def default_config_file_paths
+      [
+        File.join(Dir.pwd, '.localeapp', 'config.rb'),
+        File.join(Dir.pwd, 'config', 'initializers', 'localeapp.rb')
+      ]
     end
 
     def load_yaml(contents)

data/spec/localeapp/cli/add_spec.rb

@@ -8,7 +8,7 @@ describe Localeapp::CLI::Add, "#execute(key, *translations)" do
 
   before(:each) do
     @output = StringIO.new
-    @command = Localeapp::CLI::Add.new(@output)
+    @command = Localeapp::CLI::Add.new(:output => @output)
   end
 
   it "adds the translations to missing_translations" do

data/spec/localeapp/cli/daemon_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Localeapp::CLI::Daemon, "#execute(options)" do
+  let(:output) { StringIO.new }
+  let(:command) { Localeapp::CLI::Daemon.new(:output => output) }
+  let(:interval) { 5 }
+
+  before do
+    command.stub(:update_loop)
+  end
+
+  it "exits when interval isn't greater than 0" do
+    command.should_receive(:exit_now!)
+    command.execute(:interval => -1)
+  end
+
+  it "runs the loop directly when not running in background" do
+    command.should_receive(:update_loop).with(interval)
+    command.execute(:interval => interval)
+  end
+
+  it "runs the loop in the background when background options set" do
+    command.should_receive(:run_in_background).with(interval)
+    command.execute(:interval => interval, :background => true)
+  end
+end
+
+describe Localeapp::CLI::Daemon, "#do_update" do
+  let(:output) { StringIO.new }
+  let(:command) { Localeapp::CLI::Daemon.new(:output => output) }
+
+  it "creates and executes and Updater" do
+    stub = stub(:updater)
+    stub.should_receive(:execute)
+    Localeapp::CLI::Update.should_receive(:new).and_return(stub)
+    command.do_update
+  end
+end

data/spec/localeapp/cli/install_spec.rb

@@ -4,24 +4,24 @@ require 'localeapp/cli/install'
 describe Localeapp::CLI::Install, '.execute(key, output = $stdout)' do
   before(:each) do
     @output = StringIO.new
-    @command = Localeapp::CLI::Install.new
+    @command = Localeapp::CLI::Install.new(:output => @output)
   end
 
   it "displays error if key is nil" do
-    @command.execute(nil, @output)
+    @command.execute(nil)
     @output.string.should match(/You must supply an API key/)
   end
 
   it "displays error if the key is there but isn't valid on localeapp.com" do
     @command.stub!(:check_key).and_return([false, {}])
-    @command.execute('API_KEY', @output)
+    @command.execute('API_KEY')
     @output.string.should match(/Project not found/)
   end
 
   it "displays project name and base locale if the key is there and valid on localeapp.com" do
     @command.stub!(:check_key).and_return([true, valid_project_data])
     @command.stub!(:write_configuration_file)
-    @command.execute('API_KEY', @output)
+    @command.execute('API_KEY')
     @output.string.should match(/Test Project/)
     @output.string.should match(/en \(English\)/)
   end
@@ -30,27 +30,27 @@ describe Localeapp::CLI::Install, '.execute(key, output = $stdout)' do
     I18n.stub(:default_locale).and_return(:es)
     @command.stub!(:check_key).and_return([true, valid_project_data])
     @command.stub!(:write_configuration_file)
-    @command.execute('API_KEY', @output)
+    @command.execute('API_KEY')
     @output.string.should match(%r{WARNING: I18n.default_locale is es, change in config/environment.rb \(Rails 2\) or config/application.rb \(Rails 3\)})
   end
 
   it "asks the default configuration to write itself" do
     @command.stub!(:check_key).and_return([true, valid_project_data])
     @command.should_receive(:write_configuration_file).with('config/initializers/localeapp.rb')
-    @command.execute('API_KEY', @output)
+    @command.execute('API_KEY')
   end
 
   it "asks the configuration to write itself to .localeapp when the --standalone switch is set" do
     @command.stub!(:check_key).and_return([true, valid_project_data])
     @command.config_type = :standalone
     @command.should_receive(:write_configuration_file).with('.localeapp/config.rb')
-    @command.execute('API_KEY', @output)
+    @command.execute('API_KEY')
   end
 
   it "displays warning if config.translation_data_directory doesn't exist" do
     @command.stub!(:check_key).and_return([true, valid_project_data])
     @command.stub!(:write_configuration_file)
-    @command.execute('API_KEY', @output)
+    @command.execute('API_KEY')
     @output.string.should match(/Your translation data will be stored there./)
   end
 
@@ -58,7 +58,7 @@ describe Localeapp::CLI::Install, '.execute(key, output = $stdout)' do
     @command.stub!(:check_key).and_return([true, valid_project_data])
     @command.stub!(:write_configuration_file)
     File.should_receive(:directory?).and_return(true)
-    @command.execute('API_KEY', @output)
+    @command.execute('API_KEY')
     @output.string.should_not match(/Your translation data will be stored there./)
   end
 
@@ -66,6 +66,6 @@ describe Localeapp::CLI::Install, '.execute(key, output = $stdout)' 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)
+    @command.execute('API_KEY')
   end
 end

data/spec/localeapp/cli/pull_spec.rb

@@ -4,7 +4,7 @@ require 'localeapp/cli/pull'
 describe Localeapp::CLI::Pull, "#execute" do
   before do
     @output = StringIO.new
-    @puller = Localeapp::CLI::Pull.new(@output)
+    @puller = Localeapp::CLI::Pull.new(:output => @output)
   end
 
   it "makes the api call to the translations endpoint" do
@@ -24,7 +24,7 @@ describe Localeapp::CLI::Pull, "#update_backend(response)" do
   before do
     @test_data = ['test data'].to_json
     @output = StringIO.new
-    @puller = Localeapp::CLI::Pull.new(@output)
+    @puller = Localeapp::CLI::Pull.new(:output => @output)
   end
 
   it "calls the updater" do

data/spec/localeapp/cli/push_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Localeapp::CLI::Push, "#execute(path)" do
   let(:output) { StringIO.new }
-  let(:pusher) { Localeapp::CLI::Push.new(output) }
+  let(:pusher) { Localeapp::CLI::Push.new(:output => output) }
 
   context "path is a directory" do
     it "calls push_file on each yaml file in the directory" do
@@ -33,7 +33,7 @@ end
 
 describe Localeapp::CLI::Push, "#push_file(file_path)" do
   let(:output) { StringIO.new }
-  let(:pusher) { Localeapp::CLI::Push.new(output) }
+  let(:pusher) { Localeapp::CLI::Push.new(:output => output) }
 
   it "creates a new file object and makes the api call to the translations endpoint" do
     with_configuration do

data/spec/localeapp/cli/update_spec.rb

@@ -4,7 +4,7 @@ require 'localeapp/cli/update'
 describe Localeapp::CLI::Update, "#execute" do
   before do
     @output = StringIO.new
-    @updater = Localeapp::CLI::Update.new(@output)
+    @updater = Localeapp::CLI::Update.new(:output => @output)
   end
 
   it "creates a Poller and calls poll! on it" do

data/spec/localeapp/configuration_spec.rb

@@ -95,210 +95,63 @@ describe Localeapp::Configuration do
     end
   end
 
-  context "disabled_sending_environments" do
-    it "sets deprecated_environment_config_used flag to true" do
-      configuration.disabled_sending_environments = %w(foo bar)
-      configuration.deprecated_environment_config_used?.should be_true
-    end
-
-    it "does not include development by default" do
-      configuration.environment_name = 'development'
-      configuration.sending_disabled?.should be_false
-    end
-
-    it "include cucumber by default" do
-      configuration.environment_name = 'cucumber'
-      configuration.sending_disabled?.should be_true
-    end
-
-    it "include test by default" do
-      configuration.environment_name = 'test'
-      configuration.sending_disabled?.should be_true
-    end
-
-    it "include production by default" do
-      configuration.environment_name = 'production'
-      configuration.sending_disabled?.should be_true
-    end
-  end
-
-  context "disabled_reloading_environments" do
-    it "sets deprecated_environment_config_used flag to true" do
-      configuration.disabled_reloading_environments = %w(foo bar)
-      configuration.deprecated_environment_config_used?.should be_true
-    end
-
-    it "does not include development by default" do
-      configuration.environment_name = 'development'
-      configuration.reloading_disabled?.should be_false
-    end
-
-    it "include cucumber by default" do
-      configuration.environment_name = 'cucumber'
-      configuration.reloading_disabled?.should be_true
+  describe "polling_disabled?" do
+    it "is true when environment is not enabled" do
+      configuration.polling_environments = %w(foo)
+      configuration.environment_name = 'bar'
+      configuration.should be_polling_disabled
     end
 
-    it "include test by default" do
-      configuration.environment_name = 'test'
-      configuration.reloading_disabled?.should be_true
+    it "is false when environment is enabled" do
+      configuration.polling_environments = %w(foo)
+      configuration.environment_name = 'foo'
+      configuration.should_not be_polling_disabled
     end
 
-    it "include production by default" do
-      configuration.environment_name = 'production'
-      configuration.reloading_disabled?.should be_true
+    it "supports symbols in list of environments" do
+      configuration.polling_environments = [:foo]
+      configuration.environment_name = 'foo'
+      configuration.should_not be_polling_disabled
     end
   end
-  
-  context "disabled_polling_environments" do
-    it "sets deprecated_environment_config_used flag to true" do
-      configuration.disabled_polling_environments = %w(foo bar)
-      configuration.deprecated_environment_config_used?.should be_true
-    end
-
-    it "does not include development by default" do
-      configuration.environment_name = 'development'
-      configuration.polling_disabled?.should be_false
-    end
-
-    it "include cucumber by default" do
-      configuration.environment_name = 'cucumber'
-      configuration.polling_disabled?.should be_true
-    end
-
-    it "include test by default" do
-      configuration.environment_name = 'test'
-      configuration.polling_disabled?.should be_true
-    end
 
-    it "include production by default" do
-      configuration.environment_name = 'production'
-      configuration.polling_disabled?.should be_true
+  describe "reloading_disabled?" do
+    it "is true when environment is not enabled" do
+      configuration.reloading_environments = %w(foo)
+      configuration.environment_name = 'bar'
+      configuration.should be_reloading_disabled
     end
-  end
 
-  describe "polling_disabled?" do
-    context "deprecated syntax used" do
-      it "is true when environment is disabled" do
-        configuration.disabled_polling_environments = %w(foo)
-        configuration.environment_name = 'foo'
-        configuration.should be_polling_disabled
-      end
-
-      it "is false when environment is not disabled" do
-        configuration.disabled_polling_environments = %w(foo)
-        configuration.environment_name = 'bar'
-        configuration.should_not be_polling_disabled
-      end
-
-      it "supports symbols in list of environments" do
-        configuration.disabled_polling_environments = [:foo]
-        configuration.environment_name = 'foo'
-        configuration.should be_polling_disabled
-      end
+    it "is false when environment is enabled" do
+      configuration.reloading_environments = %w(foo)
+      configuration.environment_name = 'foo'
+      configuration.should_not be_reloading_disabled
     end
 
-    context "new syntax used" do
-      it "is true when environment is not enabled" do
-        configuration.polling_environments = %w(foo)
-        configuration.environment_name = 'bar'
-        configuration.should be_polling_disabled
-      end
-
-      it "is false when environment is enabled" do
-        configuration.polling_environments = %w(foo)
-        configuration.environment_name = 'foo'
-        configuration.should_not be_polling_disabled
-      end
-
-      it "supports symbols in list of environments" do
-        configuration.polling_environments = [:foo]
-        configuration.environment_name = 'foo'
-        configuration.should_not be_polling_disabled
-      end
+    it "supports symbols in list of environments" do
+      configuration.reloading_environments = [:foo]
+      configuration.environment_name = 'foo'
+      configuration.should_not be_reloading_disabled
     end
   end
 
-  describe "reloading_disabled?" do
-    context "deprecated syntax used" do
-      it "is true when environment is disabled" do
-        configuration.disabled_reloading_environments = %w(foo)
-        configuration.environment_name = 'foo'
-        configuration.should be_reloading_disabled
-      end
-
-      it "is false when environment is not disabled" do
-        configuration.disabled_reloading_environments = %w(foo)
-        configuration.environment_name = 'bar'
-        configuration.should_not be_reloading_disabled
-      end
-
-      it "supports symbols in list of environments" do
-        configuration.disabled_reloading_environments = [:foo]
-        configuration.environment_name = 'foo'
-        configuration.should be_reloading_disabled
-      end
-    end
-
-    context "new syntax used" do
-      it "is true when environment is not enabled" do
-        configuration.reloading_environments = %w(foo)
-        configuration.environment_name = 'bar'
-        configuration.should be_reloading_disabled
-      end
-
-      it "is false when environment is enabled" do
-        configuration.reloading_environments = %w(foo)
-        configuration.environment_name = 'foo'
-        configuration.should_not be_reloading_disabled
-      end
-
-      it "supports symbols in list of environments" do
-        configuration.reloading_environments = [:foo]
-        configuration.environment_name = 'foo'
-        configuration.should_not be_reloading_disabled
-      end
+  describe "sending_disabled?" do
+    it "is true when environment is not enabled" do
+      configuration.sending_environments = %w(foo)
+      configuration.environment_name = 'bar'
+      configuration.should be_sending_disabled
     end
-  end
 
-  describe "sending_disabled?" do
-    context "deprecated syntax used" do
-      it "is true when environment is disabled" do
-        configuration.disabled_sending_environments = %w(foo)
-        configuration.environment_name = 'foo'
-        configuration.should be_sending_disabled
-      end
-
-      it "is false when environment is not disabled" do
-        configuration.disabled_sending_environments = %w(foo)
-        configuration.environment_name = 'bar'
-        configuration.should_not be_sending_disabled
-      end
-
-      it "supports symbols in the list of enviroments" do
-        configuration.disabled_sending_environments = [:foo]
-        configuration.environment_name = 'foo'
-        configuration.should be_sending_disabled
-      end
+    it "is false when environment is enabled" do
+      configuration.sending_environments = %w(foo)
+      configuration.environment_name = 'foo'
+      configuration.should_not be_sending_disabled
     end
 
-    context "new syntax used" do
-      it "is true when environment is not enabled" do
-        configuration.sending_environments = %w(foo)
-        configuration.environment_name = 'bar'
-        configuration.should be_sending_disabled
-      end
-
-      it "is false when environment is enabled" do
-        configuration.sending_environments = %w(foo)
-        configuration.environment_name = 'foo'
-        configuration.should_not be_sending_disabled
-      end
-
-      it "supports symbols in the list of environments" do
-        configuration.sending_environments = [:foo]
-        configuration.environment_name = 'foo'
-        configuration.should_not be_sending_disabled
-      end
+    it "supports symbols in the list of environments" do
+      configuration.sending_environments = [:foo]
+      configuration.environment_name = 'foo'
+      configuration.should_not be_sending_disabled
     end
   end
 end

data/spec/localeapp/default_value_handler_spec.rb

@@ -7,19 +7,10 @@ end
 describe I18n::Backend::Base, '#default' do
   let(:klass) { Klass.new }
 
-  it "posts translations to Locale" do
+  it "adds translations to missing translations to send 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')
+      Localeapp.missing_translations.should_receive(:add).with(:en, 'foo', 'bar', :baz => 'bam')
+      klass.default(:en, 'foo', 'bar', :baz => 'bam')
     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
+end