npmdc 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7aaba2b72154a5a78139ad6d6dfa6bced85ddb0f
-  data.tar.gz: c97559ba4610458e6baf1044b09d8d8adf1c2f9e
+  metadata.gz: d7eada3811dc31b5a240495eba981289843e70a7
+  data.tar.gz: e4c1bf4e93e6d0b56682a4403c1aee1b7c7fa412
 SHA512:
-  metadata.gz: b7123a4a4e1c652c3a9a9bf97f304d8a83a3602bc153083bcd6a6af5f691b0f67fad9a4c85fae2bc77e76cc0ef74d214b185a8c761f2d86cbcc62228d0f9ff97
-  data.tar.gz: c915ab3b3bacd40907cc7a298747d907e12619a225e6ee3f54dfb2f4b6355291c4e9900a499a9c9e53851aee3eb735e59914ccc2518722ca185b7a920a58876e
+  metadata.gz: 7ec1aad5bcae24fbd540061ac20caa085e3e69c04e045bac1352d53b1d3e2921135187ab747f47f395c15dd19c883c1c08d3a3c730d8888f8a1e1fc43b7965f3
+  data.tar.gz: 277912a03de5824c67f3a857408aaa9c55d7943e210ee0a8d210216115e3c549f76f12df517bfa4a3266747a2b6fbe4cc1896dbaf5f7641f83b97326cba06062

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   DisabledByDefault: true
+  TargetRubyVersion: 2.3
 
 #################### Lint ################################
 

data/.travis.yml

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

data/CHANGELOG.md

@@ -43,4 +43,15 @@ Thanks to @aderyabin !
 
 ### 0.2.2
 
+Thanks to @palkan !
+
 * Fixed runtime dependencies
+
+
+### 0.2.3
+
+* Improved Rails integration
+
+* Add Rails integration specs
+
+* Minor improvemnts

data/gemfiles/rails42.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.2.0'
+
+gemspec path: '..'

data/gemfiles/rails5.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.0.0'
+
+gemspec path: '..'

data/lib/npmdc/checker.rb

@@ -1,6 +1,5 @@
 require 'colorize'
 require 'json'
-require 'npmdc/helpers'
 require 'npmdc/formatter'
 require 'npmdc/errors'
 require 'forwardable'
@@ -10,15 +9,15 @@ module Npmdc
     extend Forwardable
     include Npmdc::Errors
 
-    attr_accessor :path, :formatter
+    attr_reader :path, :formatter
 
     DEPENDENCIES = %w(dependencies devDependencies).freeze
 
     def initialize(options)
-      @path = options['path'] || Dir.pwd
+      @path = options[:path] || Dir.pwd
       @formatter = Npmdc::Formatter.(options)
       @dependencies_count = 0
-      @missed_dependencies = []
+      @missing_dependencies = Set.new
     end
 
     delegate [:output, :dep_output, :check_start_output, :check_finish_output] => :formatter
@@ -26,13 +25,10 @@ module Npmdc
     def call
       begin
         success = false
-        package_json_data = package_json(@path)
+        package_json_data = package_json(path)
+
         DEPENDENCIES.each do |dep|
-          if package_json_data[dep]
-            begin
-              check_dependencies(package_json_data[dep], dep)
-            end
-          end
+          check_dependencies(package_json_data[dep], dep) if package_json_data[dep]
         end
 
       rescue NoNodeModulesError => e
@@ -48,33 +44,32 @@ module Npmdc
       rescue JsonParseError => e
         output("Can't parse JSON file #{e.message}")
       else
-        success = true unless !@missed_dependencies.empty?
+        success = true unless !@missing_dependencies.empty?
       ensure
-        if !@missed_dependencies.empty?
+        if !@missing_dependencies.empty?
           output("Following dependencies required by your package.json file are missing or not installed properly:")
-          @missed_dependencies.uniq.each do |dep|
+          @missing_dependencies.each do |dep|
             output("  * #{dep}")
           end
-          output("\nRun `npm install` to install #{@missed_dependencies.uniq.count} missed packages.", :warn)
+          output("\nRun `npm install` to install #{@missing_dependencies.size} missing packages.", :warn)
         elsif success
-          output("#{pluralize(@dependencies_count, 'package')} checked. Everything is ok.", :success)
+          output("Checked #{@dependencies_count} packages. Everything is ok.", :success)
         end
-
-        return success
       end
+
+      success
     end
 
     private
 
     def installed_modules
       @installed_modules ||= begin
