lazier_data 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c23efda68aba293371fd76e5a8ce33b7b9826b18fb580f863a2aa0dd4167214f
-  data.tar.gz: 3cdc7f4cc2f6bfd502f73f1ff51722a0e5085f9b372967878e35e6fa4b612a34
+  metadata.gz: 5c57f03c689415868d20b1c1be957564aa4e3b2517aae7dd9d8b51ca24f655f9
+  data.tar.gz: b620c052b871cf8d68d945baea968d834856791e564052f6b26276ab9fd867b7
 SHA512:
-  metadata.gz: '098d51524372436ba513efc67ced6f6f7ed7f9adfefc261b67adda298383e77fac9aab9f5acdc10c811fc1c24012dbb0702c852b0e3f8b16299d215337d5314c'
-  data.tar.gz: 2436fbd078e94e17269b081f3a4c8c9dcf16e981326880796c7670ed143a3e7bf50985d3eafac7169e026482ee5247c0198619c62d06f6f71a1b2990a36ad5a5
+  metadata.gz: 030f3f706f1b6dacaa8778d7619a8f25b015138799cb90921d3ce5471ae2f2315b6e0382656c0f1198c4c304bd554495846d078323e445c458e60c424ee75fce
+  data.tar.gz: 91bdc0898cc4e93958f0fb40d9fb5b1700b12b8fc1a7eb06ec9a6d3d95990d84611124295bb11b660d4740ee2c9d826c1c7352a130681c423397a9a27062b1e0

data/README.md

@@ -1,28 +1,107 @@
-# BetterBatch
+# LazierData
 
-TODO: Delete this and the text below, and describe your gem
+The incredible productivity of massive laziness.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/better_batch`. To experiment with that code, run `bin/console` for an interactive prompt.
+LazierData allows splitting, filtering, transforming, batching, and basically everything else you might want to do with data. LazierData processing _looks like_ multiple full iterations of the input data, but under the hood it will process incrementally.
 
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+LazierData guarantees each row of input data will be processed by steps in the order the steps are defined. This means not only does LazierData processing _look like_ each step is happening in order, but you can generally think about your data that way.
 
-Install the gem and add to the application's Gemfile by executing:
+## Installation
 
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+In your Gemfile:
+```ruby
+source 'https://rubygems.org'
+gem 'lazier_data'
 ```
+Then:
+`bundle`
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Usage
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+# inputs are anything that can be iterated with .each
+lazier = LazierData.new(inputs)
+
+# transform
+lazier.enum do |input, clean_inputs|
+  clean_inputs << input.except(:unwanted_field)
+end
+
+# LazierData uses the parameter name from your previous block
+# to allow further processing
+# lets filter our clean inputs
+lazier[:clean_inputs].enum do |input, filtered_inputs|
+  filtered_inputs << input unless input[:skip_me]
+end
+
+# let's say our inputs have multiple types
+# that need to be handled differently
+lazier[:clean_inputs][:filtered_inputs].enum do |input, type_a, type_b|
+  case input[:type]
+  when :a
+  	type_a << input
+  when :b
+  	type_b << input
+  end
+end
+
+# LazierData puts the results of your previous steps
+# in the corresponding places according to your block params
+type_a = lazier[:clean_inputs][:filtered_inputs][:type_a]
+type_b = lazier[:clean_inputs][:filtered_inputs][:type_b]
+
+# we can now process each type separately
+type_a.each_slice(1000) do |batch_a|
+  ModelA.upsert_all(
+    batch_a,
+    unique_by: %i[unique_field1 unique_field2]
+  )
+end
+type_b.each_slice(1000) do |batch_b|
+  ModelB.upsert_all(
+    batch_b,
+    unique_by: %i[unique_field3 unique_field4]
+  )
+end
+
+# we can also pull sub items off the inputs
+# note that in this example we're taking sub_items from all inputs
+# instead of lazier[:clean_inputs][:filtered_inputs].enum do ...
+# while it may look like we're reprocessing the entire input list
+# under the hood LazierData will pass each item through each step
+lazier.enum do |input, sub_items|
+  # the below is shorthand for:
+  # input[:sub_items].each { |sub_item| sub_items << sub_item }
+  input[:sub_items].each(&sub_items)
+end
+
+# you can mutate items directly
+lazier[:sub_items].each do |sub_item|
+  sub_item[:other_data] = fetch_other_data
+  sub_item[:mutated] = true
+end
+
+# items are guaranteed to have passed through previous steps
+# before reaching later steps
+lazier[:sub_items].each_slice(1000) do |sub_items|
+  if sub_items.any? { |sub_item| !sub_item[:mutated] }
+  	# this will never happen :)
+  	raise 'LazierData failed me!'
+  end
+
+  SubItem.upsert_all(
+  	sub_items,
+  	unique_by: %i[unique_sub_item_field]
+  )
+end
+
+# at this point in the code
+# none of the above has actually happened
+# so, finally, we actually go
+lazier.go
 ```
 
-## Usage
-
-TODO: Write usage instructions here
+See [lazier_data_spec.rb](spec/lazier_data_spec.rb) for proven examples.
 
 ## Development
 

data/lib/lazier_data/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class LazierData
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: lazier_data
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tyler Hartland
 bindir: exe
 cert_chain: []
-date: 2025-04-10 00:00:00.000000000 Z
+date: 2025-04-11 00:00:00.000000000 Z
 dependencies: []
 description: 'Allows setting up data processing that works intuitively, but behind
   the secenes processes lazily.
@@ -32,13 +32,13 @@ files:
 - lib/lazier_data/item_store.rb
 - lib/lazier_data/processor.rb
 - lib/lazier_data/version.rb
-homepage: https://github.com/th7/lazier
+homepage: https://github.com/th7/lazier_data
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/th7/lazier
-  source_code_uri: https://github.com/th7/lazier
+  homepage_uri: https://github.com/th7/lazier_data
+  source_code_uri: https://github.com/th7/lazier_data
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: