lgtm_hd 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c41c2e01a27d7f6c8d8abeb1ab55d879c7301af8
-  data.tar.gz: 8276a44c7526c9fa68f5fbebba7b58b4049b84c8
+  metadata.gz: ff6fc3e47abef583c5dc6070508c93cef024e6da
+  data.tar.gz: aed3e2c80b96d2c35b65b9b9f365aa70e770e9a4
 SHA512:
-  metadata.gz: 6421eb054e6a2872df460ffc5a8b6c3603a8a94faaddef6b6e9ca52beed0e3004e8dd3e75801f3c087d7ba03ccd3c91e7895f89393b9d6e5689863f7e5743350
-  data.tar.gz: a2703a165f8e37526decb537b1f9aa4d89c02dc0f8a89a16a8265ac2cff18cdd810e86d635a640b4097e435a3dcc8effee80e0aa581164d3a8fb64b0347639e1
+  metadata.gz: a7c02822fbaec53939193c8245a414d322558c4825330aab6f0c5e93d5c6aac8e7cb5a50b200598bb9cbfca9d0c81edb2ba5187c150e747856343c3bbd73f811
+  data.tar.gz: 29c6b9830a8773e094af8762397c0d6c99cd45d280af11430e83c4b8044a78b1abb0c7243ee6b612a77f64147da46b316bb937a15555c65298a0e0f0c21ef5e1

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.3.0
+- Added live image previewing and option --preview
+- Fixed ?querystring after extension name
+## 0.2.x
+- Added command random for fetching LGTM image from LGTM.in
+- Improved CLI UI/UX
+## 0.1.0
+- The Big bang

data/README.md

@@ -16,36 +16,82 @@ Source             |  Happy Taeyeon!
 :-------------------------:|:-------------------------:
 ![](./images/example_2_before.png?raw=true)  |  ![](./images/example_2_after.jpg?raw=true)
 
