ansr 0.0.1 → 0.0.3

data/ansr_dpla/spec/lib/relation/select_spec.rb

@@ -6,14 +6,16 @@ describe Ansr::Relation do
     @faceted = read_fixture('kittens_faceted.jsonld')
     @empty = read_fixture('empty.jsonld')
     @mock_api = double('api')
-    Item.config({:api_key => :foo})
+    Item.config{ |x| x[:api_key] = :foo}
     Item.engine.api= @mock_api
   end
 
+  subject { Ansr::Dpla::Relation.new(Item, Item.table) }
+
   describe '#select' do
     describe 'with a block given' do
       it "should build an array" do
-        test = Ansr::Relation.new(Item, Item.table).where(q:'kittens')
+        test = subject.where(q:'kittens')
         @mock_api.should_receive(:items).with(:q => 'kittens').and_return(@kittens)
         actual = test.select {|d| true}
         expect(actual).to be_a(Array)
@@ -25,22 +27,22 @@ describe Ansr::Relation do
     end
     describe 'with a String or Symbol key given' do
       it 'should change the requested document fields' do
-        test = Ansr::Relation.new(Item, Item.table).where(q:'kittens')
-        @mock_api.should_receive(:items).with(:q => 'kittens', :fields=>'name').and_return('')
+        test = subject.where(q:'kittens')
+        @mock_api.should_receive(:items).with(:q => 'kittens', :fields=>:name).and_return('')
         test = test.select('name')
         test.load
       end
     end
     describe 'with a list of keys' do
       it "should add all the requested document fields" do
-        test = Ansr::Relation.new(Item, Item.table).where(q:'kittens')
-        @mock_api.should_receive(:items).with(:q => 'kittens', :fields=>'name,foo').and_return('')
+        test = subject.where(q:'kittens')
+        @mock_api.should_receive(:items).with(:q => 'kittens', :fields=>[:name,:foo]).and_return('')
         test = test.select(['name','foo'])
         test.load
       end
       it "should add all the requested document fields and proxy them" do
-        test = Ansr::Relation.new(Item, Item.table).where(q:'kittens')
-        @mock_api.should_receive(:items).with(:q => 'kittens', :fields=>'object').and_return(@kittens)
+        test = subject.where(q:'kittens')
+        @mock_api.should_receive(:items).with(:q => 'kittens', :fields=>:object).and_return(@kittens)
         test = test.select('object AS my_object')
         test.load
         expect(test.to_a.first['object']).to be_nil

data/ansr_dpla/spec/lib/relation/where_spec.rb

@@ -6,7 +6,7 @@ describe Ansr::Relation do
     @faceted = read_fixture('kittens_faceted.jsonld')
     @empty = read_fixture('empty.jsonld')
     @mock_api = double('api')
-    Item.config({:api_key => :foo})
+    Item.config{ |x| x[:api_key] = :foo}
     Item.engine.api= @mock_api
   end
   describe '#where' do

data/ansr_dpla/spec/lib/relation_spec.rb

@@ -1,15 +1,17 @@
 require 'spec_helper'
 
-describe Ansr::Relation do
+describe Ansr::Dpla::Relation do
   before do
     @kittens = read_fixture('kittens.jsonld')
     @faceted = read_fixture('kittens_faceted.jsonld')
     @empty = read_fixture('empty.jsonld')
     @mock_api = double('api')
-    Item.config({:api_key => :foo})
+    Item.config {|x| x[:api_key] = :foo }
     Item.engine.api= @mock_api
   end
 
+  subject { Ansr::Dpla::Relation.new(Item, Item.table) }
+
   describe "#initialize" do
     it "should identify the correct resource for the model" do
       class Foo
@@ -18,21 +20,21 @@ describe Ansr::Relation do
         end
       end
 
-      test = Ansr::Relation.new(Foo, Foo.table)
+      test = Ansr::Dpla::Relation.new(Foo, Foo.table)
       expect(test.resource).to eql(:foos)
     end
   end
 
   describe ".load" do
     it "should fetch the appropriate REST resource" do
-      test = Ansr::Relation.new(Item, Item.table).where(:q=>'kittens')
+      test = subject.where(:q=>'kittens')
       @mock_api.should_receive(:items).with(:q => 'kittens').and_return('')
       test.load
     end
 
     describe "Relation attributes" do
       it "should set attributes correctly from a response" do
-        test = Ansr::Relation.new(Item, Item.table).where(:q=>'kittens')
+        test = subject.where(:q=>'kittens')
         @mock_api.stub(:items).and_return(@kittens)
         test.load
         expect(test.count).to eql(144)
@@ -41,7 +43,7 @@ describe Ansr::Relation do
       end
 
       it "should set attributes correctly for an empty response" do
-        test = Ansr::Relation.new(Item, Item.table).where(:q=>'kittens')
+        test = subject.where(:q=>'kittens')
         @mock_api.stub(:items).and_return(@empty)
         test.load
         expect(test.count).to eql(0)
@@ -62,21 +64,21 @@ describe Ansr::Relation do
   describe '.order' do
     describe 'with symbol parms' do
       it "should add sort clause to query" do
-        test = Ansr::Relation.new(Item, Item.table).where(:q=>'kittens').order(:foo)
+        test = subject.where(:q=>'kittens').order(:foo)
         expect(test).to be_a(Ansr::Relation)
         @mock_api.should_receive(:items).with(:q => 'kittens',:sort_by=>:foo).and_return('')
         test.load
       end
 
       it "should add multiple sort clauses to query" do
-        test = Ansr::Relation.new(Item, Item.table).where(:q=>'kittens').order(:foo).order(:bar)
+        test = subject.where(:q=>'kittens').order(:foo).order(:bar)
         expect(test).to be_a(Ansr::Relation)
         @mock_api.should_receive(:items).with(:q => 'kittens',:sort_by=>[:foo,:bar]).and_return('')
         test.load
       end
 
       it "should sort in descending order if necessary" do
-        test = Ansr::Relation.new(Item, Item.table).where(:q=>'kittens').order(:foo => :desc)
+        test = subject.where(:q=>'kittens').order(:foo => :desc)
         expect(test).to be_a(Ansr::Relation)
         @mock_api.should_receive(:items).with(:q => 'kittens',:sort_by=>:foo, :sort_order=>:desc).and_return('')
         test.load
@@ -84,14 +86,14 @@ describe Ansr::Relation do
     end
     describe 'with String parms' do
       it "should add sort clause to query" do
-        test = Ansr::Relation.new(Item, Item.table).where(q:'kittens').order("foo")
+        test = subject.where(q:'kittens').order("foo")
         expect(test).to be_a(Ansr::Relation)
         @mock_api.should_receive(:items).with(:q => 'kittens',:sort_by=>:foo).and_return('')
         test.load
       end
 
       it "should sort in descending order if necessary" do
-        test = Ansr::Relation.new(Item, Item.table).where(q:'kittens').order("foo DESC")
+        test = subject.where(q:'kittens').order("foo DESC")
         expect(test).to be_a(Ansr::Relation)
         @mock_api.should_receive(:items).with(:q => 'kittens',:sort_by=>:foo, :sort_order=>:desc).and_return('')
         test.load
@@ -101,7 +103,7 @@ describe Ansr::Relation do
 
   describe '#reorder' do
     it "should replace existing order" do
-      test = Ansr::Relation.new(Item, Item.table).where(q:'kittens').order("foo DESC")
+      test = subject.where(q:'kittens').order("foo DESC")
       test = test.reorder("foo ASC")
       expect(test).to be_a(Ansr::Relation)
       @mock_api.should_receive(:items).with(:q => 'kittens',:sort_by=>:foo).and_return('')
