rake-pipeline-i18n-filters 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+-cfs -r spec_helper.rb

data/.yardopts

@@ -0,0 +1,2 @@
+--readme README.yard
+

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rake-pipeline-web-filters.gemspec
+gemspec
+
+gem "rake-pipeline", :git => "git://github.com/livingsocial/rake-pipeline.git"
+gem "pry"

data/README.markdown

@@ -0,0 +1,4 @@
+# Rake::Pipeline::Web::Filters
+
+Documentation for Rake::Pipeline::Web::Filters is hosted at
+<a href="http://rubydoc.info/github/wycats/rake-pipeline-web-filters/master/file/README.yard">rubydoc.info</a>

data/README.yard

@@ -0,0 +1,38 @@
+= Rake::Pipeline::I18n::Filters
+
+Rake::Pipeline::I18n::Filters is a collection of filters for Rake::Pipeline
+for creating pipelines to generate i18n-js and Ember.STRINGS
+localization files from I18n yaml.
+
+= Usage
+
+In your +Assetfile+:
+
+  !!!ruby
+  require "rake-pipeline-i18n-filters"
+
+  input "assets"
+  output "public"
+
+  # Take all YAML inputs and generates JS suitable for 
+  # use with i18n-js
+  output 'public/scripts'
+  input 'locales' do
+    match '**/*.yml' do
+      i18n_js { 'locales.js' }
+    end
+  end
+
+  # Take all YAML inputs and generate JS suitable for
+  # use with Ember.STRINGS
+  output 'assets/scripts/config'
+  input 'locales' do
+    match '**/*.yml' do
+      ember_strings { 'locales.js' }
+    end
+  end
+
+= Available Filters
+
+* {Rake::Pipeline::I18n::Filters::I18nJsFilter}: Compile yaml files to JS suitable for use by i18n-js
+* {Rake::Pipeline::I18n::Filters::EmberStringFilter}: Compile YAML to JS * suitable for EmberJS.STRINGS

data/Rakefile

@@ -0,0 +1,19 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+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 rake-pipeline-i18n-filters.gemspec"
+end
+desc "build and release the gem"
+task :release => :build do
+  system "gem push activeadmin-axlsx-#{Rake::Pipeline::I18n::Filters::VERSION}.gem"
+end

data/lib/ext/hash.rb

