ruckt 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f40c0a659f8c3fa90cb6e4baa38f2a7d87e39d816370416ea8da3ac15bfc79a9
+  data.tar.gz: e31ac3cd16321e27c790e1717533f7b0de917288dcf79fd3468d55f87e54e565
+SHA512:
+  metadata.gz: 6e4b897df7da094dd111e93eabd94172f442b1a92f4d7689b2e4dd963761718ba1e5b52ada3ef18ff5cf9d9df07586a05d4895a5bf95c2307d87cc6dea1cc233
+  data.tar.gz: 163a5e57fb3b9b66b03923b56ad6e42f5d555a7842419e98be5c5af41bee133e49f41dec8c6ec0b9e8d41819c0836f6e5bf07efca73c0d4797e6c224017d1a16

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## [Unreleased]
+
+## [0.1.1] - 2024-03-27
+
+- Fixed type validation for boolean values
+- Improved nested structure handling
+- Added comprehensive test coverage
+- Added detailed documentation
+
+## [0.1.0] - 2024-03-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 TODO: Write your name
+
+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,98 @@
+# Ruckt
+
+[![Gem Version](https://badge.fury.io/rb/ruck.svg)](https://badge.fury.io/rb/ruck)
+[![RSpec](https://github.com/OkayDave/ruck/actions/workflows/rspec.yml/badge.svg)](https://github.com/OkayDave/ruck/actions/workflows/rspec.yml)
+[![Coverage Status](https://coveralls.io/repos/github/dave/ruck/badge.svg?branch=main)](https://coveralls.io/github/dave/ruck?branch=main)
+
+A flexible, type-safe struct generator for Ruby that automatically infers and creates Ruby Struct-like classes from arbitrary data sources with runtime type validation.
+
+## Features
+
+- Dynamic Struct Generation: Classes auto-created from hashes/data samples
+- Type Safety: Runtime type validation for all attributes
+- Nested Structures: Automatic handling of nested hashes
+- Query Methods: Automatic boolean attribute methods (e.g., `active?`)
+- Clear Error Messages: Descriptive errors for type mismatches
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruckt'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install ruckt
+```
+
+## Usage
+
+### Basic Example
+
+```ruby
+require 'ruckt'
+
+# Create a struct from a hash
+data = {
+  name: "Dave",
+  age: 40,
+  active: true
+}
+
+user = Ruckt.new(data)
+
+# Access attributes
+user.name      # => "Dave"
+user.age       # => 40
+user.active?   # => true
+
+# Set attributes
+user.name = "John"  # => works fine
+user.age = "forty"  # => raises TypeError
+```
+
+### Nested Structures
+
+```ruby
+data = {
+  name: "Dave",
+  location: {
+    city: "Sheffield",
+    postcode: "S2"
+  }
+}
+
+person = Ruckt.new(data)
+
+# Access nested attributes
+person.location.city      # => "Sheffield"
+person.location.postcode  # => "S2"
+
+# Type validation works for nested structures too
+person.location.city = 123  # => raises TypeError
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+Please ensure that any additions are fully covered by RSpec.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dave/ruck.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/ruckt/struct_generator.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Ruckt
+  # The StructGenerator class is responsible for dynamically creating struct-like classes
+  # from hash data. It provides type safety and validation while maintaining a simple interface.
+  class StructGenerator
+    class << self
+      # Generates a new struct-like class from a hash of data
+      # @param data [Hash] The hash containing the data structure to model
+      # @return [Class] A new class with typed attributes matching the data structure
+      def generate(data)
+        # If input isn't a hash, return it as-is (handles non-hash edge cases)
+        return data unless data.is_a?(Hash)
+
+        # Create a new anonymous class that will become our struct
+        Class.new do
+          # Include type validation functionality
+          include TypeValidation
+
+          # Store type information for all attributes
+          # This will be used for validation when setting values
+          @type_info = {}
+
+          class << self
+            # Make type information accessible to instances
+            attr_reader :type_info
+
+            # Determines the type of a value for validation purposes
+            # @param value [Object] The value to infer the type from
+            # @return [Class, Array<Class>] The inferred type(s)
+            def infer_type(value)
+              case value
+              when Hash
+                # Empty hashes stay as Hash, non-empty become nested structs
+                value.empty? ? Hash : StructGenerator.generate(value)
+              when TrueClass, FalseClass
+                # Booleans can be either true or false, so we accept both types
+                [TrueClass, FalseClass]
+              else
+                # For all other values, use their class as the type
+                value.class
+              end
+            end
+          end
+
+          # Iterate through the data hash to define our struct's attributes
+          data.each do |key, value|
+            # Store the inferred type for this attribute
+            @type_info[key] = infer_type(value)
+
+            # Define a getter method that returns the instance variable
+            define_method(key) do 
+              instance_variable_get("@#{key}")
+            end
+
+            # Define a setter method with type validation
+            define_method("#{key}=") do |val|
+              # Special handling for nested hash updates
+              if val.is_a?(Hash) && self.class.type_info[key].is_a?(Class) && 
+                 self.class.type_info[key].respond_to?(:type_info)
+                # Create a temporary instance to validate the nested data
+                # This ensures all nested values have correct types
+                temp_instance = self.class.type_info[key].new
+                val.each do |k, v|
+                  temp_instance.send("#{k}=", v)
+                end
+                instance_variable_set("@#{key}", temp_instance)
+              else
+                # For non-nested values, validate and set directly
+                validate_type(key, val)
+                instance_variable_set("@#{key}", val)
+              end
+            end
+            
+            # For boolean attributes, add a convenience query method
+            # that ends with '?' (e.g., active?)
+            if value.is_a?(TrueClass) || value.is_a?(FalseClass)
+              define_method("#{key}?") { instance_variable_get("@#{key}") }
+            end
+
+            # For non-empty hashes, create a nested struct class
+            if value.is_a?(Hash) && !value.empty?
+              nested_class = StructGenerator.generate(value)
+              const_set(key.to_s.capitalize, nested_class)
+            end
+          end
+
+          # Define the initialize method that sets up a new instance
+          define_method(:initialize) do |values = {}|
+            values.each do |key, value|
+              # Special handling for nested structs
+              if self.class.type_info[key].is_a?(Class) && value.is_a?(Hash) &&
+                 self.class.type_info[key].respond_to?(:type_info)
+                instance_variable_set("@#{key}", self.class.type_info[key].new(value))
+              else
+                # For non-nested values, use the setter for validation
+                send("#{key}=", value)
+              end
+            end
+          end
+        end
+      end
+    end
+
+    # Module containing type validation functionality
+    # This is mixed into generated struct classes
+    module TypeValidation
+      # Validates that a value matches the expected type for an attribute
+      # @param key [Symbol] The attribute name
+      # @param value [Object] The value to validate
+      # @raise [TypeError] If the value doesn't match the expected type
+      def validate_type(key, value)
+        expected_type = self.class.type_info[key]
+        
+        # Handle cases where multiple types are allowed (e.g., true/false)
+        if expected_type.is_a?(Array)
+          return if expected_type.any? { |type| value.is_a?(type) }
+          raise TypeError, "Expected #{key} to be one of #{expected_type.join(', ')}, got #{value.class}"
+        end
+
+        # Handle single type validation
+        return if value.is_a?(expected_type)
+        raise TypeError, "Expected #{key} to be #{expected_type}, got #{value.class}"
+      end
+    end
+  end
+end 

data/lib/ruckt/version.rb

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

data/lib/ruckt.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "ruckt/version"
+require_relative "ruckt/struct_generator"
+
+module Ruckt
+  class Error < StandardError; end
+
+  class << self
+    def new(data)
+      StructGenerator.generate(data)
+    end
+  end
+end 

data/sig/ruckt.rbs

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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: ruckt
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Dave Russell
+bindir: exe
+cert_chain: []
+date: 2025-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.57'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.57'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.27'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.27'
+description: Automatically infer and create Ruby Struct-like classes from arbitrary
+  data sources with runtime type validation
+email:
+- dave.kerr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruckt.rb
+- lib/ruckt/struct_generator.rb
+- lib/ruckt/version.rb
+- sig/ruckt.rbs
+homepage: https://github.com/dave/ruckt
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/dave/ruckt
+  source_code_uri: https://github.com/dave/ruckt
+  changelog_uri: https://github.com/dave/ruckt/blob/main/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 flexible, type-safe struct generator for Ruby
+test_files: []