npmdc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93c4b8f8f516f0beafab7cfe44d89bd754e400b9
+  data.tar.gz: c82d5836c95c17a11dfc8a0436abbb95e6ad06c2
+SHA512:
+  metadata.gz: 7fdd0443a28f7d128a61743df0c0cfa402548d05e5d2c2c529c5beff8a59403011e03d5ad7d0363f7ee61673c91c5644c55cae4fad596e4a6696f76bdcaf1322
+  data.tar.gz: 7bca6de70b1cf50b275702f5c3b4a7e52b32dca0942fff371f5ddebbe96ba46daae4737f7f077f7712e386b06736905a02c698c60a6ab5e4157c94106d3de8f4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+### 0.1.0 First release
+
+Initial implementation of Npmdc gem with following features:
+
+* Checking for missed (or incorrectly installed) NPM dependencies inside specific folder
+
+* Works with Ruby On Rails
+
+* Standalone CLI tool

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Emil Kashkevich
+
+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,52 @@
+# npmdc
+
+*NPM Dependency Checker* is a simple tool which can check for missed dependencies based on your `package.json` file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'npmdc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install npmdc
+
+## Usage
+
+### Rails
+
+```ruby
+YourApp::Application.configure do
+  config.npmdc = {
+    :path => "/path/to/your/frontend/code/dir" # `Rails.root` by default,
+    :verbose => true                           # `false` by default
+  }
+end
+```
+
+### CLI tool:
+
+```bash
+$ bundle exec npmdc --path="/path/to/your/frontend/code/dir" --verbose
+
+```
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lysyi3m/npmdc.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/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,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "npmdc"
+
+require "irb"
+IRB.start

data/bin/npmdc

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "npmdc/cli"
+
+Npmdc::Cli.start(ARGV)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/npmdc.rb

@@ -0,0 +1,9 @@
+require "npmdc/checker"
+require "npmdc/railtie" if defined?(Rails)
+require "npmdc/version"
+
+module Npmdc
+  def self.call(options = {})
+    Npmdc::Checker.new(options).call
+  end
+end

data/lib/npmdc/checker.rb

@@ -0,0 +1,105 @@
+require "json"
+require "npmdc/helpers"
+
+module Npmdc
+  class Checker
+    def initialize(options)
+      @options = {
+        :path => options[:path] || Dir.pwd,
+        :verbose => options[:verbose]
+      }
+    end
+
+    def call
+      package_json = get_package_json(@options[:path])
+
+      if package_json
+        package_json_data = parse_package_json(package_json)
+        @installed_modules = get_installed_modules
+      end
+
+      if package_json_data&.key?("dependencies")
+        dependencies = package_json_data["dependencies"]
+        check_dependencies(dependencies)
+      end
+
+      if package_json_data&.key?("devDependencies")
+        dev_dependencies = package_json_data["devDependencies"]
+        check_dependencies(dev_dependencies, "devDependencies")
+      end
+    end
+
+    private
+
+    def get_installed_modules
+      modules_directory = File.join(@options[:path], "node_modules")
+
+      if Dir.exists?(modules_directory)
+        modules = {}
+
+        Dir.entries(modules_directory).each do |entry|
+          if entry != '.' && entry != '..' and File.directory? File.join(modules_directory, entry)
+            modules[entry] = 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 parse_package_json(json)
+      begin
+        JSON.parse(json)
+      rescue JSON::ParserError => e
+        raise "Failed to parse package.json file."
+      end
+    end
+
+    def check_dependencies(deps = {}, type = "dependencies")
+      puts "Check #{type}..." if @options[:verbose]
+
+      missed_dependencies = []
+
+      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["name"] == dep
+        else
+          missed_dependencies.push(dep)
+        end
+      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 missing packages.",
+        ].join("\n")
+
+        puts message
+        exit
+      else
+        puts "OK! #{pluralize(deps.length, 'dependency', 'dependencies')} checked." if @options[:verbose]
+      end
+    end
+  end
+end

data/lib/npmdc/cli.rb

@@ -0,0 +1,21 @@
+require "thor"
+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
+    def check
+      Npmdc::Checker.new(options).call
+    end
+
+    map %w[--version -v] => :__print_version
+    desc "--version, -v", "Print gem version"
+    def __print_version
+      puts Npmdc::VERSION
+    end
+  end
+end

data/lib/npmdc/helpers.rb

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,16 @@
+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

data/lib/npmdc/version.rb

@@ -0,0 +1,3 @@
+module Npmdc
+  VERSION = "0.1.0"
+end

data/npmdc.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'npmdc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "npmdc"
+  spec.version       = Npmdc::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Emil Kashkevich"]
+  spec.email         = ["emil.kashkevich@gmail.com"]
+  spec.summary       = "Check for missed dependencies of NPM packages."
+  spec.description   = "Check for missed dependencies of NPM packages based on dependency list specified in package.json file."
+  spec.homepage      = "https://github.com/lysyi3m/npmdc"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["npmdc"]
+  spec.require_paths = ["lib"]
+  spec.add_dependency "thor"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: npmdc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emil Kashkevich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Check for missed dependencies of NPM packages based on dependency list
+  specified in package.json file.
+email:
+- emil.kashkevich@gmail.com
+executables:
+- npmdc
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/npmdc
+- bin/setup
+- lib/npmdc.rb
+- lib/npmdc/checker.rb
+- lib/npmdc/cli.rb
+- lib/npmdc/helpers.rb
+- lib/npmdc/railtie.rb
+- lib/npmdc/version.rb
+- npmdc.gemspec
+homepage: https://github.com/lysyi3m/npmdc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Check for missed dependencies of NPM packages.
+test_files: []