localeapp 0.5.2 → 0.6.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# Version 0.6.0
+
+* Support passing -k or --api-key option to commands
+* Remove deprecated disabled_* configuration options
+* Fix performance bug when :default specified in I18n.t call
+
 # Version 0.5.2
 
 * Fix bug with pulling translations changing file permissions
@@ -80,10 +86,3 @@
 * Removed some unnecessary default options from config files generated with 
   `localeapp install`
 * Fixed `localeapp push` with no arguments
-
-## NOTICE
-
-If you've added disabled_polling_environments, 
-disabled_reloading_environments or disabled_sending_environments to your 
-initializer you should change these to polling_environments, 
-reloading_environments and sending_environments and configure as per the README

data/Gemfile.github_project.rb

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

data/bin/localeapp

@@ -14,13 +14,6 @@ if ENV['FAKE_WEB_DURING_CUCUMBER_RUN'] && fake_data_as_json = ENV['FAKE_WEB_FAKE
   end
 end
 
-def initialize_config
-  unless Localeapp.initialize_config
-    puts "Could not load config file"
-    exit 1
-  end
-end
-
 require 'gli'
 gli2 = GLI::VERSION >= '2.0.0'
 
@@ -30,9 +23,22 @@ else
   include GLI
 end
 
+pre do |global_options, command, options, args|
+  if Localeapp.has_config_file? || !global_options[:k].nil?
+    true
+  else
+    puts "Could not load config file and no key specified"
+    exit 1
+  end
+end
+
+desc "API Key (for when there is no configuration file)"
+flag [:k, 'api-key']
+
 version Localeapp::VERSION
 
 desc "Creates new configuration files and confirms key works"
+skips_pre
 arg_name "<api_key>"
 command :install do |c|
   c.desc "install configuration files in .localeapp/"
@@ -61,8 +67,7 @@ command :add do |c|
     if key.nil? || args.size.zero?
       exit_now! "localeapp add requires a key name and at least one translation", 1
     else
-      initialize_config
-      Localeapp::CLI::Add.new.execute(key, *args)
+      Localeapp::CLI::Add.new(global_options).execute(key, *args)
     end
   end
 end
@@ -70,8 +75,7 @@ end
 desc "Pulls all translations from localeapp.com"
 command :pull do |c|
   c.action do |global_options, options, args|
-    initialize_config
-    Localeapp::CLI::Pull.new.execute
+    Localeapp::CLI::Pull.new(global_options).execute
   end
 end
 
@@ -83,8 +87,7 @@ command :push do |c|
       exit_now! "localeapp push requires an file or directory to push", 1
     else
       path = args.first
-      initialize_config
-      pusher = Localeapp::CLI::Push.new
+      pusher = Localeapp::CLI::Push.new(global_options)
       pusher.execute(path)
     end
   end
@@ -93,8 +96,7 @@ end
 desc "Gets any changes since the last poll and updates the yml"
 command :update do |c|
   c.action do |global_options, options, args|
-    initialize_config
-    Localeapp::CLI::Update.new.execute
+    Localeapp::CLI::Update.new(global_options).execute
   end
 end
 
@@ -109,42 +111,7 @@ command :daemon do |c|
   c.switch [:b, 'background']
 
   c.action do |global_options, options, args|
-    initialize_config
-
-    interval = options[:interval].to_i
-
-    if interval <= 0
-      exit_now! "interval must be a positive integer greater than 0", 1
-    end
-
-    command = Proc.new do
-      loop do
-        Localeapp::CLI::Update.new.execute
-        sleep interval
-      end
-    end
-    if options[:background]
-
-      if File.exists? Localeapp.configuration.daemon_pid_file
-        begin
-          daemon_pid = File.read(Localeapp.configuration.daemon_pid_file)
-          Process.kill("QUIT", daemon_pid.to_i)
-        rescue Errno::ESRCH
-          File.delete(Localeapp.configuration.daemon_pid_file)
-        end
-      end
-
-      STDOUT.reopen(File.open(Localeapp.configuration.daemon_log_file, 'a'))
-      pid = fork do
-        Signal.trap('HUP', 'IGNORE')
-        command.call
-      end
-      Process.detach(pid)
-
-      File.open(Localeapp.configuration.daemon_pid_file, 'w') {|f| f << pid}
-    else
-      command.call
-    end
+    Localeapp::CLI::Daemon.new(global_options).execute(options)
   end
 end
 

data/features/add.feature

@@ -0,0 +1,46 @@
+Feature: Adding a translation from the command line
+
+  Scenario: Running add
+    In order to add a key and translation content
+    When I have a valid project on localeapp.com with api key "MYAPIKEY"
+    And an initializer file
+    When I run `localeapp add foo.baz en:"test en content" es:"test es content"`
+    Then the output should contain:
+    """
+    Localeapp Add
+
+    Sending key: foo.baz
+    Success!
+    """
+
+  Scenario: Running add with no arguments
+    In order to add a key and translation content
+    When I have a valid project on localeapp.com with api key "MYAPIKEY"
+    And an initializer file
+    When I run `localeapp add`
+    Then the output should contain:
+    """
+    localeapp add requires a key name and at least one translation
+    """
+
+  Scenario: Running add with just a key name
+    In order to add a key and translation content
+    When I have a valid project on localeapp.com with api key "MYAPIKEY"
+    And an initializer file
+    When I run `localeapp add foo.bar`
+    Then the output should contain:
+    """
+    localeapp add requires a key name and at least one translation
+    """
+
+  Scenario: Running add with no initializer file, passing the key on the command line
+    In order to add a key and translation content
+    When I have a valid project on localeapp.com with api key "MYAPIKEY"
+    When I run `localeapp -k MYAPIKEY add foo.baz en:"test en content"`
+    Then the output should contain:
+    """
+    Localeapp Add
+
+    Sending key: foo.baz
+    Success!
+    """

data/features/bad_command.feature

@@ -0,0 +1,8 @@
+Feature: localeapp executable
+  Scenario: Running a command that doesn't exist
+    In order to warn of a bad command
+    When I run `localeapp foo`
+    Then the output should contain:
+    """
+    error: Unknown command 'foo'
+    """

data/features/help.feature

@@ -0,0 +1,9 @@
+Feature: Getting help
+
+  Scenario: Viewing help
+    In order to see what options I have
+    When I run `localeapp help`
+    Then the output should contain:
+    """
+    localeapp [global options] command [command options]
+    """

data/features/install.feature

@@ -0,0 +1,70 @@
+Feature: Installation
+
+  Scenario: Running Rails install
+    In order to configure my 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 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 "config/initializers/localeapp.rb" should exist
+    And the exit status should be 0
+
+  Scenario: Running standalone install
+    In order to configure my non rails 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 --standalone 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 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
+    When I have a valid project on localeapp.com but an incorrect api key "BADAPIKEY"
+    And I run `localeapp install BADAPIKEY`
+    Then the output should contain:
+    """
+    Localeapp Install
+
+    Checking API key: BADAPIKEY
+    ERROR: Project not found
+    """
+    And help should not be displayed
+    And a file named "config/initializers/localeapp.rb" should not exist
+    And the exit status should not be 0

data/features/pull.feature

@@ -0,0 +1,46 @@
+Feature: Pulling all translation
+
+  Scenario: Running pull
+    In order to retrieve my translations
+    Given I have a translations on localeapp.com for the project with api key "MYAPIKEY"
+    And an initializer file
+    And a directory named "config/locales"
+    When I run `localeapp pull`
+    Then the output should contain:
+    """
+    Localeapp Pull
+
+    Fetching translations:
+    Success!
+    Updating backend:
+    Success!
+    """
+    And help should not be displayed
+    And a file named "config/locales/en.yml" should exist
+
+  Scenario: Running pull without having a locales dir
+    In order to retreive my translations
+    Given I have a translations on localeapp.com for the project with api key "MYAPIKEY"
+    And an initializer file
+    When I run `localeapp pull`
+    Then the output should contain:
+    """
+    Could not write locale file, please make sure that config/locales exists and is writeable
+    """
+
+  Scenario: Running pull with no initializer file, passing the key on the command line
+    In order to retrieve my translations
+    Given I have a translations on localeapp.com for the project with api key "MYAPIKEY"
+    And a directory named "config/locales"
+    When I run `localeapp -k MYAPIKEY pull`
+    Then the output should contain:
+    """
+    Localeapp Pull
+
+    Fetching translations:
+    Success!
+    Updating backend:
+    Success!
+    """
+    And help should not be displayed
+    And a file named "config/locales/en.yml" should exist

data/features/push.feature

@@ -0,0 +1,57 @@
+Feature: Pushing existing translation to localeapp
+
+  Scenario: Running push on a file
+    In order to send my translations
+    When I have a valid project on localeapp.com with api key "MYAPIKEY"
+    And an initializer file
+    And an empty file named "config/locales/en.yml"
+    When I run `localeapp push config/locales/en.yml`
+    Then the output should contain:
+    """
+    Localeapp Push
+
+    Pushing file en.yml:
+    Success!
+
+    config/locales/en.yml queued for processing.
+    """
+    And help should not be displayed
+
+  Scenario: Running push on a directory
+    In order to send my translations
+    When I have a valid project on localeapp.com with api key "MYAPIKEY"
+    And an initializer file
+    And an empty file named "config/locales/en.yml"
+    And an empty file named "config/locales/es.yml"
+    When I run `localeapp push config/locales`
+    Then the output should contain:
+    """
+    Localeapp Push
+
+    Pushing file en.yml:
+    Success!
+
+    config/locales/en.yml queued for processing.
+
+    Pushing file es.yml:
+    Success!
+
+    config/locales/es.yml queued for processing.
+    """
+    And help should not be displayed
+
+  Scenario: Running push on a file with no initializer file, passing the key on the command line
+    In order to send my translations
+    When I have a valid project on localeapp.com with api key "MYAPIKEY"
+    And an empty file named "config/locales/en.yml"
+    When I run `localeapp -k MYAPIKEY push config/locales/en.yml`
+    Then the output should contain:
+    """
+    Localeapp Push
+
+    Pushing file en.yml:
+    Success!
+
+    config/locales/en.yml queued for processing.
+    """
+    And help should not be displayed

data/features/update.feature

@@ -0,0 +1,44 @@
+Feature: Getting new translations
+
+  Scenario: Running update
+    In order to receive the translations that have been updated since the last check
+    When I have a valid project on localeapp.com with api key "MYAPIKEY"
+    And an initializer file
+    And a file named "log/localeapp.yml" with:
+    """
+    ---
+    :updated_at: 120
+    :polled_at: 130
+    """
+    And new translations for the api key "MYAPIKEY" since "120" with time "140"
+    And a directory named "config/locales"
+    When I run `localeapp update`
+    Then the output should contain:
+    """
+    Localeapp update: checking for translations since 120
+    Found and updated new translations
+    """
+    And help should not be displayed
+    And a file named "config/locales/en.yml" should exist
+    # check the content here
+    # and the localeapp.yml file
+
+  Scenario: Running update with no initializer file, passing the key on the command line
+    In order to receive the translations that have been updated since the last check
+    When I have a valid project on localeapp.com with api key "MYAPIKEY"
+    And a file named "log/localeapp.yml" with:
+    """
+    ---
+    :updated_at: 120
+    :polled_at: 130
+    """
+    And new translations for the api key "MYAPIKEY" since "120" with time "140"
+    And a directory named "config/locales"
+    When I run `localeapp -k MYAPIKEY update`
+    Then the output should contain:
+    """
+    Localeapp update: checking for translations since 120
+    Found and updated new translations
+    """
+    And help should not be displayed
+    And a file named "config/locales/en.yml" should exist

data/lib/localeapp/cli/add.rb

@@ -1,10 +1,6 @@
 module Localeapp
   module CLI
-    class Add
-      def initialize(output = $stdout)
-        @output = output
-      end
-
+    class Add < Command
       def execute(key, *translations)
         @output.puts "Localeapp Add"
         @output.puts ""

data/lib/localeapp/cli/command.rb

@@ -0,0 +1,34 @@
+module Localeapp
+  module CLI
+    class Command
+      def initialize(args = {})
+        initialize_config(args)
+        @output = args[:output] || $stdout
+      end
+
+      # requires the Localeapp configuration
+      def initialize_config(args = {})
+        Localeapp.configure # load defaults
+        load_config_file
+        set_command_line_arguments(args)
+      end
+
+      def set_command_line_arguments(args = {})
+        sanitized_args = {}
+        if args[:k]
+          sanitized_args[:api_key] = args[:k]
+        end
+        sanitized_args.each do |setting, value|
+          Localeapp.configuration.send("#{setting}=", value)
+        end
+      end
+
+      def load_config_file
+        Localeapp.default_config_file_paths.each do |path|
+          next unless File.exists? path
+          require path
+        end
+      end
+    end
+  end
+end

data/lib/localeapp/cli/daemon.rb

@@ -0,0 +1,54 @@
+module Localeapp
+  module CLI
+    class Daemon < Command
+      def execute(options)
+        interval = options[:interval].to_i
+
+        if interval <= 0
+          exit_now! "interval must be a positive integer greater than 0", 1
+        end
+
+        if options[:background]
+          run_in_background(interval)
+        else
+          update_loop(interval)
+        end
+      end
+
+      def update_loop(interval)
+        loop do
+          do_update
+          sleep interval
+        end
+      end
+
+      def do_update
+        Localeapp::CLI::Update.new.execute
+      end
+
+      def run_in_background(interval)
+        kill_existing
+
+        STDOUT.reopen(File.open(Localeapp.configuration.daemon_log_file, 'a'))
+        pid = fork do
+          Signal.trap('HUP', 'IGNORE')
+          update_loop(interval)
+        end
+        Process.detach(pid)
+
+        File.open(Localeapp.configuration.daemon_pid_file, 'w') {|f| f << pid}
+      end
+
+      def kill_existing
+        if File.exists? Localeapp.configuration.daemon_pid_file
+          begin
+            daemon_pid = File.read(Localeapp.configuration.daemon_pid_file)
+            Process.kill("QUIT", daemon_pid.to_i)
+          rescue Errno::ESRCH
+            File.delete(Localeapp.configuration.daemon_pid_file)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/localeapp/cli/install.rb

@@ -1,42 +1,43 @@
 module Localeapp
   module CLI
-    class Install
+    class Install < Command
       attr_accessor :config_type
 
-      def initialize
+      def initialize(args = {})
+        super
         @config_type = :rails
       end
 
-      def execute(key, output = $stdout)
-        output.puts "Localeapp Install"
-        output.puts ""
-        output.puts "Checking API key: #{key}"
+      def execute(key)
+        @output.puts "Localeapp Install"
+        @output.puts ""
+        @output.puts "Checking API key: #{key}"
         if key.nil?
-          output.puts "ERROR: You must supply an API key"
+          @output.puts "ERROR: You must supply an API key"
           return
         end
         valid_key, project_data = check_key(key)
         if valid_key
-          output.puts "Success!"
-          output.puts "Project: #{project_data['name']}"
+          @output.puts "Success!"
+          @output.puts "Project: #{project_data['name']}"
           localeapp_default_code = project_data['default_locale']['code']
-          output.puts "Default Locale: #{localeapp_default_code} (#{project_data['default_locale']['name']})"
+          @output.puts "Default Locale: #{localeapp_default_code} (#{project_data['default_locale']['name']})"
 
           if config_type == :rails
             if I18n.default_locale.to_s != localeapp_default_code
-              output.puts "WARNING: I18n.default_locale is #{I18n.default_locale}, change in config/environment.rb (Rails 2) or config/application.rb (Rails 3)"
+              @output.puts "WARNING: I18n.default_locale is #{I18n.default_locale}, change in config/environment.rb (Rails 2) or config/application.rb (Rails 3)"
             end
             config_file_path = "config/initializers/localeapp.rb"
             data_directory   = "config/locales"
           else
             if config_type == :standalone
-              output.puts "NOTICE: you probably want to add .localeapp to your .gitignore file"
+              @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}"
+          @output.puts "Writing configuration file to #{config_file_path}"
           if config_type == :github
             write_github_configuration_file config_file_path, project_data
           else
@@ -44,11 +45,11 @@ module Localeapp
           end
 
           unless File.directory?(data_directory)
-            output.puts "WARNING: please create the #{data_directory} directory. Your translation data will be stored there."
+            @output.puts "WARNING: please create the #{data_directory} directory. Your translation data will be stored there."
           end
           true
         else
-          output.puts "ERROR: Project not found"
+          @output.puts "ERROR: Project not found"
           false
         end
       end

data/lib/localeapp/cli/pull.rb

@@ -1,12 +1,8 @@
 module Localeapp
   module CLI
-    class Pull
+    class Pull < Command
       include ::Localeapp::ApiCall
 
-      def initialize(output = $stdout)
-        @output = output
-      end
-
       def execute
         @output.puts "Localeapp Pull"
         @output.puts ""

data/lib/localeapp/cli/push.rb

@@ -1,12 +1,8 @@
 module Localeapp
   module CLI
-    class Push
+    class Push < Command
       include ::Localeapp::ApiCall
 
-      def initialize(output = $stdout)
-        @output = output
-      end
-
       def execute(path = nil)
         @output.puts "Localeapp Push"
         if path_is_directory?(path)

data/lib/localeapp/cli/update.rb

@@ -1,10 +1,6 @@
 module Localeapp
   module CLI
-    class Update
-      def initialize(output = $stdout)
-        @output = output
-      end
-
+    class Update < Command
       def execute
         poller = Localeapp::Poller.new
         @output.puts("Localeapp update: checking for translations since #{poller.updated_at}")