jsonlint 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9440424c5ce5284432200d4275be3ef815c55a87
+  data.tar.gz: b85712a8defcd3df4d0846d4993e0a967cc2283d
+SHA512:
+  metadata.gz: d2f64c73f7f4e8512dee6abc20228ad68de118a339fd45313766828c118e9bb0f370b067575017566d3138915ca0e6cce644b5db46e0bcba85f47f422585dea3
+  data.tar.gz: 1dd3cea2cca3437c3dc766b57d63d79690cdb5fcdb7588c2d071ab2c281431492c18ef079439b596527fb3b844509a81a4113de1a8ffdf73404d3fcd365767fd

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
+  - 2.0.0-p648
+  - 2.1.9
+  - 2.2.5
+  - 2.3.1

data/README.md

@@ -1,6 +1,12 @@
-# JsonLint
+# jsonlint
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/PagerDuty/jsonlint.svg?branch=master)](https://travis-ci.org/PagerDuty/jsonlint)
+[![Gem Version](http://img.shields.io/gem/v/jsonlint.svg)](https://rubygems.org/gems/jsonlint)
+
+jsonlint checks your JSON files for syntax errors or silly mistakes. Currently it checks for:
+
+ * Valid JSON syntax
+ * Overlapping key definitions in JSON files, where the last definition would win
 
 ## Installation
 
@@ -16,13 +22,52 @@ Or install it yourself as:
 
     $ gem install jsonlint
 
-## Usage
+## CLI Usage
+
+You can run jsonlint against a set of files in the command line. Any errors will be printed and the process will exit with a non-zero exit code.
+
+```
+$ jsonlint spec/data/*
+spec/data/deep_overlap.json
+  The same key is defined twice: foo.bar
+spec/data/missing_brace.json
+  Hash/Object not terminated at line 5, column 2 [sparse.c:782]
+spec/data/missing_comma.json
+  expected comma, not a string at line 3, column 8 [sparse.c:386]
+spec/data/overlapping_keys.json
+  The same key is defined twice: foo
+```
+
+## Rake task
+
+You can integrate jsonlint into your build process by adding a Rake task to your project
+
+```ruby
+require 'jsonlint/rake_task'
+JsonLint::RakeTask.new do |t|
+  t.paths = %w(
+    spec/**/*.json
+  )
+end
+```
+
+Then run the rake task.
 
-TODO: Write usage instructions here
+```
+$ rake jsonlint
+spec/data/deep_overlap.json
+  The same key is defined twice: foo.bar
+spec/data/missing_brace.json
+  Hash/Object not terminated at line 5, column 2 [sparse.c:782]
+spec/data/missing_comma.json
+  expected comma, not a string at line 3, column 8 [sparse.c:386]
+spec/data/overlapping_keys.json
+  The same key is defined twice: foo
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/jsonlint/fork )
+1. Fork it ( https://github.com/PagerDuty/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`)

data/Rakefile

@@ -1,4 +1,4 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 

data/jsonlint.gemspec

@@ -18,8 +18,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'oj', '~> 2'
+  spec.add_dependency 'trollop', '~> 2'
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "aruba"
 end

data/lib/jsonlint.rb

@@ -4,7 +4,6 @@ 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

data/lib/jsonlint/cli.rb

@@ -1,3 +1,5 @@
+require 'trollop'
+
 module JsonLint
   class CLI
     def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = Kernel)
@@ -5,14 +7,40 @@ module JsonLint
     end
 
     def execute!
+      parse_options
+
       files_to_check = @argv
 
+      Trollop::die 'need at least one JSON file to check' if files_to_check.empty?
+
       linter = JsonLint::Linter.new
-      linter.check_all(files_to_check)
+      begin
+        if files_to_check == ['-']
+          linter.check_stream(STDIN)
+        else
+          linter.check_all(files_to_check)
+        end
+      rescue JsonLint::FileNotFoundError => e
+        @stderr.puts e.message
+        exit(1)
+      rescue => e
+        @stderr.puts e.message
+        exit(1)
+      end
+
+      return unless linter.errors?
+      linter.display_errors
+      @kernel.exit(1)
+    end
+
+    private
 
-      if linter.has_errors?
-        linter.display_errors
-        @kernel.exit(1)
+    def parse_options
+      @opts = Trollop.options(@argv) do
+        banner 'Usage: jsonlint [options] file1.json [file2.json ...]'
+        version(JsonLint::VERSION)
+        banner ''
+        banner 'Options:'
       end
     end
   end

data/lib/jsonlint/linter.rb

@@ -8,21 +8,38 @@ module JsonLint
     attr_reader :errors
 
     def initialize
-      @errors = Hash.new {|h,k| h[k] = [] }
+      @errors = {}
     end
 
     def check_all(*files_to_check)
-      files_to_check.flatten.each {|f| check(f) }
+      files_to_check.flatten.each { |f| check(f) }
     end
 
     def check(path)
-      raise FileNotFoundError, "#{path} does not exist" unless File.exist?(path)
+      fail FileNotFoundError, "#{path}: no such file" unless File.exist?(path)
 
-      check_syntax_valid(path) && check_overlapping_keys(path)
+      valid = false
+      File.open(path, 'r') do |f|
+        error_array = []
+        valid = check_data(f.read, error_array)
+        errors[path] = error_array unless error_array.empty?
+      end
+
+      valid
     end
 
-    def has_errors?
-      ! errors.empty?
+    def check_stream(io_stream)
+      json_data = io_stream.read
+      error_array = []
+
+      valid = check_data(json_data, error_array)
+      errors[''] = error_array unless error_array.empty?
+
+      valid
+    end
+
+    def errors?
+      !errors.empty?
     end
 
     def display_errors
@@ -36,11 +53,31 @@ module JsonLint
 
     private
 
-    def check_syntax_valid(path)
-      Oj.load_file(path, nilnil: false)
+    def check_data(json_data, errors_array)
+      valid = check_not_empty?(json_data, errors_array)
+      valid &&= check_syntax_valid?(json_data, errors_array)
+      valid &&= check_overlapping_keys?(json_data, errors_array)
+
+      valid
+    end
+
+    def check_not_empty?(json_data, errors_array)
+      if json_data.empty?
+        errors_array << 'The JSON should not be an empty string'
+        false
+      elsif json_data.strip.empty?
+        errors_array << 'The JSON should not just be spaces'
+        false
+      else
+        true
+      end
+    end
+
+    def check_syntax_valid?(json_data, errors_array)
+      Oj.load(json_data, nilnil: false)
       true
     rescue Oj::ParseError => e
-      errors[path] << e.message
+      errors_array << e.message
       false
     end
 
@@ -120,28 +157,26 @@ module JsonLint
       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
+        return if @seen_keys.add?(full_key)
+        JsonLint.logger.debug { "Overlapping key #{full_key.join('.')}" }
+        @overlapping_keys << full_key
       end
     end
 
-    def check_overlapping_keys(path)
+    def check_overlapping_keys?(json_data, errors_array)
       overlap_detector = KeyOverlapDetector.new
-      File.open(path, 'r') do |f|
-        Oj.saj_parse(overlap_detector, f)
-      end
+      Oj.saj_parse(overlap_detector, StringIO.new(json_data))
 
       overlap_detector.overlapping_keys.each do |key|
-        errors[path] << "The same key is defined twice: #{key.join('.')}"
+        errors_array << "The same key is defined more than once: #{key.join('.')}"
       end
 
-      !! overlap_detector.overlapping_keys.empty?
+      !!overlap_detector.overlapping_keys.empty?
     end
   end
 end

data/lib/jsonlint/rake_task.rb

@@ -19,15 +19,15 @@ module JsonLint
     private
 
     def define_task
-      desc 'Run jsonlint' unless ::Rake.application.last_comment
+      desc 'Run jsonlint' unless ::Rake.application.last_description
 
-      task(self.name) do
-        files_to_check = Rake::FileList.new(self.paths)
+      task(name) do
+        files_to_check = Rake::FileList.new(paths)
 
         linter = ::JsonLint::Linter.new
         linter.check_all(files_to_check)
 
-        if linter.has_errors?
+        if linter.errors?
           linter.display_errors
           abort('JSON lint found')
         end

data/lib/jsonlint/version.rb

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

data/spec/cli_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe 'jsonlint' do
+  it 'should print usage if run with no args' do
+    jsonlint
+    expect(last_command_started).to_not be_successfully_executed
+    expect(last_command_started).to have_output(/Error: need at least one JSON file to check./)
+  end
+
+  it '-h should print usage' do
+    jsonlint '-h'
+    expect(last_command_started).to be_successfully_executed
+    expect(last_command_started).to have_output(/Usage: jsonlint/)
+  end
+
+  it '--help should print usage' do
+    jsonlint '--help'
+    expect(last_command_started).to be_successfully_executed
+    expect(last_command_started).to have_output(/Usage: jsonlint/)
+  end
+
+  it '-v should print its version' do
+    jsonlint '-v'
+    expect(last_command_started).to be_successfully_executed
+    expect(last_command_started).to have_output JsonLint::VERSION
+  end
+
+  it '--version should print its version' do
+    jsonlint '--version'
+    expect(last_command_started).to be_successfully_executed
+    expect(last_command_started).to have_output JsonLint::VERSION
+  end
+
+  it 'should exit successfully with good JSON' do
+    jsonlint spec_data('valid.json')
+    expect(last_command_started).to be_successfully_executed
+  end
+
+  it 'should fail with bad JSON' do
+    jsonlint spec_data('missing_comma.json')
+    expect(last_command_started).to_not be_successfully_executed
+  end
+
+  it 'should fail with a path that does not exist' do
+    jsonlint '/does/not/exist'
+    expect(last_command_started).to_not be_successfully_executed
+    expect(last_command_started).to have_output(/no such file/)
+  end
+
+  it 'should fail with a path that is unreadable' do
+    run_simple('mkdir -p tmp')
+    run_simple('touch tmp/unreadable_file.json')
+    run_simple('chmod -r tmp/unreadable_file.json')
+
+    jsonlint 'tmp/unreadable_file.json'
+    expect(last_command_started).to_not be_successfully_executed
+    expect(last_command_started).to have_output(/Permission denied/)
+  end
+
+  it 'should be able to lint good JSON from STDIN' do
+    run "#{jsonlint_bin} -"
+    pipe_in_file('../../spec/data/valid.json') and close_input
+    expect(last_command_started).to be_successfully_executed
+  end
+
+  it 'should be able to lint bad JSON from STDIN' do
+    run "#{jsonlint_bin} -"
+    pipe_in_file('../../spec/data/missing_comma.json') and close_input
+    expect(last_command_started).to_not be_successfully_executed
+  end
+end

data/spec/data/lots_of_spaces.json

@@ -0,0 +1,2 @@
+  	  
+   

data/spec/linter_spec.rb

@@ -5,7 +5,7 @@ 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
+    expect { linter.check('/does/not/exist') }.to raise_error(JsonLint::FileNotFoundError)
   end
 
   it 'should be happy with a valid JSON file' do
@@ -22,4 +22,20 @@ describe 'JsonLint::Linter' do
     expect(linter.check(spec_data('overlapping_keys.json'))).to be(false)
     expect(linter.check(spec_data('deep_overlap.json'))).to be(false)
   end
+
+  it 'should be able to check an IO stream' do
+    valid_stream = File.open(spec_data('valid.json'))
+    expect(linter.check_stream(valid_stream)).to be(true)
+
+    invalid_stream = File.open(spec_data('missing_comma.json'))
+    expect(linter.check_stream(invalid_stream)).to be(false)
+  end
+
+  it 'should be unhappy with an empty JSON file' do
+    expect(linter.check(spec_data('empty_file.json'))).to be(false)
+  end
+
+  it 'should be unhapy with a JSON file full of spaces' do
+    expect(linter.check(spec_data('lots_of_spaces.json'))).to be(false)
+  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
 require 'rspec'
 
+require 'aruba'
+require 'aruba/rspec'
+
 require 'jsonlint'
 
 module SpecHelpers
@@ -8,6 +11,21 @@ module SpecHelpers
   end
 end
 
+module CliSpecHelpers
+  def jsonlint(args = nil)
+    run_simple("#{jsonlint_bin} #{args}", fail_on_error: false)
+  end
+
+  def jsonlint_bin
+    File.expand_path('../../bin/jsonlint', __FILE__)
+  end
+end
+
 RSpec.configure do |config|
   config.include SpecHelpers
+  config.include CliSpecHelpers
+  config.include Aruba::Api
+
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
 end

metadata

@@ -1,78 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: jsonlint
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Doug Barth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-03 00:00:00.000000000 Z
+date: 2016-08-07 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: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    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
@@ -83,8 +102,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -97,7 +116,10 @@ files:
 - lib/jsonlint/linter.rb
 - lib/jsonlint/rake_task.rb
 - lib/jsonlint/version.rb
+- spec/cli_spec.rb
 - spec/data/deep_overlap.json
+- spec/data/empty_file.json
+- spec/data/lots_of_spaces.json
 - spec/data/missing_brace.json
 - spec/data/missing_comma.json
 - spec/data/overlapping_keys.json
@@ -109,36 +131,32 @@ files:
 homepage: 
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: JSON lint checker
 test_files:
+- spec/cli_spec.rb
 - spec/data/deep_overlap.json
+- spec/data/empty_file.json
+- spec/data/lots_of_spaces.json
 - spec/data/missing_brace.json
 - spec/data/missing_comma.json
 - spec/data/overlapping_keys.json
@@ -147,3 +165,4 @@ test_files:
 - spec/data/valid_array_of_objects.json
 - spec/linter_spec.rb
 - spec/spec_helper.rb
+has_rdoc: