repository-support 0.1.1

data/spec/repository/support/result_builder_spec.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Repository::Support::ResultBuilder do
+  describe 'initialisation' do
+    it 'requires one parameter' do
+      message = /wrong number of arguments \(.+?\)/
+      expect { described_class.new }.to raise_error ArgumentError, message
+    end
+
+    it 'can be initialised with anything' do
+      init_values = ['something', nil, 42.7, self]
+      init_values.each do |value|
+        expect { described_class.new value }.not_to raise_error
+      end
+    end
+  end # describe 'initialisation'
+
+  describe 'has a #build method that' do
+    let(:obj) { described_class.new record }
+
+    context 'when the initialiser parameter is truthy' do
+      let(:record) { true }
+      let(:result) { obj.build }
+
+      describe 'returns a StoreResult instance which' do
+        it 'is successful' do
+          expect(result).to be_success
+        end
+
+        it 'returns the initialiser parameter as its :entity attribute' do
+          expect(result.entity).to eq record
+        end
+
+        it 'returns an empty Array as its :errors attribute' do
+          errors = result.errors
+          expect(errors).to respond_to :to_ary
+          expect(errors).to be_empty
+        end
+      end # describe 'returns a StoreResult instance which'
+    end # context 'when the initialiser parameter is truthy'
+
+    context 'when the initialiser parameter is falsy' do
+      let(:record) { false }
+
+      it 'requires a block' do
+        # message = 'no block given (yield)'
+        expect { obj.build }.to raise_error LocalJumpError # , message
+      end
+
+      describe 'returns a StoreResult instance which' do
+        let(:errors_value) { 'RETURNED FROM BLOCK' }
+        let(:result) { obj.build { |_r| errors_value } }
+
+        it 'is not successful' do
+          expect(result).not_to be_success
+        end
+
+        it 'returns an :entity attribute value of nil' do
+          expect(result.entity).to be nil
+        end
+
+        it 'returns the return value of the block as the :errors attribute' do
+          expect(result.errors).to be errors_value
+        end
+      end # describe 'returns a StoreResult instance which'
+    end # context 'when the initialiser parameter is falsy'
+  end # describe 'has a #build method that'
+end # describe Repository::Support::ResultBuilder

data/spec/repository/support/store_result_spec.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Repository::Support::StoreResult do
+  describe 'initialisation' do
+    it 'requires three keyword-named parameters' do
+      # message = 'missing keywords: entity, success, errors'
+      expect { described_class.new }.to raise_error ArgumentError # , message
+    end
+
+    it 'succeeds with specified values that can then be read back correctly' do
+      entity = 'ENTITY'
+      success = 'SUCCESS'
+      errors = 'ERRORS'
+      obj = described_class.new entity: entity, success: success, errors: errors
+      expect(obj.entity).to eq entity
+      expect(obj.success).to eq success
+      expect(obj.errors).to eq errors
+    end
+  end # describe 'initialisation'
+
+  describe 'has a #success? method that' do
+    it 'returns the same object as the #success accessor method' do
+      obj = described_class.new entity: nil, success: 'SUCCESS', errors: nil
+      # Note the difference between 'to be' and 'to eq'.
+      expect(obj.success?).to be obj.success
+    end
+  end # describe 'has a #success? method that'
+end # describe Repository::Support::StoreResult
+
+describe Repository::Support::StoreResult::Success do
+  let(:entity) { Object.new }
+  let(:obj) { described_class.new entity }
+
+  describe 'returns' do
+    it 'true from its #success accessor method' do
+      expect(obj.success).to be true
+      expect(obj).to be_success
+    end
+
+    it 'the specified entity from its #entity accessor method' do
+      expect(obj.entity).to be entity
+    end
+
+    it 'an empty array from its #errors accessor method' do
+      expect(obj.errors).to eq []
+    end
+  end # describe 'returns'
+end # describe Repository::Support::StoreResult::Success
+
+describe Repository::Support::StoreResult::Failure do
+  let(:errors) { 'ERRORS' }
+  let(:obj) { described_class.new errors }
+
+  describe 'returns' do
+    it 'false from its #success accessor method' do
+      expect(obj.success).not_to be true
+      expect(obj).not_to be_success
+    end
+
+    it 'nil from its #entity accessor method' do
+      expect(obj.entity).to be nil
+    end
+
+    it 'the passed-in :errors parameter from its #errors accessor method' do
+      expect(obj.errors).to be errors
+    end
+  end # describe 'returns'
+end # describe Repository::Support::StoreResult::Failure

data/spec/repository/support/test_attribute_container_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+# Test-dummy class to exercise `TestAttributeContainer`.
+class TestClass
+  extend Repository::Support::TestAttributeContainer
+
+  init_empty_attribute_container
+end
+
+describe Repository::Support::TestAttributeContainer do
+  let(:obj) { TestClass.new }
+
+  it 'has reader and writer methods for :attributes' do
+    expect(obj).to respond_to :attributes
+    expect(obj).to respond_to :attributes=
+  end
+
+  it 'supports mass initialisation of attributes' do
+    obj.attributes = { thing: true, the_answer: 42 }
+    expect(obj.thing).to be true
+    expect(obj.the_answer).to be 42
+  end
+
+  description = 'has new named-attribute accessors added when the name is' \
+    ' added to :attributes'
+  it description do
+    expect { obj.thing }.to raise_error NoMethodError
+    expect { obj.thing = false }.to raise_error NoMethodError
+    obj.attributes[:thing] = 'something'
+    expect { obj.thing }.not_to raise_error
+    expect { obj.thing = 'something else' }.not_to raise_error
+    expect(obj.thing).to eq 'something else'
+  end
+end # describe TestClass

data/spec/repository/support_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Repository::Support do
+  it 'has a version number' do
+    expect(Repository::Support::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.start 'rails' do
+  add_filter '/gemset/'
+end
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'awesome_print'
+# require 'pry'
+
+require 'repository/support'

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: repository-support
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jeff Dickey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.10
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: Support classes for Repository::Base and subclasses.
+email:
+- jdickey@seven-sigma.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rbenv-gemsets"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/bundle
+- bin/bundler
+- bin/htmldiff
+- bin/ldiff
+- bin/rake
+- bin/rspec
+- bin/rubocop
+- bin/ruby-parse
+- bin/ruby-rewrite
+- bin/setup
+- lib/repository/support.rb
+- lib/repository/support/error_factory.rb
+- lib/repository/support/result_builder.rb
+- lib/repository/support/store_result.rb
+- lib/repository/support/test_attribute_container.rb
+- lib/repository/support/version.rb
+- repository-support.gemspec
+- spec/repository/support/error_factory_spec.rb
+- spec/repository/support/result_builder_spec.rb
+- spec/repository/support/store_result_spec.rb
+- spec/repository/support/test_attribute_container_spec.rb
+- spec/repository/support_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jdickey/repository-support
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Support classes for Repository::Base and subclasses.
+test_files:
+- spec/repository/support/error_factory_spec.rb
+- spec/repository/support/result_builder_spec.rb
+- spec/repository/support/store_result_spec.rb
+- spec/repository/support/test_attribute_container_spec.rb
+- spec/repository/support_spec.rb
+- spec/spec_helper.rb