jscop 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cc2232c173339355f33b21707cdee6063a15a0fdce311f67fe2727e7a09dd1a
-  data.tar.gz: b9d78f2dd4071da98d8e081ca4a4bb5473c169362226460fb3cbb6fd1a03f483
+  metadata.gz: 4b64419ab3765a43ca858c74dc7e95b2518520c68c3c57d8a24b85e147b2963e
+  data.tar.gz: dc8bb2e1329895ac6a7dbfce27027c5cc6011627dd2d684ef2df9d29943e68bb
 SHA512:
-  metadata.gz: b6ae88acec4fdc5ba41b6020d2931318494311c8d2709245d2bea6c664fd047cd40cd0aa43b399948e43d68d89081f845f40dc1feca2be1dbb75c3546cbb9c9e
-  data.tar.gz: 89f46e2cd210c120fba2dcd17a7d2daaddfb32f01f25b35991cedb2381204d383cba96a351d0698a4c2e388df331854946d932e483ce7df1020549ba9db57581
+  metadata.gz: 345026f8b2c53c1debc6e0ad81230f40fac8a04b098c9383281014724b8212437542ec1d3dbf859898974071c77e3e0f8a9421037ee1356f02723ba55cd1940f
+  data.tar.gz: 5cb920394d53327036d0d378efba2fe4bd5b6d5d12f83ed652df76a6acb11dec4e3df8460efebcb9823f0262d197810e26edb646d7edbe5d7b2908632a5fb5e3

data/.rubocop.yml

@@ -1,10 +1,10 @@
 AllCops:
   Exclude:
     - "spec/spec_helper.rb"
+    - "lib/jscop/spacing_checker.rb"
     - "README.md"
     - "Guardfile"
     - "Rakefile"
-    - "rof_work.rb"
     - "vendor/**/*"
     - "jscop.gemspec"
 
@@ -14,6 +14,8 @@ Lint/RaiseException:
   Enabled: false
 Lint/StructNewOverride:
   Enabled: false
+Lint/UselessAssignment:
+  Enabled: false
 
 Layout/LineLength:
   Max: 120

data/.stickler.yml

@@ -6,9 +6,9 @@ linters:
 files:
   ignore:
     - "Guardfile"
+    - "lib/jscop/spacing_checker.rb"
     - "Rakefile"
     - "node_modules/**/*"
     - "spec/spec_helper.rb"
-    - "rof_work.rb"
     - "vendor/**/*"
     - "jscop.gemspec"

data/Gemfile

