perimeter-activerecord 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7af5977060e52a58d7eecacbc8f0360330887840
+  data.tar.gz: 311283970195ae921755d753c49afafa3e8f3230
+SHA512:
+  metadata.gz: d1e7804603a2cb9e2dfca15100f38842c22df849776a21dcd29f13904643742ac13c47ae5e3d137af06f74fb4649e35cc1fd1a471e447e78cf298154720e713f
+  data.tar.gz: b48686441ee6c0d54e2a7583f1c2ff329b0b6dade726d2eb18bc41ab6c4eb31e5262b60b8eddeb97f461ee17a213864a48c1c7242037d9edaa09a185a9a6b6dc

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+*.DS_Store
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tags

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+# For local development:
+# gem 'perimeter', path: '../perimeter'

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'rspec --fail-fast' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bukowskis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,27 @@
+# Perimeter
+
+An ActiveRecord adapter for [Perimeter](https://github.com/bukowskis/perimeter).
+
+```ruby
+require 'perimeter/repository/adapters/active_record'
+
+# Repository
+module Books
+  include Perimeter::Repository::Adapters::ActiveRecord
+end
+```
+
+```ruby
+require 'perimeter/backend/adapters/active_record'
+
+# Backend
+module Books
+  class Backend < ActiveRecord::Base
+    include Perimeter::Backend::Adapters::ActiveRecord
+  end
+end
+```
+
+# License
+
+See `MIT-LICENSE` for details.

data/lib/perimeter/backend/adapters/active_record.rb

@@ -0,0 +1,35 @@
+require 'active_support/concern'
+
+module Perimeter
+  module Backend
+    module Adapters
+      module ActiveRecord
+        extend ActiveSupport::Concern
+
+        included do
+          begin
+            # ActiveRecord >= 3.2.1
+            self.table_name = perimeter_table_name
+          rescue NoMethodError => e
+            # ActiveRecord < 3.2.1
+            set_table_name perimeter_table_name
+          end
+        end
+
+        module ClassMethods
+
+          def perimeter_table_name(*args)
+            @perimeter_table_name = args.first unless args.empty?
+            @perimeter_table_name || default_perimeter_table_name
+          end
+
+          def default_perimeter_table_name
+            name.split('::')[-2].underscore
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/perimeter/repository/adapters/active_record.rb

@@ -0,0 +1,101 @@
+require 'operation'
+require 'perimeter/repository'
+require 'perimeter/repository/adapters/abstract'
+require 'active_support/concern'
+
+module Perimeter
+  module Repository
+    module Adapters
+      module ActiveRecord
+        extend ActiveSupport::Concern
+
+        include Perimeter::Repository
+        include Perimeter::Repository::Adapters::Abstract
+
+        module ClassMethods
+
+          def find(id)
+            record = backend.find id
+            entity = record_to_entity record
+            Operations.success :record_found, object: entity
+
+          rescue ::ActiveRecord::RecordNotFound => exception
+            Operations.failure :record_not_found, object: exception
+
+          rescue Exception => exception
+            ::Trouble.notify exception
+            Operations.failure :backend_error, object: exception
+          end
+
+          def create(attributes)
+            record = attributes_to_record attributes
+
+            if record.invalid?
+              return Operations.failure(:validation_failed, object: record_to_entity(record))
+            end
+
+            id = record.id.presence || attributes[:id].presence || attributes['id'].presence
+            if id && backend.find_by_id(id)
+              return Operations.failure :record_already_exists
+            end
+
+            if record.save
+              Operations.success :record_created, object: record_to_entity(record)
+            else
+              Operations.failure :creation_failed, object: record_to_entity(record)
+            end
+
+          rescue Exception => exception
+            ::Trouble.notify exception
+            Operations.failure :backend_error, object: exception
+          end
+
+          # ––––––––
+          # Updating
+          # ––––––––
+
+          def update(id, attributes)
+            unless record = backend.find_by_id(id)
+              return Operations.failure :record_not_found
+            end
+
+            record.assign_attributes attributes
+
+            if record.invalid?
+              entity = record_to_entity record
+              return Operations.failure(:validation_failed, object: entity)
+            end
+
+            if record.save
+              Operations.success :record_updated, object: record_to_entity(record)
+            else
+              Operations.failure :update_failed
+            end
+
+          rescue Exception => exception
+            ::Trouble.notify exception
+            Operations.failure :backend_error, object: exception
+          end
+
+          def destroy(id)
+            unless record = backend.find_by_id(id)
+              return Operations.success(:nothing_to_destroy)
+            end
+
+            if record.destroy
+              Operations.success :record_destroyed, object: record_to_entity(record)
+            else
+              Operations.failure :destruction_failed
+            end
+
+          rescue Exception => exception
+            ::Trouble.notify exception
+            Operations.failure :backend_error, object: exception
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/perimeter-activerecord.rb

@@ -0,0 +1,4 @@
+require 'perimeter'
+
+require 'perimeter/backend/adapters/active_record'
+require 'perimeter/repository/adapters/active_record'

data/perimeter-activerecord.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'perimeter-activerecord'
+  spec.version       = '0.0.1'
+  spec.authors       = %w{ Bukowskis }
+  spec.description   = %q{Repository/Entity pattern conventions. This is an adapter for ActiveRecord.}
+  spec.summary       = %q{Repository/Entity pattern conventions. This is an adapter for ActiveRecord.}
+  spec.homepage      = 'https://github.com/bukowskis/perimeter-activerecord'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/) - ['.travis.yml']
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w{ lib }
+
+  spec.add_dependency 'perimeter', '~> 0.0.1'
+
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
+end

data/spec/lib/perimeter/repository/adapters/active_record_spec.rb

@@ -0,0 +1,342 @@
+require 'spec_helper'
+require 'perimeter/repository/adapters/active_record'
+require 'my/games'
+
+describe Perimeter::Repository::Adapters::ActiveRecord do
+
+  let(:repository) { My::Games }
+  let(:frontend)   { My::Game }
+  let(:backend)    { My::Games::Backend }
+
+  describe '.find' do
+    let(:finding) { repository.find 1 }
+
+    context 'the record exists' do
+      before do
+        backend.create! name: 'Star Wars', genre: 'Classic'
+        expect( Trouble ).to_not receive :notify
+      end
+
+      it 'is an Operation' do
+        expect( finding ).to be_instance_of Operation
+      end
+
+      it 'succeeds' do
+        expect( finding ).to be_success
+      end
+
+      it 'has an informative code' do
+        expect( finding.code ).to eq :record_found
+      end
+
+      it 'holds the Entity' do
+        expect( finding.object ).to be_instance_of frontend
+      end
+
+      it 'has all attributes on the Entity' do
+        expect( finding.object.attributes ).to eq id: 1, name: 'Star Wars', genre: 'Classic', director: 'Gene Roddenberry'
+      end
+    end
+
+    context 'the record does not exist' do
+      before do
+        expect( Trouble ).to_not receive :notify
+      end
+
+      it 'is an Operation' do
+        expect( finding ).to be_instance_of Operation
+      end
+
+      it 'fails' do
+        expect( finding ).to be_failure
+      end
+
+      it 'has an informative code' do
+        expect( finding.code ).to eq :record_not_found
+      end
+
+      it 'holds the exception' do
+        expect( finding.object ).to be_instance_of ::ActiveRecord::RecordNotFound
+      end
+    end
+
+    context 'the repository had problems' do
+      before do
+        allow( repository::Backend ).to receive(:find).and_raise NoMemoryError
+        expect( Trouble ).to receive(:notify)
+      end
+
+      it 'is an Operation' do
+        expect( finding ).to be_instance_of Operation
+      end
+
+      it 'fails' do
+        expect( finding ).to be_failure
+      end
+
+      it 'has an informative code' do
+        expect( finding.code ).to eq :backend_error
+      end
+
+      it 'holds the exception' do
+        expect( finding.object ).to be_instance_of NoMemoryError
+      end
+    end
+  end
+
+  describe '.find!' do
+    let(:finding) { repository.find! 1 }
+
+    context 'the record exists' do
+      before do
+        backend.create! name: 'Casablanca', genre: 'Retro'
+        expect( Trouble ).to_not receive :notify
+      end
+
+      it 'is an Entity' do
+        expect( finding ).to be_instance_of frontend
+      end
+
+      it 'has all attributes on the Entity' do
+        expect( finding.attributes ).to eq  id: 1, name: 'Casablanca', genre: 'Retro', director: 'Gene Roddenberry'
+      end
+    end
+
+    context 'the record does not exist' do
+      before do
+        expect( Trouble ).to_not receive :notify
+      end
+
+      it 'raises an Exception' do
+        expect { finding }.to raise_error Perimeter::Repository::FindingError
+      end
+    end
+
+    context 'the repository had problems' do
+      before do
+        allow( repository::Backend ).to receive(:find).and_raise IOError
+        expect( Trouble ).to receive(:notify)
+      end
+
+      it 'raises an Exception' do
+        expect { finding }.to raise_error Perimeter::Repository::FindingError
+      end
+    end
+  end
+
+  describe '.create' do
+
+    context 'the Record is invalid' do
+      let(:creation) { repository.create name: 'Star Trek' }
+
+      before do
+        expect( Trouble ).to_not receive :notify
+      end
+
+      it 'is an Operation' do
+        expect( creation ).to be_instance_of Operation
+      end
+
+      it 'fails' do
+        expect( creation ).to be_failure
+      end
+
+      it 'has an informative code' do
+        expect( creation.code ).to eq :validation_failed
+      end
+
+      it 'knows the validation that failed on the Entity' do
+        expect( creation.object.errors.count ).to eq 1
+        expect( creation.object.errors[:genre] ).to be_present
+      end
+
+      it 'has all attributes on the Entity' do
+        expect( creation.object.attributes ).to eq id: nil, name: 'Star Trek', genre: nil, director: 'Gene Roddenberry'
+      end
+    end
+
+    context 'record already exists' do
+      let(:creation) { repository.create id: 1, name: 'The Matrix Reloaded', genre: 'Documentary' }
+
+      before do
+        backend.create! name: 'The Matrix', genre: 'Documentary'
+        expect( Trouble ).to_not receive :notify
+      end
+
+      it 'is an Operation' do
+        expect( creation ).to be_instance_of Operation
+      end
+
+      it 'fails' do
+        expect( creation ).to be_failure
+      end
+
+      it 'has an informative code' do
+        expect( creation.code ).to eq :record_already_exists
+      end
+    end
+
+    context 'persistence fails' do
+      let(:creation) { repository.create id: 55, genre: 'Film Noir' }
+
+      before do
+        allow( backend ).to receive(:find_by_id) do
+          # This is a suitable place to hook in something that will cause the Record#save operation to fail...
+          ActiveRecord::Migration.drop_table :games
+          nil
+        end
+        expect( Trouble ).to receive :notify
+      end
+
+      it 'is an Operation' do
+        expect( creation ).to be_instance_of Operation
+      end
+
+      it 'fails' do
+        expect( creation ).to be_failure
+      end
+
+      it 'has an informative code' do
+        expect( creation.code ).to eq :backend_error
+      end
+    end
+
+    context 'persistence succeeds' do
+      let(:creation) { repository.create genre: 'Slapstick' }
+
+      before do
+        expect( Trouble ).to_not receive :notify
+      end
+
+      it 'is an Operation' do
+        expect( creation ).to be_instance_of Operation
+      end
+
+      it 'succeeds' do
+        expect( creation ).to be_success
+      end
+
+      it 'has an informative code' do
+        expect( creation.code ).to eq :record_created
+      end
+
+      it 'holds the Entity' do
+        expect( creation.object ).to be_instance_of frontend
+      end
+
+      it 'has all attributes on the Entity' do
+        expect( creation.object.attributes ).to eq id: 1, name: nil, genre: 'Slapstick', director: 'Gene Roddenberry'
+      end
+    end
+
+  end
+
+  describe '.update' do
+    context 'record does not exist' do
+      let(:updating) { repository.update 1, {} }
+
+      before do
+        expect( Trouble ).to_not receive :notify
+      end
+
+      it 'is an Operation' do
+        expect( updating ).to be_instance_of Operation
+      end
+
+      it 'fails' do
+        expect( updating ).to be_failure
+      end
+
+      it 'has an informative code' do
+        expect( updating.code ).to eq :record_not_found
+      end
+    end
+
+    context 'the Record is invalid' do
+      let(:updating) { repository.update 1, name: 'Pac Man', genre: '  ' }
+
+      before do
+        backend.create! genre: 'RPG'
+        expect( Trouble ).to_not receive :notify
+      end
+
+      it 'is an Operation' do
+        expect( updating ).to be_instance_of Operation
+      end
+
+      it 'fails' do
+        expect( updating ).to be_failure
+      end
+
+      it 'has an informative code' do
+        expect( updating.code ).to eq :validation_failed
+      end
+
+      it 'knows the validation that failed on the Entity' do
+        expect( updating.object.errors.count ).to eq 1
+        expect( updating.object.errors[:genre] ).to be_present
+      end
+
+      it 'has all attributes on the Entity' do
+        expect( updating.object.attributes ).to eq id: 1, name: 'Pac Man', genre: '  ', director: 'Gene Roddenberry'
+      end
+    end
+
+    context 'persistence fails' do
+      let(:updating) { repository.update 1, name: 'Atomic Bomberman' }
+
+      before do
+        backend.create! genre: 'RTS'
+        allow( backend ).to receive(:find_by_id) do |id|
+          # This is a suitable place to hook in something that will cause the Record#save operation to fail...
+          record = backend.find id
+          ActiveRecord::Migration.drop_table :games
+          record
+        end
+        expect( Trouble ).to receive :notify
+      end
+
+      it 'is an Operation' do
+        expect( updating ).to be_instance_of Operation
+      end
+
+      it 'fails' do
+        expect( updating ).to be_failure
+      end
+
+      it 'has an informative code' do
+        expect( updating.code ).to eq :backend_error
+      end
+    end
+
+    context 'persistence succeeds' do
+      let(:updating) { repository.update 1, name: 'Alice and Bob' }
+
+      before do
+        backend.create! genre: 'Romance'
+        expect( Trouble ).to_not receive :notify
+      end
+
+      it 'is an Operation' do
+        expect( updating ).to be_instance_of Operation
+      end
+
+      it 'succeeds' do
+        expect( updating ).to be_success
+      end
+
+      it 'has an informative code' do
+        expect( updating.code ).to eq :record_updated
+      end
+
+      it 'holds the Entity' do
+        expect( updating.object ).to be_instance_of frontend
+      end
+
+      it 'has all attributes on the Entity' do
+        expect( updating.object.attributes ).to eq id: 1, name: 'Alice and Bob', genre: 'Romance', director: 'Gene Roddenberry'
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+$LOAD_PATH.unshift File.expand_path('../support/models', __FILE__)
+
+require 'perimeter-activerecord'
+
+require 'sqlite3'
+require 'active_record'
+
+RSpec.configure do |config|
+
+  config.before(:each) do
+    ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+    ActiveRecord::Schema.define do
+      create_table :games do |table|
+        table.column :genre, :string
+        table.column :name, :string
+        table.column :director, :string
+        table.column :year, :integer
+      end
+    end
+
+  end
+end

