npmdc 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b34b01d253e7286a465aa34598043b994e5997d5
-  data.tar.gz: af1030f04a8d51f41d817bd98f309ff6d8bbabfd
+  metadata.gz: 26d60357a6871f0590d114c6d082b501425a42b4
+  data.tar.gz: 359918fc37af558a46a250e29ac019caeb7fa543
 SHA512:
-  metadata.gz: ba1a5cf48693d99d3c337ac45c4610515705360f7a76bffd9b1af49fdd288ea1a515fb584609272c52cdfe0c0e2174d0488b775f895819699fcd7cd9aa23c4bb
-  data.tar.gz: 614e2160612c5711b11d4c1bf76d4b82fa0460df2fb81b4c5e90d3c22183898bf60c0fb880688922225dddf888457bee85745a0e7cd328b26b3c02d14130ad7f
+  metadata.gz: bcd8679aef9341352d09f4799deb2aa0aeb471409168eb74a3280bbf6f17ab35baea9b4dc0f42b030a1612d3a72602b3a5b2cb69bdcbded267ee04c9ae288e8f
+  data.tar.gz: afd9ef02c3fe2f49d2499d00703ddcfcb521dd87c9923512f9443ded6b5af4e766c29b40558c13ebc23210311a82332ec8e733d7d322638453142c8a7f726fa7

data/CHANGELOG.md

@@ -21,3 +21,15 @@ Initial implementation of Npmdc gem with following features:
 * Better JSON parser errors - now with more details
 
 * Fixed deprecated methods
+
+### 0.2.0
+
+Thanks to @aderyabin !
+
+* Output formatters
+
+* Colorized output
+
+* Added specs
+
+* Refactored and optimized

data/README.md

@@ -37,6 +37,8 @@ YourApp::Application.configure do
   config.npmdc = {
     :path => "/path/to/your/frontend/code/dir" # `Rails.root` by default,
     :verbose => true                           # `false` by default
+    :'no-color' => true                        # `false` by default
+    :format => "doc"                           # `short`, `doc`, `progress`. `short` by default
   }
 end
 ```
@@ -44,10 +46,21 @@ end
 ### CLI tool:
 
 ```bash
