localeapp-handlebars_i18n 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+.localeapp
+coverage
+.yardoc
+doc
+*.gem

data/.yardopts

@@ -0,0 +1,3 @@
+--readme README.yard
+--no-private
+--exclude README.markdown

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+# Specify your gem's dependencies in localeapp-handlebars_i18n.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    localeapp-handlebars_i18n (0.0.1)
+      localeapp
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    gli (2.5.0)
+    i18n (0.6.1)
+    json (1.7.5)
+    localeapp (0.6.8)
+      gli
+      i18n
+      json
+      rest-client
+      ya2yaml
+    mime-types (1.19)
+    multi_json (1.4.0)
+    rack (1.4.1)
+    rake (0.9.2.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.1)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    ya2yaml (0.31)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  localeapp-handlebars_i18n!
+  rack
+  rake
+  rspec
+  simplecov
+  yard

data/README.markdown

@@ -0,0 +1,4 @@
+# Localeapp::HandlebarsI18n
+
+Documentation for Localeapp::HandlebarsI18n is hosted at
+<a href="http://rubydoc.info/github/randym/localeapp-handlebars_i18n/master/file/README.yard">rubydoc.info</a>

data/README.yard

@@ -0,0 +1,107 @@
+= Localeapp::HanldebarsI18n
+
+Localeapp::HandlebarsI18n is a set of tools for parsing hanldebars
+templates for a specific helper to collect missing i18n keys and report
+them to the Localeapp service.
+
+= Usage
+
+I usually set this up as a rake task so that I can push up missing
+tranlstions, push any new translations in the default locale yml file
+and finally pull down any new localizations from Localeapp.
+
+Here is an overly verbose example of a rake task that does just that!
+
+  !!!ruby
+  namespace :localeapp do
+    desc "push missing handlebars keys up to localeapp and update locale yml from localeapp"
+    task :update do
+      require 'localeapp-handlebars_i18n'
+      Localeapp::HandlebarsI18n.configure do |config|
+        config.hbs_load_path = Dir[File.expand_path '../assets/scripts/app/templates/**/*.hbs', __FILE__]
+        config.yml_load_path = File.expand_path '../locales/', __FILE__
+        config.localeapp_api_key = ENV['LOCALEAPP_API_KEY']
+        config.default_locale = :en
+        config.hbs_helper = 't'
+      end
+      Localeapp::HandlebarsI18n.send_missing_translations
+      system "localeapp push locales/#{Localeapp::HandlebarsI18n.default_locale}.yml"
+      system "localeapp pull"
+    end
+  end
+
+= The details
+
+This gem requires that you have a good understanding of how to get up
+and running with Localeapp. For it to be truly useful, you will also
+either be building a Rails application that compiles i18n localizaion
+information for use by I18n-js or Emberjs.STRINGS. To raise that barrier
+to entry just a little bit higher, you will be using handlebars for your
+view templates and have a localization helper setup in handlebars that
+lets you do stuff like !{{t some.string}} in your template to push out a
+localized string.
+
+If you are looking for a good example of all of this, have a look at
+travis-web!
+
+If all of that makes sense to you, here is an explanation of the
+configuration options that you will need to set up to push out missing
+tranlsations to Localeapp.
+
+ 
+=== hbs_load_path
+This is the path to all of your handlebars templates. All of the files
+listed here will be scanned for a handlebars set using the helper you
+specify in the following option.
+
+=== hbs_helper
+By default, this is going to look for !{{t some.key}} - or more
+specifically /!{{t (.*?)}}/ capturing what should be your tranlsation
+keys and comparing them to the data found in the following option.
+
+=== yml_load_path
+This is where your locale files live. The default locale is :en when
+looking up handlebars localizations but you can override this with the
+following configuration
+
+=== default_locale
+This is a symbol that defines the default locale you are working
+against. Most folks are using :en as the defualt locale, so that is what
+this gem uses. You can set it to any locale symbol you like but you need
+to be sure the file [default_locale].yml exists in the directory you
+specified for yml_load_path.
+
+=== localeapp_api_key
+This is your secret api key for using locale app. I usually export it
+to an shell variable, but how you manage it is up to you. Just dont post
+it to your public repo or anyone in the world will be able to update all
+your tranlsations to their favorite four letter word.
+
+
+= Coverage
+As always, this gem has 100% test coverage and 100% documentation
+
+
+= License
+Copyright (c) 2012 Randy Morgan
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+require "bundler/setup"
+
+desc "run the specs"
+task :spec do
+  sh "rspec -cfs spec"
+end
+
+task :default => :spec
+
+desc "build the gem"
+task :build do
+  system "gem build localeapp-handlebars_i18n.gemspec"
+end
+desc "build and release the gem"
+task :release => :build do
+  system "gem push localeapp-handlebars_i18n-#{Localeapp::HandlebarsI18n::VERSION}.gem"
+end

