codeclimate-engine-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 439a853dc1e069802816f36dd3de911bfa46e5ad
+  data.tar.gz: abb3f787278011087b7078dade06ef9f94656de4
+SHA512:
+  metadata.gz: b9b351cf613c18fc4c972ca9ae37f50f3973ae1f1608f931c855b79d2851074bd70b8f3872be3536c49167e2835c7737ae8ba24852c55a2970f5b2781f56dbd8
+  data.tar.gz: 2451dad2cfef7a78909403d40586951d7104dc442c4d3685ee279d8949d793643b9e6fb6cc4c064075aa7de3fe369aff03107276e051ab462f3da96094dc60ba

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Style/Documentation:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,75 @@
+# codeclimate-engine-rb
+
+A simple way to create issues in the JSON format described in the [Code Climate Engine specification].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'codeclimate_engine'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install codeclimate_engine
+
+## Usage
+
+```ruby
+location = CCEngine::Location::LineRange.new(
+  path:       "foo/bar.txt",
+  line_range: 13..14
+)
+
+issue = CCEngine::Issue.new(
+  check_name:  "Bug Risk/Unused Variable",
+  description: "Unused local variable `foo`",
+  categories:  [CCEngine::Category.complexity, CCEngine::Category.style],
+  location:    location
+)
+
+issue.to_json
+```
+
+The result would be:
+
+```json
+{
+  "type": "issue",
+  "check_name":  "Bug Risk/Unused Variable",
+  "description": "Unused local variable `foo`",
+  "categories":  ["Complexity", "Style"],
+  "location": {
+    "path": "foo/bar.txt",
+    "lines": {
+      "begin": 13,
+      "end":   14
+    }
+  }
+}
+```
+
+There are some other ways to specify the location – please browse the gem's
+tests for details.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/andyw8/codeclimate-engine-rb/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
+
+[Code Climate Engine specification]: https://github.com/codeclimate/spec/blob/master/SPEC.md

data/Rakefile

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

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "codeclimate_engine"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/codeclimate_engine.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cc_engine/version'
+
+# rubocop:disable Metrics/LineLength
+Gem::Specification.new do |spec|
+  spec.name          = "codeclimate-engine-rb"
+  spec.version       = CCEngine::VERSION
+  spec.authors       = ["Andy Waite"]
+  spec.email         = ["github.aw@andywaite.com"]
+
+  spec.summary       = "JSON issue formatter for the Code Climate engine"
+  spec.homepage      = "https://github.com/andyw8/codeclimate-engine-rb"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_dependency "virtus", "~> 1.0"
+end
+# rubocop:enable Metrics/LineLength

data/lib/cc_engine/category.rb

@@ -0,0 +1,31 @@
+module CCEngine
+  module Category
+    def self.bug_risk
+      "Bug Risk"
+    end
+
+    def self.clarity
+      "Clarity"
+    end
+
+    def self.compatibility
+      "Compatibility"
+    end
+
+    def self.complexity
+      "Complexity"
+    end
+
+    def self.duplication
+      "Duplication"
+    end
+
+    def self.security
+      "Security"
+    end
+
+    def self.style
+      "Style"
+    end
+  end
+end

data/lib/cc_engine/config.rb

@@ -0,0 +1,31 @@
+require "json"
+
+module CCEngine
+  class Config
+    def initialize(json_string)
+      @json_string = json_string
+    end
+
+    def include_paths
+      parsed_json.fetch("include_paths")
+    end
+
+    def exclude_paths
+      parsed_json.fetch("exclude_paths")
+    end
+
+    def enabled?
+      parsed_json.fetch("enabled")
+    end
+
+    protected
+
+    attr_reader :json_string
+
+    private
+
+    def parsed_json
+      @parsed_json = JSON.parse(json_string)
+    end
+  end
+end

data/lib/cc_engine/issue.rb

@@ -0,0 +1,38 @@
+require "virtus"
+require "json"
+
+module CCEngine
+  class Issue
+    include Virtus.model(strict: true)
+
+    attribute :check_name, String
+    attribute :description, String
+    attribute :categories, Array[String]
+    attribute :location
+    attribute :remediation_points
+
+    def to_json
+      to_hash.to_json
+    end
+
+    def to_hash
+      {
+        type: "issue",
+        check_name: check_name,
+        description: description,
+        categories: categories,
+        location: location.to_hash
+      }.merge(remediation_points_hash)
+    end
+
+    private
+
+    def remediation_points_hash
+      return {} unless remediation_points
+
+      {
+        remediation_points: remediation_points
+      }
+    end
+  end
+end

data/lib/cc_engine/location.rb

@@ -0,0 +1,2 @@
+require "cc_engine/location/line_range"
+require "cc_engine/location/position"

data/lib/cc_engine/location/line_range.rb

@@ -0,0 +1,22 @@
+require "virtus"
+
+module CCEngine
+  module Location
+    class LineRange
+      include Virtus.model(strict: true)
+
+      attribute :path, String
+      attribute :line_range, Range
+
+      def to_hash
+        {
+          path: path,
+          lines: {
+            begin: line_range.begin,
+            end: line_range.end
+          }
+        }
+      end
+    end
+  end
+end

data/lib/cc_engine/location/position.rb

@@ -0,0 +1,23 @@
+require "virtus"
+
+module CCEngine
+  module Location
+    class Position
+      include Virtus.model(strict: true)
+
+      attribute :path, String
+      attribute :start_position
+      attribute :end_position
+
+      def to_hash
+        {
+          path: path,
+          positions: {
+            begin: start_position.to_hash,
+            end: end_position.to_hash
+          }
+        }
+      end
+    end
+  end
+end

data/lib/cc_engine/position/grid.rb

@@ -0,0 +1,19 @@
+require "virtus"
+
+module CCEngine
+  module Position
+    class Grid
+      include Virtus.model(strict: true)
+
+      attribute :line, Integer
+      attribute :column, Integer
+
+      def to_hash
+        {
+          line: line,
+          column: column
+        }
+      end
+    end
+  end
+end

data/lib/cc_engine/position/offset.rb

@@ -0,0 +1,17 @@
+require "virtus"
+
+module CCEngine
+  module Position
+    class Offset
+      include Virtus.model(strict: true)
+
+      attribute :offset, Integer
+
+      def to_hash
+        {
+          offset: offset
+        }
+      end
+    end
+  end
+end

data/lib/cc_engine/version.rb

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

data/lib/codeclimate_engine.rb

@@ -0,0 +1,5 @@
+require "cc_engine/version"
+require "cc_engine/issue"
+require "cc_engine/location"
+require "cc_engine/category"
+require "cc_engine/config"

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: codeclimate-engine-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Waite
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- github.aw@andywaite.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- codeclimate_engine.gemspec
+- lib/cc_engine/category.rb
+- lib/cc_engine/config.rb
+- lib/cc_engine/issue.rb
+- lib/cc_engine/location.rb
+- lib/cc_engine/location/line_range.rb
+- lib/cc_engine/location/position.rb
+- lib/cc_engine/position/grid.rb
+- lib/cc_engine/position/offset.rb
+- lib/cc_engine/version.rb
+- lib/codeclimate_engine.rb
+homepage: https://github.com/andyw8/codeclimate-engine-rb
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: JSON issue formatter for the Code Climate engine
+test_files: []
+has_rdoc: