learn_linter 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff6709294423453b712f1860fb87d32547883ef4
+  data.tar.gz: 8aad25a7d9c986e6025828c8781e6a4e3c4cd2c0
+SHA512:
+  metadata.gz: bab10c9091c47939a7f5ab3404b7c5b913fe240da5b99bc5817f17b56da64661150abc08505cefd17e14efc9dec2087b20bce3b3d5e868507fbb6dc8411c26d3
+  data.tar.gz: 665585a7d296bfc2b55f4e011f48f7051eae194484c936562d124be21019d9cfe96d94381cdd4c4f9a2bc29b411f4d2a747e6492a828ff0a798435cad7ef251c

data/bin/learn-lint

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require 'yaml'
+require 'optparse'
+require_relative '../lib/learn_linter.rb'
+
+if ARGV.length == 0
+  dir = File.expand_path(File.dirname(File.dirname(__FILE__)))
+  lint = LearnLinter.new(dir).lint_directory
+elsif ARGV.length == 1 && ARGV[0] == "quiet"
+  dir = File.expand_path(File.dirname(File.dirname(__FILE__)))
+  lint = LearnLinter.new(dir, "quiet")
+elsif ARGV.length > 1 && ARGV[1] == "quiet"
+  lint = LearnLinter.new(ARGV[0], "quiet").lint_directory
+elsif ARGV.length > 1 && ARG[1] != "quiet"
+  puts "please use 'learn-lint directory_name quiet' or 'learn-lint directory_name"
+elsif ARGV.length == 1
+  lint = LearnLinter.new(ARGV[0]).lint_directory
+end
+
+

data/lib/learn_linter/learn_error.rb

@@ -0,0 +1,52 @@
+class LearnError < StandardError
+  attr_accessor :filepath, :valid_yaml, :valid_license, 
+  :present_learn, :present_license, :present_readme, :yaml_error, 
+  :readme_error, :license_error, :valid_readme, :correct_yaml_content
+
+  ESCAPES = { :green  => "\033[32m",
+              :yellow => "\033[33m",
+              :red    => "\033[31m",
+              :reset  => "\033[0m" }
+
+
+  def initialize
+    @yaml_error = {present_dotlearn: false, valid_yaml: false, valid_whitespace: false, attributes: false}
+    @readme_error = {present_readme: false, valid_readme: false}
+    @license_error = {present_license: false, valid_license: false}
+    @correct_yaml_content = {message: ".learn file must have 'tags', 'resources' and 'languages' keys", color: :yellow}
+    @valid_yaml = {message: "invalid yaml", color: :red}
+    @valid_license = {message: "invalid or missing license content", color: :yellow}
+    @valid_readme = {message: "invalid code snippet. Must have three backticks to open and close all code snippets", color: :red}
+    @present_learn = {message: "missing .learn file", color: :red}
+    @present_license = {message: "missing LICENSE.md", color: :red}
+    @present_readme = {message: "missing README.md", color: :yellow}
+
+  end
+
+  def emit(opts={})
+    color   = opts[:color]
+    message = opts[:message]
+    print ESCAPES[color]
+    print message
+    print ESCAPES[:reset]
+    print "\n"
+  end
+
+  def total_errors
+    {
+      dot_learn: yaml_error,
+      license: license_error,
+      readme: readme_error
+    }
+    
+  end
+
+
+  def result_output
+    all_results = [present_learn, valid_yaml, correct_yaml_content, present_license, valid_license, present_readme, valid_readme]
+    all_results.each do |result|
+      emit(result)
+    end
+  end
+
+end

data/lib/learn_linter/license_linter.rb

@@ -0,0 +1,17 @@
+class LicenseLinter 
+
+  VALID_FILE = File.open(File.expand_path(File.dirname(__FILE__)) + '/valid_license.md')
+
+  def self.parse_file(file, learn_error)
+    directory_file = File.open(file).read
+    valid_file = VALID_FILE.read
+    if sanitize_whitespace(directory_file) == sanitize_whitespace(valid_file)
+      learn_error.license_error[:valid_license] = true
+      learn_error.valid_license = {message: "valid license", color: :green}
+    end
+  end
+
+  def self.sanitize_whitespace(file)
+    file.split("\n").delete_if { |l| l.empty? }
+  end
+end

data/lib/learn_linter/readme_linter.rb

@@ -0,0 +1,33 @@
+class ReadmeLinter
+
+  def self.parse_file(file, learn_error)
+    file_string = File.open(file).read
+    if has_code_snippets?(file_string)
+      validate_snippets(file_string, learn_error)
+    else
+      green_light(learn_error)
+    end
+  end
+
+  def self.green_light(learn_error)
+    learn_error.readme_error[:valid_readme] = true
+    learn_error.valid_readme = {message: "valid readme", color: :green}
+  end
+
+  def self.has_code_snippets?(file)
+    file.match(/``/)
+  end
+
+  def self.validate_snippets(file, learn_error)
+    file.split(" ").each do |chars|
+      if chars.match(/``/)
+        if !(chars.match(/```ruby/) || chars.match(/```bash/) || chars.match(/```objc/) || chars.match(/```javascript/) || chars.match(/``` /))
+          break
+        else
+          green_light(learn_error)
+        end
+      end
+    end
+  end
+end
+    

data/lib/learn_linter/valid_license.md

@@ -0,0 +1,7 @@
+#Learn.co Educational Content License
+
+Copyright (c) 2015 Flatiron School, Inc
+
+The Flatiron School, Inc. owns this Educational Content. However, the Flatiron School supports the development and availability of educational materials in the public domain. Therefore, the Flatiron School grants Users of the Flatiron Educational Content set forth in this repository certain rights to reuse, build upon and share such Educational Content subject to the terms of the Educational Content License set forth [here](http://learn.co/content-license) (http://learn.co/content-license). You must read carefully the terms and conditions contained in the Educational Content License as such terms govern access to and use of the Educational Content.
+
+Flatiron School is willing to allow you access to and use of the Educational Content only on the condition that you accept all of the terms and conditions contained in the Educational Content License set forth [here](http://learn.co/content-license) (http://learn.co/content-license).  By accessing and/or using the Educational Content, you are agreeing to all of the terms and conditions contained in the Educational Content License.  If you do not agree to any or all of the terms of the Educational Content License, you are prohibited from accessing, reviewing or using in any way the Educational Content.

data/lib/learn_linter/version.rb

@@ -0,0 +1,3 @@
+class LearnLinter
+  VERSION = "0.2.0"
+end

data/lib/learn_linter/yaml_linter.rb

@@ -0,0 +1,44 @@
+require 'yaml'
+
+class YamlLint
+
+
+  def self.parse_file(file, learn_error)
+    begin
+      YAML.load_file(file)
+    rescue Exception => err
+      learn_error.valid_yaml = {message: "#{err}", color: :red}
+    else
+      learn_error.yaml_error[:valid_yaml] = true
+      if check_attributes(file)
+        learn_error.yaml_error[:attributes] = true
+        learn_error.correct_yaml_content = {message: "valid attribute key names", color: :green}
+      end
+      if self.validate_whitespace_for_learn(file)
+        learn_error.yaml_error[:valid_whitespace] = true
+        learn_error.valid_yaml = {message: "valid yaml and valid whitespace.", color: :green}
+      else 
+        learn_error.valid_yaml = {message: "valid yaml but invalid whitespace", color: :red}
+      end
+    end
+  end
+
+  def self.validate_whitespace_for_learn(file)
+    lines = file_lines(file).split("\n")
+    attributes = lines.select { |line| line.include?("-") }
+    attributes.each do |attribute| 
+      return false unless attribute[0..3] == "  - "
+    end
+    true
+  end 
+
+   def self.check_attributes(file)
+    file_string = file_lines(file)
+    file_string.match(/tags/) && file_string.match(/resources/) && file_string.match(/languages/)
+  end
+
+  def self.file_lines(file)
+    f = File.read(file)
+  end
+
+end

data/lib/learn_linter.rb

@@ -0,0 +1,58 @@
+require_relative './learn_linter/version'
+require_relative './learn_linter/learn_error'
+require_relative './learn_linter/license_linter'
+require_relative './learn_linter/readme_linter'
+require_relative './learn_linter/yaml_linter'
+
+class LearnLinter
+
+  attr_accessor :filepath, :quiet
+
+
+  def initialize(filepath, quiet=nil)
+    @filepath = filepath
+    @learn_error = LearnError.new
+    @quiet = quiet
+  end
+
+  def lint_directory
+    self.yaml_lint
+    self.license_lint
+    self.readme_lint
+    unless quiet
+      @learn_error.result_output
+    end
+    @learn_error.total_errors
+  end
+
+
+
+  def has_file?(file)
+    Dir.entries(filepath).include?(file)
+  end
+
+  def yaml_lint
+    if self.has_file?(".learn")
+      @learn_error.yaml_error[:present_dotlearn] = true
+      @learn_error.present_learn = {message: "present .learn file", color: :green}
+      YamlLint.parse_file("#{filepath}/.learn", @learn_error)
+    end
+  end
+
+  def license_lint
+    if self.has_file?("LICENSE.md")
+      @learn_error.license_error[:present_license] = true
+      @learn_error.present_license = {message: "present LICENSE.md", color: :green}
+      LicenseLinter.parse_file("#{filepath}/LICENSE.md", @learn_error)
+    end
+  end
+
+  def readme_lint
+    if self.has_file?("README.md")
+      @learn_error.readme_error[:present_readme] = true
+      @learn_error.present_readme = {message: "present README.md", color: :green}
+      ReadmeLinter.parse_file("#{filepath}/README.md", @learn_error)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: learn_linter
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Sophie DeBenedetto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- sophie.debenedetto@gmail.com
+executables:
+- learn-lint
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/learn-lint
+- lib/learn_linter.rb
+- lib/learn_linter/learn_error.rb
+- lib/learn_linter/license_linter.rb
+- lib/learn_linter/readme_linter.rb
+- lib/learn_linter/valid_license.md
+- lib/learn_linter/version.rb
+- lib/learn_linter/yaml_linter.rb
+homepage: ''
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: can lint a directory for valid .learn, license files
+test_files: []