form_attribute 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5122b7ca658f3cfb0ced9493d175fbc0297ae56a40290e66a107a0c9b814d9eb
+  data.tar.gz: 67fd143a8683bb2ca4dd943781ab21e560abf325432aaa82bcc019287ec574ca
+SHA512:
+  metadata.gz: ee33c9ec3542ee74890716fd202b56af220e68b8e227d8833858b6c1d69fec2d1fae01b5be7a432c459ea93e24adf562a5773e5c283691a37d71f5b4737963f2
+  data.tar.gz: de46fff5600fa151a9af04cbbaf3ee1d98d4352acaed09a6dc99dc0041c45f75461bd322f1c31284533d3b7e2ff0bcde0ce73316091d6ada04ba8b669cc7b0d6

data/.github/workflows/ruby.yml

@@ -0,0 +1,36 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run rubocop
+      run: bundle exec rubocop
+    - name: Run reek
+      run: bundle exec reek
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.reek.yml

@@ -0,0 +1,7 @@
+detectors:
+  IrresponsibleModule:
+    enabled: false
+
+  NilCheck:
+    exclude:
+      - "FormAttribute#matching_type_for"

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Style/Documentation:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+  EnforcedStyle: empty_lines
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ollie@nyemail.co.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in form_attribute.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+
+group :test do
+  gem 'simplecov', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    form_attribute (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    kwalify (0.7.2)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    psych (3.3.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    reek (6.0.3)
+      kwalify (~> 0.7.0)
+      parser (~> 3.0.0)
+      psych (~> 3.1)
+      rainbow (>= 2.0, < 4.0)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.8.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.1.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  form_attribute!
+  rake (~> 12.0)
+  reek (~> 6)
+  rspec (~> 3.10)
+  rubocop (~> 1.8)
+  rubocop-rake (~> 0.5)
+  rubocop-rspec (~> 2.1)
+  simplecov
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Ollie Nye
+
+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,126 @@
+# FormAttribute
+
+![Ruby](https://github.com/hex-event-solutions/form-attribute/workflows/Ruby/badge.svg)
+
+A lightweight gem for adding typed attributes to plain objects
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'form_attribute'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install form_attribute
+
+## Usage
+
+Add the line `extend FormAttribute` to your class, then start defining
+attributes as in the example below:
+
+```ruby
+class Person
+  extend FormAttribute
+
+  attribute :name, String
+  attribute :role, String, default: 'user'
+  attribute :employee, Boolean, default: true
+  attribute :contact, [String, Integer]
+  attribute :date_of_birth, Time
+end
+```
+
+Attribute definitions follow the pattern `attribute <name>, <types>, <options>`.
+`<types>` can be an array of allowed types or a single allowed type. When
+setting the value, it will be validated against this list of types and will
+raise a `TypeError` if the value being set is not one of these types.
+
+Attributes on an object can be read with `Class.attributes`
+
+```ruby
+Person.attributes
+=> [:name, :role, :employee, :contact, :date_of_birth]
+```
+
+The type of an attribute can be read with `Class.type_of(<attribute>)`
+
+```ruby
+Person.type_of :name
+=> [String]
+
+Person.type_of :contact
+=> [String, Integer]
+```
+
+The default value of an attribute can be read with
+`Class.default_for(<attribute>)`
+
+```ruby
+Person.default_for :role
+=> "user"
+```
+
+Each attribute is available as a method on the object created.
+
+```ruby
+person = Person.new
+=> #<Person name: nil, role: "user", employee: true, contact: nil, date_of_birth: nil>
+
+person.name
+=> nil
+
+person.role
+=> "user"
+```
+
+Setting attributes is also available as a method
+
+```ruby
+person.name = 'John Smith'
+=> "John Smith"
+
+person.name
+=> "John Smith"
+```
+
+## 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 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/hex-event-solutions/form_attribute. This project is intended
+to be a safe, welcoming space for collaboration, and contributors are expected
+to adhere to the
+[code of conduct](https://github.com/hex-event-solutions/form_attribute/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FormAttribute project's codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/hex-event-solutions/form_attribute/blob/master/CODE_OF_CONDUCT.md).
+
+```
+
+```

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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'form_attribute'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/form_attribute.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/form_attribute/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'form_attribute'
+  spec.version       = FormAttribute::VERSION
+  spec.authors       = ['Ollie Nye']
+  spec.email         = ['ollie@nyemail.co.uk']
+
+  spec.summary       = 'A lightweight gem for adding typed attributes to plain objects.'
+  spec.description   = 'A lightweight gem for adding typed attributes to plain objects.'
+  spec.homepage      = 'https://github.com/hex-event-solutions/form-attribute'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/hex-event-solutions/form-attribute'
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'reek', '~> 6'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.8'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.5'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.1'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
+end

data/lib/form_attribute.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'form_attribute/version'
+require 'form_attribute/errors'
+require 'form_attribute/boolean'
+
+module FormAttribute
+  def self.extended(base)
+    base.instance_variable_set('@attrs', {})
+    base.include InstanceMethods
+    base.define_method('initialize') do |**attributes|
+      write_many(**attributes)
+    end
+  end
+
+  def attribute(name, type, options = {})
+    name = name.to_sym
+    default = options[:default]
+
+    init_attribute(name, type, default)
+
+    matching_type_for(name, default)
+
+    define_accessors(name)
+  end
+
+  def attributes
+    @attrs.keys
+  end
+
+  def type_of(name)
+    attr(name)[:type]
+  end
+
+  def default_for(name)
+    attr(name)[:default]
+  end
+
+  def matching_type_for(name, value)
+    return true if value.nil?
+
+    type_of(name).each do |type|
+      return true if value.is_a? type
+    end
+    raise TypeError, "Value for #{name.inspect} is the wrong type"
+  end
+
+  private
+
+  def init_attribute(name, type, default)
+    @attrs[name] = {
+      type: [type].flatten,
+      default: default
+    }
+  end
+
+  def define_accessors(name)
+    define_method("#{name}=") { |value| write_attribute(name, value) }
+    define_method(name) { read_attribute(name) }
+  end
+
+  def attr(name)
+    attribute = @attrs[name]
+    return attribute if attribute
+
+    raise UnknownAttributeName, name.inspect
+  end
+
+  module InstanceMethods
+    def inspect
+      attrs = attributes.map { |name| "#{name}: #{read_attribute(name).inspect}" }.join(', ')
+      "#<#{self.class} #{attrs}>"
+    end
+
+    private
+
+    def write_many(**attributes)
+      attributes.each { |name, value| write_attribute(name, value) }
+    end
+
+    def write_attribute(name, value)
+      matching_type_for(name, value)
+      instance_variable_set("@#{name}", value)
+    end
+
+    def read_attribute(name)
+      raise UnknownAttributeName, name unless attributes.include? name
+
+      value = instance_variable_get("@#{name}")
+      value || default_for(name)
+    end
+
+    def attributes
+      self.class.attributes
+    end
+
+    def matching_type_for(name, value)
+      self.class.matching_type_for(name, value)
+    end
+
+    def default_for(name)
+      self.class.default_for(name)
+    end
+  end
+end

data/lib/form_attribute/boolean.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Boolean; end
+
+class TrueClass; include Boolean; end
+
+class FalseClass; include Boolean; end

data/lib/form_attribute/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Error < StandardError; end
+
+class UnknownAttributeName < Error; end

data/lib/form_attribute/version.rb

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: form_attribute
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ollie Nye
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+description: A lightweight gem for adding typed attributes to plain objects.
+email:
+- ollie@nyemail.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- form_attribute.gemspec
+- lib/form_attribute.rb
+- lib/form_attribute/boolean.rb
+- lib/form_attribute/errors.rb
+- lib/form_attribute/version.rb
+homepage: https://github.com/hex-event-solutions/form-attribute
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hex-event-solutions/form-attribute
+  source_code_uri: https://github.com/hex-event-solutions/form-attribute
+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.1.4
+signing_key: 
+specification_version: 4
+summary: A lightweight gem for adding typed attributes to plain objects.
+test_files: []