errol 0.0.1

data/lib/errol/repository.rb

@@ -0,0 +1,178 @@
+module Errol
+  class Repository
+    RecordAbsent = Class.new(StandardError)
+
+    class << self
+      def build(entries={})
+        entity = dispatch(record_class.new)
+        entries.each do |attribute, value|
+          entity.public_send "#{attribute}=", value
+        end
+        yield entity if block_given?
+        entity
+      end
+
+      def create(*arguments, &block)
+        build(*arguments, &block).tap(&method(:save))
+      end
+
+      def save(entity)
+        receive(entity).save
+        self
+      end
+
+      def remove(entity)
+        begin
+          receive(entity).destroy
+        rescue Sequel::NoExistingObject
+          raise RecordAbsent
+        end
+        self
+      end
+
+      def empty?(requirements={})
+        new(requirements, false).empty?
+      end
+
+      def count(requirements={})
+        new(requirements, false).count
+      end
+
+      def first(requirements={})
+        new(requirements, false).first
+      end
+
+      def last(requirements={})
+        new(requirements, false).last
+      end
+
+      def [](id, requirements={})
+        new(requirements, false)[id]
+      end
+
+      def fetch(id, requirements={}, &block)
+        new(requirements, false).fetch(id, &block)
+      end
+
+      def all(requirements={})
+        new(requirements, false).all
+      end
+
+      def each(requirements={}, &block)
+        new(requirements, false).each &block
+      end
+
+      def raw_dataset
+        record_class.dataset
+      end
+    end
+
+    include Enumerable
+
+    def initialize(requirements={}, paginate=true)
+      @requirements = requirements
+      @inquiry = self.class.inquiry(requirements)
+      @paginate = paginate
+    end
+
+    def current_page
+      paginated_dataset.current_page
+    end
+
+    def page_size
+      paginated_dataset.page_size
+    end
+
+    def first_page?
+      paginated_dataset.first_page?
+    end
+
+    def last_page?
+      paginated_dataset.last_page?
+    end
+
+    def page_count
+      paginated_dataset.page_count
+    end
+
+    def page_range
+      paginated_dataset.page_range
+    end
+
+    def next_page
+      paginated_dataset.next_page
+    end
+
+    def previous_page
+      paginated_dataset.prev_page
+    end
+
+    attr_reader :inquiry
+
+    def empty?
+      paginated_dataset.empty?
+    end
+
+    def count
+      paginated_dataset.count
+    end
+
+    def first
+      dispatch(paginated_dataset.first)
+    end
+
+    def last
+      # TODO say what!!
+      all.last
+      # dispatch(paginated_dataset.last)
+    end
+
+    def [](id)
+      dispatch(dataset.first(:id => id))
+    end
+
+    def fetch(id)
+      item = self[id]
+      return item if item
+      return yield id if block_given?
+      record_absent(id)
+    end
+
+    def all
+      paginated_dataset.map { |record| dispatch(record) }
+    end
+
+    def each
+      paginated_dataset.each do |record|
+        yield dispatch(record)
+      end
+      self
+    end
+
+    def raw_dataset
+      self.class.raw_dataset
+    end
+
+    def paginate?
+      @paginate
+    end
+
+    private
+
+    def dispatch(item)
+      self.class.dispatch(item) if item
+    end
+
+    def record_absent(id)
+      raise RecordAbsent, "#{self.class.name} contains no record with id: #{id}"
+    end
+
+    def paginated_dataset
+      if paginate?
+        dataset.paginate(inquiry.page.to_i, inquiry.page_size.to_i)
+      else
+        dataset
+      end
+    end
+  end
+end

data/lib/errol/version.rb

@@ -0,0 +1,3 @@
+module Errol
+  VERSION = "0.0.1"
+end

data/test/entity/access_generation_test.rb

