tzu 0.0.1.0 → 0.0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b809317c8b5ff13fcb4784360d28703691ea3d9d
-  data.tar.gz: 141562074c39e1d23fc945f2d6d7bf825eb37c6c
+  metadata.gz: e476045f4ece3c811b3fdaedad37f1a035f12e13
+  data.tar.gz: b699bc51b73743dcaa26a42394fe8a086018dd7b
 SHA512:
-  metadata.gz: 1b231785af2e5ca4fab9e1a8590676875f87796592050391f9e32a2358e70878e31cc85c42b5c383c2fb484ab00afc7abb549c15a56a5f0b29fa0dccd3f96878
-  data.tar.gz: bff733337e18acb528bd37978f3034f67e788225b23b487c878f60d00bca8c0ef95b07c362ec5166024b633b102f968d1c0418451b7ab13a4accee6911d4ff93
+  metadata.gz: 2838ccd7ae2ed0cab8e6827ddeaa765520a55a49f42865f7739d96142e232dfbe96e4ea0d6ca20996f3a39fc6258124d90e39fde3adc0cdde769b341d2e0efdf
+  data.tar.gz: 337506517ab4d5e0dc25b6a1e7a6fab72aeb71dc47129d8adfbd304a7e579bb4416680440fe7b6109624ea0735ce3ce8381d80461773230bf49dc4d97426c18d

data/lib/tzu/failure.rb

@@ -1,10 +1,24 @@
 module Tzu
   class Failure < StandardError
-    attr_reader :errors, :type
+    attr_reader :type
 
     def initialize(type = nil, errors = nil)
-      @errors, @type = errors, type
+      @type = type
+      @raw_errors = errors
     end
 
+    def errors
+      string_error? ? { errors: @raw_errors } : @raw_errors
+    end
+
+    def message
+      string_error? ? @raw_errors : @raw_errors.to_s
+    end
+
+    private
+
+    def string_error?
+      @raw_errors.is_a?(String)
+    end
   end
 end

data/lib/tzu/validation.rb

@@ -32,7 +32,7 @@ module Tzu
     end
 
     def invalid!(obj)
-      output = [:errors, :messages].reduce(obj) do |result, m|
+      output = [:errors, :messages, :message].reduce(obj) do |result, m|
         result = result.respond_to?(m) ? result.send(m) : result
       end
 

data/spec/tzu_spec.rb

@@ -1,354 +1,39 @@
-# require 'spec_helper'
-#
-# if !defined?(ActiveRecord::Base)
-#   puts "** require 'active_record' to run the specs in #{__FILE__}"
-# else
-#   ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
-#
-#   ActiveRecord::Migration.suppress_messages do
-#     ActiveRecord::Schema.define(:version => 0) do
-#       create_table(:employers, force: true) {|t| t.string :name }
-#       create_table(:users, force: true) {|t| t.string :first_name; t.string :last_name; t.references :employer; }
-#       create_table(:sports_cars, force: true) {|t| t.string :make; t.references :employer; }
-#     end
-#   end
-#
-#   module GetSpec
-#     class Employer < ActiveRecord::Base
-#       has_many :users
-#       has_many :sports_cars
-#     end
-#
-#     class User < ActiveRecord::Base
-#       belongs_to :employer
-#     end
-#
-#     class SportsCar < ActiveRecord::Base
-#       belongs_to :employer
-#     end
-#   end
-# end
-#
-# describe Get do
-#   let(:last_name) { 'Turner' }
-#   let(:adapter) { :active_record }
-#
-#   # Preserve system config for other tests
-#   before(:all) { @system_config = Get.configuration }
-#   after(:all) { Get.configuration = @system_config }
-#
-#   # Reset base config with each iteration
-#   before { Get.configure { |config| config.set_adapter(adapter) } }
-#   after do
-#     GetSpec::User.delete_all
-#     GetSpec::Employer.delete_all
-#     Get.reset
-#   end
-#
-#   class MyCustomEntity < Horza::Entities::Collection
-#     def east_london_length
-#       "#{length}, bruv"
-#     end
-#   end
-#
-#   describe '#configure' do
-#     context '#register_entity' do
-#       let(:user_count) { 3 }
-#
-#       before do
-#         Get.configure { |config| config.register_entity(:users_by_last_name, MyCustomEntity) }
-#         user_count.times { GetSpec::User.create(last_name: last_name) }
-#       end
-#       after { Get.reset }
-#
-#       it 'gets registers entity' do
-#         expect(Get.configuration.entity_for(:users_by_last_name)).to eq MyCustomEntity
-#       end
-#
-#       it 'returns specified entity type after querying db' do
-#         result = Get::UsersByLastName.run(last_name)
-#         expect(result.is_a? MyCustomEntity).to be true
-#         expect(result.east_london_length).to eq "#{user_count}, bruv"
-#       end
-#     end
-#   end
-#
-#   context '#entity_for' do
-#     context 'when entity has been registered' do
-#       before do
-#         Get.configure do |config|
-#           config.set_adapter(adapter)
-#           config.register_entity(:users_by_last_name, MyCustomEntity)
-#         end
-#       end
-#       after { Get.reset }
-#
-#       it 'registers entity' do
-#         expect(Get.entity_for(:users_by_last_name)).to eq MyCustomEntity
-#       end
-#     end
-#
-#     context 'when entity has not been registered' do
-#       it 'returns nil' do
-#         expect(Get.entity_for(:users_by_last_name)).to be nil
-#       end
-#     end
-#   end
-#
-#   context '#adapter' do
-#     context 'when the adapter is set' do
-#       it 'returns the correct adapter class' do
-#         expect(Get.adapter).to eq Horza::Adapters::ActiveRecord
-#       end
-#     end
-#
-#     context 'when the adapter is not set' do
-#       before { Get.reset }
-#       after { Get.reset }
-#
-#       it 'throws error' do
-#         expect { Get.adapter }.to raise_error(Get::Errors::Base)
-#       end
-#     end
-#   end
-#
-#   context '#reset' do
-#     before do
-#       Get.configure do |config|
-#         config.set_adapter('my_adapter')
-#         config.register_entity(:users_by_last_name, MyCustomEntity)
-#       end
-#       Get.reset
-#     end
-#     it 'resets the config' do
-#       expect(Get.configuration.adapter).to be nil
-#       expect(Get.entity_for(:users_by_last_name)).to be nil
-#     end
-#   end
-#
-#   context '#run!' do
-#     context 'singular form' do
-#       context 'when the record exists' do
-#         let!(:user) { GetSpec::User.create(last_name: last_name) }
-#
-#         context 'field in class name' do
-#           it 'gets the records based on By[KEY]' do
-#             result = Get::UserById.run!(user.id)
-#             expect(result.to_h).to eq user.attributes
-#           end
-#
-#           it 'returns a dynamically generated response entity' do
-#             expect(Get::UserById.run!(user.id).is_a?(Horza::Entities::Single)).to be true
-#           end
-#         end
-#
-#         context 'field in parameters' do
-#           it 'gets the records based on parameters' do
-#             result = Get::UserBy.run!(last_name: last_name)
-#             expect(result.to_h).to eq user.attributes
-#           end
-#
-#           it 'returns a dynamically generated response entity' do
-#             expect(Get::UserBy.run!(last_name: last_name).is_a?(Horza::Entities::Single)).to be true
-#           end
-#         end
-#       end
-#
-#       context 'when the record does not exist' do
-#         it 'returns nil' do
-#           expect { Get::UserById.run!(999) }.to raise_error Get::Errors::Base
-#         end
-#       end
-#     end
-#
-#     context 'ancestry' do
-#       context 'valid ancestry with no saved parent' do
-#         let(:user2) { GetSpec::User.create }
-#         it 'returns nil' do
-#           expect { Get::EmployerFromUser.run!(user2) }.to raise_error Get::Errors::RecordNotFound
-#         end
-#       end
-#     end
-#   end
-#
-#   context '#run' do
-#     context 'singular form' do
-#       context 'when the record exists' do
-#         let!(:user) { GetSpec::User.create(last_name: last_name) }
-#
-#         context 'field in class name' do
-#           it 'gets the records based on By[KEY]' do
-#             result = Get::UserById.run(user.id)
-#             expect(result.to_h).to eq user.attributes
-#           end
-#
-#           it 'returns a dynamically generated response entity' do
-#             expect(Get::UserById.run(user.id).is_a?(Horza::Entities::Single)).to be true
-#           end
-#         end
-#
-#         context 'field in parameters' do
-#           it 'gets the records based on parameters' do
-#             result = Get::UserBy.run(last_name: last_name)
-#             expect(result.to_h).to eq user.attributes
-#           end
-#
-#           it 'returns a dynamically generated response entity' do
-#             expect(Get::UserBy.run(last_name: last_name).is_a?(Horza::Entities::Single)).to be true
-#           end
-#         end
-#       end
-#
-#       context 'when the record does not exist' do
-#         it 'returns nil' do
-#           expect(Get::UserById.run(999)).to eq nil
-#         end
-#       end
-#     end
-#
-#     context 'plural form' do
-#       let(:last_name) { 'Turner' }
-#       let(:match_count) { 3 }
-#       let(:miss_count) { 2 }
-#
-#       context 'when records exist' do
-#         before do
-#           match_count.times { GetSpec::User.create(last_name: last_name)  }
-#           miss_count.times { GetSpec::User.create }
-#         end
-#
-#         context 'field in class name' do
-#           it 'gets the records based on By[KEY]' do
-#             result = Get::UsersByLastName.run(last_name)
-#             expect(result.length).to eq match_count
-#           end
-#
-#           it 'returns a dynamically generated response entity' do
-#             expect(Get::UsersByLastName.run(last_name).is_a?(Horza::Entities::Collection)).to be true
-#           end
-#         end
-#
-#         context 'field in parameters' do
-#           it 'gets the records based on parameters' do
-#             result = Get::UsersBy.run(last_name: last_name)
-#             expect(result.length).to eq match_count
-#           end
-#
-#           it 'returns a dynamically generated response entity' do
-#             expect(Get::UsersBy.run(last_name: last_name).is_a?(Horza::Entities::Collection)).to be true
-#           end
-#         end
-#       end
-#
-#       context 'when no records exist' do
-#         it 'returns empty collection' do
-#           expect(Get::UsersBy.run(last_name: last_name).empty?).to be true
-#         end
-#       end
-#     end
-#
-#     context 'ancestry' do
-#       context 'direct relation' do
-#         let(:employer) { GetSpec::Employer.create }
-#         let!(:user1) { GetSpec::User.create(employer: employer) }
-#         let!(:user2) { GetSpec::User.create(employer: employer) }
-#
-#         context 'ParentFromChild' do
-#           it 'returns parent' do
-#             expect(Get::EmployerFromUser.run(user1).to_h).to eq employer.attributes
-#           end
-#         end
-#
-#         context 'ChildrenFromParent' do
-#           it 'returns children' do
-#             result = Get::UsersFromEmployer.run(employer)
-#             expect(result.first.to_h).to eq user1.attributes
-#             expect(result.last.to_h).to eq user2.attributes
-#           end
-#         end
-#
-#         context 'invalid ancestry' do
-#           it 'throws error' do
-#             expect { Get::UserFromEmployer.run(employer) }.to raise_error Get::Errors::InvalidAncestry
-#           end
-#         end
-#
-#         context 'valid ancestry with no saved childred' do
-#           let(:employer2) { GetSpec::Employer.create }
-#           it 'returns empty collection error' do
-#             expect(Get::UsersFromEmployer.run(employer2).empty?).to be true
-#           end
-#         end
-#
-#         context 'valid ancestry with no saved parent' do
-#           let(:user2) { GetSpec::User.create }
-#           it 'returns nil' do
-#             expect(Get::EmployerFromUser.run(user2)).to be nil
-#           end
-#         end
-#       end
-#
-#       context 'using via' do
-#         let(:employer) { GetSpec::Employer.create }
-#         let(:user) { GetSpec::User.create(employer: employer) }
-#         let(:sportscar) { GetSpec::SportsCar.create(employer: employer) }
-#
-#         before do
-#           employer.sports_cars << sportscar
-#         end
-#
-#         it 'returns the correct ancestor (single via symbol)' do
-#           result = Get::SportsCarsFromUser.run(user, via: :employer)
-#           expect(result.first.to_h).to eq sportscar.attributes
-#         end
-#
-#         it 'returns the correct ancestor (array of via symbols)' do
-#           result = Get::SportsCarsFromUser.run(user, via: [:employer])
-#           expect(result.first.to_h).to eq sportscar.attributes
-#         end
-#       end
-#     end
-#   end
-# end
-#
-# describe Get::Builders::AncestryBuilder do
-#   let(:name) { 'UserFromEmployer' }
-#
-#   before { Get.configure { |config| config.set_adapter(:active_record) } }
-#   after { Get.reset }
-#
-#   subject { Get::Builders::AncestryBuilder.new(name) }
-#
-#   describe '#class' do
-#     it 'builds a class that inherits from Get::Db' do
-#       expect(subject.class.superclass).to eq Get::Db
-#     end
-#
-#     it 'correctly assigns class-level variables' do
-#       [:entity, :query_key, :collection, :store, :result_key].each do |class_var|
-#         expect(subject.class.respond_to? class_var).to be true
-#       end
-#     end
-#   end
-# end
-#
-# describe Get::Builders::QueryBuilder do
-#   let(:name) { 'UserFromEmployer' }
-#
-#   before { Get.configure { |config| config.set_adapter(:active_record) } }
-#   after { Get.reset }
-#
-#   subject { Get::Builders::QueryBuilder.new(name) }
-#
-#   describe '#class' do
-#     it 'builds a class that inherits from Get::Db' do
-#       expect(subject.class.superclass).to eq Get::Db
-#     end
-#
-#     it 'correctly assigns class-level variables' do
-#       [:entity, :query_key, :collection, :store, :field].each do |class_var|
-#         expect(subject.class.respond_to? class_var).to be true
-#       end
-#     end
-#   end
-# end
+require 'spec_helper'
+
+describe Tzu do
+
+  context 'command fails' do
+    subject do
+      Class.new do
+        include Tzu
+
+        def call(params)
+          fail! :something
+        end
+      end
+    end
+
+    it 'returns failure' do
+      result = subject.run(nil)
+      expect(result).to have_attributes(success: false, type: :something)
+    end
+  end
+
+  context 'command succeeds' do
+    subject do
+      Class.new do
+        include Tzu
+
+        def call(params)
+          1234
+        end
+      end
+    end
+
+    it 'returns result' do
+      result = subject.run(nil)
+      expect(result).to have_attributes(success: true, result: 1234)
+    end
+  end
+
+end

data/spec/validation_spec.rb

@@ -41,4 +41,56 @@ describe Tzu::Validation do
       expect(result).to have_attributes(success: false, type: :validation)
     end
   end
-end
+
+  context 'error message is string' do
+    let(:str) { 'error_message' }
+    subject { Tzu::Invalid.new(str) }
+
+    context 'invoked directly' do
+      it 'has string as #message' do
+        expect(subject.message).to eq str
+      end
+
+      it '#errors converts sting to hash' do
+        expect(subject.errors).to eq(errors: str)
+      end
+    end
+
+    context 'rescued' do
+      subject do
+        Class.new do
+          include Tzu
+          include Tzu::Validation
+
+          def call(params)
+            raise StandardError.new(params)
+          rescue StandardError => e
+            invalid! e
+          end
+        end
+      end
+
+      describe '#run' do
+        it 'returns error hash as result' do
+          outcome = subject.run(str)
+          expect(outcome.result).to eq(errors: str)
+        end
+      end
+
+      describe '#run!' do
+        it 'has string as #message' do
+          expect { subject.run!(str) }.to raise_error Tzu::Invalid, str
+        end
+
+        it 'has string as #errors' do
+          begin
+            subject.run!(str)
+            expect(false).to be true # Should never reach this
+          rescue Tzu::Invalid => e
+            expect(e.errors).to eq(errors: str)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tzu
 version: !ruby/object:Gem::Version
-  version: 0.0.1.0
+  version: 0.0.2.0
 platform: ruby
 authors:
 - Morgan Bruce
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-28 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,7 +95,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Tzu is a library for issuing commands in Ruby
+description: Encapsulate your database queries with dynamically generated classes
 email: morgan@onfido.com
 executables: []
 extensions: []
@@ -112,7 +112,6 @@ files:
 - lib/tzu/outcome.rb
 - lib/tzu/validation.rb
 - lib/tzu/validation_result.rb
-- spec/command_spec.rb
 - spec/hooks_spec.rb
 - spec/organizer_spec.rb
 - spec/outcome_spec.rb
@@ -142,9 +141,9 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Standardise and encapsulate your application's actions
+summary: Get is a library designed to encapsulate Rails database queries and prevent
+  query pollution in the view layer.
 test_files:
-- spec/command_spec.rb
 - spec/hooks_spec.rb
 - spec/organizer_spec.rb
 - spec/outcome_spec.rb

data/spec/command_spec.rb

@@ -1,39 +0,0 @@
-require 'spec_helper'
-
-describe Tzu do
-
-  context 'command fails' do
-    subject do
-      Class.new do
-        include Tzu
-
-        def call(params)
-          fail! :something
-        end
-      end
-    end
-
-    it 'returns failure' do
-      result = subject.run(nil)
-      expect(result).to have_attributes(success: false, type: :something)
-    end
-  end
-
-  context 'command succeeds' do
-    subject do
-      Class.new do
-        include Tzu
-
-        def call(params)
-          1234
-        end
-      end
-    end
-
-    it 'returns result' do
-      result = subject.run(nil)
-      expect(result).to have_attributes(success: true, result: 1234)
-    end
-  end
-
-end