iterm2-viewer 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c939586a9e3fcfe8bb750d994245c67c77ef1b3
-  data.tar.gz: d3acb5b1f9ae229d1ac4699965a2e204e5c01ad2
+  metadata.gz: e669b5969e6184f423ac372b5fc2dec5d8a29f40
+  data.tar.gz: ce0019766d06fc9b4f263ed531033e252268df0c
 SHA512:
-  metadata.gz: 0ac2ed4d9b107d109a00c8cad44ed0049ec68074211d69337201532b9a314fc8673105bcfd0287c0b413d0a4242e22b70e8bdfc3386e9cc6371351711d7a928a
-  data.tar.gz: eceed5eab5b7a1c9cb5db0ab26d0fe7c925f89ee5d8771e8b6466b759bc29a6203ef90fa228ff4262b4b2ab9642938f80d18a9b875e3444e3475911e580fc531
+  metadata.gz: 3645f7d37581fd296342db543c593b2d31e6787b3894951db07097657167ef454a11f37ae3449bb514b1cdecd649a6ebc493410dd8d1c1f49f4be45e7d49556b
+  data.tar.gz: 56e3b46fd2d1455445f6d0179e2679f4b6dd89f5db3abe42b56751143d3130f628c3b01b250c9bf47476d591482922983b32da6b44921d952174b36d582d31d6

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+gemfile:
+  - gemfiles/Gemfile
+addons:
+    code_climate:
+        repo_token: ab8664da98d6bfb6a14e4bd439bb87efe95b19785f42ba496077b3fd5ef3ecc3
+rvm:
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3
+#cache: bundler

data/Gemfile

@@ -1,4 +1,9 @@
 source 'https://rubygems.org'
 
+group :test do
+  gem 'rake'
+  gem "codeclimate-test-reporter", require: nil
+end
+
 # Specify your gem's dependencies in iterm2-viewer.gemspec
 gemspec

data/README.md

@@ -1,11 +1,19 @@
 [![Code Climate](https://codeclimate.com/github/AndreyAntipov/iterm2-viewer/badges/gpa.svg)](https://codeclimate.com/github/AndreyAntipov/iterm2-viewer)
 [![Dependency Status](https://gemnasium.com/AndreyAntipov/iterm2-viewer.svg)](https://gemnasium.com/AndreyAntipov/iterm2-viewer)
 [![Gem Version](https://badge.fury.io/rb/iterm2-viewer.svg)](http://badge.fury.io/rb/iterm2-viewer)
+[![Build Status](https://travis-ci.org/AndreyAntipov/iterm2-viewer.svg?branch=master)](https://travis-ci.org/AndreyAntipov/iterm2-viewer)
+[![Test Coverage](https://codeclimate.com/github/AndreyAntipov/iterm2-viewer/badges/coverage.svg)](https://codeclimate.com/github/AndreyAntipov/iterm2-viewer)
 
 # iterm2-viewer
 
 Display media files in terminal. iTerm2-nightly is required
 
+## Supported types
+    - png
+    - jpeg
+    - tiff
+    - gif
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -25,11 +33,11 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-iterm2-viewer YOUR_IMAGE_FILE_PATH
+iterm2-viewer IMAGE_FILE_PATH
 ```
-or
+display multiple images
 ```ruby
-iterm2-viewer YOUR_IMAGE_FILE_1_PATH YOUR_IMAGE_FILE_2_PATH
+iterm2-viewer IMAGE_FILE_1_PATH IMAGE_FILE_2_PATH
 ```
 --- 
 
@@ -47,7 +55,7 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/iterm2-viewer/fork )
+1. Fork it ( https://github.com/AndreyAntipov/iterm2-viewer/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`)

data/Rakefile

@@ -1,2 +1,9 @@
-require "bundler/gem_tasks"
+require 'rake/testtask'
 
+Rake::TestTask.new do |t|
+    t.libs << 'test'
+    # t.warning = true
+    #t.verbose = true
+    t.pattern = "test/**/test_*.rb"
+end
+task :default => [:test]

data/bin/iterm2-viewer

@@ -12,10 +12,13 @@ module Iterm2
     # @param [String, #arguments] routes to files
     class << self
        def show(arguments)
+         # show current version
+        puts VERSION if arguments[0].to_s == "--version" || arguments[0].to_s == "-v"
+
         # initialize whenever application called from iTerm2
         if ENV['TERM_PROGRAM']  == 'iTerm.app'
           arguments.each do |route|
-            Render.new Media.new route if File.file? route
+            Render.new(Media.new route) if File.file? route
           end
         end
        end

data/lib/iterm2/viewer/media.rb

@@ -0,0 +1,57 @@
+module Iterm2
+  module Viewer
+    # Create a new media object
+    class Media
+      # Dependency
+      require 'mime/types'
+      require 'base64'
+
+      def initialize(object)
+        @mime ||= MIME::Types.of(object).first
+
+        # Raise error an error if file type isn't supported
+        raise TypeError unless renderable?
+
+        @data ||= renderable? ? construct(object) : nil
+      end
+
+      # @return [Symbol] data return base64 string of file
+      attr_reader :data
+
+      # Construct base64 blob from binary
+      # @param [String] file which are need to open
+      # @return [String] base64 data of binary file
+      def construct(object)
+        Base64.encode64(open(object).read)
+      end
+
+      # Helper method.
+      # Detect current kind such as (application, image, document) and so on of selected file
+      # @return [String] current kind of file
+      def kind
+        @mime.media_type.to_sym
+      end
+
+      # Helper method.
+      # Detect current type such as (.png, .pdf, .txt) and so on of se
+      # @return [String] current type of file
+      def type
+        @mime.sub_type
+      end
+
+      # Determine whether type is renderable
+      # @note Renderable Types and MIME's listed below in supported_types method
+      # @return [Boolean]
+      def renderable?
+        supported_types.key?(kind) && supported_types[kind].include?(type)
+      end
+
+      # Renderable types and kinds
+      def supported_types
+        {
+          image: %w(jpeg jpg png tiff gif)
+        }
+      end
+    end
+  end
+end

data/lib/iterm2/viewer/render.rb

@@ -0,0 +1,14 @@
+module Iterm2
+  module Viewer
+    # Render new object in terminal
+    # @param object [Iterm2::Viewer::Entity]
+    class Render
+      def initialize(object)
+        raise ArgumentError, "incorrect media file" unless object.is_a? Iterm2::Viewer::Media
+        # @see  http://iterm2.com/images.html
+        # @note based on https://raw.githubusercontent.com/gnachman/iTerm2/master/tests/imgcat
+        puts "\033]1337;File=;inline=1:#{object.data}\a\n"
+      end
+    end
+  end
+end

data/lib/iterm2/viewer/version.rb

@@ -1,5 +1,5 @@
 module Iterm2
   module Viewer
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

data/test/coverage/.last_run.json

@@ -0,0 +1,5 @@
+{
+  "result": {
+    "covered_percent": 100.0
+  }
+}

data/test/coverage/.resultset.json

@@ -0,0 +1,7 @@
+{
+  "MiniTest": {
+    "coverage": {
+    },
+    "timestamp": 1416492861
+  }
+}

data/test/lib/iterm2/viewer/test_media.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+class Media < Minitest::Test
+
+  def object_will_not_created_with_unsupported_type
+    skip "this test will pass later"
+  end
+
+  def object_will_be_rendered_with_supported_type
+    skip "this test will pass later"
+  end
+
+end

data/test/lib/iterm2/viewer/test_render.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class Render < Minitest::Test
+
+  def test_that_object_will_not_render_until_argument_isnt_set
+    assert_raises ArgumentError do
+      Render.new
+    end
+  end
+
+  def test_that_object_will_not_rendered_with_wrong_type_of_object
+      assert_raises ArgumentError do
+        Render.new "wrong type of object"
+      end
+  end
+
+  def test_that_object_will_render_with_correct_type_of_object
+    skip "this test will pass later"
+  end
+
+end

data/test/lib/iterm2/viewer/test_version.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+describe Iterm2::Viewer do
+    it "must be defined" do
+          Iterm2::Viewer::VERSION.wont_be_nil
+    end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/pride'
+require File.expand_path('../../lib/iterm2/viewer.rb', __FILE__)
+
+require 'codeclimate-test-reporter'
+
+CodeClimate::TestReporter.start

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iterm2-viewer
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Andrey
@@ -257,6 +257,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -265,7 +266,16 @@ files:
 - bin/iterm2-viewer
 - iterm2-viewer.gemspec
 - lib/iterm2/viewer.rb
+- lib/iterm2/viewer/media.rb
+- lib/iterm2/viewer/render.rb
 - lib/iterm2/viewer/version.rb
+- test/coverage/.last_run.json
+- test/coverage/.resultset.json
+- test/coverage/.resultset.json.lock
+- test/lib/iterm2/viewer/test_media.rb
+- test/lib/iterm2/viewer/test_render.rb
+- test/lib/iterm2/viewer/test_version.rb
+- test/test_helper.rb
 homepage: https://github.com/AndreyAntipov/iterm2-viewer
 licenses:
 - MIT
@@ -290,5 +300,12 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Display media files in iTerm2.
-test_files: []
+test_files:
+- test/coverage/.last_run.json
+- test/coverage/.resultset.json
+- test/coverage/.resultset.json.lock
+- test/lib/iterm2/viewer/test_media.rb
+- test/lib/iterm2/viewer/test_render.rb
+- test/lib/iterm2/viewer/test_version.rb
+- test/test_helper.rb
 has_rdoc: