iterm2-viewer 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e669b5969e6184f423ac372b5fc2dec5d8a29f40
-  data.tar.gz: ce0019766d06fc9b4f263ed531033e252268df0c
+  metadata.gz: 832d19f977fb9f52c754339921906db1b41975e0
+  data.tar.gz: a5ea41ede95ac467e297d87df41f702d0d2f381a
 SHA512:
-  metadata.gz: 3645f7d37581fd296342db543c593b2d31e6787b3894951db07097657167ef454a11f37ae3449bb514b1cdecd649a6ebc493410dd8d1c1f49f4be45e7d49556b
-  data.tar.gz: 56e3b46fd2d1455445f6d0179e2679f4b6dd89f5db3abe42b56751143d3130f628c3b01b250c9bf47476d591482922983b32da6b44921d952174b36d582d31d6
+  metadata.gz: 82a9726452593757dc86e15ab3cd3b2b1569fa7ff9d1ceff89eae82ba90c75e4766a3095a7f7bbd265a0e5bd143a7212f47cc649acad5f18081b43cc123f7686
+  data.tar.gz: 36852f9fc8071c2cc71b85da6d7adefcba7bbc3ce074a2b8c26f601f6cb7930381ee3825688578185acf049eeb336515f2363b0dbbac0d83f7bb6069bb1e05ba

data/.cfg.reek

@@ -0,0 +1,3 @@
+---
+UncommunicativeMethodName:
+  enabled: false

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Style/FileName:
+    Enabled: false
+
+Metrics/LineLength:
+      Max: 100
+
+AllCops:
+    Exclude:
+        - 'Guardfile'
+        - '*.gemspec'

data/.travis.yml

@@ -1,11 +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
+  - 1.8.7
+addons:
+    code_climate:
+        repo_token: ab8664da98d6bfb6a14e4bd439bb87efe95b19785f42ba496077b3fd5ef3ecc3
+install: bundle install
+cache: bundler

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+lib/test/**/*.rb
+-
+*.txt

data/Gemfile

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

data/Guardfile

@@ -24,7 +24,8 @@ guard :yard do
   watch(%r{lib/.+\.rb})
 end
 
-guard :minitest do
+guard :minitest, all_after_pass: true do
+#guard :minitest do
   # with Minitest::Unit
   watch(%r{^test/(.*)\/?test_(.*)\.rb$})
   watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }

data/README.md

