octicons 1.1.0 → 2.0.0

data/lib/octicons.rb

@@ -1,10 +1,14 @@
 require "octicons/version"
 require "octicons/octicon"
 require "nokogiri"
+require "json"
 
 module Octicons
   OCTICONS_SVG_PATH = File.join(File.dirname(__FILE__), "svg/*.svg")
 
+  KEYWORDS = JSON.parse(File.read(File.join(File.dirname(__FILE__), "keywords.json")))
+  CODEPOINTS = JSON.parse(File.read(File.join(File.dirname(__FILE__), "codepoints.json")))
+
   OCTICON_SYMBOLS = {}
   Dir[OCTICONS_SVG_PATH].each do |svg_path|
     id = File.basename(svg_path, ".svg")

data/lib/octicons/octicon.rb

@@ -1,36 +1,59 @@
 module Octicons
   class Octicon
 
-    def initialize(options)
-      @options = options
-      if symbol = Octicons::OCTICON_SYMBOLS[@options[:symbol]]
-        @path = symbol[:path]
-        @width = symbol[:width]
-        @height = symbol[:height]
-
-        # create html_options from options, except for a few
-        @html_options = @options.reject { |d| [:symbol, :size].include? d }
-        @html_options.merge!({
+    attr_reader :path, :options, :width, :height, :symbol
+
+    def initialize(symbol, options = {})
+      @symbol = symbol.to_s
+      if octicon = Octicons::OCTICON_SYMBOLS[@symbol]
+
+        @path = octicon[:path]
+        @width = octicon[:width]
+        @height = octicon[:height]
+
+        @options = options
+        @options.merge!({
           :class   => classes,
           :viewBox => viewbox,
           :version => "1.1"
         })
-        @html_options.merge!(size)
-        @html_options.merge!(a11y)
+        @options.merge!(size)
+        @options.merge!(a11y)
       else
-        raise "Couldn't find octicon symbol for #{options[:symbol].inspect}"
+        raise "Couldn't find octicon symbol for #{@symbol.inspect}"
       end
     end
 
+    # Returns an string representing a <svg> tag
     def to_svg
       "<svg #{html_attributes}>#{@path}</svg>"
     end
 
+    # Returns an array of keywords similar to the icon
+    def keywords
+      Octicons::KEYWORDS[@symbol]["keywords"]
+    end
+
+    # Returns the decimal codepoint of the character
+    def decimal
+      Octicons::CODEPOINTS[@symbol]
+    end
+
+    # Returns the hexidecimal version of the character
+    def hexadecimal
+      decimal.to_s(16)
+    end
+
+    # Returns the unicode character
+    def character
+      [decimal].pack("U")
+    end
+
     private
 
     def html_attributes
       attrs = ""
-      @html_options.each { |attr, value| attrs += "#{attr}=\"#{value}\" " }
+      @options.each { |attr, value| attrs += "#{attr}=\"#{value}\" " }
       attrs.strip
     end
 
@@ -49,7 +72,7 @@ module Octicons
 
     # prepare the octicon class
     def classes
-      "octicon octicon-#{@options[:symbol]} #{@options[:class]} ".strip
+      "octicon octicon-#{@symbol} #{@options[:class]} ".strip
     end
 
     def viewbox
@@ -63,18 +86,8 @@ module Octicons
         :height => @height
       }
 
-      # When size is "large"
-      if @options[:size] == "large"
-        size[:width] = 2 * @width
-        size[:height] = 2 * @height
-
-      # When size is an integer
-      elsif @options[:size].is_a?(Integer) || !!(@options[:size] =~ /\A[0-9]+\z/)
-        size[:width]  = calculate_width(@options[:size])
-        size[:height] = @options[:size]
-
-        # Specific size
-      elsif !@options[:width].nil? || !@options[:height].nil?
+      # 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

data/lib/octicons/version.rb

@@ -1,3 +1,3 @@
 module Octicons
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: octicons
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - GitHub Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-09 00:00:00.000000000 Z
+date: 2016-06-17 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 Octicons in a gem
@@ -31,9 +31,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- lib/codepoints.json
+- lib/keywords.json
+- lib/octicons.rb
 - lib/octicons/octicon.rb
 - lib/octicons/version.rb
-- lib/octicons.rb
 - lib/svg/alert.svg
 - lib/svg/arrow-down.svg
 - lib/svg/arrow-left.svg
@@ -206,8 +210,6 @@ files:
 - lib/svg/watch.svg
 - lib/svg/x.svg
 - lib/svg/zap.svg
-- LICENSE
-- README.md
 homepage: https://github.com/primer/octicons_gem
 licenses:
 - MIT
@@ -218,17 +220,17 @@ 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.0.14.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: GitHub's octicons gem