@@ -5,6 +5,7 @@ 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 'rake', '~> 12.3.3'
 gem 'rspec'
 gem 'rubocop'
 gem 'tty-font', '~> 0.5.0'

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    jscop (0.1.7)
+      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.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    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 (~> 12.3.3)
+  rspec
+  rubocop
+  tty-font (~> 0.5.0)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -1,9 +1,25 @@
-[![Gem Version](https://badge.fury.io/rb/jscop.svg)](https://badge.fury.io/rb/jscop) [![Run on Repl.it](https://repl.it/badge/github/codecell/js-companion)](https://repl.it/github/codecell/js-companion)
+[![Gem Version](https://badge.fury.io/rb/jscop.svg)](https://badge.fury.io/rb/jscop)  [![Build Status](https://travis-ci.org/codecell/jscop.svg?branch=development)](https://travis-ci.org/codecell/jscop)
 
 # Jscop
 
 This is a Linter for checking errors in Javascript code, built with Ruby. 
 
+## Outline
+  - [Installation](#Installation)
+  - [Usage](#Usage)
+  - [Errors currently detectable by jscop](#ERRORS)
+    - 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
+  - [More about usage](#More-About-Usage)
+  - [Testing this repo](#Testing-This-Repo)
+  - [Built With](#Built-With)
+  - [Contributing](#contributing)
+  - [Code of conduct](#Code-of-Conduct)
+  - [Licence](#License)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,76 +40,60 @@ Or install it yourself as:
 - once in desired path in the terminal/console, RUN
 
 ```ruby
-a. jscop # To lint all *.js files in the current Path.
+a. jscop # To lint all *.js files in the current $Path.
 b. jscop ./**/path_to_file.js # To lint JUST a specific file.
 c. jscop foldername # To lint all *.js files in a specific folder.
 ```
 
-## Outline
-  - Title, Description, Installation, Usage Above
-  - Errors currently detectable by jscop
-    - 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
-    - cloning Locally to local machine
-  - Unit Tests
-  - Tools used
-  - Code of conduct
-  - Contributing
-
-## ERRORS that can currently be detected include
+## ERRORS 
+  The following erros are currently detectable by Jscop:
 
 ### VARIABLE NAMING ERRORS
-  - if capital letters or numbers is used to start a variable name, e.g
+  - if capital letters or numbers are 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`
+    - `*Good practice* let owngoal = 4 or const capVar = 9`
     
 ### CLASS NAME ERRORS 
-  - if class names begin With small letters and/or
-  - if class names is Snake-Cased or both e.g
+  - if class names begin with small letters and/or
+  - if class names are snake-cased or both e.g
     - `*Bad practice* class badclass {} or class Bad-class {}`   
-    - `*Good Practice* class GoodClass {} or class Good_Class {}`
+    - `*Good practice* class GoodClass {} or class Good_Class {}`
   - Or if underscores and hyphen are mixed
     `*Bad practice* class Bad_class-Name {}`
     
 ### SPACING ERRORS
-  - if Spaces are found at beginning of lines
+  - 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`
+    - `*Bad practice* let|   | vacuum = 4 or var hollow|    | = 9`
+    - `*Good practice* let vacuum = 4 or const hollow = 9`
 
 ### CLASS COUNT ERROR
-  - if more than one class is defined in a Module,
+  - if more than one class is defined in a module,
 
 ### UNUSED VARIABLE ERROR
   - if a variable (var, let, const) is defined and never used.
-  - A lot of edge cases is covered here.
+  - A lot of edge cases are covered here.
 
-## Arguments Supported By Js-Companion to check Javascript code
+## More About Usage
+  Arguments Supported By jscop 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 This Repo
-- 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/jscop.git)
-- change directory into the folder cd jscop
-- Install project dependencies with the command bundle install
-- You can make the exe/jscop executable with the command chmod a+x exe/jscop if permission is not granted
-
-## 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` or `rake` to run all the unit tests written for this project
+    - `You 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 this Repo
+- 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/jscop.git)`
+- Change directory into the folder `cd jscop`
+- Install project dependencies with the command `bundle install`
+- You can make the `exe/jscop` file executable with the command `chmod a+x exe/jscop` if permission is not granted
+- Ensure you have `rspec` installed, or ensure that `gem rspec` is listed among the gems in the `Gemfile` => then run `bundle install`
+- In the console, run `rspec` or `rake` 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
+- [Rubular](https://rubular.com/) was used to craft and test the regular expressions
+- Rubocop linter
 - Stickler CI
 
 ## Contributing
@@ -111,6 +111,7 @@ Everyone interacting in the Jscop project’s codebases, issue trackers, chat ro
 - Github: [@codecell](https://github.com/codecell)
 - Twitter: [@the_codecell](https://twitter.com/the_codecell) 
 - Linkedin: [ezaka alfred](https://www.linkedin.com/in/alfrednoble/)
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/exe/jscop

@@ -1,9 +1,10 @@
 #!/usr/bin/env ruby
-require 'jscop/version'
-require_relative '../lib/helpers/lint_ware'
 require 'tty-font'
 require 'colorize'
 
+require 'jscop/version'
+require_relative '../lib/helpers/lint_ware'
+
 def show_title
   font = TTY::Font.new
   font_messge = font.write('Jscop', letter_spacing: 1)

data/lib/classes/js_parser.rb

@@ -11,10 +11,12 @@ class JsParser
 
   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)
+      config_folders = line.filename.match?(/(node_modules|config|babel)/)
+      next if config_folders
+
       @lines << line
     }
 

data/lib/jscop/class_count.rb

@@ -16,11 +16,15 @@ module ClassCount
 
   def self.class_count(file)
     pat = /(class)/
+    commented_line = %r{^\W+[\/\/]}
 
     lines_with_class = []
     err_type = 'CLASS_COUNT_ERR'
 
-    file.lines.each { |line| lines_with_class << line.number if pat.match?(line.content) }
+    file.lines.each { |line|
+      needed_lines_with_class = pat.match?(line.content) && !line.content.match?(commented_line)
+      lines_with_class << line.number if needed_lines_with_class
+    }
     raise_err(lines_with_class, err_type, file.filename) if lines_with_class.length > 1
 
     lines_with_class

data/lib/jscop/class_name.rb

@@ -18,7 +18,9 @@ module ClassName
     fes_pat = /[\s]*(class)[\s]*[\d]*[\-]*[a-z]+[\-]*[\w\W]*/
     sec_pat = /[\s]*(class)[\s]*[\p{Alpha}]+[\-]+[\p{Alpha}]+/
 
-    fes_pat.match?(crime) || sec_pat.match?(crime)
+    commented_line = crime.match?(%r{^\W+[\/\/]})
+
+    !commented_line && (fes_pat.match?(crime) || sec_pat.match?(crime))
   end
 
   def self.check_class_name(file)

data/lib/jscop/naming_checker.rb

@@ -16,7 +16,9 @@ module NamingChecker
 
   def self.bad_var_case(bad_case)
     bad_var_start = /(var|let|const|[\s])[\s]*([[:upper:]]{1,}|\d)+(([\w]+[\s][\w]+)|[\w]+)[\s]*[\=][\s]*[\w]*/
-    bad_var_start.match?(bad_case)
+    commented_line = bad_case.match?(%r{^\W+[\/\/]})
+
+    bad_var_start.match?(bad_case) && !commented_line
   end
 
   def self.check_naming(fpath)

data/lib/jscop/spacing_checker.rb

@@ -15,25 +15,81 @@ module SpacingChecker
   end
 
   def self.found_spaces(cont)
-    spaces_before = /[\s]+(const|let|var|function|class|[\}$])[\s]+[\w]*/
-    spaces_after = /(const|let|var|function|class)[\s]{2,}[\w]+[\s]*[\=]/
-    spaced_console = /[\s]+(function|(console.log)[\(][\w]*[\)])[\s]*/
-    closing_line = /[\s]+[\}][\s]*/
+    /(?<lhs>\w+[\W]*)\s{2,}(?<rhs>\w+[\W]*)/ =~ cont
+    vsf = !Regexp.last_match.nil?
 
-    a = spaces_before.match?(cont)
-    b = spaces_after.match?(cont)
-    c = spaced_console.match?(cont)
+    /(?<lhs>\w+\W*)\s{2,}=\s*(?<rhs>\w+\W*)/ =~ cont
+    beq = !Regexp.last_match.nil?
 
-    a || b || c || closing_line.match?(cont)
+    /(?<lhs>\w+\W*)\s*=\s{2,}(?<rhs>\w+\W*)/ =~ cont
+    aeq = !Regexp.last_match.nil?
+
+    spaced_console = /(console.log)[\s+][\(][\w\W]+[\)]/
+    spc = spaced_console.match?(cont)
+    commented_line = cont.match?(%r{^\W+[\/\/]})
+
+    !commented_line && (vsf || beq || aeq || spc)
+  end
+
+  def self.spc_around_fn(cont)
+    around_funcs = /[\)][\s]{2,}[\{]/.match?(cont)
+    around_classes = /[\w+\-*]*[\s]{2,}[\{]/.match?(cont)
+
+    commented_line = cont.match?(%r{^\W+[\/\/]})
+
+    !commented_line && (around_funcs || around_classes)
+  end
+
+  def self.closing_curly_spacing(cont)
+    spaced_closing_curly = /[\s]+[\}][\s]*/
+    c = spaced_closing_curly.match(cont)
+
+    commented_line = cont.match?(%r{^\W+[\/\/]})
+
+    c && !commented_line
+  end
+
+  def self.closed_curly(cont)
+    cont.match?(/}/)
+  end
+
+  def self.open_curly(cont)
+    cont.match?(/{/)
+  end
+
+  def self.line_beginining_spaces(line)
+    /^[\s+][\w\W]*/.match?(line)
   end
 
   def self.check_spaces(file)
+    seen_open = false
+    counter = 0
     lines_with_spaces = []
-    check_line = lambda { |line|
-      lines_with_spaces << line.number if found_spaces(line.content) && !lines_with_spaces.nil?
-    }
+
+    opening_tracker = 0
+    closing_tracker = 0
+
+    arr = file.lines
     err_type = 'SPACING_ERR'
-    file.lines.each(&check_line)
+
+    while counter < arr.length
+      line = arr[counter]
+
+      seen_open = true if open_curly(line.content)
+
+      opening_tracker += 1 if line.content.match?(/{/)
+      closing_tracker += 1 if line.content.match?(/}/) && !line.content.match?(/[\}][\s]*[\)]/)
+
+      lines_with_spaces << line.number if line_beginining_spaces(line.content) unless seen_open
+      opt = (opening_tracker == closing_tracker)
+      seen_open = false if closed_curly(line.content) && opt
+
+      lines_with_spaces << line.number if closing_curly_spacing(line.content) && opt
+      lines_with_spaces << line.number if found_spaces(line.content) && !lines_with_spaces.nil?
+      lines_with_spaces << line.number if spc_around_fn(line.content)
+
+      counter += 1
+    end
 
     lines_with_spaces.each { |line| raise_err(line, err_type, file.filename) if !lines_with_spaces.empty? }
   end

data/lib/jscop/unused_var_checker.rb

@@ -14,29 +14,53 @@ module UnusedVarChecker
     unused_var_err
   end
 
-  def self.extract_from_parentesis(expresn)
-    /([\(][\w\W]+[\)])/ =~ expresn
-    vars_match_data = Regexp.last_match
+  def self.check_escapable(elem)
+    escapables = [
+      '', 'var', 'let', 'const', 'constructor', 'class', 'super', 'function', 'static', 'console',
+      'prototype', 'get', 'set', 'this', 'alert', 'prompt', 'return',
+      '0', '1', '2', '3', '4', '5', '6', '7', '8', '9'
+    ]
+
+    escapables.include?(elem)
+  end
 
-    vars_match_data_str_arr = vars_match_data.to_s.split
+  def self.vars_parentesis(paramz)
+    /(?<lhs>[\(])(?<rhs>[^\{]*[\w\-]+)/ =~ paramz
+    vars = Regexp.last_match(:rhs)
+    vars = vars.to_s.split if vars
+    vars_match_data = vars.to_s.split
 
-    vars_match_data_str_arr.collect { |var|
+    each_var = vars_match_data.collect { |var|
       /([\w\-]+)/ =~ var
-      wanted = Regexp.last_match
+      wanted = Regexp.last_match(0)
       wanted = wanted.to_s
-
-      all_params << wanted.to_s if !wanted.empty?
+      wanted
     }
+    each_var[0] if each_var[0] && !each_var.nil?
+  end
+
+  def self.match_accessd_var(vari)
+    /(?<lhs>[\w+\-*]+)[\[](?<rhs>[\w+\-*]+)/ =~ vari
+    sqad = Regexp.last_match(:rhs)
+
+    /(?<lhs>[\w+\-*]+)\.(?<rhs>[\w+\-*]+)/ =~ vari
+    awda = Regexp.last_match(:rhs)
+
+    sqad || awda
   end
-  # /(?<lhs>\w+)\s*=\s*(?<rhs>\w+)/ =~ "  x = y  " <= From: https://ruby-doc.org/core-2.6.4/Regexp.html
 
-  # rubocop:disable Lint/UselessAssignment
   def self.match_variable(contents)
     /(?<lhs>\w+)\s*=\s*(?<rhs>\w*\W*)/ =~ contents
+    equals_var = Regexp.last_match(:lhs)
+
+    /(?<lhs>(let|var|const))\s{1,}(?<rhs>[\w\-]*)/ =~ contents
+    lazy_init_var = Regexp.last_match(:rhs)
 
-    lhs
+    /(?<lhs>\w+)\s*(?<rhs>[\(\w+\)]*)/ =~ contents
+    func_call_var = Regexp.last_match(:lhs)
+
+    lazy_init_var || func_call_var || equals_var
   end
-  # rubocop:enable Lint/UselessAssignment
 
   def self.create_variables_check_info(count_vs_var, lines_vs_var, filename)
     err_type = 'UNUSED_VAR_ERR'
@@ -59,31 +83,23 @@ module UnusedVarChecker
     lines_variables_hash = {}
 
     line_check = lambda { |line|
-      /([\(][\w\W]+[\)])/ =~ line.content.to_s
-      vars_match_data = Regexp.last_match
-
-      vars_match_data = vars_match_data if !vars_match_data.nil?
-      vars_match_data_str_arr = vars_match_data.to_s.split
+      commented_line = line.content.to_s.match?(%r{^\W+[\/\/]})
 
-      escapables = ['var', 'let', '', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9']
+      from_parentsis = vars_parentesis(line.content.to_s) if !commented_line
+      lines_variables_hash[line.number] = from_parentsis if from_parentsis
+      variable_instances << from_parentsis if !check_escapable(from_parentsis) && !from_parentsis.nil?
 
-      vars_match_data_str_arr.collect { |var|
-        /([\w\-]+)/ =~ var
-        wanted = Regexp.last_match
-        wanted = wanted.to_s
-        lines_variables_hash[line.number] = wanted if wanted
-        variable_instances << wanted if !escapables.include?(wanted)
-      }
+      detected_var = match_variable(line.content.to_s) if !commented_line
+      detected_accessd_var = match_accessd_var(line.content.to_s) if !commented_line
 
-      commented_line = line.content.to_s.match?(%r{^\W+[\/\/]})
+      lines_variables_hash[line.number] = detected_var if detected_var
+      lines_variables_hash[line.number] = detected_accessd_var if detected_accessd_var
 
-      detected_variable = match_variable(line.content.to_s) if !commented_line
-      lines_variables_hash[line.number] = detected_variable if detected_variable
-      variable_instances << detected_variable if detected_variable
+      variable_instances << detected_var if !check_escapable(detected_var) && !detected_var.nil?
+      variable_instances << detected_accessd_var if !check_escapable(detected_accessd_var) && !detected_accessd_var.nil?
     }
 
     file.lines.each(&line_check)
-
     variable_instances.map { |el|
       var_instances_count_hash[el] = var_instances_count_hash[el] ? var_instances_count_hash[el] += 1 : 1
     }

data/lib/jscop/version.rb

@@ -1,3 +1,3 @@
 module Jscop
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jscop
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Ezaka Alfred
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -96,6 +96,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -135,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A linter for checking errors in javascript code