Как проверить, является ли строка json в модели Rails

Question

Я создаю простое приложение и хочу иметь возможность хранить строки json в БД. У меня есть интерфейс таблицы со столбцом json, и я хочу, чтобы моя модель rails проверяла значение строки. Так что-то вроде:

class Interface < ActiveRecord::Base
  attr_accessible :name, :json

  validates :name,  :presence => true,
                    :length   => { :minimum => 3,
                                   :maximum => 40 },
                    :uniqueness => true

  validates :json, :presence => true,
                   :type => json #SOMETHING LIKE THIS
                   :contains => json #OR THIS    
end

Как мне это сделать?

Answer 1

Полагаю, вы могли бы проанализировать рассматриваемое поле и посмотреть, выдает ли оно ошибку. Вот упрощенный пример (вы можете отбросить двойной удар для чего-то более понятного):

require 'json'

class String
  def is_json?
    begin
      !!JSON.parse(self)
    rescue
      false
    end
  end
end

Тогда вы можете использовать это расширение строки в пользовательском валидаторе.

validate :json_format

protected

  def json_format
    errors[:base] << "not in json format" unless json.is_json?
  end

Answer 2

Лучший способ - добавить метод в модуль JSON!

Поместите это в ваш config / application.rb:

module JSON
  def self.is_json?(foo)
    begin
      return false unless foo.is_a?(String)
      JSON.parse(foo).all?
    rescue JSON::ParserError
      false
    end 
  end
end

Теперь вы 'Вы сможете использовать его где угодно («контроллер, модель, вид, ...»), вот так:

puts 'it is json' if JSON.is_json?(something)

Answer 3

В настоящее время (Rails 3 / Rails 4) я бы предпочел специальный валидатор .Также см. https://gist.github.com/joost/7ee5fbcc40e377369351.

# Put this code in lib/validators/json_validator.rb
# Usage in your model:
#   validates :json_attribute, presence: true, json: true
#
# To have a detailed error use something like:
#   validates :json_attribute, presence: true, json: {message: :some_i18n_key}
# In your yaml use:
#   some_i18n_key: "detailed exception message: %{exception_message}"
class JsonValidator < ActiveModel::EachValidator

  def initialize(options)
    options.reverse_merge!(:message => :invalid)
    super(options)
  end

  def validate_each(record, attribute, value)
    value = value.strip if value.is_a?(String)
    ActiveSupport::JSON.decode(value)
  rescue MultiJson::LoadError, TypeError => exception
    record.errors.add(attribute, options[:message], exception_message: exception.message)
  end

end

Answer 4

Я столкнулся с другой проблемой при использовании Rails 4.2.4 и адаптера PostgreSQL (pg) и пользовательского валидатора для моего поля json.

В следующем примере:

class SomeController < BaseController
  def update
    @record.json_field = params[:json_field]
  end
end

если вы передадите недопустимый JSON

params[:json_field]

тихо игнорируется и "ноль" сохраняется в

@record.json_field

Если вы используете пользовательский валидатор, такой как

class JsonValidator < ActiveModel::Validator
  def validate(record)
    begin
      JSON.parse(record.json_field)
    rescue
      errors.add(:json_field, 'invalid json')
    end
  end
end

вы не увидите неверную строку в

record.json_field

только значение "nil", потому что rails выполняет приведение типов перед передачей вашего значения в валидатор. Чтобы преодолеть это, просто используйте

record.json_field_before_type_cast

в вашем валидаторе.

Answer 5

Используя анализатор JSON, возможна чистая проверка формата JSON.ActiveSupport::JSON.decode(value) проверяет значение "123" и 123 на true.Это не правильно!

# Usage in your model:
#   validates :json_attribute, presence: true, json: true
#
# To have a detailed error use something like:
#   validates :json_attribute, presence: true, json: {message: :some_i18n_key}
# In your yaml use:
#   some_i18n_key: "detailed exception message: %{exception_message}"
class JsonValidator < ActiveModel::EachValidator

  def initialize(options)
    options.reverse_merge!(message: :invalid)
    super(options)
  end


  def validate_each(record, attribute, value)
    if value.is_a?(Hash) || value.is_a?(Array)
      value = value.to_json
    elsif value.is_a?(String)
      value = value.strip
    end
    JSON.parse(value)
  rescue JSON::ParserError, TypeError => exception
    record.errors.add(attribute, options[:message], exception_message: exception.message)
  end

end

Answer 6

Если вам не нравятся валидаторы корпоративного стиля или неуклюжее исправление класса String, вот простое решение:

class Model < ApplicationRecord
  validate :json_field_format

  def parsed_json_field
    JSON.parse(json_field)
  end

  private

  def json_field_format
    return if json_field.blank?
    begin
      parsed_json_field
    rescue JSON::ParserError => e
      errors[:json_field] << "not is json format" 
    end
  end
end