minenum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 62775a6aa94437fc897c0ced4c9f7209cd279ab4c51f55793c3dbd218a4cf492
+  data.tar.gz: 5fd974a1b3efb463a6b39aea2a5206c7acc013c729acdc80a590e0e6b1011e3c
+SHA512:
+  metadata.gz: 8c75161d38a61f3e67c83f7ade775ea3c9de48fc9f1a90f991c77835f6469be11bd3bbbf947a3fe7cd5d375ada00d8a56be320565c6516eb4fd62bf31d25f912
+  data.tar.gz: 9706434cf641116c550cc341686059721495ec9dcb9528077562fccd90e5f08ea6f45fd7dc39caaa0990a74282b06accd63e48052fb03181b6f5f76a06cfd705

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,18 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+require: rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+RSpec/NestedGroups:
+  Max: 4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-04-05
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Loose Coupling
+
+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,59 @@
+# Minenum
+
+Minenum is a gem that enhances Ruby objects by adding enum functionality and returning enum objects as return values. Enums simplify representing states or types within a specific range of values and can be returned directly from methods.
+
+Features:
+
+* Return enum objects directly from methods, enabling clearer and more expressive code.
+* Simplify code by encapsulating valid value ranges within enums.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add minenum
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install minenum
+
+## Usage
+
+```ruby
+class Shirt
+  include Minenum::Model
+
+  enum :size, { small: 1, medium: 2, large: 3 }
+end
+```
+
+```ruby
+shirt = Shirt.new
+shirt.size = 1
+shirt.size.name #=> :small
+shirt.size.small? #=> true
+
+# You can also set the name
+shirt.size = :medium
+shirt.size.name #=> :medium
+shirt.size.medium? #=> true
+```
+
+```ruby
+# You can get the enum values
+Shirt.size.values #=> { small: 1, medium: 2, large: 3 }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 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/nowlinuxing/minenum.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/Steepfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+D = Steep::Diagnostic
+
+target :lib do
+  signature 'sig'
+
+  check 'lib'
+end

data/lib/minenum/enum/base.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Minenum
+  module Enum
+    class Base # :nodoc:
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+        freeze
+      end
+    end
+  end
+end

data/lib/minenum/enum/class_builder.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'values'
+
+module Minenum
+  module Enum
+    class ClassBuilder # :nodoc:
+      def self.build(values = {})
+        new(values).build
+      end
+
+      def initialize(values)
+        @values = values
+      end
+
+      def build
+        values = Values.new(@values)
+
+        klass = Class.new(Base)
+        add_values_method(klass, values)
+        add_name_method(klass, values)
+        add_predicate_methods(klass, values)
+
+        klass
+      end
+
+      private
+
+      def add_values_method(klass, values)
+        klass.singleton_class.define_method(:values) do
+          values.values
+        end
+      end
+
+      def add_name_method(klass, values)
+        klass.define_method(:name) do
+          values.key(@value)
+        end
+      end
+
+      def add_predicate_methods(klass, values)
+        values.each_key do |key|
+          klass.define_method("#{key}?") do
+            values.match?(key, @value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/minenum/enum/values.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Minenum
+  module Enum
+    class Values # :nodoc:
+      attr_reader :values
+
+      def initialize(values)
+        @values = values.transform_keys(&:to_sym).tap(&:freeze)
+        freeze
+      end
+
+      def each_key(...)
+        @values.each_key(...)
+      end
+
+      def key(key_or_value)
+        if key_or_value.respond_to?(:to_sym) && (key_sym = key_or_value.to_sym) && @values.key?(key_sym)
+          key_sym
+        else
+          return @values.key(key_or_value) if @values.value?(key_or_value)
+
+          case key_or_value
+          when Symbol then @values.key(key_or_value.to_s)
+          when String then @values.key(key_or_value.to_sym)
+          end
+        end
+      end
+
+      def match?(key_name, key_or_value)
+        if key_or_value.respond_to?(:to_sym) && (key_sym = key_or_value.to_sym) && @values.key?(key_sym)
+          key_sym == key_name.to_sym
+        else
+          match_with_value?(key_name, key_or_value)
+        end
+      end
+
+      private
+
+      def match_with_value?(key_name, value)
+        registered_value = @values[key_name.to_sym]
+        return true if value == registered_value
+
+        case value
+        when Symbol then value.to_s == registered_value
+        when String then value.to_sym == registered_value
+        else false
+        end
+      end
+    end
+  end
+end

data/lib/minenum/enum.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'enum/class_builder'

data/lib/minenum/model.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative 'enum'
+
+module Minenum
+  # = Minenum
+  #
+  # Minenum enhances Ruby objects by adding enum functionality.
+  #
+  #   class Shirt
+  #     include Minenum::Model
+  #
+  #     enum :size, { small: 1, medium: 2, large: 3 }
+  #   end
+  #
+  #   shirt = Shirt.new
+  #   shirt.size = 1
+  #   shirt.size.name #=> :small
+  #   shirt.size.small? #=> true
+  #
+  #   # You can also set the name
+  #   shirt.size = :medium
+  #   shirt.size.name #=> :medium
+  #   shirt.size.medium? #=> true
+  #
+  #   # You can get the enum values
+  #   Shirt.size.values #=> { small: 1, medium: 2, large: 3 }
+  #
+  module Model
+    module InstanceVariableAccessor # :nodoc:
+      def set(model, name, value)
+        enum = if model.instance_variable_defined?(:@_minenum_enum)
+                 model.instance_variable_get(:@_minenum_enum)
+               else
+                 model.instance_variable_set(:@_minenum_enum, {})
+               end
+        enum[name] = value
+      end
+      module_function :set
+
+      def get(model, name)
+        enum = model.instance_variable_get(:@_minenum_enum)
+        enum&.[](name)
+      end
+      module_function :get
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods # :nodoc:
+      def enum(name, values, adapter: InstanceVariableAccessor)
+        enum_class = Enum::ClassBuilder.build(values)
+
+        const_set(classify(name.to_s), enum_class)
+        singleton_class.define_method(name) { enum_class }
+
+        enum_methods_module.define_method("#{name}=") do |value|
+          adapter.set(self, name, value)
+        end
+
+        enum_methods_module.define_method(name) do
+          enum_class.new(adapter.get(self, name))
+        end
+      end
+
+      private
+
+      def enum_methods_module
+        @enum_methods_module ||= begin
+          mod = Module.new
+          include mod
+          mod
+        end
+      end
+
+      def classify(key)
+        key.gsub(/([a-z\d]+)_?/) { ::Regexp.last_match(1)&.capitalize }
+      end
+    end
+  end
+end

data/lib/minenum/version.rb

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

data/lib/minenum.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'minenum/version'
+require_relative 'minenum/model'

data/minenum.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/minenum/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'minenum'
+  spec.version = Minenum::VERSION
+  spec.authors = ['Loose Coupling']
+  spec.email = ['loosecplg@gmail.com']
+
+  spec.summary = 'Enum for Ruby'
+  spec.description = 'Enum for Ruby'
+  spec.homepage = 'https://github.com/nowlinuxing/minenum'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/CHANGELOG.md"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/sig/minenum/enum/base.rbs

@@ -0,0 +1,9 @@
+module Minenum
+  module Enum
+    class Base
+      attr_reader value: untyped
+
+      def initialize: (untyped) -> void
+    end
+  end
+end

data/sig/minenum/enum/class_builder.rbs

@@ -0,0 +1,19 @@
+module Minenum
+  module Enum
+    module ClassBuilder
+      def self.build: (Hash[String | Symbol, untyped]) -> singleton(Minenum::Enum::Base)
+      def self.new: (Hash[String | Symbol, untyped]) -> ClassBuilder
+
+      @values: Hash[String | Symbol, untyped]
+
+      def initialize: (Hash[String | Symbol, untyped]) -> void
+      def build: -> untyped
+
+      private
+
+      def add_values_method: (untyped, Minenum::Enum::Values) -> void
+      def add_name_method: (untyped, Minenum::Enum::Values) -> void
+      def add_predicate_methods: (untyped, Minenum::Enum::Values) -> void
+    end
+  end
+end

data/sig/minenum/enum/values.rbs

@@ -0,0 +1,16 @@
+module Minenum
+  module Enum
+    class Values
+      attr_reader values: Hash[Symbol, untyped]
+
+      def initialize: (Hash[String | Symbol, untyped]) -> void
+      def each_key: { (Symbol) -> untyped } -> Hash[String | Symbol, untyped]
+      def key: (untyped) -> Symbol?
+      def match?: (String | Symbol, untyped) -> bool
+
+      private
+
+      def match_with_value?: (String | Symbol, untyped) -> bool
+    end
+  end
+end

data/sig/minenum/model.rbs

@@ -0,0 +1,24 @@
+module Minenum
+  module Model
+    interface _Accessor
+      def set: (untyped model, String | Symbol name, untyped value) -> untyped
+      def get: (untyped model, String | Symbol name) -> untyped
+    end
+
+    module InstanceVariableAccessor
+      include _Accessor
+    end
+
+    module ClassMethods
+      def enum: (String | Symbol name, Hash[String | Symbol, untyped], ?adapter: _Accessor) -> void
+
+      private
+
+      def enum_methods_module: -> Module
+      def classify: (String) -> String
+
+      def const_set: [T] (String | Symbol, T) -> T
+      def include: (Module) -> self
+    end
+  end
+end

data/sig/minenum.rbs

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

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: minenum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Loose Coupling
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-22 00:00:00.000000000 Z
+dependencies: []
+description: Enum for Ruby
+email:
+- loosecplg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- lib/minenum.rb
+- lib/minenum/enum.rb
+- lib/minenum/enum/base.rb
+- lib/minenum/enum/class_builder.rb
+- lib/minenum/enum/values.rb
+- lib/minenum/model.rb
+- lib/minenum/version.rb
+- minenum.gemspec
+- sig/minenum.rbs
+- sig/minenum/enum/base.rbs
+- sig/minenum/enum/class_builder.rbs
+- sig/minenum/enum/values.rbs
+- sig/minenum/model.rbs
+homepage: https://github.com/nowlinuxing/minenum
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nowlinuxing/minenum
+  source_code_uri: https://github.com/nowlinuxing/minenum
+  changelog_uri: https://github.com/nowlinuxing/minenum/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Enum for Ruby
+test_files: []