option_set 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8060b52926fea6b9958f27f06f5e6e900e4959214628c9d179bd766ff6e46b2
+  data.tar.gz: 83978bd41bad8ed429b5656be2b82ad0658a2b2d3676ac0d6c57cf9710740d3d
+SHA512:
+  metadata.gz: 519bfbeee55cc992ddee434eb33fa430857a4466995115a5014ee6a07806ea2bd0d994acd98d0fc78466b223bdeb5401ef8d10134c47e33ade1d51bcf67f8844
+  data.tar.gz: 0faf39bb2c5e3fdf8a57722dc837bd623d9daac32097446c1b1b2bb851d79b4f96f0d5106a6bff7bd3f7b9fbdccff5134e7e2b9b6a4b5a52a20195c546e4ce39

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,6 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1
+plugins:
+  - standard-performance
+  # - standard-rspec

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-02-25
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Mateus Armando
+
+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,60 @@
+# OptionSet
+
+TODO: Delete this and the text below, and describe your gem
+
+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/option_set`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+```ruby
+
+class ShippingOptions
+  include OptionSet
+  
+  define_options :next_day, :second_day, :priority, :standard
+  
+  EXPRESS = ShippingOptions.from(array: [NEXT_DAY, SECOND_DAY])
+  ALL = ShippingOptions.from(array: [EXPRESS, PRIORITY, STANDARD])
+end
+
+opts = ShippingOptions::EXPRESS
+
+opts.next_day?   # => true
+opts.second_day? # => true
+opt.priority?    # false
+opt.standard?  # false
+
+opts.remove(ShippingOptions::NEXT_DAY)
+```
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/option_set.
+
+## 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,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/option_set/option_set.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+# The OptionSet module provides a way to define and manipulate bit flag options.
+# It allows for defining methods to check, set, and toggle options represented by bit flags.
+#
+# @example Basic usage
+#   class Permissions
+#     include OptionSet
+#     define_options :read, :write, :delete
+#   end
+#
+#   perms = Permissions.new
+#   perms.read!       # Set read flag
+#   perms.write = true # Set write flag
+#   perms.read?       # => true
+#   perms.contains?(Permissions::DELETE) # => false
+#   perms.values      # => ["READ", "WRITE"]opt
+#
+# @example Using a hash with custom bit values
+#   class Features
+#     include OptionSet
+#     define_options basic: 1, premium: 2, enterprise: 4
+#   end
+#
+module OptionSet
+  # Called when this module is included in another class
+  #
+  # @param base [Class] The class including this module
+  # @return [void]
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  # Module containing class methods to be extended into the including class
+  module ClassMethods
+    # Defines options and creates associated methods for bit flag manipulation
+    #
+    # @overload define_options(*symbols)
+    #   @param symbols [Array<Symbol>] A list of symbols representing options
+    #   @example define_options(:read, :write, :execute)
+    #
+    # @overload define_options(hash)
+    #   @param hash [Hash{Symbol => Integer}] A hash mapping option names to bit values
+    #   @example define_options(basic: 1, premium: 2, enterprise: 4)
+    #
+    # @raise [ArgumentError] If options are not provided as symbols or a hash
+    # @return [void]
+    def define_options(*options)
+      # Initialize option_values, merging from parent if available
+      @option_values = {}
+
+      option_hash = parse_options(options)
+      define_option_methods(option_hash)
+    end
+
+    # Creates a new instance with the provided numeric value
+    #
+    # @param opts [Hash] the options to create an OptionSet.
+    # @param opts [Integer] :value The bit value for initializing the option set
+    # @param opts [Array<Integer>] :array a list of bits value for initializing the option set
+    #
+    # @return [OptionSet] A new instance with the specified value
+    def from(value: nil, array: [])
+      raise ArgumentError, 'Options must be an Array of Symbols or a Integer' if value.nil? && array.empty?
+
+      input = value || array.reduce(0) { |result, option| result | (option.is_a?(self) ? option.value : option) }
+      new(input)
+    end
+
+    private
+
+    # Parses options into a hash mapping option names to bit values
+    #
+    # @param options [Array] Options provided to define_options
+    # @return [Hash{Symbol => Integer}] A hash mapping option names to bit values
+    #
+    # @raise [ArgumentError] If options are not provided as symbols or a hash
+    def parse_options(options)
+      case options.first
+      when Symbol
+        options.each_with_index.with_object({}) { |(option, index), hash| hash[option] = 1 << index }
+      when Hash
+        options.first
+      else
+        raise ArgumentError, 'Options must be an Array of Symbols or a Hash'
+      end
+    end
+
+    # Defines methods and constants for each option
+    #
+    # @param options [Hash{Symbol => Integer}] A hash mapping option names to bit values
+    #
+    # @return [void]
+    def define_option_methods(options)
+      options.each do |option, value|
+        const_set(option.to_s.upcase, value)
+        @option_values[value] = option
+
+        # Define predicate methods
+        define_method(option) { contains?(value) }
+        define_method(:"#{option}?") { contains?(value) }
+
+        # Define mutator methods
+        define_method(:"#{option}!") { add(value) }
+        define_method(:"#{option}=") { |val| val ? add(value) : remove(value) }
+      end
+    end
+
+    # Returns the mapping of option values to option names
+    #
+    # @return [Hash{Integer => Symbol}] A hash mapping bit values to option names
+    # @api private
+    def option_values
+      @option_values ||= {}
+    end
+  end
+
+  private_constant :ClassMethods
+
+  # @return [Integer] The current bit value
+  attr_reader :value
+
+  # Initialize a new option set
+  #
+  # @param value [Integer] Initial bit value (default: 0)
+  def initialize(value = 0)
+    @value = value
+  end
+
+  # Check if the option set contains the specified option
+  #
+  # @param option [Integer, self] The bit value to check
+  # @return [Boolean] true if the option is set, false otherwise
+  def contains?(option)
+    option = option.value if option.is_a?(self.class)
+    (@value & option) == option
+  end
+
+  # Add an option to the set
+  #
+  # @param option [Integer, self] The bit value to add
+  # @return [self] Returns self for method chaining
+  def add(option)
+    option = option.value if option.is_a?(self.class)
+    @value |= option
+    self
+  end
+
+  # Remove an option from the set
+  #
+  # @param option [Integer, self] The bit value to remove
+  # @return [self] Returns self for method chaining
+  def remove(option)
+    option = option.value if option.is_a?(self.class)
+    @value &= ~option
+    self
+  end
+
+  # Toggle an option in the set
+  #
+  # @param option [Integer] The bit value to toggle
+  # @return [self] Returns self for method chaining
+  def toggle(option)
+    option = option.value if option.is_a?(self.class)
+    @value ^= option
+    self
+  end
+
+  # Clear all options in the set
+  #
+  # @return [self] Returns self for method chainin
+  def clear
+    @value = 0
+    self
+  end
+
+  # Get the symbolic names of all set options
+  #
+  # @return [Array<Symbol>] Array of uppercase option names that are enabled
+  def values
+    option_values = self.class.send(:option_values)
+    option_values.select { |k, _| contains?(k) }
+                 .values.map(&:upcase)
+  end
+end

data/lib/option_set/version.rb

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

data/lib/option_set.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'option_set/version'
+require_relative 'option_set/option_set'
+
+module OptionSet
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/option_set.rbs

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

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: option_set
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mateus
+bindir: exe
+cert_chain: []
+date: 2025-02-25 00:00:00.000000000 Z
+dependencies: []
+description: |
+  OptionSet ame it easier to represent bitset types, where individual bits constants,
+  it allows the usage to the usual bitset functionalities
+email:
+- Mateus@tester.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/option_set.rb
+- lib/option_set/option_set.rb
+- lib/option_set/version.rb
+- sig/option_set.rbs
+homepage: https://gitlab.com/seanlilmateus/option_set
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/seanlilmateus/option_set
+  source_code_uri: https://gitlab.com/seanlilmateus/option_set.git
+  changelog_uri: https://gitlab.com/seanlilmateus/option_set/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.2
+specification_version: 4
+summary: A type that presents a mathematical set interface to a bit set.
+test_files: []