repository 0.0.1

data/lib/repository/stash.rb

@@ -0,0 +1,59 @@
+# a Stash is a glorified hashtable, used for keeping objects in memory
+# and indexing them by key. Any objects put into the stash must have an
+# key, as identified by the Keymaster class. A stash is used by Repository
+# to keep the objects it recieves from its Storage.
+module Repository
+  class Stash
+
+    attr_reader :data # for debugging only
+
+    def initialize
+      @data = {}
+    end
+
+    def size
+      @data.size
+    end
+
+    def clear
+      @data = {}
+    end
+
+    # Put an object, or an array of objects, into the stash.
+    # All such objects must be identifiable by the Keymaster class;
+    # if not, this will raise a Repository::Storage::Unidentified exception
+    # (possibly leaving some remaining items unstashed).
+    def put(object)
+      if object.is_a? Array
+        object.each do |o|
+          put(o)
+        end
+      else
+        key = object.id
+        raise Storage::Unidentified, "you can't stash an object without id" unless key
+        @data[key] = object
+      end
+    end
+
+    # get an object by key
+    def get(key)
+      @data[key]
+    end
+    
+    alias_method :[], :get
+
+    # Finds all stashed objects that match the argument. Argument is either
+    # a criterion, an key, or an array of either keys or criteria.
+    # Returns an array of objects.
+    def find(arg)
+      if arg.is_a? Criterion
+        @data.values.select{|object| arg.match? object}
+      elsif arg.is_a? Array
+        arg.map{|key| get(key)}
+      else
+        [get(arg)]
+      end
+    end
+
+  end
+end

data/lib/repository/stash_storage.rb

@@ -0,0 +1,34 @@
+module Repository 
+  class StashStorage < Storage
+
+    attr_reader :stash
+    
+    def initialize(klass, stash = Stash.new)
+      raise "nope" if klass.is_a? Stash
+      raise "nuh-uh" unless stash.is_a? Stash
+      super(klass)
+      @stash = stash
+    end
+    
+    def size
+      @stash.size
+    end
+
+    def clear
+      @stash.clear
+    end
+
+    def store(objects)
+      @stash.put(objects)
+    end
+
+    def find_by_criterion(criterion)
+      @stash.find(criterion)
+    end
+
+    def find_by_keys(keys)
+      @stash.find(keys)
+    end
+
+  end
+end

data/lib/repository/storage.rb

@@ -0,0 +1,78 @@
+module Repository
+
+  # Storage is an abstract base class for the backing storage area of
+  # a Repository. Concrete implementations include Stash (for in-memory
+  # storage).
+  class Storage
+
+    class Unidentified < RuntimeError
+    end
+
+    class Unimplemented < RuntimeError
+    end
+    
+    def self.for_class(klass)
+      StashStorage.new(klass)
+    end
+
+    def initialize(klass = nil)
+      @klass = klass
+    end
+
+    def size
+      raise Unimplemented
+    end
+
+    def clear
+      raise Unimplemented
+    end
+    
+    # Put an object, or an array of objects, into the storage.
+    def store(objects)
+      unless objects.is_a? Array
+        objects = [objects]
+      end
+      objects.each do |object|
+        store(object)
+      end
+    end
+
+    # get an object by key
+    def get(key)
+      find_by_keys([key]).first
+    end
+
+    # alias for get
+    def [](key)
+      get(key)
+    end
+
+    # Finds all stashed objects that match the argument. Argument is either
+    # a criterion, an key, or an array of either keys or criteria.
+    # Returns an array of objects.
+    def find(arg)
+      if arg.is_a? Criterion
+        find_by_criterion(arg)
+      elsif arg.is_a? Array
+        find_by_keys(arg)
+      else
+        find_by_keys([arg])
+      end
+    end
+    
+    protected
+    
+    def store(objects)
+      raise Unimplemented
+    end
+
+    def find_by_criterion(criterion)
+      raise Unimplemented
+    end
+    
+    def find_by_keys(keys)
+      raise Unimplemented
+    end
+    
+  end
+end

