branding 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3688ed4157906260e426018c08b5236dbcf7a75b
-  data.tar.gz: 3914f9b09f648a42dc171727409fb66ac35867f5
+  metadata.gz: 98c7c50a74686570bba45b496c478e1e3e34dbcc
+  data.tar.gz: 631b8ac04bd4f9aea66443e4c5224535bc32025d
 SHA512:
-  metadata.gz: ad2c13b8bba0648fd37e98a19e36e83ab17314ba96570738417d3d4257559eb018e3f499976676de023117afa4be2d23163dc220aad4611ba953fa4f804266a9
-  data.tar.gz: 853164e000f97ce4101213e664eec010a05bce557c099f2fdc116f7ff7cd46dc618f9a59ddc803e3620b43ba4ac6386723ce80d5c4bd053e7d4fb57487c5a5ec
+  metadata.gz: 575a40f1e189d2ceee0614e12e4773e8c73c4c90c46ca39cad7a3fcc781190f0a65ae59cdfaa23f69bb4483958c883cca484de3c70cbddcc3953d5b009fc3fad
+  data.tar.gz: 8526484d7c9776793bed44e8de82efb7f56f30c02c40dc4c963f01beb58733dc899c3edca79d5ba193bbfd279a3f54a39390f9e015df8dc5b7948eae3d929bfa

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.2

data/README.md

@@ -6,17 +6,19 @@ Proud of your code? Add some bling to your terminal.
 
 * No dependencies!
 * Pure Ruby PNG decoding in < 200 LoC
+* Hi-Res mode for 2x pixel density!
+* Hi-Color mode for 720 colors!!
 * Loads of fun!
 
 ## Quality
 
-Much quality:
+Much quality.
 
 ## How it works
 
 Branding will detect your Rails application's favicon. It adds a small
 initializer in development and testing environments that draws the favicon with
-ANSI control characters.
+ANSI control characters whenever you run tests, a rake task or boot the console.
 
 ## Installation
 

data/lib/branding/canvas.rb

@@ -4,14 +4,34 @@ module Branding
   class Canvas
     attr_reader :width, :height, :rows, :cols
 
-    def initialize(width:,height:)
+    def self.terminal_size
+      # TODO: make sure we can get this on linux
+      begin
+        `stty size`.split.map(&:to_i)
+      rescue
+        [40, 100]
+      end
+    end
+
+    def initialize(width:, height:)
       @width, @height = width, height
-      @rows, @cols = `stty size`.split.map { |x| x.to_i }
+      @rows, @cols = self.class.terminal_size
       @pixel_buffer = []
     end
 
-    def load(pixels)
-      Pixel2x.load_strategy(pixels, width: width, height: height) do |pixel|
+    def load(pixels, algo: :normal)
+      case algo
+      when :normal
+        klass = Pixel
+      when :hires
+        klass = Pixel2x
+      when :hicolor
+        raise 'Hi-Color coming soon!'
+      else
+        raise "Unknown pixel algo `#{algo}`"
+      end
+
+      klass.load_strategy(pixels, width: width, height: height) do |pixel|
         @pixel_buffer << pixel
       end
     end

data/lib/branding/cli.rb

@@ -6,13 +6,15 @@ module Branding
     def initialize(args)
       @options = OpenStruct.new
 
-      @options.command = :print_logo
       @options.file = args.last
 
       @parser = OptionParser.new do |opts|
         opts.banner = 'Usage: branding FILE'
-        opts.on('-a') do |algo|
-          @options = algo
+        opts.on('-p PIXEL',
+                '--pixel=PIXEL',
+                [:normal, :hires, :hicolor],
+                'The pixel rendering algorithm (`normal`, `hires`, or `hicolor`)') do |pixel_algo|
+          @options.algo = pixel_algo.to_sym
         end
 
         opts.on_tail('-h', '--help', 'Show this message') do
@@ -26,11 +28,8 @@ module Branding
     end
 
     def run
-      send(@options.command)
-    end
-
-    def print_logo
       logo = Branding::Logo.new(@options.file)
+      logo.algo = @options.algo
       logo.print
     end
   end

data/lib/branding/logo.rb

@@ -1,12 +1,15 @@
 module Branding
-  class Logo
+  class Logo # :nodoc:
+    attr_accessor :algo
+
     def initialize(path)
+      @algo = :normal
       @img = PNG.from_file(path)
       @canvas = Canvas.new(width: @img.width, height: @img.height)
     end
 
     def print
-      @canvas.load(@img.pixels)
+      @canvas.load(@img.pixels, algo: @algo)
       @canvas.print
       nil
     end

data/lib/branding/railtie.rb

@@ -3,21 +3,40 @@ module Branding
 
     unless Rails.env.production?
       initializer('branding.print_logo') do
-        logo = Branding::Logo.new(Branding::Railtie.favicons)
-        logo.print
+        begin
+          rows, cols = Canvas.terminal_size
+          ideal_width = cols / 6
+
+          logo = Branding::Logo.new(Branding::Railtie.best_icon(ideal_width))
+          logo.algo = :hires
+          logo.print
+          print "\n"
+        rescue
+          # We don't want to do anything if this causes an exception. Your time
+          # is too valuable to be dealing with busted amusement gems.
+        end
       end
     end
 
     ##
     # find the best suited icon in a rails app
-    def self.favicons
+    def self.best_icon(ideal_width)
+      paths = icon_paths.sort_by do |path|
+        png = PNG.from_file(path)
+        (ideal_width - png.width).abs
+      end
+
+      if paths.empty?
+      else
+        paths.first
+      end
+    end
+
+    def self.icon_paths
       paths = ["#{Rails.root}/public/", "#{Rails.root}/app/assets/images/"]
       file_patterns = ['favicon*.png', 'apple-touch-icon*.png']
       patterns = paths.product(file_patterns).map(&:join)
-
-      matches = Dir.glob(patterns)
-
-      matches.sort_by{|path| File.stat(path).size }.first
+      Dir.glob(patterns)
     end
   end
 end

data/lib/branding/version.rb

@@ -1,3 +1,3 @@
 module Branding
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/branding_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe Branding do
   it 'should have a version number' do
-    Branding::VERSION.should_not be_nil
+    expect(Branding::VERSION).to_not be_nil
   end
 end

data/spec/png_spec.rb

@@ -1,14 +1,12 @@
 require 'spec_helper'
 
 RSpec.describe Branding::PNG do
-  it 'returns a pixel matrix' do
+  it 'returns a pixel list' do
     png = Branding::PNG.from_file(fixture_file('test3x3.png'))
-    expect(png.pixels).to eq(
-      [
-        [0x111111, 0xc6c6c6, 0xffffff],
-        [0xc6c6c6, 0x111111, 0xc6c6c6],
-        [0xffffff, 0xc6c6c6, 0x111111]
-      ]
-    )
+    expect(png.pixels).to eq([
+      0x111111ff, 0xc6c6c6ff, 0xffffffff,
+      0xc6c6c6ff, 0x111111ff, 0xc6c6c6ff,
+      0xffffffff, 0xc6c6c6ff, 0x111111ff
+    ])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branding
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Stefan Natchev
@@ -90,6 +90,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -107,6 +108,7 @@ files:
 - lib/branding/railtie.rb
 - lib/branding/version.rb
 - spec/branding_spec.rb
+- spec/fixtures/test3x3.png
 - spec/pixel_spec.rb
 - spec/png_spec.rb
 - spec/spec_helper.rb
@@ -136,6 +138,7 @@ specification_version: 4
 summary: Print your logo to the terminal.
 test_files:
 - spec/branding_spec.rb
+- spec/fixtures/test3x3.png
 - spec/pixel_spec.rb
 - spec/png_spec.rb
 - spec/spec_helper.rb