prawn-icon 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8889719da10fa88779b85044ad4e21cefba4b626
-  data.tar.gz: 538526d331c869244c668b9f4646d16cc8072028
+  metadata.gz: 9efb0b74b59e669ba8755dc2768d156b798eafb7
+  data.tar.gz: b4ac081cd8e32226989e4a1372ecbc02bdcd025e
 SHA512:
-  metadata.gz: 4c8c174bc49dbbb3ab8ca16755b932f483cdbe50539d55b8705c6a79c0ad466bcf6c7a5ef9d61d1aea827bc037e7f2a838e12841a0afb5d3ae2bdc1a6464cf6d
-  data.tar.gz: d3960939db1027e38f079a31bde2eac6d9d70d4ea05045e2a2e7447cfd1c17c5cb299285d863ae6986dfe4f2c38eb73ac023d5a26dc3374de562f1a276b31b66
+  metadata.gz: a1af37c3f257d7f1904365049e43c98079fbcf8731a04d20b8aceebfff92d2e49d9a720284a1c468a79b58d248fae9571f5fdd2b5627e68e5f924ad3e63e0ff3
+  data.tar.gz: 62c35e08a09d709dfc60996404224083c2206ac208039c6943a1379c5b3affa98d39f52f79b15a8c68b575da3bb85b12a79a3f2fb552a6984296a1c2b026aaae

data/CHANGELOG.md