@@ -111,7 +113,7 @@ describe Ansr::Relation do
 
   describe '#reverse_order' do
     it "should replace existing DESC order" do
-      test = Ansr::Relation.new(Item, Item.table).where(q:'kittens').order("foo DESC")
+      test = subject.where(q:'kittens').order("foo DESC")
       test = test.reverse_order
       expect(test).to be_a(Ansr::Relation)
       @mock_api.should_receive(:items).with(:q => 'kittens',:sort_by=>:foo).and_return('')
@@ -119,7 +121,7 @@ describe Ansr::Relation do
     end
 
     it "should replace existing ASC order" do
-      test = Ansr::Relation.new(Item, Item.table).where(q:'kittens').order("foo ASC")
+      test = subject.where(q:'kittens').order("foo ASC")
       test = test.reverse_order
       expect(test).to be_a(Ansr::Relation)
       @mock_api.should_receive(:items).with(:q => 'kittens',:sort_by=>:foo, :sort_order=>:desc).and_return('')
@@ -129,7 +131,7 @@ describe Ansr::Relation do
 
   describe '#unscope' do
     it 'should remove clauses only from spawned Relation' do
-      test = Ansr::Relation.new(Item, Item.table).where(q:'kittens').order("foo DESC")
+      test = subject.where(q:'kittens').order("foo DESC")
       test2 = test.unscope(:order)
       expect(test2).to be_a(Ansr::Relation)
       @mock_api.should_receive(:items).with(:q => 'kittens').and_return('')
@@ -139,7 +141,7 @@ describe Ansr::Relation do
     # ActiveRecord::QueryMethods.VALID_UNSCOPING_VALUES =>
     # Set.new([:where, :select, :group, :order, :lock, :limit, :offset, :joins, :includes, :from, :readonly, :having])
     it 'should reject bad scope keys' do
-      test = Ansr::Relation.new(Item, Item.table).where(q:'kittens').order("foo DESC")
+      test = subject.where(q:'kittens').order("foo DESC")
       expect { test.unscope(:foo) }.to raise_error
     end
   end
@@ -147,7 +149,7 @@ describe Ansr::Relation do
   describe '#select' do
     describe 'with a block given' do
       it "should build an array" do
-        test = Ansr::Relation.new(Item, Item.table).where(q:'kittens')
+        test = subject.where(q:'kittens')
         @mock_api.should_receive(:items).with(:q => 'kittens').and_return(@kittens)
         actual = test.select {|d| true}
         expect(actual).to be_a(Array)
@@ -159,22 +161,22 @@ describe Ansr::Relation do
     end
     describe 'with a String or Symbol key given' do
       it 'should change the requested document fields' do
-        test = Ansr::Relation.new(Item, Item.table).where(q:'kittens')
-        @mock_api.should_receive(:items).with(:q => 'kittens', :fields=>'name').and_return('')
+        test = subject.where(q:'kittens')
+        @mock_api.should_receive(:items).with(:q => 'kittens', :fields=>:name).and_return('')
         test = test.select('name')
         test.load
       end
     end
     describe 'with a list of keys' do
       it "should add all the requested document fields" do
-        test = Ansr::Relation.new(Item, Item.table).where(q:'kittens')
-        @mock_api.should_receive(:items).with(:q => 'kittens', :fields=>'name,foo').and_return('')
+        test = subject.where(q:'kittens')
+        @mock_api.should_receive(:items).with(:q => 'kittens', :fields=>[:name,:foo]).and_return('')
         test = test.select(['name','foo'])
         test.load
       end
       it "should add all the requested document fields and proxy them" do
-        test = Ansr::Relation.new(Item, Item.table).where(q:'kittens')
-        @mock_api.should_receive(:items).with(:q => 'kittens', :fields=>'object').and_return(@kittens)
+        test = subject.where(q:'kittens')
+        @mock_api.should_receive(:items).with(:q => 'kittens', :fields=>:object).and_return(@kittens)
         test = test.select('object AS my_object')
         test.load
         expect(test.to_a.first['object']).to be_nil
@@ -185,13 +187,13 @@ describe Ansr::Relation do
 
   describe '#limit' do
     it "should add page_size to the query params" do
-      test = Ansr::Relation.new(Item, Item.table).where(q:'kittens')
+      test = subject.where(q:'kittens')
       @mock_api.should_receive(:items).with(:q => 'kittens', :page_size=>17).and_return('')
       test = test.limit(17)
       test.load
     end
     it "should raise an error if limit > 500" do
-      test = Ansr::Relation.new(Item, Item.table).where(q:'kittens')
+      test = subject.where(q:'kittens')
       test = test.limit(500)
       expect {test.load }.to raise_error
     end
@@ -199,13 +201,13 @@ describe Ansr::Relation do
 
   describe '#offset' do
     it "should add page to the query params when page_size is defaulted" do
-      test = Ansr::Relation.new(Item, Item.table).where(q:'kittens')
+      test = subject.where(q:'kittens')
       @mock_api.should_receive(:items).with(:q => 'kittens', :page=>3).and_return('')
       test = test.offset(20)
       test.load
     end
     it 'should raise an error if an offset is requested that is not a multiple of the page size' do
-      test = Ansr::Relation.new(Item, Item.table).where(q:'kittens').limit(12)
+      test = subject.where(q:'kittens').limit(12)
       expect{test.offset(17)}.to raise_error(/^Bad/)
       test.offset(24)
     end
@@ -218,7 +220,7 @@ describe Ansr::Relation do
 
   describe '#loaded?' do
     it 'should be false before and true after' do
-      test = Ansr::Relation.new(Item, Item.table).where(q:'kittens')
+      test = subject.where(q:'kittens')
       @mock_api.stub(:items).with(:q => 'kittens').and_return('')
       expect(test.loaded?).to be_false
       test.load
@@ -240,7 +242,7 @@ describe Ansr::Relation do
 
   describe '#empty?' do
     it 'should not make another call if records are loaded' do
-      test = Ansr::Relation.new(Item, Item.table).where(q:'kittens')
+      test = subject.where(q:'kittens')
       @mock_api.should_receive(:items).with(:q => 'kittens').once.and_return(@empty)
       test.load
       expect(test.loaded?).to be_true

data/ansr_dpla/test/system.rb

@@ -5,7 +5,9 @@ require 'ansr_dpla'
 require 'item'
 
 # you config the model with a hash including an API key for dp.la/v2, or the path to a YAML file
-Item.config('config/dpla.yml')
+open('config/dpla.yml') do |blob|
+  Item.config {|x| x.merge! YAML.load(blob)}
+end
 
 # then you can find single items with known IDs
 puts Item.find("7eb617e559007e1ad6d95bd30a30b16b")
@@ -22,7 +24,7 @@ rel.to_a
 # the limit decorator adds a page size limit
 # the offset decorator adds a non-zero starting point in the response set
 # the filter decorator adds filter/facet fields and optionally values to query them on
-rel = Item.where(q: 'kittens').limit(2).filter('sourceResource.contributor').select('sourceResource.title')
+rel = Item.where(q: 'kittens').limit(2).facet('sourceResource.contributor').select('sourceResource.title')
 rel.to_a.each do |item|
   puts "#{item["id"]} \"#{item['sourceResource.title']}\""
 end

data/lib/ansr.rb

@@ -1,14 +1,21 @@
 require 'active_support'
+require 'active_record'
 module Ansr
   extend ActiveSupport::Autoload
   eager_autoload do
     autoload :Configurable
+    autoload :ConnectionAdapters
+    autoload :DummyAssociations
     autoload :Arel
+    autoload :Facets
     autoload :Base
     autoload :Model
     autoload :Sanitization
     autoload :Relation
+    autoload :OpenStructWithHashAccess, 'ansr/utils'
     autoload_under 'relation' do
+      autoload :Group
+      autoload :PredicateBuilder
       autoload :ArelMethods
       autoload :QueryMethods
     end

data/lib/ansr/arel.rb

@@ -1,5 +1,8 @@
 module Ansr
   module Arel
+  	autoload :ConfiguredField, 'ansr/arel/configured_field'
     require 'ansr/arel/big_table'
+    require 'ansr/arel/nodes'
+    require 'ansr/arel/visitors'
   end
 end

data/lib/ansr/arel/big_table.rb

@@ -1,23 +1,63 @@
+require 'arel'
 module Ansr
   module Arel
   	class BigTable < ::Arel::Table
+      attr_writer :primary_key
       attr_reader :fields, :facets, :sorts
 
-      include Ansr::Configurable
 
       attr_reader :klass
       alias :model :klass
 
+      def self.primary_key
+        @primary_key ||= 'id'
+      end
+
+      def self.primary_key=(key)
+        @primary_key = key
+      end
+
       def initialize(klass, engine=nil)
         super(klass.name, engine.nil? ? klass.engine : engine)
         @klass = klass.model
         @fields = []
         @facets = []
         @sorts = []
+        @field_configs = {}
+      end
+
+      def primary_key
+        @primary_key ||= self.class.primary_key
       end
 
-      def view?
-        Ansr::Model::ViewProxy === model()
+      def [] name
+        name = (name.respond_to? :name) ? name.name.to_sym : name.to_sym
+        (@field_configs.include? name) ? Ansr::Arel::ConfiguredField.new(self, name, @field_configs[name]) : ::Arel::Attribute.new( self, name)
+      end
+
+      def configure_fields
+        if block_given?
+          yield @field_configs
+        end
+        @field_configs
+      end
+      def fields
+        if block_given?
+          yield @fields
+        end
+        @fields
+      end
+      def facets
+        if block_given?
+          yield @facets
+        end
+        @facets
+      end
+      def sorts
+        if block_given?
+          yield @sorts
+        end
+        @sorts
       end
     end
   end

data/lib/ansr/arel/configured_field.rb

@@ -0,0 +1,19 @@
+module Ansr::Arel
+  class ConfiguredField < ::Arel::Attributes::Attribute
+  	attr_reader :config
+  	def initialize(relation, name, config={})
+  		super(relation, name)
+  		@config = {local: {}, query: {}}.merge(config)
+  	end
+    def query
+      @config[:query]
+    end
+    def local
+      @config[:local]
+    end
+    def method_missing(method, *args)
+      @config[method] = args if args.first
+      @config[method]
+    end
+  end
+end

data/lib/ansr/arel/nodes.rb

@@ -0,0 +1,41 @@
+module Ansr::Arel::Nodes
+  class ConfiguredUnary < ::Arel::Nodes::Node
+    attr_reader :expr, :opts
+
+    def initialize(expr, opts={})
+      @expr = expr
+      @opts = opts
+    end
+
+    def method_missing(method, *args)
+      @opts[method] = args if args.first
+      @opts[method]
+    end
+
+  end
+
+  class Facet < ConfiguredUnary
+
+    def order(*val)
+      if val.first
+        val = val.first.downcase.to_sym if String === val
+        @opts[:order] = val if val == :asc or val == :desc
+      end
+      @opts[:order]
+    end
+
+    def prefix(*val)
+      @opts[:prefix] = val.first.to_s if val.first
+      @opts[:prefix]
+    end
+
+    def limit(*val)
+      @opts[:limit] = val.first.to_s if val.first
+      @opts[:limit]
+    end
+  end
+  class Filter < ConfiguredUnary; end
+  class Highlight < ConfiguredUnary; end
+  class ProjectionTraits < ConfiguredUnary; end
+  class Spellcheck < ConfiguredUnary; end
+end