yaml_locales_jsonizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d56a0422c0978cadfec19f43bdd4a76227d12192
+  data.tar.gz: e26e2bbd9f460c40e04b1319e5b023205e57feaa
+SHA512:
+  metadata.gz: ba03ff85684d27898254f518c202a521bc4f26988c537c5db0dd56ca69ca9895e3c0828e8f30428eedc2237a9184f80d0bcc9628546a91aec354cd1b96baaee5
+  data.tar.gz: ba5aeda8b548c9e86cd7a82d2b35a22c909a40b06285b2fb7a703fe1f9f621f598a35913382ce5f7906f18e36dfcfbe3fc0fb8ac5a76832b78a7330461e71368

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yaml_locales_jsonizer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Oleg Ivanov
+
+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/README.md

@@ -0,0 +1,66 @@
+# YamlLocalesJsonizer
+
+Simple generation of JSON i18n data for the frontend based on Rails-style YAML
+locales.
+
+The gem provides an asset file for asset pipeline, to be used in production,
+but it is quite cumbersome to use in development. Changes in dynamic assets
+derived from other resources are not being detected and picked up by sprockets
+properly, and they require a server restart and cache wipe to get applied.
+
+To give you a better development experience, an action view helper is also
+available, which allows on-reload locale updates, without any extra steps.
+
+## Compatibility
+
+The current version is built to support [i18next](http://i18next.com/), and
+produces JSON data in the format expected by this tool. If you want to have
+support for other i18n engines - open an issue with a feature request, or
+(even better) - take a look at `styles/i18next.rb` file and send me a pull
+request.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yaml_locales_jsonizer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yaml_locales_jsonizer
+
+## Usage
+
+Add to your asset manifest file, for production:
+
+```
+//= require yaml_locales_jsonizer
+```
+
+For effortless locale updates in dev environment, add a helper call to your
+view (e.g. layout file).  Make sure to add it AFTER your regular assets, to let
+it override cached asset data!
+
+```erb
+= javascript_include_tag 'application' # application assets
+= yaml_locales_jsonizer if Rails.env.development?
+```
+
+JSON data is exposed via `yaml_locales_jsonised` variable, so initialize
+i18next with this variable as the resource storage:
+
+```javascript
+i18n.init({resStore: yaml_locales_jsonized});
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/yaml_locales_jsonizer/action_view/helper.rb

@@ -0,0 +1,11 @@
+module YamlLocalesJsonizer::ActionView
+  module Helper
+
+    def yaml_locales_jsonizer
+      locales = YamlLocalesJsonizer::Loader.locales
+      locales_json = ActiveSupport::JSON.encode locales
+      javascript_tag "window.yaml_locales_jsonized = #{locales_json}"
+    end
+
+  end
+end

data/lib/yaml_locales_jsonizer/engine.rb

@@ -0,0 +1,9 @@
+module YamlLocalesJsonizer
+  class Railtie < Rails::Engine
+    initializer 'yaml_locales_jsonizer.view_helper' do
+      ::ActionView::Base.class_eval do
+        include ::YamlLocalesJsonizer::ActionView::Helper
+      end
+    end
+  end
+end

data/lib/yaml_locales_jsonizer/loader.rb

@@ -0,0 +1,27 @@
+module YamlLocalesJsonizer::Loader
+  extend self
+
+  def locales
+    locale_files.reduce({}) do |locales, file|
+      langdata = YAML.load_file file
+
+      langdata.each_pair do |lang, translations|
+        locales[lang] ||= style.empty_locale
+        style.add_to_locale locales[lang], translations
+      end
+
+      locales
+    end
+  end
+
+  private
+
+  def locale_files
+    %w(en.yml ru.yml).map { |name| Rails.root + "config/locales/#{name}" }
+  end
+
+  def style
+    YamlLocalesJsonizer::Styles::I18next
+  end
+
+end

data/lib/yaml_locales_jsonizer/styles/i18next.rb

@@ -0,0 +1,16 @@
+module YamlLocalesJsonizer
+  module Styles
+    module I18next
+      extend self
+
+      def empty_locale
+        { translation: {} }
+      end
+
+      def add_to_locale(locale, new_data)
+        locale[:translation].merge! new_data
+      end
+
+    end
+  end
+end

data/lib/yaml_locales_jsonizer/styles.rb

@@ -0,0 +1,2 @@
+module YamlLocalesJsonizer::Styles
+end

data/lib/yaml_locales_jsonizer/version.rb

@@ -0,0 +1,3 @@
+module YamlLocalesJsonizer
+  VERSION = "0.1.0"
+end

data/lib/yaml_locales_jsonizer.rb

@@ -0,0 +1,10 @@
+require 'yaml_locales_jsonizer/version'
+require 'yaml'
+
+module YamlLocalesJsonizer
+end
+
+require 'yaml_locales_jsonizer/loader'
+require 'yaml_locales_jsonizer/styles/i18next'
+require 'yaml_locales_jsonizer/action_view/helper'
+require 'yaml_locales_jsonizer/engine' if defined?(Rails)

data/spec/shared/locale_files.rb

@@ -0,0 +1,13 @@
+shared_context 'locale files' do
+  let(:locale_en) { { kaiju: 'Kaiju' } }
+  let(:locale_ru) { { kaiju: 'Кайджу' } }
+  let(:locale_files) do
+    { 'en.yml' => { en: locale_en }, 'ru.yml' => { ru: locale_ru } }
+  end
+
+  before do
+    allow(YamlLocalesJsonizer::Loader).to receive(:locale_files)
+      .and_return(locale_files.keys)
+    allow(YAML).to receive(:load_file) { |file| locale_files[file] }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.filter_run focus: true
+  config.alias_example_to :fit, focus: true
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+end

data/spec/yaml_locales_jsonizer/action_view_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'action_view'
+require 'active_support/json'
+require File.expand_path('../../../lib/yaml_locales_jsonizer', __FILE__)
+require 'shared/locale_files'
+
+describe YamlLocalesJsonizer::ActionView::Helper, '#yaml_locales_jsonizer' do
+  include ActionView::Helpers::JavaScriptHelper
+  include ActionView::Helpers::TagHelper
+  include described_class
+
+  include_context 'locale files'
+
+  it 'generates json data' do
+    json_data = ActiveSupport::JSON.encode YamlLocalesJsonizer::Loader.locales
+    expect(yaml_locales_jsonizer).to eq javascript_tag(
+      "window.yaml_locales_jsonized = #{json_data}"
+    )
+  end
+end

data/spec/yaml_locales_jsonizer/loader_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require File.expand_path('../../../lib/yaml_locales_jsonizer', __FILE__)
+require 'shared/locale_files'
+
+describe YamlLocalesJsonizer::Loader, '.locales' do
+  include_context 'locale files'
+  subject(:load_locales) { described_class.locales }
+
+  it 'loads locale files' do
+    expect(load_locales).to eq ({
+      en: { translation: locale_en },
+      ru: { translation: locale_ru }
+    })
+  end
+end

data/vendor/assets/javascripts/yaml_locales_jsonizer.js.erb

@@ -0,0 +1,4 @@
+<%
+  locales = YamlLocalesJsonizer::Loader.locales
+%>
+window.yaml_locales_jsonized = <%= locales.to_json %>;

data/yaml_locales_jsonizer.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yaml_locales_jsonizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yaml_locales_jsonizer'
+  spec.version       = YamlLocalesJsonizer::VERSION
+  spec.authors       = ['Oleg Ivanov']
+  spec.email         = ['morhekil@morhekil.net']
+  spec.description   = %q{Simple generation of JSON data for the frontend based on Rails-style YAML locales}
+  spec.summary       = %q{Simple generation of JSON data for the frontend based on Rails-style YAML locales}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'actionpack', '~> 3.0'
+  spec.add_development_dependency 'activesupport', '~> 3.0'
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: yaml_locales_jsonizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oleg Ivanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simple generation of JSON data for the frontend based on Rails-style
+  YAML locales
+email:
+- morhekil@morhekil.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/yaml_locales_jsonizer.rb
+- lib/yaml_locales_jsonizer/action_view/helper.rb
+- lib/yaml_locales_jsonizer/engine.rb
+- lib/yaml_locales_jsonizer/loader.rb
+- lib/yaml_locales_jsonizer/styles.rb
+- lib/yaml_locales_jsonizer/styles/i18next.rb
+- lib/yaml_locales_jsonizer/version.rb
+- spec/shared/locale_files.rb
+- spec/spec_helper.rb
+- spec/yaml_locales_jsonizer/action_view_spec.rb
+- spec/yaml_locales_jsonizer/loader_spec.rb
+- vendor/assets/javascripts/yaml_locales_jsonizer.js.erb
+- yaml_locales_jsonizer.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Simple generation of JSON data for the frontend based on Rails-style YAML
+  locales
+test_files:
+- spec/shared/locale_files.rb
+- spec/spec_helper.rb
+- spec/yaml_locales_jsonizer/action_view_spec.rb
+- spec/yaml_locales_jsonizer/loader_spec.rb