normalizator 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc2052bf00ec23dacf70899f62bb42a8f914cb46ecf6c72fca18dcb2c6f336aa
+  data.tar.gz: 92b1070b6c4391896d168b44e6221f4f649d3d0771fb843b75a69f193d43dc11
+SHA512:
+  metadata.gz: f55a58c621930017b7cd99b7ba53ecf542cc37726ad9cac61219d69c678f3670b7782e81a696b38ce43176e0b782043767207df500620d06e5d9234a9e786b3d
+  data.tar.gz: 03af6853cee5b839b0a16029251a58281c98195547f8cc6c93941d3b67c020f929d88b6297396d3a58677314b6bdb37e1b7618b2ef4dcb1bf8fc5fea120d4bc2

data/.codeclimate.yml

@@ -0,0 +1,20 @@
+engines:
+  rubocop:
+    enabled: true
+  golint:
+    enabled: false
+  gofmt:
+    enabled: false
+  eslint:
+    enabled: false
+  csslint:
+    enabled: false
+
+ratings:
+  paths:
+    - lib/**
+    - "**.rb"
+
+exclude_paths:
+  - spec/**/*
+  - vendor/**/*

data/.gitignore

@@ -0,0 +1,8 @@
+.idea/
+coverage/
+.DS_Store
+.rbenv-gemsets
+.ruby-version
+.vscode/
+.bundle
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,98 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'script/**/*'
+
+Rails:
+  Enabled: true
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/CaseIndentation:
+  EnforcedStyle: end
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/IndentHash:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+      inject: 'inject'
+
+Style/Documentation:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Style/BracesAroundHashParameters:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 100
+
+Metrics/ModuleLength:
+  Max: 100
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Style/FormatString:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/WordArray:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/AlignHash:
+  Enabled: true
+  EnforcedLastArgumentHashStyle: always_ignore
+
+Style/TrivialAccessors:
+  AllowPredicates: true

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: required
+cache: bundler
+dist: trusty
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+gemfiles:
+  - normalizator.gemspec
+script: "bundle exec rspec && bundle exec codeclimate-test-reporter"
+before_install:
+  - gem install bundler

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2019-present David De Anda
+
+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,7 @@
+<h1 align="center">
+  <img src="https://raw.githubusercontent.com/omarandstuff/normalizator/master/media/normalizator-logo.png" alt="Normalizator" title="Normalizator" width="512">
+</h1>
+
+[![Build Status](https://travis-ci.org/omarandstuff/normalizator.svg?branch=master)](https://travis-ci.org/omarandstuff/normalizator)
+[![Maintainability](https://api.codeclimate.com/v1/badges/8ac96249f76f2001c036/maintainability)](https://codeclimate.com/github/omarandstuff/normalizator/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/8ac96249f76f2001c036/test_coverage)](https://codeclimate.com/github/omarandstuff/normalizator/test_coverage)

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:test)
+
+  task default: :test
+rescue LoadError
+  puts 'RSpec rake tasks not available. Please run "bundle install" to install missing dependencies.'
+end

data/lib/normalizator.rb

@@ -0,0 +1,17 @@
+require 'normalizator/default_options'
+require 'normalizator/error'
+require 'normalizator/normalize'
+require 'rules/base_rule'
+require 'rules/enum_rule'
+require 'rules/numeric_rule'
+
+# Normalizator normizlize your data
+module Normalizator
+  include Normalizator::DefaultOptions
+
+  module_function
+
+  def normalize(rules, data, options = {})
+    Normalize.new(rules, data, DEFAULT_OPTIONS.merge(options)).normalize
+  end
+end

data/lib/normalizator/default_options.rb

@@ -0,0 +1,9 @@
+module Normalizator
+  module DefaultOptions
+    DEFAULT_OPTIONS = {
+      exclude_fileds_without_rule: true,
+      ignore_unmatched_rules: true,
+      default_unmatched_rules_value: nil
+    }.freeze
+  end
+end

data/lib/normalizator/error.rb

@@ -0,0 +1,5 @@
+module Normalizator
+  NormalizeError = Class.new(StandardError)
+
+  RuleError = Class.new(NormalizeError)
+end

data/lib/normalizator/normalize.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# Normalizator::Normalize module
+module Normalizator
+  # Normalization logic for Normalizator
+  class Normalize
+    def initialize(rules, data, options)
+      raise(Normalizator::NormalizeError, 'Nil data') unless data
+      raise(Normalizator::NormalizeError, 'Nil rules') unless rules
+      @rules = rules
+      @data = data
+      @rules_keys = rules.keys
+      @options = options
+    end
+
+    def normalize
+      normalized_data = []
+
+      @data.each do |original_row|
+        normalized_row = run_rules_on_row original_row
+
+        normalized_data.push(normalized_row)
+      end
+
+      normalized_data
+    end
+
+    private
+
+    def run_rules_on_row(original_row)
+      new_row = @options[:exclude_fileds_without_rule] ? {} : original_row.clone
+
+      @rules_keys.each do |field|
+        if field.instance_of? Array
+          next if should_skip_mutly_field_rule(field, original_row)
+          run_rules_on_multy_value(field, new_row, original_row)
+        else
+          next if should_skip_rule(field, new_row, original_row)
+          new_row[field] = run_rules_on_value(@rules[field], original_row[field], original_row)
+        end
+      end
+
+      new_row
+    end
+
+    def run_rules_on_multy_value(multy_field, new_row, original_row)
+      values = multy_field.map { |sub_field| original_row[sub_field] }
+
+      normalized_values = run_rules_on_value(@rules[multy_field], values, original_row)
+
+      multy_field.each_with_index do |sub_field, index|
+        new_row[sub_field] = normalized_values[index]
+      end
+    end
+
+    def run_rules_on_value(rules, values, original_row)
+      if rules.instance_of? Array
+        ruled_field = values
+
+        rules.each do |rule|
+          ruled_field = rule.apply(ruled_field, original_row)
+        end
+
+        ruled_field
+      else
+        rules.apply(values, original_row)
+      end
+    end
+
+    def should_skip_rule(field, new_row, original_row)
+      unless original_row.key? field
+        return true if @options[:ignore_unmatched_rules]
+
+        new_row[field] = @options[:default_unmatched_rules_value]
+        true
+      end
+    end
+
+    def should_skip_mutly_field_rule(multy_field, original_row)
+      multy_field.any? { |sub_field| !original_row.key?(sub_field) }
+    end
+  end
+end

data/lib/normalizator/version.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Normalizator
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  # Version builder module
+  module VERSION
+    # major version
+    MAJOR = 0
+    # minor version
+    MINOR = 0
+    # tiny version
+    TINY  = 0
+    # alpha, beta, etc. tag
+    PRE   = nil
+
+    # Build version string
+    STRING = [[MAJOR, MINOR, TINY].compact.join('.'), PRE].compact.join('-')
+  end
+end

data/lib/rules/base_rule.rb

@@ -0,0 +1,19 @@
+# Normalizator::BaseRule module
+module Normalizator
+  class BaseRule
+    DEFAULT_OPTIONS = {
+      return_original_on_failure: true,
+      default_value_on_failure: nil
+    }.freeze
+
+    def initialize(options = {})
+      @options = DEFAULT_OPTIONS.merge(options)
+    end
+
+    private
+
+    def get_value_on_failure(value)
+      @options[:return_original_on_failure] ? value : @options[:default_value_on_failure]
+    end
+  end
+end

data/lib/rules/enum_rule.rb

@@ -0,0 +1,48 @@
+# Normalizator::EnumRule module
+module Normalizator
+  class EnumRule < BaseRule
+    def apply(value, _original_row)
+      value_on_failure = get_value_on_failure(value)
+      best_match = nil
+
+      raise(RuleError, 'Array of enumerators is expected in the rule constructor options') unless @options[:enumerators].instance_of? Array
+
+      @options[:enumerators].each do |enum|
+        (best_match, perfect_match) = match_agains_enumerator(enum, value, best_match)
+
+        break if perfect_match
+      end
+
+      best_match ? best_match : value_on_failure
+    end
+
+    private
+
+    def match_agains_enumerator(enum, value, best_match)
+      if @options[:case_sensitive]
+        (best_match, perfect_match) = case_sensitive_matching(enum, value, best_match)
+      else
+        (best_match, perfect_match) = case_insensitive_matching(enum, value, best_match)
+      end
+
+      [best_match, perfect_match]
+    end
+
+    def case_sensitive_matching(enum, value, best_match)
+      return [value, true] if value.strip == enum.strip
+      return [enum, false] if @options[:diffuse] && enum.include?(value)
+
+      [best_match, false]
+    end
+
+    def case_insensitive_matching(enum, value, best_match)
+      sanitized_value = value.downcase.strip
+      sanitized_enum = enum.downcase.strip
+
+      return [enum, true] if sanitized_value == sanitized_enum
+      return [enum, false] if @options[:diffuse] && sanitized_enum.include?(sanitized_value)
+
+      [best_match, false]
+    end
+  end
+end

data/lib/rules/numeric_rule.rb

@@ -0,0 +1,21 @@
+# Normalizator::NumericRule module
+module Normalizator
+  class NumericRule < BaseRule
+    def apply(value, _original_row)
+      value_on_failure = get_value_on_failure(value)
+
+      apply_numeric_rules value_on_failure, value.to_i
+    end
+
+    private
+
+    def apply_numeric_rules(value_on_failure, value)
+      return value_on_failure if @options[:positive] && value < 0
+      return value_on_failure if @options[:negative] && value >= 0
+      return value_on_failure if @options[:greater_than] && value < @options[:greater_than]
+      return value_on_failure if @options[:less_than] && value > @options[:less_than]
+
+      value
+    end
+  end
+end

data/normalizator.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'normalizator/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'normalizator'
+  spec.version = Normalizator.gem_version
+  spec.summary = 'Normalizator normalize your unnormalized data'
+  spec.authors = ['David De Anda']
+  spec.email = 'timrudat@gmail.com'
+  spec.description = ''
+  spec.homepage = 'https://github.com/omarandstuff/normalizator'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.1'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|gemfiles|coverage|bin|media|examples)/}) }
+  spec.executables = []
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w[lib]
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-json'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: normalizator
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- David De Anda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov-json
+  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: ''
+email: timrudat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/normalizator.rb
+- lib/normalizator/default_options.rb
+- lib/normalizator/error.rb
+- lib/normalizator/normalize.rb
+- lib/normalizator/version.rb
+- lib/rules/base_rule.rb
+- lib/rules/enum_rule.rb
+- lib/rules/numeric_rule.rb
+- normalizator.gemspec
+homepage: https://github.com/omarandstuff/normalizator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Normalizator normalize your unnormalized data
+test_files: []