npm2gem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea5ddf081f5d65a4ccd584b25a8cfe11eb32e1eb
+  data.tar.gz: 059720c125fc8d381a7256b4284cdfac41e698db
+SHA512:
+  metadata.gz: 9d333d7280e0ac37901758b819c078d2fa9f3bc8e1f673b5ab09af483aa57f76a420b382d1f2691114cecc438674dcaa882ff7b2fa597a4541eee5b42f57f307
+  data.tar.gz: b826f1e25116f4644cf50fb18bb7a8f1c2d271e5284866c5a9bee58b771575d47c4ae5bed9dba03dff1987483c99348f6cd32f33fbf2c84fca88c91da65f939b

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/node_modules/
+/spec/dummy/node_modules/
+*.js
+*.css
+/vendor/
+/*.gem

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,241 @@
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+    - "db/schema.rb"
+  UseCache: false
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find: detect
+    find_all: select
+    reduce: inject
+Style/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: trailing
+  SupportedStyles:
+  - leading
+  - trailing
+Style/FileName:
+  Description: Use snake_case for source file names.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
+  Enabled: false
+  Exclude: []
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: false
+  MinBodyLength: 1
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: false
+  MaxLineLength: 80
+Style/OptionHash:
+  Description: Don't use option hashes when you can use keyword arguments.
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Style/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  Exclude:
+  - spec/**/*
+Style/RaiseArgs:
+  Description: Checks the arguments passed to raise/fail.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
+  Enabled: false
+  EnforcedStyle: exploded
+  SupportedStyles:
+  - compact
+  - exploded
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: false
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+Style/SingleLineBlockParams:
+  Description: Enforces the names of some block params.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
+  Enabled: false
+  Methods:
+  - reduce:
+    - a
+    - e
+  - inject:
+    - a
+    - e
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: false
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/TrailingCommaInArguments:
+  Description: Checks for trailing comma in parameter lists and literals.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - no_comma
+Style/TrailingCommaInLiteral:
+  Description: Checks for trailing comma in parameter lists and literals.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - no_comma
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  Enabled: false
+  Max: 15
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: false
+  Max: 5
+  CountKeywordArgs: true
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human
+    reader.
+  Enabled: false
+  Max: 7
+Lint/AssignmentInCondition:
+  Description: Don't use assignment in conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: false
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: false
+Style/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+Style/Alias:
+  Description: Use alias_method instead of alias.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: false
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: false
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: false
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: false
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
+  Enabled: false
+Style/PerlBackrefs:
+  Description: Avoid Perl-style regex back references.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
+  Enabled: false
+Style/Send:
+  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
+    may overlap with existing methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
+  Enabled: false
+Style/SpecialGlobalVars:
+  Description: Avoid Perl-style global variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
+  Enabled: false
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: false
+Style/WhenThen:
+  Description: Use when x then ... for one-line cases.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
+  Enabled: false
+Lint/EachWithObjectArgument:
+  Description: Check for immutable argument given to each_with_object.
+  Enabled: true
+Lint/HandleExceptions:
+  Description: Don't suppress exception.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
+  Enabled: false
+Lint/LiteralInCondition:
+  Description: Checks of literals used in conditions.
+  Enabled: false
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,111 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment,
+we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone,
+regardless of age,
+body
+size,
+disability,
+ethnicity,
+gender identity and expression,
+level of experience,
+nationality,
+personal appearance,
+race,
+religion,
+or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling,
+insulting/derogatory comments,
+and personal or political attacks
+* Public or private harassment
+* Publishing others' private information,
+such as a physical or electronic address,
+without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying
+the standards of acceptable behavior
+and are expected to take appropriate and fair corrective action
+in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove,
+edit,
+or
+reject comments,
+commits,
+code,
+wiki edits,
+issues,
+and other contributions
+that are not aligned to this Code of Conduct,
+or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening,
+offensive,
+or harmful.
+
+## Scope
+
+This Code of Conduct applies both
+within project spaces and in public spaces
+when an individual is representing the project or its community.
+Examples of
+representing a project or community include using an official project e-mail
+address,
+posting via an official social media account,
+or acting as an appointed representative at an online or offline event.
+Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive,
+harassing,
+or otherwise unacceptable behavior may be
+reported by contacting @seancllns on Twitter.
+All
+complaints will be reviewed and investigated
+and will result in a response that is deemed necessary
+and appropriate to the circumstances.
+The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow
+or enforce the Code of Conduct in good faith
+may face temporary or permanent repercussions
+as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the
+[Contributor Covenant][homepage],
+version 1.4,
+available at
+[http://contributor-covenant.org/version/1/4][version]
+
+[homepage]:
+http://contributor-covenant.org
+[version]:
+http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sean Collins
+
+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,102 @@
+# npm2gem
+
+npm2gem is a tool to help you build
+['gemified assets'](http://www.prioritized.net/blog/gemify-assets-for-rails/)
+for Rails,
+by automatically pulling assets from NPM.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'npm2gem'
+end
+```
+
+Then run:
+
+    $ bundle
+
+## Usage
+
+`npm2gem` works via an config file, `.npm2gem.yml`.
+
+Once that file is set up,
+you just run `npm2gem`
+and it'll automatically download the correct package from `npm`,
+and copy the files you want into your application.
+
+It assumes that all files will go into `vendor/assets`,
+with javascript files going into `vendor/assets/javascripts`
+and stylesheet files going into `vendor/assets/stylesheets`.
+
+
+### `.npm2gem.yml`
+
+Here is the specification for the `.npm2gem.yml` file:
+
+```
+bootstrap:
+  - dist/css/boostrap.css
+  - dist/css/bootstrap-theme.css
+  - dist/js/bootstrap.js
+
+```yaml
+
+
+#### Subdirectories
+
+You can also tell `npm2gem` which subfolder
+you'd like the assets to be placed in.
+
+Note: all `.css` files go into `vendor/assets/stylesheets`
+and all `.js` files go into `vendor/assets/javascripts`,
+this is currently a default that you cannot override.
+
+What you can do though,
+is have subdirectories.
+
+Let's say you wanted to put the `bootstrap-theme.css` file into
+`vendor/assets/stylesheets/themes` instead.
+
+Here's the `.npm2gem.yml` you'd use:
+
+```
+bootstrap:
+  - dist/css/boostrap.css
+  - dist/js/bootstrap.js
+  - themes:
+    - dist/css/bootstrap-theme.css
+
+```yaml
+
+## TODO:
+
+- [ ] Support SCSS, Coffee, etc.
+- [ ] Add support for fonts?
+- [ ] Add tests to ensure you can group JS and CSS files together in `.npm2gem.yml`
+
+## Future work
+Eventually, I'd like there to be a service that uses this gem to
+intermittenly poll `npm` to check for new packages.
+
+Once it finds one,
+it'll open a PR with the project
+to see if they want to update their gem.
+
+## Development
+
+Bug reports, support requests and pull requests are welcome on GitHub at
+https://github.com/cllns/npm2gem.
+This project is intended to be a safe,
+welcoming space for collaboration,
+and contributors are expected to adhere to the
+[Contributor Covenant](contributor-covenant.org)
+code of conduct.
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "npm2gem"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/npm2gem

@@ -0,0 +1,8 @@
+#! /usr/bin/env ruby
+require "npm2gem"
+
+if ARGV.length == 0
+  NPM2Gem::CLI.new.run
+else
+  abort "USAGE:\t npm2gem "
+end

data/lib/npm2gem/cli.rb

@@ -0,0 +1,56 @@
+require "npm2gem/config"
+require "npm2gem/npm_install"
+require "npm2gem/file_copier"
+require "npm2gem/exception"
+require "npm2gem/gem_version_updater"
+require "highline/import"
+
+module NPM2Gem
+  class CLI
+    attr_reader :config
+
+    def initialize
+      @config = Config.new
+      @npm_install = NPMInstall.new(@config.package_name)
+      @file_copier = FileCopier.new(@npm_install.path, "vendor/assets")
+    end
+
+    def run
+      if new_version?
+        puts "Current (gem)\t Version: #{gem_version}"
+        puts "New (npm)\t Version: #{npm_version}"
+        if want_to_upgrade?
+          @file_copier.copy(@config.files_to_copy)
+          version = GemVersionUpdater.new.run(npm_version)
+          puts "Done! :) Upgraded to #{version}"
+        else
+          puts "Okay, no problem!"
+        end
+      else
+        puts "There's no new version of #{@config.package_name} "\
+             "on npm. The current version is #{npm_version}"
+      end
+
+      #      FileUtils.rm_rf("node_modules")
+    end
+
+    private
+
+    def want_to_upgrade?
+      agree("Do you want to upgrade? [y/n]", true)
+    end
+
+    def new_version?
+      Gem::Version.new(npm_version) > Gem::Version.new(gem_version)
+    end
+
+    def gem_version
+      gemspec_file_name = Dir["*.gemspec"].first
+      Gem::Specification.load(gemspec_file_name).version.to_s
+    end
+
+    def npm_version
+      @npm_install.package_version
+    end
+  end
+end

data/lib/npm2gem/config.rb

@@ -0,0 +1,21 @@
+require "yaml"
+
+module NPM2Gem
+  class Config
+    def initialize
+      @yaml_file = YAML.load_file(".npm2gem.yml")
+    end
+
+    # TODO: support more than one?
+    def package_name
+      @yaml_file.keys.first
+    end
+
+    # This is an array, of either:
+    #   - file names, or
+    #   - a hash: { destination_subfolder: files }
+    def files_to_copy
+      @yaml_file[package_name]
+    end
+  end
+end

data/lib/npm2gem/exception.rb

@@ -0,0 +1,4 @@
+module NPM2Gem
+  class Exception < StandardError
+  end
+end