prettyp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f5a14081112b48776bdb009a7b509ca08548d94
+  data.tar.gz: 6506aa55657f050cda05b958b377a15b92556024
+SHA512:
+  metadata.gz: c28301c9b78b7a2d51809163b018a8a7922105883a2ff3e1588dd64e9cec6c3a3ae784da3a3894a31e1c222e6f9e1399cdc330eb18634337c2a713c7703d5a08
+  data.tar.gz: 4999d3c6478c700ff330af063863506a2f1d1c7c0960b2a87c42ca3656bacc5ef572713bb7a4a123c5090d12fd2037842a9fb5087f172b5d1e6403771d8d6a84

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+tags
+/.vendor/
+cscope.out
+.starscope.db

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'pry', require: true
+  gem 'fakefs'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jacob Evans
+
+MIT License
+
+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,37 @@
+# Prettyp
+
+One language formatter tool to rule them all.
+
+## Why?
+I didn't like having to remember:
+
+```
+pbpaste | xmllint --format -
+cat log.json | python -m json.tool
+```
+
+Why not just have a tool to do them all.
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install prettyp
+
+## Usage
+
+```
+pbpaste | prettyp format
+cat test.json | prettyp format
+prettyp format --file test.json
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/dekz/prettyp/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## TODO support ignoring the language classifier

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/prettyp

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+
+require 'prettyp'
+require 'thor'
+
+class CLI < Thor
+  Prettyp::Logger.logger.level = ::Logger::WARN
+  desc "format", "formats input from either stdin or file (--file) and prints to stdout"
+  option :file
+  def format
+    service = Prettyp::FormatterService.new
+    text = if options[:file]
+      service.format_from_file(File.open(options[:file], 'r'))
+    else
+      service.format_from_stdin
+    end
+    puts text
+  end
+end
+
+CLI.start(ARGV)

data/lib/prettyp.rb

@@ -0,0 +1,7 @@
+require "prettyp/version"
+require "prettyp/logger"
+require 'prettyp/formatters'
+require 'prettyp/formatter_service'
+
+module Prettyp
+end

data/lib/prettyp/formatter/base_formatter.rb

@@ -0,0 +1,73 @@
+require 'tempfile'
+
+module Prettyp
+  module Formatter
+    class FormatError < StandardError; end
+    class Unimplemented < StandardError; end
+
+    class BaseFormatter
+      include Logger
+
+      def self.inherited clazz
+        @inherited_classes ||= []
+        @inherited_classes << clazz
+      end
+
+      def self.inherited_classes
+        @inherited_classes
+      end
+
+      def self.check_requirement
+        raise Unimplemented 'requirement'
+      end
+
+      def self.languages
+        []
+      end
+
+      def check_requirement
+        self.class.check_requirement
+      end
+
+      def format input, language
+        raise Unimplemented 'format'
+      end
+
+      protected
+      def execute_command command, on_error: nil, on_success: nil
+        logger.debug command
+
+        output = `#{command} 2>&1 `
+        success = !execute_error?
+
+        on_error.call(output) if !success && on_error
+        on_success.call(output) if success and on_success
+
+        output
+      end
+
+      def execute_error?
+        $? != 0
+      end
+
+      def with_file input, &block
+        return block.call(input) if input.is_a?(File) || input.is_a?(Tempfile)
+        with_tempfile(input, &block)
+      end
+
+      def with_tempfile input, &block
+        file = Tempfile.new('prettyp')
+        file.write(input)
+        begin
+          file.rewind
+          block.call(file)
+        ensure
+          file.close
+          file.unlink
+        end
+      end
+
+    end
+  end
+end
+

data/lib/prettyp/formatter/html.rb

@@ -0,0 +1 @@
+Dir.glob(File.dirname(__FILE__) + '/html/*') { |f| load f }

data/lib/prettyp/formatter/html/tidy.rb

@@ -0,0 +1,32 @@
+module Prettyp
+  module Formatter
+    module HTML
+      class Tidy < ::Prettyp::Formatter::BaseFormatter
+
+        def self.languages
+          ['HTML']
+        end
+
+        def self.executeable; 'tidy'; end
+
+        def self.check_requirement
+          !%x|which #{executeable}|.empty?
+        end
+
+        def format input, language
+          with_file(input) do |file|
+            with_tempfile '' do |tmp|
+              out = execute_command("#{self.class.executeable} -im #{file.path} -f #{tmp.path} -q",
+                                    #on_error: Proc.new { |output| raise FormatError, output })
+                                    on_error: Proc.new { })
+              out = File.read(file.path)
+              out
+            end
+          end
+        end
+
+      end
+    end
+  end
+end
+

data/lib/prettyp/formatter/json.rb

@@ -0,0 +1 @@
+Dir.glob(File.dirname(__FILE__) + '/json/*') { |f| load f }

data/lib/prettyp/formatter/json/python.rb

