jscop 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dfcb068c701434605b2f0c9b0493a63da87b7c38cac2ed9a1863c455a96c709a
+  data.tar.gz: 0f3b9fafaa1827044fd26dd3d0ae1ff376ddcbac0acefe58167999806deb640e
+SHA512:
+  metadata.gz: 9874c505f8f141e9442455798f5b6f36f611ef4d318fec1796a0ac50d9ba3fc80f28000eea7c23080580f5f10001c0078b584ce3ae8659469e061eab7650da50
+  data.tar.gz: 225eadd3a11c805980f442f18538db222fba198791dc93fbb0cb4a4f44de9bcdda3807269f5886f73e297e7f48e12427d5786f8a7f268737d5458c2fff20deea

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.replit

@@ -0,0 +1,2 @@
+language = "ruby"
+run = "bin/main.rb ."

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,69 @@
+AllCops:
+  Exclude:
+    - "spec/spec_helper.rb"
+    - "README.md"
+    - "Guardfile"
+    - "Rakefile"
+    - "rof_work.rb"
+    - "vendor"
+
+  DisplayCopNames: true
+
+Lint/RaiseException:
+  Enabled: false
+Lint/StructNewOverride:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 30
+Metrics/AbcSize:
+  Max: 50
+Metrics/ClassLength:
+  Max: 150
+Metrics/BlockLength:
+  ExcludedMethods: ["describe"]
+  Max: 30
+Metrics/ModuleLength:
+  Max: 150
+Metrics/CyclomaticComplexity:
+  Max: 20
+Metrics/PerceivedComplexity:
+  Max: 20
+Metrics/ParameterLists:
+  Max: 7
+
+Style/Documentation:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/EachForSimpleLoop:
+  Enabled: false
+Style/AndOr:
+  Enabled: false
+Style/DefWithParentheses:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+Style/NegatedIf:
+  Enabled: false
+Style/NegatedUnless:
+  Enabled: false
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: false
+Style/HashTransformKeys:
+  Enabled: false
+Style/HashTransformValues:
+  Enabled: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: key
+Layout/ExtraSpacing:
+  AllowForAlignment: false
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented

data/.stickler.yml

@@ -0,0 +1,13 @@
+linters:
+  rubocop:
+    display_cop_names: true
+    config: "./rubocop.yml"
+
+files:
+  ignore:
+    - "Guardfile"
+    - "Rakefile"
+    - "node_modules/**/*"
+    - "spec/spec_helper.rb"
+    - "rof_work.rb"
+    - "vendor"

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ezakaphil@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jscop.gemspec
+gemspec
+gem 'colorize', '~> 0.8.1'
+gem 'rspec'
+gem 'rubocop'
+gem 'tty-font', '~> 0.5.0'

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    jscop (0.1.2)
+      colorize (~> 0.8)
+      tty-font (~> 0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    colorize (0.8.1)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.1.1)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    tty-font (0.5.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  colorize (~> 0.8.1)
+  jscop!
+  rake (~> 10.0)
+  rspec
+  rubocop
+  tty-font (~> 0.5.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 codecell solutions
+
+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,101 @@
+[![Run on Repl.it](https://repl.it/badge/github/codecell/js-companion)](https://repl.it/github/codecell/js-companion)
+
+# Js-Companion
+
+This is a Linter for checking errors in Javascript code, built with Ruby. 
+
+## PREVIEW
+   ![image](https://user-images.githubusercontent.com/46686100/78828956-6eb04300-79dd-11ea-8529-598e8dc3011e.png) 
+
+## Outline
+  - Title, Description and Preview Above
+  - Errors currently detectable by js-companion
+    - variable naming errors
+    - class naming errors
+    - Extra or redundant spacing errors 
+    - Multiple declaration of classes in a file (class count) errors
+    - Unused variables are detected
+  - Arguments supported to initiate linting
+  - Testing Javascript files with Js-Companion
+    - without cloning
+    - cloning Locally to local machine
+  - Unit Tests
+  - Tools used
+  - Contributing
+  - Author Details
+
+## ERRORS that can currently be detected include
+
+### VARIABLE NAMING ERRORS
+  - if capital letters or numbers is used to start a variable name, e.g
+    - `*Bad practice* let 8owngoal = 4 or const Capvar = 9`
+    - `*Good Practice* let meka = 4 or const mEeka = 9`
+    
+### CLASS NAME ERRORS 
+  - if class names begin With small letters and/or
+  - if class names is Snake-Cased or both e.g
+    - `*Bad practice* class badclass {} or class Bad-class {}`    
+    - `*Good Practice* class GoodClass {} or class Good_Class {}`
+    
+### SPACING ERRORS
+  - if Spaces are found at beginning of lines
+  - if extra spaces are found around variables e.g
+    - `*Bad practice* let|   | vacuuuum = 4 or var hollow|    | = 9`
+    - `*Good Practice* let meka = 4 or const mEeka = 9`
+
+### CLASS COUNT ERROR
+  - if more than one class is defined in a Module,
+
+### UNUSED VARIABLE ERROR
+  - if a variable (var, let, const) is defined and never used.
+
+## Arguments Supported By Js-Companion to check Javascript code
+  - You can pass in file(s) or a folder in any of the following cases in your terminal
+    - `Youn can pass in a specific file Path to test just the file`
+    - `You can pass in a Folder and all Javascript files in it will be checked and finally`
+    - `Everything Js can be linted all at once (both files and Folders)`
+
+## Testing Your Javscript code
+  -  ### Without Cloning
+  - If You don't want to clone this repository, you can simply click the `Run On Replit badge` above
+    to quickly test the project on Replit. *Note* However that the the Replit console(terminal) does not support the colors and font gems used, so it will appear black/white
+
+    ### To clone and test Javascript files locally
+  - Once in the Path you intend to keep this project in the terminal of your machine
+  - Clone with this command `git clone [repo](https://github.com/codecell/js-companion.git)`
+  - Enter into the folder `cd js-companion`
+  - Install project dependencies with the command `bundle install`
+  - You can make the bin/main.rb executable with the command `chmod +x bin/main.rb` if permission is not granted.
+
+  ### Finally To Check Javascript File;
+  - use the command `bin/main.rb ./**/path_to_file.js` To lint JUST a specific file.
+  - use the command `bin/main.rb FolderName` To lint all `*.js` files a specific folder.
+  - To lint everything, use the command *bin/main.rb dot* => `bin/main.rb .` to lint (all files and folders) visible from the root of the current folder.
+
+## Unit Tests
+- Ensure you have `rspec` installed, or ensure the `gem 'rspec` is listed among the gems in the `Gemfile` => then run `bundle install`
+- in your console, run `rspec` to run all the unit tests written for this project
+
+## Built With
+- Ruby
+- [Rubular](https://rubular.com/) Was used to craft and test the regular expressions
+- Rubocop Linter
+- Stickler CI
+
+## Contributing 
+- Your contributions are highly welcome on improving this project
+
+## Author
+
+👤 **Alfred Ezaka**
+
+- Github: [@codecell](https://github.com/codecell)
+- Twitter: [@the_codecell](https://twitter.com/the_codecell) 
+- Linkedin: [ezaka alfred](https://www.linkedin.com/in/alfrednoble/)
+
+
+## Show your support
+
+Give a ⭐️ if you like this project!
+## Licence
+MIT

data/Rakefile

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

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/jscop

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+require "jscop/version"
+require_relative '../lib/helpers/lint_ware'
+require 'tty-font'
+require 'colorize'
+
+def show_title
+  font = TTY::Font.new
+  font_messge = font.write('Jscop', letter_spacing: 1)
+  puts font_messge
+end
+
+def print_linter_result(error_bin, fpath)
+  puts
+  puts "#{error_bin.length.to_s.yellow} Offense(s) Detected" unless error_bin.empty?
+
+  path_exists = File.exist?(fpath) || Dir.exist?(fpath)
+
+  success_msg = 'As clean as Snow!. No offenses found in the $PATH'
+
+  puts "#{success_msg} #{fpath}".green if error_bin.empty? && path_exists == true
+  puts
+end
+
+def jscop_init
+  show_title
+
+  path = ARGV[0]
+  
+  path = '.' if ARGV.empty?
+
+  error_bin = []
+
+  js_file_pattern = /(\w|\W)+.js$/
+
+  if js_file_pattern.match?(path)
+    LintWare.init_files_linting(error_bin, path)
+  else
+    LintWare.init_dir_linting(error_bin, path)
+  end
+
+  print_linter_result(error_bin, path)
+end
+
+jscop_init

data/jscop.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jscop/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jscop"
+  spec.version       = Jscop::VERSION
+  spec.authors       = ["Ezaka Alfred"]
+  spec.email         = ["ezakaphil@gmail.com"]
+
+  spec.summary       = %q{A linter for checking errors in javascript code}
+  spec.homepage      = "https://github.com/codecell/jscop"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables << "jscop"
+  spec.require_paths = ["lib", "spec"]
+
+  spec.add_runtime_dependency "colorize", "~> 0.8"
+  spec.add_runtime_dependency "tty-font", "~> 0.5"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/classes/error.rb

@@ -0,0 +1,33 @@
+class Error
+  attr_accessor :line, :err_type, :file_path, :variable
+
+  # rubocop:disable Lint/UnusedMethodArgument
+  def initialize(line, err_type, fpath, *variable)
+    @line = line
+    @err_type = err_type
+    @file_path = fpath
+  end
+  # rubocop:enable Lint/UnusedMethodArgument
+
+  def print_err(line, type, path, *variable)
+    error_hash = {
+      'VAR_NAMING_ERR': 'VariableName Error: Uppercase|Numbers used to Start a Variable name.',
+      'CLASS_NAME_ERR': 'ClassName Error: Ensure classes Begin With Uppercase and is not Snake-Cased.',
+      'SPACING_ERR': 'Spacing Error: Redundant Space(s).',
+      'CLASS_COUNT_ERR': 'Count Error: Multiple Classes Defined in a Module.',
+      'UNUSED_VAR_ERR': "Warning: Unused Variable ** #{variable[0]} ** Detected."
+    }
+
+    emit_err = lambda { |key|
+      if type == 'UNUSED_VAR_ERR' && key[0].to_s == type
+        puts "#{key[1].to_s.yellow} On Line #{line.to_s.yellow} in #{path.to_s.yellow}" if line
+        puts
+      elsif type != 'UNUSED_VAR_ERR' && key[0].to_s == type
+        puts "#{key[1].to_s.red} Detected On Line #{line.to_s.yellow} in #{path.to_s.yellow}"
+        puts
+      end
+    }
+
+    error_hash.each(&emit_err)
+  end
+end

data/lib/classes/js_parser.rb

@@ -0,0 +1,24 @@
+require_relative './line'
+
+class JsParser
+  attr_reader :filename, :lines
+
+  def initialize(filename)
+    @filename = filename
+    @lines = []
+    set_lines
+  end
+
+  def set_lines
+    file = File.open(@filename)
+
+    all_lines = file.readlines.map(&:chomp)
+    init_lines = lambda { |val, index|
+      line = Line.new(index + 1, val, @filename)
+      @lines << line
+    }
+
+    all_lines.each_with_index(&init_lines)
+    file.close
+  end
+end

data/lib/classes/line.rb

@@ -0,0 +1,9 @@
+class Line
+  attr_reader :number, :content, :filename
+
+  def initialize(number, content, filename)
+    @number = number
+    @content = content
+    @filename = filename
+  end
+end

data/lib/helpers/lint_ware.rb

@@ -0,0 +1,39 @@
+require_relative '../jscop/check_js_files'
+require_relative '../jscop/spacing_checker'
+require_relative '../jscop/naming_checker'
+require_relative '../jscop/class_count'
+require_relative '../jscop/class_name'
+require_relative '../jscop/unused_var_checker'
+
+require_relative '../classes/js_parser'
+
+module LintWare
+  private_class_method def self.start_all(error_bin, given_file)
+    file = JsParser.new(given_file)
+
+    NamingChecker.check_naming_res(error_bin, file)
+    SpacingChecker.check_spaces_res(error_bin, file)
+    ClassCount.class_count_res(error_bin, file)
+    ClassName.check_class_name_res(error_bin, file)
+    UnusedVarChecker.check_unused_var_res(error_bin, file)
+
+    error_bin
+  end
+
+  def self.init_files_linting(error_bin, path)
+    if CheckJsFiles.find_file(path)
+      start_all(error_bin, path)
+    else
+      puts "No such File as #{path}".yellow
+    end
+  end
+
+  def self.init_dir_linting(error_bin, path)
+    if CheckJsFiles.find_dir(path)
+      files = CheckJsFiles.seek_js(path)
+      files.each { |file| start_all(error_bin, file) } if files
+    else
+      CheckJsFiles.find_dir(path)
+    end
+  end
+end

data/lib/jscop/check_js_files.rb

@@ -0,0 +1,29 @@
+# Locate Js files in defined paths on the Terminal
+
+module CheckJsFiles
+  def self.find_file(path)
+    puts "No such File as #{path}" if !File.exist?(path)
+
+    File.exist?(path)
+  end
+
+  def self.find_dir(path)
+    puts "No such Folder as #{path}".yellow unless Dir.exist?(path)
+
+    Dir.exist?(path)
+  end
+
+  def self.seek_js(*path)
+    if path[0]
+      files = Dir["#{path[0]}/**/*.js"]
+      return files if !files.empty?
+
+      puts "No JS files found in #{path[0]} Path" if files.empty?
+    else
+      files = Dir['./**/*.js']
+      return files if !files.empty?
+
+      puts 'No JS files found in this Folder' if files.empty?
+    end
+  end
+end

data/lib/jscop/class_count.rb

@@ -0,0 +1,28 @@
+require_relative '../classes/error'
+
+module ClassCount
+  def self.class_count_res(error_bin, path)
+    lines_with_class_def = class_count(path)
+    error_bin << lines_with_class_def if lines_with_class_def.length > 1
+
+    error_bin
+  end
+
+  private_class_method def self.raise_err(line, message, path)
+    error = Error.new(line, message, path)
+    class_count_err = error.print_err(line, message, path) if error
+    class_count_err
+  end
+
+  def self.class_count(file)
+    pat = /(class)/
+
+    lines_with_class = []
+    err_type = 'CLASS_COUNT_ERR'
+
+    file.lines.each { |line| lines_with_class << line.number if pat.match?(line.content) }
+    raise_err(lines_with_class, err_type, file.filename) if lines_with_class.length > 1
+
+    lines_with_class
+  end
+end