ostruct-sanitizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1fbed6da9849bd08294b41532a5d3b6eddb7e2be
+  data.tar.gz: 6cfdf6336cef374308cb8d185d11af5649ebcace
+SHA512:
+  metadata.gz: 94681e544a913fb8bb34d0ab3eb56bf567d7d8f01f663908df3a590fdf1eeaba5a6d15ef627ff5865c9aca9313ad08aaee2b527905e98419960f92d8159ab513
+  data.tar.gz: 98e55eb02a6625a6323e36f33d0073f3e63e55ad7568f0858f3326ddfcfe320d88f688e17d630b78a5e6830f6a7f86878650de7ab07ba8affd058077807863f4

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.13.6

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 drborges.cic@gmail.com. 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/

data/Gemfile

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

data/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.

data/README.md

@@ -0,0 +1,58 @@
+# OStruct::Sanitizer
+
+Provides Rails-like sanitization hooks to be applied to OpenStruct fields upon their assignment, allowing for better encapsulation of such rules.
+
+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
+  drop_punctuation :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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/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

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/lib/ostruct/sanitizer.rb

@@ -0,0 +1,115 @@
+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 WellsFargoRetail::Sanitizer
+  #
+  #     truncate :name, length: 20
+  #     drop_punctuation :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 "OpenStructSanitizer can only be used within OpenStruct classes."
+      end
+
+      base.extend ClassMethods
+    end
+
+    # Initializes the OpenStruct applying any registered sanitization rules
+    #
+    def initialize(attrs = {})
+      super
+      attrs.each_pair do |field, value|
+        self.send("#{field}=", value)
+      end
+    end
+
+    # Overrides ostruct member definition applying sanitization rules when needed
+    #
+    # @param [#to_sym] field the name of the field being defined
+    # @return [Symbol] the name of the defined field
+    #
+    def new_ostruct_member(field)
+      field = field.to_sym
+      unless respond_to?(field)
+        define_singleton_method(field) { modifiable[field] }
+        define_singleton_method("#{field}=") do |value|
+          modifiable[field] = sanitize(field, value)
+        end
+      end
+      field
+    end
+
+    private
+
+    def sanitize(field, value)
+      return value if value.nil? || !sanitize?(field)
+      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 [Symbol] field the field to be sanitized
+      # @param [#call] block sanitization block that takes the current value and returns the new sanitized value
+      #
+      def sanitize(field, &block)
+        @sanitizers ||= {}
+        field_sanitizers = @sanitizers[field] ||= []
+        field_sanitizers << block
+      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
+      #
+      def truncate(*fields, length:)
+        fields.each do |field|
+          sanitize(field) { |value| value[0...length] }
+        end
+      end
+
+      # Drops any punctuation character from the field's value
+      #
+      # @param [Array<Symbol>] a list of field names to be sanitized
+      #
+      def drop_punctuation(*fields)
+        fields.each do |field|
+          sanitize(field) { |value| value.gsub(/[^\w\s]/, '') }
+        end
+      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)
+        fields.each do |field|
+          sanitize(field) { |value| value.strip }
+        end
+      end
+    end
+  end
+end

data/lib/ostruct/sanitizer/version.rb

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

data/ostruct-sanitizer.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ostruct/sanitizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ostruct-sanitizer"
+  spec.version       = OStruct::Sanitizer::VERSION
+  spec.authors       = ["Diego Borges"]
+  spec.email         = ["drborges.cic@gmail.com"]
+
+  spec.summary       = %q{Provides Rails-like sanitization rules for OpenStruct fields.}
+  spec.description   = %q{Provides Rails-like sanitization rules for OpenStruct fields.}
+  spec.homepage      = "https://github.com/powerhome/ostruct-sanitizer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: ostruct-sanitizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Diego Borges
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Provides Rails-like sanitization rules for OpenStruct fields.
+email:
+- drborges.cic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ostruct/sanitizer.rb
+- lib/ostruct/sanitizer/version.rb
+- ostruct-sanitizer.gemspec
+homepage: https://github.com/powerhome/ostruct-sanitizer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Provides Rails-like sanitization rules for OpenStruct fields.
+test_files: []