data/lib/localeapp-handlebars_i18n.rb

@@ -0,0 +1,162 @@
+require 'localeapp'
+
+# The Localeapp Module - we place HandlebarsI18n under this namespace
+module Localeapp
+
+  # A singleton module that reports missing translations found in handebars templates to Localeapp.
+  # Once you have set everything up with configure it is a simple matter of calling Localeapp::HandlebarsI18n.send_missing_translations and you are done.
+  module HandlebarsI18n
+
+    class << self
+
+      # configures HanldebarsI18n
+      # @param [Object] output You can pass in an object that accepts calls to puts for logging. By default $stdout will be used.
+      # @param [Proc] block A configuration block
+      # @example
+      #     Localeapp::HandlebarsI18.configure do |config|
+      #       config.localeapp_api_key = ENV['LOCALEAPP_API_KEY']
+      #       config.hbs_helper = 't'
+      #       config.hbs_load_path = Dir[File.expand_path '../support/**.hbs', __FILE__]
+      #       config.yml_load_path = File.expand_path '../support/', __FILE__
+      #       config.default_locale = :ru
+      #     end
+      def configure(output = $stdout, &block)
+        @output = output
+        instance_eval &block if block_given?
+        register_missing_translations
+      end
+
+      # The string name of your handlebars helper function for translation.
+      # Here is an example coffeescript handlebars helper registration that creates a helper named 't'
+      # that uses I18n-js for javascript localizations. If you had a helper like the one below, you would
+      # pass 't' into this method. 't' is also the default so if you are already using a helper named 't'
+      # you do not need to configure this.
+      #
+      # This helper is interpolated into the regular expression used to scan for translation keys:
+      # "{{#{hbs_helper}} (.*?)}}"
+      #
+      # @example
+      #   Handlebars.registerHelper 't', (key) ->
+      #     safe I18n.t(key)
+      # @param [String] helper The name of your handlebars helper used for localization.
+      def hbs_helper=(helper)
+        @hbs_helper
+      end
+
+      # @see hbs_helper=
+      def hbs_helper
+        @hbs_helper ||= 't'
+      end
+
+      # The default locale to load when comparing handlebar translation keys and I18n translation keys.
+      # This is used when loading YAML data into I18n's simple backend
+      # @param [Symbol] locale the locale to load.
+      def default_locale=(locale)
+        @default_locale = locale
+      end
+
+      # @see default_locale=
+      def default_locale
+        @default_locale ||= :en
+      end
+
+      # The directory where your locale .yml files live.
+      # @param [String] dir The directory to search for the default locale's YAML data
+      def yml_load_path=(dir)
+        @yml_load_path = dir
+      end
+
+      # This defines the yml file to load for I18n. It retuns an interpolated string of the yml_load_path value you configured
+      # and the default locale.
+      # @return [String]
+      def yml_load_path
+        "#{@yml_load_path}/#{default_locale}.yml"
+      end
+
+      # Sets the array of handlebars templates that will be searched for localization helpers. Dir.glob is pretty dang handy here.
+      # @param [Array] files The files to search.
+      # @see hbs_helper
+      def hbs_load_path=(files)
+        @hbs_load_path = files.flatten
+      end
+
+      # Returns the files you specified or an empty array
+      # @return [Array]
+      def hbs_load_path
+        @hbs_load_path ||= []
+      end
+
+      # Configures localeapp to use the api key you specify when reporting missing translations.
+      # @param [String] api_key The localeapp api key.
+      def localeapp_api_key=(api_key)
+        Localeapp.configure do |config|
+          config.api_key= api_key
+        end
+      end
+
+      # Sends any missing translations to Localeapp.
+      # @note If you have not configured Localeapp::HandlebarsI18n you will recieve an error with an example on how to do so.
+      def send_missing_translations
+        ensure_configured
+        return if Localeapp.missing_translations[default_locale].empty?
+        @output.puts "sending missing translations to localeapp"
+        Localeapp::sender.post_missing_translations
+      end
+
+      private
+      def hbs_locale_keys
+        @hbs_locale_keys ||= hbs_load_path.map do |file| 
+          extract_keys(file)
+        end.flatten.compact.uniq
+      end 
+
+
+      def ensure_configured
+        if @hbs_load_path.nil? || @yml_load_path.nil?
+          raise ArgumentError, <<ERROR_MSG
+          "You must configure Localeapp::Reporter before sending missing translations.
+          example:
+
+          Localeapp::Reporter.configure do |config|
+            config.localeapp_api_key = ENV['LOCALEAPP_API_KEY']
+            config.yml_load_path = 'locales/'
+            config.hbs_load_path = 'assets/scripts/app/templates/**/*.hbs'
+            config.hbs_helper = 't'
+            config.default_locale = :en
+          end
+ERROR_MSG
+        end
+      end
+
+
+      def matcher
+        @matcher ||= Regexp.new("{{#{hbs_helper} (.*?)}}")
+      end
+
+      def backend
+        @backend ||= I18n::Backend::Simple.new.tap do |simple|
+          simple.load_translations yml_load_path
+        end
+      end
+
+      def extract_keys(template_file)
+        template = IO.read(template_file)
+        template.scan(matcher)
+      end
+
+      def register_missing_translations 
+        hbs_locale_keys.each do |key|
+          key.gsub!(/[\"\']/, '')
+          begin
+            backend.translate(default_locale, key)
+          rescue Exception => e
+            @output.puts "translation missing: #{key}"
+            Localeapp.missing_translations.add(default_locale, key, key.split('.').last)
+          end
+        end
+      end
+    end
+  end
+end
+
+

data/lib/localeapp-handlebars_i18n/version.rb

@@ -0,0 +1,6 @@
+module Localeapp
+  module HandlebarsI18n
+    # The current version
+    VERSION = '0.0.1'
+  end
+end

data/localeapp-handlebars_i18n.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/localeapp-handlebars_i18n/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Randy Morgan"]
+  gem.email         = ["digital.ipseity@gmail.com"]
+  gem.description   = %q{A localeapp reporter for working with handlebars templates with localizations.}
+  gem.summary       = %q{Parses handlebars templates for localization helpers and adds missing keys to localeapp.}
+  gem.homepage      = "http://github.com/randym/localeapp-handlebars_i18n"
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  gem.name          = "localeapp-handlebars_i18n"
+  gem.require_paths = ["lib"]
+  gem.version       = Localeapp::HandlebarsI18n::VERSION
+
+  gem.add_dependency "localeapp"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rack"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "yard"
+  gem.add_development_dependency "simplecov"
+end

data/spec/localeapp-handlebars_i18n_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'localeapp-handlebars_i18n'
+
+describe Localeapp::HandlebarsI18n do
+  class Log
+    class << self
+      def data
+        @data ||= []
+      end
+      def puts(text)
+        data << text
+      end
+    end
+  end
+  let(:reporter) {
+    cloned_module = Localeapp::HandlebarsI18n.clone
+    cloned_module.configure(Log) do |config|
+      config.localeapp_api_key = 'whatever'
+      config.hbs_helper = 't'
+      config.hbs_load_path = Dir[File.expand_path '../support/**.hbs', __FILE__]
+      config.yml_load_path = File.expand_path '../support/', __FILE__
+      config.default_locale = :ru
+    end
+    cloned_module
+  }
+  before :each do
+    reporter
+  end
+
+  context "with a configured localeapp reporter" do
+
+    it 'configured the default locale' do
+      reporter.default_locale.should == :ru
+    end
+
+    it 'configured the yml_load_path' do
+      reporter.yml_load_path.should == File.expand_path("../support/#{reporter.default_locale}.yml", __FILE__)
+    end
+
+    it 'configured the hbs_load_path' do
+      reporter.hbs_load_path.should == Dir[File.expand_path '../support/**.hbs', __FILE__]
+    end
+
+    it 'loaded up the i18n backend' do
+      expect { reporter.send(:backend).translate(reporter.default_locale, 'existing.key') }.to_not raise_error(ArgumentError)
+      expect { reporter.send(:backend).translate(reporter.default_locale, 'missing.key') }.to raise_error(ArgumentError)
+    end
+
+    it "configured Localeapp.missing_translations" do
+      Localeapp.missing_translations.should_not be_nil
+    end
+    it "adds missing {{t missing.key}} translation key to Localeapp.missing_translations" do
+      Localeapp.missing_translations[reporter.default_locale].should include('missing.key')
+    end
+  end
+
+  context "when sending missing translations" do
+    it 'executes a rest client request with the translations in the payload' do 
+      RestClient::Request.should_receive(:execute).with(hash_including(
+        :payload => { :translations => Localeapp.missing_translations.to_send }.to_json)).and_return(double('response', :code => 200))
+        reporter.send_missing_translations
+    end 
+    it 'populates the log' do
+      # something tells me that if I randomize the order of these specs,
+      # this wont pass until a call to send_missing_translations gets
+      # sent
+      Log.data.should include('sending missing translations to localeapp')
+    end
+  end
+  context "when nothing is configured" do
+    before :each do
+      @cloned_module = Localeapp::HandlebarsI18n.clone
+    end
+
+    it "send_missing_translations fails with a message to configure." do
+      expect { @cloned_module.send_missing_translations }.to raise_error ArgumentError
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'simplecov'
+SimpleCov.start 

data/spec/support/existing_t_key.hbs

@@ -0,0 +1 @@
+{{t existing.key}}

data/spec/support/missing_t_key.hbs

@@ -0,0 +1 @@
+{{t missing.key}}

data/spec/support/ru.yml

@@ -0,0 +1,3 @@
+ru:
+  existing:
+    key: An existing key in locale YAML

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: localeapp-handlebars_i18n
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Randy Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: localeapp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A localeapp reporter for working with handlebars templates with localizations.
+email:
+- digital.ipseity@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardopts
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- README.yard
+- Rakefile
+- lib/localeapp-handlebars_i18n.rb
+- lib/localeapp-handlebars_i18n/version.rb
+- localeapp-handlebars_i18n-0.0.1.gem
+- localeapp-handlebars_i18n.gemspec
+- spec/localeapp-handlebars_i18n_spec.rb
+- spec/spec_helper.rb
+- spec/support/existing_t_key.hbs
+- spec/support/missing_t_key.hbs
+- spec/support/ru.yml
+homepage: http://github.com/randym/localeapp-handlebars_i18n
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1516604966356496189
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1516604966356496189
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Parses handlebars templates for localization helpers and adds missing keys
+  to localeapp.
+test_files: []
+has_rdoc: