i18n_structure 0.0.2

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,2 @@
+--color
+--format documentation

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Wojciech Krysiak
+
+MIT License
+
+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,132 @@
+# I18nStructure
+
+## Put in order your locale files
+
+This gem adds support of nice and nifty structure of locale files to your Rails app.
+Gem divides translations into two groups:
+
+- global namespaced translations: they could be repeated among different pages for different resources: for example **send** or **confirm** 
+- resource (activerecord) namespaced translations: specyfic for resource, for example **send request**, **add storey**. They are stored in files named after resource (**article.yml**) inside **config/locales/LOCALE_NAME/ar** folder
+
+**Supported locale structure:** for example polish translations
+
+```yaml
+pl:
+  labels: #/config/locales/pl/labels.yml
+    send: Wyślij
+  attributes: #/config/locales/pl/attributes.yml
+    name: Nazwa
+  collections: #/config/locales/pl/collections.yml
+    yes_no: 
+      - - Tak
+        - true
+      - - Nie
+        - false
+  tooltips: #/config/locales/pl/tooltips.yml
+    name: Nazwa jest to .. #Some tooltip for name
+  activerecord:
+    attributes:
+      order: #/config/locales/pl/ar/order.yml
+        name: Nazwa zamówienia
+        order_type: Rodzaj zamówienia
+        order_type_collection: #collections are in attributes namespace
+          - - Odrzucone
+            - rejected
+          - - Zaakceptowane
+            - accepted
+    tooltips: #/config/locales/pl/ar/order.yml
+      order:
+        name: Tooltip
+    labels: #/config/locales/pl/ar/order.yml
+      order:
+        create_header: Stwórz zamówienie
+```
+
+## ...and use new i18n methods and helpers
+
+I18nStructure gem also adds some usefull methods to I18n module and viwes:
+
+```rails
+translate_label(key, model=nil, options={}) #alias tl()
+translate_tooltip(key, model=nil, options={}) #alias tt()
+translate_attribute(key, model=nil, options={}) #alias ta()
+translate_collection(key, model=nil, options={}) #alias tc()
+
+# and corresponding methods which tests presence of given translation:
+translate_label?(key, model=nil, options={}) #alias tl?()
+...
+
+```
+
+**Usage example for working with :labels**
+
+```ruby
+# translate_label(key, model=nil, options={}), alias: tl
+tl(:send) # returns Wyślij
+tl(:create_order, :order) #returns "Stwórz zamówienie"
+tl(:create_order, @order) #works the same
+tl(:create_order, Order) #also the same
+tl(:create_order, OrderDecorator) #the same again /using Draper gem
+```
+
+**and with :collections**
+```ruby
+# translate_collection(key, model=nil, options={}), alias: tc
+
+# example for global translation:
+tc(:yes_no) # returns [["Tak", true],["Nie", false]]
+
+# example for resource translation
+tc(:order_type, :order) #returns [["odrzucone", "rejected"], ["zaakceptowane", "accepted"]]
+```
+
+**IMPORTANT** - in collections you **don't** have to use ..._collection suffix. Because of this you can iterate through attributes and view selectboxes without extra key operation:
+
+```rails
+# haml and simple_form example
+[attr1, attr2, attr3].each do |t|
+  f.input t, collection: tc(t, :model), :label => ta(t, :model)
+end
+
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'i18n_structure'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install i18n_structure
+
+
+## Generator
+
+You can generate all necessary locale files by using generator
+
+    $ rails g i18nstructure pl #for polish translations
+
+Generator also adds:
+
+    $ config.i18n.load_path += Dir[Rails.root.join('config', 'locales', '**', '*.{rb,yml}')]
+
+in your application.rb
+
+
+## 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
+
+## License
+
+MIT

data/Rakefile

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

data/i18n_structure.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'i18n_structure/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "i18n_structure"
+  spec.version       = I18nStructure::VERSION
+  spec.authors       = ["Wojciech Krysiak"]
+  spec.email         = ["wojciech.g.krysiak@gmail.com"]
+  spec.description   = %q{Create structure for I18n locale files}
+  spec.summary       = %q{Create structure for I18n locale files}
+  spec.homepage      = "https://github.com/KMPgroup/i18n-structure"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'rails', '>= 3.0.0'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'draper'
+  spec.add_development_dependency 'rspec'
+end

data/lib/generators/i18n_structure/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Generates translations for all models and default global translations
+
+Example:
+    % rails g i18nstructure (pl, en ....)
+
+    This will create:
+        config/locales/locale/en/labels.yml
+        config/locales/locale/en/collections.yml
+        config/locales/locale/en/attributes.yml
+        config/locales/locale/en/tooltips.yml
+        config/locales/locale/en/ar/user.yml (for model user if you have it in your db)
+        config/locales/locale/en/ar/order.yml (for model order if you have it in your db)
+        etc....

data/lib/generators/i18n_structure/i18n_structure_generator.rb

@@ -0,0 +1,64 @@
+# require 'generators/i18n_translation/lib/yaml'
+require 'rails/generators'
+require 'i18n'
+require 'yaml'
+
+class I18nStructureGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("../templates", __FILE__)
+  argument :locale_name, :type => :string, :default => "pl"
+
+  def main
+    unless locale_name =~ /^[a-zA-Z]{2}([-_][a-zA-Z]+)?$/
+      log 'ERROR: Wrong locale format. Please give locale in XX or XX-XX format.'
+      exit
+    end
+    log "create i18n structure for locale: #{locale_name}"
+
+    create_folders_for_locale(locale_name)
+    copy_initializer_file(locale_name)
+    create_ar_locales(locale_name)
+    update_locale_lookup_path
+  end
+
+
+  private
+    def update_locale_lookup_path
+      application "config.i18n.load_path += Dir[Rails.root.join('config', 'locales', '**', '*.{rb,yml}')]"
+    end
+
+    def create_folders_for_locale(locale)
+      empty_directory "config/locales/#{locale}"
+      empty_directory "config/locales/#{locale}/ar"
+    end
+
+    def copy_initializer_file(locale)
+      empty_directory "config/locales/#{locale}"
+      %w{attributes.yml collections.yml labels.yml tooltips.yml}.each do |fn|
+        url = "config/locales/#{locale}/#{fn}"
+        copy_file fn, url
+
+        h = YAML::load_file(url)
+        h[locale_name] = h.delete("locale_name")
+        File.open(url, 'w') {|f| f.write h.to_yaml }
+      end
+    end
+
+    def create_ar_locales(locale_name)
+      table_names = ActiveRecord::Base.connection.tables.reject{|name| name == "schema_migrations"}
+      ar_path = "config/locales/#{locale_name}/ar"
+      empty_directory ar_path if table_names.any?
+      table_names.each do |table_name|
+        file_url = ar_path+"/#{table_name}.yml"
+        copy_file "ar.yml", file_url
+        h = YAML::load_file(file_url)
+        h[locale_name] = h.delete("locale_name")
+        h[locale_name]["activerecord"]["errors"]["models"][table_name.singularize] = h[locale_name]["activerecord"]["errors"]["models"].delete("model_name")
+        ["labels", "tooltips", "attributes"].each do |r|
+          h[locale_name]["activerecord"][r][table_name.singularize] = h[locale_name]["activerecord"][r].delete("model_name")
+        end
+
+
+        File.open(file_url, 'w') {|f| f.write h.to_yaml }
+      end
+    end
+end

data/lib/generators/i18n_structure/templates/ar.yml

@@ -0,0 +1,29 @@
+locale_name: 
+  activerecord:
+    errors:
+      models:
+        model_name:
+          attributes:
+            name:
+              some_errors_for_ar: You have error for this field
+    labels:
+      model_name:
+        example_field_with_versions:
+          one: one version
+          few: fev version
+          many: many version
+          other: other version
+        other_normal_field: This is first header
+    tooltips:
+      model_name:
+        id: Example Tooltip for id
+    attributes:
+      model_name:
+        example_category: My awesome category
+        example_category_collection:
+          - 
+            - only right
+            - right
+          - 
+            - only wrong
+            - wrong

data/lib/generators/i18n_structure/templates/attributes.yml

@@ -0,0 +1,4 @@
+locale_name:
+  attributes:
+    name: Default name
+    version: System version

data/lib/generators/i18n_structure/templates/collections.yml

@@ -0,0 +1,9 @@
+locale_name:
+  collections:
+    your_first_collection:
+      - 
+        - First collection value
+        - first_collection_value
+      - 
+        - Second collection value
+        - second_collection_value

data/lib/generators/i18n_structure/templates/labels.yml

@@ -0,0 +1,3 @@
+locale_name:
+  labels:
+    your_first_label: Your first translated label

data/lib/generators/i18n_structure/templates/tooltips.yml

@@ -0,0 +1,4 @@
+locale_name:
+  tooltips:
+    name: tooltip for name
+    version: tooltip for version

data/lib/i18n_structure/i18n_extension.rb

@@ -0,0 +1,54 @@
+I18n.extend( Module.new{
+  [:labels, :tooltips, :attributes].each do |kind|
+    define_method("translate_#{kind.to_s.singularize}") do |*args|
+      translate_element(kind, *args)
+    end
+    alias_method "t#{kind.to_s[0]}", "translate_#{kind.to_s.singularize}"
+
+    define_method("translate_#{kind.to_s.singularize}_exist?") do |*args|
+      translate_element_exist?(kind, *args)
+    end
+    alias_method "t#{kind.to_s[0]}?", "translate_#{kind.to_s.singularize}_exist?"
+  end
+
+  # collections are handled different than other elements
+  def translate_collection(key, model=nil, options={})
+    if model
+      translate_attribute(key.to_s+"_collection", model, options)
+    else
+      I18n.t(key, :scope => [:collections])
+    end
+  end
+  alias_method :tc, :translate_collection
+
+  private
+    # change passed object to key used in localization
+    def to_mode_name(model)
+      if defined?(ActiveRecord) && model.kind_of?(ActiveRecord)
+        model.class.model_name.singular
+      elsif defined?(Draper) && model.kind_of?(Draper::Decorator)
+        model.source.class.model_name.singular
+      elsif model.is_a?(Class)
+        model.model_name.singular
+      else
+        model
+      end
+    end
+     
+    #transleates element of specyfic kind (label, attribute)
+    def translate_element(element_kind, key, model=nil, options={})
+      if model
+        translate(key, {:scope => [:activerecord, element_kind, to_mode_name(model)]}.merge(options))
+      else
+        translate(key, {:scope => [element_kind]}.merge(options))
+      end  
+    end
+
+    def translate_element_exist?(element_kind, key, model=nil, options={})
+      if model
+        return translate(key, :scope => [:activerecord, element_kind, to_mode_name(model)], :default => "").present?
+      else
+        return translate(key, :scope => [element_kind], :default => "").present?
+      end  
+    end
+})

data/lib/i18n_structure/locale_helper.rb

@@ -0,0 +1,15 @@
+module I18nStructure
+  module LocaleHelper
+    [:labels, :tooltips, :attributes, :collections].each do |kind|
+      define_method("translate_#{kind.to_s.singularize}") do |*args|
+        I18n.send("translate_#{kind.to_s.singularize}", *args)
+      end
+      alias_method "t#{kind.to_s[0]}", "translate_#{kind.to_s.singularize}"
+
+      define_method("translate_#{kind.to_s.singularize}_exist?") do |*args|
+        I18n.send("translate_#{kind.to_s.singularize}_exist?", *args)
+      end
+      alias_method "t#{kind.to_s[0]}?", "translate_#{kind.to_s.singularize}_exist?"
+    end
+  end
+end

data/lib/i18n_structure/version.rb

@@ -0,0 +1,3 @@
+module I18nStructure
+  VERSION = "0.0.2"
+end

data/lib/i18n_structure.rb

@@ -0,0 +1,9 @@
+require "i18n_structure/version"
+require "i18n_structure/i18n_extension"
+require "i18n_structure/locale_helper"
+
+ActionView::Base.send :include, I18nStructure::LocaleHelper
+
+module I18nStructure
+  
+end

data/spec/i18n_extension_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+require "i18n_structure/i18n_extension"
+require 'active_record'
+require 'draper'
+
+I18n.config.load_path += Dir[
+  File.join(File.dirname(__FILE__), 'locales', "*.yml").to_s
+]
+
+describe I18n do
+  describe ".translate_attribute" do
+    it "translates attr in model" do
+      expect(I18n.translate_attribute(:foo, :bar)).to eq "foobar"
+    end
+
+    it "translates with alias without model" do
+      expect(I18n.ta(:foo)).to eq "foobar_global"
+    end
+  end
+
+  describe ".translate_collection" do
+    it "translate collection in mode" do
+      expect(I18n.translate_collection(:foo, :bar).size).to eq 2
+    end
+
+    it "translate collection withoud model (global collection)" do
+      expect(I18n.translate_collection(:foo_collection).first).to eq ["element1_key", "element1_value"]
+    end
+  end
+
+  describe ".translate_label_exist?" do
+    it "checks unexisting label" do
+      expect(I18n.tl?(:some_dummmy_unexisted_key, :also_dummy_model)).to be_false
+    end
+
+    it "checks existing label" do
+      expect(I18n.translate_label_exist?(:exist_label)).to be_true
+    end
+  end
+end

data/spec/i18n_structure_generator.rb

@@ -0,0 +1,7 @@
+describe I18nStructureGenerator do
+  subject { I18nStructureGenerator.new(['pl']) }
+
+  it "should description" do
+    
+  end
+end

data/spec/locales/en.yml

@@ -0,0 +1,21 @@
+en:
+  activerecord:
+    attributes:
+      bar:
+        foo: foobar
+        foo_collection:
+          - 
+            - first_name
+            - first_value
+          - 
+            - second_name
+            - secong_value
+  collections:
+    foo_collection:
+      - 
+        - element1_key
+        - element1_value
+  attributes:
+    foo: foobar_global
+  labels:
+    exist_label: it exist!

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rails'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: i18n_structure
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Wojciech Krysiak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rails
+  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: draper
+  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: 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: Create structure for I18n locale files
+email:
+- wojciech.g.krysiak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- i18n_structure.gemspec
+- lib/.DS_Store
+- lib/generators/i18n_structure/USAGE
+- lib/generators/i18n_structure/i18n_structure_generator.rb
+- lib/generators/i18n_structure/templates/ar.yml
+- lib/generators/i18n_structure/templates/attributes.yml
+- lib/generators/i18n_structure/templates/collections.yml
+- lib/generators/i18n_structure/templates/labels.yml
+- lib/generators/i18n_structure/templates/tooltips.yml
+- lib/i18n_structure.rb
+- lib/i18n_structure/.DS_Store
+- lib/i18n_structure/i18n_extension.rb
+- lib/i18n_structure/locale_helper.rb
+- lib/i18n_structure/version.rb
+- spec/i18n_extension_spec.rb
+- spec/i18n_structure_generator.rb
+- spec/locales/en.yml
+- spec/spec_helper.rb
+homepage: https://github.com/KMPgroup/i18n-structure
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Create structure for I18n locale files
+test_files:
+- spec/i18n_extension_spec.rb
+- spec/i18n_structure_generator.rb
+- spec/locales/en.yml
+- spec/spec_helper.rb