i18n_model_translator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a746825c89ec2e7e57fc815efc57f0e117b0f90
+  data.tar.gz: 15e80dc47f970bb7b049f650e93672aa6bad564e
+SHA512:
+  metadata.gz: 33b4be7e0f01d5bd92d591b43d63307415c67961d5bfb206d917c47583d2a6c623716779dd97219cb26984161fd9d70611417276fcb69b38e83828248d12f6f9
+  data.tar.gz: 879c8e8f6af4465cd5c4184401afa2947b5b7a6927f1c327405d793bce8e5d846a12fd520afea054d1ccc33c2ff7e66bd7bb81e380ca39c740507d3f42ce8694

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+
+# Ignore RVM autoconfig file
+.rvmrc
+.ruby-version
+.ruby-gemset

data/.idea/.name

@@ -0,0 +1 @@
+i18n_translator

data/.idea/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build i18n_translator-0.0.1.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Build and install i18n_translator-0.0.1.gem into system gems" fullCmd="install" taksId="install" /><RakeTask description="Create tag v0.0.1 and build and push i18n_translator-0.0.1.gem to Rubygems" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup></RakeGroup></Settings>

data/.idea/encodings.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Encoding" useUTFGuessing="true" native2AsciiForPropertiesFiles="false" />
+</project>

data/.idea/misc.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectLevelVcsManager" settingsEditedManually="false">
+    <OptionsSetting value="true" id="Add" />
+    <OptionsSetting value="true" id="Remove" />
+    <OptionsSetting value="true" id="Checkout" />
+    <OptionsSetting value="true" id="Update" />
+    <OptionsSetting value="true" id="Status" />
+    <OptionsSetting value="true" id="Edit" />
+    <ConfirmationsSetting value="0" id="Add" />
+    <ConfirmationsSetting value="0" id="Remove" />
+  </component>
+  <component name="ProjectRootManager" version="2" project-jdk-name="RVM: ruby-2.1.1" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/i18n_model_translator.iml" filepath="$PROJECT_DIR$/.idea/i18n_model_translator.iml" />
+      <module fileurl="file://$PROJECT_DIR$/.idea/i18n_translator.iml" filepath="$PROJECT_DIR$/.idea/i18n_translator.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/scopes/scope_settings.xml

@@ -0,0 +1,5 @@
+<component name="DependencyValidationManager">
+  <state>
+    <option name="SKIP_IMPORT_STATEMENTS" value="false" />
+  </state>
+</component>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Patrick Nitschke
+
+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,73 @@
+# I18nModelTranslator
+
+Gem that generates i18n model translations for existing models. If you have descriptive column names in english it will generate the following files for your models:
+config/locales/models/model_name/en.yml
+
+This is an example outcome:
+
+```
+en:
+  active_record:
+    models:
+      webinar_presenter:
+        one: Webinar presenter
+        other: Webinar presenters
+    attributes:
+      webinar_presenter:
+        webinar_id: Webinar
+        presenter_email: Presenter email
+        presenter_url: Presenter url
+        user_id: User
+        entry_time: Entry time
+        exit_time: Exit time
+        screen_name: Screen name
+        attended_minutes: Attended minutes
+```
+
+It skips the columns :id, :created_at and :updated_at.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'i18n_model_translator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install i18n_model_translator
+
+## Usage
+
+
+This gem gives you four rake tasks to create the model i18ns:
+
+####Print a specific model i18n. Pass the model name as parameter:
+
+    $ rake i18n_model_translator:print_model[model]
+
+####Prints all model (except HABTM) i18ns:
+
+    $ rake i18n_model_translator:print_all_models
+
+####Print a specific model i18n directly to the file 'config/locales/models/model_name/en.yml'. Pass the model name as parameter. It will not override existing files:
+
+    $ rake i18n_model_translator:print_model_to_file[model]
+
+####Print i18ns for each model directly to the file 'config/locales/models/model_name/en.yml'. It will not override existing files:
+
+    $ rake i18n_model_translator:print_all_models_to_file[model]
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/i18n_model_translator/fork )
+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 a new Pull Request

data/Rakefile

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

data/i18n_model_translator.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'i18n_model_translator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "i18n_model_translator"
+  spec.version       = I18nModelTranslator::VERSION
+  spec.authors       = ["Jens Freiling"]
+  spec.email         = ["jcfrei@uni-koblenz.de"]
+  spec.summary       = %q{Generate I18n Model Translation Files}
+  spec.description   = %q{Yes...}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency 'rails', '~> 4.0'
+  spec.add_dependency 'i18n'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'sqlite3', '~> 0'
+  spec.add_development_dependency 'generator_spec'
+  spec.add_development_dependency 'rspec', '~> 3.2.0'
+end

data/lib/i18n_model_translator.rb

