ddr-models 2.4.0.rc5 → 2.4.0.rc6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a57bdb43e8f09d8bba57f543fa677e6f584d49e0
-  data.tar.gz: aaf3160fc9732099da710cff89d874701f2c9432
+  metadata.gz: 41cc8abee7e422452e72bf103a639f2fd8c9b12f
+  data.tar.gz: 2500d3facc196eeeb47deb8a31f01bc89c4d9b97
 SHA512:
-  metadata.gz: dbb52a96b1ea4168b8bc8a0d7cc813b425b3e407f9ce5a13d1a330a176c1684e039c3195182bf615f3199d13fc8465b3765dbc97c95bc6be47822feba9fbb7a1
-  data.tar.gz: d8f17c7f174c712105de7c53a6107fafb216fb6121655b9e439adeb886cf359f8c524edd06a7a9e2123e252ee0a05a2408fba4da5e2ee66762c3fc4561ce2bbc
+  metadata.gz: 0d1a0070f6099ca82a7f134eef231dfa14226c0829d076f70baa6505ef380d1381da691fcedc6bba135eff0a8007071ae4870cfc5d084af700105d1b29617701
+  data.tar.gz: 95f8776c042c8612a2ab9bac5268daed97b80498c69cfbf4bfaffe90e36989b38b91d54e784b13667e24a21093b3fc1515984c9cd76a6837c953a362c295414a

data/ddr-models.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
   s.add_dependency "cancancan", "~> 1.12"
   s.add_dependency "ddr-antivirus", "~> 2.1.1"
   s.add_dependency "virtus", "~> 1.0.5"
+  s.add_dependency "hashie", "~> 3.4.3"
 
   s.add_development_dependency "bundler", "~> 1.11"
   s.add_development_dependency "rake"

data/lib/ddr/index.rb

@@ -4,6 +4,7 @@ module Ddr
 
     autoload :AbstractQueryResult
     autoload :Connection
+    autoload :CSVOptions
     autoload :CSVQueryResult
     autoload :DocumentBuilder
     autoload :Field
@@ -18,6 +19,7 @@ module Ddr
     autoload :QueryParams
     autoload :QueryResult
     autoload :Response
+    autoload :SolrCSVOptions
     autoload :SortOrder
     autoload :UniqueKeyField
 

data/lib/ddr/index/abstract_query_result.rb

@@ -6,7 +6,7 @@ module Ddr::Index
     delegate :params, to: :query
 
     def initialize(query)
-      @query = query
+      @query = query.dup.freeze
       @conn = Connection.new
     end
 

data/lib/ddr/index/csv_options.rb

@@ -0,0 +1,14 @@
+require "csv"
+require "hashie"
+
+module Ddr::Index
+  class CSVOptions < Hashie::Dash
+
+    property :headers,        default: CSV::DEFAULT_OPTIONS[:headers]
+    property :return_headers, default: true
+    property :write_headers,  default: true
+    property :col_sep,        default: CSV::DEFAULT_OPTIONS[:col_sep]
+    property :quote_char,     default: CSV::DEFAULT_OPTIONS[:quote_char]
+
+  end
+end

data/lib/ddr/index/csv_query_result.rb

@@ -4,57 +4,64 @@ module Ddr::Index
   class CSVQueryResult < AbstractQueryResult
 
     MAX_ROWS = 10**8
+    MV_SEP   = ";"
 
-    COL_SEP    = CSV::DEFAULT_OPTIONS[:col_sep].freeze
-    QUOTE_CHAR = CSV::DEFAULT_OPTIONS[:quote_char].freeze
+    attr_reader :mv_sep
 
-    SOLR_CSV_OPTS = {
-      "csv.header"       => "false",
-      "csv.mv.separator" => ";",
-      "wt"               => "csv",
-    }.freeze
+    delegate :read, :each, to: :csv
 
-    CSV_OPTS = {
-      return_headers: true,
-      write_headers:  true,
-    }.freeze
-
-    attr_reader :csv_opts, :solr_csv_opts
-
-    def initialize(query, **opts)
+    def initialize(query, mv_sep: MV_SEP)
       super(query)
+      @mv_sep = mv_sep
+    end
+
+    def csv
+      CSV.new(data, csv_opts.to_h)
+    end
 
-      @solr_csv_opts = SOLR_CSV_OPTS.dup
-      @solr_csv_opts[:rows] ||= MAX_ROWS
+    def to_s
+      read.to_csv
+    end
 
-      @csv_opts = CSV_OPTS.dup
-      @csv_opts[:headers] = query.fields.map(&:label)
+    def rows
+      query.rows || MAX_ROWS
+    end
 
-      # Set column separator and quote character consistently
-      @csv_opts[:col_sep]    = @solr_csv_opts["csv.separator"]    = opts.fetch(:col_sep, COL_SEP)
-      @csv_opts[:quote_char] = @solr_csv_opts["csv.encapsulator"] = opts.fetch(:quote_char, QUOTE_CHAR)
+    def csv_opts
+      @csv_opts ||= CSVOptions.new(headers: csv_headers)
     end
 
-    def csv
-      CSV.new(data, csv_opts)
+    def solr_csv_opts
+      @solr_csv_opts ||= SolrCSVOptions.new(col_sep: csv_opts.col_sep,
+                                            quote_char: csv_opts.quote_char,
+                                            header: solr_csv_header,
+                                            mv_sep: mv_sep,
+                                            rows: rows)
     end
 
-    def each
-      csv.each
+    def headers
+      @headers ||= query.fields.map(&:heading)
     end
 
-    def to_s
-      csv.string
+    def csv_headers
+      if headers.empty?
+        :first_row
+      else
+        headers
+      end
     end
 
-    private
+    def solr_csv_header
+      csv_headers == :first_row
+    end
 
-    def csv_params
-      params.merge(solr_csv_opts)
+    def solr_csv_params
+      params.merge solr_csv_opts.params
     end
 
     def data
-      conn.get "select", params: csv_params
+      raw = conn.get("select", params: solr_csv_params)
+      raw.gsub(/\\#{mv_sep}/, mv_sep)
     end
 
   end

data/lib/ddr/index/field_attribute.rb

@@ -3,7 +3,7 @@ require "virtus"
 module Ddr::Index
   class FieldAttribute < Virtus::Attribute
 
-    def coerce(value)
+    def self.coerce(value)
       case value
       when Field
         value
@@ -14,5 +14,9 @@ module Ddr::Index
       end
     end
 
+    def coerce(value)
+      self.class.coerce(value)
+    end
+
   end
 end

data/lib/ddr/index/filter.rb

@@ -27,6 +27,12 @@ module Ddr::Index
         self
       end
 
+      def where_not(conditions)
+        self.clauses += conditions.map do |field, v|
+          Array(v).map { |value| QueryClause.negative(field, value) }
+        end.flatten
+      end
+
       def absent(field)
         self.clauses << QueryClause.absent(field)
         self
@@ -59,7 +65,7 @@ module Ddr::Index
       delegate Api.public_instance_methods => :new_filter
 
       def has_content
-        where active_fedora_model: [ "Component", "Attachment", "Target" ]
+        model "Component", "Attachment", "Target"
       end
 
       def is_governed_by(object_or_id)
@@ -70,6 +76,10 @@ module Ddr::Index
         term is_member_of_collection: internal_uri(object_or_id)
       end
 
+      def model(*models)
+        where active_fedora_model: models
+      end
+
       private
 
       def internal_uri(object_or_id)

data/lib/ddr/index/query.rb

@@ -15,6 +15,13 @@ module Ddr::Index
     delegate [:count, :docs, :pids, :each_pid, :all] => :result
     delegate :params => :query_params
 
+    def initialize(**args, &block)
+      super(**args)
+      if block_given?
+        build(&block)
+      end
+    end
+
     def inspect
       "#<#{self.class.name} q=#{q.inspect}, filters=#{filters.inspect}," \
       " sort=#{sort.inspect}, rows=#{rows.inspect}, fields=#{fields.inspect}>"
@@ -40,5 +47,10 @@ module Ddr::Index
       QueryParams.new(self)
     end
 
+    def build(&block)
+      QueryBuilder.new(self, &block)
+      self
+    end
+
   end
 end

data/lib/ddr/index/query_builder.rb

@@ -12,6 +12,7 @@ module Ddr::Index
   #
   # asc [field], ...
   #   Adds ascending orderings by the fields specified.
+  #
   #   See also: desc, order_by
   #
   # before [field], [date_time]
@@ -20,10 +21,11 @@ module Ddr::Index
   #
   # before_days [field], [int]
   #   Adds a filter selecting documents where the field has a date/time the
-  #   specified number of days before today (now) or earlier.
+  #     specified number of days before today (now) or earlier.
   #
   # desc [field], ...
   #   Adds descending orderings by the fields specified.
+  #
   #   See also: asc, order_by
   #
   # id [doc_id]
@@ -31,6 +33,7 @@ module Ddr::Index
   #
   # filter [filter1], ...
   #   Adds filters to the query.
+  #
   #   Aliased as: filters
   #
   # filters [filter], ...
@@ -38,7 +41,8 @@ module Ddr::Index
   #
   # field [field1], ...
   #   Adds fields to result documents.
-  #   Note that all fields are returned when none is specified.
+  #     Note that all fields are returned when none is specified.
+  #
   #   Aliased as: fields
   #
   # fields [field], ...
@@ -46,13 +50,19 @@ module Ddr::Index
   #
   # limit [int]
   #   Limits the number of documents returned by the query.
+  #
   #   Aliased as: rows
   #
+  # model [model_name], ...
+  #   Adds a filter selecting document where ActiveFedora model equals value
+  #     or one of the values.
+  #
   # negative [field], [value]
   #   Adds a filter selecting document where field does not have the value.
   #
   # order_by [{field => order, ...}], ...
   #   Adds ordering(s) to the query.
+  #
   #   Aliased as: sort
   #
   # present [field]
@@ -75,8 +85,8 @@ module Ddr::Index
   #
   # where [{field => value, ...}]
   #   Adds a filter of "standard" query clauses.
-  #   Values will be escaped when the filter is serialized.
-  #   If a hash value is an array, that query clause will select documents
+  #     Values will be escaped when the filter is serialized.
+  #     If a hash value is an array, that query clause will select documents
   #     where the field matches any array entry.
   #
   class QueryBuilder
@@ -95,8 +105,8 @@ module Ddr::Index
 
     attr_reader :query
 
-    def initialize(&block)
-      @query = Query.new
+    def initialize(query = nil, &block)
+      @query = query || Query.new
       if block_given?
         instance_eval &block
       end
@@ -120,7 +130,7 @@ module Ddr::Index
     # @param fields [Array<Field>]
     # @return [QueryBuilder] self
     def field(*fields)
-      query.fields += fields
+      query.fields += fields.flatten.map { |f| FieldAttribute.coerce(f) }
       self
     end
     alias_method :fields, :field

data/lib/ddr/index/query_clause.rb

@@ -46,10 +46,11 @@ module Ddr::Index
       alias_method :id, :unique_key
 
       def where(field, value)
-        if value.respond_to?(:each)
-          disjunction(field, value)
+         values = Array(value)
+        if values.size > 1
+          disjunction(field, values)
         else
-          new(field: field, value: value, quote_value: true)
+          new(field: field, value: values.first, quote_value: true)
         end
       end
 
@@ -65,7 +66,7 @@ module Ddr::Index
 
       # Builds a query clause to filter where field is NOT present (no values)
       def absent(field)
-        new(field: "-#{field}", value: ANY_VALUE)
+        new(field: field, value: ANY_VALUE, template: NEGATIVE_QUERY)
       end
 
       # Builds a query clause to filter where field contains at least one of a set of values.

data/lib/ddr/index/solr_csv_options.rb

@@ -0,0 +1,18 @@
+require "hashie"
+
+module Ddr::Index
+  class SolrCSVOptions < Hashie::Trash
+
+    property "csv.header",       from: :header,     default: false
+    property "csv.separator",    from: :col_sep,    default: ","
+    property "csv.encapsulator", from: :quote_char, default: '"'
+    property "csv.mv.separator", from: :mv_sep,     default: ","
+    property :wt,                default: "csv"
+    property :rows
+
+    def params
+      to_h.reject { |k, v| v.nil? }
+    end
+
+  end
+end

data/lib/ddr/models/version.rb

@@ -1,5 +1,5 @@
 module Ddr
   module Models
-    VERSION = "2.4.0.rc5"
+    VERSION = "2.4.0.rc6"
   end
 end

data/spec/index/filter_spec.rb

@@ -54,7 +54,23 @@ module Ddr::Index
       end
       describe ".has_content" do
         subject { described_class.has_content }
-        its(:clauses) { are_expected.to eq([QueryClause.where(:active_fedora_model, ["Component", "Attachment", "Target"])]) }
+        its(:clauses) {
+          are_expected.to eq([QueryClause.where(:active_fedora_model, ["Component", "Attachment", "Target"])])
+        }
+      end
+      describe ".model" do
+        describe "with a single model" do
+          subject { described_class.model("Component") }
+          its(:clauses) {
+            are_expected.to eq([QueryClause.where(:active_fedora_model, "Component")])
+          }
+        end
+        describe "with a list of models" do
+          subject { described_class.model("Component", "Attachment", "Target") }
+          its(:clauses) {
+            are_expected.to eq([QueryClause.where(:active_fedora_model, ["Component", "Attachment", "Target"])])
+          }
+        end
       end
       describe ".where" do
         subject { described_class.where("foo"=>"bar", "spam"=>"eggs", "stuff"=>["dog", "cat", "bird"]) }
@@ -95,7 +111,7 @@ module Ddr::Index
 
     describe "API methods" do
       describe "#where" do
-        it "adds raw query filters for the hash of conditions" do
+        it "adds query clauses for the hash of conditions" do
           subject.where("foo"=>"bar", "spam"=>"eggs", "stuff"=>["dog", "cat", "bird"])
           expect(subject.clauses).to eq([QueryClause.where("foo", "bar"),
                                          QueryClause.where("spam", "eggs"),
@@ -103,6 +119,17 @@ module Ddr::Index
                                         ])
         end
       end
+      describe "#where_not" do
+        it "adds negative query clauses for the hash of conditions" do
+          subject.where_not("foo"=>"bar", "spam"=>"eggs", "stuff"=>["dog", "cat", "bird"])
+          expect(subject.clauses).to eq([QueryClause.negative("foo", "bar"),
+                                         QueryClause.negative("spam", "eggs"),
+                                         QueryClause.negative("stuff", "dog"),
+                                         QueryClause.negative("stuff", "cat"),
+                                         QueryClause.negative("stuff", "bird")
+                                        ])
+        end
+      end
       describe "#raw" do
         it "adds the query clauses w/o escaping" do
           subject.raw("foo:bar", "spam:eggs")

data/spec/index/query_clause_spec.rb

@@ -43,7 +43,11 @@ module Ddr::Index
           subject { described_class.where("foo", "Jungle Fever") }
           its(:to_s) { is_expected.to eq "foo:\"Jungle Fever\"" }
         end
-        describe "when the value is an array" do
+        describe "when the value is an Array with one entry" do
+          subject { described_class.where("foo", ["Jungle Fever"]) }
+          its(:to_s) { is_expected.to eq "foo:\"Jungle Fever\"" }
+        end
+        describe "when the value is an array with multiple entries" do
           subject { described_class.where("foo", ["Jungle Fever", "bar"]) }
           its(:to_s) { is_expected.to eq "{!lucene q.op=OR df=foo}\"Jungle Fever\" bar" }
         end

data/spec/index/query_spec.rb

@@ -1,26 +1,48 @@
 module Ddr::Index
   RSpec.describe Query do
 
-    let(:id) { UniqueKeyField.instance }
-    let(:foo) { Field.new("foo") }
-    let(:spam) { Field.new("spam") }
-    let(:filter) { Filter.where(spam=>"eggs") }
-    let(:sort_order) { SortOrder.new(field: foo, order: "asc") }
-    let(:fields) { [id, foo, spam] }
+    describe "initialized with attributes" do
+      let(:id) { UniqueKeyField.instance }
+      let(:foo) { Field.new("foo") }
+      let(:spam) { Field.new("spam") }
+      let(:filter) { Filter.where(spam=>"eggs") }
+      let(:sort_order) { SortOrder.new(field: foo, order: "asc") }
+      let(:fields) { [id, foo, spam] }
 
-    subject {
-      described_class.new(q: "foo:bar",
-                          filters: [filter],
-                          fields: fields,
-                          sort: sort_order,
-                          rows: 50)
-    }
+      subject {
+        described_class.new(q: "foo:bar",
+                            filters: [filter],
+                            fields: fields,
+                            sort: sort_order,
+                            rows: 50)
+      }
+
+      its(:to_s) {
+        is_expected.to eq "q=foo%3Abar&fq=spam%3Aeggs&fl=id%2Cfoo%2Cspam&sort=foo+asc&rows=50"
+      }
+      its(:params) {
+        is_expected.to eq({q: "foo:bar", fl: "id,foo,spam", fq: ["spam:eggs"], sort: "foo asc", rows: 50})
+      }
+    end
+
+    describe "initialized with a block" do
+      subject {
+        described_class.new do
+          q "foo:bar"
+          where "spam"=>"eggs"
+          fields :id, "foo", "spam"
+          asc "foo"
+          limit 50
+        end
+      }
+
+      its(:to_s) {
+        is_expected.to eq "q=foo%3Abar&fq=spam%3Aeggs&fl=id%2Cfoo%2Cspam&sort=foo+asc&rows=50"
+      }
+      its(:params) {
+        is_expected.to eq({q: "foo:bar", fl: "id,foo,spam", fq: ["spam:eggs"], sort: "foo asc", rows: 50})
+      }
+    end
 
-    its(:to_s) {
-      is_expected.to eq "q=foo%3Abar&fq=spam%3Aeggs&fl=id%2Cfoo%2Cspam&sort=foo+asc&rows=50"
-    }
-    its(:params) {
-      is_expected.to eq({q: "foo:bar", fl: "id,foo,spam", fq: ["spam:eggs"], sort: "foo asc", rows: 50})
-    }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ddr-models
 version: !ruby/object:Gem::Version
-  version: 2.4.0.rc5
+  version: 2.4.0.rc6
 platform: ruby
 authors:
 - Jim Coble
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-18 00:00:00.000000000 Z
+date: 2016-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -227,6 +227,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -463,6 +477,7 @@ files:
 - lib/ddr/index.rb
 - lib/ddr/index/abstract_query_result.rb
 - lib/ddr/index/connection.rb
+- lib/ddr/index/csv_options.rb
 - lib/ddr/index/csv_query_result.rb
 - lib/ddr/index/document_builder.rb
 - lib/ddr/index/field.rb
@@ -477,6 +492,7 @@ files:
 - lib/ddr/index/query_params.rb
 - lib/ddr/index/query_result.rb
 - lib/ddr/index/response.rb
+- lib/ddr/index/solr_csv_options.rb
 - lib/ddr/index/sort_order.rb
 - lib/ddr/index/unique_key_field.rb
 - lib/ddr/jobs.rb