bundle_outdated_formatter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b3dde0537afc9e0b41231b98bffc5a06c999606
-  data.tar.gz: a09cc4304d66a60814b7d4a5207a6c413656cabc
+  metadata.gz: 46d8e274c48811f1a392cf4c0535b82d2aca4df7
+  data.tar.gz: a64b6f0deea5b0af8bf91060aa8a87ebf1a713e9
 SHA512:
-  metadata.gz: aff545d992a1538144e298782be897a0aace41f06b215816649478cf6ec15a0a3d5c9e2920ea1008ac34ce8b1a9e978dee293f202e76e9f3660f925b699d87b2
-  data.tar.gz: 25f5195074d504e5a9e5e5433eb98ec9464bfe3806281df5438ab110103ff9055d68d8be96fe28e1cebf696c9e6c66c07c702dfc3cbd9df07067a50b984642db
+  metadata.gz: 2834c969fe8cab275e2909b75fc5394fb835b39e331c0f6e0796fa47351aedee8ae968cf0923c200f532291312e79ad85ce1f9f8e231debe175b64509ac3ab1a
+  data.tar.gz: afb16f7d8bfe1f683bbf718d368b269997a95f7389de780024b73b4e1c7c2a1ea5b94eb5e0dd17d169eca4bf1ba3c0852f435ec805eadc9a1438dd91bc4f6338

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-06-10 17:56:18 +0900 using RuboCop version 0.49.1.
+# on 2017-06-19 20:57:55 +0900 using RuboCop version 0.49.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -12,41 +12,37 @@ Layout/EmptyLineAfterMagicComment:
   Exclude:
     - 'bundle_outdated_formatter.gemspec'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
-Layout/ExtraSpacing:
-  Exclude:
-    - 'bundle_outdated_formatter.gemspec'
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 23
 
 # Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment.
-Layout/SpaceAroundOperators:
-  Exclude:
-    - 'bundle_outdated_formatter.gemspec'
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 102
 
 # Offense count: 1
-Metrics/AbcSize:
-  Max: 23
+Metrics/CyclomaticComplexity:
+  Max: 7
 
-# Offense count: 5
+# Offense count: 8
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 126
 
-# Offense count: 1
+# Offense count: 4
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 20
 
-# Offense count: 1
+# Offense count: 2
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/bundle_outdated_formatter/cli.rb'
+    - 'lib/bundle_outdated_formatter/formatter.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -56,12 +52,6 @@ Style/HashSyntax:
   Exclude:
     - 'Rakefile'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/MutableConstant:
-  Exclude:
-    - 'lib/bundle_outdated_formatter/version.rb'
-
 # Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: PreferredDelimiters.
@@ -69,12 +59,6 @@ Style/PercentLiteralDelimiters:
   Exclude:
     - 'bundle_outdated_formatter.gemspec'
 
-# Offense count: 5
-# Cop supports --auto-correct.
-Style/RedundantFreeze:
-  Exclude:
-    - 'lib/bundle_outdated_formatter/cli.rb'
-
 # Offense count: 2
 # Cop supports --auto-correct.
 Style/UnneededPercentQ:

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## 0.2.0 (2017-06-19)
+
+### Features
+
+* Support JSON format
+* Support YAML format
+* Support CSV format
+* Support XML format
+* Support HTML format
+
 ## 0.1.0 (2017-06-15)
 
 ### Features

data/README.md

@@ -1,5 +1,6 @@
 # BundleOutdatedFormatter
 
+[![Gem Version](https://badge.fury.io/rb/bundle_outdated_formatter.svg)](https://badge.fury.io/rb/bundle_outdated_formatter)
 [![Build Status](https://travis-ci.org/emsk/bundle_outdated_formatter.svg?branch=master)](https://travis-ci.org/emsk/bundle_outdated_formatter)
 [![Coverage Status](https://coveralls.io/repos/github/emsk/bundle_outdated_formatter/badge.svg?branch=master)](https://coveralls.io/github/emsk/bundle_outdated_formatter)
 [![Code Climate](https://codeclimate.com/github/emsk/bundle_outdated_formatter/badges/gpa.svg)](https://codeclimate.com/github/emsk/bundle_outdated_formatter)
@@ -31,12 +32,16 @@ $ gem install bundle_outdated_formatter
 
 ## Usage
 
-### Convert to Markdown
-
 ```sh
 $ bundle outdated | bof
 ```
 
+## Command Options
+
+| Option | Alias | Description | Default |
+| :----- | :---- | :---------- | :------ |
+| `--format` | `-f` | Format. `markdown`, `json`, `yaml`, `csv`, `xml`, or `html`. | `markdown` |
+
 ## Examples
 
 Output of `bundle outdated`:
@@ -63,6 +68,54 @@ Outdated gems included in the bundle:
 | headless | 2.3.1 | 2.2.3 | | |
 ```
 
+### Convert to JSON
+
+```
+[{"gem":"faker","newest":"1.6.6","installed":"1.6.5","requested":"~> 1.4","groups":"development, test"},{"gem":"hashie","newest":"3.4.6","installed":"1.2.0","requested":"= 1.2.0","groups":"default"},{"gem":"headless","newest":"2.3.1","installed":"2.2.3","requested":"","groups":""}]
+```
+
+### Convert to YAML
+
+```
+---
+- gem: faker
+  newest: 1.6.6
+  installed: 1.6.5
+  requested: "~> 1.4"
+  groups: development, test
+- gem: hashie
+  newest: 3.4.6
+  installed: 1.2.0
+  requested: "= 1.2.0"
+  groups: default
+- gem: headless
+  newest: 2.3.1
+  installed: 2.2.3
+  requested: ''
+  groups: ''
+```
+
+### Convert to CSV
+
+```
+"gem","newest","installed","requested","groups"
+"faker","1.6.6","1.6.5","~> 1.4","development, test"
+"hashie","3.4.6","1.2.0","= 1.2.0","default"
+"headless","2.3.1","2.2.3","",""
+```
+
+### Convert to XML
+
+```
+<?xml version='1.0' encoding='UTF-8'?><gems><outdated><gem>faker</gem><newest>1.6.6</newest><installed>1.6.5</installed><requested>~> 1.4</requested><groups>development, test</groups></outdated><outdated><gem>hashie</gem><newest>3.4.6</newest><installed>1.2.0</installed><requested>= 1.2.0</requested><groups>default</groups></outdated><outdated><gem>headless</gem><newest>2.3.1</newest><installed>2.2.3</installed><requested></requested><groups></groups></outdated></gems>
+```
+
+### Convert to HTML
+
+```
+<table><tr><th>gem</th><th>newest</th><th>installed</th><th>requested</th><th>groups</th></tr><tr><td>faker</td><td>1.6.6</td><td>1.6.5</td><td>~> 1.4</td><td>development, test</td></tr><tr><td>hashie</td><td>3.4.6</td><td>1.2.0</td><td>= 1.2.0</td><td>default</td></tr><tr><td>headless</td><td>2.3.1</td><td>2.2.3</td><td></td><td></td></tr></table>
+```
+
 ## Supported Ruby Versions
 
 * Ruby 2.0.0

data/bundle_outdated_formatter.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'psych', '~> 2.2'
   spec.add_runtime_dependency 'thor', '~> 0.19'
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'coveralls', '~> 0.8'

data/lib/bundle_outdated_formatter/cli.rb

@@ -1,27 +1,22 @@
 require 'thor'
+require 'bundle_outdated_formatter/formatter'
 
 module BundleOutdatedFormatter
   class CLI < Thor
-    NAME_REGEXP      = /\A(\* )*(?<name>.+) \(/.freeze
-    NEWEST_REGEXP    = /newest (?<newest>[\d\.]+)/.freeze
-    INSTALLED_REGEXP = /installed (?<installed>[\d\.]+)/.freeze
-    REQUESTED_REGEXP = /requested (?<requested>.+)\)/.freeze
-    GROUPS_REGEXP    = /in groups "(?<groups>.+)"/.freeze
-
-    MARKDOWN_HEADER = <<-EOS.freeze
-| gem | newest | installed | requested | groups |
-| --- | --- | --- | --- | --- |
-    EOS
+    ALLOW_FORMAT = %w[markdown json yaml csv xml html].freeze
 
     default_command :output
 
     desc 'output', 'Format output of `bundle outdated`'
-    option :format, type: :string, aliases: '-f', default: 'markdown'
+    option :format, type: :string, aliases: '-f', default: 'markdown', desc: 'Format. (markdown, json, yaml, csv, xml, html)'
 
     def output
       return if STDIN.tty?
+      return unless allow_format?
 
-      puts format_markdown(outdated_gems_in_stdin) if options[:format] == 'markdown'
+      formatter = Formatter.new(options[:format])
+      formatter.read_stdin
+      puts formatter.convert
     end
 
     desc 'version, -v, --version', 'Print the version'
@@ -33,42 +28,8 @@ module BundleOutdatedFormatter
 
     private
 
-    def outdated_gems_in_stdin
-      outdated_gems = STDIN.each.to_a.map(&:strip).reject(&:empty?)
-
-      outdated_gems.map! do |line|
-        matched_name      = NAME_REGEXP.match(line)
-        matched_newest    = NEWEST_REGEXP.match(line)
-        matched_installed = INSTALLED_REGEXP.match(line)
-        matched_requested = REQUESTED_REGEXP.match(line)
-        matched_groups    = GROUPS_REGEXP.match(line)
-
-        if matched_name.nil? && matched_newest.nil? && matched_installed.nil? && matched_requested.nil? && matched_groups.nil?
-          nil
-        else
-          {
-            name:      gem_text(matched_name, :name),
-            newest:    gem_text(matched_newest, :newest),
-            installed: gem_text(matched_installed, :installed),
-            requested: gem_text(matched_requested, :requested),
-            groups:    gem_text(matched_groups, :groups)
-          }
-        end
-      end
-
-      outdated_gems.compact
-    end
-
-    def gem_text(text, name)
-      text ? text[name] : ''
-    end
-
-    def format_markdown(outdated_gems)
-      outdated_gems.map! do |gem|
-        "| #{[gem[:name], gem[:newest], gem[:installed], gem[:requested], gem[:groups]].join(' | ')} |".gsub(/  /, ' ')
-      end
-
-      MARKDOWN_HEADER + outdated_gems.join("\n")
+    def allow_format?
+      ALLOW_FORMAT.include?(options[:format])
     end
   end
 end

data/lib/bundle_outdated_formatter/formatter.rb

@@ -0,0 +1,136 @@
+require 'json'
+require 'psych'
+require 'csv'
+require 'rexml/document'
+
+module BundleOutdatedFormatter
+  class Formatter
+    NAME_REGEXP      = /\A(\* )*(?<name>.+) \(/
+    NEWEST_REGEXP    = /newest (?<newest>[\d\.]+)/
+    INSTALLED_REGEXP = /installed (?<installed>[\d\.]+)/
+    REQUESTED_REGEXP = /requested (?<requested>.+)\)/
+    GROUPS_REGEXP    = /in groups "(?<groups>.+)"/
+
+    MARKDOWN_HEADER = <<-EOS.freeze
+| gem | newest | installed | requested | groups |
+| --- | --- | --- | --- | --- |
+    EOS
+    COLUMNS = %w[gem newest installed requested groups].freeze
+
+    def initialize(format)
+      @format = format
+      @outdated_gems = []
+    end
+
+    def read_stdin
+      @outdated_gems = STDIN.each.to_a.map(&:strip).reject(&:empty?)
+
+      @outdated_gems.map! do |line|
+        matched_name      = NAME_REGEXP.match(line)
+        matched_newest    = NEWEST_REGEXP.match(line)
+        matched_installed = INSTALLED_REGEXP.match(line)
+        matched_requested = REQUESTED_REGEXP.match(line)
+        matched_groups    = GROUPS_REGEXP.match(line)
+
+        if matched_name.nil? && matched_newest.nil? && matched_installed.nil? && matched_requested.nil? && matched_groups.nil?
+          nil
+        else
+          {
+            'gem'       => gem_text(matched_name, :name),
+            'newest'    => gem_text(matched_newest, :newest),
+            'installed' => gem_text(matched_installed, :installed),
+            'requested' => gem_text(matched_requested, :requested),
+            'groups'    => gem_text(matched_groups, :groups)
+          }
+        end
+      end
+
+      @outdated_gems.compact!
+    end
+
+    def convert
+      text =
+        case @format
+        when 'markdown' then format_markdown
+        when 'json'     then format_json
+        when 'yaml'     then format_yaml
+        when 'csv'      then format_csv
+        when 'xml'      then format_xml
+        when 'html'     then format_html
+        else                 ''
+        end
+      text.chomp
+    end
+
+    private
+
+    def format_markdown
+      @outdated_gems.map! do |gem|
+        "| #{gem.values.join(' | ')} |".gsub(/  /, ' ')
+      end
+
+      MARKDOWN_HEADER + @outdated_gems.join("\n")
+    end
+
+    def format_json
+      @outdated_gems.to_json
+    end
+
+    def format_yaml
+      @outdated_gems.to_yaml
+    end
+
+    def format_csv
+      CSV.generate(force_quotes: true) do |csv|
+        csv << COLUMNS
+        @outdated_gems.each do |gem|
+          csv << gem.values
+        end
+      end
+    end
+
+    def format_xml
+      xml = REXML::Document.new(nil, raw: :all)
+      xml << REXML::XMLDecl.new('1.0', 'UTF-8')
+
+      root = REXML::Element.new('gems')
+      xml.add_element(root)
+
+      @outdated_gems.each do |gem|
+        elements = root.add_element(REXML::Element.new('outdated'))
+
+        COLUMNS.each do |column|
+          elements.add_element(column).add_text(gem[column])
+        end
+      end
+
+      xml.to_s
+    end
+
+    def format_html
+      html = REXML::Document.new(nil, raw: :all)
+
+      root = REXML::Element.new('table')
+      html.add_element(root)
+
+      elements = root.add_element(REXML::Element.new('tr'))
+      COLUMNS.each do |column|
+        elements.add_element('th').add_text(column)
+      end
+
+      @outdated_gems.each do |gem|
+        elements = root.add_element(REXML::Element.new('tr'))
+
+        COLUMNS.each do |column|
+          elements.add_element('td').add_text(gem[column])
+        end
+      end
+
+      html.to_s
+    end
+
+    def gem_text(text, name)
+      text ? text[name] : ''
+    end
+  end
+end

data/lib/bundle_outdated_formatter/version.rb

@@ -1,3 +1,3 @@
 module BundleOutdatedFormatter
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bundle_outdated_formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - emsk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-15 00:00:00.000000000 Z
+date: 2017-06-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: psych
+  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: thor
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +147,7 @@ files:
 - exe/bof
 - lib/bundle_outdated_formatter.rb
 - lib/bundle_outdated_formatter/cli.rb
+- lib/bundle_outdated_formatter/formatter.rb
 - lib/bundle_outdated_formatter/version.rb
 homepage: https://github.com/emsk/bundle_outdated_formatter
 licenses: