active_interaction 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58a3ed3559d4e08664cc19fb81100a947bb597e8
-  data.tar.gz: d7d1152399851b34028504b90b05a5cfda76e14f
+  metadata.gz: 1c363a94aaacce981bd5b48b6681e193a01f7449
+  data.tar.gz: 81bdc016e4c55ead1dc8d632fd361c1752ce4b9d
 SHA512:
-  metadata.gz: 96954a543eb586113be298cef976bbbdc5bb1eeed62de460d5b42ac3ad3c2c56896483729ad1c4a012ef08757b1e92a47848b9b7db7c903ebea3f3455967cfba
-  data.tar.gz: 046393507e5bb5acfea4db4bd0b1e95222d8dfafd156bb5289668c0139153ce1c9e9a643d1b3fc7c41d5bcdd444df5abc47c300301a9721a8757471eea2976e7
+  metadata.gz: 44c0c3dd501b88f1c23301a1b7baccbe3518a3b9f494c6c46ecf756d13e3825ca0886db66bde70bcc8db43c18df3ed9f3dbc129e0a53cb5044328bbc55be68e8
+  data.tar.gz: d9199c57073feb9afd9f22d84a026eb6bdb66f0713c8e9a0f43a0b5f96ee3b07ab02dd433789c61dbabfeb18d13395911ce3ab7479fdb911c512752aa250183e

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # [Master][]
 
+# [0.4.0][]
+
+- Support i18n translations.
+
 # [0.3.0][] (2013-08-07)
 
 - Give better error messages for nested attributes.
@@ -39,7 +43,8 @@
 
 - Initial release.
 
-  [master]: https://github.com/orgsync/active_interaction/compare/v0.3.0...master
+  [master]: https://github.com/orgsync/active_interaction/compare/v0.4.0...master
+  [0.4.0]: https://github.com/orgsync/active_interaction/compare/v0.3.0...v0.4.0
   [0.3.0]: https://github.com/orgsync/active_interaction/compare/v0.2.2...v0.3.0
   [0.2.2]: https://github.com/orgsync/active_interaction/compare/v0.2.1...v0.2.2
   [0.2.1]: https://github.com/orgsync/active_interaction/compare/v0.2.0...v0.2.1

data/README.md

@@ -22,7 +22,7 @@ This project uses [semantic versioning][].
 Add it to your Gemfile:
 
 ```ruby
-gem 'active_interaction', '~> 0.3.0'
+gem 'active_interaction', '~> 0.4.0'
 ```
 
 And then execute:
@@ -197,6 +197,49 @@ end
 
 Check out the [documentation][] for a full list of methods.
 
+## How do I translate an interaction?
+
+ActiveInteraction is i18n-aware out of the box! All you have to do
+is add translations to your project. In Rails, they typically go
+into `config/locales`. So, for example, let's say that (for whatever
+reason) you want to print out everything backwards. Simply add
+translations for ActiveInteraction to your `hsilgne` locale:
+
+```yaml
+# config/locales/hsilgne.yml
+hsilgne:
+  active_interaction:
+    types:
+      array: yarra
+      boolean: naeloob
+      date: etad
+      date_time: emit etad
+      file: elif
+      float: taolf
+      hash: hsah
+      integer: regetni
+      model: ledom
+      string: gnirts
+      time: emit
+    errors:
+      messages:
+        invalid: dilavni si
+        invalid_nested: '%{type} dilav a ton si'
+        missing: deriuqer si
+```
+
+Then set your locale and run an interaction like normal:
+
+```ruby
+I18n.locale = :hsilgne
+class Interaction < ActiveInteraction::Base
+  boolean :a
+  def execute; end
+end
+p Interaction.run.errors.messages
+# => {:a=>["deriuqer si"]}
+```
+
 ## Credits
 
 This project was inspired by the fantastic work done in [Mutations][].

data/lib/active_interaction.rb

@@ -20,5 +20,9 @@ require 'active_interaction/filters/string_filter'
 require 'active_interaction/filters/time_filter'
 require 'active_interaction/base'
 
+I18n.backend.load_translations(
+  Dir.glob(File.join(%w(lib active_interaction locale *.yml)))
+)
+
 # @since 0.1.0
 module ActiveInteraction end

data/lib/active_interaction/base.rb

@@ -44,6 +44,14 @@ module ActiveInteraction
       false
     end
 
+    def self.i18n_scope
+      :active_interaction
+    end
+
+    def i18n_scope
+      self.class.i18n_scope
+    end
+
     extend OverloadHash
 
     # Returns the output from {#execute} if there are no validation errors or
@@ -191,12 +199,12 @@ module ActiveInteraction
         begin
           filter.prepare(attribute, send(attribute), options, &block)
         rescue InvalidNestedValue
-          errors.add(attribute, 'is invalid')
+          errors.add(attribute, :invalid_nested)
         rescue InvalidValue
-          errors.add(attribute,
-                     "is not a valid #{type.to_s.humanize.downcase}")
+          errors.add(attribute, :invalid,
+                     type: I18n.translate("#{i18n_scope}.types.#{type.to_s}"))
         rescue MissingValue
