hexx 7.0.1 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adb6424142ab3c257299fcb041460531b522fb07
-  data.tar.gz: e431cd32de61cb5d0cbb7d6a04a0857c2aa13afd
+  metadata.gz: 8b0ca93b80a2f6c0c3748f0a273d9edda36972ba
+  data.tar.gz: 19527f2b06838db356f0bb99df053671bc1fce70
 SHA512:
-  metadata.gz: bfcd1ea97d548e82af5b5970b143c446ad7525ba1a0acd01d63ad27b0dbd0a72aa247e16fe15744e9e3a0b223f70d5eabfa33b88fcbd815a104fee5a53554db1
-  data.tar.gz: 5cdf1a02b98f49ef603e5ac33019606d066dcf04e8d8ee3827c5456be5e197d2f02dd49a1ee2c75a915c60a944e91c05430e54b5da0bd6e4a879f9c25da16d95
+  metadata.gz: 74c24d5eed54e869db7b3fdcbfe9cfbe3b3e1f8fa11cb287c2c51b9c9cc568ec7b067894526b2d68de238c78d94398fbf4d080a6ccd3e5b6c31bdc31b49ea945
+  data.tar.gz: d66c7f7a5eb5dbc20b2b1fdf78c53fdbaa99c36290267fddf1941cc7634af2dd5a072650d2546d78c9dc7b34004215c05fd3755fdfd293bc02bad7afe6fb69d3

data/README.rdoc

@@ -300,6 +300,56 @@ It is possible to test a service in isolation from its dependencies.
     end
   end
 
+=== Hexx::Name
+
+The module provides the base class for name constructors for various instances.
+
+It declares helpers:
+
+* +object+:: the attribute for the object to be named
+* +locale+:: the locale to name the object in
+* +scope+:: the current translation scope
+* +t(value, options):: the translator of the value in current scope and locale
+
+Inherit the class and reload its <tt>#for</tt> instance method:
+
+  module Names
+    class Hash < Hexx::Name
+      def for
+        user ? t(:user, value: user) : t(:empty)
+      end
+
+      def user
+        value = object[:user]
+        value ? value.upcase : nil
+      end
+    end
+  end
+
+Add the necessary translations:
+
+  # config/locales/ru.yml
+  ru:
+    activemodel:
+      names/hash:
+        user:  "чувак %{value}"
+        empty: "н/д"
+
+  # config/locales/en.yml
+  en:
+    activemodel:
+      names/hash:
+        user: "dude %{value}"
+        empty: "-"
+
+Then use its <tt>for</tt> class method to construct names:
+
+  Names::Hash.for { user: "Ivan" }, locale: :en
+  # => "dude IVAN"
+
+  Names::Hash.for { user: nil }, locale: :ru
+  # => "н/д"
+
 === Hexx::Null
 
 The class implements the {Null object}[http://robots.thoughtbot.com/rails-refactoring-example-introduce-null-object] pattern. The object:

data/lib/hexx/name.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+# require "extlib"
+
+module Hexx
+
+  class Name
+
+    # @!attribute [r] object
+    # The object to be named.
+    # @return [Object] the object.
+
+    # @!attribute [r] locale
+    # The locale to be used for naming.
+    # Equals <tt>I18n.locale</tt> by default.
+    # @return [Symbol] the locale.
+
+    attr_reader :object, :locale
+
+    # @note The class has a private constructor. Use {.for} method instead.
+    private_class_method :new
+
+    # @api hide
+    # The class instance initializer.
+    #
+    # @param  [Object] object The object to be named.
+    # @param  [Symbol] locale The locale to be used for naming.
+    # @return [Hexx::Name] the class instance.
+    def initialize(object, locale)
+      @object, @locale = object, locale
+    end
+
+    # @abstract
+    # Returns the name for the current {#object}.
+    #
+    # @return [String] the name.
+    def for
+      ""
+    end
+
+    # Constructs the name for given object and locale.
+    #
+    # @param  [Object] object The object to be named.
+    # @param  [Symbol, nil] locale (I18n.locale)
+    #   The locale to be used for naming.
+    # @return [String] the name.
+    def self.for(object, locale: I18n.locale)
+      new(object, locale).for
+    end
+
+    # Translates the value in the current scope and locale.
+    #
+    # @param  [Symbol, String] value The value to be translated.
+    # @param  [Hash] options ({}) The options for the translation.
+    # @return [String] The translation.
+    def t(value, options = {})
+      return value unless value.is_a? Symbol
+      I18n.t value, options.merge(locale: locale, scope: scope)
+    end
+
+    # The scope for object translation.
+    # @return [Array<String, Symbol>] the list of scopes.
+    def scope
+      @scope ||= %w(activemodel models) << object_name
+    end
+
+    private
+
+    def object_name
+      self.class.name.underscore.gsub("::", "/")
+    end
+  end
+end

data/lib/hexx/version.rb

@@ -2,5 +2,5 @@
 module Hexx
 
   # Current release.
-  VERSION = "7.0.1"
+  VERSION = "7.1.0"
 end

data/spec/hexx/name_spec.rb

@@ -0,0 +1,80 @@
+require "spec_helper"
+
+module Hexx
+  describe Name do
+
+    before { class Test < Name; end }
+    after  { Hexx.send :remove_const, :Test }
+
+    let(:object) { double :object }
+    let(:described_class)  { Test }
+    subject { described_class.send :new, object, :ua }
+
+    describe "#scope" do
+
+      it "is set by default" do
+        expect(subject.scope).to eq %w(activemodel models hexx/test)
+      end
+    end
+
+    describe "#object" do
+
+      it "is set by the initializer" do
+        expect(subject.object).to eq object
+      end
+    end
+
+    describe "#locale" do
+
+      it "can be set by the initializer" do
+        subject = described_class.send :new, object, :ua
+        expect(subject.locale).to eq :ua
+      end
+    end
+
+    describe "#t" do
+
+      it "translates the symbol in current scope and locale" do
+        result = subject.t :text
+        expect(result)
+          .to eq "translation missing: ua.activemodel.models.hexx/test.text"
+      end
+
+      it "returns non-symbols as is" do
+        value = "something"
+        expect(subject.t value).to eq value
+      end
+    end
+
+    describe "#for" do
+
+      it "returns a blank string" do
+        expect(subject.for).to eq ""
+      end
+    end
+
+    describe ".new" do
+
+      it "is private" do
+        expect(described_class.private_methods).to include :new
+      end
+    end
+
+    describe ".for" do
+
+      let(:name) { double for: nil }
+      before     { allow(described_class).to receive(:new).and_return name }
+
+      it "constructs the object and calls its #for method" do
+        expect(described_class).to receive(:new).with(object, :ua)
+        expect(name).to receive(:for)
+        described_class.for object, locale: :ua
+      end
+
+      it "sets locale by default" do
+        expect(described_class).to receive(:new).with(object, I18n.locale)
+        described_class.for object
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexx
 version: !ruby/object:Gem::Version
-  version: 7.0.1
+  version: 7.1.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-13 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -162,6 +162,7 @@ files:
 - lib/hexx/helpers/parameters.rb
 - lib/hexx/helpers/validations.rb
 - lib/hexx/message.rb
+- lib/hexx/name.rb
 - lib/hexx/null.rb
 - lib/hexx/service.rb
 - lib/hexx/service/with_callbacks.rb
@@ -175,6 +176,7 @@ files:
 - spec/hexx/helpers/parameters_spec.rb
 - spec/hexx/helpers/validations_spec.rb
 - spec/hexx/message_spec.rb
+- spec/hexx/name_spec.rb
 - spec/hexx/null_spec.rb
 - spec/hexx/service_invalid_spec.rb
 - spec/hexx/service_spec.rb
@@ -221,6 +223,7 @@ test_files:
 - spec/hexx/service_invalid_spec.rb
 - spec/hexx/coercible_spec.rb
 - spec/hexx/dependable_spec.rb
+- spec/hexx/name_spec.rb
 - spec/hexx/configurable_spec.rb
 - spec/support/matchers/methods.rb
 - spec/support/initializers/garbage_collection.rb