@@ -0,0 +1,23 @@
+# Shamelessly borrowed from active_support. Simply because I dont want
+# to force the dependency.
+class Hash
+  # Returns a new hash with +self+ and +other_hash+ merged recursively.
+  #
+  #   h1 = {:x => {:y => [4,5,6]}, :z => [7,8,9]}
+  #   h2 = {:x => {:y => [7,8,9]}, :z => "xyz"}
+  #
+  #   h1.deep_merge(h2) #=> { :x => {:y => [7, 8, 9]}, :z => "xyz" }
+  #   h2.deep_merge(h1) #=> { :x => {:y => [4, 5, 6]}, :z => [7, 8, 9] }
+  def deep_merge(other_hash)
+    dup.deep_merge!(other_hash)
+  end
+
+  # Same as +deep_merge+, but modifies +self+.
+  def deep_merge!(other_hash)
+    other_hash.each_pair do |k,v|
+      tv = self[k]
+      self[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? tv.deep_merge(v) : v
+    end
+    self
+  end
+end

data/lib/rake-pipeline-i18n-filters/ember_strings_filter.rb

@@ -0,0 +1,91 @@
+require 'rake-pipeline-i18n-filters/filter_with_dependencies'
+
+module Rake::Pipeline::I18n::Filters
+  # A filter that compiles locale yml files into javascript
+  # appropriate for use by Ember#String#loc
+  #
+  # @example
+  #   !!!ruby
+  #   Rake::Pipeline.build do
+  #     input "config/locales", "**/*.yml"
+  #     output "public"
+  #
+  #     # Compile each .yml file under the config/locales
+  #     # directory.
+  #     filter Rake::Pipeline::Web::Filters::EmberI18nFilter
+  #   end
+  #
+  class EmberStringsFilter < Rake::Pipeline::Filter
+  
+    include FilterWithDependencies
+
+    # @param [Hash] options
+    #   A hash of options for this filter
+    # @option [String] :use_i18n_js
+    #   When true, localization information will be output in a format
+    #   suitable for i18n-js. If this option is missing data will be
+    #   output in the format that Ember.String.loc expects.
+    # @note If you are using Ember.String.loc be sure to set
+    #      Ember.STRINGS = EmberI18n['locale'];
+    # where 'locale' is the locale you have parsed and want to render.
+    # @see https://github.com/fnando/i18n-js
+    # @see http://docs.emberjs.com/symbols/Ember.String.html#method=.loc
+    # @param [Proc] block a block to use as the Filter's
+    #   {#output_name_generator}.
+    def initialize(&block)
+      block ||= proc { |input| input.sub(/\.(yml)$/, '.js') }
+      super(&block)
+    end
+
+    # Implement the {#generate_output} method required by
+    # the {Filter} API. Generates javascript from i18n yaml files
+    # appropriate for Ember#String#loc or i18n-js
+    # @param [Array<FileWrapper>] inputs an Array of
+    #   {FileWrapper} objects representing the inputs to
+    #   this filter.
+    # @param [FileWrapper] output a single {FileWrapper}
+    #   object representing the output.
+    def generate_output(inputs, output)
+        output.write ember_i18n_output(inputs)
+    end
+
+    private
+
+    def external_dependencies
+      [ 'yaml', 'json' ]
+    end
+
+    def ember_i18n_output(inputs)
+      "EmberI18n = EmberI18n || {};#{compile_locales_for_ember_i18n(inputs)}"
+    end
+
+    def compile_locales_for_ember_i18n(inputs)
+      output_hash = {}
+      inputs.map do |input|
+        output_hash.deep_merge! YAML.load(input.read)
+      end
+      parse_ember_i18n_locales(output_hash)
+    end
+
+    def parse_ember_i18n_locales(output_hash)
+      dotified = dotify(output_hash)
+      dotified.map do |locale_key, locale_value|
+        locale_strings = locale_value.map do |entry_key, entry_value|
+          "'#{entry_key}' : '#{entry_value}'"
+        end.join(',')
+        "EmberI18n['#{locale_key}'] = { #{locale_strings} };"
+      end.join('')
+    end
+
+    def dotify(source, target={}, path=nil)
+      prefix = "#{path}." if path
+      if source.is_a?(Hash)
+        source.each do |key, value|
+          dotify(value, target, "#{prefix}#{key}")
+        end
+      else
+        target[path.split('.')[1..-1].join('.')] = source
+      end
+    end
+  end
+end

data/lib/rake-pipeline-i18n-filters/filter_with_dependencies.rb

@@ -0,0 +1,27 @@
+module Rake::Pipeline::I18n::Filters
+  # A mixin for filters that have dependencies on external
+  # libraries. Include this module in the filter class and
+  # declare a private `external_dependencies` method that
+  # returns an array of strings. Each one will be passed
+  # to `Kernel#require` when an instance of the filter
+  # is created.
+  module FilterWithDependencies
+
+    def initialize(*args, &block)
+      require_dependencies!
+      super(*args, &block)
+    end
+
+    private
+
+    def require_dependencies!
+      external_dependencies.each do |d|
+        begin
+          require d
+        rescue LoadError => error
+          raise error, "#{self.class} requires #{d}, but it is not available."
+        end
+      end
+    end
+  end
+end

data/lib/rake-pipeline-i18n-filters/helpers.rb

@@ -0,0 +1,19 @@
+module Rake::Pipeline::I18n::Filters
+  # Extends the Rake::Pipeline DSL to include shortcuts
+  # for adding filters to the pipeline.
+  module PipelineHelpers
+    # Add a new {I18nJsFilter} to the pipeline
+    # @see I18nJsFilter#initialize
+    def i18n_js(*args, &block)
+      filter(Rake::Pipeline::I18n::Filters::I18nJsFilter, *args, &block)
+    end
+    # Add a new {EmberStringsFilter} to the pipeline
+    # @see EmberStringsFilter#initialize
+    def ember_strings(*args, &block)
+      filter(Rake::Pipeline::I18n::Filters::EmberStringsFilter, *args, &block)
+    end
+  end
+end
+
+require "rake-pipeline/dsl"
+Rake::Pipeline::DSL::PipelineDSL.send(:include, Rake::Pipeline::I18n::Filters::PipelineHelpers)

data/lib/rake-pipeline-i18n-filters/i18n_js_filter.rb

@@ -0,0 +1,54 @@
+require 'rake-pipeline-i18n-filters/filter_with_dependencies'
+
+module Rake::Pipeline::I18n::Filters
+  # A filter that compiles locale yml files into javascript
+  # appropriate for use by Ember#String#loc
+  #
+  # @example
+  #   !!!ruby
+  #   Rake::Pipeline.build do
+  #     input "config/locales", "**/*.yml"
+  #     output "public"
+  #
+  #     # Compile each .yml file under the config/locales
+  #     # directory.
+  #     filter Rake::Pipeline::I18n::Filters::I18nJSFilter
+  #   end
+  #
+  class I18nJsFilter < Rake::Pipeline::Filter
+
+    include FilterWithDependencies
+    
+    # @see https://github.com/fnando/i18n-js
+    # @param [Proc] block a block to use as the Filter's
+    #   {#output_name_generator}.
+    def initialize(&block)
+      block ||= proc { |input| input.sub(/\.(yml)$/, '.js') }
+      super(&block)
+    end
+ 
+    # Implement the {#generate_output} method required by
+    # the {Filter} API. Generates javascript from i18n yaml files
+    # appropriate for i18n-js
+    # @param [Array<FileWrapper>] inputs an Array of
+    #   {FileWrapper} objects representing the inputs to
+    #   this filter.
+    # @param [FileWrapper] output a single {FileWrapper}
+    #   object representing the output.
+    def generate_output(inputs, output)
+      js_dec = 'I18n.translations = I18n.translations || {};' 
+      output_hash = {}
+      inputs.each do |input|
+        output_hash.deep_merge! YAML.load(input.read)
+      end  
+      output.write "#{js_dec}\nI18n.translations = #{output_hash.to_json};"
+    end
+
+    private
+
+    def external_dependencies
+      [ 'yaml', 'json' ]
+    end
+
+  end
+end

data/lib/rake-pipeline-i18n-filters/version.rb

@@ -0,0 +1,9 @@
+module Rake
+  class Pipeline
+    module I18n 
+      module Filters
+        VERSION = "0.0.1"
+      end
+    end
+  end
+end

data/lib/rake-pipeline-i18n-filters.rb

@@ -0,0 +1,17 @@
+require "rake-pipeline"
+
+module Rake
+  class Pipeline
+    module I18n
+      module Filters
+      end
+    end
+  end
+end
+
+require "ext/hash"
+require "rake-pipeline-i18n-filters/version"
+require "rake-pipeline-i18n-filters/filter_with_dependencies"
+require "rake-pipeline-i18n-filters/i18n_js_filter"
+require "rake-pipeline-i18n-filters/ember_strings_filter"
+require "rake-pipeline-i18n-filters/helpers"

data/rake-pipeline-i18n-filters.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rake-pipeline-i18n-filters/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Randy Morgan"]
+  gem.email         = ["digital.ipseity@gmail.com"]
+  gem.description   = %q{A collection of i18n filters for rake-pipeline}
+  gem.summary       = %q{Adds filters for generating i18n-js and Ember.STRINGS localization data from i18n YAML}
+  gem.homepage      = "http://github.com/randym/rake-pipeline-i18n-filters"
+  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 -- {test,spec,features}/*`.split("\n")
+  gem.name          = "rake-pipeline-i18n-filters"
+  gem.require_paths = ["lib"]
+  gem.version       = Rake::Pipeline::I18n::Filters::VERSION
+
+  gem.add_dependency "rake-pipeline", "~> 0.6"
+  gem.add_development_dependency "rspec"
+end

data/spec/ember_strings_filter_spec.rb

@@ -0,0 +1,51 @@
+# encoding: UTF-8
+
+describe "EmberStringsFilter" do
+  EmberStringsFilter ||= Rake::Pipeline::I18n::Filters::EmberStringsFilter
+  MemoryFileWrapper ||= Rake::Pipeline::SpecHelpers::MemoryFileWrapper
+
+  # Seems like YAML is expecting this method.
+  MemoryFileWrapper.class_eval( 'def external_encoding; Encoding.default_external; end')
+
+  let(:input) { yaml = <<EOF
+# encoding: UTF-8
+en:
+  foo: bar
+  hoge: hoge
+ja:
+  foo: バー
+  hoge: ホゲ
+EOF
+  }
+
+  # not using heredoc as it adds an extra \n to the end
+  let(:expected_ember_strings) {
+  "EmberI18n = EmberI18n || {};EmberI18n['en'] = { 'foo' : 'bar','hoge' : 'hoge' };EmberI18n['ja'] = { 'foo' : 'バー','hoge' : 'ホゲ' };"
+  }
+  def input_file(name, content)
+    MemoryFileWrapper.new('/path/to/input', name, 'UTF-8', content)
+  end
+
+  def output_file(name)
+    MemoryFileWrapper.new('/path/to/output', name, 'UTF-8')
+  end
+
+  def setup_filter(filter)
+    filter.file_wrapper_class = MemoryFileWrapper
+    filter.input_files = [input_file('localizations.yml', input)]
+    filter.output_root = '/path/to/output'
+    filter.rake_application = Rake::Application.new
+    filter
+  end
+
+  it "generates ember_strings" do
+    filter = setup_filter EmberStringsFilter.new
+    filter.output_files.should == [output_file('localizations.js')]
+    tasks = filter.generate_rake_tasks
+    tasks.each(&:invoke)
+    file = MemoryFileWrapper.files['/path/to/output/localizations.js']
+    file.body.should == expected_ember_strings
+  end
+
+end
+

data/spec/helpers_spec.rb

@@ -0,0 +1,25 @@
+describe "Helpers" do
+  let(:pipeline) { Rake::Pipeline.new }
+  let(:dsl) { Rake::Pipeline::DSL::PipelineDSL.new(pipeline) }
+
+  before do
+    pipeline.add_input '.'
+  end
+
+  def filter
+    pipeline.filters.last
+  end
+
+  describe '#i18n_js' do
+    it "creates an I18nJsFilter" do
+      dsl.i18n_js
+      filter.should be_kind_of(Rake::Pipeline::I18n::Filters::I18nJsFilter)
+    end
+  end
+  describe '#ember_strings' do
+    it "creates an EmberStringsFilter" do
+      dsl.ember_strings
+      filter.should be_kind_of(Rake::Pipeline::I18n::Filters::EmberStringsFilter)
+    end
+  end
+end

data/spec/i18n_js_filter_spec.rb

@@ -0,0 +1,50 @@
+# encoding: UTF-8
+
+describe "I18nJsFilter" do
+  I18nJsFilter ||= Rake::Pipeline::I18n::Filters::I18nJsFilter
+  MemoryFileWrapper ||= Rake::Pipeline::SpecHelpers::MemoryFileWrapper
+
+  # Seems like YAML is expecting this method.
+  MemoryFileWrapper.class_eval( 'def external_encoding; Encoding.default_external; end')
+
+  let(:input) { yaml = <<EOF
+# encoding: UTF-8
+en:
+  foo: bar
+  hoge: hoge
+ja:
+  foo: バー
+  hoge: ホゲ
+EOF
+  }
+
+  # not using heredoc as it adds an extra \n to the end
+  let(:expected_i18n_js) {
+  "I18n.translations = I18n.translations || {};\nI18n.translations = {\"en\":{\"foo\":\"bar\",\"hoge\":\"hoge\"},\"ja\":{\"foo\":\"バー\",\"hoge\":\"ホゲ\"}};"
+  }
+  def input_file(name, content)
+    MemoryFileWrapper.new('/path/to/input', name, 'UTF-8', content)
+  end
+
+  def output_file(name)
+    MemoryFileWrapper.new('/path/to/output', name, 'UTF-8')
+  end
+
+  def setup_filter(filter)
+    filter.file_wrapper_class = MemoryFileWrapper
+    filter.input_files = [input_file('i18n_js_localizations.yml', input)]
+    filter.output_root = '/path/to/output'
+    filter.rake_application = Rake::Application.new
+    filter
+  end
+
+  it "generates i18n_js" do
+    filter = setup_filter I18nJsFilter.new
+    filter.output_files.should == [output_file('i18n_js_localizations.js')]
+    tasks = filter.generate_rake_tasks
+    tasks.each(&:invoke)
+    file = MemoryFileWrapper.files['/path/to/output/i18n_js_localizations.js']
+    file.body.should == expected_i18n_js
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,103 @@
+require "rake-pipeline"
+require "rake-pipeline-i18n-filters"
+class Rake::Pipeline
+  module SpecHelpers
+
+    class MemoryFileWrapper < Struct.new(:root, :path, :encoding, :body)
+      @@files = {}
+      @@data = {}
+
+      def self.files
+        @@files
+      end
+
+      def self.data
+        @@data
+      end
+
+      def with_encoding(new_encoding)
+        self.class.new(root, path, new_encoding, body)
+      end
+
+      def fullpath
+        File.join(root, path)
+      end
+
+      def create
+        @@files[fullpath] = self
+        self.body = ""
+        yield
+      end
+
+      def read
+        body || @@data[fullpath] || ""
+      end
+
+      def write(contents)
+        self.body << contents
+      end
+    end
+
+    # TODO: OS agnostic modules
+    module FileUtils
+      def mkdir_p(dir)
+        system "mkdir", "-p", dir
+      end
+
+      def touch(file)
+        system "touch", file
+      end
+
+      def rm_rf(dir)
+        system "rm", "-rf", dir
+      end
+
+      def touch_p(file)
+        dir = File.dirname(file)
+        mkdir_p dir
+        touch file
+      end
+
+      def age_existing_files
+        old_time = Time.now - 10
+        Dir[File.join(tmp, "**/*.js")].each do |file|
+          File.utime(old_time, old_time, file)
+        end
+      end
+    end
+
+    module Filters
+      ConcatFilter = Rake::Pipeline::ConcatFilter
+      MemoryFileWrapper = Rake::Pipeline::SpecHelpers::MemoryFileWrapper
+
+      class StripAssertsFilter < Rake::Pipeline::Filter
+        def generate_output(inputs, output)
+          inputs.each do |input|
+            output.write input.read.gsub(%r{^\s*assert\(.*\)\s*;?\s*$}m, '')
+          end
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  original = Dir.pwd
+
+  config.include Rake::Pipeline::SpecHelpers::FileUtils
+
+  def tmp
+    File.expand_path("../tmp", __FILE__)
+  end
+
+  config.before do
+    rm_rf(tmp)
+    mkdir_p(tmp)
+    Dir.chdir(tmp)
+  end
+
+  config.after do
+    Dir.chdir(original)
+  end
+end
+

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: rake-pipeline-i18n-filters
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Randy Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !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'
+description: A collection of i18n filters for rake-pipeline
+email:
+- digital.ipseity@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .yardopts
+- Gemfile
+- README.markdown
+- README.yard
+- Rakefile
+- lib/ext/hash.rb
+- lib/rake-pipeline-i18n-filters.rb
+- lib/rake-pipeline-i18n-filters/ember_strings_filter.rb
+- lib/rake-pipeline-i18n-filters/filter_with_dependencies.rb
+- lib/rake-pipeline-i18n-filters/helpers.rb
+- lib/rake-pipeline-i18n-filters/i18n_js_filter.rb
+- lib/rake-pipeline-i18n-filters/version.rb
+- rake-pipeline-i18n-filters.gemspec
+- spec/ember_strings_filter_spec.rb
+- spec/helpers_spec.rb
+- spec/i18n_js_filter_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/randym/rake-pipeline-i18n-filters
+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: -3126436427769998385
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3126436427769998385
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Adds filters for generating i18n-js and Ember.STRINGS localization data from
+  i18n YAML
+test_files:
+- spec/ember_strings_filter_spec.rb
+- spec/helpers_spec.rb
+- spec/i18n_js_filter_spec.rb
+- spec/spec_helper.rb