json-guard 0.1.0

data/lib/json_guard/property.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module JsonGuard
+  class Property
+    attr_accessor :name, :type, :required, :message, :messages, :i18n_key,
+                  :message_template, :enum, :format, :pattern, :minimum, :maximum,
+                  :null_allowed, :schema
+
+    def initialize(name, type, options = {})
+      @name = name
+      @type = type
+      @required = options[:required] || false
+      @null_allowed = options[:null] || false
+      @message = options[:message]
+      @messages = options[:messages] || {}
+      @i18n_key = options[:i18n_key]
+      @message_template = options[:message_template]
+      @enum = options[:enum]
+      @format = options[:format]
+      @pattern = options[:pattern]
+      @minimum = options[:minimum]
+      @maximum = options[:maximum]
+      @schema = options[:schema]
+    end
+
+    def error_message(validation_type, record = nil, context = nil)
+      # Priority order:
+      # 1. Dynamic message (Proc)
+      # 2. Specific message for validation type
+      # 3. General message
+      # 4. I18n translation
+      # 5. Message template
+      # 6. Default message
+
+      if @message.is_a?(Proc)
+        return @message.call(record, nil, context)
+      end
+
+      if @messages[validation_type]
+        return @messages[validation_type]
+      end
+
+      if @message
+        return @message
+      end
+
+      if @i18n_key && defined?(I18n)
+        return I18n.t("json_guard.errors.#{@i18n_key}.#{validation_type}",
+                     default: I18n.t("json_guard.errors.#{validation_type}",
+                                   default: default_message(validation_type)))
+      end
+
+      if @message_template
+        return interpolate_template(@message_template, record, context)
+      end
+
+      # Default fallback
+      default_message(validation_type)
+    end
+
+    private
+
+    def interpolate_template(template, record, context)
+      variables = {
+        operation: context&.to_s || 'operation',
+        current_time: Time.current.strftime('%Y-%m-%d %H:%M:%S'),
+        model_name: record&.class&.name&.downcase || 'record'
+      }
+      template % variables
+    end
+
+    def default_message(validation_type)
+      field_name = @name.to_s.gsub('_', ' ').capitalize
+
+      case validation_type
+      when :required
+        "#{field_name} is required"
+      when :invalid_type
+        type_str = @type.is_a?(Array) ? @type.join(' or ') : @type.to_s
+        "#{field_name} must be a #{type_str}"
+      when :invalid_enum
+        "#{field_name} must be one of: #{@enum.join(', ')}" if @enum
+      when :invalid_format
+        "#{field_name} format is invalid"
+      when :invalid_pattern
+        "#{field_name} format is invalid"
+      when :too_small
+        "#{field_name} must be greater than or equal to #{@minimum}"
+      when :too_large
+        "#{field_name} must be less than or equal to #{@maximum}"
+      else
+        "#{field_name} is invalid"
+      end
+    end
+  end
+end

data/lib/json_guard/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module JsonGuard
+  class Railtie < Rails::Railtie
+    initializer "json_guard.initialize" do
+      ActiveSupport.on_load(:active_record) do
+        require "json_guard/active_record_extension"
+        extend JsonGuard::ActiveRecordExtension
+      end
+    end
+  end
+end

data/lib/json_guard/schema.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module JsonGuard
+  class Schema
+    attr_reader :properties, :contexts
+
+    def initialize
+      @properties = {}
+      @contexts = {}
+    end
+
+    class << self
+      def inherited(subclass)
+        super
+        subclass.instance_variable_set(:@properties, {})
+        subclass.instance_variable_set(:@contexts, {})
+      end
+
+      def properties
+        @properties ||= {}
+      end
+
+      def contexts
+        @contexts ||= {}
+      end
+
+      def context(name, &block)
+        @contexts[name] = block
+      end
+
+      def validate(data, context = nil)
+        validator = Validator.new(self)
+        validator.validate(data, context)
+      end
+
+      # DSL methods
+      def method_missing(method_name, *args, &block)
+        if block_given?
+          # Object definition
+          define_object_property(method_name, args.first || {}, &block)
+        else
+          # Simple property definition
+          define_property(method_name, args[0], args[1] || {})
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        true
+      end
+
+      private
+
+      def define_property(name, type, options = {})
+        # Handle multiple types like [:string, :null]
+        if type.is_a?(Array)
+          options[:null] = type.include?(:null)
+          type = type.reject { |t| t == :null }.first
+        end
+
+        property = Property.new(name, type, options)
+        @properties[name] = property
+      end
+
+      def define_object_property(name, options = {}, &block)
+        # Handle multiple types for objects like [:object, :null]
+        if options.is_a?(Array)
+          type_array = options
+          options = {}
+          options[:null] = type_array.include?(:null)
+          options[:type] = type_array.reject { |t| t == :null }.first || :object
+        else
+          options[:type] ||= :object
+        end
+
+        # Create nested schema class
+        nested_schema = Class.new(Schema)
+        nested_schema.class_eval(&block) if block
+
+        property = Property.new(name, options[:type], options.merge(schema: nested_schema))
+        @properties[name] = property
+      end
+    end
+  end
+end

