Class: Composer::Json::JsonFile

Inherits:
Object
  • Object
show all
Defined in:
lib/composer/json/json_file.rb

Overview

Reads/writes json files.

PHP Authors: Konstantin Kudryashiv <[email protected]> Jordi Boggiano <[email protected]>

Ruby Authors: Ioannis Kappas <[email protected]>

Constant Summary collapse

LAX_SCHEMA = 
1
STRICT_SCHEMA = 
2
JSON_ERROR_NONE = 
0
JSON_ERROR_DEPTH = 
1
JSON_ERROR_STATE_MISMATCH = 
2
JSON_ERROR_CTRL_CHAR = 
3
JSON_ERROR_SYNTAX = 
4
JSON_ERROR_UTF8 = 
5
JSON_ERROR_RECURSION = 
6
JSON_ERROR_INF_OR_NAN = 
7
JSON_ERROR_UNSUPPORTED_TYPE = 
8

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path, rfs = nil) ⇒ JsonFile

Initializes json file reader/parser.

Parameters:

  • path (String) —

    path to a json file

  • rfs (RemoteFileSystem) (defaults to: nil) —

    The remote filesystem to use for http/https json files

Raises:



42
43
44
45
46
47
48
49
 
# File 'lib/composer/json/json_file.rb', line 42

def initialize(path, rfs = nil)
  @path = path
  if rfs === nil && /^https?:\/\//i.match(path)
    raise ArgumentError,
          'http urls require a RemoteFilesystem instance to be passed'
  end
  @rfs = rfs
end

Instance Attribute Details

#path ⇒ Object (readonly)

Returns the value of attribute path.



23
24
25
 
# File 'lib/composer/json/json_file.rb', line 23

def path
  @path
end

Class Method Details

.encode(data, options = 448) ⇒ Object

Encodes an hash into (optionally pretty-printed) JSON

Parameters:

  • data —

    mixed Data to encode into a formatted JSON string

  • options (defaults to: 448) —

    int json_encode options (defaults to JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE)

Returns:

  • string Encoded json



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/composer/json/json_file.rb', line 164

def encode(data, options = 448)

  # if (version_compare(PHP_VERSION, '5.4', '>=')) {
  #     $json = json_encode(data, options);

  #     # compact brackets to follow recent php versions
  #     if (PHP_VERSION_ID < 50428 || (PHP_VERSION_ID >= 50500 && PHP_VERSION_ID < 50512) || (defined('JSON_C_VERSION') && version_compare(phpversion('json'), '1.3.6', '<'))) {
  #         $json = preg_replace('/\[\s+\]/', '[]', $json);
  #         $json = preg_replace('/\{\s+\}/', '{}', $json);
  #     }

  #     return $json;
  # }

  # * *indent*: a string used to indent levels (default: ''),
  # * *space*: a string that is put after, a : or , delimiter (default: ''),
  # * *space_before*: a string that is put before a : pair delimiter (default: ''),
  # * *object_nl*: a string that is put at the end of a JSON object (default: ''),
  # * *array_nl*: a string that is put at the end of a JSON array (default: ''),
  # * *allow_nan*: true if NaN, Infinity, and -Infinity should be
  #   generated, otherwise an exception is thrown if these values are
  #   encountered. This options defaults to false.
  # * *max_nesting*: The maximum depth of nesting allowed in the data
  #   structures from which JSON is to be generated. Disable depth checking
  #   with :max_nesting => false, it defaults to 100.

  if data.nil?
    return 'null'
  elsif data.is_a?(TrueClass)
    return 'true'
  elsif data.is_a?(FalseClass)
    return 'false'
  elsif data.is_a?(Integer)
    return Integer(data)
  elsif data.is_a?(Float)
    return Float(data)
  else
    begin
      json = JSON.generate(data, { quirks_mode: false })
    rescue JSON::GeneratorError => e
      if e.message === 'only generation of JSON objects or arrays allowed'
        #trick into parsing scalar values by wrapping them in an array
        scalar = data.gsub("\\\\", "\\\\\\")
        if json = JSON::generate([scalar], { quirks_mode: false })
          json = json[1..(json.length - 2)]
        end
      end
    end
  end

  return json unless options != 0

  result = Composer::Json::JsonFormatter::format(
    json,
    options
  )

  result
end

.parse_json(json, file = nil) ⇒ Object

Parses json string and returns hash.

Params: json string The json string to parse file string The json file

Returns: mixed



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/composer/json/json_file.rb', line 232

def parse_json(json, file = nil)
  last_error = JSON_ERROR_NONE

  begin
    data = JSON.parse(json)
  rescue => e
    last_error = e
  end


  if data.nil? && last_error != JSON_ERROR_NONE
    JsonFile::validate_syntax(json, file)
    raise JSON::ParserError,
        "\"#{file}\" does not contain valid JSON\n
        #{last_error.message}"
  end

  data
end

.validate_syntax(json, file) ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/composer/json/json_file.rb', line 252

def validate_syntax(json, file)
  # JSON::
  # parser = Composer::Json::JsonParser.new
  # if (result = parser.lint(json))
  #   raise ParsingError,
  #       "\"#{file}\" does not contain valid JSON\n
  #       #{result.message}"
  # end
  # if (defined('JSON_ERROR_UTF8') && JSON_ERROR_UTF8 === json_last_error()) {
  #     throw new \UnexpectedValueException('"'.$file.'" is not UTF-8, could not parse as JSON');
  # }
  true
end

Instance Method Details

#exists? ⇒ Boolean

Checks whether this json file exists.

Returns: true if this json file exists; otherwise false.

Returns:

  • (Boolean) 


55
56
57
 
# File 'lib/composer/json/json_file.rb', line 55

def exists?
  File.exists?(@path)
end

#read ⇒ Object

Reads the json file.

Raises: RuntimeError

Returns: mixed



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/composer/json/json_file.rb', line 66

def read
  if @rfs
    json = @rfs.get_contents(@path, @path, false)
  else
    json = File.open(@path, 'r') { |f| f.read }
  end

  JsonFile::parse_json(json, @path)

rescue Exception => e
  raise e
end

#validate_schema(schema = STRICT_SCHEMA) ⇒ Object

Validates the schema of the current json file according to composer-schema.json rules

Parameters:

  • schema (defaults to: STRICT_SCHEMA) —

    int a JsonFile::*_SCHEMA constant

Returns:

  • bool true if schema is valid; Otherwise false.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/composer/json/json_file.rb', line 115

def validate_schema(schema = STRICT_SCHEMA)
  content = File.open(@path, 'r') { |f| f.read }
  data = JSON.parse(content)

  if data == nil && content != 'null'
    self::validate_syntax(content, @path)
  end

  schema_file = File.join(
    File.dirname(__FILE__),
    '../../../resources/composer-schema.json'
  )

  schema_data = JSON.parse(
    File.open(schema_file, 'r') { |f| f.read }
  )

  if schema === LAX_SCHEMA
    schema_data['additionalProperties'] = true
    schema_data['properties']['name']['required'] = false
    schema_data['properties']['description']['required'] = false
  end

  errors = JSON::Validator.fully_validate(
    schema_data,
    data,
    {:errors_as_objects => true}
  )

  unless errors.empty?
    processed_errors = []
    errors.each do |error|
      prefix = error[:fragment] ? "#{error[:fragment]} : " : ''
      processed_errors.push( prefix + error[:message])
    end
    raise Composer::Json::JsonValidationError.new(processed_errors),
          "\"#{@path}\" does not match the expected JSON schema"
  end

  true
end

#write(hash, options = 448) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/composer/json/json_file.rb', line 79

def write(hash, options = 448)
  dir = File.dirname(@path)

  unless File.directory?(dir)
    if File.exists?(dir)
      raise UnexpectedValueError,
            "#{dir} exists and is not a directory."
    end
    FileUtils.mkdir_p(dir, mode: 0777)
  end

  retries = 3
  while retries >= 0
    begin
      file_ending = options & JsonFormatter::JSON_PRETTY_PRINT ? "\n" : ''
      File.open(@path, 'w') do |f|
        content = JsonFile::encode(hash, options) + file_ending
        f.write(content)
      end
      break

    rescue Exception => e
      raise e unless retries > 0
      retries -= 1
      sleep 0.5
    end
  end

end