-$ bundle exec npmdc --path="/path/to/your/frontend/code/dir" --verbose
+$ bundle exec npmdc [options]
 
 ```
 
+_Options:_
+
+* --path PATH - Path to frontend code
+
+* -V, --verbose - Set the verbose level of output
+
+* --no-color - Disable color formatting of output
+
+* --format FORMAT - Set format of output
+
+
 ## 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,109 +1,110 @@
+require 'colorize'
 require 'json'
 require 'active_support/inflector'
+require 'npmdc/formatter'
+require 'npmdc/errors'
+require 'forwardable'
 
 module Npmdc
   class Checker
+    extend Forwardable
+    include Npmdc::Errors
+
+    attr_accessor :path, :formatter
+
+    DEPENDENCIES = %w(dependencies devDependencies).freeze
+
     def initialize(options)
-      @options = {
-        path: options[:path] || Dir.pwd,
-        verbose: options[:verbose]
-      }
+      @path = options['path'] || Dir.pwd
+      @formatter = Npmdc::Formatter.(options)
+      @dependencies_count = 0
+      @missed_dependencies = []
     end
 
+    delegate [:output, :dep_output, :check_start_output, :check_finish_output] => :formatter
+
     def call
-      package_json = get_package_json(@options[:path])
+      begin
+        success = false
+        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
+        end
 
-      if package_json
-        package_json_data = parse_package_json(package_json)
-        @installed_modules = get_installed_modules
-      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)
 
-      if package_json_data && package_json_data.key?('dependencies')
-        dependencies = package_json_data['dependencies']
-        check_dependencies(dependencies)
-      end
+      rescue WrongPathError => e
+        output("There is no '#{e.message}' directory.")
 
-      if package_json_data && package_json_data.key?('devDependencies')
-        dev_dependencies = package_json_data['devDependencies']
-        check_dependencies(dev_dependencies, 'devDependencies')
-      end
-    end
+      rescue MissedPackageError => e
+        output("There is no `package.json` file inside '#{e.message}' directory.")
 
-    private
+      rescue JsonParseError => e
+        output("Can't parse JSON file #{e.message}")
+      else
+        success = true unless !@missed_dependencies.empty?
+      ensure
+        if !@missed_dependencies.empty?
+          output("Following dependencies required by your package.json file are missing or not installed properly:")
+          @missed_dependencies.uniq.each do |dep|
+            output("  * #{dep}")
+          end
+          output("\nRun `npm install` to install #{@missed_dependencies.uniq.count} missed packages.", :warn)
+        elsif success
+          output("#{@dependencies_count} #{"package".pluralize(@dependencies_count)} checked. Everything is ok.", :success)
+        end
 
-    def pluralize
-      ActiveSupport::Inflector.pluralize(self)
+        return success
+      end
     end
 
-    def get_installed_modules
-      modules_directory = File.join(@options[:path], 'node_modules')
+    private
 
-      if Dir.exist?(modules_directory)
-        modules = {}
+    def installed_modules
+      @installed_modules ||= begin
+        modules_directory = File.join(@path, 'node_modules')
+        raise NoNodeModulesError, @path unless Dir.exist?(modules_directory)
 
-        Dir.entries(modules_directory).each do |entry|
+        Dir.entries(modules_directory).each_with_object({}) do |entry, modules|
           if entry != '.' && entry != '..' and File.directory? File.join(modules_directory, entry)
-            modules[entry] = File.join(modules_directory, entry)
+            modules[entry] = package_json(File.join(modules_directory, entry))
           end
         end
-
-        modules
-      else
-        message = [
-          "Failed! Can't find `node_modules` folder inside '#{@options[:path]}' directory!",
-          'Try running `npm install` first.'
-        ].join("\n")
-
-        puts message
-        exit
       end
     end
 
-    def get_package_json(directory)
-      file_path = File.join(directory, 'package.json')
-
-      if File.file?(file_path)
-        File.read(file_path)
-      else
-        puts "There is no `package.json` file inside '#{directory}' directory." if @options[:verbose]
-      end
-    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)
 
-    def parse_package_json(json)
       begin
-        JSON.parse(json)
-      rescue JSON::ParserError => error
-        raise error
+        JSON.parse(File.read(file_path))
+      rescue JSON::ParserError
+        raise JsonParseError, file_path
       end
     end
 
-    def check_dependencies(deps = {}, type = 'dependencies')
-      puts "Check #{type}..." if @options[:verbose]
-
-      missed_dependencies = []
-
+    def check_dependencies(deps = {}, type)
+      installed_modules
+      check_start_output(type)
       deps.keys.each do |dep|
-        if @installed_modules.key?(dep)
-          package_json = get_package_json(@installed_modules[dep])
-          package_json_data = parse_package_json(package_json)
-          missed_dependencies.push(dep) unless package_json_data && package_json_data['name'] == dep
-        else
-          missed_dependencies.push(dep)
-        end
+        @dependencies_count += 1
+        status = valid_dependency?(dep) ? :success : :failure
+        @missed_dependencies.push("#{dep}@#{deps[dep]}") unless valid_dependency?(dep)
+        dep_output(dep, status)
       end
+      check_finish_output
+    end
 
-      if missed_dependencies.any?
-        message = [
-          "Failed! Following #{type} required by your package.json file are missing or not installed properly:\n",
-          missed_dependencies.map { |dep| "* #{dep}@#{deps[dep]}" },
-          "\nRun `npm install` to install #{missed_dependencies.length} missing #{'package'.pluralize(missed_dependencies.length)}.",
-        ].join("\n")
-
-        puts message
-        exit
-      else
-        puts "OK! #{deps.length} #{'dependency'.pluralize(deps.length)} checked." if @options[:verbose]
-      end
+    def valid_dependency?(dep)
+      !!installed_modules[dep]
     end
   end
 end

data/lib/npmdc/cli.rb

@@ -3,11 +3,13 @@ require 'npmdc'
 
 module Npmdc
   class Cli < Thor
-    class_option 'verbose', type: :boolean, desc: 'Enable verbose output mode', aliases: '-V'
     default_task :check
 
     desc 'check', 'Run check'
-    option :path
+    method_option :path, desc: 'Path to package.json config'
+    method_option :'no-color', desc: 'Disable color', type: :boolean
+    method_option :format, desc: "Output format, possible values: #{Npmdc::Formatter::FORMATTERS.keys.join(", ")}"
+
     def check
       Npmdc::Checker.new(options).call
     end

data/lib/npmdc/errors.rb

@@ -0,0 +1,9 @@
+module Npmdc
+  module Errors
+    class NoNodeModulesError < StandardError; end
+    class MissedPackageError < StandardError; end
+    class JsonParseError < StandardError; end
+    class MissedDepsError < StandardError; end
+    class WrongPathError < StandardError; end
+  end
+end

data/lib/npmdc/formatter.rb

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

data/lib/npmdc/formatters/base_formatter.rb

@@ -0,0 +1,45 @@
+require 'colorized_string'
+
+module Npmdc
+  module Formatters
+    class BaseFormatter
+
+      COLORS = {
+        success: :green,
+        failure: :red,
+        warn: :yellow,
+        info: :white
+      }.freeze
+
+      def initialize(options, output = $stdout)
+        @options = options
+        @output = output
+        @disable_colorization = !!(@options['no-color'] || @options['no_color'])
+      end
+
+      def output(message, status = nil)
+        @output.puts color_message(message, status)
+      end
+
+      def check_finish_output
+        @output.puts "\n"
+      end
+
+      def check_start_output(type)
+        @output.puts "Checking #{type}:"
+      end
+
+      def color_message(message, status = nil)
+        if @disable_colorization || !status
+          message
+        else
+          ColorizedString[message].colorize(color(status))
+        end
+      end
+
+      def color(status)
+        COLORS[status]
+      end
+    end
+  end
+end

data/lib/npmdc/formatters/documentation_formatter.rb

@@ -0,0 +1,14 @@
+module Npmdc
+  module Formatters
+    class DocumentationFormatter < BaseFormatter
+      def dep_output(dep, status, options = {})
+        case status
+        when :success
+          @output.puts color_message("  ✓ #{dep}", status)
+        when :failure
+          @output.puts color_message("  ✗ #{dep}", status)
+        end
+      end
+    end
+  end
+end

data/lib/npmdc/formatters/progress_formatter.rb

@@ -0,0 +1,18 @@
+module Npmdc
+  module Formatters
+    class ProgressFormatter < BaseFormatter
+      def dep_output(dep, status, options = {})
+        case status
+        when :success
+          @output.print color_message(".", status)
+        when :failure
+          @output.print color_message("F", status)
+        end
+      end
+
+      def check_finish_output
+        2.times { @output.puts "\n" }
+      end
+    end
+  end
+end

data/lib/npmdc/formatters/short_formatter.rb

@@ -0,0 +1,14 @@
+module Npmdc
+  module Formatters
+    class ShortFormatter < BaseFormatter
+      def dep_output(dep, status, options = {})
+      end
+
+      def check_start_output(type)
+      end
+
+      def check_finish_output
+      end
+    end
+  end
+end

data/lib/npmdc/version.rb

@@ -1,3 +1,3 @@
 module Npmdc
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/npmdc.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   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 'colorize', '~> 0.8.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: npmdc
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Emil Kashkevich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-30 00:00:00.000000000 Z
+date: 2016-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -86,6 +86,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 description: Check for missed dependencies of NPM packages based on dependency list
   specified in package.json file.
 email:
@@ -112,6 +126,12 @@ files:
 - lib/npmdc.rb
 - lib/npmdc/checker.rb
 - lib/npmdc/cli.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/railtie.rb
 - lib/npmdc/version.rb
 - npmdc.gemspec