ostruct-sanitizer 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 73b62ce9ad20aad02e6d4b8c844920156e38abef
-  data.tar.gz: ea109f7926cbaa9075ef332299a36a3321b2c2d9
+SHA256:
+  metadata.gz: 21d9b00bfcb23a7e0c361f8299a563506598de0ee343200b20b30c05a4a70c32
+  data.tar.gz: 1a154510321649d9f97e77c64919c095fe18b8d512b35e82e57321e6e714c7c6
 SHA512:
-  metadata.gz: f594d6d4e082d7737c536770102b5b818c2828a59cd23050535c8a3bf7848c47c64f7f014615af7c5dda0f9fcafa066d3a549933d0b016a9e5e91871b5148cd8
-  data.tar.gz: 07ecf9f6b57b7df70d9041fe9011a441bdd65267c754d15bd9184296d13e91bce3801846cc681504d093b88d104c745d162b3822b1eb9e1764055a330ce816a9
+  metadata.gz: 9b4fe46013b220f8242de2277a25fff91334246a38116f2723e96dc3f686139a2758167637a7408f7fd5a88ef8d5662b1cabc0e2aaee42c2d08edfb720845e79
+  data.tar.gz: 1e498bfb88218ee6400517b79cff65ae162ad71309e328e7238e224b2f941d36d98f3fd0158f9a7a581a42e8d1f3edd3df33e33622f686a74992a3b4a4444d7f

data/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on: push
+
+jobs:
+  test:
+    name: Tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "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.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
@@ -89,16 +114,17 @@ module OStruct
       # @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
 
-      # 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/lib/ostruct/sanitizer/version.rb

@@ -1,5 +1,5 @@
 module OStruct
   module Sanitizer
-    VERSION = "0.3.0"
+    VERSION = "0.6.0"
   end
 end

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.7'
+
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ostruct-sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Diego Borges
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-20 00:00:00.000000000 Z
+date: 2021-08-18 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"
@@ -84,15 +100,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 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.1.6
 signing_key: 
 specification_version: 4
 summary: Provides Rails-like sanitization rules for OpenStruct fields.