jsonl_reader_writer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec02c52057118cbb7551ad488d1f93984accb2d4a08e6ed433f7cf23475bc59e
+  data.tar.gz: 8654deef936ac24154e1a044ecd713100aebeb734f2dc4b71b05faad51a0a5be
+SHA512:
+  metadata.gz: 901123e04f267482079665b587fc77ddf59fffa76acf4dcd791ffa53eefeef21ee740bad650b2ab1f7abf9726729fbc4ca44796aef9ad30368054b71a00d9022
+  data.tar.gz: c4d10dc0f1f911130c7349ec013dea3923c4f1961c95ccfa813207506dcca444ecf468f4ae4a0a22f0d6bd0c0c5a36f1d8b4625e0cfc16a2bac607befbcdaf40

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsonl_reader_writer.gemspec
+gemspec
+
+# Add any additional gems needed for development here.
+# For example, you might use 'pry' for debugging or 'rspec' for testing.
+group :development, :test do
+  gem 'rspec'
+  gem 'pry'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 katsuya tanaka
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# JSONL Reader Writer
+
+`jsonl_reader_writer` is a Ruby gem that provides utilities for reading, mapping, filtering, and writing JSON Lines formatted files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonl_reader_writer'
+```
+And then execute:
+```
+$ bundle install
+```
+
+Or install it yourself as:
+```
+$ gem install jsonl_reader_writer
+```
+
+## Usage
+```ruby
+require 'jsonl_reader_writer'
+
+# Create a reader instance
+reader = JsonlReaderWriter::Reader.new('/path/to/your/jsonl_file.jsonl')
+
+# Read and print each line
+reader.each do |data, line_number|
+  puts "Line #{line_number + 1}: #{data}"
+end
+
+# Filter the data
+filtered_data = reader.filter do |data|
+  data['some_key'] == 'some_value'
+end
+
+# Map the data
+mapped_data = reader.map do |data|
+  data['some_key']
+end
+
+# Create a writer instance
+writer = JsonlReaderWriter::Writer.new('/path/to/your/output_file.jsonl')
+
+# Write data
+writer.write({ some_key: 'some_value' })
+
+# Write multiple records
+records = [
+  { record_1_key: 'record_1_value' },
+  { record_2_key: 'record_2_value' },
+]
+writer.write(records)
+
+# Write data with validation
+writer.write({ some_key: 'some_value' }, validate: true)
+
+```
+
+## Development
+After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/your_username/jsonl_reader_writer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
+
+## License
+The gem is available as open source under the terms of the MIT License.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/jsonl_reader_writer.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |spec|
+  spec.name          = "jsonl_reader_writer"
+  spec.version       = "0.1.0"
+  spec.authors       = "ka2yatanaka"
+  spec.email         = "katwoya513@gmail.com"
+
+  spec.summary       = %q{JSON Lines file reader and writer for Ruby.}
+  spec.description   = %q{This gem provides utilities for reading, filtering, mapping, and writing JSON Lines formatted files in Ruby.}
+  spec.homepage      = "https://github.com/ka2-ya/jsonl_reader_writer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.add_dependency "json", ">= 2.0"
+end

data/lib/jsonl_reader_writer/reader.rb

@@ -0,0 +1,56 @@
+require 'json'
+
+module JsonlReaderWriter
+  # Reader class: Provides methods to read and process .jsonl files
+  class Reader
+    # initialize method: Takes a file path as an argument, and validates that the file is a .jsonl file
+    def initialize(file_path)
+      @file_path = file_path
+      validate_file_extension
+    end
+
+    # each method: Opens the file, reads each line, parses it as JSON, and yields it along with its index
+    # If there's an error parsing a line, it rescues the exception and prints an error message
+    def each
+      File.open(@file_path, 'r') do |f|
+        f.each_line.with_index do |line, index|
+          begin
+            yield JSON.parse(line.chomp), index
+          rescue => e
+            puts "Error parsing line #{index + 1}: #{e.message}"
+          end
+        end
+      end
+    end
+
+    # filter method: Iterates over each line in the file and adds it to an array if it meets the condition specified in the block
+    def filter(&block)
+      filtered_data = []
+
+      each do |data, line_number|
+        filtered_data << data if block.call(data)
+      end
+
+      filtered_data
+    end
+
+    # map method: Iterates over each line in the file and adds the result of the block operation to an array
+    def map(&block)
+      mapped_data = []
+
+      each do |data, line_number|
+        mapped_data << block.call(data)
+      end
+
+      mapped_data
+    end
+
+    private
+      # validate_file_extension method: Checks if the file is a .jsonl file. If not, it raises an ArgumentError
+      def validate_file_extension
+        unless @file_path.end_with?('.jsonl')
+          raise ArgumentError, 'File must be a .jsonl file'
+        end
+      end
+  end
+end

data/lib/jsonl_reader_writer/writer.rb

@@ -0,0 +1,15 @@
+require 'json'
+
+module JsonlReaderWriter
+  class Writer
+    def initialize(file_path)
+      @file_path = file_path
+    end
+
+    def write(data)
+      File.open(@file_path, 'w') do |f|
+        data.each { |datum| f.puts(JSON.generate(datum)) }
+      end
+    end
+  end
+end

data/lib/jsonl_reader_writer.rb

@@ -0,0 +1,2 @@
+require 'jsonl_reader_writer/reader'
+require 'jsonl_reader_writer/writer'

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: jsonl_reader_writer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ka2yatanaka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: This gem provides utilities for reading, filtering, mapping, and writing
+  JSON Lines formatted files in Ruby.
+email: katwoya513@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jsonl_reader_writer.gemspec
+- lib/jsonl_reader_writer.rb
+- lib/jsonl_reader_writer/reader.rb
+- lib/jsonl_reader_writer/writer.rb
+homepage: https://github.com/ka2-ya/jsonl_reader_writer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.12
+signing_key: 
+specification_version: 4
+summary: JSON Lines file reader and writer for Ruby.
+test_files: []