lgtm_hd 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cb60a766e51ba4e5afa496f4ece6c1ed2178213
-  data.tar.gz: 32f930d5fd406cb6fcb8530343910a6d7d796e69
+  metadata.gz: 690ffa92888775481986a81d37f5283cb85b5736
+  data.tar.gz: 9004f97a6135757b9206b11af5189f6af79c5d8e
 SHA512:
-  metadata.gz: e55c1aadd8ac434d1bf3223d60dcb0a53520c77996bf6b2a6797f6ebeabb1b7d10cc799cea044fed065a706ee35088c6ede16625c25c9614be943431b9dfc71a
-  data.tar.gz: f20e482210fa657059447b2cd52f1479be3b2bc13aee251f1b18dc4fa6e636eb59702b2edd9041124f5968cfe490b0d449bce3727542da44c3eadf4b5ab47284
+  metadata.gz: 3be3ee8b19592dbcf5be3d03df690a0f24bab103b318ea0953d2c9fa571fe50ed8d03a1536c4141c85ce5b86b115d5a4e646a6a63ca402a4bf36a8a19856464d
+  data.tar.gz: 977302599a8bd739e8e7ee0900a7d19542850ee017e0bae2e41484316642844d690b89498ddcf082869b164780e13964a2ae3a6ad2176246c983cda752e4d508

data/.travis.yml

@@ -2,3 +2,9 @@ language: ruby
 rvm:
   - 2.2.3
 before_install: gem install bundler -v 1.10.6
+addons:
+  code_climate:
+    repo_token: f8de4766221c1d212d7c884d1415314f1c55a24c1a58e16db530efbf155d1ad3
+# regular test configuration
+after_success:
+  - bundle exec codeclimate-test-reporter

data/README.md

@@ -23,10 +23,14 @@ Source             |  Happy Taeyeon!
 
 ## Usage
 
-    $ lgtm_hd [transform] <source> <output> [--clipboard]
+    $ lgtm_hd [transform] <source_uri> <output_folder> [--clipboard] [--interactive]
     $ lgtm_hd http://domain.com/image.jpg /path/lgtm.jpg 
 
-    # Default command is transform so you can just leave the command empty.
+
+    --clipboard will let the OS copy content of the file for direct pasting to Github comment box
+    --interactive is for lazy people who can\'t bother to type
+    Default command is transform so you can just leave the command empty.
+
 
 ## Features
 

data/bin/lgtm_hd

@@ -1,4 +1,3 @@
 #!/usr/bin/env ruby
-require "lgtm_hd/cli"
-
-LgtmHD::CLI.new.run #if $0 == __FILE__
+require "lgtm_hd"
+LgtmHD::CLI.new.run

data/lgtm_hd.gemspec

@@ -33,6 +33,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   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"

data/lib/lgtm_hd.rb

@@ -1,123 +1,5 @@
+require "lgtm_hd/version"
 require "lgtm_hd/configuration"
-require "mini_magick"
-require "rubygems"
-
-module LgtmHD
-
-  class MemeGenerator
-    attr_accessor :input_image_URI, :output_image_URI
-
-    # 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)
-      @input_image_URI = input_image_URI
-      @output_image_URI = output_image_URI
-
-      @img = MiniMagick::Image.open(@input_image_URI)
-      @caption_position = :caption_position_bottom
-    end
-
-    ##
-    # Used to create a new Image object data-copy. Not used to "paint" or
-    # that kind of thing.
-    #
-    # @param caption_text [String] Specify the caption for your LGTM meme
-    # @return [MiniMagick::Image] The drawn image
-    #
-    def draw (caption_text = "LGTM")
-      if @img.respond_to? (:combine_options) then
-        @img.combine_options do |c|
-          c.gravity captionPosition()
-          c.draw "text 0,0 " << "#{caption_text}"
-          c.font captionFont
-          c.pointsize captionFontSize
-          c.density imageDensity
-          c.fill captionColor
-          c.resize imageMaxSize().reduce() {|w,h| w << 'x' << h} # syntax: convert -resize $wx$h
-        end
-        @img.contrast
-      end
-      yield @img if block_given?
-    end
-
-    def export
-      @img.write(@output_image_URI)
-      yield @output_image_URI if block_given?
-    end
-
-
-  private
-
-    def imageMaxSize
-      [Configuration::OUTPUT_MAX_WIDTH.to_s, Configuration::OUTPUT_MAX_HEIGHT.to_s]
-    end
-
-    ##
-    # @return [String] the position of image
-    # Could be either :caption_position_top or :caption_position_bottom
-    #
-    def captionPosition ()
-      if not [:caption_position_top, :caption_position_bottom].include? (@caption_position)
-        @caption_position = :caption_position_top
-      end
-      return {:caption_position_top => "north center",
-              :caption_position_bottom => "south center"}[@caption_position]
-    end
-
-    def captionFont
-      '' << LgtmHD.root << Configuration::FONT_PATH
-    end
-
-    def captionFontSize
-      Configuration::CAPTION_FONT_SIZE_DEFAULT
-    end
-
-    def imageDensity
-      Configuration::OUTPUT_DENSITY
-    end
-
-    ##
-    # Decide foreground color depending on background color
-    # https://en.wikipedia.org/wiki/Rec._601
-    #
-    # We use this method that include magic numbers .241, .691, .068 accroding to
-    # the provided wikipedia link
-    # Math.Sqrt(
-    # c.R * c.R * .241 +
-    # c.G * c.G * .691 +
-    # c.B * c.B * .068)
-    #
-    # Magic cut off number is 130.
-    # Under 130 is too dark, so the foreground color is white
-    # Above is too bright so the foreground color is black
-    #
-    # @return [String] the foreground color of caption
-    #
-    def captionColor
-      # Copy current image data instead of working directly on working file
-      img = MiniMagick::Image.read(@img.to_blob)
-
-      # cutoff's x is always 0 as we only support top or bottom right now
-      cutoff_y = @caption_position == :caption_position_bottom ? (img.height/2).round : 0
-      img.crop("#{img.width}x#{img.height/2}+0+#{cutoff_y}")
-
-      # Since we are getting
-      img = img.resize('1x1')
-      rgb = img.get_pixels[0][0] # Only 1x1 pixel remember? ^_^
-      color = {}
-      ['r','g','b'].zip(rgb) { |k,v| color[k] = v }
-
-      magic_color_value = color['r'] * color['r'] * 0.241
-      magic_color_value += color['g'] * color['g'] * 0.691
-      magic_color_value += color['b'] * color['b'] * 0.068
-      magic_color_value = Math.sqrt(magic_color_value)
-
-      return (magic_color_value.round > 130) ? "#000000" : "#FFFFFF"
-    end
-
-  end # End of Class
-
-  def self.root
-    File.expand_path '../..', __FILE__
-  end
-end # End of Module
+require "lgtm_hd/utilities"
+require "lgtm_hd/meme_generator"
+require "lgtm_hd/cli"

data/lib/lgtm_hd/cli.rb

@@ -1,15 +1,9 @@
 require 'rubygems'
 require 'commander'
 require 'os'
-require 'net/http'
-require 'tempfile'
 require 'clipboard'
 require 'uri'
 
-require 'lgtm_hd'
-require 'lgtm_hd/version'
-require 'lgtm_hd/configuration'
-
 module LgtmHD
   class CLI
     include Commander::Methods
@@ -21,7 +15,7 @@ module LgtmHD
       default_command :transform
 
       command :transform do |c|
-        c.syntax = 'lgtm_hd transform <source_uri> <output_uri> [options]'
+        c.syntax = 'lgtm_hd <source_uri> <output_path> [--clipboard] [--interactive]'
         c.summary = 'Generate a LGTM image from source_uri (local path or URL) into output folder'
         c.description = ''
         c.example '', 'lgtm_hd export http://domain.com/image.png /path/to/lgtm.png'
@@ -32,37 +26,34 @@ module LgtmHD
           to_clipboard = options.clipboard
 
           # ARGS validation!
-          if args.length == 2 then
+          if args.length == 2
               source_uri = args[0]
               output_uri = args[1]
-
           elsif options.interactive  # Interactive mode!
             say "-- LGTM Interactive mode --"
             source_uri = ask('Source (URL or Path/to/file): ')
