npmdc 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 537a9fb442684ccc9060002f319790fee0e957de
-  data.tar.gz: 4790c3f98f4df7ba95c919741d10cec5efad8f68
+  metadata.gz: edf001bda970b1e162aeb42fb68139881f4c12ac
+  data.tar.gz: 0b05cecf21b35f46c54706f68d610d2bb6e4f4f4
 SHA512:
-  metadata.gz: e600166b3f97c343ed26f5529cb3cb1cba64ec767127c7e37eda61f182718241e0f78fb7b3a24d8a273ec160e5934ad1d49a7011a9a16d077c2e96cb402c1254
-  data.tar.gz: a76611ac04b63bd4077d435703e0aee7dafc72a734d22db8cdaeb1eebcdf52e503aae45a0ad461e7ca4b2bde7f43b859ab3d0a7427007580a663b24dc6701cf4
+  metadata.gz: 0753c101fab5213fdd03d5246a99ab2f71d887d1d31e6335020c94de6971934dec00d1e6aa839f1b3105ea55a0508068c776cf7f63dd546cd74f4d8282783103
+  data.tar.gz: 8d2581dd9b526ec1dc366b552f8189818d690c00f4dd1d6c382d72fe41bbded948cc7cde36d7da2aed0c1a719b0b9654b2897e95aeda62189686f782d1a44df5

data/.travis.yml

@@ -1,11 +1,11 @@
 sudo: false
 language: ruby
 cache: bundler
-matrix:
-  include:
-    - rvm: 2.3.3
-      gemfile: gemfiles/rails42.gemfile
-    - rvm: 2.3.3
-      gemfile: gemfiles/rails5.gemfile
+rvm:
+  - 2.3.3
+
+gemfile:
+  - gemfiles/rails42.gemfile
+  - gemfiles/rails5.gemfile
 
 before_install: gem install bundler -v 1.13.6

data/CHANGELOG.md

@@ -71,3 +71,10 @@ Thanks to @aderyabin !
 * Added new `types` option
 
 * Added specs for 'short' formatter
+
+
+### 0.3.0
+
+* Added new version check functionality
+
+* Added specs for version check

data/README.md

@@ -53,14 +53,16 @@ $ bundle exec npmdc [options]
 
 _Options:_
 
-* --path PATH - Path to frontend code
-
-* --color - Disable color formatting of output
-
-* -f, --format FORMAT - Set format of output
-
-* -t, --types dependencies devDependencies - Dependency types to check
-
+```bash
+      [--path=PATH]            # Path to package.json config
+      [--color], [--no-color]  # Enable color
+                               # Default: true
+  t, [--types=one two three]   # types for check
+                               # Default: ["dependencies", "devDependencies"]
+                               # Possible values: dependencies, devDependencies
+  f, [--format=FORMAT]         # Output format
+                               # Possible values: progress, doc, short
+```
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/npmdc/checker.rb

@@ -1,8 +1,9 @@
 require 'colorize'
 require 'json'
+require 'forwardable'
+require 'semantic_range'
 require 'npmdc/formatter'
 require 'npmdc/errors'
-require 'forwardable'
 
 module Npmdc
   class Checker
@@ -19,7 +20,10 @@ module Npmdc
       @missing_dependencies = Set.new
     end
 
-    delegate [:output, :dep_output, :check_start_output, :check_finish_output] => :formatter
+    delegate [
+      :output, :error_output, :dep_output,
+      :check_start_output, :check_finish_output
+    ] => :formatter
 
     def call
       begin
@@ -29,18 +33,8 @@ module Npmdc
           check_dependencies(package_json_data[dep], dep) if package_json_data[dep]
         end
 
-      rescue NoNodeModulesError => e
-        output("Failed! Can't find `node_modules` folder inside '#{e.message}' directory!")
-        output("\nRun `npm install` to install missing packages.", :warn)
-
-      rescue WrongPathError => e
-        output("There is no '#{e.message}' directory.")
-
-      rescue MissedPackageError => e
-        output("There is no `package.json` file inside '#{e.message}' directory.")
-
-      rescue JsonParseError => e
-        output("Can't parse JSON file #{e.message}")
+      rescue CheckerError => e
+        error_output(e)
       else
         success = true unless !@missing_dependencies.empty?
       ensure
@@ -63,7 +57,7 @@ module Npmdc
     def installed_modules
       @installed_modules ||= begin
         modules_directory = File.join(path, 'node_modules')
-        raise NoNodeModulesError, path unless Dir.exist?(modules_directory)
+        raise(NoNodeModulesError, path: path) unless Dir.exist?(modules_directory)
 
         Dir.glob("#{modules_directory}/*").each_with_object({}) do |file_path, modules|
           next unless File.directory?(file_path)
@@ -73,33 +67,50 @@ module Npmdc
     end
 
     def package_json(directory, filename = 'package.json')
-      raise WrongPathError, directory unless Dir.exist?(directory)
-      file_path = File.join(directory, filename)
-      raise MissedPackageError, directory unless File.file?(file_path)
+      raise(WrongPathError, directory: directory) unless Dir.exist?(directory)
+
+      path = File.join(directory, filename)
+      raise(MissedPackageError, directory: directory) unless File.file?(path)
 
       begin
-        JSON.parse(File.read(file_path))
+        JSON.parse(File.read(path))
       rescue JSON::ParserError
-        raise JsonParseError, file_path
+        raise(JsonParseError, path: path)
       end
     end
 
     def check_dependencies(deps, type)
       check_start_output(type)
+
       deps.each_key do |dep|
         @dependencies_count += 1
         check_dependency(dep, deps[dep])
       end
+
       check_finish_output
     end
 
     def check_dependency(dep, version)
-      if installed_modules[dep]
-        dep_output(dep, :success)
+      installed_module = installed_modules[dep]
+
+      if installed_module
+        check_version(installed_module, dep, version)
       else
         @missing_dependencies << "#{dep}@#{version}"
         dep_output(dep, :failure)
       end
     end
+
+    def check_version(installed_module, dep, version)
+      if !installed_module.key?('version') || !SemanticRange.valid(installed_module['version'])
+        @missing_dependencies << "#{dep}@#{version}"
+        dep_output(dep, :failure)
+      elsif SemanticRange.satisfies(installed_module['version'], version)
+        dep_output(dep, :success)
+      else
+        @missing_dependencies << "#{dep}@#{version}"
+        dep_output("#{dep} expected version '#{version}' but got '#{installed_module['version']}'", :failure)
+      end
+    end
   end
 end

data/lib/npmdc/cli.rb

@@ -9,12 +9,13 @@ module Npmdc
     method_option :path, desc: 'Path to package.json config'
     method_option :color, desc: 'Enable color', type: :boolean, default: true
     method_option :types, aliases: [:t],
-                          desc: 'types for check',
+                          desc: 'Dependency types to check',
                           type: :array,
+                          enum: Npmdc::Config::DEPEPENDENCY_TYPES,
                           default: Npmdc::Config::DEPEPENDENCY_TYPES
     method_option :format, aliases: [:f],
-                           desc: "Output format,
-                           possible values: #{Npmdc::Formatter::FORMATTERS.keys.join(", ")}"
+                           desc: 'Output format',
+                           enum: Npmdc::Formatter::FORMATTERS.keys.map(&:to_s)
 
     def check
       Npmdc.call(options)

data/lib/npmdc/errors.rb

@@ -1,9 +1,60 @@
 module Npmdc
   module Errors
-    class NoNodeModulesError < StandardError; end
-    class MissedPackageError < StandardError; end
-    class JsonParseError < StandardError; end
-    class MissedDepsError < StandardError; end
-    class WrongPathError < StandardError; end
+    class Error < StandardError
+      attr_reader :options
+
+      def initialize(msg = nil, **options)
+        @options = options
+
+        super(msg)
+      end
+
+      def banner
+        raise(NotImplementedError, '#banner has to be implemented in subclass')
+      end
+    end
+
+    class CheckerError < Error; end
+    class ConfigurationError < Error; end
+
+    class NoNodeModulesError < CheckerError
+      def banner
+        path = options.fetch(:path)
+        [
+          "Can't find `node_modules` folder inside '#{path}' directory!",
+          ["\nRun `npm install` to install missing packages.", :warn]
+        ]
+      end
+    end
+
+    class WrongPathError < CheckerError
+      def banner
+        directory = options.fetch(:directory)
+        "There is no '#{directory}' directory."
+      end
+    end
+
+    class MissedPackageError < CheckerError
+      def banner
+        directory = options.fetch(:directory)
+        "There is no `package.json` file inside '#{directory}' directory."
+      end
+    end
+
+    class JsonParseError < CheckerError
+      def banner
+        path = options.fetch(:path)
+        "Can't parse JSON file #{path}"
+      end
+    end
+
+
+    class UnknownFormatter < ConfigurationError
+      def banner
+        formatter = options.fetch(:formatter)
+
+        "Unknown '#{formatter}' formatter"
+      end
+    end
   end
 end

data/lib/npmdc/formatter.rb

@@ -4,7 +4,6 @@ require 'npmdc/formatters/short'
 
 module Npmdc
   module Formatter
-
     FORMATTERS = {
       progress: Npmdc::Formatters::Progress,
       doc:      Npmdc::Formatters::Documentation,
@@ -14,7 +13,13 @@ module Npmdc
     class << self
       def call(options)
         fmt = options.fetch('format', Npmdc.config.format)
-        FORMATTERS[fmt.to_sym].new(options)
+        klass(fmt).new(options)
+      end
+
+      private
+
+      def klass(fmt)
+        FORMATTERS[fmt.to_sym] || raise(Npmdc::Errors::UnknownFormatter, formatter: fmt)
       end
     end
   end

data/lib/npmdc/formatters/base.rb

@@ -33,6 +33,20 @@ module Npmdc
         @output.puts "Checking #{type}:"
       end
 
+      def error_output(error)
+        banner = error.banner
+        case banner
+        when Array
+          error.banner.each do |message|
+            output(*message)
+          end
+        else
+          output(banner)
+        end
+      end
+
+      private
+
       def color_message(message, status = nil)
         if @disable_colorization || !status
           message
@@ -46,4 +60,4 @@ module Npmdc
       end
     end
   end
-end
+end

data/lib/npmdc/version.rb

@@ -1,3 +1,3 @@
 module Npmdc
-  VERSION = '0.2.5'
+  VERSION = '0.3.0'
 end

data/lib/npmdc.rb

@@ -6,6 +6,11 @@ module Npmdc
   class << self
     def call(options = {})
       Npmdc::Checker.new(options).call
+
+    rescue Npmdc::Errors::ConfigurationError => e
+      Npmdc.config.output.puts e.banner
+
+      false
     end
 
     def config

data/npmdc.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.2.2'
   spec.add_dependency 'thor', '> 0.18'
   spec.add_dependency 'colorize', '~> 0.8.1'
+  spec.add_dependency 'semantic_range', '~> 1.0'
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: npmdc
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Emil Kashkevich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-06 00:00:00.000000000 Z
+date: 2016-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: semantic_range
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement