gemfile_utils 1.0.0

data/gemfile_utils.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gemfile_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gemfile_utils"
+  spec.version       = GemfileUtils::VERSION
+  spec.authors       = ["Igor Fedoronchuk"]
+  spec.email         = ["fedoronchuk@gmail.com"]
+
+  spec.summary       = %q{gemfile_utils gem}
+  spec.description   = %q{gemfile_utils provides command line interface to modify Gemfile with annotations and comments}
+  spec.homepage      = "https://github.com/Fivell"
+  spec.license       = "MIT"
+  
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = ['gemfile_utils']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_dependency "thor", '~> 0.19'
+  spec.add_dependency "faraday", '~> 0.10'
+  spec.add_dependency "typhoeus", '~> 1.1'
+  spec.add_dependency "gemnasium-parser", '~> 0.1'
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/gemfile_utils/cli/base.rb

@@ -0,0 +1,55 @@
+require 'thor'
+require_relative '../thor/actions/inject_into_file'
+require_relative '../parser/gemfile'
+require_relative '../parser/ruby_gems'
+
+require_relative 'modules/comments'
+require_relative 'modules/licenses'
+
+
+module GemfileUtils
+  module Cli
+    class Base < ::Thor
+      include ::Thor::Actions
+      namespace :gemfile_utils
+
+      UNKNOWN_LICENCES = ['Unknown'].freeze
+
+      include GemfileUtils::Cli::Comments
+      include GemfileUtils::Cli::Licenses
+
+
+
+      protected
+
+      def gemfile_dependencies
+        @gemfile_dependencies ||= GemfileUtils::Parser::Gemfile.new(gemfile_content).dependencies
+      end
+
+      def gemfile_content
+        @gemfile_content ||= File.read( options[:gemfile] )
+      end
+
+      def ruby_gems(gem_name)
+        ruby_gems_parser.info(gem_name)
+      end
+
+      def ruby_gems_parser
+        @ruby_gems_parser ||= begin
+          rg =  GemfileUtils::Parser::RubyGems.new(gemfile_dependencies.map(&:name))
+          rg.request!
+          rg
+        end
+      end
+
+      def comment_block(str, indention = '')
+        safe_encode str.lines.map{|line|  "#{indention}# #{line.chomp}" }.join($/) + $/
+      end
+
+      def safe_encode(value)
+         value.encode("utf-8", invalid: :replace, undef: :replace, replace: "_")
+      end
+
+    end
+  end
+end

data/lib/gemfile_utils/cli/modules/comments.rb

@@ -0,0 +1,34 @@
+module GemfileUtils
+  module Cli
+    module Comments
+
+      def self.included(thor)
+        thor.class_eval do
+
+          desc 'comments', 'Comment Gemfile with gems descriptions fetched from rubygems'
+          method_option :gemfile, default: 'Gemfile'
+          method_option :licenses, default: 'false'
+
+          def comments
+            gemfile_dependencies.each do |dependency|
+              add_comment(dependency.name, ruby_gems(dependency.name), ' ' * dependency.instance_variable_get(:@indention) )
+            end
+          end
+
+          protected
+
+          def add_comment(gem_name, gem_data, indention = '')
+            info = gem_data['info']
+            if options[:licenses]
+              licenses = gem_data['licenses']
+              licenses = Base::UNKNOWN_LICENCES if licenses.nil? || licenses.empty?
+              info =  "(#{licenses * ', '}) #{info}"
+            end
+            inject_into_file options[:gemfile],  comment_block(info, indention), before: Regexp.new("[\s]*gem[\s]+['\"]#{gem_name}['\"]") if info
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/gemfile_utils/cli/modules/licenses.rb

@@ -0,0 +1,29 @@
+module GemfileUtils
+  module Cli
+    module Licenses
+
+      def self.included(thor)
+        thor.class_eval do
+          desc 'licenses', 'Comment Gemfile with gems all dependencies licences fetched from rubygems'
+          method_option :gemfile, default: 'Gemfile'
+
+          def licenses
+            licenses_list = []
+            gemfile_dependencies.each do |dependency|
+              l = ruby_gems(dependency.name)['licenses']
+              l =  Base::UNKNOWN_LICENCES if l.nil? || l.empty?
+              licenses_list += l
+            end
+
+            prepend_to_file options[:gemfile], comment_block(licenses_comment(licenses_list))
+          end
+
+          private
+          def licenses_comment(list)
+            safe_encode "Licenses: #{list.uniq.sort}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gemfile_utils/parser/gemfile.rb

@@ -0,0 +1,19 @@
+require 'gemnasium/parser'
+require 'gemnasium/parser/gemfile'
+module GemfileUtils
+  module Parser
+    class Gemfile < ::Gemnasium::Parser::Gemfile
+      #do not exclude any gem
+      def exclude?(_match, _opts)
+        false
+      end
+
+      def dependency(match)
+        dep = super(match)
+        dep.instance_variable_set(:@indention, match.to_s.index(/[^ ]/) ) #count spaces before gem method
+        dep
+      end
+
+    end
+  end
+end

data/lib/gemfile_utils/parser/ruby_gems.rb

@@ -0,0 +1,38 @@
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+require 'json'
+
+module GemfileUtils
+  module Parser
+    class RubyGems
+      API_URL = 'https://rubygems.org/api/v1/gems/'.freeze
+
+      attr_reader :gems, :connection, :responses
+
+      def initialize(gems)
+        @gems = gems
+        @connection = Faraday.new(url: API_URL) do |faraday|
+          faraday.adapter :typhoeus
+        end
+      end
+
+      def request!
+        #
+        @responses = {}
+
+        connection.in_parallel(Typhoeus::Hydra.new(max_concurrency: 10)) do
+          gems.map do |gem_name|
+            @responses[gem_name] = connection.get("#{gem_name}")
+          end
+        end
+        #keep only successful responses
+        @responses.reject! { |_, response| response.status >= 400 }
+      end
+
+      def info(gem_name)
+        responses.has_key?(gem_name) ? JSON.parse(responses[gem_name].body) : {}
+      end
+
+    end
+  end
+end

data/lib/gemfile_utils/thor/actions/inject_into_file.rb

@@ -0,0 +1,21 @@
+# incompatible character encodings: ASCII-8BIT and UTF-8 fix by replacing File.binread with File.read
+# https://github.com/erikhuda/thor/issues/191
+class Thor
+  module Actions
+    class InjectIntoFile < EmptyDirectory #:nodoc:
+      protected
+
+      # Adds the content to the file.
+      #
+      def replace!(regexp, string, force)
+        return if base.options[:pretend]
+        content = File.read(destination)
+        if force || !content.include?(replacement)
+          content.gsub!(regexp, string)
+          File.open(destination, "wb") { |file| file.write(content) }
+        end
+      end
+    end
+  end
+end
+

data/lib/gemfile_utils/version.rb

@@ -0,0 +1,3 @@
+module GemfileUtils
+  VERSION = "1.0.0"
+end

data/lib/gemfile_utils.rb

@@ -0,0 +1,4 @@
+require "gemfile_utils/version"
+require "gemfile_utils/cli/base"
+module GemfileUtils
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: gemfile_utils
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Igor Fedoronchuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: gemnasium-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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: gemfile_utils provides command line interface to modify Gemfile with
+  annotations and comments
+email:
+- fedoronchuk@gmail.com
+executables:
+- gemfile_utils
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rvmrc"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/gemfile_utils
+- bin/setup
+- fixtures/vcr_cassettes/rubygems.yml
+- gemfile_utils.gemspec
+- lib/gemfile_utils.rb
+- lib/gemfile_utils/cli/base.rb
+- lib/gemfile_utils/cli/modules/comments.rb
+- lib/gemfile_utils/cli/modules/licenses.rb
+- lib/gemfile_utils/parser/gemfile.rb
+- lib/gemfile_utils/parser/ruby_gems.rb
+- lib/gemfile_utils/thor/actions/inject_into_file.rb
+- lib/gemfile_utils/version.rb
+homepage: https://github.com/Fivell
+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.4.6
+signing_key: 
+specification_version: 4
+summary: gemfile_utils gem
+test_files: []