crypticons 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f3e63d9adeee648934bf87f87ab909f68991afe
+  data.tar.gz: fe7264ddd976d52115bbc69a9aada16996380fe9
+SHA512:
+  metadata.gz: e9020a553edc89780672f6dc48461ba8fd364b40d9798fa150b63b8892bc6ab05332369907397ac366c30f1b3aa325911186a1dc4a59693e2b1a2749355456d5
+  data.tar.gz: f2d27612fd18e3e4a21f51226c18545429f6deeafada7040603a085ab82c5eb853a51af7fef00361e8e9371820996adb40160302d7a283562c9836340c5760a5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Mitchell Cash
+
+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/README.md

@@ -0,0 +1,112 @@
+# Crypticons gem
+
+[![Gem version](https://img.shields.io/gem/v/crypticons.svg)](https://rubygems.org/gems/crypticons)
+[![Build Status](https://travis-ci.org/mitchellcash/crypticons.svg?branch=master)](https://travis-ci.org/mitchellcash/crypticons)
+
+> Crypticons gem to distribute crypticons svg
+
+## Install
+
+Add this to your `Gemfile`
+
+```rb
+gem 'crypticons'
+```
+
+Then `bundle install`.
+
+## Usage
+
+```rb
+require 'crypticons'
+icon = Crypticons::Crypticon.new("bitcoin")
+icon.to_svg
+# <svg class="crypticon crypticon-bitcoin" viewBox="0 0 16 16" width="16" height="16" version="1.1"  aria-hidden="true"><path d="M13.638 9.521A5.906 5.906 0 1 1 2.177 6.664 5.906 5.906 0 0 1 13.638 9.52z"></path><path d="M10.512 7.25c.118-.785-.48-1.208-1.299-1.49l.266-1.065-.649-.161-.258 1.036c-.17-.042-.345-.082-.52-.122l.261-1.043-.648-.162L7.4 5.308c-.142-.033-.28-.064-.414-.098v-.003l-.894-.223-.172.692s.48.11.47.117c.263.066.31.24.303.377L6.39 7.383a.537.537 0 0 1 .068.022l-.069-.017-.424 1.7c-.032.079-.113.199-.297.153.007.01-.47-.117-.47-.117l-.323.742.844.21.462.12-.268 1.076.647.162.266-1.066c.177.048.348.092.516.134l-.264 1.06.648.162.268-1.075c1.105.21 1.937.125 2.286-.875.282-.805-.014-1.269-.595-1.572.423-.097.742-.376.827-.951zm-1.48 2.077c-.2.805-1.556.37-1.995.261l.355-1.427c.44.11 1.849.327 1.64 1.166zm.2-2.088c-.183.732-1.31.36-1.677.269l.323-1.294c.366.091 1.544.261 1.354 1.025z"></path></svg>
+```
+
+## Documentation
+
+The `Crypticon` class takes two arguments. The first is the symbol of the icon, and the second is a hash of arguments representing html attributes
+
+#### `symbol` _(required)_
+
+This is the name of the crypticon you want to use. For example `bitcoin`.
+
+#### Options
+
+* `:height` - When setting the height to a number, the icon will scale to that size. For example, passing `32`, will calculate the width based on the icon's natural size.
+* `:width` - When setting the width to a number, the icon will scale to that size. For example, passing `32`, will calculate the width based on the icon's natural size.
+
+If both `:width, :height` are passed into the options hash, then the icon will be sized exactly at those dimensions.
+
+#### Attributes
+
+Once initialized, you can read a few properties from the icon.
+
+##### `symbol`
+
+Returns the string of the symbol name
+
+```rb
+icon = Crypticons::Crypticon.new("bitcoin")
+icon.symbol
+# "bitcoin"
+```
+
+##### `path`
+
+Path returns the string representation of the path of the icon.
+
+```rb
+icon = Crypticons::Crypticon.new("bitcoin")
+icon.path
+# <path d="M13.638 9.521A5.906 5.906 0 1 1 2.177 6.664 5.906 5.906 0 0 1 13.638 9.52z"/><path d="M10.512 7.25c.118-.785-.48-1.208-1.299-1.49l.266-1.065-.649-.161-.258 1.036c-.17-.042-.345-.082-.52-.122l.261-1.043-.648-.162L7.4 5.308c-.142-.033-.28-.064-.414-.098v-.003l-.894-.223-.172.692s.48.11.47.117c.263.066.31.24.303.377L6.39 7.383a.537.537 0 0 1 .068.022l-.069-.017-.424 1.7c-.032.079-.113.199-.297.153.007.01-.47-.117-.47-.117l-.323.742.844.21.462.12-.268 1.076.647.162.266-1.066c.177.048.348.092.516.134l-.264 1.06.648.162.268-1.075c1.105.21 1.937.125 2.286-.875.282-.805-.014-1.269-.595-1.572.423-.097.742-.376.827-.951zm-1.48 2.077c-.2.805-1.556.37-1.995.261l.355-1.427c.44.11 1.849.327 1.64 1.166zm.2-2.088c-.183.732-1.31.36-1.677.269l.323-1.294c.366.091 1.544.261 1.354 1.025z"/>
+```
+
+##### `options`
+
+This is a hash of all the `options` that will be added to the output tag.
+
+```rb
+icon = Crypticons::Crypticon.new("bitcoin")
+icon.options
+# {:class=>"crypticon crypticon-bitcoin", :viewBox=>"0 0 16 16", :version=>"1.1", :width=>16, :height=>16, :"aria-hidden"=>"true"}
+```
+
+##### `width`
+
+Width is the icon's true width. Based on the svg view box width. _Note, this doesn't change if you scale it up with size options, it only is the natural width of the icon_
+
+##### `height`
+
+Height is the icon's true height. Based on the svg view box height. _Note, this doesn't change if you scale it up with size options, it only is the natural height of the icon_
+
+##### `keywords`
+
+Returns an array of keywords for the icon. The data comes from the [data file in lib](../data.json). Consider contributing more aliases for the icons.
+
+```rb
+icon = Crypticons::Crypticon.new("bitcoin")
+icon.keywords
+# ["bitcoin"]
+```
+
+#### Methods
+
+##### `to_svg`
+
+Returns a string of the svg tag
+
+```rb
+icon = Crypticons::Crypticon.new("bitcoin")
+icon.to_svg
+# <svg class="crypticon crypticon-bitcoin" viewBox="0 0 16 16" width="16" height="16" version="1.1"  aria-hidden="true"><path d="M13.638 9.521A5.906 5.906 0 1 1 2.177 6.664 5.906 5.906 0 0 1 13.638 9.52z"></path><path d="M10.512 7.25c.118-.785-.48-1.208-1.299-1.49l.266-1.065-.649-.161-.258 1.036c-.17-.042-.345-.082-.52-.122l.261-1.043-.648-.162L7.4 5.308c-.142-.033-.28-.064-.414-.098v-.003l-.894-.223-.172.692s.48.11.47.117c.263.066.31.24.303.377L6.39 7.383a.537.537 0 0 1 .068.022l-.069-.017-.424 1.7c-.032.079-.113.199-.297.153.007.01-.47-.117-.47-.117l-.323.742.844.21.462.12-.268 1.076.647.162.266-1.066c.177.048.348.092.516.134l-.264 1.06.648.162.268-1.075c1.105.21 1.937.125 2.286-.875.282-.805-.014-1.269-.595-1.572.423-.097.742-.376.827-.951zm-1.48 2.077c-.2.805-1.556.37-1.995.261l.355-1.427c.44.11 1.849.327 1.64 1.166zm.2-2.088c-.183.732-1.31.36-1.677.269l.323-1.294c.366.091 1.544.261 1.354 1.025z"></path></svg>
+```
+
+## License
+
+(c) Mitchell Cash
+
+[MIT](./LICENSE)  
+
+[crypticons]: https://github.com/mitchellcash/crypticons

data/lib/crypticons.rb

@@ -0,0 +1,8 @@
+require "crypticons/version"
+require "crypticons/crypticon"
+require "json"
+
+module Crypticons
+  file_data = File.read(File.join(File.dirname(__FILE__), "data.json"))
+  CRYPTICON_SYMBOLS = JSON.parse(file_data).freeze
+end

data/lib/crypticons/crypticon.rb

@@ -0,0 +1,88 @@
+module Crypticons
+  class Crypticon
+
+    attr_reader :path, :options, :width, :height, :symbol, :keywords
+
+    def initialize(symbol, options = {})
+      @symbol = symbol.to_s
+      if crypticon = Crypticons::CRYPTICON_SYMBOLS[@symbol]
+
+        @path = crypticon["path"]
+        @width = crypticon["width"].to_i
+        @height = crypticon["height"].to_i
+
+        @keywords = crypticon["keywords"]
+
+        @options = options
+        @options.merge!({
+          class:   classes,
+          viewBox: viewbox,
+          version: "1.1"
+        })
+        @options.merge!(size)
+        @options.merge!(a11y)
+      else
+        raise "Couldn't find crypticon symbol for #{@symbol.inspect}"
+      end
+    end
+
+    # Returns an string representing a <svg> tag
+    def to_svg
+      "<svg #{html_attributes}>#{@path}</svg>"
+    end
+
+    private
+
+    def html_attributes
+      attrs = ""
+      @options.each { |attr, value| attrs += "#{attr}=\"#{value}\" " }
+      attrs.strip
+    end
+
+    # add some accessibility features to svg
+    def a11y
+      accessible = {}
+
+      if @options[:'aria-label'].nil?
+        accessible[:'aria-hidden'] = "true"
+      else
+        accessible[:role] = "img"
+      end
+
+      accessible
+    end
+
+    # prepare the crypticon class
+    def classes
+      "crypticon crypticon-#{@symbol} #{@options[:class]} ".strip
+    end
+
+    def viewbox
+      "0 0 #{@width} #{@height}"
+    end
+
+    # determine the height and width of the crypticon based on :size option
+    def size
+      size = {
+        width:  @width,
+        height: @height
+      }
+
+      # Specific size
+      unless @options[:width].nil? && @options[:height].nil?
+        size[:width]  = @options[:width].nil?  ? calculate_width(@options[:height]) : @options[:width]
+        size[:height] = @options[:height].nil? ? calculate_height(@options[:width]) : @options[:height]
+      end
+
+      size
+    end
+
+    def calculate_width(height)
+      (height.to_i * @width) / @height
+    end
+
+    def calculate_height(width)
+      (width.to_i * @height) / @width
+    end
+  end
+end

data/lib/crypticons/version.rb

@@ -0,0 +1,3 @@
+module Crypticons
+  VERSION = "1.0.0".freeze
+end

data/lib/data.json

@@ -0,0 +1 @@
+{"bitcoin":{"keywords":["bitcoin"],"path":"<path fill=\"#F7931A\" fill-rule=\"nonzero\" d=\"M13.638 9.521A5.906 5.906 0 1 1 2.177 6.664 5.906 5.906 0 0 1 13.638 9.52zm-3.126-2.27c.118-.786-.48-1.209-1.299-1.49l.266-1.066-.649-.161-.258 1.036c-.17-.042-.345-.082-.52-.122l.261-1.043-.648-.162L7.4 5.308c-.142-.033-.28-.064-.414-.098v-.003l-.894-.223-.172.692s.48.11.47.117c.263.066.31.24.303.377L6.39 7.383a.537.537 0 0 1 .068.022l-.069-.017-.424 1.7c-.032.079-.113.199-.297.153.007.01-.47-.117-.47-.117l-.323.742.844.21.462.12-.268 1.076.647.162.266-1.066c.177.048.348.092.516.134l-.264 1.06.648.162.268-1.075c1.105.21 1.937.125 2.286-.875.282-.805-.014-1.269-.595-1.572.423-.097.742-.376.827-.951zm-1.48 2.076c-.2.805-1.556.37-1.995.261l.355-1.427c.44.11 1.849.327 1.64 1.166zm.2-2.088c-.183.732-1.31.36-1.677.269l.323-1.294c.366.091 1.544.261 1.354 1.025z\"/>","height":"16","width":"16"},"litecoin":{"keywords":["litecoin"],"path":"<path fill=\"#BEBEBE\" fill-rule=\"nonzero\" d=\"M13.967 8A5.968 5.968 0 1 1 2.031 8a5.968 5.968 0 0 1 11.936 0M7.65 9.595l.388-1.46.918-.336.228-.857-.008-.022-.903.33.65-2.45H7.079l-.852 3.198-.71.26-.235.884.71-.26-.502 1.886h4.913l.315-1.173H7.65\"/>","height":"16","width":"16"},"ethereum":{"keywords":["ethereum"],"path":"<g fill=\"none\" fill-rule=\"nonzero\"><path fill=\"#343434\" d=\"M7.682 2l-.08.273v7.933l.08.08 3.683-2.176z\"/><path fill=\"#3C3C3B\" d=\"M7.682 10.984l-.045.055v2.826l.045.132 3.685-5.189z\"/><path fill=\"#8C8C8C\" d=\"M7.682 2L4 8.11l3.682 2.177v-3.85zM7.682 13.997v-3.013L4 8.808z\"/><path fill=\"#141414\" d=\"M7.682 10.287l3.683-2.177-3.683-1.674z\"/><path fill=\"#393939\" d=\"M4 8.11l3.682 2.177v-3.85z\"/></g>","height":"16","width":"16"},"dash":{"keywords":["dash"],"path":"<path fill=\"#1C75BC\" fill-rule=\"nonzero\" d=\"M4.515 4.256l-.49 1.5-.004.014h7.346l-.003.013-.58 1.768-.576 1.757s-1.654.002-3.675.002H2.859l-.096.292c-.233.71-.481 1.471-.481 1.474 0 .006 8.112.004 8.226-.002.288-.015.55-.09.858-.246.287-.145.527-.323.777-.572.283-.284.487-.583.608-.892.036-.092 1.172-3.56 1.194-3.646a1.5 1.5 0 0 0 .053-.39 1.368 1.368 0 0 0-.07-.508 1.133 1.133 0 0 0-.603-.692 1.24 1.24 0 0 0-.387-.114c-.065-.01-.295-.011-4.204-.012L4.599 4l-.084.256zM2.283 7.533C2.127 7.984 2 8.357 2 8.36c0 .005.491.007 2.183.007h2.184l.007-.02a957.892 957.892 0 0 0 .561-1.626c.004-.01-.102-.01-2.182-.01H2.566l-.283.82z\"/>","height":"16","width":"16"},"ripple":{"keywords":["ripple"],"path":"<defs><linearGradient x1=\"28.201%\" x2=\"103.372%\" y1=\"15.347%\" y2=\"84.653%\"><stop offset=\"0%\" stop-color=\"#00AAE4\"/><stop offset=\"100%\" stop-color=\"#006097\"/></linearGradient></defs><path fill=\"url(#a)\" fill-rule=\"nonzero\" d=\"M11.81 9.323c-.424-.245-.902-.316-1.375-.332-.397-.014-.99-.269-.99-.991 0-.538.437-.971.99-.99.473-.017.951-.088 1.375-.333a2.506 2.506 0 1 0-3.759-2.17c0 .485.173.932.393 1.346.185.349.28.996-.356 1.363-.473.273-1.064.1-1.358-.372-.25-.398-.55-.771-.97-1.014a2.506 2.506 0 1 0 0 4.34c.42-.242.72-.616.97-1.014.204-.327.714-.744 1.357-.372.473.273.619.87.357 1.363-.22.414-.393.861-.393 1.347a2.506 2.506 0 1 0 3.76-2.17z\"/>","height":"16","width":"16"}}

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: crypticons
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mitchell Cash
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.3.1
+description: A package that distributes Crypticons in a gem
+email:
+- mitchell@mitchellcash.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/crypticons.rb
+- lib/crypticons/crypticon.rb
+- lib/crypticons/version.rb
+- lib/data.json
+homepage: https://github.com/mitchellcash/crypticons
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: The crypticons gem
+test_files: []