-          errors.add(attribute, 'is required')
+          errors.add(attribute, :missing)
         end
       end
       private validator

data/lib/active_interaction/version.rb

@@ -1,3 +1,3 @@
 module ActiveInteraction
-  VERSION = Gem::Version.new('0.3.0')
+  VERSION = Gem::Version.new('0.4.0')
 end

data/spec/active_interaction/base_spec.rb

@@ -234,4 +234,16 @@ describe ActiveInteraction::Base do
       expect(interaction).to_not be_persisted
     end
   end
+
+  describe '.i18n_scope' do
+    it 'returns the scope' do
+      expect(described_class.i18n_scope).to eq :active_interaction
+    end
+  end
+
+  describe '#i18n_scope' do
+    it 'returns the scope' do
+      expect(interaction.i18n_scope).to eq :active_interaction
+    end
+  end
 end

data/spec/active_interaction/i18n_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+class I18nInteraction < ActiveInteraction::Base
+  hash :a do
+    hash :x
+  end
+
+  def execute; end
+end
+
+describe I18nInteraction do
+  include_context 'interactions'
+
+  TYPES = %w(
+    array
+    boolean
+    date
+    date_time
+    file
+    float
+    hash
+    integer
+    model
+    string
+    time
+  )
+
+  shared_examples 'translation' do
+    context 'types' do
+      TYPES.each do |type|
+        it "has a translation for #{type}" do
+          key = "#{described_class.i18n_scope}.types.#{type}"
+          expect { I18n.translate(key, raise: true) }.to_not raise_error
+        end
+      end
+    end
+
+    context 'error messages' do
+      let(:translation) { I18n.translate(key, type: type, raise: true) }
+      let(:type) { I18n.translate("#{described_class.i18n_scope}.types.hash") }
+
+      context ':invalid' do
+        let(:key) { "#{described_class.i18n_scope}.errors.messages.invalid" }
+
+        it 'has a translation' do
+          expect { translation }.to_not raise_error
+        end
+
+        it 'returns the translation' do
+          options.merge!(a: Object.new)
+          expect(outcome.errors[:a]).to eq [translation]
+        end
+      end
+
+      context ':invalid_nested' do
+        let(:key) {
+          "#{described_class.i18n_scope}.errors.messages.invalid_nested"
+        }
+
+        it 'has a translation' do
+          expect { translation }.to_not raise_error
+        end
+
+        it 'returns the translation' do
+          options.merge!(a: { x: Object.new })
+          expect(outcome.errors[:a]).to eq [translation]
+        end
+      end
+
+      context ':missing' do
+        let(:key) { "#{described_class.i18n_scope}.errors.messages.missing" }
+
+        it 'has a translation' do
+          expect { translation }.to_not raise_error
+        end
+
+        it 'returns the translation' do
+          expect(outcome.errors[:a]).to eq [translation]
+        end
+      end
+    end
+  end
+
+  context 'english' do
+    include_examples 'translation'
+
+    before do
+      I18n.locale = :en
+    end
+  end
+
+  context 'english'.reverse do
+    include_examples 'translation'
+
+    before do
+      I18n.locale = 'english'.reverse
+
+      I18n.backend.store_translations(I18n.locale, active_interaction: {
+        errors: { messages: {
+          invalid: "%{type} #{'invalid'.reverse}",
+          invalid_nested: 'invalid_nested'.reverse,
+          missing: 'missing'.reverse
+        } },
+        types: TYPES.reduce({}) { |a, e| a[e] = e.reverse; a }
+      })
+    end
+  end
+end

data/spec/support/interactions.rb

@@ -17,6 +17,10 @@ shared_examples_for 'an interaction' do |type, generator, filter_options = {}|
       send(type, :defaults_1, :defaults_2,
            filter_options.merge(default: generator.call))
 
+      def self.name
+        SecureRandom.hex
+      end
+
       def execute
         {
           required: required,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_interaction
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Aaron Lasseigne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-07 00:00:00.000000000 Z
+date: 2013-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -180,6 +180,7 @@ files:
 - spec/active_interaction/filters/model_filter_spec.rb
 - spec/active_interaction/filters/string_filter_spec.rb
 - spec/active_interaction/filters/time_filter_spec.rb
+- spec/active_interaction/i18n_spec.rb
 - spec/active_interaction/integration/array_interaction_spec.rb
 - spec/active_interaction/integration/boolean_interaction_spec.rb
 - spec/active_interaction/integration/date_interaction_spec.rb
@@ -238,6 +239,7 @@ test_files:
 - spec/active_interaction/filters/model_filter_spec.rb
 - spec/active_interaction/filters/string_filter_spec.rb
 - spec/active_interaction/filters/time_filter_spec.rb
+- spec/active_interaction/i18n_spec.rb
 - spec/active_interaction/integration/array_interaction_spec.rb
 - spec/active_interaction/integration/boolean_interaction_spec.rb
 - spec/active_interaction/integration/date_interaction_spec.rb