@@ -0,0 +1,23 @@
+require 'i18n_model_translator/version'
+
+module I18nModelTranslator
+  require 'i18n_model_translator/railtie' if defined?(Rails)
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+  class Configuration
+    attr_accessor :model_locale_path, :translation_source_locale, :locales
+
+    def initialize
+      @model_locale_path = 'config/locales/models'
+      @translation_source_locale = I18n.default_locale
+      @locales = I18n.available_locales rescue []
+    end
+  end
+end

data/lib/i18n_model_translator/models/model_translation.rb

@@ -0,0 +1,79 @@
+require 'fileutils'
+
+module I18nTranslator
+  module Models
+    module ModelTranslation
+      class << self
+
+        def generate_model_translation(model, locale)
+          active_record_hash = {active_record: {}}
+          names = generate_model_names(model)
+          attributes = generate_model_attributes(model)
+          active_record_hash[:active_record].merge!(names)
+          active_record_hash[:active_record].merge!(attributes)
+          {locale.to_sym => active_record_hash}.deep_stringify_keys.psych_to_yaml
+        end
+
+        def write_model_translation(model, locale)
+          content = generate_model_translation model, locale
+          write_to_file model, locale, content
+        end
+
+        def print_all_model_translations(locale)
+          load_models.each do |model|
+            puts generate_model_translation(model, locale)
+          end
+        end
+
+        def write_all_model_translations(locale)
+          load_models.each do |model|
+            write_model_translation model, locale
+          end
+        end
+
+        private
+
+        def generate_model_names(model)
+          model_name = model.to_s.tableize.split('/').last
+          {models: {model.to_s.tableize.singularize.to_sym => {
+              one: model_name.singularize.humanize,
+              other: model_name.pluralize.humanize
+          }}}
+        end
+
+        def generate_model_attributes(model)
+          hash = {}
+          exclude = %w[id created_at updated_at]
+          (model.column_names - exclude).each do |column_name|
+            hash.merge!({
+                            column_name.to_sym => column_name.humanize
+                        })
+          end
+          {attributes: {model.to_s.tableize.singularize.to_sym => hash}}
+        end
+
+        def load_models
+          Rails.application.eager_load!
+          models = ActiveRecord::Base.descendants
+          models.delete([ActiveRecord::SchemaMigration])
+          models.reject! { |model| model.name.include?('HABTM') | !model.table_exists? }
+        end
+
+        def write_to_file(model, locale, content)
+          path = "#{Rails.root}/config/locales/models/#{model.to_s.tableize.singularize}/#{locale}.yml"
+          unless File.exist?(path)
+
+            # create directories
+            dirname = File.dirname(path)
+            unless File.directory?(dirname)
+              FileUtils.mkdir_p(dirname)
+            end
+
+            # write to file
+            File.open(path, 'w') { |file| file.write(content) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n_model_translator/railtie.rb

@@ -0,0 +1,11 @@
+require 'i18n_model_translator'
+require 'rails'
+module MyPlugin
+  class Railtie < Rails::Railtie
+    railtie_name :i18n_model_translator
+
+    rake_tasks do
+      load "tasks/i18n_model_translator.rake"
+    end
+  end
+end

data/lib/i18n_model_translator/version.rb

@@ -0,0 +1,3 @@
+module I18nModelTranslator
+  VERSION = '1.0.0'
+end

data/lib/tasks/i18n_model_translator.rake

@@ -0,0 +1,25 @@
+namespace :i18n_model_translator do
+
+  require 'i18n_model_translator/models/model_translation'
+
+  desc 'prints out the locale for one specific model'
+  task :print_model, [:model] => :environment do |t, args|
+    puts I18nTranslator::Models::ModelTranslation.generate_model_translation(args[:model].constantize, :en)
+  end
+
+  desc 'prints out the model locale for the given model into /config/locales/models/model_name/en.yml'
+  task :print_model_to_file, [:model] => :environment do |t, args|
+    I18nTranslator::Models::ModelTranslation.write_model_translation(args[:model].constantize, :en)
+  end
+
+  desc 'prints out the locales for each model in the environment'
+  task :print_all_models => :environment do |t, args|
+    I18nTranslator::Models::ModelTranslation.print_all_model_translations :en
+  end
+
+  desc 'prints out all model locale into /config/locales/models/model_name/en.yml'
+  task :print_all_models_to_file => :environment do |t, args|
+    I18nTranslator::Models::ModelTranslation.write_all_model_translations :en
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+require 'generator_spec'
+require 'i18n_model_translator'
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: i18n_model_translator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jens Freiling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: generator_spec
+  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: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Yes...
+email:
+- jcfrei@uni-koblenz.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/.name"
+- ".idea/.rakeTasks"
+- ".idea/encodings.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/scopes/scope_settings.xml"
+- ".idea/vcs.xml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- i18n_model_translator.gemspec
+- lib/i18n_model_translator.rb
+- lib/i18n_model_translator/models/model_translation.rb
+- lib/i18n_model_translator/railtie.rb
+- lib/i18n_model_translator/version.rb
+- lib/tasks/i18n_model_translator.rake
+- spec/spec_helper.rb
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Generate I18n Model Translation Files
+test_files:
+- spec/spec_helper.rb