jsonlint 0.1.0

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsonlint.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Doug Barth
+
+MIT License
+
+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,29 @@
+# JsonLint
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jsonlint'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsonlint
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/jsonlint/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/bin/jsonlint

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path('../../lib', __FILE__)
+
+require 'jsonlint'
+require 'jsonlint/cli'
+
+JsonLint::CLI.new(ARGV).execute!

data/jsonlint.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsonlint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsonlint"
+  spec.version       = JsonLint::VERSION
+  spec.authors       = ["Doug Barth"]
+  spec.email         = ["dougbarth@gmail.com"]
+  spec.summary       = %q{JSON lint checker}
+  spec.description   = %q{Checks JSON files for correct syntax and no silly mistakes}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'oj', '~> 2'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/jsonlint.rb

@@ -0,0 +1,13 @@
+require 'logger'
+
+require 'jsonlint/version'
+require 'jsonlint/linter'
+
+module JsonLint
+  # Your code goes here...
+  def self.logger
+    @logger ||= Logger.new(STDOUT).tap do |l|
+      l.level = Logger::INFO
+    end
+  end
+end

data/lib/jsonlint/cli.rb

@@ -0,0 +1,19 @@
+module JsonLint
+  class CLI
+    def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = Kernel)
+      @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
+    end
+
+    def execute!
+      files_to_check = @argv
+
+      linter = JsonLint::Linter.new
+      linter.check_all(files_to_check)
+
+      if linter.has_errors?
+        linter.display_errors
+        @kernel.exit(1)
+      end
+    end
+  end
+end

data/lib/jsonlint/errors.rb

@@ -0,0 +1,3 @@
+module JsonLint
+  class FileNotFoundError < StandardError; end
+end

data/lib/jsonlint/linter.rb

@@ -0,0 +1,147 @@
+require 'oj'
+require 'set'
+
+require 'jsonlint/errors'
+
+module JsonLint
+  class Linter
+    attr_reader :errors
+
+    def initialize
+      @errors = Hash.new {|h,k| h[k] = [] }
+    end
+
+    def check_all(*files_to_check)
+      files_to_check.flatten.each {|f| check(f) }
+    end
+
+    def check(path)
+      raise FileNotFoundError, "#{path} does not exist" unless File.exist?(path)
+
+      check_syntax_valid(path) && check_overlapping_keys(path)
+    end
+
+    def has_errors?
+      ! errors.empty?
+    end
+
+    def display_errors
+      errors.each do |path, errors|
+        puts path
+        errors.each do |err|
+          puts "  #{err}"
+        end
+      end
+    end
+
+    private
+
+    def check_syntax_valid(path)
+      Oj.load_file(path, nilnil: false)
+      true
+    rescue Oj::ParseError => e
+      errors[path] << e.message
+      false
+    end
+
+    class KeyOverlapDetector < Oj::Saj
+      attr_reader :overlapping_keys
+
+      def initialize
+        @seen_keys = Set.new
+        @key_components = []
+        @overlapping_keys = Set.new
+
+        @complex_type = []
+        @array_positions = []
+      end
+
+      def hash_start(key)
+        JsonLint.logger.debug { "hash_start: #{key.inspect}" }
+
+        case @complex_type.last
+        when :hash
+          @key_components.push(key)
+        when :array
+          @key_components.push(@array_positions.last)
+          @array_positions[-1] += 1
+        end
+
+        @complex_type.push(:hash)
+        check_for_overlap!
+      end
+
+      def hash_end(key)
+        JsonLint.logger.debug { "hash_end: #{key.inspect}" }
+        @key_components.pop
+        @complex_type.pop
+      end
+
+      def array_start(key)
+        JsonLint.logger.debug { "array_start: #{key.inspect}" }
+
+        case @complex_type.last
+        when :hash
+          @key_components.push(key)
+        when :array
+          @key_components.push(@array_positions.last)
+          @array_positions[-1] += 1
+        end
+
+        @complex_type.push(:array)
+        @array_positions.push(0)
+        check_for_overlap!
+      end
+
+      def array_end(key)
+        JsonLint.logger.debug { "array_end: #{key.inspect}" }
+        @key_components.pop
+        @complex_type.pop
+        @array_positions.pop
+      end
+
+      def add_value(value, key)
+        JsonLint.logger.debug { "add_value: #{value.inspect}, #{key.inspect}" }
+        case @complex_type.last
+        when :hash
+          @key_components.push(key)
+          check_for_overlap!
+          @key_components.pop
+        when :array
+          @key_components.push(@array_positions.last)
+          check_for_overlap!
+          @array_positions[-1] += 1
+          @key_components.pop
+        end
+      end
+
+      def error(message, line, column)
+        JsonLint.logger.debug { "error: #{message.inspect}, #{line.inspect}, #{column.inspect}" }
+      end
+
+      private
+      def check_for_overlap!
+        full_key = @key_components.dup
+        JsonLint.logger.debug { "Checking #{full_key.join('.')} for overlap" }
+
+        unless @seen_keys.add?(full_key)
+          JsonLint.logger.debug { "Overlapping key #{full_key.join('.')}" }
+          @overlapping_keys << full_key
+        end
+      end
+    end
+
+    def check_overlapping_keys(path)
+      overlap_detector = KeyOverlapDetector.new
+      File.open(path, 'r') do |f|
+        Oj.saj_parse(overlap_detector, f)
+      end
+
+      overlap_detector.overlapping_keys.each do |key|
+        errors[path] << "The same key is defined twice: #{key.join('.')}"
+      end
+
+      !! overlap_detector.overlapping_keys.empty?
+    end
+  end
+end

data/lib/jsonlint/rake_task.rb

@@ -0,0 +1,37 @@
+require 'rake'
+require 'rake/tasklib'
+
+require 'jsonlint'
+
+module JsonLint
+  class RakeTask < Rake::TaskLib
+    attr_accessor :name
+    attr_accessor :paths
+
+    def initialize(name = :jsonlint)
+      @name = name
+
+      yield self if block_given?
+
+      define_task
+    end
+
+    private
+
+    def define_task
+      desc 'Run jsonlint' unless ::Rake.application.last_comment
+
+      task(self.name) do
+        files_to_check = Rake::FileList.new(self.paths)
+
+        linter = ::JsonLint::Linter.new
+        linter.check_all(files_to_check)
+
+        if linter.has_errors?
+          linter.display_errors
+          abort('JSON lint found')
+        end
+      end
+    end
+  end
+end

data/lib/jsonlint/version.rb

@@ -0,0 +1,3 @@
+module JsonLint
+  VERSION = "0.1.0"
+end

data/spec/data/deep_overlap.json

@@ -0,0 +1,13 @@
+{
+  "foo": {
+    "bar": {
+      "a": 1
+    },
+    "baz": {
+      "a": 1
+    },
+    "bar": {
+      "b": 1
+    }
+  }
+}

data/spec/data/missing_brace.json

@@ -0,0 +1,4 @@
+{
+  "foo": {
+    "bar": 1
+}

data/spec/data/missing_comma.json

@@ -0,0 +1,4 @@
+{
+  "foo": 1
+  "bar": 2
+}

data/spec/data/overlapping_keys.json

@@ -0,0 +1,4 @@
+{
+  "foo": "foo",
+  "foo": "bar"
+}

data/spec/data/valid.json

@@ -0,0 +1,11 @@
+{
+  "an_int": 1,
+  "a_float": 1.0,
+  "a_string": "foo",
+  "a_boolean": true,
+  "an_array": [1,2,3],
+  "an_object": {
+    "field1": true,
+    "field2": ""
+  }
+}

data/spec/data/valid_array_of_arrays.json

@@ -0,0 +1,3 @@
+{
+  "array_of_arrays": [[1], [1]]
+}

data/spec/data/valid_array_of_objects.json

@@ -0,0 +1,12 @@
+{
+  "objs": [
+    {
+      "name": "foo",
+      "value": 1
+    },
+    {
+      "name": "bar",
+      "value": 1
+    }
+  ]
+}

data/spec/linter_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'jsonlint/linter'
+
+describe 'JsonLint::Linter' do
+  let(:linter) { JsonLint::Linter.new }
+
+  it 'should throw an exception if given a bogus path' do
+    expect { linter.check('/does/not/exist') }.to raise_error
+  end
+
+  it 'should be happy with a valid JSON file' do
+    expect(linter.check(spec_data('valid.json'))).to be(true)
+    expect(linter.check(spec_data('valid_array_of_objects.json'))).to be(true)
+    expect(linter.check(spec_data('valid_array_of_arrays.json'))).to be(true)
+  end
+
+  it 'should be unhappy with an invalid JSON file' do
+    expect(linter.check(spec_data('missing_comma.json'))).to be(false)
+  end
+
+  it 'should be unhappy with JSON that has overlapping keys' do
+    expect(linter.check(spec_data('overlapping_keys.json'))).to be(false)
+    expect(linter.check(spec_data('deep_overlap.json'))).to be(false)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+
+require 'jsonlint'
+
+module SpecHelpers
+  def spec_data(data_path)
+    File.expand_path(File.join('spec/data', data_path))
+  end
+end
+
+RSpec.configure do |config|
+  config.include SpecHelpers
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: jsonlint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Doug Barth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Checks JSON files for correct syntax and no silly mistakes
+email:
+- dougbarth@gmail.com
+executables:
+- jsonlint
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/jsonlint
+- jsonlint.gemspec
+- lib/jsonlint.rb
+- lib/jsonlint/cli.rb
+- lib/jsonlint/errors.rb
+- lib/jsonlint/linter.rb
+- lib/jsonlint/rake_task.rb
+- lib/jsonlint/version.rb
+- spec/data/deep_overlap.json
+- spec/data/missing_brace.json
+- spec/data/missing_comma.json
+- spec/data/overlapping_keys.json
+- spec/data/valid.json
+- spec/data/valid_array_of_arrays.json
+- spec/data/valid_array_of_objects.json
+- spec/linter_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4326837317699917705
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4326837317699917705
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: JSON lint checker
+test_files:
+- spec/data/deep_overlap.json
+- spec/data/missing_brace.json
+- spec/data/missing_comma.json
+- spec/data/overlapping_keys.json
+- spec/data/valid.json
+- spec/data/valid_array_of_arrays.json
+- spec/data/valid_array_of_objects.json
+- spec/linter_spec.rb
+- spec/spec_helper.rb