@@ -0,0 +1,75 @@
+require_relative '../test_config'
+
+module Errol
+  class EntityTest < MiniTest::Test
+    def test_entry_reader_sets_reader_method
+      entity = Class.new Errol::Entity do
+        entry_reader :test_attribute
+      end
+      record = OpenStruct.new
+      instance = entity.new record
+      record.test_attribute = :value
+      assert_equal :value, instance.test_attribute
+    end
+
+    def test_entry_writer_sets_writer_method
+      entity = Class.new Errol::Entity do
+        entry_writer :test_attribute
+      end
+      record = OpenStruct.new
+      instance = entity.new record
+      instance.test_attribute = :value
+      assert_equal :value, record.test_attribute
+    end
+
+    def test_boolean_query_sets_query_method
+      entity = Class.new Errol::Entity do
+        boolean_query :test_attribute
+      end
+      record = OpenStruct.new
+      instance = entity.new record
+      record.test_attribute = :value
+      assert_equal true, instance.test_attribute?
+    end
+
+    def test_entry_accessor_sets_reader_method
+      entity = Class.new Errol::Entity do
+        entry_accessor :test_attribute
+      end
+      record = OpenStruct.new
+      instance = entity.new record
+      record.test_attribute = :value
+      assert_equal :value, instance.test_attribute
+    end
+
+    def test_entry_accessor_sets_writer_method
+      entity = Class.new Errol::Entity do
+        entry_accessor :test_attribute
+      end
+      record = OpenStruct.new
+      instance = entity.new record
+      instance.test_attribute = :value
+      assert_equal :value, record.test_attribute
+    end
+
+    def test_boolean_accessor_sets_query_method
+      entity = Class.new Errol::Entity do
+        boolean_accessor :test_attribute
+      end
+      record = OpenStruct.new
+      instance = entity.new record
+      record.test_attribute = :value
+      assert_equal true, instance.test_attribute?
+    end
+
+    def test_boolean_accessor_sets_writer_method
+      entity = Class.new Errol::Entity do
+        boolean_accessor :test_attribute
+      end
+      record = OpenStruct.new
+      instance = entity.new record
+      instance.test_attribute = :value
+      assert_equal :value, record.test_attribute
+    end
+  end
+end

data/test/entity/access_methods_test.rb

@@ -0,0 +1,32 @@
+require_relative '../test_config'
+
+module Errol
+  class EntityTest < MiniTest::Test
+    def test_set_sends_to_self
+      entity = Class.new Errol::Entity do
+        entry_accessor :test_attribute
+      end
+      record = OpenStruct.new
+      entity.new(record).set :test_attribute => 25
+      assert_equal 25, record.test_attribute
+    end
+
+    def test_set_returns_self
+      entity = Class.new Errol::Entity do
+        entry_accessor :test_attribute
+      end
+      record = OpenStruct.new
+      instance = entity.new(record)
+      out = instance.set :test_attribute => 25
+      assert_equal instance, out
+    end
+
+    # def test_save_after_set
+    #   mock_repo.expect :save, mock_repo, [instance]
+    #   instance.stub :set, instance do
+    #     instance.set!
+    #   end
+    #   mock_repo.verify
+    # end
+  end
+end

data/test/entity/entity_test.rb

@@ -0,0 +1,35 @@
+require_relative '../test_config'
+
+module Errol
+  class EntityTest < MiniTest::Test
+
+    def test_make_available_id
+      klass = Class.new(Errol::Entity)
+      record = OpenStruct.new :id => 4
+      instance = klass.new record
+      assert_equal 4, instance.id
+    end
+
+    def test_equal_if_wrapping_same_record
+      klass = Class.new(Errol::Entity)
+      assert_equal klass.new(:record), klass.new(:record)
+    end
+
+    def test_not_equal_for_different_records
+      klass = Class.new(Errol::Entity)
+      refute_equal klass.new(:record_b), klass.new(:record_a)
+    end
+
+    def test_not_equal_if_different_classes
+      klass1 = Class.new(Errol::Entity)
+      klass2 = Class.new(Errol::Entity)
+      refute_equal klass1.new(:record), klass2.new(:record)
+    end
+
+    # def test_undefined_bang
+    #   assert_raises NoMethodError do
+    #     instance.random!
+    #   end
+    # end
+  end
+end

data/test/entity/repository_method_test.rb

