rizzy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f7ea68ab1a6a1a72a9778ef875afc364da2b77a165900b108897c135efc3cf31
+  data.tar.gz: b49a431ed0e28da35e0f37a5bcf23bfee968a4403610b29a0ffd830cd4db928c
+SHA512:
+  metadata.gz: 8861dcaf5e50bfaf6fdef578a14db1a9206bb2ee50527228c5c39ec4bfb38f7aaa5fdefce1f8122e54423c9d94f3428d13d942ff71741fcbf4901771974521e3
+  data.tar.gz: bdd47013da7a4e807cf58e16b64fb4ace62640b621cb1acd88719e4d1448cf4a6138216d9022c680cb7a11cbb9f16f0bc1bc42611a2bca99144d372b63b7b84b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/.vscode/launch.json

@@ -0,0 +1,25 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "ruby_lsp",
+            "name": "Debug script",
+            "request": "launch",
+            "program": "ruby ${file}"
+        },
+        {
+            "type": "ruby_lsp",
+            "name": "Debug test",
+            "request": "launch",
+            "program": "ruby -Itest ${relativeFile}"
+        },
+        {
+            "type": "ruby_lsp",
+            "name": "Attach debugger",
+            "request": "attach"
+        }
+    ]
+}

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-10-24
+
+- Initial release

data/CLAUDE.md

@@ -0,0 +1,73 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+<!-- ## Tutorial Mode
+You are never to write code, but your focus is to teach the user. The user is writing their first ruby gem and wants to learn and internalise core cocnepts of ruby language and gem files. Focus on explaining step by step and explain the mechanics. -->
+
+## Project Overview
+
+Rizzy is a Ruby gem project initialized from the standard bundler gem template. It's currently in early development with placeholder content.
+
+- Ruby version requirement: >= 3.1.0
+- Testing framework: RSpec
+- Linting: RuboCop
+- CI: GitHub Actions (testing on Ruby 3.3.3)
+
+## Development Commands
+
+### Setup
+```bash
+bin/setup              # Install dependencies
+```
+
+### Testing
+```bash
+rake spec              # Run all tests
+rspec                  # Run all tests (alternative)
+rspec spec/path/to/specific_spec.rb  # Run a specific test file
+```
+
+### Linting
+```bash
+rake rubocop           # Run RuboCop linter
+rubocop -a             # Auto-fix RuboCop issues
+```
+
+### Combined Tasks
+```bash
+rake                   # Run default task (spec + rubocop)
+```
+
+### Interactive Console
+```bash
+bin/console            # Launch IRB with the gem loaded
+```
+
+### Local Installation
+```bash
+bundle exec rake install   # Install gem locally
+```
+
+## Code Architecture
+
+### Module Structure
+- `lib/rizzy.rb` - Main entry point, defines the `Rizzy` module with base `Error` class
+- `lib/rizzy/version.rb` - Version constant (currently 0.1.0)
+- Additional module files should go in `lib/rizzy/` directory
+
+### Code Style
+- RuboCop enforces double quotes for strings (both regular and interpolated)
+- All Ruby files should start with `# frozen_string_literal: true`
+- Target Ruby version: 3.1
+
+### Testing
+- RSpec is configured with monkey patching disabled
+- Test files go in `spec/` directory
+- Use `.rspec_status` for example status persistence
+- Syntax: use `expect` style (not `should`)
+
+### File Organization
+- Executable files: `exe/` directory (currently none)
+- Binary helpers: `bin/` directory (console, setup)
+- Type signatures: `sig/` directory (RBS files)

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Andrew Boeckh
+
+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,3 @@
+# Rizzy
+
+A gem for parsing and writing .ris files

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/rizzy/parser.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative "reference"
+
+# Rizzy parsing logic
+module Rizzy
+  TAG_TO_FIELD = {
+    "TY" => { attr: :type, multiple: false },
+    "DB" => { attr: :database, multiple: false },
+    "ID" => { attr: :id, multiple: false },
+    "DO" => { attr: :doi, multiple: false },
+    "T1" => { attr: :title, multiple: false },
+    "TI" => { attr: :title, multiple: false },
+    "Y1" => { attr: :year, multiple: false },
+    "PY" => { attr: :year, multiple: false },
+    "N2" => { attr: :abstract, multiple: false },
+    "AB" => { attr: :abstract, multiple: false },
+    "M3" => { attr: :type_of_work, multiple: false },
+    "JF" => { attr: :journal_full, multiple: false },
+    "VL" => { attr: :volume, multiple: false },
+    "IS" => { attr: :issue, multiple: false },
+    "SP" => { attr: :start_page, multiple: false },
+    "EP" => { attr: :end_page, multiple: false },
+    "CY" => { attr: :country, multiple: false },
+    "SN" => { attr: :isbn, multiple: false },
+    "NL" => { attr: :alternate_journal, multiple: false },
+    "LA" => { attr: :language, multiple: false },
+    "PT" => { attr: :publication_type, multiple: false },
+    "A1" => { attr: :authors, multiple: true },
+    "AU" => { attr: :authors, multiple: true },
+    "AI" => { attr: :author_identifiers, multiple: true },
+    "A2" => { attr: :secondary_authors, multiple: true },
+    "KW" => { attr: :keywords, multiple: true },
+    "PB" => { attr: :publishers, multiple: true },
+    "AD" => { attr: :addresses, multiple: true },
+    "M1" => { attr: :miscellaneous_ones, multiple: true },
+    "M2" => { attr: :miscellaneous_twos, multiple: true },
+    "L2" => { attr: :urls, multiple: true },
+    "UR" => { attr: :urls, multiple: true }
+  }.freeze
+
+  def self.parse(content)
+    str = normalize_encoding(content)
+    entries = str.split("ER  -")
+    references = []
+    entries.each do |entry|
+      reference = process_entry(entry)
+      references << process_entry(entry) unless reference[:type].nil?
+    end
+    references
+  end
+
+  def self.normalize_encoding(string)
+    str = string.dup
+    return str if str.encoding.name == "UTF-8" && str.valid_encoding?
+
+    str.encode("UTF-8")
+  end
+
+  def self.process_entry(entry)
+    data = Hash.new { |h, k| h[k] = [] if k.to_s.end_with?("s") }
+    lines = entry.lines
+    lines.each do |line|
+      elements = line.split("  - ")
+      next if elements.length != 2
+
+      add_entry(elements[0], elements[1].strip, data)
+    end
+    Reference.new(**data)
+  end
+
+  def self.add_entry(tag, entry, data)
+    mapping = TAG_TO_FIELD[tag]
+    return if mapping.nil?
+
+    attr = mapping[:attr]
+    if mapping[:multiple]
+      data[attr] << entry
+    else
+      data[attr] = entry
+    end
+  end
+
+  private_class_method :normalize_encoding
+end

data/lib/rizzy/reference.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Rizzy
+  Reference = Struct.new(
+    :type,                    # TY
+    :database,                # DB
+    :id,                      # ID
+    :doi,                     # DO
+    :title,                   # T1, TI
+    :year,                    # Y1, PY
+    :abstract,                # N2, AB
+    :type_of_work,            # M3
+    :journal_full,            # JF
+    :volume,                  # VL
+    :issue,                   # IS
+    :start_page,              # SP
+    :end_page,                # EP
+    :country,                 # CY
+    :isbn,                    # SN
+    :alternate_journal,       # NL
+    :language,                # LA
+    :publication_type,        # PT
+    :authors,                 # A1, AU
+    :author_identifiers,      # AI
+    :secondary_authors,       # A2
+    :keywords,                # KW
+    :publishers,              # PB
+    :addresses,               # AD
+    :miscellaneous_ones,      # M1
+    :miscellaneous_twos,      # M2
+    :urls                     # L2, UR
+  )
+end

data/lib/rizzy/version.rb

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

data/lib/rizzy/writer.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# rubocop:disable all
+require_relative "reference"
+
+# Rizzy writing logic
+module Rizzy
+  FIELD_TO_TAG = {
+    type: { tag: "TY", multiple: false },
+    database: { tag: "DB", multiple: false },
+    id: { tag: "ID", multiple: false },
+    doi: { tag: "DO", multiple: false },
+    title: { tag: "T1", multiple: false },
+    year: { tag: "Y1", multiple: false },
+    abstract: { tag: "N2", multiple: false },
+    type_of_work: { tag: "M3", multiple: false },
+    journal_full: { tag: "JF", multiple: false },
+    volume: { tag: "VL", multiple: false },
+    issue: { tag: "IS", multiple: false },
+    start_page: { tag: "SP", multiple: false },
+    end_page: { tag: "EP", multiple: false },
+    country: { tag: "CY", multiple: false },
+    isbn: { tag: "SN", multiple: false },
+    alternate_journal: { tag: "NL", multiple: false },
+    language: { tag: "LA", multiple: false },
+    publication_type: { tag: "PT", multiple: false },
+    authors: { tag: "A1", multiple: true },
+    author_identifiers: { tag: "AI", multiple: true },
+    secondary_authors: { tag: "A2", multiple: true },
+    keywords: { tag: "KW", multiple: true },
+    publishers: { tag: "PB", multiple: true },
+    addresses: { tag: "AD", multiple: true },
+    miscellaneous_ones: { tag: "M1", multiple: true },
+    miscellaneous_twos: { tag: "M2", multiple: true },
+    urls: { tag: "L2", multiple: true }
+  }.freeze
+
+  def self.write(references)
+    references = [references] unless references.is_a?(Array)
+
+    output = []
+    references.each do |reference|
+      output << write_reference(reference)
+    end
+
+    output.join("\n")
+  end
+
+  def self.write_reference(reference)
+    lines = []
+
+    FIELD_TO_TAG.each do |field, config|
+      value = reference[field]
+      next if value.nil?
+
+      tag = config[:tag]
+
+      if config[:multiple]
+        next if value.empty?
+        value.each do |item|
+          lines << format_line(tag, item)
+        end
+      else
+        next if value.to_s.empty?
+        lines << format_line(tag, value)
+      end
+    end
+
+    lines << "ER  -"
+    lines.join("\n")
+  end
+
+  def self.format_line(tag, value)
+    "#{tag}  - #{value}"
+  end
+
+  private_class_method :write_reference, :format_line
+end

data/lib/rizzy.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "rizzy/version"
+require_relative "rizzy/parser"
+require_relative "rizzy/writer"
+
+module Rizzy
+  class Error < StandardError; end
+  class EncodingError < StandardError; end
+end

data/sig/rizzy.rbs

@@ -0,0 +1,4 @@
+module Rizzy
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: rizzy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Boeckh
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-10-25 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  The gem have a parse and writer method for easy interfacing with .ris files.
+    Currently only common .ris tags are implemented
+email:
+- boeckhandrew@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".vscode/launch.json"
+- CHANGELOG.md
+- CLAUDE.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rizzy.rb
+- lib/rizzy/parser.rb
+- lib/rizzy/reference.rb
+- lib/rizzy/version.rb
+- lib/rizzy/writer.rb
+- sig/rizzy.rbs
+homepage: https://github.com/arboeckh/rizzy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/arboeckh/rizzy
+  source_code_uri: https://github.com/arboeckh/rizzy
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: A .ris file parser and writer for ruby
+test_files: []