literal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 02ab6065a85602e1f60d915cb11cf8e0505881894ec9df310f08fc9194124a77
+  data.tar.gz: d86ff5c802deb2896486fa016da1f851af1296be511b79f5eab779a6e7bcb169
+SHA512:
+  metadata.gz: de1ddb15cb9172712bc0534ac4c4c09aeb8d224496e8dcfe913cb03a1f3d4496b7ceee128e0eda7f94ada97dfa16160acafbae130165e7662a6714a6e25c2e67
+  data.tar.gz: 59a8bebc8c29ca4b62ba2c0adb6acc03037f92589465012fcbb8edafbe3d8acb36526439c6acad3346f2e4f9210c3b33902a03395b2e1ddf7221dc3cd5d46f57

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-03
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 joel@drapper.me. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in strict_attributes.gemspec
+gemspec
+
+gem "zeitwerk"
+gem "green_dots", git: "https://github.com/joeldrapper/green_dots.git"

data/Gemfile.lock

@@ -0,0 +1,29 @@
+GIT
+  remote: https://github.com/joeldrapper/green_dots.git
+  revision: 776745d38c9523e403b445eeef8b374ffb130f8b
+  specs:
+    green_dots (0.1.0)
+      concurrent-ruby
+      zeitwerk
+
+PATH
+  remote: .
+  specs:
+    literal (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.2.2)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  green_dots!
+  literal!
+  zeitwerk
+
+BUNDLED WITH
+   2.4.12

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Joel Drapper
+
+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,112 @@
+# Literal
+
+## Basic Usage
+
+### Mixin
+
+```ruby
+class User
+  include Literal
+
+  attribute :name, String
+  attribute :age, Integer
+end
+```
+
+### Struct
+
+```ruby
+class Person < Literal::Struct
+  attribute :name, String
+  attribute :age, Integer
+end
+```
+
+### Data
+
+```ruby
+class Person < Literal::Data
+  attribute :name, String
+  attribute :age, Integer
+end
+```
+
+## Special Types
+
+### Union
+
+```ruby
+_Union(String, Symbol)
+```
+
+### Boolean
+
+```ruby
+_Boolean
+```
+
+### Maybe
+
+```ruby
+_Maybe(String)
+```
+
+### Array
+
+```ruby
+_Array(String)
+```
+
+### Set
+
+```ruby
+_Set(String)
+```
+
+### Enumerable
+
+```ruby
+_Enumerable(String)
+```
+
+### Tuple
+An Enumerable containing exactly the specified types in order.
+
+```ruby
+_Tuple(String, Integer)
+```
+
+### Hash
+
+```ruby
+_Hash(String, Integer)
+```
+
+### Interface
+```ruby
+_Interface(:to_s)
+```
+
+### Class
+
+```ruby
+_Class(RuntimeError)
+```
+
+### Module
+
+```ruby
+_Module(Enumerable)
+```
+
+### Integer
+You can of course just use `Integer` to specify an integer type. The special type `_Integer` allows you to limit that type with a range, while verifying that it's an integer and not something else that matches the range such as a float.
+
+```
+_Integer(18..)
+```
+
+You can use these types together.
+```ruby
+_Maybe(Union(String, Symbol, Interface(:to_s), Interface(:to_str), Tuple(String, Symbol)))
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+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/literal/attributes.rb

@@ -0,0 +1,33 @@
+module Literal::Attributes
+  extend Literal::Types
+
+  def attribute(name, type, reader: false, writer: :private)
+    __attributes__ << name
+
+    writer_name = :"#{name}="
+    ivar_name = :"@#{name}"
+
+    define_method writer_name do |value|
+      raise Literal::TypeError, "Expected `#{value.inspect}` to be a `#{type.inspect}`." unless type === value
+      instance_variable_set(ivar_name, value)
+    end
+
+    private writer_name unless writer == :public
+
+    if reader
+      attr_reader name
+      private name unless reader == :public
+    end
+
+    name
+  end
+
+  def __attributes__
+    return @__attributes__ if defined?(@__attributes__)
+    @__attributes__ = superclass.is_a?(self) ? superclass.__attributes__.dup : []
+  end
+
+  def self.extended(base)
+    base.include(Literal::Initializer)
+  end
+end

data/lib/literal/data.rb

@@ -0,0 +1,12 @@
+class Literal::Data < Literal::Struct
+  def initialize(...)
+    super
+    @attributes.each(&:freeze)
+    @attributes.freeze
+    freeze
+  end
+
+  def dup(**attributes)
+    self.class.new(**@attributes.merge(attributes))
+  end
+end

data/lib/literal/initializer.rb

@@ -0,0 +1,11 @@
+module Literal::Initializer
+  def initialize(**attributes)
+    self.class.__attributes__.each do |name|
+      attributes[name] ||= nil
+    end
+
+    attributes.each do |name, value|
+      send("#{name}=", value)
+    end
+  end
+end

data/lib/literal/model.rb

@@ -0,0 +1,22 @@
+class Literal::Model
+  extend Literal::Types
+  include Literal::Initializer
+
+  def self.__attributes__
+    return @required_attributes if defined?(@required_attributes)
+    @required_attributes = superclass.is_a?(self) ? superclass.required_attributes.dup : []
+  end
+
+  def self.attribute(name, type)
+    __attributes__ << name
+
+    writer_name = :"#{name}="
+
+    define_method writer_name do |value|
+      raise Literal::TypeError, "Expected #{name}: `#{value.inspect}` to be: `#{type.inspect}`." unless type === value
+      super(value)
+    end
+
+    name
+  end
+end

data/lib/literal/struct.rb

@@ -0,0 +1,35 @@
+class Literal::Struct
+  extend Literal::Types
+  include Literal::Initializer
+
+  def initialize(...)
+    @attributes = {}
+    super
+  end
+
+  def self.__attributes__
+    return @__attributes__ if defined?(@__attributes__)
+    @__attributes__ = superclass.is_a?(self) ? superclass.__attributes__.dup : []
+  end
+
+  def self.attribute(name, type, writer: :private)
+    __attributes__ << name
+
+    writer_name = :"#{name}="
+
+    define_method writer_name do |value|
+      raise Literal::TypeError, "Expected #{name}: `#{value.inspect}` to be: `#{type.inspect}`." unless type === value
+      @attributes[name] = value
+    end
+
+    define_method name do
+      @attributes[name]
+    end
+
+    name
+  end
+
+  def to_h
+    @attributes.dup
+  end
+end

data/lib/literal/types/any_type.rb

@@ -0,0 +1,5 @@
+module Literal::Types::AnyType
+  def self.===(value)
+    true
+  end
+end

data/lib/literal/types/array_type.rb

@@ -0,0 +1,13 @@
+class Literal::Types::ArrayType
+  def initialize(type)
+    @type = type
+  end
+
+  def inspect
+    "Array(#{@type.inspect})"
+  end
+
+  def ===(value)
+    value.is_a?(::Array) && value.all? { |item| @type === item }
+  end
+end

data/lib/literal/types/boolean_type.rb

@@ -0,0 +1 @@
+Literal::Types::BooleanType = Literal::Types::UnionType.new(true, false)

data/lib/literal/types/class_type.rb

@@ -0,0 +1,13 @@
+class Literal::Types::ClassType
+  def initialize(type)
+    @type = type
+  end
+
+  def inspect
+    "Class(#{@type.name})"
+  end
+
+  def ===(value)
+    value.is_a?(::Class) && (value == @type || value < @type)
+  end
+end

data/lib/literal/types/enumerable_type.rb

@@ -0,0 +1,13 @@
+class Literal::Types::EnumerableType
+  def initialize(type)
+    @type = type
+  end
+
+  def inspect
+    "Enumerable(#{@type.inspect})"
+  end
+
+  def ===(value)
+    value.is_a?(::Enumerable) && value.all? { |item| @type === item }
+  end
+end

data/lib/literal/types/float_type.rb

@@ -0,0 +1,13 @@
+class Literal::Types::FloatType
+  def initialize(range)
+    @range = range
+  end
+
+  def inspect
+    "Float(#{@range})"
+  end
+
+  def ===(other)
+    other.is_a?(::Float) && @range === other
+  end
+end

data/lib/literal/types/hash_type.rb

@@ -0,0 +1,14 @@
+class Literal::Types::HashType
+  def initialize(key_type, value_type)
+    @key_type = key_type
+    @value_type = value_type
+  end
+
+  def inspect
+    "Hash(#{@key_type.inspect}, #{@value_type.inspect})"
+  end
+
+  def ===(value)
+    value.is_a?(::Hash) && value.all? { |key, value| @key_type === key && @value_type === value }
+  end
+end

data/lib/literal/types/integer_type.rb

@@ -0,0 +1,13 @@
+class Literal::Types::IntegerType
+  def initialize(range)
+    @range = range
+  end
+
+  def inspect
+    "Integer(#{@range})"
+  end
+
+  def ===(other)
+    other.is_a?(::Integer) && @range === other
+  end
+end

data/lib/literal/types/interface_type.rb

@@ -0,0 +1,13 @@
+class Literal::Types::InterfaceType
+  def initialize(*methods)
+    @methods = methods
+  end
+
+  def inspect
+    "Interface(#{@methods.map(&:inspect).join(", ")})"
+  end
+
+  def ===(other)
+    @methods.all? { |method| other.respond_to?(method) }
+  end
+end

data/lib/literal/types/set_type.rb

@@ -0,0 +1,13 @@
+class Literal::Types::SetType
+  def initialize(type)
+    @type = type
+  end
+
+  def inspect
+    "Set(#{@type.inspect})"
+  end
+
+  def ===(value)
+    value.is_a?(::Set) && value.all? { |item| @type === item }
+  end
+end