@@ -0,0 +1,92 @@
+require_relative '../test_config'
+
+module Errol
+  class EntityTest < MiniTest::Test
+
+    def test_raises_informative_error_on_class_before_repository_set
+      entity = Class.new Errol::Entity
+      assert_raises Errol::Entity::RepositoryUndefined do
+        entity.repository
+      end
+    end
+
+    def test_raises_informative_error_on_instance_before_repository_set
+      entity = Class.new Errol::Entity
+      instance = entity.new :record
+      assert_raises Errol::Entity::RepositoryUndefined do
+        instance.repository
+      end
+    end
+
+    def test_sets_repository_on_instance
+      entity = Class.new Errol::Entity
+      entity.repository = :repository
+      instance = entity.new :record
+      assert_equal :repository, instance.repository
+    end
+
+    def test_sets_repository_on_class
+      entity = Class.new Errol::Entity
+      entity.repository = :repository
+      assert_equal :repository, entity.repository
+    end
+
+    def test_saves_self_to_repository
+      entity = Class.new Errol::Entity
+      mock = MiniTest::Mock.new
+      entity.repository = mock
+      instance = entity.new mock
+      mock.expect :save, mock, [instance]
+      instance.save
+      mock.verify
+    end
+
+    def test_save_returns_self
+      entity = Class.new Errol::Entity
+      mock = MiniTest::Mock.new
+      entity.repository = mock
+      instance = entity.new mock
+      mock.expect :save, mock, [instance]
+      assert_equal instance.object_id, instance.save.object_id
+    end
+
+    def test_removes_self_with_repository
+      entity = Class.new Errol::Entity
+      mock = MiniTest::Mock.new
+      entity.repository = mock
+      instance = entity.new mock
+      mock.expect :remove, mock, [instance]
+      instance.destroy
+      mock.verify
+    end
+
+    def test_destroy_returns_self
+      entity = Class.new Errol::Entity
+      mock = MiniTest::Mock.new
+      entity.repository = mock
+      instance = entity.new mock
+      mock.expect :remove, mock, [instance]
+      assert_equal instance.object_id, instance.destroy.object_id
+    end
+
+    def test_refreshes_itself_with_repository
+      entity = Class.new Errol::Entity
+      mock = MiniTest::Mock.new
+      entity.repository = mock
+      instance = entity.new mock
+      mock.expect :refresh, mock, [instance]
+      instance.refresh
+      mock.verify
+    end
+
+    def test_refresh_returns_self
+      entity = Class.new Errol::Entity
+      mock = MiniTest::Mock.new
+      entity.repository = mock
+      instance = entity.new mock
+      mock.expect :refresh, mock, [instance]
+      assert_equal instance.object_id, instance.refresh.object_id
+    end
+
+  end
+end

data/test/inquiry/inquiry_test.rb

@@ -0,0 +1,57 @@
+require_relative '../test_config'
+
+module Errol
+  class InquiryTest < MiniTest::Test
+    def inquiry_class
+      @inquiry_class ||= Class.new(Inquiry)
+    end
+
+    def inquiry
+      @inquiry ||= inquiry_class.new
+    end
+
+    def teardown
+      @inquiry_class = nil
+      @inquiry = nil
+    end
+
+    def test_can_set_paginate_false
+      inquiry_class.default :paginate, false
+      assert_equal false, inquiry.paginate?
+    end
+
+    def test_throws_error_for_undefined_value
+      err = assert_raises Inquiry::DefaultValueUndefined do
+        inquiry.random
+      end
+      assert_match(/random/, err.message)
+    end
+
+    def test_can_set_arbitrary_number_of_defaults
+      inquiry_class.default :filter_a, []
+      inquiry_class.default :filter_b, :ballon
+      assert_equal [], inquiry.filter_a
+      assert_equal :ballon, inquiry.filter_b
+    end
+
+    def test_can_set_with_string
+      inquiry_class.default 'filter', :ballon
+      assert_equal :ballon, inquiry.filter
+    end
+
+    def test_can_check_if_value_set
+      inquiry_class.default :filter, :ballon
+      assert_equal true, inquiry.filter?
+    end
+
+    def test_can_over_write_on_initialize
+      inquiry_class.default :filter, :ballon
+      assert_equal :smidge, inquiry_class.new(:filter => :smidge).filter
+    end
+
+    def test_can_over_write_on_initialize_with_string
+      inquiry_class.default :filter, :ballon
+      assert_equal :smidge, inquiry_class.new('filter' => :smidge).filter
+    end
+  end
+end