greek_abc 0.4.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c477315c6d8488763ae6aaf9cda25496efe69c3626c4d9b5303f2a37ca20732d
-  data.tar.gz: 021a7e8589ff196694b3f3d28f4afb0773d3aad16cc6c068aab009d3118b18c1
+  metadata.gz: 4a8d90028ace5d4eba870e2928c93d3451a4f3f815ddb64fe1f4660aa6c9026d
+  data.tar.gz: e35ab039f0086b309fbd09c80e7c70299e3b12866f6cd9cf32c8964821e5f3db
 SHA512:
-  metadata.gz: dd7a8f8b82cb8c66884ad6f176378de9a7b225fa627c895d6ebf046c76b910233734b12380c200ea0e8da8f5bfad93c21c88cb7746b0e79cb8809c9d377abe81
-  data.tar.gz: b833cdc98f6e919739566830a22a537dc757be60569a97017488a1e1931c04b279b793a34bdd73b390e88d037418e296e67e498c4c2a4d210d2f265249a63096
+  metadata.gz: 7aaf58156345da497974c0440f7b8ce9f789ebe2e35e24d610ff4beaf8ae7998ee2e98f49471f8fe13fed2a2d2bd34e395ef3a7467dfdb75b9938388929a56a3
+  data.tar.gz: 53bc55871d72b93762821a878d0755577279a9119b599331cc90f2f622abd43b9649cfbd11526b244475577003c2f9a2e54921b08260efae7197792045ae7682

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 3.0

data/.yardopts

@@ -0,0 +1,3 @@
+--private
+-r README.md
+--exclude lib/greek_abc/version.rb

data/Gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in greek_abc.gemspec
 gemspec
+
+gem 'steep', '~> 1.3'

data/Gemfile.lock

@@ -1,35 +1,134 @@
 PATH
   remote: .
   specs:
-    greek_abc (0.4.2)
+    greek_abc (2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    activesupport (7.0.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.1)
+    concurrent-ruby (1.2.0)
+    csv (3.2.6)
+    diff-lcs (1.5.0)
+    e2mmap (0.1.0)
+    ffi (1.15.5)
+    fileutils (1.7.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    language_server-protocol (3.17.0.3)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.5.3)
+    minitest (5.17.0)
+    nokogiri (1.14.1-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (2.8.4)
+    regexp_parser (2.7.0)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.45.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    securerandom (0.2.2)
+    solargraph (0.48.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    steep (1.3.0)
+      activesupport (>= 5.1)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      parallel (>= 1.0.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 2.8.0)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 4)
+    strscan (3.0.6)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.2.1)
+    tilt (2.0.11)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
 
 PLATFORMS
-  ruby
+  arm64-darwin-22
 
 DEPENDENCIES
-  bundler (~> 2.0)
+  bundler
   greek_abc!
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  rake
+  rspec
+  solargraph
+  steep (~> 1.3)
 
 BUNDLED WITH
-   2.0.1
+   2.4.6

data/README.md

@@ -4,14 +4,21 @@
 
 <img src=".logo.png" width="200px" align="right">
 
-Gem for Greek alphabet manipulations
+Greek alphabet as a gem, nothing extra.
+
+Well [documented](https://rubydoc.info/github/vladyio/greek_abc/master), covered with [tests](/spec)
+and [RBS](/sig).
 
 ## Installation
 
+> [Legacy v0.4.4](https://github.com/vladyio/greek_abc/tree/v0.4.4)
+
+> Ruby `>= 2.7` is recommended
+
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'greek_abc'
+gem 'greek_abc', '~> 2.0.0'
 ```
 
 And then execute:
@@ -24,77 +31,57 @@ Or install it yourself as:
 
 ## Usage
 
-Add `require 'greek_abc'` to your script.
-
-#### Single letters
+**🔤 Get an array of all letters**
 
 ```ruby
-GreekABC::Alphabet.alpha # => #<GreekABC::Letter:0x0000557ef0e4fda8 @position=1, @name="Alpha", @lower="α", @upper="Α">
-
-GreekABC::Alphabet.omega # => #<GreekABC::Letter:0x0000557ef0e37a78 @position=24, @name="Omega", @lower="ω", @upper="Ω">
+GreekABC::Alphabet.new.letters
 ```
 
-#### Lookup
+**🔎 Look up a letter by attributes**
 
 ```ruby
-abc = GreekABC::Alphabet.new
-
-psi = abc.find_letter_by(name: 'Psi') # => <..@lower="ψ", @name="Psi", @position=23, @upper="Ψ">
-eta = abc.find_letter_by(position: 7) # => <..@lower="η", @name="Eta", @position=7, @upper="Η">
-
-puts psi # => Letter #23 'Psi', lowercase 'ψ', uppercase 'Ψ'
+GreekABC::Alphabet.new.find_letter(name: 'lambda')
+GreekABC::Alphabet.new.find_letter(position: 5)
 ```
 
-#### `Letter` methods
+**🫳🏻 Easily reach for the letter attributes**
 
 ```ruby
-abc = GreekABC::Alphabet.new
+l = GreekABC::Alphabet.new.find_letter(name: 'lambda')
 
-omega = abc.find_letter_by(name: 'Omega').lower # => "ω"
-omega = abc.find_letter_by(name: 'Omega').upper # => "Ω"
-omega = abc.find_letter_by(name: 'Omega').position # => 24
-
-alpha = abc.find_letter_by(position: 1).name # => "Alpha"
+puts [l.name, l.position, l.lower]
 ```
 
-#### Get all letters
+**#️⃣ Get the ABC as a hash:**
 
 ```ruby
 abc = GreekABC::Alphabet.new
-puts abc.letters
+puts abc.to_h # => {"Alpha"=>{:position=>1, :lower=>"α", :upper=>"Α" ...
 ```
 
-Also get letters as a hash:
+**🖨️ Print print print!**
 
 ```ruby
-abc = GreekABC::Alphabet.new
-puts abc.to_h # => {"Alpha"=>{:position=>1, :lower=>"α", :upper=>"Α"}
-```
+puts GreekABC::Alphabet.new.letters
 
-#### Basic sets of letters
-
-- Hash with letters and their names
-
-```ruby
-abc = GreekABC::ALPHABET # => {"Alpha"=>"α", "Beta"=>"β", ...}
-```
-
-- Lowercase letters
-
-```ruby
-abc = GreekABC::LOWERS # => ["α", "β", ...]
-```
-
-- Uppercase letters
-
-```ruby
-abc = GreekABC::UPPERS # => ["Α", "Β", ...]
+# ...
+# Letter #16 'Pi', lowercase 'π', uppercase 'Π'
+# Letter #17 'Rho', lowercase 'ρ', uppercase 'Ρ'
+# Letter #18 'Sigma', lowercase 'σ / ς', uppercase 'Σ'
+# ...
 ```
 
-- Lowercase and uppercase together
+**✨Alternative✨ lowercase Sigma support**
 
 ```ruby
-abc = GreekABC::LOWERS_AND_UPPERS
+GreekABC::Alphabet.new.find_letter(name: :sigma)
+
+# <GreekABC::Letter:0x00000001078e4c90
+#  @lower="σ",
+#  @lower_alt="ς", <== cool, right?
+#  @name="Sigma",
+#  @position=18,
+#  @upper="Σ">
 ```
 
 ## Development

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/Steepfile

@@ -0,0 +1,4 @@
+target :lib do
+  check 'lib'
+  signature 'sig'
+end

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "greek_abc"
+require 'bundler/setup'
+require 'greek_abc'
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/greek_abc.gemspec

@@ -1,41 +1,36 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "greek_abc/version"
+require 'greek_abc/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "greek_abc"
+  spec.name          = 'greek_abc'
   spec.version       = GreekABC::VERSION
-  spec.authors       = ["Vladislav Andreev"]
-  spec.email         = ["me@vld.by"]
+  spec.authors       = ['Vladislav Andreev']
+  spec.email         = ['andreev@vlad.social']
 
-  spec.summary       = %q{Greek alphabet manipulation gem}
-  spec.homepage      = "https://github.com/vladyio/greek_abc"
-  spec.license       = "MIT"
+  spec.summary       = 'Greek alphabet manipulation gem'
+  spec.homepage      = 'https://github.com/vladyio/greek_abc'
+  spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/vladyio/greek_abc'
+  spec.metadata['changelog_uri'] = 'https://github.com/vladyio/greek_abc/blob/master/CHANGELOG.md'
 
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/vladyio/greek_abc"
-    spec.metadata["changelog_uri"] = "https://github.com/vladyio/greek_abc/blob/master/CHANGELOG.md"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
+  spec.metadata['steep_types'] = 'sig'
+
+  spec.required_ruby_version = '>= 2.7.0'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.bindir        = 'bin'
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'solargraph'
 end

data/lib/greek_abc/alphabet.rb

@@ -1,59 +1,56 @@
+# frozen_string_literal: true
+
 module GreekABC
+  #
+  # Alphabet representation
+  #
+  # @!attribute [r] letters
+  #   @return [Array<Letter>] an array of all letters of the alphabet
   class Alphabet
-    attr_accessor :letters
-
-    ALPHABET.map.with_index(1) do |(name, letter), index|
-      define_singleton_method(:"#{name.downcase}") do
-        Letter.new(position: index, name: name, lower: letter,
-                   upper: letter.upcase)
-      end
-    end
+    attr_reader :letters
 
+    # Initialize an Alphabet object, a collection of all letters
+    #
+    # @return [Array<Letter>]
     def initialize
-      @letters = ALPHABET.map.with_index(1) do |(name, letter), index|
+      @letters = ALPHABET.map.with_index(1) do |(name, letter_variant), index|
+        # @type var letter_variant: String | Array[untyped]
+        letter = letter_variant[0]
+        letter_alt = letter_variant[1]
+
         Letter.new(position: index, name: name, lower: letter,
-                   upper: letter.upcase)
+                   lower_alt: letter_alt, upper: letter.upcase)
       end
     end
 
-    def find_letter_by(**lookup)
-      parameter = lookup.keys.first
-      value = lookup.values.first
-
-      unless letter_parameter?(parameter)
-        raise LetterLookupError, "Letter does not have parameter `#{parameter}`"
-      end
-
-      result = @letters.find do |letter|
-        letter if letter.send(parameter.to_sym) == value
-      end
-
-      unless result
-        raise LetterNotFoundError, "Letter with `#{parameter}: #{value}` not found"
-      end
-
-      result
+    # Finds a letter by given lookup parameteres
+    # @example
+    #   GreekABC::Alphabet.new.find_letter(name: 'Lambda') # => #<GreekABC::Letter:...
+    # @param [Hash{Symbol => String, Integer, nil}] lookup_params
+    #   A hash, with some {Letter} attribute as a key and desired lookup value
+    # @return [Letter]
+    # @see LetterLookup#find_letter
+    def find_letter(**lookup_params)
+      LetterLookup.new(letters).find_letter(**lookup_params)
     end
 
+    # Hash representation of an alphabet
+    # @return [Hash{String => String, Integer}]
     def to_h
-      @letters.each_with_object({}) do |letter, hash|
+      letters.each_with_object({}) do |letter, hash|
         hash[letter.name.to_s] = {
           position: letter.position,
           lower: letter.lower,
+          lower_alt: letter.lower_alt,
           upper: letter.upper
         }
       end
     end
 
+    # String representation of an alphabet
+    # @return [String]
     def to_s
-      @letters
-    end
-
-    private
-
-    def letter_parameter?(parameter)
-      parameters = %i[name position lower upper]
-      parameters.include?(parameter)
+      letters
     end
   end
 end

data/lib/greek_abc/constants.rb

@@ -1,4 +1,9 @@
+# frozen_string_literal: true
+
 module GreekABC
+  #
+  # Hash of full letter names and their lowercase representation variant(s)
+  #
   ALPHABET = {
     'Alpha' => 'α',
     'Beta' => 'β',
@@ -17,7 +22,7 @@ module GreekABC
     'Omicron' => 'ο',
     'Pi' => 'π',
     'Rho' => 'ρ',
-    'Sigma' => 'σ',
+    'Sigma' => %w[σ ς],
     'Tau' => 'τ',
     'Upsilon' => 'υ',
     'Phi' => 'φ',
@@ -25,8 +30,4 @@ module GreekABC
     'Psi' => 'ψ',
     'Omega' => 'ω'
   }.freeze
-
-  LOWERS = ALPHABET.values.freeze
-  UPPERS = LOWERS.map(&:upcase).freeze
-  LOWERS_AND_UPPERS = (LOWERS + UPPERS).freeze
 end

data/lib/greek_abc/errors.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module GreekABC
+  class GreekABCError < StandardError; end
+
+  # Raised when the lookup parameter is not a valid {Letter} attribute
+  class LetterLookupParamsError < GreekABCError
+    def initialize(wrong_parameter)
+      super("`#{wrong_parameter}` is not an existing letter attribute")
+    end
+  end
+
+  # Raised when the passed parameter and value didn't match any {Letter}
+  class LetterNotFoundError < GreekABCError
+    def initialize(parameter, value)
+      super("Letter with `#{parameter}: #{value}` was not found")
+    end
+  end
+end

data/lib/greek_abc/letter.rb

@@ -1,16 +1,47 @@
+# frozen_string_literal: true
+
 module GreekABC
+  #
+  # Represents a letter object
+  #
+  # @!attribute [r] position
+  #   @return [Integer] letter position in the alphabet
+  # @!attribute [r] name
+  #   @return [String] letter name
+  # @!attribute [r] lower
+  #   @return [String] lowercase representation
+  # @!attribute [r] lower_alt
+  #   @return [String, nil] lowercase alternative represenation, if exists
+  # @!attribute [r] upper
+  #   @return [String] uppercase representation
   class Letter
-    attr_reader :position, :name, :lower, :upper
+    attr_reader :position, :name, :lower, :lower_alt, :upper
 
-    def initialize(position:, name:, lower:, upper:)
+    # Initialize a new letter
+    #
+    # @param [Integer] position (see {position})
+    # @param [String] name (see {name})
+    # @param [String] lower (see {lower})
+    # @param [String] upper (see {upper})
+    # @param [String, nil] lower_alt (see {lower_alt})
+    # @return [Letter]
+    #
+    def initialize(position:, name:, lower:, upper:, lower_alt: nil)
       @position = position
       @name = name
       @lower = lower
+      @lower_alt = lower_alt
       @upper = upper
     end
 
+    #
+    # String representation of a {Letter} object
+    # @return [String]
     def to_s
-      "Letter ##{@position} '#{@name}', lowercase '#{@lower}', uppercase '#{@upper}'"
+      lower_alt = " / #{@lower_alt}" if @lower_alt
+
+      "Letter ##{@position} '#{@name}', lowercase '#{@lower}" \
+      "#{lower_alt}', uppercase '#{@upper}'"
     end
   end
 end

data/lib/greek_abc/letter_lookup.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module GreekABC
+  #
+  # Letter lookup utility class
+  # @!attribute [r] letters
+  #   @return [Array<Letter>]
+  class LetterLookup
+    # @dynamic letters
+    attr_reader :letters
+
+    # All available letter attributes.
+    # @see #letter_parameter?
+    LOOKUP_PARAMETERS = %i[name position lower lower_alt upper].freeze
+
+    # @param [Array<Letters>] letters
+    #   An array of letters generated by GreekABC::Alphabet.new.letters
+    def initialize(letters)
+      @letters = letters
+    end
+
+    # Finds a letter by given lookup parameteres
+    # @example
+    #   letters = GreekABC::Alphabet.new.letters
+    #   GreekABC::LetterLookup.new(letters).find_letter(name: 'Lambda') # => #<GreekABC::Letter:...
+    # @param [Hash{Symbol => String, Integer}] lookup_params
+    #   A hash, with some {Letter} attribute as a key and desired lookup value
+    # @return [Letter]
+    # @raise [LetterLookupParamsError] if passed parameter is not an existing
+    #   letter attribute
+    # @raise [LetterNotFoundError] if a letter with given parameters does not exist
+    # @see Alphabet#find_letter
+    def find_letter(**lookup_params) # rubocop:disable Metrics/AbcSize
+      # @type var lookup_params: Hash[Symbol | untyped, String | Integer | nil]
+      parameter = lookup_params.keys.first.to_sym
+      value = lookup_params.values.first
+
+      raise LetterLookupParamsError, parameter unless letter_parameter?(parameter)
+
+      result = letters.find do |letter|
+        letter if letter.send(parameter).to_s.downcase == value.to_s.downcase
+      end
+
+      raise LetterNotFoundError.new(parameter, value) unless result
+
+      result
+    end
+
+    private
+
+    def letter_parameter?(parameter)
+      LOOKUP_PARAMETERS.include?(parameter)
+    end
+  end
+end

data/lib/greek_abc/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GreekABC
-  VERSION = "0.4.3"
+  VERSION = '2.0.0'
 end

data/lib/greek_abc.rb

@@ -1,11 +1,11 @@
-require 'greek_abc/version'
+# frozen_string_literal: true
 
+require 'greek_abc/version'
 require 'greek_abc/constants'
+require 'greek_abc/errors'
 require 'greek_abc/letter'
+require 'greek_abc/letter_lookup'
 require 'greek_abc/alphabet'
 
 module GreekABC
-  class GreekABCError < StandardError; end
-  class LetterLookupError < GreekABCError; end
-  class LetterNotFoundError < GreekABCError; end
 end

data/sig/greek_abc.rbs

@@ -0,0 +1,62 @@
+module GreekABC
+  ALPHABET: Hash[String, String | Array[String]]
+
+  VERSION: String
+end
+
+module GreekABC
+  class Alphabet
+    attr_accessor letters: Array[GreekABC::Letter]
+
+    def initialize: () -> void
+
+    def find_letter: (**untyped lookup_params) -> GreekABC::Letter
+
+    def to_h: () -> Hash[String, String | Integer]
+    def to_s: () -> untyped
+  end
+end
+
+module GreekABC
+  class GreekABCError < StandardError
+  end
+
+  class LetterLookupParamsError < GreekABCError
+    def initialize: (Symbol wrong_parameter) -> void
+  end
+
+  class LetterNotFoundError < GreekABCError
+    def initialize: (Symbol parameter, String | Integer | nil value) -> void
+  end
+end
+
+module GreekABC
+  class Letter
+    attr_reader position: Integer
+    attr_reader name: String
+    attr_reader lower: String
+    attr_reader lower_alt: String?
+    attr_reader upper: String
+
+    def initialize: (position: Integer, name: String, lower: String,
+                     upper: String, ?lower_alt: String?) -> void
+
+    def to_s: () -> String
+  end
+end
+
+module GreekABC
+  class LetterLookup
+    attr_reader letters: Array[GreekABC::Letter]
+
+    LOOKUP_PARAMETERS: Array[Symbol]
+
+    def initialize: (Array[GreekABC::Letter] letters) -> untyped
+
+    def find_letter: (**untyped lookup_params) -> GreekABC::Letter
+
+    private
+
+    def letter_parameter?: (Symbol parameter) -> bool
+  end
+end

metadata

@@ -1,60 +1,74 @@
 --- !ruby/object:Gem::Specification
 name: greek_abc
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Vladislav Andreev
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2019-05-05 00:00:00.000000000 Z
+date: 2023-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: 
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
 email:
-- me@vld.by
+- andreev@vlad.social
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -62,21 +76,26 @@ files:
 - ".gitignore"
 - ".logo.png"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - bin/console
 - bin/setup
 - greek_abc.gemspec
 - lib/greek_abc.rb
 - lib/greek_abc/alphabet.rb
 - lib/greek_abc/constants.rb
+- lib/greek_abc/errors.rb
 - lib/greek_abc/letter.rb
+- lib/greek_abc/letter_lookup.rb
 - lib/greek_abc/version.rb
+- sig/greek_abc.rbs
 homepage: https://github.com/vladyio/greek_abc
 licenses:
 - MIT
@@ -85,7 +104,8 @@ metadata:
   homepage_uri: https://github.com/vladyio/greek_abc
   source_code_uri: https://github.com/vladyio/greek_abc
   changelog_uri: https://github.com/vladyio/greek_abc/blob/master/CHANGELOG.md
-post_install_message: 
+  steep_types: sig
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,15 +113,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: Greek alphabet manipulation gem
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.2
-before_install: gem install bundler -v 2.0.1