-        modules_directory = File.join(@path, 'node_modules')
-        raise NoNodeModulesError, @path unless Dir.exist?(modules_directory)
+        modules_directory = File.join(path, 'node_modules')
+        raise NoNodeModulesError, path unless Dir.exist?(modules_directory)
 
-        Dir.entries(modules_directory).each_with_object({}) do |entry, modules|
-          if entry != '.' && entry != '..' and File.directory? File.join(modules_directory, entry)
-            modules[entry] = package_json(File.join(modules_directory, entry))
-          end
+        Dir.glob("#{modules_directory}/*").each_with_object({}) do |file_path, modules|
+          next unless File.directory?(file_path)
+          modules[File.basename(file_path)] = package_json(file_path)
         end
       end
     end
@@ -91,20 +86,22 @@ module Npmdc
       end
     end
 
-    def check_dependencies(deps = {}, type)
-      installed_modules
+    def check_dependencies(deps, type)
       check_start_output(type)
-      deps.keys.each do |dep|
+      deps.each_key do |dep|
         @dependencies_count += 1
-        status = valid_dependency?(dep) ? :success : :failure
-        @missed_dependencies.push("#{dep}@#{deps[dep]}") unless valid_dependency?(dep)
-        dep_output(dep, status)
+        check_dependency(dep, deps[dep])
       end
       check_finish_output
     end
 
-    def valid_dependency?(dep)
-      !!installed_modules[dep]
+    def check_dependency(dep, version)
+      if installed_modules[dep]
+        dep_output(dep, :success)
+      else
+        @missing_dependencies << "#{dep}@#{version}"
+        dep_output(dep, :failure)
+      end
     end
   end
 end

data/lib/npmdc/cli.rb

@@ -7,11 +7,11 @@ module Npmdc
 
     desc 'check', 'Run check'
     method_option :path, desc: 'Path to package.json config'
-    method_option :'no-color', desc: 'Disable color', type: :boolean
+    method_option :color, desc: 'Enable color', type: :boolean, default: true
     method_option :format, desc: "Output format, possible values: #{Npmdc::Formatter::FORMATTERS.keys.join(", ")}"
 
     def check
-      Npmdc::Checker.new(options).call
+      Npmdc.call(options)
     end
 
     map %w[--version -v] => :__print_version

data/lib/npmdc/engine.rb

@@ -0,0 +1,13 @@
+require 'npmdc'
+
+module Npmdc
+  class Engine < Rails::Engine # :nodoc:
+    config.npmdc = ActiveSupport::OrderedOptions.new
+
+    initializer "npmdc.load_hook" do |app|
+      options = app.config.npmdc
+      options.path ||= Rails.root
+      Npmdc.call(options)
+    end
+  end
+end

data/lib/npmdc/errors.rb

@@ -6,4 +6,4 @@ module Npmdc
     class MissedDepsError < StandardError; end
     class WrongPathError < StandardError; end
   end
-end
+end

data/lib/npmdc/formatter.rb

@@ -1,21 +1,23 @@
-Dir["#{File.dirname(__FILE__)}/formatters/*.rb"].each { |file| require file }
+require 'npmdc/formatters/progress'
+require 'npmdc/formatters/documentation'
+require 'npmdc/formatters/short'
 
 module Npmdc
   module Formatter
 
     FORMATTERS = {
-      progress: Npmdc::Formatters::ProgressFormatter,
-      doc:      Npmdc::Formatters::DocumentationFormatter,
-      short:    Npmdc::Formatters::ShortFormatter,
+      progress: Npmdc::Formatters::Progress,
+      doc:      Npmdc::Formatters::Documentation,
+      short:    Npmdc::Formatters::Short
     }.freeze
 
     DEFAULT_FORMAT = :short
 
     class << self
       def call(options)
-        fmt = options['format'] || options[:format] || DEFAULT_FORMAT
+        fmt = options.fetch(:format, DEFAULT_FORMAT)
         FORMATTERS[fmt.to_sym].new(options)
       end
     end
   end
-end
+end

data/lib/npmdc/formatters/{base_formatter.rb → base.rb}

@@ -2,7 +2,7 @@ require 'colorized_string'
 
 module Npmdc
   module Formatters
-    class BaseFormatter
+    class Base
 
       COLORS = {
         success: :green,
@@ -11,16 +11,20 @@ module Npmdc
         info: :white
       }.freeze
 
-      def initialize(options, output = $stdout)
+      def initialize(options, output = Npmdc.output)
         @options = options
         @output = output
-        @disable_colorization = !!(@options['no-color'] || @options['no_color'])
+        @disable_colorization = !@options.fetch(:color, true)
       end
 
       def output(message, status = nil)
         @output.puts color_message(message, status)
       end
 