@@ -0,0 +1,24 @@
+module Prettyp
+  module Formatter
+    module JSON
+      class Python < ::Prettyp::Formatter::BaseFormatter
+        def self.languages
+          ['JSON']
+        end
+
+        def self.executeable; 'python'; end
+        def self.check_requirement
+          !%x|which #{executeable}|.empty?
+        end
+
+        def format input, language
+          with_file(input) do |file|
+            out = execute_command("cat #{file.path} | #{self.class.executeable} -m json.tool",
+                                  on_error: Proc.new { |output| raise FormatError, output })
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/prettyp/formatter/xml.rb

@@ -0,0 +1 @@
+Dir.glob(File.dirname(__FILE__) + '/xml/*') { |f| load f }

data/lib/prettyp/formatter/xml/xmllint.rb

@@ -0,0 +1,27 @@
+module Prettyp
+  module Formatter
+    module XML
+      class Xmllint < ::Prettyp::Formatter::BaseFormatter
+
+        def self.languages
+          [:xml, :html]
+        end
+
+        def self.executeable; 'xmllint'; end
+        def self.check_requirement
+          !%x|which #{executeable}|.empty?
+        end
+
+        def format input, language
+          extra_opts = '--html' if language.eql? :html
+          with_file(input) do |file|
+            out = execute_command("cat #{file.path} | #{self.class.executeable} --format #{extra_opts} -",
+                                  on_error: Proc.new { |output| raise FormatError, output })
+          end
+        end
+
+      end
+    end
+  end
+end
+

data/lib/prettyp/formatter_registry.rb

@@ -0,0 +1,30 @@
+module Prettyp
+  class FormatterRegistry
+
+    attr_reader :formatters
+
+    def initialize formatters = Formatter::BaseFormatter.inherited_classes
+      determine_formatters formatters
+    end
+
+    def formatter_for language
+      formatters[format_language_key(language)].first
+    end
+
+    private
+    def determine_formatters formatters
+      our_formatters = Hash.new {|h,k| h[k]=[]}
+
+      formatters.each do |clazz|
+        clazz.languages.each { |l| our_formatters[format_language_key(l)] << clazz } if clazz.check_requirement
+      end
+
+      @formatters = our_formatters
+    end
+
+    def format_language_key l
+      l.downcase.to_sym
+    end
+
+  end
+end

data/lib/prettyp/formatter_service.rb

@@ -0,0 +1,62 @@
+require 'prettyp/language_detection_service'
+require 'prettyp/formatter_registry'
+
+module Prettyp
+  class FormatError < StandardError; end
+  class FormatterService
+    include Logger
+
+    def initialize(formatter_registry: FormatterRegistry.new, language_detection: LanguageDetectionService.new)
+      @formatter_registry = formatter_registry
+      @language_detection = language_detection
+    end
+
+    def format_from_file file
+      language = language_detection.detect_from_file(file)
+      format file, language
+    end
+
+    def format_from_stdin
+      input = $stdin.read
+
+      language = language_detection.detect_from_input(input)
+      with_tempfile input do |f|
+        format f, language
+      end
+    end
+
+    def format_as_language_from_file language, file
+      format file, language
+    end
+
+    def format_as_language_from_stdin language
+      input = $stdin.read
+
+      with_tempfile input do |f|
+        format f, language
+      end
+    end
+
+    private
+      attr_reader :formatter_registry, :language_detection
+
+      def format file, language
+        formatter = formatter_registry.formatter_for(language)
+        raise FormatError, "Cannot determine formatter for #{language} from #{formatter_registry.formatters}" unless formatter
+        formatter.new.format(file, language)
+      end
+
+      def with_tempfile input, &block
+        file = Tempfile.new('prettyp')
+        file.write(input)
+        begin
+          file.rewind
+          block.call(file)
+        ensure
+          file.close
+          file.unlink
+        end
+      end
+  end
+end
+

data/lib/prettyp/formatters.rb

@@ -0,0 +1,4 @@
+require 'prettyp/formatter/base_formatter'
+require 'prettyp/formatter/xml'
+require 'prettyp/formatter/json'
+require 'prettyp/formatter/html'

data/lib/prettyp/language_detection_service.rb

@@ -0,0 +1,31 @@
+require 'linguist'
+
+module Prettyp
+  class LanguageDetectionService
+    # Our supported languages
+    POSSIBLE_LANGUAGE_NAMES = ['XML', 'Ruby', 'JSON', 'JavaScript', 'HTML']
+
+    def detect_from_file file
+      file_blob = Linguist::FileBlob.new(file.path)
+      language = file_blob.language
+      return format_language_key(language.name) if language
+
+      detect_from_input(file_blob.data)
+    end
+
+    def detect_from_input input
+      classified = Linguist::Classifier.classify(Linguist::Samples::DATA, input, possible).first
+      format_language_key(Linguist::Language[classified[0]].name)
+    end
+
+    private
+    def possible
+      @possible_languaes_list ||= POSSIBLE_LANGUAGE_NAMES.map { |n| Linguist::Language.find_by_name(n) }.map(&:name)
+    end
+
+    def format_language_key l
+      l.downcase.to_sym
+    end
+  end
+end
+