over_h3sentence 1.0.0

data/lib/over_h3sentence.rb

@@ -0,0 +1,36 @@
+require 'json'
+
+class OverH3sentence
+  LIST_OF_WORDS = JSON.parse(File.read(File.join(File.dirname(__FILE__), './list_of_words_v1.json')))
+  COMBINATIONS_VOCAB = ['000','001','010','011','100','101','110','111','002','012','020','021','022','102','112','120','121','122','200','201','202','210','211','212','220','221','222']
+
+  def self.sentence(hex_id)
+    raise ArgumentError, 'Hex id must be 15 characters long' if hex_id.length != 15
+
+    words = form_h3_to_words(hex_id.to_i(16))
+    words.join('.')
+  end
+
+  def self.form_h3_to_words(h3_address)
+    binary = h3_address.to_s(2)
+
+    binary_clean = binary[8..50]
+    integer = binary_clean.to_i(2)
+    str_integer = integer.to_s
+    integer_length = str_integer.length
+    if (integer_length < 13)
+      for i in 0..12-integer_length do
+        str_integer = "0#{str_integer}"
+      end
+    end
+    integer_first_value = str_integer[0]
+    first_word_idx = "#{COMBINATIONS_VOCAB[integer_first_value.to_i][0]}#{str_integer[1,4]}".to_i % 30000
+    first_word = LIST_OF_WORDS[first_word_idx]
+    second_word_idx = "#{COMBINATIONS_VOCAB[integer_first_value.to_i][1]}#{str_integer[5..8]}".to_i % 30000
+    second_word = LIST_OF_WORDS[second_word_idx]
+    third_word_idx = "#{COMBINATIONS_VOCAB[integer_first_value.to_i][2]}#{str_integer[9..-1]}".to_i % 30000
+    third_word = LIST_OF_WORDS[third_word_idx.to_i]
+
+    [first_word, second_word, third_word]
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: over_h3sentence
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gregorio Galante
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate sentence from Over land hex id (H3 address)
+email: me@gregoriogalante.com
+executables:
+- over_h3sentence
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/over_h3sentence
+- lib/list_of_words_v1.json
+- lib/over_h3sentence.rb
+homepage: https://rubygems.org/gems/over_h3sentence
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: Generate sentence from Over land hex id (H3 address)
+test_files: []