data/spec/support/models/my/game.rb

@@ -0,0 +1,12 @@
+require 'perimeter/entity'
+
+module My
+  class Game
+    include Perimeter::Entity
+
+    attribute :name
+    attribute :genre
+    attribute :director
+
+  end
+end

data/spec/support/models/my/games/backend.rb

@@ -0,0 +1,21 @@
+require 'perimeter/backend/adapters/active_record'
+
+module My
+  module Games
+    class Backend < ActiveRecord::Base
+
+      include Perimeter::Backend::Adapters::ActiveRecord
+
+      validates :genre, presence: true
+
+      before_validation :set_director
+
+      private
+
+      def set_director
+        self.director = 'Gene Roddenberry'
+      end
+
+    end
+  end
+end

data/spec/support/models/my/games.rb

@@ -0,0 +1,9 @@
+require 'my/game'
+require 'my/games/backend'
+require 'perimeter/repository/adapters/active_record'
+
+module My
+  module Games
+    include Perimeter::Repository::Adapters::ActiveRecord
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: perimeter-activerecord
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bukowskis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: perimeter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Repository/Entity pattern conventions. This is an adapter for ActiveRecord.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- lib/perimeter-activerecord.rb
+- lib/perimeter/backend/adapters/active_record.rb
+- lib/perimeter/repository/adapters/active_record.rb
+- perimeter-activerecord.gemspec
+- spec/lib/perimeter/repository/adapters/active_record_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/my/game.rb
+- spec/support/models/my/games.rb
+- spec/support/models/my/games/backend.rb
+homepage: https://github.com/bukowskis/perimeter-activerecord
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Repository/Entity pattern conventions. This is an adapter for ActiveRecord.
+test_files:
+- spec/lib/perimeter/repository/adapters/active_record_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/my/game.rb
+- spec/support/models/my/games.rb
+- spec/support/models/my/games/backend.rb