+## Requirements
+
+This gem needs [imagemagick](https://www.imagemagick.org/) installed on local machine for image processing
+
+See if it has been installed already (should be able to see similar output like below)
+    
+    $ convert -version
+    Version: ImageMagick 6.9.2-6 Q16 x86_64 2015-11-15 http://www.imagemagick.org
+    Copyright: Copyright (C) 1999-2015 ImageMagick Studio LLC
+
+If not, follow below command to install it
+
+    # for Ubuntu, Debian
+    $ sudo apt-get install imagemagick libmagickwand-dev
+    
+    # for RHEL, CentOS, Fedora
+    $ yum install -y ImageMagick ImageMagick-devel
+    
+    # Mac with Brew
+    $ brew install imagemagick
+    # Mac with Port
+    $ sudo port install imagemagick
 
 ## Installation
 
     $ gem install lgtm_hd
-
+    
 ## Usage
 
+Add LGTM caption to image
+    
     $ lgtm_hd <source_image_uri>
+    
+Fetch random image from LGTM.in    
+    
     $ lgtm_hd random 
 
-    Options:
-    --clipboard (or -c) will let the OS copy content of the file for direct pasting to Github comment box
+Global Options:
+    
     --interactive (or -i) is for lazy people who can't bother to type
     --dest DIR (or -d) is for changing output folder
     Default command is transform so you can just leave the command empty.
     
-## Examples
+## Examples 
+
+Add LGTM caption to image (with output)
+
+    $ lgtm_hd http://nogitweet.com/wp-content/uploads/2015/03/fbf5c1c80ffea521bad6e231061731a5.gif
+      Reading and inspecting source at http://nogitweet.com/wp-content/uploads/2015/03/fbf5c1c80ffea521bad6e231061731a5.gif
+      Transforming Image
+      Exporting to file
+      Exported LGTM image to /Users/huydq/Desktop/lgtm_hd_20170529005457.gif
+      Copied file to OS's clipboard for direct pasting to Github comments or Slack
+    
+Fetch random image from LGTM.in (with output)
+    
+    $ bundle exec bin/lgtm_hd random
+      Fetching from lgtm.in
+      Loading image at http://www.storyofbing.com/pics3/ff0040_kids_thumbs_up_sharp_mooiplaas.jpg
+      Exported image to /Users/huydq/Works/lgtm_hd/lgtm_hd_20170529011541.jpg
+      Copied file to OS's clipboard for direct pasting to Github comments or Slack
+    
+      Or you can copy the markdown format below provided by lgtm.in
+      [![LGTM](https://lgtm.in/p/mdVnGXxym)](https://lgtm.in/i/mdVnGXxym)
+    
+      if the lgtm.in's image does not have LGTM texts on it, run the cmd below
+      lgtm_hd /Users/huydq/Works/lgtm_hd/lgtm_hd_20170529011541.jpg
+    
+Interaction Mode
 
-    $ lgtm_hd transform http://nogitweet.com/wp-content/uploads/2015/03/fbf5c1c80ffea521bad6e231061731a5.gif
-    \ Reading and inspecting source at http://nogitweet.com/wp-content/uploads/2015/03/fbf5c1c80ffea521bad6e231061731a5.gif
-    \ Processing Image
-    \ Exporting to file
-    \ Exported LGTM image to /Users/huydq/Desktop/lgtm_hd_20170527124831.gif.
+    $ lgtm_hd -i
+    -- LGTM HD Interactive Mode --
+    Source Image (URL or Path/to/file): lgtm_hd_20170527122725.jpg
+    Destination Directory (Enter to skip):
+    ...
     
-    $ lgtm_hd random -c -d /tmp/
-    \ Fetching random image from lgtm.in
-    \ Loading image at http://i.imgur.com/mHrrwpY.gif
-    \ Exported image to /tmp/lgtm_hd_20170527124027.gif
-    \ Copied file to OS's clipboard for direct pasting to Github comments or Slack
-    \ Or you can copy the markdown format by lgtm.in directly below
 
 ## Features
 
@@ -53,6 +99,7 @@ Source             |  Happy Taeyeon!
 * Source Image - Support Offline (file) or Online (url) 
 * Caption Position - Top Center or Bottom Center positions for the caption
 * Auto Clipboard - MacOSX user can just paste directly to comment box on Github after running the programm. On other OSes the clipboard only returns the path to the generated LGTM image.
+* Random image from LGTM.in
 * Formats - GIF, PNG, JPEG (SVG and TIFF not tested yet)
 * Max Image size is 500px by 500px
 
@@ -62,9 +109,8 @@ Source             |  Happy Taeyeon!
 * Add options for \[font size, positions\] (Code already setup for this, expect new version soon!)
 * Add --source-random option incase there is no source provided.
 * Add --caption-color for more colorful captions
-* Integration to lgtm.in
-    * Submission to lgtm.in
-    * Query lgtm or google images and return the first found item
+* Submission to lgtm.in
+* Keyword's based Query google images and return the first found item
 * Interactive mode with image preview in ASCII generation
 * Interactive mode that allow adjusting LGTM captions
 * Add progress bar for the whole generation process

data/lgtm_hd.gemspec

@@ -11,10 +11,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Huy Dinh"]
   spec.email         = ["phradion@gmail.com"]
 
-  spec.summary       = %q{CLI tool for generating images from user input with LGTM text on it, or fetching images from LGTM.in based on user's query. Finally put the image to clipboard. Support direct image pasting to Github and Slack on MacOSX.}
+  spec.summary       = %q{CLI tool for generating images from user input with LGTM text on it, or fetching images from LGTM.in based on user's query. Finally put the image to clipboard. Support direct image pasting to Github and Slack on MacOSX. Live preview on terminal as well!}
   spec.description   = %q{This gem is command-line tool for fetching random image from lgtm.in.
     It also provide tool to apply LGTM text based on input file/url with smart text colors and positions.
-    It also support direct clipboard paste to github's comment box or Slack on MacOSX.}
+    It also support direct clipboard paste to github's comment box or Slack on MacOSX.
+    Live preview on terminal as well!}
   spec.homepage      = "http://github.com/phradion/lgtm_hd"
   spec.license       = "MIT"
 
@@ -37,8 +38,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "3.6.0"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.0"
-  spec.add_runtime_dependency "commander", "4.4.3"
-  spec.add_runtime_dependency "clipboard", "1.1.1"
-  spec.add_runtime_dependency "os", "1.0.0"
-  spec.add_runtime_dependency "mini_magick", "4.7.0"
+  spec.add_runtime_dependency "commander", "~> 4.4.3"
+  spec.add_runtime_dependency "catpix_mini", "~> 0.1.0", ">= 0.1.0"
+  spec.add_runtime_dependency "clipboard", "~> 1.1.1"
+  spec.add_runtime_dependency "os", "~> 1.0.0"
+  spec.add_runtime_dependency "mini_magick", "~> 4.7.0"
 end

data/lib/lgtm_hd/cli.rb

@@ -2,23 +2,27 @@ require 'rubygems'
 require 'commander'
 require 'os'
 require 'clipboard'
+require 'catpix_mini'
 require 'uri'
 
 module LgtmHD
   class CLI
     include Commander::Methods
 
-    CMD_RANDOM_SYNTAX = 'lgtm_hd random [-i | --interactive] [-d | --dest DIR]'.freeze
-    CMD_TRANSFORM_SYNTAX = 'lgtm_hd <URI|FILE> [-i | --interactive] [-d | --dest <DIR>]'.freeze
+    CMD_RANDOM_SYNTAX = 'lgtm_hd random [options]'.freeze
+    CMD_TRANSFORM_SYNTAX = 'lgtm_hd <URI|FILE> [options]'.freeze
+    OPTIONS_SYNTAX = '[-i | --interactive] [-d | --destination <DIR>] [-p | --preview high|low|none]'
 
     def run
       program :name, LgtmHD::Configuration::PROGRAM_NAME
       program :version, LgtmHD::VERSION
       program :description, LgtmHD::Configuration::DESCRIPTION
+      program :help_formatter, Commander::HelpFormatter::TerminalCompact
 
       default_command :transform
       global_option '-i', '--interactive', 'Turn on interactive Mode. In case you forgot all these super complexive args and options' do say "-- LGTM HD Interactive Mode --" end
       global_option '-d', '--dest DIR', String, 'Directory to export the LGTM image to. Default value is user\'s current working directory'
+      global_option '-p', '--preview QUALITY', String, 'Quality of Image preview live on terminal at the end. Accepted values for QUALITY are [high, low, none]. Default value is high. Set to none for skipping'
 
       command :random do |c|
         c.syntax = CMD_RANDOM_SYNTAX
@@ -29,6 +33,7 @@ module LgtmHD
         c.action do |args, options|
           if options.interactive  # Interactive mode!
             options.dest ||= ask('Destination Directory (Enter to skip): ')
+            options.preview ||= ask('Image Preview Quality? [high|low|none] (Enter to skip)')
           end
           dest_dir = CLI.destination_dir(options.dest)
           dest_file_prefix = CLI.destination_file_prefix
@@ -40,11 +45,15 @@ module LgtmHD
           end
 
           say_ok "Exported image to #{dest_uri}"
+
+          show_preview dest_uri, options.preview
+
           copy_file_to_clipboard(dest_uri)
           say "\nOr you can copy the markdown format below provided by lgtm.in"
           say_code_block "#{image_markdown}"
           say "\nIf the image does not have LGTM texts on it, run the cmd below"
           say_code_block "lgtm_hd #{dest_uri}"
+
         end
       end
 
@@ -59,17 +68,19 @@ module LgtmHD
           if args.length >= 1
             source_uri = args[0]
           elsif options.interactive  # Interactive mode!
-            source_uri ||= ask(' Source Image (URL or Path/to/file): ')
+            source_uri ||= ask('Source Image (URL or Path/to/file): ')
             options.dest ||= ask('Destination Directory (Enter to skip): ')
+            options.preview ||= ask('Image Preview Quality [high|low|none] (Enter to skip): ')
           else
             # Since this is the default command so we will provide a little extra care for first-time user
             help_the_noobie
           end
 
           # Validate the inputs
+          source_uri = CLI.source_uri(source_uri)
           dest_dir = CLI.destination_dir(options.dest)
           check_uris(dest_dir, source_uri)
-          dest_file = File.join(dest_dir, CLI.destination_file_prefix + File.extname(source_uri))
+          dest_file = File.join(dest_dir, CLI.destination_file_prefix + CLI.extname(source_uri))
 
           # Do stuff with our LGTM meme
           say_step "Reading and inspecting source at #{source_uri}"
@@ -81,7 +92,8 @@ module LgtmHD
           say_step "Exporting to file"
           meme_generator.export do |output|
             say_ok "Exported LGTM image to #{output}."
-            copy_file_to_clipboard(dest_file)
+            show_preview output, options.preview
+            copy_file_to_clipboard output
           end # end of meme_generator.export block
         end # end of action
       end # end of command transform
@@ -90,16 +102,32 @@ module LgtmHD
     end # end run def
 
     def help_the_noobie
-      say "To add LGTM text:"
+      say_step "\nTo add LGTM text to image:"
       say_code_block CLI::CMD_TRANSFORM_SYNTAX
-      say "To fetch LGTM text:"
+      say_step "\nTo fetch random LGTM.IN image:"
       say_code_block CLI::CMD_RANDOM_SYNTAX
-      say "More Help:"
+      say_step "\nGlobal Options:"
+      say_code_block CLI::OPTIONS_SYNTAX
+      say_step "\nMore Help:"
       say_code_block "lgtm_hd --help"
-      say "\nVisit #{LgtmHD::Configuration::MORE_HELP_URL} for development purpose or more examples"
+      say_step "\nVisit #{LgtmHD::Configuration::MORE_HELP_URL} for development purpose or more examples\n"
       exit
     end
 
+    def show_preview(image_path, quality)
+      quality ||= 'high'
+      quality.downcase!
+      if quality.eql? "none" then return end
+      quality = 'high' unless quality.eql? 'low'
+
+      say_step "\nImage Preview"
+      CatpixMini::print_image image_path, {
+        :limit_y => 1.0,
+        :resolution => quality,
+        :center_x => false,
+        :center_y => true
+      }
+    end
 
     private
 
@@ -146,6 +174,15 @@ module LgtmHD
       end
     end
 
+    def self.source_uri(source_uri)
+      source_uri =~ URI::regexp ? source_uri : File.expand_path(source_uri)
+    end
+
+    def self.extname(source_uri)
+      ext = File.extname(source_uri)
+      ext.gsub(/\?.*/, '')
+    end
+
     def self.destination_dir(dest_dir)
       dest_dir ||= Dir.pwd
       File.expand_path(dest_dir)

data/lib/lgtm_hd/configuration.rb

@@ -7,7 +7,7 @@ module LgtmHD
                             "or fetching images from LGTM.in based on user's query.\n"\
                             "Finally put the image to clipboard.".freeze
     MORE_HELP_URL         = "https://github.com/phradion/lgtm_hd".freeze
-    
+
     # Output Image configurations
     OUTPUT_PREFIX         = "lgtm_hd_".freeze
     OUTPUT_MAX_WIDTH      = 500

data/lib/lgtm_hd/lgtmdotin.rb

@@ -46,7 +46,7 @@ module LgtmHD
       #
       begin
         data = uri.open('Accept' => 'application/json', redirect: false, ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE)
-        json = JSON.parse data.readlines.join("")
+        JSON.parse data.readlines.join("")
       rescue OpenURI::HTTPRedirect => redirect
         uri = redirect.uri # assigned from the "Location" response header
         retry if (limit -= 1) > 0

data/lib/lgtm_hd/meme_generator.rb

@@ -3,7 +3,7 @@ require "mini_magick"
 module LgtmHD
   class MemeGenerator
     @@caption_positions = {caption_position_top: "north center", caption_position_bottom: "south center"}
-    
+
     # TODO make options list for this class
     # TODO pass BLOB data into this class instead of paths
     def initialize(input_image_uri:, output_image_uri:)
@@ -38,7 +38,6 @@ module LgtmHD
       yield @output_image_uri if block_given?
     end
 
-
   private
 
     def image

data/lib/lgtm_hd/version.rb

@@ -1,3 +1,3 @@
 module LgtmHD
-  VERSION         = "0.2.0".freeze
+  VERSION         = "0.3.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lgtm_hd
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Huy Dinh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-28 00:00:00.000000000 Z
+date: 2017-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,62 +84,83 @@ dependencies:
   name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.4.3
+- !ruby/object:Gem::Dependency
+  name: catpix_mini
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: clipboard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: os
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.7.0
 description: |-
   This gem is command-line tool for fetching random image from lgtm.in.
       It also provide tool to apply LGTM text based on input file/url with smart text colors and positions.
       It also support direct clipboard paste to github's comment box or Slack on MacOSX.
+      Live preview on terminal as well!
 email:
 - phradion@gmail.com
 executables:
@@ -150,6 +171,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -193,5 +215,6 @@ signing_key:
 specification_version: 4
 summary: CLI tool for generating images from user input with LGTM text on it, or fetching
   images from LGTM.in based on user's query. Finally put the image to clipboard. Support
-  direct image pasting to Github and Slack on MacOSX.
+  direct image pasting to Github and Slack on MacOSX. Live preview on terminal as
+  well!
 test_files: []