data/lib/json_guard/validator.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'date'
+require 'json'
+
+module JsonGuard
+  class Validator
+    attr_reader :schema, :errors
+
+    def initialize(schema)
+      @schema = schema
+      @errors = []
+    end
+
+    def validate(data, context = nil)
+      @errors = []
+
+      return false if data.nil?
+
+      validate_properties(data, @schema.properties, context)
+
+      @errors.empty?
+    end
+
+    def error_messages
+      @errors.map { |error| error[:message] }
+    end
+
+    def detailed_errors
+      @errors
+    end
+
+    private
+
+    def validate_properties(data, properties, context = nil, path = [])
+      properties.each do |name, property|
+        current_path = path + [name.to_s]
+        value = data[name.to_s] || data[name.to_sym]
+
+        validate_property(property, value, current_path, context)
+      end
+    end
+
+    def validate_property(property, value, path, context)
+      # Check if value is present
+      if value.nil?
+        if property.required
+          add_error(property, :required, path, context)
+        end
+        return unless property.null_allowed
+      end
+
+      # Skip validation if value is nil and null is allowed
+      return if value.nil? && property.null_allowed
+
+      # Type validation
+      unless valid_type?(value, property.type)
+        add_error(property, :invalid_type, path, context)
+        return
+      end
+
+      # Enum validation
+      if property.enum && !property.enum.include?(value)
+        add_error(property, :invalid_enum, path, context)
+      end
+
+      # Format validation
+      if property.format && !valid_format?(value, property.format)
+        add_error(property, :invalid_format, path, context)
+      end
+
+      # Pattern validation
+      if property.pattern && !property.pattern.match?(value.to_s)
+        add_error(property, :invalid_pattern, path, context)
+      end
+
+      # Numeric validations
+      if property.minimum && value < property.minimum
+        add_error(property, :too_small, path, context)
+      end
+
+      if property.maximum && value > property.maximum
+        add_error(property, :too_large, path, context)
+      end
+
+      # Nested object validation
+      if property.schema && property.type == :object && value.is_a?(Hash)
+        nested_validator = Validator.new(property.schema)
+        nested_validator.validate(value, context)
+
+        nested_validator.detailed_errors.each do |error|
+          nested_path = path + error[:path].split('.')
+          @errors << error.merge(path: nested_path.join('.'))
+        end
+      end
+    end
+
+    def valid_type?(value, type)
+      case type
+      when :string
+        value.is_a?(String)
+      when :integer
+        value.is_a?(Integer)
+      when :boolean
+        value.is_a?(TrueClass) || value.is_a?(FalseClass)
+      when :array
+        value.is_a?(Array)
+      when :object
+        value.is_a?(Hash)
+      when :null
+        value.nil?
+      else
+        true
+      end
+    end
+
+    def valid_format?(value, format)
+      case format
+      when :email
+        value =~ /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i
+      when :uri, :url
+        value =~ /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
+      when :date
+        Date.parse(value) rescue false
+      when :datetime
+        DateTime.parse(value) rescue false
+      else
+        true
+      end
+    end
+
+    def add_error(property, validation_type, path, context, record = nil)
+      message = property.error_message(validation_type, record, context)
+
+      @errors << {
+        path: path.join('.'),
+        message: message,
+        validation_type: validation_type,
+        property: property.name,
+        code: validation_type.to_s.upcase
+      }
+    end
+  end
+end

data/lib/json_guard/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JsonGuard
+  VERSION = "0.1.0"
+end

data/lib/json_guard.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "json_guard/version"
+require_relative "json_guard/configuration"
+require_relative "json_guard/schema"
+require_relative "json_guard/property"
+require_relative "json_guard/validator"
+require_relative "json_guard/errors"
+
+module JsonGuard
+  class << self
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end
+
+# Load Rails integration if Rails is present
+if defined?(Rails)
+  require_relative "json_guard/railtie"
+end

metadata

@@ -0,0 +1,231 @@
+--- !ruby/object:Gem::Specification
+name: json-guard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zaid Saeed
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: Beautiful JSON Schema validation with Rails-native syntax, context-aware
+  rules, and production-ready monitoring
+email:
+- izaidsaeed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/json_guard.rb
+- lib/json_guard/active_record_extension.rb
+- lib/json_guard/configuration.rb
+- lib/json_guard/errors.rb
+- lib/json_guard/property.rb
+- lib/json_guard/railtie.rb
+- lib/json_guard/schema.rb
+- lib/json_guard/validator.rb
+- lib/json_guard/version.rb
+homepage: https://github.com/zaid-4/json-guard
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/zaid-4/json-guard
+  source_code_uri: https://github.com/zaid-4/json-guard
+  changelog_uri: https://github.com/zaid-4/json-guard/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/zaid-4/json-guard/tree/main/examples
+  bug_tracker_uri: https://github.com/zaid-4/json-guard/issues
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Enterprise-grade JSON Schema validation for Rails
+test_files: []