feedx 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93c6d8da8f0485d4cde2b935d55d176bd85265ed2983d5fda8b86e229635c666
-  data.tar.gz: 0d32c1595c97c42937bbdb8765da4347d8041fc6e4db8c335a88a26c715eed02
+  metadata.gz: 88ccb5e67e8ad202fab870bea54b8ff04c26b644fa3f8e07f8aa3b0c09a75351
+  data.tar.gz: b832b9867141506986402d5a091f0c35528ee739ea624e7616e7e018748c0cd1
 SHA512:
-  metadata.gz: 689dd5925778d4895cd1dbfd35bf717070dbfdbe4fe3c831d01108ccef637fb1eaeb1166945b152393cff653f71426dbdd326de78633b6ed4aab36640e11693e
-  data.tar.gz: ea603ed38643a9484875d626ff9be7b42ae0a56f20e7a85ccdcbb0ca8101846084bfc4cdb4373793df3d4be36ca31eb92e0351186c85712937d88f1b46677e07
+  metadata.gz: 4e9df1a95a2821b882c6eed8e0d7b36532bb734b43405eb5e90c24984b8c7a0ef5fa4f7f8b35fd371a7ce724ce00e6d9a6174753ae552340773e9367024b8fce
+  data.tar.gz: 9e2d6714753f66eb2976a591eaf95a1b7caa4476e404d5622820de824bc7212e182b8d3b6cac0ae50cc5b2a6bcfd1cc4c2ab94e1a36b20b99563bae957969a45

data/.rubocop.yml

@@ -1,5 +1,2 @@
 inherit_from:
-  - https://storage.googleapis.com/bsm-misc/rubocop.yml?1541767352
-
-AllCops:
-  TargetRubyVersion: "2.2"
+  - https://bitbucket.org/bsm/misc/raw/master/rubocop/default.yml

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    feedx (0.1.0)
+    feedx (0.2.0)
       bfs
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
-    bfs (0.2.2)
+    bfs (0.3.2)
     diff-lcs (1.3)
     google-protobuf (3.6.1)
     jaro_winkler (1.5.1)

data/feedx.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'feedx'
-  s.version       = '0.1.0'
+  s.version       = '0.2.0'
   s.authors       = ['Black Square Media Ltd']
   s.email         = ['info@blacksquaremedia.com']
   s.summary       = %(Exchange data between components via feeds)

data/lib/feedx/pusher.rb

@@ -4,13 +4,22 @@ require 'bfs'
 module Feedx
   # Pushes a relation as a protobuf encoded stream to an S3 location.
   class Pusher
-    # @param [Enumerable,ActiveRecord::Relation] relation to stream.
+    # See constructor.
+    def self.perform(url, opts={}, &block)
+      new(url, opts, &block).perform
+    end
+
     # @param [String] url the destination URL.
     # @param [Hash] opts options
+    # @option opts [Enumerable,ActiveRecord::Relation] :enum relation or enumerator to stream.
     # @option opts [Symbol,Class<Feedx::Format::Abstract>] :format custom formatter. Default: from file extension.
     # @option opts [Symbol,Class<Feedx::Compression::Abstract>] :compress enable compression. Default: from file extension.
-    def initialize(relation, url, opts={})
-      @relation = relation
+    # @yield A block factory to generate the relation or enumerator.
+    # @yieldreturn [Enumerable,ActiveRecord::Relation] the relation or enumerator to stream.
+    def initialize(url, opts={}, &block)
+      @enum = opts[:enum] || block
+      raise ArgumentError, "#{self.class.name}.new expects an :enum option or a block factory" unless @enum
+
       @blob     = BFS::Blob.new(url)
       @format   = detect_format(opts[:format])
       @compress = detect_compress(opts[:compress])
@@ -54,9 +63,10 @@ module Feedx
     end
 
     def write_to(io)
-      stream = @format.new(io)
-      enum = @relation.respond_to?(:find_each) ? :find_each : :each
-      @relation.send(enum) {|rec| stream.write(rec) }
+      stream   = @format.new(io)
+      relation = @enum.is_a?(Proc) ? @enum.call : @enum
+      iterator = relation.respond_to?(:find_each) ? :find_each : :each
+      relation.send(iterator) {|rec| stream.write(rec) }
     end
   end
 end

data/spec/feedx/pusher_spec.rb

@@ -13,8 +13,8 @@ RSpec.describe Feedx::Pusher do
     end
   end
 
-  let :relation do
-    %w[x y z].map {|_t| model.new('t') } * 100
+  let :enumerable do
+    %w[x y z].map {|t| model.new(t) } * 100
   end
 
   let(:tempdir) { Dir.mktmpdir }
@@ -22,35 +22,39 @@ RSpec.describe Feedx::Pusher do
 
   it 'should reject invalid inputs' do
     expect do
-      described_class.new relation, "file://#{tempdir}/file.txt"
+      described_class.perform "file://#{tempdir}/file.txt", enum: enumerable
     end.to raise_error(/unable to detect format/)
   end
 
   it 'should push compressed JSON' do
-    pusher = described_class.new relation, "file://#{tempdir}/file.jsonz"
-    size   = pusher.perform
-    expect(size).to be_within(20).of(140)
+    size = described_class.perform "file://#{tempdir}/file.jsonz", enum: enumerable
+    expect(size).to be_within(20).of(166)
     expect(File.size("#{tempdir}/file.jsonz")).to eq(size)
   end
 
   it 'should push plain JSON' do
-    pusher = described_class.new relation, "file://#{tempdir}/file.json"
-    size = pusher.perform
+    size = described_class.perform "file://#{tempdir}/file.json", enum: enumerable
     expect(size).to be_within(0).of(15900)
     expect(File.size("#{tempdir}/file.json")).to eq(size)
   end
 
   it 'should push compressed PB' do
-    pusher = described_class.new relation, "file://#{tempdir}/file.pbz"
-    size = pusher.perform
+    size = described_class.perform "file://#{tempdir}/file.pbz", enum: enumerable
     expect(size).to be_within(20).of(41)
     expect(File.size("#{tempdir}/file.pbz")).to eq(size)
   end
 
   it 'should push plain PB' do
-    pusher = described_class.new relation, "file://#{tempdir}/file.pb"
-    size = pusher.perform
+    size = described_class.perform "file://#{tempdir}/file.pb", enum: enumerable
     expect(size).to be_within(0).of(1200)
     expect(File.size("#{tempdir}/file.pb")).to eq(size)
   end
+
+  it 'should support factories' do
+    size = described_class.perform("file://#{tempdir}/file.json") do
+      [model.new('xy')] * 10
+    end
+    expect(size).to be_within(0).of(540)
+    expect(File.size("#{tempdir}/file.json")).to eq(size)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feedx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Black Square Media Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-09 00:00:00.000000000 Z
+date: 2018-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bfs