knitter 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75dbb5ccb2ef2db2a68c18dd89b63592623bb057
+  data.tar.gz: '0846c7cf3588e9bb3afb4025996973b338c7dd16'
+SHA512:
+  metadata.gz: f7e806fedd8b284594430ca89147cbe20a250860d39391da0c2be4cdfb2f7dddd74b86e290aa7fa722ecdd796c0ae2324fd1a900c21cbe121b711064288b8a7d
+  data.tar.gz: '085c70e7d0d854dc9718127647de6bd4b39d04c7479be026b7169d429bb33ea29eb36e086205c9be4293a853826270612c505549649ed3270c7f6193e82be230'

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in npm-wrapper.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :minitest, autorun: true, bundler: true, test_folders: ['test'] do
+    watch(%r{^test/test_(.*)\.rb$})
+    watch(%r{^lib/(.*/)?([^/]+)\.rb$}) { |m| "test/test_#{m[2]}.rb" }
+    watch(%r{^test/test_helper\.rb$})  { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nathan Stitt
+
+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,49 @@
+# Knitter
+
+A lightweight Ruby Gem wrapper around the node package manager.  Allows checking installation status of and installing packages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'knitter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install knitter
+
+## Usage
+
+```ruby
+require 'knitter'
+
+process = NPMWrapper::Process.new('my-npm-project-directory')
+
+# create a bare-bones 'package.json' file
+process.init
+
+# test with the infamous left-pad.  Process is optional, it will default to Dir.pwd
+package = NPMWrapper::Package.new('left-pad', process: process)
+
+package.installed? # false
+
+package.install
+
+package.installed? # true
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nathanstitt/npm-wrapper.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/**/test_*.rb']
+end
+desc "Run tests"
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "npm/wrapper"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/knitter.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knitter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "knitter"
+  spec.version       = Knitter::VERSION
+  spec.authors       = ["Nathan Stitt"]
+  spec.email         = ["nathan@stitt.org"]
+
+  spec.summary       = %q{Wraps the Javascript "yarn" package manager command}
+  spec.description   = %q{Wraps the Javascript "yarn" command; query and install Javascript packages from Ruby.  Reads the package.json file directly to detect packages that are installed, and shells out to `yarn` to initialize and install packages.}
+  spec.homepage      = "https://github.com/nathanstitt/knitter"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'mixlib-shellout', '~> 2.2'
+
+  spec.add_development_dependency "bundler",        "~> 1.13"
+  spec.add_development_dependency "rake",           "~> 10.0"
+  spec.add_development_dependency "guard",          "~> 2.13"
+  spec.add_development_dependency "spy",            "~> 0.4.5"
+  spec.add_development_dependency "guard-minitest", "~> 2.3"
+
+end

data/lib/knitter.rb

@@ -0,0 +1,8 @@
+require_relative "knitter/version"
+require_relative "knitter/package"
+require_relative "knitter/process"
+
+module Knitter
+
+
+end

data/lib/knitter/package.rb

@@ -0,0 +1,81 @@
+require 'json'
+require_relative 'package_version'
+
+module Knitter
+    class Package
+        PackageConfig = Struct.new(:area, :version)
+
+        attr_reader :name, :dependency_type
+
+        attr_writer :process
+
+        def initialize(name, process: nil)
+            @name = name
+            @process = process
+        end
+
+        def version
+            @version ||= PackageVersion.new(config.version)
+        end
+
+        def version=(ver)
+            @version = PackageVersion.new(ver)
+        end
+
+        def dependency_type=(type)
+            @dependency_type = type
+        end
+
+        def dependency_type
+            @dependency_type || (
+                case config.area
+                when 'optionalDependencies' then :optional
+                when 'devDependencies'      then :development
+                when 'peerDependencies'     then :peer
+                else
+                    :dependencies
+                end
+            )
+        end
+
+        def installed?
+            !config.nil?
+        end
+
+        def add
+            process.add(self)
+            @config = nil
+        end
+
+        def config
+            @config ||= read_config
+        end
+
+        def valid?
+            process.package_file.exist? && config
+        end
+
+        protected
+
+        def parse_package_file
+            JSON.parse(process.package_file.read)
+        end
+
+        def process
+            @process ||= Process.new(Dir.pwd)
+        end
+
+        def read_config
+            config = PackageConfig.new
+            package = parse_package_file
+            %w{dependencies devDependencies optionalDependencies}.each do | part_name |
+                part = package[part_name]
+                next unless part && (version = part[@name])
+                config.area = part_name
+                config.version = version
+            end
+            config
+        end
+
+    end
+end

data/lib/knitter/package_version.rb

@@ -0,0 +1,17 @@
+module Knitter
+    class PackageVersion
+
+
+        def initialize(version)
+            @version = version
+        end
+
+        def to_s
+            @version.to_s
+        end
+
+        def latest?
+            @version == :latest
+        end
+    end
+end

data/lib/knitter/process.rb

@@ -0,0 +1,54 @@
+require 'mixlib/shellout'
+
+module Knitter
+    class Process
+        extend Forwardable
+        def_delegators :@sh, :stderr, :stdout
+
+        attr_reader :directory
+
+        def initialize(directory)
+            @directory = Pathname.new(directory)
+        end
+
+        def init
+            execute('init', '--yes')
+        end
+
+        def ok?
+            @sh && @sh.status.exitstatus == 0
+        end
+
+        def add(package)
+            name = package.name
+            unless package.version.latest?
+                name << '@' << package.version.to_s
+            end
+            execute(
+                *['add', name, package_save_as_flag(package)].compact
+            )
+        end
+
+        def package_file
+            @directory.join "package.json"
+        end
+
+        protected
+
+        def package_save_as_flag(package)
+            case package.dependency_type
+            when :peer        then '--peer'
+            when :optional    then '--optional'
+            when :development then '--dev'
+            end
+        end
+
+        def execute(cmd, *args)
+            @sh = Mixlib::ShellOut.new(
+                "yarn", cmd, *args,
+                cwd: @directory.to_s
+            )
+            @sh.run_command
+        end
+    end
+end

data/lib/knitter/version.rb

@@ -0,0 +1,3 @@
+module Knitter
+    VERSION = '0.1'
+end

data/lib/yarn/wrapper.rb

@@ -0,0 +1,7 @@
+require "npm-wrapper"
+require 'mixlib/config'
+
+module Knitter
+
+
+end

data/lib/yarn/wrapper/version.rb

@@ -0,0 +1,5 @@
+module Npm
+  module Wrapper
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: knitter
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Nathan Stitt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !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: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: spy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: Wraps the Javascript "yarn" command; query and install Javascript packages
+  from Ruby.  Reads the package.json file directly to detect packages that are installed,
+  and shells out to `yarn` to initialize and install packages.
+email:
+- nathan@stitt.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- knitter.gemspec
+- lib/knitter.rb
+- lib/knitter/package.rb
+- lib/knitter/package_version.rb
+- lib/knitter/process.rb
+- lib/knitter/version.rb
+- lib/yarn/wrapper.rb
+- lib/yarn/wrapper/version.rb
+homepage: https://github.com/nathanstitt/knitter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Wraps the Javascript "yarn" package manager command
+test_files: []