traject_plus 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 586e90e7cb12df2dce7019884f218d1438a0493f4a982da874b0a566f163fb15
-  data.tar.gz: 1a54f1a1f29fba7669f746266861687836678d376348f796d8442799ec2f8e0f
+  metadata.gz: 9e88950f9930b74cc29eaf7d62b55c255e3f29e471f73abfcdbd7c2456e604bc
+  data.tar.gz: bb058742cce2434abc341dc72cd76928cf856afc149fc681122819fdc9022897
 SHA512:
-  metadata.gz: a72f9d3fab511ca29b2f01995bfca990953c2b28ba3bc9d33a09bc56c2c769c7f665c95776720c51c38278fc781d1beefeba00f21e35009ca442fb7f3e79e44e
-  data.tar.gz: ca6c5f9ab9e060c9883c66f75d061877279cc13288b4832faed6779cf36b107e96e537a36c6a7bafd2f57a605ce3395af49087102487cde446ad56cc2d95e22d
+  metadata.gz: 942616c2a50191ee8a1f30d10fbfb718bade0c99adc9d5181aca0d8087b6fea2f264f36434f0e1341cd03da871cf33cc14e172320d2ba877230cfcab75b352f7
+  data.tar.gz: f5063714eac2c658c34d99ce8a7ce22d8ed45bef54ffe16945305f794034963e411b8e9c6f046867a8e90c3f9e4fffac900d32bab4dc67669cbaac7d4da9b732

data/lib/traject_plus/extraction.rb

@@ -4,6 +4,7 @@ require 'active_support/core_ext/object/blank'
 require 'deprecation'
 
 module TrajectPlus
+  # @deprecated because Traject 3 can do this for us.
   module Extraction
     def self.apply_extraction_options(result, options = {})
       TransformPipeline.new(options).transform(result)

data/lib/traject_plus/macros/csv.rb

@@ -10,6 +10,9 @@ module TrajectPlus
         lambda do |row, accumulator, _context|
           return if row[header_or_index].to_s.empty?
           result = Array(row[header_or_index].to_s)
+          unless options.empty?
+            Deprecation.warn(self, "passing options to column is deprecated and will be removed in the next major release. Use the Traject 3 pipeline instead")
+          end
           result = TrajectPlus::Extraction.apply_extraction_options(result, options)
           accumulator.concat(result)
         end

data/lib/traject_plus/macros/json.rb

@@ -12,6 +12,9 @@ module TrajectPlus
         lambda do |json, accumulator, _context|
           result = Array(JsonPath.on(json, path))
           result = TrajectPlus::Extraction.apply_extraction_options(result, options)
+          unless options.empty?
+            Deprecation.warn(self, "passing options to extract_json is deprecated and will be removed in the next major release. Use the Traject 3 pipeline instead")
+          end
           accumulator.concat(result)
         end
       end

data/lib/traject_plus/macros/xml.rb

@@ -10,6 +10,9 @@ module TrajectPlus
       def extract_xml(xpath, namespaces, options = {})
         lambda do |xml, accumulator, _context|
           result = xml.xpath(xpath, namespaces).map(&:text)
+          unless options.empty?
+            Deprecation.warn(self, "passing options to extract_xml is deprecated and will be removed in the next major release. Use the Traject 3 pipeline instead")
+          end
           result = TrajectPlus::Extraction.apply_extraction_options(result, options)
           accumulator.concat(result)
         end

data/lib/traject_plus/macros.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
+
+require 'deprecation'
+
 module TrajectPlus
   module Macros
+    extend Deprecation
+
     # construct a structured hash using values extracted using traject
     def transform_values(context, hash)
       hash.transform_values do |lambdas|
@@ -51,10 +56,9 @@ module TrajectPlus
     end
 
     def transform(options = {})
-      lambda do |record, accumulator, context|
-        results = TrajectPlus::Extraction.apply_extraction_options(accumulator, options)
-        accumulator.replace(results)
-      end
+      return deprecated_transform(options) unless block_given?
+
+      super() # These empty parens are meaningful, otherwise it'll pass options.
     end
 
     # apply the same mapping to multiple fields
@@ -63,6 +67,9 @@ module TrajectPlus
     end
 
     def to_field(field_name, *procs, extract: nil, transform: nil, **namedArgs, &block)
+      if transform || extract
+        Deprecation.warn(self, "Passing extract or transform arguments to to_field is deprecated. Use the Traject 3 pipeline instead.")
+      end
       procs =  [extract, transform] if procs.empty?
       @index_steps << TrajectPlus::Indexer::ToFieldStep.new(field_name, procs, block, Traject::Util.extract_caller_location(caller.first), **namedArgs)
     end
@@ -78,5 +85,15 @@ module TrajectPlus
 
       @index_steps << TrajectPlus::Indexer::ComposeStep.new(fieldname, extract || aLambda, transform, Traject::Util.extract_caller_location(caller.first), indexer)
     end
+
+    private
+
+    def deprecated_transform(options)
+      Deprecation.warn(self, "transform is deprecated and will be removed in the next major release. Use the Traject 3 pipeline instead")
+      lambda do |record, accumulator, context|
+        results = TrajectPlus::Extraction.apply_extraction_options(accumulator, options)
+        accumulator.replace(results)
+      end
+    end
   end
 end

data/lib/traject_plus/version.rb

@@ -1,3 +1,3 @@
 module TrajectPlus
-  VERSION = "1.0.0"
+  VERSION = "1.1.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: traject_plus
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris Beer
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-26 00:00:00.000000000 Z
+date: 2019-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport