errol 0.0.1

data/test/repository/contruction_test.rb

@@ -0,0 +1,62 @@
+require_relative '../test_config'
+require_relative './query_test'
+
+class Item < Sequel::Model(:items)
+  def name=(name)
+    super name.reverse
+  end
+end
+
+class RepositoryQueyTest < RecordTest
+  def test_can_build_new_record
+    assert_equal Item.new, TestRepository.build.__getobj__
+  end
+
+  def test_can_build_new_record_with_name
+    assert_equal 'ylurnu', TestRepository.build(:name => 'unruly').name
+  end
+
+  def test_build_yields_to_block
+    mock = MiniTest::Mock.new
+    mock.expect :record, true, [Item.new]
+    TestRepository.build do |item|
+      mock.record item.__getobj__
+    end
+    mock.verify
+  end
+
+  def test_can_save_an_item
+    # TODO incorperate, update.amend/renew/revise, remove/obliterate/withdraw
+    item = SimpleDelegator.new Item.new
+    TestRepository.save(item)
+    refute_empty TestRepository
+  end
+
+  def test_save_returns_repository
+    item = SimpleDelegator.new Item.new
+    assert_equal TestRepository, TestRepository.save(item)
+  end
+
+  def test_can_remove_an_item
+    item = SimpleDelegator.new Item.create
+    TestRepository.remove(item)
+    assert_empty TestRepository
+  end
+
+  def test_cant_remove_missing_item
+    item = SimpleDelegator.new Item.new
+    assert_raises Errol::Repository::RecordAbsent do
+      TestRepository.remove(item)
+    end
+  end
+
+  def test_remove_returns_repository
+    item = SimpleDelegator.new Item.create
+    assert_equal TestRepository, TestRepository.remove(item)
+  end
+
+  def test_can_create_item
+    TestRepository.create
+    refute_empty TestRepository
+  end
+end

data/test/repository/page_test.rb

@@ -0,0 +1,163 @@
+require_relative '../test_config'
+
+class PaginatedInquiry < Errol::Inquiry
+  default :page, 1
+  default :page_size, 2
+end
+
+class PaginatedRepository < Errol::Repository
+  def self.record_class
+    Item
+  end
+
+  def dataset
+    dataset = raw_dataset
+  end
+
+  def self.inquiry(requirements)
+    PaginatedInquiry.new(requirements)
+  end
+
+  def self.dispatch(record)
+    SimpleDelegator.new record
+  end
+
+  def self.receive(entity)
+    entity.__getobj__
+  end
+end
+
+class DemoRepositoryQueyTest < RecordTest
+  def items
+    DB[:items]
+  end
+
+  def first
+    @first ||= items.insert({})
+  end
+
+  def second
+    @second ||= items.insert({})
+  end
+
+  def third
+    @third ||= items.insert({})
+  end
+
+  def setup
+    first
+    second
+    third
+  end
+
+  def teardown
+    @first = nil
+    @second = nil
+    @third = nil
+  end
+
+  def test_can_get_first_page_number
+    page = PaginatedRepository.new
+    assert_equal 1, page.current_page
+  end
+
+  def test_can_get_first_page_size
+    page = PaginatedRepository.new
+    assert_equal 2, page.page_size
+  end
+
+  def test_identifies_as_first_page
+    page = PaginatedRepository.new
+    assert page.first_page?
+  end
+
+  def test_identifies_as_not_first_page
+    page = PaginatedRepository.new :page => 2
+    refute page.first_page?
+  end
+
+  def test_identifies_as_last_page
+    page = PaginatedRepository.new :page => 2
+    assert page.last_page?
+  end
+
+  def test_identifies_as_not_first_page
+    page = PaginatedRepository.new
+    refute page.last_page?
+  end
+
+  def test_can_get_page_count_from_each_page
+    page = PaginatedRepository.new
+    assert_equal 2, page.page_count
+  end
+
+  def test_can_get_page_range
+    page = PaginatedRepository.new
+    assert_equal 1..2, page.page_range
+  end
+
+  def test_can_get_next_page
+    page = PaginatedRepository.new
+    assert_equal 2, page.next_page
+  end
+
+  def test_can_get_previous_page
+    page = PaginatedRepository.new
+    assert_equal nil, page.previous_page
+  end
+
+  def test_page_reports_not_empty
+    page = PaginatedRepository.new
+    refute_empty page
+  end
+
+  def test_page_reports_empty
+    page = PaginatedRepository.new :page => 3
+    assert_empty page
+  end
+
+  def test_counts_page_items
+    page = PaginatedRepository.new :page => 2
+    assert_equal 1, page.count
+  end
+
+  def test_can_get_first_item_on_second_page
+    page = PaginatedRepository.new :page => 2
+    assert_equal third, page.first.id
+  end
+
+  def test_can_get_last_item_on_first_page
+    page = PaginatedRepository.new :page => 1
+    assert_equal second, page.last.id
+  end
+
+  # def test_nil_if_not_found_on_page
+  #   # TODO note pagination applied after filtering so finds record
+  #   page = PaginatedRepository.new :page => 1
+  #   assert_nil page[third]
+  # end
+
+  def test_can_get_all_items_on_second_page
+    page = PaginatedRepository.new :page => 2
+    assert_equal [third], page.all.map{ |entity| entity.id }
+  end
+
+  def test_can_get_each_item_on_page
+    mock = MiniTest::Mock.new
+    mock.expect :record, true, [third]
+    page = PaginatedRepository.new :page => 2
+    page.each { |entity| mock.record entity.id }
+    mock.verify
+  end
+
+  def test_each_method_returns_self
+    page = PaginatedRepository.new :page => 2
+    assert_equal page, page.each{}
+  end
+
+  def test_can_map_items_on_page
+    page = PaginatedRepository.new :page => 2
+    assert_equal [3], page.map(&:id)
+  end
+
+end

data/test/repository/query_test.rb

@@ -0,0 +1,190 @@
+require_relative '../test_config'
+
+class Inquiry < Errol::Inquiry
+  default :show_offers, false
+end
+
+class TestRepository < Errol::Repository
+  def self.record_class
+    Item
+  end
+
+  def dataset
+    dataset = raw_dataset
+
+    inquiry.show_offers? ? dataset.where(:discounted) : dataset
+
+  end
+
+  def self.inquiry(requirements)
+    Inquiry.new(requirements)
+  end
+
+  def self.dispatch(record)
+    SimpleDelegator.new record
+  end
+
+  def self.receive(entity)
+    entity.__getobj__
+  end
+end
+
+
+class RepositoryQueyTest < RecordTest
+  def items
+    DB[:items]
+  end
+
+  def test_repository_starts_empty
+    assert_equal true, TestRepository.empty?
+  end
+
+  def test_repository_not_empty_with_item
+    items.insert(:name => 'abc')
+    assert_equal false, TestRepository.empty?
+  end
+
+  def test_filtered_repository_is_empty
+    items.insert(:name => 'abc', :discounted => false)
+    assert_equal true, TestRepository.empty?(:show_offers => true)
+  end
+
+  def test_repository_starts_with_count_zero
+    assert_equal 0, TestRepository.count
+  end
+
+  def test_respository_counts_one_item
+    items.insert(:name => 'abc')
+    assert_equal 1, TestRepository.count
+  end
+
+  def test_filtered_repository_counts_zero_items
+    items.insert(:name => 'abc', :discounted => false)
+    assert_equal 0, TestRepository.count(:show_offers => true)
+  end
+
+  def test_can_get_first_item
+    item = Item.create(:name => 'abc')
+    assert_equal item, TestRepository.first.__getobj__
+  end
+
+  def test_wraps_first_item
+    items.insert(:name => 'abc')
+    assert_equal SimpleDelegator, TestRepository.first.class
+  end
+
+  def test_returns_nil_for_no_first_item
+    assert_nil TestRepository.first
+  end
+
+  def test_returns_first_filtered_item
+    items.insert(:name => 'abc', :discounted => false)
+    i = items.insert(:name => 'abc', :discounted => true)
+    items.insert(:name => 'abc', :discounted => false)
+    assert_equal i, TestRepository.first(:show_offers => true).id
+  end
+
+  def test_can_get_last_item
+    item = Item.create(:name => 'abc')
+    assert_equal item, TestRepository.last.__getobj__
+  end
+
+  def test_wraps_last_item
+    items.insert(:name => 'abc')
+    assert_equal SimpleDelegator, TestRepository.last.class
+  end
+
+  def test_returns_nil_for_no_last_item
+    assert_nil TestRepository.last
+  end
+
+  def test_returns_last_filtered_item
+    items.insert(:name => 'abc', :discounted => false)
+    i = items.insert(:name => 'abc', :discounted => true)
+    items.insert(:name => 'abc', :discounted => false)
+    assert_equal i, TestRepository.last(:show_offers => true).id
+  end
+
+  def test_can_find_item_by_id
+    item = Item.create(:name => 'abc')
+    assert_equal item, TestRepository[item.id].__getobj__
+  end
+
+  def test_wraps_found_item
+    item = Item.create(:name => 'abc')
+    assert_equal SimpleDelegator, TestRepository[item.id].class
+  end
+
+  def test_returns_nil_for_no_found_item
+    assert_nil TestRepository[2]
+  end
+
+  def test_returns_nil_on_filtered_find
+    item = Item.create(:name => 'abc')
+    assert_nil TestRepository[item.id, :show_offers => true]
+  end
+
+  def test_can_fetch_item_by_id
+    item = Item.create(:name => 'abc')
+    assert_equal item, TestRepository.fetch(item.id).__getobj__
+  end
+
+  def test_wraps_fetched_item
+    item = Item.create(:name => 'abc')
+    assert_equal SimpleDelegator, TestRepository.fetch(item.id).class
+  end
+
+  def test_raises_error_for_no_fetched_item
+    err = assert_raises Errol::Repository::RecordAbsent do
+      TestRepository.fetch(2)
+    end
+    assert_equal 'TestRepository contains no record with id: 2', err.message
+  end
+
+  def test_raises_error_on_filtered_fetch
+    item = Item.create(:name => 'abc')
+    assert_raises Errol::Repository::RecordAbsent do
+      TestRepository.fetch(item.id, :show_offers => true)
+    end
+  end
+
+  def test_fetch_calls_block_for_missing_item
+    mock = MiniTest::Mock.new
+    mock.expect :record, true, [2]
+    TestRepository.fetch(2) { |id| mock.record id }
+  end
+
+  def test_returns_all_items
+    item = Item.create(:name => 'abc')
+    assert_equal [item], TestRepository.all.map(&:__getobj__)
+  end
+
+  def test_wraps_all_items
+    item = Item.create(:name => 'abc')
+    assert_equal [SimpleDelegator], TestRepository.all.map(&:class)
+  end
+
+  def test_filters_all_records
+    discounted = Item.create(:name => 'abc', :discounted => true)
+    Item.create(:name => 'abc')
+    assert_equal [discounted], TestRepository.all(:show_offers => true).map(&:__getobj__)
+  end
+
+  def test_can_get_each_item_in_repository
+    item = Item.create(:name => 'abc')
+    mock = MiniTest::Mock.new
+    mock.expect :record, true, [item]
+    TestRepository.each { |entity| mock.record entity.__getobj__ }
+    mock.verify
+  end
+
+  def test_can_get_each_item_in_filtered_repository
+    item = Item.create(:name => 'abc')
+    discounted = Item.create(:name => 'abc', :discounted => true)
+    mock = MiniTest::Mock.new
+    mock.expect :record, true, [discounted]
+    TestRepository.each(:show_offers => true) { |entity| mock.record entity.__getobj__ }
+    mock.verify
+  end
+
+end