@@ -1,3 +1,56 @@
+# 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.
+- Fix `rubocop` config to show cop names as well as increase the ABC complexity slightly.
+- Add internal tooling to assist with the SCSS => YAML mappings of FontAwesome and PaymentFont.
+- Update FontAwesome to `v4.7.0` from `v4.6.3`. See [changelog](http://fontawesome.io/icons#new).
+- Update PaymentFont to `v1.2.5` from `v1.1.2`. See [icons](https://paymentfont.com/#icons).
+- Update Octicons from to `v4.4.0` from `v3.1.0`. NOTE: As Octicons have moved from font-based icons to SVG after this version, this will be the final octicon version in `prawn/icon`. See the [wiki](https://github.com/blog/2112-delivering-octicons-with-svg).
+- Fix rubocop warnings for whitespace.
+
+# 1.3.0 - Oct 15, 2016
+
+- Update rubocop developement dependency (to `0.44.1`).
+- Add `simplecov` as a development dependency and require 100% coverage.
+- Break out `Prawn::Icon::Interface` into its own file. This resolves issue [#27](https://github.com/jessedoyle/prawn-icon/issues/27).
+
+# 1.2.0 - Sept 12, 2016
+
+- Update FontAwesome from v4.5.0 to v4.6.3. See [changelog](http://fontawesome.io/icons#new).
+- Refactor spec files to remove duplication using `let` blocks.
+- Break internal dependencies to `Prawn::Icon::Base` to allow selective code requires.
+  e.g. (to require only `prawn/icon/font_data`):
+
+  ```ruby
+    require 'prawn/icon/base'
+    require 'prawn/icon/font_data'
+  ```
+
+  This resolves issue [#27](https://github.com/jessedoyle/prawn-icon/issues/27). Thanks @mojavelinux for reporting!
+- Introduce `Prawn::Icon::Errors` to contain internal exception classes.
+- `Prawn::Icon::FONTDIR` is now an alias to `Prawn::Icon::Base::FONTDIR` for compatibilty.
+- Add basic spec files for `Prawn::Icon::Base` and separate exception classes.
+- Minor backwards-compatible code refactor of `Prawn::Icon::FontData` for readability.
+- Add a spec to test inline_icon with final_gap: false to achieve 100% coverage.
+
+# 1.1.1 - Jun 24, 2016
+
+- BUGFIX: Inline icons now properly render at the correct cursor position with the correct line gap and box leading[#24](https://github.com/jessedoyle/prawn-icon/issues/24). Thanks @ToniTornado for reporting!
+
+# 1.1.0 - March 16, 2016
+
+- Update FontAwesome from v4.4.0 to v4.5.0. See [changelog](http://fontawesome.io/icons#new).
+- Refactor specs to use `expect(foo).to be true` over `expect(foo).to be_true`.
+- Update development dependencies to latest.
+
 # 1.0.0 - September 9, 2015
 
 - *(breaking change)* Updated Octicons from v2.4.1 to v3.1.0.
@@ -65,4 +118,4 @@
 
 # 0.5.0 - October 29, 2014
 
-- Initial public release.
+- Initial public release.

data/GPLv2

@@ -1,12 +1,12 @@
-        GNU GENERAL PUBLIC LICENSE
-           Version 2, June 1991
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
 
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.
-     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
-          Preamble
+                            Preamble
 
   The licenses for most software are designed to take away your
 freedom to share and change it.  By contrast, the GNU General Public
@@ -15,7 +15,7 @@ software--to make sure the software is free for all its users.  This
 General Public License applies to most of the Free Software
 Foundation's software and to any other program whose authors commit to
 using it.  (Some other Free Software Foundation software is covered by
-the GNU Library General Public License instead.)  You can apply it to
+the GNU Lesser General Public License instead.)  You can apply it to
 your programs, too.
 
   When we speak of free software, we are referring to freedom, not
@@ -55,8 +55,8 @@ patent must be licensed for everyone's free use or not licensed at all.
 
   The precise terms and conditions for copying, distribution and
 modification follow.
-
-        GNU GENERAL PUBLIC LICENSE
+
+                    GNU GENERAL PUBLIC LICENSE
    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
   0. This License applies to any program or other work which contains
@@ -110,7 +110,7 @@ above, provided that you also meet all of these conditions:
     License.  (Exception: if the Program itself is interactive but
     does not normally print such an announcement, your work based on
     the Program is not required to print an announcement.)
-
+
 These requirements apply to the modified work as a whole.  If
 identifiable sections of that work are not derived from the Program,
 and can be reasonably considered independent and separate works in
@@ -168,7 +168,7 @@ access to copy from a designated place, then offering equivalent
 access to copy the source code from the same place counts as
 distribution of the source code, even though third parties are not
 compelled to copy the source along with the object code.
-
+
   4. You may not copy, modify, sublicense, or distribute the Program
 except as expressly provided under this License.  Any attempt
 otherwise to copy, modify, sublicense or distribute the Program is
@@ -225,7 +225,7 @@ impose that choice.
 
 This section is intended to make thoroughly clear what is believed to
 be a consequence of the rest of this License.
-
+
   8. If the distribution and/or use of the Program is restricted in
 certain countries either by patents or by copyrighted interfaces, the
 original copyright holder who places the Program under this License
@@ -255,7 +255,7 @@ make exceptions for this.  Our decision will be guided by the two goals
 of preserving the free status of all derivatives of our free software and
 of promoting the sharing and reuse of software generally.
 
-          NO WARRANTY
+                            NO WARRANTY
 
   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
@@ -277,9 +277,9 @@ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGES.
 
-         END OF TERMS AND CONDITIONS
-
-      How to Apply These Terms to Your New Programs
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
 
   If you develop a new program, and you want it to be of the greatest
 possible use to the public, the best way to achieve this is to make it
@@ -303,17 +303,16 @@ the "copyright" line and a pointer to where the full notice is found.
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 Also add information on how to contact you by electronic and paper mail.
 
 If the program is interactive, make it output a short notice like this
 when it starts in an interactive mode:
 
-    Gnomovision version 69, Copyright (C) year  name of author
+    Gnomovision version 69, Copyright (C) year name of author
     Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.
@@ -336,5 +335,5 @@ necessary.  Here is a sample; alter the names:
 This General Public License does not permit incorporating your program into
 proprietary programs.  If your program is a subroutine library, you may
 consider it more useful to permit linking proprietary applications with the
-library.  If this is what you want to do, use the GNU Library General
-Public License instead of this License.
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

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: ""