prawn-icon 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55455c80d1f0c5ca47e3e50783d51570b76c86da
-  data.tar.gz: 5f7891504d8785ec3824fa85d923e77a55c9a711
+  metadata.gz: 9efb0b74b59e669ba8755dc2768d156b798eafb7
+  data.tar.gz: b4ac081cd8e32226989e4a1372ecbc02bdcd025e
 SHA512:
-  metadata.gz: b12586fbc20353c8260d80c57276e9b8adec643c7f21d13e380fe53b954c8b6be2039eb42445db941e487d4f2bbd648c5fa8fed1d19559d12caddb56310b1340
-  data.tar.gz: 5d0a761f00b7f9d32d44bebca00916590c32163ab949529266374143204a94c4aa1eba1011dfbe53cedc86a7707e7ab7eca423cc0818a388888a883fab5ddf52
+  metadata.gz: a1af37c3f257d7f1904365049e43c98079fbcf8731a04d20b8aceebfff92d2e49d9a720284a1c468a79b58d248fae9571f5fdd2b5627e68e5f924ad3e63e0ff3
+  data.tar.gz: 62c35e08a09d709dfc60996404224083c2206ac208039c6943a1379c5b3affa98d39f52f79b15a8c68b575da3bb85b12a79a3f2fb552a6984296a1c2b026aaae

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 2.0.0 - March 7, 2018
+
+* [**breaking change**] Update to FontAwesome 5.0.8. FontAwesome 5 now provides 3 different font families: `brands`, `regular` and `solid`. The specifiers for these font icons are now: `fab`, `far` and `fas`.
+* [**breaking change**] Remove GitHub Octicons because Octicons are now only [delivered via SVG](https://github.com/blog/2112-delivering-octicons-with-svg).
+* [**breaking change**] Make the font specifier a required attribute for `Prawn::Icon::FontData#new`. Previously it was assumed to be `fa`.
+* Write a new tool `tool/fontawesome/converter.rb` that accepts the FontAwesome metadata YAML file ([link](https://github.com/FortAwesome/Font-Awesome/blob/31281606f5205b0191c17c3b4d2d56e1ddbb2dc6/advanced-options/metadata/icons.yml)), and generates the correct legend files for `brands`, `regular` and `solid` styles.
+* Require 'prawn/icon/version' with by default.
+
 # 1.4.0 - Sept 11, 2017
 
 - Update dependency gems to latest version.

data/README.md

@@ -10,7 +10,6 @@ The following icon fonts ship with Prawn::Icon:
 
 * FontAwesome (http://fontawesome.io/icons/)
 * Foundation Icons (http://zurb.com/playground/foundation-icon-fonts-3)
-* GitHub Octicons (https://octicons.github.com)
 * PaymentFont (http://paymentfont.io)
 
 Prawn::Icon was originally written by Jesse Doyle.
@@ -31,13 +30,13 @@ Prawn::Icon was designed to have an API familiar to Prawn. A single icon may be
 require 'prawn/icon'
 
 Prawn::Document.generate('icons.pdf') do |pdf|
-  pdf.icon 'fa-beer', size: 60
+  pdf.icon 'fas-beer', size: 60
 end
 ```
 
 produces:
 
-![FontAwesome Beer](https://raw.github.com/jessedoyle/prawn-icon/master/examples/fa-beer.png)
+![FontAwesome Beer](https://raw.github.com/jessedoyle/prawn-icon/master/examples/fas-beer.png)
 
 ## Inline Icons
 
@@ -47,13 +46,13 @@ You can also provide the `inline_format: true` option to Prawn::Icon:
 require 'prawn/icon'
 
 Prawn::Document.generate('inline_icons.pdf') do |pdf|
-  pdf.icon 'Enjoy: <icon size="20" color="AAAAAA">fa-beer</icon>', inline_format: true
+  pdf.icon 'Enjoy: <icon size="20" color="AAAAAA">fas-beer</icon>', inline_format: true
 end
 ```
 
 produces:
 
-![FontAwesome Beer Inline](https://raw.github.com/jessedoyle/prawn-icon/master/examples/fa-beer-inline.png)
+![FontAwesome Beer Inline](https://raw.github.com/jessedoyle/prawn-icon/master/examples/fas-beer-inline.png)
 
 When using `inline_format: true`, you may supply `<icon>` tags with `color` and `size` attributes.
 
@@ -69,7 +68,7 @@ Prawn::Document.generate('table_icons.pdf') do |pdf|
 
   data = [
     # Explicit brackets must be used here
-    [pdf.table_icon('fa-birthday-cake'), 'Cake'],
+    [pdf.table_icon('fas-birthday-cake'), 'Cake'],
     ['is', 'Great!']
   ]
 
@@ -85,10 +84,11 @@ Prawn::Icon uses the prefix of an icon key to determine which font family is use
 
 Currently supported prefixes include:
 
-* `fa` - Fontawesome (eg. `fa-arrows`)
-* `fi` - Foundation Icons (eg. `fi-compass`)
-* `octicon` - Github Octicons (eg. `octicon-calendar`)
-* `pf` - PaymentFont (eg. `pf-cash`)
+* `fab` - [FontAwesome Brands](https://fontawesome.com/icons?d=gallery&s=brands&m=free) (eg. `fab-amazon`).
+* `far` - [FontAwesome Regular](https://fontawesome.com/icons?d=gallery&s=regular&m=free) (eg. `far-address-book`).
+* `fas` - [FontAwesome Solid](https://fontawesome.com/icons?d=gallery&s=solid&m=free) (eg. `fas-location-arrow`).
+* `fi` - [Foundation Icons](https://zurb.com/playground/foundation-icon-fonts-3) (eg. `fi-compass`).
+* `pf` - [PaymentFont](https://paymentfont.com/#icons) (eg. `pf-cash`).
 
 ## How It Works
 

data/data/fonts/fab/LICENSE

@@ -0,0 +1,34 @@
+Font Awesome Free License
+-------------------------
+
+Font Awesome Free is free, open source, and GPL friendly. You can use it for
+commercial projects, open source projects, or really almost whatever you want.
+Full Font Awesome Free license: https://fontawesome.com/license.
+
+# Icons: CC BY 4.0 License (https://creativecommons.org/licenses/by/4.0/)
+In the Font Awesome Free download, the CC BY 4.0 license applies to all icons
+packaged as SVG and JS file types.
+
+# Fonts: SIL OFL 1.1 License (https://scripts.sil.org/OFL)
+In the Font Awesome Free download, the SIL OLF license applies to all icons
+packaged as web and desktop font files.
+
+# Code: MIT License (https://opensource.org/licenses/MIT)
+In the Font Awesome Free download, the MIT license applies to all non-font and
+non-icon files.
+
+# Attribution
+Attribution is required by MIT, SIL OLF, and CC BY licenses. Downloaded Font
+Awesome Free files already contain embedded comments with sufficient
+attribution, so you shouldn't need to do anything additional when using these
+files normally.
+
+We've kept attribution comments terse, so we ask that you do not actively work
+to remove them from files, especially code. They're a great way for folks to
+learn about Font Awesome.
+
+# Brand Icons
+All brand icons are trademarks of their respective owners. The use of these
+trademarks does not indicate endorsement of the trademark holder by Font
+Awesome, nor vice versa. **Please do not use brand logos for any purpose except
+to represent the company, product, or service to which they refer.**

data/data/fonts/fab/fab.yml

@@ -0,0 +1,333 @@
+---
+fab:
+  __font_version__: 5.0.8
+  500px: ""
+  accessible-icon: ""
+  accusoft: ""
+  adn: ""
+  adversal: ""
+  affiliatetheme: ""
+  algolia: ""
+  amazon: ""
+  amazon-pay: ""
+  amilia: ""
+  android: ""
+  angellist: ""
+  angrycreative: ""
+  angular: ""
+  app-store: ""
+  app-store-ios: ""
+  apper: ""
+  apple: ""
+  apple-pay: ""
+  asymmetrik: ""
+  audible: ""
+  autoprefixer: ""
+  avianex: ""
+  aviato: ""
+  aws: ""
+  bandcamp: ""
+  behance: ""
+  behance-square: ""
+  bimobject: ""
+  bitbucket: ""
+  bitcoin: ""
+  bity: ""
+  black-tie: ""
+  blackberry: ""
+  blogger: ""
+  blogger-b: ""
+  bluetooth: ""
+  bluetooth-b: ""
+  btc: ""
+  buromobelexperte: ""
+  buysellads: ""
+  cc-amazon-pay: ""
+  cc-amex: ""
+  cc-apple-pay: ""
+  cc-diners-club: ""
+  cc-discover: ""
+  cc-jcb: ""
+  cc-mastercard: ""
+  cc-paypal: ""
+  cc-stripe: ""
+  cc-visa: ""
+  centercode: ""
+  chrome: ""
+  cloudscale: ""
+  cloudsmith: ""
+  cloudversify: ""
+  codepen: ""
+  codiepie: ""
+  connectdevelop: ""
+  contao: ""
+  cpanel: ""
+  creative-commons: ""
+  css3: ""
+  css3-alt: ""
+  cuttlefish: ""
+  d-and-d: ""
+  dashcube: ""
+  delicious: ""
+  deploydog: ""
+  deskpro: ""
+  deviantart: ""
+  digg: ""
+  digital-ocean: ""
+  discord: ""
+  discourse: ""
+  dochub: ""
+  docker: ""
+  draft2digital: ""
+  dribbble: ""
+  dribbble-square: ""
+  dropbox: ""
+  drupal: ""
+  dyalog: ""
+  earlybirds: ""
+  edge: ""
+  elementor: ""
+  ember: ""
+  empire: ""
+  envira: ""
+  erlang: ""
+  ethereum: ""
+  etsy: ""
+  expeditedssl: ""
+  facebook: ""
+  facebook-f: ""
+  facebook-messenger: ""
+  facebook-square: ""
+  firefox: ""
+  first-order: ""
+  firstdraft: ""
+  flickr: ""
+  flipboard: ""
+  fly: ""
+  font-awesome: ""
+  font-awesome-alt: ""
+  font-awesome-flag: ""
+  fonticons: ""
+  fonticons-fi: ""
+  fort-awesome: ""
+  fort-awesome-alt: ""
+  forumbee: ""
+  foursquare: ""
+  free-code-camp: ""
+  freebsd: ""
+  get-pocket: ""
+  gg: ""
+  gg-circle: ""
+  git: ""
+  git-square: ""
+  github: ""
+  github-alt: ""
+  github-square: ""
+  gitkraken: ""
+  gitlab: ""
+  gitter: ""
+  glide: ""
+  glide-g: ""
+  gofore: ""
+  goodreads: ""
+  goodreads-g: ""
+  google: ""
+  google-drive: ""
+  google-play: ""
+  google-plus: ""
+  google-plus-g: ""
+  google-plus-square: ""
+  google-wallet: ""
+  gratipay: ""
+  grav: ""
+  gripfire: ""
+  grunt: ""
+  gulp: ""
+  hacker-news: ""
+  hacker-news-square: ""
+  hips: ""
+  hire-a-helper: ""
+  hooli: ""
+  hotjar: ""
+  houzz: ""
+  html5: ""
+  hubspot: ""
+  imdb: ""
+  instagram: ""
+  internet-explorer: ""
+  ioxhost: ""
+  itunes: ""
+  itunes-note: ""
+  jenkins: ""
+  joget: ""
+  joomla: ""
+  js: ""
+  js-square: ""
+  jsfiddle: ""
+  keycdn: ""
+  kickstarter: ""
+  kickstarter-k: ""
+  korvue: ""
+  laravel: ""
+  lastfm: ""
+  lastfm-square: ""
+  leanpub: ""
+  less: ""
+  line: ""
+  linkedin: ""
+  linkedin-in: ""
+  linode: ""
+  linux: ""
+  lyft: ""
+  magento: ""
+  maxcdn: ""
+  medapps: ""
+  medium: ""
+  medium-m: ""
+  medrt: ""
+  meetup: ""
+  microsoft: ""
+  mix: ""
+  mixcloud: ""
+  mizuni: ""
+  modx: ""
+  monero: ""
+  napster: ""
+  nintendo-switch: ""
+  node: ""
+  node-js: ""
+  npm: ""
+  ns8: ""
+  nutritionix: ""
+  odnoklassniki: ""
+  odnoklassniki-square: ""
+  opencart: ""
+  openid: ""
+  opera: ""
+  optin-monster: ""
+  osi: ""
+  page4: ""
+  pagelines: ""
+  palfed: ""
+  patreon: ""
+  paypal: ""
+  periscope: ""
+  phabricator: ""
+  phoenix-framework: ""
+  php: ""
+  pied-piper: ""
+  pied-piper-alt: ""
+  pied-piper-pp: ""
+  pinterest: ""
+  pinterest-p: ""
+  pinterest-square: ""
+  playstation: ""
+  product-hunt: ""
+  pushed: ""
+  python: ""
+  qq: ""
+  quinscape: ""
+  quora: ""
+  ravelry: ""
+  react: ""
+  rebel: ""
+  red-river: ""
+  reddit: ""
+  reddit-alien: ""
+  reddit-square: ""
+  rendact: ""
+  renren: ""
+  replyd: ""
+  resolving: ""
+  rocketchat: ""
+  rockrms: ""
+  safari: ""
+  sass: ""
+  schlix: ""
+  scribd: ""
+  searchengin: ""
+  sellcast: ""
+  sellsy: ""
+  servicestack: ""
+  shirtsinbulk: ""
+  simplybuilt: ""
+  sistrix: ""
+  skyatlas: ""
+  skype: ""
+  slack: ""
+  slack-hash: ""
+  slideshare: ""
+  snapchat: ""
+  snapchat-ghost: ""
+  snapchat-square: ""
+  soundcloud: ""
+  speakap: ""
+  spotify: ""
+  stack-exchange: ""
+  stack-overflow: ""
+  staylinked: ""
+  steam: ""
+  steam-square: ""
+  steam-symbol: ""
+  sticker-mule: ""
+  strava: ""
+  stripe: ""
+  stripe-s: ""
+  studiovinari: ""
+  stumbleupon: ""
+  stumbleupon-circle: ""
+  superpowers: ""
+  supple: ""
+  telegram: ""
+  telegram-plane: ""
+  tencent-weibo: ""
+  themeisle: ""
+  trello: ""
+  tripadvisor: ""
+  tumblr: ""
+  tumblr-square: ""
+  twitch: ""
+  twitter: ""
+  twitter-square: ""
+  typo3: ""
+  uber: ""
+  uikit: ""
+  uniregistry: ""
+  untappd: ""
+  usb: ""
+  ussunnah: ""
+  vaadin: ""
+  viacoin: ""
+  viadeo: ""
+  viadeo-square: ""
+  viber: ""
+  vimeo: ""
+  vimeo-square: ""
+  vimeo-v: ""
+  vine: ""
+  vk: ""
+  vnv: ""
+  vuejs: ""
+  weibo: ""
+  weixin: ""
+  whatsapp: ""
+  whatsapp-square: ""
+  whmcs: ""
+  wikipedia-w: ""
+  windows: ""
+  wordpress: ""
+  wordpress-simple: ""
+  wpbeginner: ""
+  wpexplorer: ""
+  wpforms: ""
+  xbox: ""
+  xing: ""
+  xing-square: ""
+  y-combinator: ""
+  yahoo: ""
+  yandex: ""
+  yandex-international: ""
+  yelp: ""
+  yoast: ""
+  youtube: ""
+  youtube-square: ""