favicon-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5db5d4cde3f3c229fb62918f0fcf1a953353cce
+  data.tar.gz: bceebac2bafab41aabe2af2e51a187d64df50594
+SHA512:
+  metadata.gz: 6cfa612c66fa02c6fc5d1c34d8ee407d3135a62aaf703ca349e6aea080ba8bd8c889e0c5ceb3ca2f7ea3003a00575172f5339667c4b6b6613daeb2e71771394c
+  data.tar.gz: 2e76db4cd3e27ad4dfd47b59a0c7e4a1b1b370f51006f1ab541a87301b0a2dceaafc108a4019e39e83c1b877bc9ed493b1191d563b7abadcf33fef6c0a8527ca

data/.autotest

@@ -0,0 +1,25 @@
+# -*- ruby -*-
+
+require "autotest/restart"
+
+# Autotest.add_hook :initialize do |at|
+#   at.testlib = "minitest/unit"
+#
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception "vendor"
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/.gitignore

@@ -0,0 +1,54 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.DS_Store
+*.swp
+*.swo

data/.hoeignore

@@ -0,0 +1,15 @@
+test/*
+bin/*
+.git/*
+
+*.swp
+.*.swp
+**/*.swp
+**/.*.swp
+*.sw?
+.*.sw?
+**/*.sw?
+**/.*.sw?
+
+.DS_Store
+**/.DS_Store

data/Gemfile

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+# DO NOT EDIT THIS FILE. Instead, edit Rakefile, and run `rake bundler:gemfile`.
+
+source "https://rubygems.org/"
+
+gem "ico", "0.1.1"
+
+gem "minitest", "~>5.10", :group => [:development, :test]
+gem "hoe-yard", ">=0.1.3", :group => [:development, :test]
+gem "hoe-ignore", "~>1.0", :group => [:development, :test]
+gem "hoe-bundler", "~>1.2", :group => [:development, :test]
+gem "hoe-gemspec", "~>1.0", :group => [:development, :test]
+gem "hoe-git", "~>1.6", :group => [:development, :test]
+gem "yard", "~>0.8", :group => [:development, :test]
+gem "redcarpet", "~>3.3", :group => [:development, :test]
+gem "hoe", "~>3.16", :group => [:development, :test]
+
+# vim: syntax=ruby

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.0.1 / 2017-04-02
+
+* It's alive!
+
+  * Bornday!
+

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2017 Bordee Inc.
+
+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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,11 @@
+.autotest
+.gitignore
+.hoeignore
+Gemfile
+History.txt
+LICENSE
+Manifest.txt
+README.md
+Rakefile
+lib/favicon.rb
+lib/favicon/version.rb

data/README.md

@@ -0,0 +1,126 @@
+# Favicon
+
+  favicon.ico generator in Ruby without imagemagick
+
+## Usage
+
+```
+#
+# PNG to favicon.ico standard sizes for 2017
+#
+# https://github.com/audreyr/favicon-cheat-sheet#ico-file
+# SIZES_ARRAY = [16, 24, 32, 48, 64]
+#
+# @param  input_filename   [String] "/path/to/example.png"
+# @param  output_filename  [String] "/path/to/favicon.ico"
+# @param  sizes_array      [Array<Array<Int,Int>>, Array<Int>]  
+#   rectangles use Array with XY: `[x,y]`
+#   squares use single Integer `N`
+#   mixed indices is valid
+#   example: `[24, [24,24], [480,270], 888] # a[0] => 24x24; a[1] => 24x24; a[2] => 480x270; a[3] => 888x888`
+# @return                  [String] filename of generated ico
+#
+#def png_to_favicon(input_filename, output_filename, sizes_array=SIZES_ARRAY)
+# ...
+
+require 'favicon'
+
+input_filename  = "/path/to/example.png"
+output_filename = "/path/to/favicon.ico"
+
+# standard sizes
+Favicon.png_to_ico(input_filename, output_filename)
+
+# custom sizes
+Favicon.png_to_ico(input_filename, output_filename, [16,92,256])
+
+```
+
+## Installation
+
+Command Line
+
+```
+gem install favicon-ruby
+```
+
+Gemfile
+
+```
+gem "favicon-ruby", "~>0.1"
+```
+
+## Development
+
+(soon)
+
+### Dev Requirements
+
+* [hoe](https://github.com/seattlerb/hoe) gem manager
+* [hoe-bundler] may need `gem install hoe-bundler` installation before using `rake bundler:gemfile`
+* [YARD](http://yardoc.org) docs
+* [redcarpet](https://github.com/vmg/redcarpet) for yardoc
+
+    [hoe-bundler]: https://github.com/flavorjones/hoe-bundler
+
+### Testing
+
+Tests written with [minitest]
+
+```
+rake test
+```
+
+  [minitest]: https://github.com/seattlerb/minitest
+
+### Contributing
+
+Send tested code.
+Thank you, [contributors]!
+
+  [contributors]: https://github.com/bordeeinc/favicon-ruby/graphs/contributors
+
+### To Do
+
+* (soon)
+
+## License
+
+MIT License
+
+Copyright (c) 2017 Bordee Inc.
+
+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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+## About
+
+![bordee](http://bordee.com/src/img/surf-with-bordee-github.png)
+
+favicon-ruby is maintained and funded by Bordee Inc.
+The names and logos for Bordee are trademarks of [Bordee Inc.][bordeeinc]
+
+  [bordeeinc]: http://bordee.com
+
+We love open source software!
+See [our other projects][bordee-github]
+and [check out Seattle.rb!][community]
+
+  [bordee-github]: https://github.com/bordeeinc
+  [community]: https://seattlerb.org

data/Rakefile

@@ -0,0 +1,61 @@
+# -*- ruby -*-
+
+require "rubygems"
+require "hoe"
+require './lib/favicon/version.rb'
+
+Hoe.plugin :gemspec
+Hoe.plugin :minitest
+Hoe.plugin :yard
+Hoe.plugin :bundler
+Hoe.plugin :git
+Hoe.plugin :ignore
+
+Hoe.spec "favicon" do
+  developer("So Awesome Man", "callme@1800aweso.me")
+
+  license "MIT" # this matches the license in the README
+
+  self.email                = 'support@bordee.com'
+
+  self.name                 = 'favicon-ruby'
+  self.version              = Favicon::VERSION
+  self.summary              = 'favicon.ico generator in Ruby without imagemagick'
+  self.description          = self.summary
+  self.urls                 = ['https://github.com/bordeeinc/favicon-ruby']
+  self.testlib              = :minitest
+  self.readme_file          = 'README.md'
+  self.history_file         = 'History.txt'
+
+  # third-party
+  self.yard_title           = self.name
+  self.yard_markup          = 'markdown'
+
+  self.extra_deps += [
+    ['ico',                        '0.1.1']
+  ]
+
+  self.extra_dev_deps += [
+    ["hoe-yard",                  "~> 0.1"],
+    ["hoe-ignore",                "~> 1.0"],
+    ["hoe-bundler",               "~> 1.2"],
+    ["hoe-gemspec",               "~> 1.0"],
+    ["hoe-git",                   "~> 1.6"],
+    ["minitest",                  "~> 5.9"],
+    ["yard",                      "~> 0.8"],
+    ["redcarpet",                 "~> 3.3"] # yard/markdown
+  ]
+
+  self.clean_globs += [
+    '.yardoc',
+    'vendor',
+    'Gemfile.lock',
+    '.bundle',
+  ]
+
+  self.spec_extras = {
+    :required_ruby_version => '>= 1.9.2'
+  }
+end
+
+# vim: syntax=ruby

data/lib/favicon.rb

@@ -0,0 +1,36 @@
+require 'core_ext/array/extract_options.rb' unless Array.method_defined?(:extract_options!)
+require 'ico'
+require 'favicon/version'
+
+module Favicon
+  # https://github.com/audreyr/favicon-cheat-sheet#ico-file
+  SIZES_ARRAY = [16, 24, 32, 48, 64]
+
+  # make all methods class-methods
+  extend self
+
+  # PNG to favicon.ico in supplied sizes
+  #
+  # @param input_filename   [String] "/path/to/example.png"
+  # @param output_filename  [String] "/path/to/favicon.ico"
+  # @param sizes_array      [Array<Array<Int,Int>>, Array<Int>]  
+  #   rectangles use Array with XY: `[x,y]`
+  #   squares use single Integer `N`
+  #   mixed indices is valid
+  #   example: `[24, [24,24], [480,270], 888] # a[0] => 24x24; a[1] => 24x24; a[2] => 480x270; a[3] => 888x888`
+  # @return                 [String]                filename of generated ico
+  #
+  def png_to_favicon(input_filename, output_filename, sizes_array=SIZES_ARRAY)
+    dir = Dir.mktmpdir
+
+    begin
+      output_dir = ICO::Utils.png_to_sizes(input_filename, sizes_array, dir)
+
+      filename_array = Dir.glob(File.join(output_dir, '**/*'))
+
+      ICO.png_to_ico(filename_array, output_filename)
+    ensure
+      FileUtils.remove_entry dir
+    end
+  end
+end

data/lib/favicon/version.rb

@@ -0,0 +1,3 @@
+module Favicon
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: favicon-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- So Awesome Man
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ico
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+- !ruby/object:Gem::Dependency
+  name: hoe-yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: hoe-ignore
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hoe-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: hoe-gemspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hoe-git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+description: favicon.ico generator in Ruby without imagemagick
+email: support@bordee.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.md
+files:
+- ".autotest"
+- ".gitignore"
+- ".hoeignore"
+- Gemfile
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/favicon.rb
+- lib/favicon/version.rb
+homepage: https://github.com/bordeeinc/favicon-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- favicon-ruby
+- "--markup"
+- markdown
+- "--quiet"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: favicon.ico generator in Ruby without imagemagick
+test_files: []