@@ -4,9 +4,12 @@
 [![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
+# 💎 iterm2-viewer
+Utility for view images in the terminal
+
+📎 Note: currently work only in mac iTerm2-nightly
+
 
-Display media files in terminal. iTerm2-nightly is required
 
 ## Supported types
     - png
@@ -14,6 +17,8 @@ Display media files in terminal. iTerm2-nightly is required
     - tiff
     - gif
 
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -30,6 +35,8 @@ Or install it yourself as:
 
     $ gem install iterm2-viewer
 
+
+
 ## Usage
 
 ```ruby
@@ -39,20 +46,30 @@ display multiple images
 ```ruby
 iterm2-viewer IMAGE_FILE_1_PATH IMAGE_FILE_2_PATH
 ```
---- 
 
+##### Options
+| Key               |  Action                       |
+|:------------------|:-----------------------------:|
+| `-v` or `--version`   |  show current version         |
+
+
+## How it look like
 ![How it look like 1](https://raw.githubusercontent.com/AndreyAntipov/iterm2-viewer/media/screenshot_1.png "How it look like 1")
 
 ![How it look like 2](https://raw.githubusercontent.com/AndreyAntipov/iterm2-viewer/media/screenshot_2.png "How it look like 2")
 
 --- 
 
+
+
 ## License
 
 The MIT License (MIT) 
 
 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 in [LICENSE.txt](https://github.com/AndreyAntipov/iterm2-viewer/blob/master/LICENSE.txt)
 
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/AndreyAntipov/iterm2-viewer/fork )

data/Rakefile

@@ -1,9 +1,13 @@
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-    t.libs << 'test'
-    # t.warning = true
-    #t.verbose = true
-    t.pattern = "test/**/test_*.rb"
+  t.libs << 'test'
+  t.pattern = 'test/**/test_*.rb'
 end
-task :default => [:test]
+
+desc 'Guard'
+task :guard do
+  exec('bundle exec guard')
+end
+
+task default: [:test]

data/bin/iterm2-viewer

@@ -7,21 +7,21 @@ $LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
 require 'iterm2/viewer'
 
 module Iterm2
+  # Display media files in command line
   module Viewer
     # Command line interface
     # @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"
-
+      def show(arguments)
         # 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
-          end
-        end
-       end
+        return unless ENV['TERM_PROGRAM'] == 'iTerm.app'
+
+        # show current version
+        puts VERSION if arguments[0].to_s == '--version' || arguments[0].to_s == '-v'
+
+        # initialize routes
+        arguments.each { |route| Render.new(Media.new route) if File.file? route }
+      end
     end
   end
 end

data/iterm2-viewer.gemspec

@@ -6,10 +6,11 @@ require 'iterm2/viewer/version'
 Gem::Specification.new do |spec|
   spec.name          = 'iterm2-viewer'
   spec.version       = Iterm2::Viewer::VERSION
-  spec.authors       = ['Andrey']
+  spec.authors       = ['Andrey Antipov']
   spec.email         = ['andrey@antipov.me']
-  spec.summary       = %q{Display media files in iTerm2.}
-  spec.description   = %q{Display media files in terminal. iTerm2 is required}
+  spec.summary       = %q(Utility for view images in the terminal)
+  spec.description   = %q(Utility for view images in the terminal. iTerm2-nightly is required)
+  spec.extra_rdoc_files = ['LICENSE.txt', 'README.md']
   spec.homepage      = 'https://github.com/AndreyAntipov/iterm2-viewer'
   spec.license       = 'MIT'
 

data/lib/iterm2/viewer.rb

@@ -3,6 +3,7 @@ require 'iterm2/viewer/media'
 require 'iterm2/viewer/render'
 
 module Iterm2
+  # Display media files in command line
   module Viewer
   end
 end

data/lib/iterm2/viewer/media.rb

@@ -6,11 +6,14 @@ module Iterm2
       require 'mime/types'
       require 'base64'
 
+      # Validate and construct media object
+      #
+      # @param object [String] file path which are need to open
       def initialize(object)
         @mime ||= MIME::Types.of(object).first
 
         # Raise error an error if file type isn't supported
-        raise TypeError unless renderable?
+        fail TypeError unless renderable?
 
         @data ||= renderable? ? construct(object) : nil
       end
@@ -19,14 +22,16 @@ module Iterm2
       attr_reader :data
 
       # Construct base64 blob from binary
-      # @param [String] file which are need to open
+      #
+      # @param object [String] file path 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
+      # Detect current kind such as (application, image, document)
+      #
       # @return [String] current kind of file
       def kind
         @mime.media_type.to_sym
@@ -34,6 +39,7 @@ module Iterm2
 
       # 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

data/lib/iterm2/viewer/render.rb

@@ -4,9 +4,9 @@ module Iterm2
     # @param object [Iterm2::Viewer::Entity]
     class Render
       def initialize(object)
-        raise ArgumentError, "incorrect media file" unless object.is_a? Iterm2::Viewer::Media
+        fail 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
+        # @note https://raw.githubusercontent.com/gnachman/iTerm2/master/tests/imgcat
         puts "\033]1337;File=;inline=1:#{object.data}\a\n"
       end
     end

data/lib/iterm2/viewer/version.rb

@@ -1,5 +1,7 @@
 module Iterm2
+  # Display media files in command line
   module Viewer
-    VERSION = '0.0.5'
+    # Current version of application
+    VERSION = '0.0.6'
   end
 end

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

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

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

@@ -1,7 +1,7 @@
 require 'test_helper'
 
+# Testing render class
 class Render < Minitest::Test
-
   def test_that_object_will_not_render_until_argument_isnt_set
     assert_raises ArgumentError do
       Render.new
@@ -9,13 +9,10 @@ class Render < Minitest::Test
   end
 
   def test_that_object_will_not_rendered_with_wrong_type_of_object
-      assert_raises ArgumentError do
-        Render.new "wrong type of object"
-      end
+    skip 'this test will pass later'
   end
 
   def test_that_object_will_render_with_correct_type_of_object
-    skip "this test will pass later"
+    skip 'this test will pass later'
   end
-
 end

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

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

data/test/media/unsupported

@@ -0,0 +1 @@
+plain text

data/test/test_helper.rb

@@ -1,8 +1,9 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
+
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iterm2-viewer
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
-- Andrey
+- Andrey Antipov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-20 00:00:00.000000000 Z
+date: 2014-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -248,16 +248,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Display media files in terminal. iTerm2 is required
+description: Utility for view images in the terminal. iTerm2-nightly is required
 email:
 - andrey@antipov.me
 executables:
 - iterm2-viewer
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
 files:
+- ".cfg.reek"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -269,12 +274,11 @@ files:
 - 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/media/supported
+- test/media/unsupported
 - test/test_helper.rb
 homepage: https://github.com/AndreyAntipov/iterm2-viewer
 licenses:
@@ -299,13 +303,12 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Display media files in iTerm2.
+summary: Utility for view images in the terminal
 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/media/supported
+- test/media/unsupported
 - test/test_helper.rb
 has_rdoc: 

data/test/coverage/.last_run.json

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

data/test/coverage/.resultset.json

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