+      def dep_output(dep, status)
+        # no-op
+      end
+
       def check_finish_output
         @output.puts "\n"
       end

data/lib/npmdc/formatters/{documentation_formatter.rb → documentation.rb}

@@ -1,7 +1,9 @@
+require_relative './base'
+
 module Npmdc
   module Formatters
-    class DocumentationFormatter < BaseFormatter
-      def dep_output(dep, status, options = {})
+    class Documentation < Base
+      def dep_output(dep, status)
         case status
         when :success
           @output.puts color_message("  ✓ #{dep}", status)

data/lib/npmdc/formatters/{progress_formatter.rb → progress.rb}

@@ -1,7 +1,9 @@
+require_relative './base'
+
 module Npmdc
   module Formatters
-    class ProgressFormatter < BaseFormatter
-      def dep_output(dep, status, options = {})
+    class Progress < Base
+      def dep_output(_dep, status)
         case status
         when :success
           @output.print color_message(".", status)

data/lib/npmdc/formatters/{short_formatter.rb → short.rb}

@@ -1,9 +1,8 @@
+require_relative './base'
+
 module Npmdc
   module Formatters
-    class ShortFormatter < BaseFormatter
-      def dep_output(dep, status, options = {})
-      end
-
+    class Short < Base
       def check_start_output(type)
       end
 

data/lib/npmdc/version.rb

@@ -1,3 +1,3 @@
 module Npmdc
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/lib/npmdc.rb

@@ -1,9 +1,17 @@
 require "npmdc/checker"
-require "npmdc/railtie" if defined?(Rails)
+require "npmdc/engine" if defined?(Rails)
 require "npmdc/version"
 
 module Npmdc
-  def self.call(options = {})
-    Npmdc::Checker.new(options).call
+  class << self
+    attr_writer :output
+
+    def call(options = {})
+      Npmdc::Checker.new(options).call
+    end
+
+    def output
+      @output ||= STDOUT
+    end
   end
 end

data/npmdc.gemspec

@@ -19,9 +19,11 @@ Gem::Specification.new do |spec|
   spec.executables   = ['npmdc']
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.2.2'
-  spec.add_dependency 'thor', '~> 0.19.4'
+  spec.add_dependency 'thor', '> 0.18'
   spec.add_dependency 'colorize', '~> 0.8.1'
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rails', '>= 4.2'
+  spec.add_development_dependency 'pry-byebug'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: npmdc
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Emil Kashkevich
@@ -14,16 +14,16 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 0.19.4
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 0.19.4
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: Check for missed dependencies of NPM packages based on dependency list
   specified in package.json file.
 email:
@@ -103,18 +131,20 @@ files:
 - bin/console
 - bin/npmdc
 - bin/setup
+- gemfiles/rails42.gemfile
+- gemfiles/rails5.gemfile
 - lib/npmdc.rb
 - lib/npmdc/checker.rb
 - lib/npmdc/cli.rb
+- lib/npmdc/engine.rb
 - lib/npmdc/errors.rb
 - lib/npmdc/formatter.rb
-- lib/npmdc/formatters/base_formatter.rb
-- lib/npmdc/formatters/documentation_formatter.rb
-- lib/npmdc/formatters/progress_formatter.rb
-- lib/npmdc/formatters/short_formatter.rb
-- lib/npmdc/helpers.rb
-- lib/npmdc/railtie.rb
+- lib/npmdc/formatters/base.rb
+- lib/npmdc/formatters/documentation.rb
+- lib/npmdc/formatters/progress.rb
+- lib/npmdc/formatters/short.rb
 - lib/npmdc/version.rb
+- log/test.log
 - npmdc.gemspec
 homepage: https://github.com/lysyi3m/npmdc
 licenses:

data/lib/npmdc/helpers.rb

@@ -1,9 +0,0 @@
-def pluralize(n, singular, plural = nil)
-  if n == 1
-    "1 #{singular}"
-  elsif plural
-    "#{n} #{plural}"
-  else
-    "#{n} #{singular}s"
-  end
-end

data/lib/npmdc/railtie.rb

@@ -1,16 +0,0 @@
-require 'rails'
-
-module Npmdc
-  class Railtie < Rails::Railtie
-    config.npmdc = ActiveSupport::OrderedOptions.new
-
-    initializer 'npmdc' do |app|
-      options = {
-        path: app.config.npmdc[:path] || Rails.root,
-        verbose: app.config.npmdc[:verbose]
-      }
-
-      Npmdc.call(options)
-    end
-  end
-end