adif 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 94e612b5395d8c418a60a99d259471fa670eac0de3732e14ee9845ff788d5427
+  data.tar.gz: 4890f1b5f7698e7e9ea6b2ac44a29a1062c719a91993b8a2428685f49948408e
+SHA512:
+  metadata.gz: '0678d7604fa7abd64365e05979870d4fa6ea6c49c91685edeafa3c76ad0c13525f7f0207a52f17383a1aefe09aa81603db6294c82bdb11dd750df70f95ba2c76'
+  data.tar.gz: 0f7cde07961896616f7091fe11f94572d2f6fc7dc8161d379738a6bbb0b81c3e41495cd7db05324a092ae041fd0149a910109ff1d7957036490477ce3420fbb8

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Chris Dinger
+
+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,39 @@
+# ADIFrb
+
+A rubygem to parse, manipulate, and manage [ADIF](https://adif.org/315/ADIF_315.htm) amateur radio logs and records.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "adif"
+```
+
+And then execute:
+
+```
+bundle install
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/cdinger/adifrb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/cdinger/adifrb/blob/main/CODE_OF_CONDUCT.md).
+
+## TODO
+
+- make Record#uniqueness configurable, with examples (qsl.net has some fuzziness in the qso_start minute)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Adif project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/adif/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/adif/log/header.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ADIF
+  class Log
+    class Header
+      FIELDS = %w(
+        adif_ver
+        created_timestamp
+        programid
+        programversion
+        userdefn
+      )
+    end
+  end
+end

data/lib/adif/log.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "adif/record"
+
+module ADIF
+  class Log
+    include Enumerable
+
+    attr_accessor :adif_version, :program_id, :program_version, :records
+
+    def initialize(adif_version: "3.1.5", program_id: "adifrb", program_version: ADIF::VERSION, records: [])
+      @adif_version = adif_version
+      @program_id = program_id
+      @program_version = program_version
+      @records = records
+    end
+
+    def self.parse(adif_string)
+      records = [Record.new]
+
+      adif_string.scan(/<(\w+):?(\d+)?>([^<]*)/) do |key, length, value|
+        records.last[key.downcase.to_sym] = value.strip
+        if key.downcase == "eor"
+          records << Record.new
+        end
+      end
+
+      # Remove trailing empty record
+      records.pop if records.last.empty?
+
+      Log.new(records: records)
+    end
+
+    def header
+      [
+        adif_field("adif_ver", "3.1.5"),
+        adif_field("created_timestamp", Time.now.utc),
+        adif_field("programid", program_id),
+        adif_field("programversion", program_version),
+        terminator
+      ].join
+    end
+
+    def terminator
+      "<EOH>"
+    end
+
+    def adif_field(name, value)
+      "<#{name.upcase}:#{value.to_s.length}>#{value.to_s} "
+    end
+
+    def to_adif
+      ([header] + sorted_records.map(&:to_adif)).join("\n")
+    end
+
+    def to_uniq_adif
+      ([header] + uniq_records.map(&:to_adif)).join("\n")
+    end
+
+    def sorted_records
+      records.sort do |a, b|
+        a.qso_date + a.time_on <=> b.qso_date + b.time_on
+      end
+    end
+
+    def uniq_records
+      records.uniq(&:uniqueness)
+    end
+  end
+end

data/lib/adif/record/field.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ADIF
+  class Record
+    class Field
+      attr_reader :key, :value
+
+      def initialize(key, value)
+        @key = key
+        @value = value
+      end
+
+      def to_adif
+        "<#{@key.upcase}:#{value.to_s.length}>#{value} "
+      end
+    end
+  end
+end

data/lib/adif/record/fields.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+module ADIF
+  class Record
+    module Fields
+      FIELDS = {
+        # https://adif.org/315/ADIF_315.htm
+        "3.1.5" => %w(
+          call
+          mode
+          band
+          qso_date
+          time_on
+          address
+          address_intl
+          age
+          altitude
+          ant_az
+          ant_el
+          ant_path
+          arrl_sect
+          award_submitted
+          award_granted
+          a_index
+          band
+          band_rx
+          call
+          check
+          class
+          clublog_qso_upload_date
+          clublog_qso_upload_status
+          cnty
+          cnty_alt
+          comment
+          comment_intl
+          cont
+          contacted_op
+          contest_id
+          country
+          country_intl
+          cqz
+          credit_submitted
+          credit_granted
+          darc_dok
+          dcl_qslrdate
+          dcl_qslsdate
+          dcl_qsl_rcvd
+          dcl_qsl_sent
+          distance
+          dxcc
+          email
+          eq_call
+          eqsl_qslrdate
+          eqsl_qslsdate
+          eqsl_qsl_rcvd
+          eqsl_qsl_sent
+          fists
+          fists_cc
+          force_init
+          freq
+          freq_rx
+          gridsquare
+          gridsquare_ext
+          guest_op
+          hamlogeu_qso_upload_date
+          hamlogeu_qso_upload_status
+          hamqth_qso_upload_date
+          hamqth_qso_upload_status
+          hrdlog_qso_upload_date
+          hrdlog_qso_upload_status
+          iota
+          iota_island_id
+          ituz
+          k_index
+          lat
+          lon
+          lotw_qslrdate
+          lotw_qslsdate
+          lotw_qsl_rcvd
+          lotw_qsl_sent
+          max_bursts
+          mode
+          morse_key_info
+          morse_key_type
+          ms_shower
+          my_altitude
+          my_antenna
+          my_antenna_intl
+          my_arrl_sect
+          my_city
+          my_city_intl
+          my_cnty
+          my_cnty_alt
+          my_country
+          my_country_intl
+          my_cq_zone
+          my_darc_dok
+          my_dxcc
+          my_fists
+          my_gridsquare
+          my_gridsquare_ext
+          my_iota
+          my_iota_island_id
+          my_itu_zone
+          my_lat
+          my_lon
+          my_morse_key_info
+          my_morse_key_type
+          my_name
+          my_name_intl
+          my_postal_code
+          my_postal_code_intl
+          my_pota_ref
+          my_rig
+          my_rig_intl
+          my_sig
+          my_sig_intl
+          my_sig_info
+          my_sig_info_intl
+          my_sota_ref
+          my_state
+          my_street
+          my_street_intl
+          my_usaca_counties
+          my_vucc_grids
+          my_wwff_ref
+          name
+          name_intl
+          notes
+          notes_intl
+          nr_bursts
+          nr_pings
+          operator
+          owner_callsign
+          pfx
+          pota_ref
+          precedence
+          prop_mode
+          public_key
+          qrzcom_qso_download_date
+          qrzcom_qso_download_status
+          qrzcom_qso_upload_date
+          qrzcom_qso_upload_status
+          qslmsg
+          qslmsg_intl
+          qslmsg_rcvd
+          qslrdate
+          qslsdate
+          qsl_rcvd
+          qsl_rcvd_via
+          qsl_sent
+          qsl_sent_via
+          qsl_via
+          qso_complete
+          qso_date
+          qso_date_off
+          qso_random
+          qth
+          qth_intl
+          region
+          rig
+          rig_intl
+          rst_rcvd
+          rst_sent
+          rx_pwr
+          sat_mode
+          sat_name
+          sfi
+          sig
+          sig_intl
+          sig_info
+          sig_info_intl
+          silent_key
+          skcc
+          sota_ref
+          srx
+          srx_string
+          state
+          station_callsign
+          stx
+          stx_string
+          submode
+          swl
+          ten_ten
+          time_off
+          time_on
+          tx_pwr
+          uksmg
+          usaca_counties
+          ve_prov
+          vucc_grids
+          web
+          wwff_ref
+        ).map(&:to_sym)
+      }
+    end
+  end
+end

data/lib/adif/record.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "adif/record/fields"
+require "adif/record/field"
+require "json"
+
+module ADIF
+  class Record
+    include Fields
+
+    def initialize(data = {})
+      @data = data
+    end
+
+    def [](key)
+      @data[key].value
+    end
+
+    def []=(key, value)
+      @data[key] = value
+    end
+
+    def empty?
+      @data.empty?
+    end
+
+    def fields
+      key_fields + nonkey_fields
+    end
+
+    def key_fields
+      [:call, :mode, :band, :qso_date, :time_on]
+    end
+
+    def nonkey_fields
+      FIELDS["3.1.5"] - key_fields
+    end
+
+    def uniqueness
+      key_fields.map { @data[it] }.join("")
+    end
+
+    def unique_key
+      uniqueness
+    end
+
+    def terminator
+      "<EOR>"
+    end
+
+    def field_adif(field)
+      "<#{field.upcase}:#{@data[field].to_s.length}>#{@data[field]}"
+    end
+
+    def to_adif
+      fields.map do |field|
+        field_adif(field) unless @data[field].nil?
+      end.compact.join(" ") + " #{terminator}"
+    end
+
+    def to_json
+      JSON.generate(@data)
+    end
+
+    def method_missing(name, *args, &block)
+      if fields.include?(name)
+        @data[name]
+      else
+        super
+      end
+      if @data.has_key?(name)
+        @data[name]
+      else
+        raise ArgumentError.new("Method `#{m}` doesn't exist.")
+      end
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      fields.include?(name) || super
+    end
+  end
+end

data/lib/adif/version.rb

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

data/lib/adif.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "adif/version"
+require_relative "adif/log"
+require_relative "adif/record"
+
+module ADIF
+  class Error < StandardError; end
+end

data/sig/adif.rbs

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

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: adif
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Dinger
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A rubygem for parsing and manipulating amateur radio ADIF files
+email:
+- cdinger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/adif.rb
+- lib/adif/log.rb
+- lib/adif/log/header.rb
+- lib/adif/record.rb
+- lib/adif/record/field.rb
+- lib/adif/record/fields.rb
+- lib/adif/version.rb
+- sig/adif.rbs
+homepage: https://github.com/cdinger/adifrb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cdinger/adifrb
+  source_code_uri: https://github.com/cdinger/adifrb
+  changelog_uri: https://github.com/cdinger/adifrb/blob/main/CHANGELOG.md
+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.6.8
+specification_version: 4
+summary: A rubygem for parsing and manipulating amateur radio ADIF files
+test_files: []