csv_to_yaml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: efb0d27827ab1b8b65d932e2ab99592df354b85b1c6d2a7dc4a616735524b010
+  data.tar.gz: 92594a121766813967749c4ed1948db796ac13dbafeb843b1abcab2a027e8482
+SHA512:
+  metadata.gz: 267e1d0c52d49b2e3b3dfae5fd82ecfd075f0b6ecd7d5d8af419ad00d6dfa637f0af913f39607eb4211a9be05f421b361d4355bb26e2887c0cebfc9d24662dbc
+  data.tar.gz: 8ac49a1370650e33ebbaec656e38a9bc30a69ba31fc9164fa0984aa3e0acb347f22420d25bf98bb5dff8c76a1dbbe4b627a38708ccfd2f62336eb3bbd76944c2

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-03
+
+### Added
+
+- Initial release of CsvToYaml gem
+- Core functionality to convert CSV files to YAML format
+- Automatic data type inference for integers, floats, booleans, and strings
+- Error handling for empty files and invalid CSV formats
+- Basic documentation including README and this CHANGELOG
+
+### Features
+
+- `CsvToYaml.convert` method to convert CSV files to YAML
+- `CsvToYaml::Converter` class for handling the conversion process
+- Custom error classes: `ConversionError`, `EmptyFileError`, and `InvalidCsvFormatError`
+
+### Dependencies
+
+- Uses standard library modules: CSV and YAML

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Kazuya INOUE
+
+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,63 @@
+# CsvToYaml
+
+CsvToYaml is a Ruby gem that provides an easy way to convert CSV(Comma Separated Values) files to YAML(YAML Ain't Markup Language) format. It handles various data types and attempts to infer and convert them appropriately.
+
+## Features
+
+- Convert CSV files to YAML format
+- Automatic data type inference and conversion
+- Handles empty files and invalid CSV formats
+- Simple and easy-to-use API
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add csv_to_yaml
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install csv_to_yaml
+
+## Usage
+
+Here's a basic example of how to use CsvToYaml:
+
+```ruby
+require 'csv_to_yaml'
+
+# Convert a CSV file to YAML
+CsvToYaml.convert('input.csv', 'output.yaml')
+```
+
+This will read the `input.csv` file, convert its contents to YAML format, and save the result to `output.yaml`.
+
+## Error Handling
+
+CsvToYaml provides specific error classes to handle different scenarios:
+
+```ruby
+begin
+  CsvToYaml.convert('input.csv', 'output.yaml')
+rescue CsvToYaml::EmptyFileError
+  puts "The input file is empty"
+rescue CsvToYaml::InvalidCsvFormatError
+  puts "The input file is not a valid CSV"
+rescue CsvToYaml::ConversionError => e
+  puts "Conversion failed: #{e.message}"
+end
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kazuyainoue0124/csv_to_yaml.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/csv_to_yaml/converter.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module CsvToYaml
+  # Converter class handles the actual conversion from CSV to YAML
+  class Converter
+    # Convert CSV file to YAML file
+    #
+    # @param input_csv [String] Path to input CSV file
+    # @param output_yaml [String] Path to output YAML file
+    # @return [void]
+    # @raise [CsvToYaml::ConversionError] If any error occurs during conversion
+    # @raise [CsvToYaml::EmptyFileError] If the input file is empty
+    # @raise [CsvToYaml::InvalidCsvFormatError] If the input file is not in a valid CSV format
+    def convert(input_csv, output_yaml)
+      validate_csv_format(input_csv)
+      data = read_csv(input_csv)
+      write_yaml(data, output_yaml)
+    rescue EmptyFileError => e
+      raise e
+    rescue InvalidCsvFormatError => e
+      raise e
+    rescue StandardError => e
+      raise ConversionError, "Failed to convert CSV to YAML: #{e.message}"
+    end
+
+    private
+
+    # Validate the format of the input file
+    #
+    # @param file_path [String] Path to the input file
+    # @raise [CsvToYaml::EmptyFileError] If the file is empty
+    # @raise [CsvToYaml::InvalidCsvFormatError] If the file is not a valid CSV
+    def validate_csv_format(file_path)
+      raise EmptyFileError, "Input file '#{file_path}' is empty" if File.zero?(file_path)
+
+      File.open(file_path, "rb") do |file|
+        first_line = file.readline.force_encoding("ASCII-8BIT")
+        unless first_line.include?(",".b)
+          raise InvalidCsvFormatError, "The file content does not appear to be a valid CSV format"
+        end
+      end
+    rescue EOFError
+      raise ConversionError, "The input file is empty or not readable"
+    end
+
+    # Read and parse CSV file
+    #
+    # @param input_csv [String] Path to input CSV file
+    # @return [Array<Hash>] Parsed CSV data
+    def read_csv(input_csv)
+      csv_data = CSV.read(input_csv, headers: true)
+      csv_data.map { |row| convert_types(row.to_h) }
+    end
+
+    # Convert data types
+    #
+    # @param row [Hash] A row of CSV data
+    # @return [Hash] Converted data
+    def convert_types(row)
+      row.each_with_object({}) do |(key, value), new_row|
+        new_row[key] = infer_and_convert_type(value) unless key.nil?
+      end
+    end
+
+    # Infer and convert the type of a value
+    #
+    # @param value [String] The value to convert
+    # @return [Object] The converted value
+    def infer_and_convert_type(value)
+      case value
+      when /\A\d+\z/ then value.to_i
+      when /\A\d+\.\d+\z/ then value.to_f
+      when /\A(true|false)\z/i then value.downcase == "true"
+      else value
+      end
+    end
+
+    # Write data to YAML file
+    #
+    # @param data [Array<Hash>] The data to write
+    # @param output_yaml [String] Path to output YAML file
+    # @return [void]
+    def write_yaml(data, output_yaml)
+      File.open(output_yaml, "w") do |f|
+        f.write(data.to_yaml.sub(/^---\n/, ""))
+      end
+    end
+  end
+end

data/lib/csv_to_yaml/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CsvToYaml
+  # Base error class for CsvToYaml
+  class Error < StandardError; end
+  # Error raised when conversion fails
+  class ConversionError < Error; end
+  # Error raised when the input file is empty or not readable
+  class EmptyFileError < Error; end
+  # Error raised when the input file is not a valid CSV
+  class InvalidCsvFormatError < Error; end
+end

data/lib/csv_to_yaml/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CsvToYaml
+  VERSION = "0.1.0"
+end

data/lib/csv_to_yaml.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "csv_to_yaml/version"
+require_relative "csv_to_yaml/converter"
+require_relative "csv_to_yaml/errors"
+require "csv"
+require "yaml"
+
+# CsvToYaml is a module that provides functionality to convert CSV files to YAML format.
+#
+# This gem allows you to easily transform data from CSV (Comma-Separated Values) format
+# to YAML (YAML Ain't Markup Language) format. It handles various data types and
+# attempts to infer and convert them appropriately.
+#
+# @example Converting a CSV file to YAML
+#   CsvToYaml.convert('input.csv', 'output.yaml')
+#
+# @note This gem assumes that the input CSV file has headers.
+#
+# @see https://github.com/kazuyainoue0124/csv_to_yaml for more information and usage examples.
+module CsvToYaml
+  class << self
+    # Converts a CSV file to YAML format
+    #
+    # @param input_csv [String] Path to the input CSV file
+    # @param output_yaml [String] Path to the output YAML file
+    # @return [void]
+    # @raise [CsvToYaml::ConversionError] If any error occurs during conversion
+    # @raise [CsvToYaml::EmptyFileError] If the input file is empty
+    # @raise [CsvToYaml::InvalidCsvFormatError] If the input file is not in a valid CSV format
+    def convert(input_csv, output_yaml)
+      Converter.new.convert(input_csv, output_yaml)
+    end
+  end
+end

data/spec/csv_to_yaml_spec.rb

@@ -0,0 +1,279 @@
+# frozen_string_literal: true
+
+RSpec.describe CsvToYaml do
+  let(:input_csv) { Tempfile.new(["input", ".csv"]) }
+  let(:output_yaml) { Tempfile.new(["output", ".yml"]) }
+
+  after do
+    input_csv.close
+    input_csv.unlink
+    output_yaml.close
+    output_yaml.unlink
+  end
+
+  it "has a version number" do
+    expect(CsvToYaml::VERSION).not_to be nil
+  end
+
+  describe ".convert" do
+    context "Positive tests" do
+      # Test for valid CSV data conversion
+      context "with valid csv data" do
+        before do
+          input_csv.write(<<~CSV)
+            id,name,age,salary,active
+            1,Alice,30,50000.0,true
+            2,Bob,25,40000.5,false
+            3,Charlie,35,60000.0,true
+          CSV
+          input_csv.rewind
+        end
+
+        it "converts CSV to YAML with correct data types" do
+          described_class.convert(input_csv.path, output_yaml.path)
+          yaml_content = YAML.load_file(output_yaml.path)
+
+          expect(yaml_content).to eq(
+            [
+              { "id" => 1, "name" => "Alice",   "age" => 30, "salary" => 50_000.0, "active" => true },
+              { "id" => 2, "name" => "Bob",     "age" => 25, "salary" => 40_000.5, "active" => false },
+              { "id" => 3, "name" => "Charlie", "age" => 35, "salary" => 60_000.0, "active" => true }
+            ]
+          )
+        end
+      end
+
+      # Test for overwriting existing output file
+      context "when output file already exists" do
+        let(:existing_output) { Tempfile.new(["existing_output", ".yml"]) }
+
+        before do
+          existing_output.write("Existing content\n")
+          existing_output.rewind
+
+          input_csv.write(<<~CSV)
+            id,name
+            1,Alice
+            2,Bob
+          CSV
+          input_csv.rewind
+        end
+
+        after do
+          existing_output.close
+          existing_output.unlink
+        end
+
+        it "overwrites the existing file" do
+          described_class.convert(input_csv.path, existing_output.path)
+          yaml_content = YAML.load_file(existing_output.path)
+
+          expect(yaml_content).to eq(
+            [
+              { "id" => 1, "name" => "Alice" },
+              { "id" => 2, "name" => "Bob" }
+            ]
+          )
+          expect(File.read(existing_output.path)).not_to include("Existing content")
+        end
+      end
+
+      # Test for creating new output file
+      context "when output file does not exist" do
+        let(:non_existent_output) { "non_existent_output.yml" }
+
+        before do
+          input_csv.write(<<~CSV)
+            id,name
+            1,Alice
+            2,Bob
+          CSV
+          input_csv.rewind
+        end
+
+        after do
+          File.delete(non_existent_output) if File.exist?(non_existent_output)
+        end
+
+        it "creates a new file" do
+          expect(File.exist?(non_existent_output)).to be false
+          described_class.convert(input_csv.path, non_existent_output)
+          expect(File.exist?(non_existent_output)).to be true
+
+          yaml_content = YAML.load_file(non_existent_output)
+          expect(yaml_content).to eq(
+            [
+              { "id" => 1, "name" => "Alice" },
+              { "id" => 2, "name" => "Bob" }
+            ]
+          )
+        end
+      end
+
+      # Test for processing large files
+      context "with large CSV file" do
+        before do
+          input_csv.write("id,name,value\n")
+          10_000.times do |i|
+            input_csv.write("#{i},name#{i},#{i * 10}\n")
+          end
+          input_csv.rewind
+        end
+
+        it "processes large files correctly" do
+          described_class.convert(input_csv.path, output_yaml.path)
+          yaml_content = YAML.load_file(output_yaml.path)
+
+          expect(yaml_content.size).to eq(10_000)
+          expect(yaml_content.first).to eq({ "id" => 0, "name" => "name0", "value" => 0 })
+          expect(yaml_content.last).to eq({ "id" => 9999, "name" => "name9999", "value" => 99_990 })
+        end
+      end
+    end
+
+    context "Edge cases" do
+      # Test for header-only file
+      context "with CSV file containing only headers" do
+        before do
+          input_csv.write("id,name,age\n")
+          input_csv.rewind
+        end
+
+        it "produces an empty YAML file" do
+          described_class.convert(input_csv.path, output_yaml.path)
+          yaml_content = YAML.load_file(output_yaml.path)
+
+          expect(yaml_content).to eq([])
+        end
+      end
+
+      # Test for mixed data types
+      context "with CSV containing mixed row data types" do
+        before do
+          input_csv.write(<<~CSV)
+            id,name,value
+            1,Test,123
+            2,Another test,456.78
+            3,Yet another test,true
+            4,String test,abc
+          CSV
+          input_csv.rewind
+        end
+
+        it "converts data types correctly" do
+          described_class.convert(input_csv.path, output_yaml.path)
+          yaml_content = YAML.load_file(output_yaml.path)
+
+          expect(yaml_content).to eq(
+            [
+              { "id" => 1, "name" => "Test",             "value" => 123 },
+              { "id" => 2, "name" => "Another test",     "value" => 456.78 },
+              { "id" => 3, "name" => "Yet another test", "value" => true },
+              { "id" => 4, "name" => "String test",      "value" => "abc" }
+            ]
+          )
+        end
+      end
+
+      # Test for empty data rows
+      context "with empty data rows" do
+        before do
+          input_csv.write(<<~CSV)
+            id,name,age
+            1,Alice,
+            2,,
+            3,Bob,30
+          CSV
+          input_csv.rewind
+        end
+
+        it "handles empty data rows correctly" do
+          described_class.convert(input_csv.path, output_yaml.path)
+          yaml_content = YAML.load_file(output_yaml.path)
+
+          expect(yaml_content).to eq(
+            [
+              { "id" => 1, "name" => "Alice", "age" => nil },
+              { "id" => 2, "name" => nil,     "age" => nil },
+              { "id" => 3, "name" => "Bob",   "age" => 30 }
+            ]
+          )
+        end
+      end
+    end
+
+    context "Error handling" do
+      # Test for invalid input file path
+      context "with invalid input file path" do
+        before do
+          input_csv.write(<<~CSV)
+            id,name,age
+            1,Alice,30
+            2,Bob,25
+            3,Charlie
+          CSV
+          input_csv.rewind
+        end
+
+        it "raises a ConversionError" do
+          expect do
+            described_class.convert("invalid.csv", output_yaml.path)
+          end.to raise_error(CsvToYaml::ConversionError, /Failed to convert CSV to YAML/)
+        end
+      end
+
+      # Test for invalid output file path
+      context "with invalid output file path" do
+        before do
+          input_csv.write(<<~CSV)
+            id,name,age
+            1,Alice,30
+            2,Bob,25
+            3,Charlie
+          CSV
+          input_csv.rewind
+        end
+
+        it "raises a ConversionError" do
+          expect do
+            described_class.convert(input_csv.path, "/invalid/path/output.yml")
+          end.to raise_error(CsvToYaml::ConversionError, /Failed to convert CSV to YAML/)
+        end
+      end
+
+      # Test for empty CSV file
+      context "with empty CSV file" do
+        before do
+          input_csv.write("")
+          input_csv.rewind
+        end
+
+        it "raises a EmptyFileError" do
+          expect do
+            described_class.convert(input_csv.path, output_yaml.path)
+          end.to raise_error(CsvToYaml::EmptyFileError, /Input file '#{input_csv.path}' is empty/)
+        end
+      end
+
+      # Test for invalid CSV format
+      context "with invalid CSV format" do
+        before do
+          input_csv.write(<<~CSV)
+            id:name:age
+            1:Alice:30
+            2:Bob:25
+            3:Charlie
+          CSV
+          input_csv.rewind
+        end
+
+        it "raises a InvalidCsvFormatError" do
+          expect do
+            described_class.convert(input_csv.path, output_yaml.path)
+          end.to raise_error(CsvToYaml::InvalidCsvFormatError,
+                             /The file content does not appear to be a valid CSV format/)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: csv_to_yaml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kazuyainoue0124
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: This gem reads a CSV file and converts its content into a YAML file.
+email:
+- kazuyainoue0124@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/csv_to_yaml.rb
+- lib/csv_to_yaml/converter.rb
+- lib/csv_to_yaml/errors.rb
+- lib/csv_to_yaml/version.rb
+- spec/csv_to_yaml_spec.rb
+homepage: https://github.com/kazuyainoue0124/csv_to_yaml
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kazuyainoue0124/csv_to_yaml
+  source_code_uri: https://github.com/kazuyainoue0124/csv_to_yaml
+  changelog_uri: https://github.com/kazuyainoue0124/csv_to_yaml/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.14
+signing_key:
+specification_version: 4
+summary: A gem to convert CSV data to YAML format
+test_files:
+- spec/csv_to_yaml_spec.rb