t_t 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc0178a11cfb6485afd79658204c099a1669b9e2
+  data.tar.gz: 5b2fe90809f3c1ecc26dfa80c31b7ae54d104c50
+SHA512:
+  metadata.gz: 2bf34f3f4efb00014850798c385233ce27c9956a9867080d9c4cdc0141052d3ec3d6bbbbe66922e4be2f933a52fc758566e8e912adb6c9306b6e740ed221c5eb
+  data.tar.gz: 157cedeec1cbcab34a82d77a5d70844aea77193bde81d2d5f9272f304f68c580a49c879a4fde8169eada2a8307eb58f90fce50a9d01e6d4f9aa2b66b657fda7f

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/Gemfile.custom
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in t_t.gemspec
+gemspec
+
+eval(File.read("./Gemfile.custom")) if File.exists?("./Gemfile.custom")

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sergey Pchelintsev
+
+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,91 @@
+## About
+
+The main goal of Dos-T is reducing time on supporting a multi-language web application by providing a few conventions and a short method names. We believe that it's a primary reason which slows down development. Cause it's boring to write a long path like `t('namespace.controller_name.action_name.section.key')`. Let's better spend time on something more interesting.
+
+So what's makes Dos-T such a good tool(on our opinion):
+
+### Example of page
+
+```haml
+/ users#index
+= link_to tt.c(:new_resource, model: tt.resource), new_user_path, "data-tooltip" => tt(:new_user_tip)
+
+%table
+  %tr
+    %th= tt.attr :name
+    %th= tt.attr :email
+    %th= tt.attr :phone
+    %th= tt.attr :role
+    %th= tt.c :actions
+  - @users.each do |user|
+    %tr
+      %td= user.name
+      %td= user.email
+      %td= user.phone
+      %td= tt.enum :role, user.role
+      %td
+        = link_to tt.f(:edit), edit_user_path(user)
+        = link_to tt.f(:delete), user_path(user), method: :delete, confirm: tt.c(:confirm)
+
+/ tt.c looks in 'users.common', 'common'
+/ tt.f looks in 'users.form', 'form'
+/ tt looks in 'users.index', 'users.common'
+/ tt.attr - calls human_attribute_name on User
+/ tt.enum - calls human_attribute_name on User with role_%value%
+/ tt.resource - User.model_name.human(count: 1)
+```
+
+### Global commons
+
+`tt.c` - in every application there are some elements which are present in every page. For example, if a page has "delete some resource" button/link, it's good to have a confirmation message which tells a user "Are you sure?". At this point you add a key for this page, for example, in "admin.users.index.confirm" path and on page call `t('.confirm')`. Rails is smart enough to prepend a full path to ".confirm" key. But then you need to add confirmation on `admin/users#show` and you, probably, will not duplicate it for "show" page and move it into a common section. After that the translation helper can't help us and we need to provide a full path – `t('common.confirm')`. We reduce a duplication of translation keys, but have to write a long methods. Well, as always, programming is a compromise. But not this time, with Dos-T you can have both – just call `tt.c(:confirm)`. At first it will look into a section's common node(description of a section see below). If Dos-T doesn't find a translation there it will look into the global *common* >>> *common.confirm*. You, probably, are interested what's a section. By a section Dos-T means I18n path of the current controller(mailer). Let's review the previous example. If our current controller is `Admin::UsersController`, the section is *admin.users*. That's why if we want for deleting users a special confirmation we just add "admin.users.common.confirmation" key and it's done.
+
+`tt.f` - the global `common` section could fast become a huge and you will add some namespaces into it. We prefer a facts over a supposes, but there is a 100% assumption that you will have this subsection - `common.form` with `save`, `edit`, `delete` and etc. Cause we don't know any application which doesn't have that. That's why Dos-T has another method `tt.f` which like `tt.c` -  first looks into the current section(*controller_path.form*) and fallbacks into the global("form").
+
+And finally, Dos-T allows you to define a new "common-used" sections. For example, for breadcrumbs. Just place "tt.rb" file in config/initializations that:
+
+```ruby
+ActiveSupport.on_load(:tt) do
+  shortcut(:crumbs, :breadcrumbs) # => tt.crumbs(:index) which looks into `breadcrumbs` sections
+  shortcut(:tip, :tooltips) # => tt.tip(:readonly) which looks into `tooltips` sections
+end
+```
+
+### Section's commons
+
+`tt` - let's back to our example with user management pages. Our clients decided to add a gravatar support. To make this feature more clear to admins we should put a tooltip with a description on index and show page, next to label "Gravatar". It brings a problem where to put a translation. If we put it into 'admin.users.index' we can use `t('.gravatar')` on index page, but have to use `t('admin.users.index.gravatar')` on show page and vice versa. And there Dos-T helps us. Just put `tt(:gravatar)` and put the tip into 'admin.users.common'. First it will act like a `t('.gravatar')` and fallbacks into section's common. And yes, `tt(:key)` is one symbol shorter than t('.key') – you can't avoid `t` in a favour to `tt`.
+
+### Resource translations
+
+`tt.attr` - we think every developer enjoys how `form_for` easily translates column's label - `f.label :column_name` - and Rails will magically translate it. But then we have to use an ugly way(`User.human_attribute_name(:column_name)`) to reuse these translations on index and show pages. It's become boring to type again and again this `human_attribute_name`. Dos-T provides a shortcut `tt.attr :column_name, User`. But it could be a shorter, cause if you call it in `UsersController` in 9/10 you closely work with User model. That's why, a second argument in `#attr` method is an optional and default value is a context class. A context class is computed on a controller name. If it's `users_controller`, Dos-T expects for a User model presence. If it's `Admin::UsersController` a context class is still User model.
+
+### Other useful methods
+
+* `tt.record([context_class])` – returns the singular human name of a model class(alias - resource)
+* `tt.records([context_class])` – returns the plural human name of a model class(alias – resources)
+* `tt.no_records([context_class])` – returns the zero form human name of a model class(alias – no_resources)
+* `tt.enum(attr_name, variant, [context_class])` – returns a human variant name of an attribute. It looks for human  attribute name of "%attr_name%_%variant%"
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 't_t'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install t_t
+
+
+## Contributing
+
+1. Fork it ( https://github.com/jalkoby/t_t/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,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "tests"
+  t.pattern = 'tests/**/*_test.rb'
+end
+
+task default: :test

data/lib/t_t.rb

@@ -0,0 +1,88 @@
+require "active_support/lazy_load_hooks"
+require "i18n"
+
+module TT
+  class Translator
+    def self.shortcut(meth_name, section)
+      class_eval <<-RUBY
+        def #{ meth_name }(key, options = {})
+          I18n.t "\#{ ns }.#{ section }.\#{ key }",
+            { default: :"#{ section }.\#{ key }" }.merge(options)
+        end
+      RUBY
+    end
+
+    def initialize(ns, section)
+      @ns = ns
+      @section = section
+    end
+
+    def t(key, options = {})
+      I18n.t "#{ ns }.#{ section }.#{ key  }",
+        { default: :"#{ ns }.common.#{ key  }" }.merge(options)
+    end
+
+    shortcut :c, :common
+    shortcut :f, :form
+
+    def attr(name, klass = context_klass)
+      klass.human_attribute_name(name)
+    end
+
+    def enum(name, kind, klass = context_klass)
+      klass.human_attribute_name("#{ name }_#{ kind }")
+    end
+
+    def resource(klass = context_klass)
+      klass.model_name.human(count: 1)
+    end
+    alias_method :record, :resource
+
+    def resources(klass = context_klass)
+      klass.model_name.human(count: 10)
+    end
+    alias_method :records, :resources
+
+    def no_resources(klass = context_klass)
+      klass.model_name.human(count: 0)
+    end
+    alias_method :no_records, :no_resources
+
+    private
+
+    attr_reader :ns, :section
+
+    def context_klass
+      return @context_klass if @context_klass
+
+      @context_klass = ns.split('.').map(&:classify).join('::').singularize.constantize
+    end
+
+    ActiveSupport.run_load_hooks(:tt, self)
+  end
+end
+
+if defined?(ActionPack) || defined?(ActionMailer)
+  module TT::Helper
+    extend ::ActiveSupport::Concern
+
+    included do
+      helper_method :tt
+    end
+
+    private
+
+    def tt(*args)
+      @tt ||= ::TT::Translator.new(controller_path.gsub('/', '.'), action_name)
+      args.empty? ? @tt : @tt.t(*args)
+    end
+  end
+
+  ActiveSupport.on_load(:action_controller) do
+    include ::TT::Helper
+  end
+
+  ActiveSupport.on_load(:action_mailer) do
+    include ::TT::Helper
+  end
+end

data/t_t.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "t_t"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Sergey Pchelintsev"]
+  spec.email         = ["mail@sergeyp.me"]
+  spec.summary       = %q{An opinioned I18n helper}
+  spec.description   = %q{An opinioned I18n helper}
+  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 "i18n", ">= 0.6.0"
+  spec.add_dependency "activesupport", ">= 3.0.0"
+
+  spec.add_development_dependency "actionpack", ">= 3.0.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "minitest", ">= 4.7"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/tests/lib/action_pack_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class TTController < ActionController::Base
+  public :tt
+end
+
+describe "ActionPack integration" do
+  before do
+    @controller = TTController.new
+  end
+
+  it 'returns tt instance if the method was called without args' do
+    assert_equal @controller.tt.class, TT::Translator
+  end
+
+  it 'calls #t if args were passed' do
+    assert_equal @controller.tt.c(:tar), 'global_tar'
+  end
+end

data/tests/lib/t_t_test.rb

@@ -0,0 +1,146 @@
+require 'test_helper'
+
+describe TT::Translator do
+  before do
+    @tt = TT::Translator.new("tt", "spec")
+  end
+
+  describe '#t' do
+    it "looks for a section translation first" do
+      assert_equal @tt.t(:foo), "spec_foo"
+    end
+
+    it "falls back to common namespace translations" do
+      assert_equal @tt.t(:bar), "namespace_bar"
+    end
+
+    it "allows a custom options" do
+      assert_equal @tt.t(:tar, default: "default_tar"), "default_tar"
+    end
+  end
+
+  describe '#c' do
+    it "looks for a namespace translation first" do
+      assert_equal @tt.c(:foo), "namespace_foo"
+    end
+
+    it "falls back to a global translation" do
+      assert_equal @tt.c(:tar), "global_tar"
+    end
+
+    it "allows a custom options" do
+      assert_equal @tt.c(:car, default: "default_car"), 'default_car'
+    end
+  end
+
+  describe '#f' do
+    it "looks for a namespace translation first" do
+      assert_equal @tt.f(:edit), "namespace_edit"
+    end
+
+    it "falls back to a global translation" do
+      assert_equal @tt.f(:save), "global_save"
+    end
+
+    it "allows a custom options" do
+      assert_equal @tt.f(:commit, default: "default_commit"), "default_commit"
+    end
+  end
+
+  describe 'a model related methods' do
+    before do
+      @klass = Minitest::Mock.new
+    end
+
+    describe '#attr' do
+      it 'uses the provided class' do
+        @klass.expect(:human_attribute_name, 'Nombre', [:name])
+        assert_equal @tt.attr(:name, @klass), 'Nombre'
+      end
+
+      it 'uses a context class by default' do
+        @klass.expect(:human_attribute_name, 'Nombre', [:name])
+        @tt.stub(:context_klass, @klass) do
+          assert_equal @tt.attr(:name), 'Nombre'
+        end
+      end
+    end
+
+    describe '#enum' do
+      it 'uses the provided class' do
+        @klass.expect(:human_attribute_name, 'Melody', ['type_melody'])
+        assert_equal @tt.enum(:type, :melody, @klass), 'Melody'
+      end
+
+      it 'uses a context class by default' do
+        @klass.expect(:human_attribute_name, 'Sound', ['type_sound'])
+        @tt.stub(:context_klass, @klass) do
+          assert_equal @tt.enum(:type, :sound), 'Sound'
+        end
+      end
+    end
+
+    describe 'a model name' do
+      before do
+        @model_name = Minitest::Mock.new
+        @klass.expect(:model_name, @model_name)
+      end
+
+      describe '#resource' do
+        before do
+          @model_name.expect(:human, 'Coche', [{ count: 1 }])
+        end
+
+        it 'uses the provided class' do
+          assert_equal @tt.resource(@klass), 'Coche'
+        end
+
+        it 'uses a context class by default' do
+          @tt.stub(:context_klass, @klass) do
+            assert_equal @tt.resource, 'Coche'
+          end
+        end
+      end
+
+      describe '#resources' do
+        before do
+          @model_name.expect(:human, 'Coches', [{ count: 10 }])
+        end
+
+        it 'uses the provided class' do
+          assert_equal @tt.resources(@klass), 'Coches'
+        end
+
+        it 'uses a context class by default' do
+          @tt.stub(:context_klass, @klass) do
+            assert_equal @tt.resources, 'Coches'
+          end
+        end
+      end
+
+      describe '#no_resources' do
+        before do
+          @model_name.expect(:human, 'Coches', [{ count: 0 }])
+        end
+
+        it 'uses the provided class' do
+          assert_equal @tt.no_resources(@klass), 'Coches'
+        end
+
+        it 'uses a context class by default' do
+          @tt.stub(:context_klass, @klass) do
+            assert_equal @tt.no_resources, 'Coches'
+          end
+        end
+      end
+
+      after do
+        assert @model_name.verify
+      end
+    end
+
+    after do
+      assert @klass.verify
+    end
+  end
+end

data/tests/test_helper.rb

@@ -0,0 +1,42 @@
+require "minitest/autorun"
+require "minitest/mock"
+require "rack/test"
+require "action_controller"
+require "t_t"
+
+I18n.backend = I18n::Backend::Simple.new
+I18n.backend.store_translations(:en, {
+  common: {
+    tar: 'global_tar'
+  },
+  crumbs: {
+    index: 'global_index',
+    new: 'global_new'
+  },
+  form: {
+    edit: "global_edit",
+    save: "global_save"
+  },
+  tooltip: {
+    info: "global_info",
+    notice: "global_notice"
+  },
+  tt: {
+    common: {
+      foo: "namespace_foo",
+      bar: "namespace_bar"
+    },
+    crumbs: {
+      new: 'namespace_new'
+    },
+    form: {
+      edit: "namespace_edit"
+    },
+    spec: {
+      foo: "spec_foo"
+    },
+    tooltip: {
+      info: "namespace_info"
+    }
+  }
+})

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: t_t
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sergey Pchelintsev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: 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'
+description: An opinioned I18n helper
+email:
+- mail@sergeyp.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/t_t.rb
+- t_t.gemspec
+- tests/lib/action_pack_test.rb
+- tests/lib/t_t_test.rb
+- tests/test_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.2.2
+signing_key: 
+specification_version: 4
+summary: An opinioned I18n helper
+test_files: []