ostruct-sanitizer 0.3.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c2195eea12fb39af3afff6c4b6fe806ec04bca30
-  data.tar.gz: 76c44ec8ff0b923e93adbc976a59a6683ff3892a
+SHA256:
+  metadata.gz: ec72d23523602ba268e7d80512e70dbf9b0009832ae82183ec543318113bad65
+  data.tar.gz: '049578c417a53dc08f904c186f5fd394692a9717f2e78441df7f65ef7192c763'
 SHA512:
-  metadata.gz: c66bb4d5415a969ee8e986c34b9363ef1971fa1e5de273617069dd69fc10384ba78567a56301bdd392fa8311404c24c8079840372174e9699dc30bad85589b67
-  data.tar.gz: 76b3e51b2ede7292b4e065c4125c0c2ff990650445297d705690071e19c4e59b89ee82db8748fd1119bf43fbd493305cec83b6beac90c6c5bdb1828897e28e37
+  metadata.gz: 42000f20cab9e7cf22da5138392f6c9228ed5482ecb836f99ff27053ad885ca267660d9b240fac18d93900641976ef3f33578df326c2f5eeb2169ab2cb0e0de1
+  data.tar.gz: 834702166f3e337f6c34b0c975649c4cf2b5e35e4645649f0ed254f1393a423b122db10eb7131f9a10cd6ba22a46bd084a9305594bd1303f4a053f1dceaafc2b

data/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+
+on: push
+
+jobs:
+  test:
+    name: Tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "2.5"
+          - "2.6"
+          - "2.7"
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler: "2"
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake spec

data/.github/workflows/release.yml

@@ -0,0 +1,20 @@
+name: Publish Gem
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - v*
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Release Gem
+        uses: cadwallion/publish-rubygems-action@master
+        if: contains(github.ref, 'refs/tags/v')
+        env:
+          GITHUB_TOKEN: ${{ secrets.github_token }}
+          RUBYGEMS_API_KEY: ${{ secrets.rubygems_api_key }}
+          RELEASE_COMMAND: rake release

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.byebug_history

data/.travis.yml

@@ -2,4 +2,7 @@ sudo: false
 language: ruby
 rvm:
   - 2.2.4
-before_install: gem install bundler -v 1.13.6
+  - 2.3.3
+  - 2.7.3
+  - ruby-head
+before_install: gem install bundler -v 2.2.25

data/README.md

@@ -34,7 +34,7 @@ class User < OpenStruct
   include OStruct::Sanitizer
 
   truncate :first_name, :last_name, length: 10
-  drop_punctuation :city, :country
+  alphanumeric :city, :country
   strip :email, :phone
 
   sanitize :age do |value|

data/lib/ostruct/sanitizer/version.rb

@@ -1,5 +1,5 @@
 module OStruct
   module Sanitizer
-    VERSION = "0.3.1"
+    VERSION = "0.6.1"
   end
 end

data/lib/ostruct/sanitizer.rb

@@ -7,10 +7,10 @@ module OStruct
   #
   # @example
   #   class Person < OpenStruct
-  #     include WellsFargoRetail::Sanitizer
+  #     include OStruct::Sanitizer
   #
   #     truncate :name, length: 20
-  #     drop_punctuation :name
+  #     alphanumeric :name
   #     sanitize :middle_name do |value|
   #       # Perform a more complex sanitization process
   #     end
@@ -28,32 +28,57 @@ module OStruct
     # Initializes the OpenStruct applying any registered sanitization rules
     #
     def initialize(attrs = {})
-      super
+      super nil
       attrs.each_pair do |field, value|
-        self.send("#{field}=", value)
+        self[field] = value
       end
     end
 
-    # Overrides ostruct member definition applying sanitization rules when needed
+    # Creates a setter method for the corresponding field which applies any
+    # existing sanitization rules
     #
-    # @param [#to_sym] field the name of the field being defined
-    # @return [Symbol] the name of the defined field
+    # @param [Symbol] method the missing method
+    # @param [Array<Any>] args the method's arguments list
     #
-    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
+    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
-      field
+    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|
+        modifiable?[field] = sanitize(field, value)
+      end
+    end
+
     def sanitize(field, value)
-      return value if value.nil? || !sanitize?(field)
+      return value if value.nil?
       self.class.sanitizers[field].reduce(value) do |current_value, sanitizer|
         sanitizer.call(current_value)
       end
@@ -77,7 +102,7 @@ module OStruct
       def sanitize(*fields, &block)
         @sanitizers ||= {}
         fields.each do |field|
-          field_sanitizers = @sanitizers[field] ||= []
+          field_sanitizers = @sanitizers[field.to_sym] ||= []
           field_sanitizers << block
         end
       end
@@ -94,12 +119,12 @@ module OStruct
         strip(*fields) if strip_whitespaces
       end
 
-      # Drops any punctuation character from the field's value
+      # Remove any non-alphanumeric character from the field's value
       #
       # @param [Array<Symbol>] a list of field names to be sanitized
       #
-      def drop_punctuation(*fields)
-        sanitize(*fields) { |value| value.gsub(/[^\w\s]/, '') }
+      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

data/ostruct-sanitizer.gemspec

@@ -21,7 +21,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.required_ruby_version = '>= 2.5'
+
+  spec.add_development_dependency "bundler", "~> 2.2.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
 end

data/test_all.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+set -e
+
+rubies=("ruby-2.5.9" "ruby-2.6.8" "ruby-2.7.4")
+for i in "${rubies[@]}"
+do
+  echo "====================================================="
+  echo "$i: Start Test"
+  echo "====================================================="
+  rvm $i exec bundle
+  rvm $i exec bundle exec rake
+  echo "====================================================="
+  echo "$i: End Test"
+  echo "====================================================="
+done

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ostruct-sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.6.1
 platform: ruby
 authors:
 - Diego Borges
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-20 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.2.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.2.11
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides Rails-like sanitization rules for OpenStruct fields.
 email:
 - drborges.cic@gmail.com
@@ -59,6 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -72,6 +88,7 @@ files:
 - lib/ostruct/sanitizer.rb
 - lib/ostruct/sanitizer/version.rb
 - ostruct-sanitizer.gemspec
+- test_all.sh
 homepage: https://github.com/powerhome/ostruct-sanitizer
 licenses:
 - MIT
@@ -84,15 +101,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Provides Rails-like sanitization rules for OpenStruct fields.