data/test/test_config.rb

@@ -0,0 +1,27 @@
+require 'errol'
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'sequel'
+
+reporter_options = {color: true, slow_count: 5}
+Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(reporter_options)]
+
+DB = Sequel.sqlite
+
+DB.create_table :items do
+  primary_key :id
+  String :name
+  TrueClass :discounted
+  Float :price
+end
+DB.extension(:pagination)
+
+class RecordTest < MiniTest::Test
+
+  def run(*args, &block)
+    result = nil
+    Sequel::Model.db.transaction(:rollback=>:always, :auto_savepoint=>true){result = super}
+    result
+  end
+
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: errol
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Saxton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.19'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Based of the Sequel Library to deliver a repository interface to persisted
+  data. Handles pagination by default
+email:
+- peterhsaxton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- errol.gemspec
+- lib/errol.rb
+- lib/errol/entity.rb
+- lib/errol/inquiry.rb
+- lib/errol/repository.rb
+- lib/errol/version.rb
+- test/entity/access_generation_test.rb
+- test/entity/access_methods_test.rb
+- test/entity/entity_test.rb
+- test/entity/repository_method_test.rb
+- test/inquiry/inquiry_test.rb
+- test/repository/contruction_test.rb
+- test/repository/page_test.rb
+- test/repository/query_test.rb
+- test/test_config.rb
+homepage: ''
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Repository to store and deliver encapsulated records.
+test_files:
+- test/entity/access_generation_test.rb
+- test/entity/access_methods_test.rb
+- test/entity/entity_test.rb
+- test/entity/repository_method_test.rb
+- test/inquiry/inquiry_test.rb
+- test/repository/contruction_test.rb
+- test/repository/page_test.rb
+- test/repository/query_test.rb
+- test/test_config.rb