data/lib/literal/types/tuple_type.rb

@@ -0,0 +1,13 @@
+class Literal::Types::TupleType
+  def initialize(*types)
+    @types = types
+  end
+
+  def inspect
+    "Tuple(#{@types.map(&:inspect).join(", ")})"
+  end
+
+  def ===(value)
+    value.is_a?(::Enumerable) && value.size == @types.size && value.zip(@types).all? { |value, type| type === value }
+  end
+end

data/lib/literal/types/union_type.rb

@@ -0,0 +1,13 @@
+class Literal::Types::UnionType
+  def initialize(*types)
+    @types = types
+  end
+
+  def inspect
+    "Union(#{@types.map(&:inspect).join(", ")})"
+  end
+
+  def ===(value)
+    @types.any? { |type| type === value }
+  end
+end

data/lib/literal/types.rb

@@ -0,0 +1,56 @@
+module Literal::Types
+  def _Union(*types)
+    raise Literal::ArgumentError, "Union type must have at least two types." if types.size < 2
+    Literal::Types::UnionType.new(*types)
+  end
+
+  def _Array(type)
+    Literal::Types::ArrayType.new(type)
+  end
+
+  def _Set(type)
+    Literal::Types::SetType.new(type)
+  end
+
+  def _Enumerable(type)
+    Literal::Types::EnumerableType.new(type)
+  end
+
+  def _Hash(key_type, value_type)
+    Literal::Types::HashType.new(key_type, value_type)
+  end
+
+  def _Interface(*methods)
+    raise Literal::ArgumentError, "Interface type must have at least one method." if methods.size < 1
+    Literal::Types::InterfaceType.new(*methods)
+  end
+
+  def _Maybe(type)
+    _Union(type, nil)
+  end
+
+  def _Any
+    Literal::Types::AnyType
+  end
+
+  def _Boolean
+    Literal::Types::BooleanType
+  end
+
+  def _Class(type)
+    Literal::Types::ClassType.new(type)
+  end
+
+  def _Tuple(*types)
+    raise Literal::ArgumentError, "Tuple type must have at least one type." if types.size < 1
+    Literal::Types::TupleType.new(*types)
+  end
+
+  def _Integer(range)
+    Literal::Types::IntegerType.new(range)
+  end
+
+  def _Float(range)
+    Literal::Types::FloatType.new(range)
+  end
+end

data/lib/literal/version.rb

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

data/lib/literal.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "literal/version"
+
+module Literal
+  Loader = Zeitwerk::Loader.for_gem.tap(&:setup)
+
+  module Error; end
+
+  class TypeError < ::TypeError
+    include Error
+  end
+
+  class ArgumentError < ::ArgumentError
+    include Error
+  end
+end

data/literal.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/literal/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "literal"
+  spec.version = Literal::VERSION
+  spec.authors = ["Joel Drapper"]
+  spec.email = ["joel@drapper.me"]
+
+  spec.summary = "Strict Attributes is a gem that allows you to define strict attributes on your models."
+  spec.description = "Strict Attributes is a gem that allows you to define strict attributes on your models."
+  spec.homepage = "https://github.com/joeldrapper/literal"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/joeldrapper/literal"
+  spec.metadata["changelog_uri"] = "https://github.com/joeldrapper/literal/blob/master/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 .circleci appveyor])
+    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
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: literal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Drapper
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-03 00:00:00.000000000 Z
+dependencies: []
+description: Strict Attributes is a gem that allows you to define strict attributes
+  on your models.
+email:
+- joel@drapper.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/literal.rb
+- lib/literal/attributes.rb
+- lib/literal/data.rb
+- lib/literal/initializer.rb
+- lib/literal/model.rb
+- lib/literal/struct.rb
+- lib/literal/types.rb
+- lib/literal/types/any_type.rb
+- lib/literal/types/array_type.rb
+- lib/literal/types/boolean_type.rb
+- lib/literal/types/class_type.rb
+- lib/literal/types/enumerable_type.rb
+- lib/literal/types/float_type.rb
+- lib/literal/types/hash_type.rb
+- lib/literal/types/integer_type.rb
+- lib/literal/types/interface_type.rb
+- lib/literal/types/set_type.rb
+- lib/literal/types/tuple_type.rb
+- lib/literal/types/union_type.rb
+- lib/literal/version.rb
+- literal.gemspec
+homepage: https://github.com/joeldrapper/literal
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/joeldrapper/literal
+  source_code_uri: https://github.com/joeldrapper/literal
+  changelog_uri: https://github.com/joeldrapper/literal/blob/master/CHANGELOG.md
+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.4.6
+signing_key:
+specification_version: 4
+summary: Strict Attributes is a gem that allows you to define strict attributes on
+  your models.
+test_files: []