Merge remote-tracking branch 'bootstraponline/plugin'

.gitignore

@@ -1,2 +1,4 @@
 #Ruby gem
 *.gem
+.idea/
+*.lock

README.md

@@ -164,6 +164,28 @@ Now, whenever you build your application, Xcode will automatically invoke Twine
 * [Twine TextMate 2 Bundle](https://github.com/mobiata/twine.tmbundle) — This [TextMate 2](https://github.com/textmate/textmate) bundle will make it easier for you to work with Twine strings files. In particular, it lets you use code folding to easily collapse and expand both strings and sections.
 * [twine_ui](https://github.com/Daij-Djan/twine_ui) — A user interface for Twine written by [Dominik Pich](https://github.com/Daij-Djan/). Consider using this if you would prefer to use Twine without dropping to a command line.
 
+## Plugin
+
+Twine will read a yaml config file from three locations.
+
+0. `./twine.yml`    The current working directory
+0. `~/.twine`       The home directory
+0. `/etc/twine.yml` The etc directory
+
+Plugins are specified as values for the gems key. The following is an example config.
+
+```
+gems: appium_twine
+```
+
+Multiple gems are also supported.
+
+```
+gems: [appium_twine, some_other_plugin]
+```
+
+* [appium_twine](https://github.com/appium/appium_twine) is a sample plugin used to provide C# output.
+
 ## Contributors
 
 Many thanks to all of the contributors to the Twine project, including:

Rakefile

@@ -1,8 +1,12 @@
+require 'bundler'
 require 'rake'
 require 'rake/testtask'
 
+# Add build, install, and release tasks.
+Bundler::GemHelper.install_tasks
+
 Rake::TestTask.new do |t|
   t.test_files = %w(test/twine_test.rb)
 end
 
-task :default => :test
+task :default => :test

lib/twine.rb

@@ -2,6 +2,7 @@ module Twine
   class Error < StandardError
   end
 
+  require 'twine/plugin'
   require 'twine/cli'
   require 'twine/encoding'
   require 'twine/formatters'

lib/twine/cli.rb

@@ -45,7 +45,7 @@ module Twine
           @options[:untagged] = true
         end
         formats = []
-        Formatters::FORMATTERS.each do |formatter|
+        Formatters.formatters.each do |formatter|
           formats << formatter::FORMAT_NAME
         end
         opts.on('-f', '--format FORMAT', "The file format to read or write (#{formats.join(', ')}). Additional formatters can be placed in the formats/ directory.") do |format|

lib/twine/formatters.rb

@@ -9,6 +9,22 @@ require 'twine/formatters/tizen'
 
 module Twine
   module Formatters
-    FORMATTERS = [Formatters::Apple, Formatters::Android, Formatters::Gettext, Formatters::JQuery, Formatters::Flash, Formatters::Django, Formatters::Tizen]
+    @formatters = [Formatters::Apple, Formatters::Android, Formatters::Gettext, Formatters::JQuery, Formatters::Flash, Formatters::Django, Formatters::Tizen]
+
+    class << self
+      attr_reader :formatters
+
+      ###
+      # registers a new formatter
+      #
+      # formatter_class - the class of the formatter to register
+      #
+      # returns array of active formatters
+      #
+      def register_formatter formatter_class
+        raise "#{formatter_class} already registered" if @formatters.include? formatter_class
+        @formatters << formatter_class
+      end
+    end
   end
-end
+end

lib/twine/plugin.rb

@@ -0,0 +1,62 @@
+require 'safe_yaml/load'
+
+SafeYAML::OPTIONS[:suppress_warnings] = true
+
+module Twine
+  class Plugin
+    attr_reader :debug, :config
+
+    def initialize
+      @debug = false
+      require_gems
+    end
+
+    ###
+    # require gems from the yaml config.
+    #
+    # gems: [twine-plugin1, twine-2]
+    #
+    # also works with single gem
+    #
+    # gems: twine-plugin1
+    #
+    def require_gems
+      # ./twine.yml    # current working directory
+      # ~/.twine       # home directory
+      # /etc/twine.yml # etc
+      cwd_config  = join_path Dir.pwd, 'twine.yml'
+      home_config = join_path Dir.home, '.twine'
+      etc_config  = '/etc/twine.yml'
+
+      config_order = [cwd_config, home_config, etc_config]
+
+      puts "Config order: #{config_order}" if debug
+
+      config_order.each do |config_file|
+        next unless valid_file config_file
+        puts "Loading: #{config_file}" if debug
+        @config = SafeYAML.load_file config_file
+        puts "Config yaml: #{config}" if debug
+        break
+      end
+
+      return unless config
+
+      # wrap gems in an array. if nil then array will be empty
+      Kernel.Array(config['gems']).each do |gem_path|
+        puts "Requiring: #{gem_path}" if debug
+        require gem_path
+      end
+    end
+
+    private
+
+    def valid_file path
+      File.exist?(path) && File.readable?(path) && !File.directory?(path)
+    end
+
+    def join_path *paths
+      File.expand_path File.join *paths
+    end
+  end
+end

lib/twine/runner.rb

@@ -1,5 +1,7 @@
 require 'tmpdir'
 
+Twine::Plugin.new # Initialize plugins first in Runner.
+
 module Twine
   VALID_COMMANDS = ['generate-string-file', 'generate-all-string-files', 'consume-string-file', 'consume-all-string-files', 'generate-loc-drop', 'consume-loc-drop', 'generate-report']
 
@@ -269,7 +271,7 @@ module Twine
 
     def determine_format_given_path(path)
       ext = File.extname(path)
-      Formatters::FORMATTERS.each do |formatter|
+      Formatters.formatters.each do |formatter|
         if formatter::EXTENSION == ext
           return formatter::FORMAT_NAME
         end
@@ -279,7 +281,7 @@ module Twine
     end
 
     def determine_format_given_directory(directory)
-      Formatters::FORMATTERS.each do |formatter|
+      Formatters.formatters.each do |formatter|
         if formatter.can_handle_directory?(directory)
           return formatter::FORMAT_NAME
         end
@@ -289,7 +291,7 @@ module Twine
     end
 
     def formatter_for_format(format)
-      Formatters::FORMATTERS.each do |formatter|
+      Formatters.formatters.each do |formatter|
         if formatter::FORMAT_NAME == format
           return formatter.new(@strings, @options)
         end

twine.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = ">= 1.8.7"
   s.add_runtime_dependency('rubyzip', "~> 0.9.5")
+  s.add_runtime_dependency('safe_yaml', "~> 1.0.3")
   s.add_development_dependency('rake', "~> 0.9.2")
 
   s.executables  = %w( twine )