hydramata-core 0.1.0

data/spec/README.md

@@ -0,0 +1,10 @@
+Congratulations, you are reading the README of the specs.
+
+Why is this here? Because specs are an important subject.
+
+One of my development foci for Hydramata::Core has been a focus on keeping the test suite's runtime healthy. Yes, each spec that I write adds time to the test suite, but I want that to be a linear growth.
+
+In this directory you will find several files with filename pattern `spec_*_helper.rb`.
+As I've worked through specs, my goal has been to use the fastest spec helper
+possible.
+This typically means striving to use the `spec_fast_helper.rb`, but acknowledging that may not be feasible.

data/spec/features/translation_services_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_fast_helper'
+require 'i18n'
+require 'hydramata/core/translator'
+
+module Hydramata
+  module Core
+    describe 'Translation services' do
+
+      it 'allows overriding the :base_scope and nested lookup of scopes' do
+        result = Translator.translate('my_message_key', base_scope: ['other'], scopes: ['nested'], name: 'Jeremy')
+        expect(result).to eq('Thanks but no thanks Jeremy!')
+      end
+
+      it 'has a default :base_scope' do
+        result = Translator.translate('my_message_key', name: 'Jeremy')
+        expect(result).to eq('Thanks Jeremy!')
+      end
+
+      around do |example|
+        begin
+          # @TODO - The structure of the hash is not ideal. The order of keys is
+          # somewhat counter-intuitive.
+          old_backend = I18n.backend
+          I18n.backend = old_backend.clone
+          core = Psych.load_file(File.expand_path('../../fixtures/core.translations.yml', __FILE__))
+          I18n.backend.store_translations(:en, core.fetch('en'))
+          example.run
+        ensure
+          I18n.backend = old_backend
+        end
+      end
+
+    end
+  end
+end

data/spec/fixtures/core.translations.yml

@@ -0,0 +1,8 @@
+en:
+  other:
+    my_message_key: 'No thank you %{name}!'
+    nested:
+      my_message_key: 'Thanks but no thanks %{name}!'
+  hydramata:
+    core:
+      my_message_key: 'Thanks %{name}!'

data/spec/lib/hydramata-translations_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_fast_helper'
+require 'hydramata-core'
+
+module Hydramata
+  describe Core do
+  end
+end

data/spec/lib/hydramata/configuration_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_fast_helper'
+require 'active_support/lazy_load_hooks'
+
+module Hydramata
+  class Configuration
+  end
+
+  module MockConfiguration
+  end
+
+  describe 'Configuration' do
+    it 'allows loading of additional modules' do
+      expect do
+        ActiveSupport.on_load(:hydramata_configuration) do
+          include MockConfiguration
+        end
+        require 'hydramata/configuration'
+      end.to change { Configuration.included_modules.include?(MockConfiguration) }.from(false).to(true)
+    end
+
+    context '#translator' do
+      subject { Configuration.new }
+      it 'defaults to something that will translate' do
+        expect(subject.translator).to respond_to(:translate)
+      end
+      it 'can be overridden by something that will translate' do
+        new_translator = double(translate: true)
+        expect { subject.translator = new_translator }.
+          to change { subject.translator }.
+          to(new_translator)
+      end
+      it 'requires a translator to have the proper methods' do
+        new_translator = double
+        expect { subject.translator = new_translator }.to raise_error
+      end
+    end
+  end
+end

data/spec/lib/hydramata/core/named_callbacks_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_fast_helper'
+require 'hydramata/core/named_callbacks'
+
+module Hydramata
+  module Core
+    describe NamedCallbacks do
+      Given(:named_callback) { described_class.new }
+      Given(:context) { [ ] }
+      Given { named_callback.my_named_callback { |*a| context.replace(a) } }
+
+      describe "with a named callback" do
+        Given(:callback_name) { :my_named_callback }
+        When { named_callback.call(callback_name, 'a',:hello) }
+        Then { context == ['a', :hello] }
+      end
+
+      describe "with a named callback called by a string" do
+        Given(:callback_name) { 'my_named_callback' }
+        When { named_callback.call(callback_name, 'a',:hello) }
+        Then { context == ['a', :hello] }
+      end
+
+      describe "with a undeclared callback" do
+        When(:result) { named_callback.call(:undeclared_callback, 1, 2, 3) }
+        Then { result }
+        Then { context == [] }
+      end
+    end
+  end
+end

data/spec/lib/hydramata/core/runner_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_fast_helper'
+require 'hydramata/core/runner'
+
+module Hydramata
+  module Core
+
+    describe Runner do
+      Given(:context) { double(invoked: true, services: services) }
+      Given(:services) { double('Services') }
+      Given(:runner) {
+        described_class.new(context) do |on|
+          on.success { |a, b| context.invoked("SUCCESS", a, b) }
+          on.failure { |a, b| context.invoked("FAILURE", a, b) }
+          on.other   { |a, b| context.invoked("OTHER", a, b) }
+        end
+      }
+
+      Invariant { runner.context == context }
+
+      context '#services' do
+        it 'delegates to the context' do
+          expect(runner.services).to eq(services)
+        end
+      end
+      context "#run" do
+        it 'is an abstract method' do
+          expect { runner.run }.to raise_error(NotImplementedError)
+        end
+      end
+
+      context "calling other" do
+        When(:result) { runner.callback(:other, :first, :second) }
+        Then { expect(context).to have_received(:invoked).with("OTHER", :first, :second) }
+        Then { result == [:first, :second] }
+      end
+
+      context "calling unknown" do
+        When(:result) { runner.callback(:unknown, :first, :second) }
+        Then { expect(context).to_not have_received(:invoked) }
+        Then { result == [:first, :second] }
+      end
+
+    end
+  end
+end

data/spec/lib/hydramata/core/translator_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_fast_helper'
+require 'hydramata/core/translator'
+
+module Hydramata
+  module Core
+    describe Translator do
+      subject do
+        described_class.new(
+          base_scope: base_scope,
+          translation_service: translation_service,
+          translation_service_error: translation_service_error
+        )
+      end
+      let(:base_scope) { ['hydramata', 'core'] }
+      let(:scopes) { [['grandparent', 'parent'], ['grandparent']] }
+      let(:translation_service) { double('TranslationService', translate: true) }
+      let(:translation_service_error) { ArgumentError }
+
+      context '#translate' do
+        it 'passes options to the default rendering' do
+          expect(translation_service).to receive(:translate).
+            with('child', scope: base_scope, default: 'default').
+            ordered.
+            and_return('With Default')
+
+          expect(subject.translate('child', default: 'default')).to eq('With Default')
+        end
+
+        it 'swallows defaults except on the final rendering' do
+          scopes = [['parent']]
+          expect(translation_service).to receive(:translate).
+            with('child', scope: (base_scope + scopes[0]), raise: true, other_key: 'other').
+            ordered.
+            and_raise(translation_service_error)
+          expect(translation_service).to receive(:translate).
+            with('child', scope: base_scope, other_key: 'other', default: 'Shine On').
+            ordered.
+            and_return('My Work Type')
+          expect(subject.translate('child', scopes: scopes, other_key: 'other', default: 'Shine On'))
+        end
+
+        it 'attempts to translate through each scope then finally via the base scope' do
+          expect(translation_service).to receive(:translate).
+            with('child', scope: (base_scope + scopes[0]), raise: true, other_key: 'other').
+            ordered.
+            and_raise(translation_service_error)
+          expect(translation_service).to receive(:translate).
+            with('child', scope: (base_scope + scopes[1]), raise: true, other_key: 'other').
+            ordered.
+            and_raise(translation_service_error)
+          expect(translation_service).to receive(:translate).
+            with('child', scope: base_scope, other_key: 'other').
+            ordered.
+            and_return('My Work Type')
+
+          expect(subject.translate('child', scopes: scopes, other_key: 'other')).to eq('My Work Type')
+        end
+
+        it 'translates through each scope until it finds a match then returns without processing more generic case' do
+          expect(translation_service).to receive(:translate).
+            with('child', scope: (base_scope + scopes[0]), raise: true).
+            ordered.
+            and_raise(translation_service_error)
+          expect(translation_service).to receive(:translate).
+            with('child', scope: (base_scope + scopes[1]), raise: true).
+            ordered.
+            and_return('Found Grandparent')
+          expect(translation_service).to_not receive(:translate).
+            with('child', scope: base_scope)
+
+          expect(subject.translate('child', scopes: scopes)).to eq('Found Grandparent')
+        end
+
+        it 'translates through each scope until it finds a match then returns without processing more generic case' do
+          expect(translation_service).to receive(:translate).
+            with('child', scope: (base_scope + scopes[0]), raise: true).
+            ordered.
+            and_raise(translation_service_error)
+          expect(translation_service).to receive(:translate).
+            with('child', scope: (base_scope + scopes[1]), raise: true).
+            ordered.
+            and_raise(translation_service_error)
+          expect(translation_service).to_not receive(:translate).
+            with('child', scope: base_scope).
+            ordered.
+            and_raise(translation_service_error)
+
+          expect { subject.translate('child', scopes: scopes) }.to raise_error
+        end
+      end
+
+    end
+  end
+end

data/spec/lib/hydramata/services_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_fast_helper'
+require 'active_support/lazy_load_hooks'
+module Hydramata
+  class Services
+  end
+
+  module MockServices
+  end
+
+  describe 'Services' do
+    it 'allows loading of additional modules' do
+      expect do
+        ActiveSupport.on_load(:hydramata_services) do
+          include MockServices
+        end
+        require 'hydramata/services'
+      end.to change { Services.included_modules.include?(MockServices) }.from(false).to(true)
+    end
+
+    context '#translator' do
+      Given(:context) { double('Context') }
+      Given(:service) { Services.new(context) }
+      Then { service.context == context }
+    end
+
+  end
+end

data/spec/spec_fast_helper.rb

@@ -0,0 +1,33 @@
+# This helper provides at least a ~x3 speed increase over the 'spec_slow_helper'.
+#
+# The idea being that some tests have very few dependencies.
+#
+# Example:
+# $ time rspec -r spec/spec_fast_helper.rb spec/lib/hydramata-work_spec.rb
+#
+#     real  0m1.188s
+#     user  0m0.979s
+#     sys   0m0.204s
+#
+# Compared to `rspec -r spec/spec_slow_helper.rb ./path/to/spec.rb`
+#
+# Example:
+# $ time rspec -r spec/spec_slow_helper.rb spec/lib/hydramata-work_spec.rb
+#
+#     real  0m3.491s
+#     user  0m2.800s
+#     sys   0m0.667s
+
+require 'rspec-given'
+unless defined?(Rails) # If we are in a Rails context this is overkill.
+  Dir[File.expand_path('../../app/*', __FILE__)].each do |dir|
+    $LOAD_PATH << dir
+  end
+  $LOAD_PATH << File.expand_path('../../lib', __FILE__)
+
+  unless defined?(require_dependency)
+    def require_dependency(*files)
+      require *files
+    end
+  end
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: hydramata-core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Friesen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubydora
+  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: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: ''
+email:
+- jeremy.n.friesen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/rails
+- fs
+- gemfiles/rails4.1.gemfile
+- gemfiles/rails4.gemfile
+- hydramata-core.gemspec
+- lib/hydramata-core.rb
+- lib/hydramata/configuration.rb
+- lib/hydramata/core.rb
+- lib/hydramata/core/named_callbacks.rb
+- lib/hydramata/core/railtie.rb
+- lib/hydramata/core/runner.rb
+- lib/hydramata/core/translator.rb
+- lib/hydramata/core/version.rb
+- lib/hydramata/exceptions.rb
+- lib/hydramata/services.rb
+- lib/hydramata_core.rb
+- lib/tasks/hydramata_mecha_tasks.rake
+- run_each_spec_in_isolation
+- script/analyzer.rb
+- script/fast_specs
+- spec/README.md
+- spec/features/translation_services_spec.rb
+- spec/fixtures/core.translations.yml
+- spec/lib/hydramata-translations_spec.rb
+- spec/lib/hydramata/configuration_spec.rb
+- spec/lib/hydramata/core/named_callbacks_spec.rb
+- spec/lib/hydramata/core/runner_spec.rb
+- spec/lib/hydramata/core/translator_spec.rb
+- spec/lib/hydramata/services_spec.rb
+- spec/spec_fast_helper.rb
+homepage: https://github.com/ndlib/hydramata-core
+licenses:
+- APACHE2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.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: ''
+test_files:
+- spec/README.md
+- spec/features/translation_services_spec.rb
+- spec/fixtures/core.translations.yml
+- spec/lib/hydramata-translations_spec.rb
+- spec/lib/hydramata/configuration_spec.rb
+- spec/lib/hydramata/core/named_callbacks_spec.rb
+- spec/lib/hydramata/core/runner_spec.rb
+- spec/lib/hydramata/core/translator_spec.rb
+- spec/lib/hydramata/services_spec.rb
+- spec/spec_fast_helper.rb