yae 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b08e3c607e151e0ae96ed463c71557a083ae4e215439f66987cf29baeb2f1c7
+  data.tar.gz: 0d7e7febabbe7aa0eb8881e3816a5be81a289f597e8d012d1d919e2a7bfbe9f7
+SHA512:
+  metadata.gz: 6da9471e3743883cc584f51e55ea2c5b0f3f7b7c499b738b576ce161ef1bca3bd5b926943e8a31475ccc5c5aa293a26f756c07f470211ddd941378cba86f6bac
+  data.tar.gz: cc04e3adc32e9765f70d5d112a4acdab8d77afa7f7508c04b79cb0f6defd6253fb8ed4df28b1ce2034802243cfadf85e55f3f4f71868f7f5c3dd79445ccab788

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Stephen Ierodiaconou
+
+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,40 @@
+# Yae::Enum
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yae`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yae'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install yae
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, 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/[USERNAME]/yae.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard/rake"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/yae/enum.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+# Implements an enum
+module Yae
+  class Enum
+    class << self
+      extend ::Forwardable
+
+      def inherited(subclass)
+        subclass.instance_variable_set(:@enum_store, @enum_store.clone)
+        super
+      end
+
+      # Define an entry in the enum
+      def define(key, value)
+        @enum_store = {} unless enum_store
+        enum_store[key] = value
+      end
+
+      # Get the enum value
+      def get(key, raises: true)
+        return unless enum_store
+        raises ? enum_store.fetch(key) : enum_store.fetch(key, nil)
+      end
+
+      # Get multiple keys at once
+      def get_multiple(*keys, raises: true)
+        keys.map { |key| get(key, raises: raises) }
+      end
+
+      # Check if value is used in enum
+      def include?(value)
+        !!enum_store&.has_value?(value)
+      end
+
+      # Delegate enumerable methods to underlying hash
+      def_delegators :@enum_store,
+        :key,
+        :key?,
+        :keys,
+        :values,
+        :each,
+        :map,
+        :select,
+        :reject,
+        :to_a,
+        :to_h
+
+      # Convert a string to a enum key
+      def keyify(name)
+        name.gsub(%r{[\-\s/\\]}, "_").downcase.to_sym
+      end
+
+      private
+
+      attr_reader :enum_store
+    end
+  end
+end

data/lib/yae/version.rb

@@ -0,0 +1,3 @@
+module Yae
+  VERSION = "1.0.0"
+end

data/lib/yae.rb

@@ -0,0 +1,2 @@
+require "yae/version"
+require "yae/enum"

data/sig/types.rbs

@@ -0,0 +1,52 @@
+module Yae
+  VERSION: String
+
+  class Enum
+    extend ::Forwardable
+
+    def self.inherited: (Enum subclass) -> void
+
+    # Define an entry in the enum
+    def self.define: (Symbol key, untyped value) -> void
+
+    # Get the enum value
+    def self.get: (Symbol key, ?raises: bool) -> (nil | untyped)
+
+    # Get multiple keys at once
+    def self.get_multiple: (*Symbol keys, ?raises: bool) -> Array[untyped]
+
+    # Check if value is used in enum
+    def self.include?: (untyped value) -> bool
+
+    # Convert a string to a enum key
+    def self.keyify: (String name) -> Symbol
+
+    # Delegate methods to the hash
+    def self.key: (untyped) -> Symbol
+
+    def self.key?: (Symbol key) -> bool
+
+    def self.keys: () -> Array[Symbol]
+
+    def self.values: () -> Array[untyped]
+
+    def self.each: () { ([Symbol, untyped]) -> void } -> Hash[Symbol, untyped]
+
+    def self.map: () { ([Symbol, untyped]) -> untyped } -> Array[untyped]
+
+    def self.to_a: () -> Array[[Symbol, untyped]]
+
+    def self.select: () { ([Symbol, untyped]) -> boolish } -> Hash[Symbol, untyped]
+      | () -> Enumerator[[[Symbol, untyped]], Hash[Symbol, untyped]]
+
+    def self.reject: () { (Symbol, untyped) -> boolish } -> Hash[Symbol, untyped]
+      | () -> Enumerator[[Symbol, untyped], Hash[Symbol, untyped]]
+
+    def self.to_h: () -> Hash[Symbol, untyped]
+
+    private
+
+    attr_reader self.enum_store: Hash[Symbol, untyped]
+  end
+
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: yae
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Stephen Ierodiaconou
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: standard
+  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'
+- !ruby/object:Gem::Dependency
+  name: steep
+  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: yae provides a simple enum class (enumerated type) implementation (Yae::Enum)
+  that can be used to abstract a set of values. It also provides methods to check
+  values existence in the enum and to iterate over its contents.
+email:
+- stevegeek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yae.rb
+- lib/yae/enum.rb
+- lib/yae/version.rb
+- sig/types.rbs
+homepage: https://github.com/stevegeek/yae
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/stevegeek/yae
+  source_code_uri: https://github.com/stevegeek/yae
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: yae (Yet Another Enum) provides a simple enum class (enumerated type) implementation,
+  Yae::Enum
+test_files: []