-            output_uri = ask('Output Folder (absolute path): ')
-            # TODO accept relative path "~/.."
+            output_uri = ask('Output Folder: ')
             to_clipboard = agree("Copy to clipboard afterward? [Y/N]")
           else
-            raise "Too few or too many arguments provided. Need 2: source and output URIs."
+            say "usage: lgtm_hd <source_uri> <output_path> [--clipboard] [--interactive]"
+            raise ArgumentError, "Too few or too many arguments provided, need 2: source and output URIs"
           end
 
 
           # Validate the inputs
-          unless (source_uri =~ URI::regexp or File.exist?(source_uri)) then
-            # Part of the reason why I fucking hate #unless. No reason.
-            raise "Source is not proper URIs (URL or Path/to/file)"
-          end
+          output_folder = File.expand_path(output_uri)
+          output_file = File.join(output_folder,
+                                  LgtmHD::Configuration::OUTPUT_PREFIX +
+                                  Time.now.strftime('%Y-%m-%d_%H-%M-%S') +
+                                  File.extname(source_uri))
+          raise "Source is not proper URIs (URL or Path/to/file)" unless source_uri =~ URI::regexp || File.exist?(source_uri)
+          raise "Output is invalid path or directory" unless File.exist?(output_folder) && File.directory?(output_folder)
 
-          unless File.exist?(output_uri) and File.directory?(output_uri) then
-            raise "Output is not a directory or valid path"
-          end
 
-          file_ext = File.extname(source_uri)
-          output_uri = File.join(output_uri, "" << LgtmHD::Configuration::OUTPUT_PREFIX << Time.now.strftime('%Y-%m-%d_%H-%M-%S') << file_ext)
 
           # Do stuff with our LGTM meme
           say "- Reading and inspecting source"
-          meme_generator = MemeGenerator.new(source_uri, output_uri)
+          meme_generator = MemeGenerator.new(input_image_uri:source_uri, output_image_uri:output_file)
           say "- Rendering output"
           meme_generator.draw
 

data/lib/lgtm_hd/configuration.rb

@@ -1,18 +1,18 @@
 module LgtmHD
   module Configuration
     # Program configurations
-    PROGRAM_NAME      = "lgtm_hd"
-    DESCRIPTION       = "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."
+    PROGRAM_NAME          = "lgtm_hd".freeze
+    DESCRIPTION           = "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.".freeze
 
     # Output Image configurations
-    OUTPUT_PREFIX    = "lgtm_tmp_"
-    OUTPUT_MAX_WIDTH    = 500
-    OUTPUT_MAX_HEIGHT   = 500
-    OUTPUT_DENSITY      = 90 # or 120 point per inch
+    OUTPUT_PREFIX         = "lgtm_hd_".freeze
+    OUTPUT_MAX_WIDTH      = 500.freeze
+    OUTPUT_MAX_HEIGHT     = 500.freeze
+    OUTPUT_DENSITY        = 90.freeze # or 120 point per inch
 
     # Caption configurations
-    FONT_PATH           = "/fonts/impact.ttf"
-    CAPTION_FONT_SIZE_DEFAULT = 96
+    FONT_PATH                   = "/fonts/impact.ttf".freeze
+    CAPTION_FONT_SIZE_DEFAULT   = 96.freeze
 
   end
 end

data/lib/lgtm_hd/meme_generator.rb

@@ -0,0 +1,118 @@
+require "mini_magick"
+
+module LgtmHD
+  class MemeGenerator
+
+    # 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:)
+      @input_image_uri = input_image_uri
+      @output_image_uri = output_image_uri
+    end
+
+    ##
+    # Used to create a new Image object data-copy. Not used to "paint" or
+    # that kind of thing.
+    #
+    # @param caption_text [String] Specify the caption for your LGTM meme
+    # @return [MiniMagick::Image] The drawn image
+    #
+    def draw(caption_text = "LGTM")
+      img = image
+      img.combine_options do |c|
+        c.gravity caption_position
+        c.draw "text 0,0 " << caption_text
+        c.font caption_font
+        c.pointsize caption_font_size
+        c.density image_density
+        c.fill caption_color
+        c.resize image_max_size().reduce() {|w,h| "#{w}x#{h}"} # syntax: convert -resize $wx$h
+        img.contrast
+      end
+      yield img if block_given?
+    end
+
+    def export
+      image.write(@output_image_uri)
+      yield @output_image_uri if block_given?
+    end
+
+
+  private
+
+    def image
+      @image ||= MiniMagick::Image.open(@input_image_uri)
+    end
+
+    def image_max_size
+      [Configuration::OUTPUT_MAX_WIDTH, Configuration::OUTPUT_MAX_HEIGHT]
+    end
+
+    ##
+    # @return [String] the position of image
+    # Could be either :caption_position_top or :caption_position_bottom
+    # Default value is top
+    #
+    def caption_position
+      if not [:caption_position_top, :caption_position_bottom].include? (@caption_position)
+        @caption_position = :caption_position_bottom
+      end
+      return {:caption_position_top => "north center",
+              :caption_position_bottom => "south center"}[@caption_position]
+    end
+
+    def caption_font
+      File.join(LgtmHD::gem_root, Configuration::FONT_PATH)
+    end
+
+    def caption_font_size
+      Configuration::CAPTION_FONT_SIZE_DEFAULT
+    end
+
+    def image_density
+      Configuration::OUTPUT_DENSITY
+    end
+
+    ##
+    # Decide foreground color depending on background color
+    # https://en.wikipedia.org/wiki/Rec._601
+    #
+    # We use this method that include magic numbers .241, .691, .068 accroding to
+    # the provided wikipedia link
+    # Math.Sqrt(
+    # c.R * c.R * .241 +
+    # c.G * c.G * .691 +
+    # c.B * c.B * .068)
+    #
+    # Magic cut off number is 130.
+    # Under 130 is too dark, so the foreground color is white
+    # Above is too bright so the foreground color is black
+    #
+    # @return [String] the foreground color of caption
+    #
+    def caption_color
+      # Copy current image data instead of working directly on working file
+      # because ImageMagick apply change directly to the temporary working file instead of keep changes in memory
+      # Might need to invest a bit further to ensure this, as for now, lazy..
+      temp_img = MiniMagick::Image.read(image.to_blob)
+
+      # cutoff's x is always 0 as we only support top or bottom right now
+      cutoff_y = @caption_position == :caption_position_bottom ? (temp_img.height/2).round : 0
+      temp_img.crop("#{temp_img.width}x#{temp_img.height/2}+0+#{cutoff_y}")
+
+      # Since we are getting
+      temp_img = temp_img.resize('1x1')
+      rgb = temp_img.get_pixels[0][0] # Only 1x1 pixel remember? ^_^
+      color = {}
+      ['r','g','b'].zip(rgb) { |k,v| color[k] = v }
+
+      magic_color_value = color['r'] * color['r'] * 0.241
+      magic_color_value += color['g'] * color['g'] * 0.691
+      magic_color_value += color['b'] * color['b'] * 0.068
+      magic_color_value = Math.sqrt(magic_color_value)
+
+      (magic_color_value.round > 130) ? "#000000" : "#FFFFFF"
+    end
+
+  end # End of Class
+end # End of module

data/lib/lgtm_hd/utilities.rb

@@ -0,0 +1,5 @@
+module LgtmHD
+  def self.gem_root
+    File.expand_path '../../..', __FILE__
+  end
+end # End of Module

data/lib/lgtm_hd/version.rb

@@ -1,3 +1,3 @@
 module LgtmHD
-  VERSION         = "0.1.3"
+  VERSION         = "0.1.4".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lgtm_hd
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Huy Dinh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2017-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: commander
   requirement: !ruby/object:Gem::Requirement
@@ -134,6 +162,8 @@ files:
 - lib/lgtm_hd.rb
 - lib/lgtm_hd/cli.rb
 - lib/lgtm_hd/configuration.rb
+- lib/lgtm_hd/meme_generator.rb
+- lib/lgtm_hd/utilities.rb
 - lib/lgtm_hd/version.rb
 homepage: http://github.com/phradion/lgtm_hd
 licenses: