Move ostruct-sanitizer gem

.github/workflows/ostruct-sanitizer.yml

@@ -0,0 +1,12 @@
+name: ostruct-sanitizer
+
+on:
+  push:
+
+jobs:
+  ruby:
+    uses: powerhome/github-actions-workflows/.github/workflows/ruby-gem.yml@main
+    with:
+      package: ${{ github.workflow }}
+      workdir: "packages/${{ github.workflow }}"
+    secrets: inherit

packages/ostruct-sanitizer/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

packages/ostruct-sanitizer/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ostruct-sanitizer.gemspec
+gemspec

packages/ostruct-sanitizer/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Diego Borges
+
+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.

packages/ostruct-sanitizer/Rakefile

@@ -0,0 +1,11 @@
+# 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(:rubocop)
+
+task default: %i[rubocop spec]

packages/ostruct-sanitizer/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ostruct/sanitizer"
+
+# 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

packages/ostruct-sanitizer/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

packages/ostruct-sanitizer/docs/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 [email protected]. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

packages/ostruct-sanitizer/docs/README.md

@@ -0,0 +1,60 @@
+# OStruct::Sanitizer
+
+[![Build Status](https://travis-ci.org/powerhome/ostruct-sanitizer.svg?branch=master)](https://travis-ci.org/powerhome/ostruct-sanitizer)
+
+Provides Rails-like sanitization hooks to be applied to OpenStruct fields upon their assignment, allowing for better encapsulation of such rules and simple extensibility.
+
+This module provides a few built-in sanitization rules, all built upon the basic `#sanitize` method used as building block.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ostruct-sanitizer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ostruct-sanitizer
+
+## Usage
+
+More complex sanitization rules may be created using the `#sanitize` method.
+
+```ruby
+require "ostruct"
+require "ostruct/sanitizer"
+
+class User < OpenStruct
+  include OStruct::Sanitizer
+
+  truncate :first_name, :last_name, length: 10
+  alphanumeric :city, :country
+  strip :email, :phone
+
+  sanitize :age do |value|
+    # Apply more complex sanitization rule to the value of "age" returning the
+    # final, sanitized value.
+  end
+end
+```
+
+## 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/[USERNAME]/ostruct-sanitizer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

packages/ostruct-sanitizer/lib/ostruct/sanitizer.rb

@@ -0,0 +1,147 @@
+require "ostruct"
+require "ostruct/sanitizer/version"
+
+module OStruct
+  # Provides a series of sanitization rules to be applied on OpenStruct fields on
+  # a Rails-ish fashion.
+  #
+  # @example
+  #   class Person < OpenStruct
+  #     include OStruct::Sanitizer
+  #
+  #     truncate :name, length: 20
+  #     alphanumeric :name
+  #     sanitize :middle_name do |value|
+  #       # Perform a more complex sanitization process
+  #     end
+  #   end
+  #
+  module Sanitizer
+    def self.included(base)
+      unless base.ancestors.include? OpenStruct
+        raise "#{self.name} can only be used within OpenStruct classes"
+      end
+
+      base.extend ClassMethods
+    end
+
+    # Initializes the OpenStruct applying any registered sanitization rules
+    #
+    def initialize(attrs = {})
+      super nil
+      attrs.each_pair do |field, value|
+        self[field] = value
+      end
+    end
+
+    # Creates a setter method for the corresponding field which applies any
+    # existing sanitization rules
+    #
+    # @param [Symbol] method the missing method
+    # @param [Array<Any>] args the method's arguments list
+    #
+    def method_missing(method, *args)
+      # Give OpenStruct a chance to create getters and setters for the
+      # corresponding field
+      super method, *args
+
+      if field = setter?(method)
+        # override setter logic to apply any existing sanitization rules before
+        # assigning the new value to the field
+        override_setter_for(field) if sanitize?(field)
+        # uses the newly created setter to set the field's value and apply any
+        # existing sanitization rules
+        send(method, args[0])
+      end
+    end
+
+    # Set attribute's value via setter so that any existing sanitization rules
+    # may be applied
+    #
+    # @param [Symbol|String] name the attribute's name
+    # @param [Any] value the attribute's value
+    #
+    def []=(name, value)
+      send("#{name}=", value)
+    end
+
+    private
+
+    def setter?(method)
+      method[/.*(?==\z)/m].to_s.to_sym
+    end
+
+    def override_setter_for(field)
+      define_singleton_method("#{field}=") do |value|
+        @table[field] = sanitize(field, value)
+      end
+    end
+
+    def sanitize(field, value)
+      return value if value.nil?
+      self.class.sanitizers[field].reduce(value) do |current_value, sanitizer|
+        sanitizer.call(current_value)
+      end
+    end
+
+    def sanitize?(field)
+      self.class.sanitizers.key? field
+    end
+
+    # Provides sanitization rules that can be declaratively applied to OpenStruct
+    # fields, similar to hooks on Rails models.
+    #
+    module ClassMethods
+      attr_accessor :sanitizers
+
+      # Registers a sanitization block for a given field
+      #
+      # @param [Array<Symbol>] a list of field names to be sanitized
+      # @param [#call] block sanitization block to be applied to the current value of each field and returns the new sanitized value
+      #
+      def sanitize(*fields, &block)
+        @sanitizers ||= {}
+        fields.each do |field|
+          field_sanitizers = @sanitizers[field.to_sym] ||= []
+          field_sanitizers << block
+        end
+      end
+
+      # Truncates fields to a given length value
+      #
+      # @param [Array<Symbol>] a list of field names to be sanitized
+      # @param [Integer] length the amount to truncate the field's value to
+      # @param [Boolean] strip_whitespaces whether or not to strip whitespaces
+      #
+      def truncate(*fields, length:, strip_whitespaces: true)
+        strip(*fields) if strip_whitespaces
+        sanitize(*fields) { |value| value[0...length] }
+        strip(*fields) if strip_whitespaces
+      end
+
+      # Remove any non-alphanumeric character from the field's value
+      #
+      # @param [Array<Symbol>] a list of field names to be sanitized
+      #
+      def alphanumeric(*fields)
+        sanitize(*fields) { |value| value.gsub(/[^A-Za-z0-9\s]/, '') }
+      end
+
+      # Strips out leading and trailing spaces from the values of the given fields
+      #
+      # @param [Array<Symbol>] fields list of fields to be sanitized
+      #
+      def strip(*fields)
+        sanitize(*fields) { |value| value.strip }
+      end
+
+      # Removes any non-digit character from the values of the given fields
+      #
+      # @param [Array<Symbol>] fields list of fields to be sanitized
+      #
+      def digits(*fields)
+        sanitize(*fields) { |value| value.to_s.gsub(/[^0-9]/, '') }
+      end
+    end
+  end
+end

packages/ostruct-sanitizer/lib/ostruct/sanitizer/version.rb

@@ -0,0 +1,5 @@
+module OStruct
+  module Sanitizer
+    VERSION = "0.7.0"
+  end
+end

packages/ostruct-sanitizer/mkdocs.yml

@@ -0,0 +1,7 @@
+site_name: Ostruct Sanitizer
+site_description: Ostruct Sanitizer Documentation
+nav:
+  - "Home": "README.md"
+  - "Code of Conduct": "CODE_OF_CONDUCT.md"
+plugins:
+  - techdocs-core