data/repository.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.add_dependency 'active_support', [">= 0"]
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+
+  gem.authors = ["Alex Chaffee", "Nikita Fedyashev"]
+  gem.description = %q{A Repository mediates between the domain and data mapping layers, acting like an in-memory domain object collection.}
+  gem.email = 'loci.master@gmail.com'
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = 'http://github.com/nfedyashev/repository'
+  gem.name = 'repository'
+  gem.require_paths = ['lib']
+  gem.extra_rdoc_files = ['README.md']
+  gem.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if gem.respond_to? :required_rubygems_version=
+  gem.summary = %q{A Ruby implementation of the Repository Pattern}
+  gem.test_files = `git ls-files -- spec/*`.split("\n")
+  gem.version = '0.0.1'
+end
+

data/spec/domain.rb

@@ -0,0 +1,21 @@
+require 'ostruct'
+
+module Repository
+
+  class Project < OpenStruct
+  end
+
+  class User < OpenStruct
+    def initialize(hash = {})
+      super({:name => nil}.merge(hash))
+    end
+  end
+
+  class Address < OpenStruct
+  end
+
+  class Country < OpenStruct
+  end
+
+
+end

data/spec/helper.rb

@@ -0,0 +1,51 @@
+ENV["T_ENV"] = "test"
+require 'repository'
+require 'rspec'
+require 'pry'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'domain'
+
+module CustomMatchers
+  # borrowed from http://github.com/aiwilliams/spec_goodies
+
+  class IncludeOnly # :nodoc:all
+    def initialize(*expected)
+      @expected = expected.flatten
+    end
+
+    def matches?(actual)
+      @missing = @expected.reject {|e| actual.include?(e)}
+      @extra = actual.reject {|e| @expected.include?(e)}
+      @extra.empty? && @missing.empty?
+    end
+
+    def failure_message
+      message = "expected to include only #{@expected.inspect}"
+      message << "\nextra: #{@extra.inspect}" unless @extra.empty?
+      message << "\nmissing: #{@missing.inspect}" unless @missing.empty?
+      message
+    end
+
+    def negative_failure_message
+      "expected to include more than #{@expected.inspect}"
+    end
+
+    def to_s
+      "include only #{@expected.inspect}"
+    end
+  end
+
+  # Unlike checking that two Enumerables are equal, where the
+  # objects in corresponding positions must be equal, this will
+  # allow you to ensure that an Enumerable has all the objects
+  # you expect, in any order; no more, no less.
+  def include_only(*expected)
+    IncludeOnly.new(*expected)
+  end
+end
+
+RSpec.configure do |config|
+  include CustomMatchers
+end

data/spec/lib/criterion_conjunction_spec.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+require 'helper'
+
+module Repository
+  describe Criterion do
+    before do
+      @alice = User.new(:name => "Alice", :id => 1)
+      @bob = User.new(:name => "Bob", :id => 2)
+      @charlie = User.new(:name => "Charlie", :id => 3)
+    end
+
+    describe Criterion::And do
+      before do
+        @c = Criterion::And.new(
+          (@c1 = Criterion::Contains.new(:subject => "name", :value => "a")),
+          (@c2 = Criterion::Contains.new(:subject => "name", :value => "r"))
+        )
+      end
+
+      describe '#match' do
+
+        it "fails to match if no criteria match" do
+          @c.should_not be_match(@bob)
+        end
+
+        it "fails to match if only one criterion matches" do
+          @c.should_not be_match(@alice)
+        end
+
+        it "matches if all criteria match" do
+          @c.should be_match(@charlie)
+        end
+      end
+    end
+
+    describe Criterion::Or do
+      before do
+        @c = Criterion::Or.new(
+          (@c1 = Criterion::Contains.new(:subject => "name", :value => "o")),  # 'o' is only in 'bob'
+          (@c2 = Criterion::Contains.new(:subject => "name", :value => "r"))   # 'r' is only in 'charlie'
+        )
+      end
+
+      describe '#match' do
+        it "fails to match if no criteria match" do
+          @c.should_not be_match(@alice)
+        end
+
+        it "matches if only one criterion matches" do
+          @c.should be_match(@bob)
+          @c.should be_match(@charlie)
+        end
+      end
+    end
+
+
+  end
+end

data/spec/lib/criterion_contains_spec.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+require 'helper'
+
+module Repository
+  describe Criterion do
+    before do
+      @alice = User.new(:name => "Alice", :id => 1)
+      @bob = User.new(:name => "Bob", :id => 2)
+      @charlie = User.new(:name => "Charlie", :id => 3)
+    end
+
+    describe Criterion::Contains do
+      before do
+        @c = Criterion::Contains.new(:subject => "name", :value => "ABC")
+      end
+
+      it "has a swell descriptor" do
+        @c.descriptor.should == "name contains"
+      end
+
+      it "matches identical text" do
+        @c.should be_match(User.new(:name => "ABC"))
+      end
+      it "matches mixed-case identical text" do
+        @c.should be_match(User.new(:name => "AbC"))
+      end
+      it "matches text in the middle" do
+        @c.should be_match(User.new(:name => "drabCouch"))
+      end
+      it "doesn't match different text" do
+        @c.should_not be_match(User.new(:name => "abx"))
+      end
+      describe "multiple values" do
+        before do
+          @c = Criterion::Contains.new(:subject => "name", :descriptor => "is kinda named", :value => ["ABC", "123"])
+        end
+        it "matches any" do
+          @c.should be_match(User.new(:name => "abc"))
+          @c.should be_match(User.new(:name => "123"))
+        end
+        it "fails to match" do
+          @c.should_not be_match(User.new(:name => "12ab3c"))
+        end
+      end
+    end
+
+  end
+end

data/spec/lib/criterion_equals_spec.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+require 'helper'
+
+module Repository
+  describe Criterion do
+    before do
+      @alice = User.new(:name => "Alice", :id => 1)
+      @bob = User.new(:name => "Bob", :id => 2)
+      @charlie = User.new(:name => "Charlie", :id => 3)
+    end
+
+    describe Criterion::Equals do
+      before do
+        @c = Criterion::Equals.new(:subject => "name", :value => "alex")
+      end
+
+      it "has a swell descriptor" do
+        Criterion::Equals.new({}).descriptor.should == "id equals"
+      end
+
+      describe '#match' do
+        describe "a string" do
+          before do
+            @c = Criterion::Equals.new(:subject => "name", :value => "Alice")
+          end
+
+          it "matches a string" do
+            @c.should be_match @alice
+          end
+
+          it "fails to match a string" do
+            @c.should_not be_match @bob
+          end
+
+          it "fails to match a string with the wrong case" do
+            @c.should_not be_match User.new(:name => "alice")
+          end
+        end
+
+        describe "an int" do
+          before do
+            @c = Criterion::Equals.new(:subject => "id", :value => 1)
+          end
+
+          it "matches an int" do
+            @c.match?(@alice).should be_true
+          end
+
+          it "fails to match an int" do
+            @c.match?(@bob).should be_false
+          end
+        end
+
+        describe "a set of ints" do
+          before do
+            @c = Criterion::Equals.new(:subject => "id", :value => [1,2])
+          end
+
+          it "matches" do
+            @c.should be_match @alice
+            @c.should be_match @bob
+          end
+
+          it "fails to match an int" do
+            @c.should_not be_match @charlie
+          end
+        end
+
+        describe "a string value in the criterion" do
+          it "should match an int value in the object" do
+            @c = Criterion::Equals.new(:subject => "id", :value => "1")
+            @c.should be_match @alice
+          end
+        end
+
+      end
+    end
+  end
+end