noft 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b18d3b368d0d7a28485e5e597be24ce57acde43f
+  data.tar.gz: c2ac67eae485026b52792928dc9b9f13bdf7a7a2
+SHA512:
+  metadata.gz: 18dc12efb79cbaa9731a3448bf66ac47c21ba5cc49bf0cbf75a1fc83cd83a6fdf3484f40f7d8d77c177c970aa418ee09a23e584d1b76f674d69175920968c7c2
+  data.tar.gz: d41e16f253793691c75179b83df411bbc89ec5f4b897c2c4ef99f342ef9bd22984b812aca3b264d78c7ebaa6045fea2c23908593f004f9ecc1a8aed833ec2533

data/.gitattributes

@@ -0,0 +1,8 @@
+* -text
+*.rb text -crlf -binary
+*.rdoc text -crlf -binary
+*.textile text -crlf -binary
+*.txt text -crlf -binary
+*.erb text -crlf -binary
+*.svg text -crlf -binary
+*.json text -crlf -binary

data/.gitignore

@@ -0,0 +1,9 @@
+*.iml
+/*.ipr
+/*.iws
+/.rakeTasks
+/Gemfile.lock
+/patch.diff
+/pkg
+/rdoc
+/tmp

data/.node-version

@@ -0,0 +1 @@
+6.10.3

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.3.1
+node_js:
+  - v6.10.3
+git:
+  depth: 10
+before_install:
+  - nvm install v6.10.3
+  - nvm use v6.10.3
+  - gem update bundler

data/CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# How to Contribute
+
+Pull requests are greatly appreciated and are what makes opensource great. Here's a quick guide:
+
+* Fork it
+* Create your feature branch (`git checkout -b my-new-feature`)
+* Commit your changes (`git commit -am 'Add some feature'`)
+* Push to the branch (`git push origin my-new-feature`)
+* Create new Pull Request
+
+Pester us if we don't get your Pull Requests merged in a timely fashion. :)
+
+## How to speed the merging of pull requests
+
+* Describe your changes in the CHANGELOG.
+* Give yourself some credit in the appropriate place (usually the CHANGELOG).
+* Make commits of logical units.
+* Ensure your commit messages help others understand what you are doing and why.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Maintain the same code style.
+* Maintain the same level of test coverage or improve it.
+
+## Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '= 0.9.2.2'

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,65 @@
+# noft
+
+[![Build Status](https://secure.travis-ci.org/realityforge/noft.png?branch=master)](http://travis-ci.org/realityforge/noft)
+
+`noft` is a tool to extract svg icons from icon fonts and generate helpers to render the icons
+in different web frameworks. `noft` automates
+
+# Getting Started
+
+Noft makes extensive use of the [font-blast](https://www.npmjs.com/package/font-blast) node package. To use this
+tool it is expected that you have installed Node and NPM. See [https://www.npmjs.com/get-npm](https://www.npmjs.com/get-npm)
+if that is not the case. Then you need to install `font-blast`. This may require the following steps:
+
+    # If your project does not yet have NPMs package.json file present
+    $ npm init
+
+    # Install font-blast
+    $ npm install font-blast --save-dev
+
+## Motivation
+
+Several of our applications made use of font icon libraries either as part of larger frontend frameworks
+(i.e. [Bootstrap](http://getbootstrap.com/)) or using individual libraries (i.e. [Font Awesome](http://fontawesome.io/)).
+Often our applications would use an extremely small subset of the icons from these sources. The application
+would also combine it with custom icon fonts constructed on websites such as [FlatIcon](flaticon.com). As a
+result our applications would have 100s or 1000s of unused css classes and unused glyphs. For frameworks
+like [GWT](http://www.gwtproject.org/) this also necessitated 1000s of lines of unused java code for
+`CssResource` bundles. All of this slowed down development time and increased the size of assets downloaded
+by web clients. In some cases we were forced to manually remove unused css classes, font glyphs and java methods
+but it was labour intensive (and thus expensive), somewhat error prone and extremely boring.
+
+Looking towards the architecture of future applications we came across several articles about moving from
+icon fonts to svg. In particular the article["Making the Switch Away from Icon Fonts to SVG: Converting Font Icons to SVG"](https://sarasoueidan.com/blog/icon-fonts-to-svg/) by Sara
+Soueidan and the article ["Delivering Octicons with SVG"](https://github.com/blog/2112-delivering-octicons-with-svg)
+from GitHub about their move away from font icons motivated us to make the switch. Unwilling to lose the investment
+in our current icons we created this tool to help automate the conversion of our current icons to helpers that
+injected icons where we needed it.
+
+## TODO
+
+Here are a bunch of TODO notes. They are just pointers to the authors about work not yet done and may not be
+decipherable to outside parties.
+
+* Add generator that generates a html view page like Font-Awesomes.
+* Add simple way to generate a github site that publishes this index page as GitHub site.
+
+* Consider chaining https://github.com/ananthakumaran/webify for ttf fonts
+
+* Generate a GWT helper that generates methods that emit SafeHtml for each svg icon. The generated svg
+  should probably be patched to allow setting width, height, aria-hidden=true, aria-role=img. See the
+  GitHub implementation of similar concept https://github.com/blog/2112-delivering-octicons-with-svg
+* Generate React helper for the same.
+
+* Add documentation describing full process
+* Link to font-awesome usage of this library and possible demonstrate using other examples from other font libraries
+  not unlike https://github.com/eugene1g/font-blast-examples
+
+* Figure out a mechanism for bringing in css classes not unlike in FontAwesome https://github.com/FortAwesome/Font-Awesome/tree/master/scss
+
+* Add a watcher that waits for changes of either fonts or `noft.rb` and re-runs relevant tools.
+  https://github.com/guard/listen
+
+* Adapt hints from https://css-tricks.com/using-svg/
+
+* Optimize svg as part of process via https://github.com/svg/svgo

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rubygems/package_task'
+require 'rake/testtask'
+
+desc 'Default Task'
+task :default => [:test, :build]
+
+desc 'Test Task'
+Rake::TestTask.new do |t|
+  files = FileList['test/helper.rb', 'test/**/test_*.rb']
+  t.loader = :rake
+  t.test_files = files
+  t.libs << '.'
+  t.warning = true
+end

data/bin/noft

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'noft'
+
+Noft::Runner.new.run

data/lib/noft.rb

@@ -0,0 +1,30 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'json'
+require 'fileutils'
+require 'schmooze'
+
+require 'reality/mda'
+require 'reality/core'
+require 'reality/facets'
+require 'reality/generators'
+require 'reality/model'
+require 'reality/naming'
+
+require 'noft/model'
+require 'noft/generator'
+
+require 'noft/base/templates/assets'
+require 'noft/base/model'

data/lib/noft/base/model.rb

@@ -0,0 +1,50 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Noft
+  module Base
+    class BaseRepository
+      class << self
+        include Noft::ArtifactDSL
+
+        def facet_key
+          nil
+        end
+
+        def target_key
+          :icon_set
+        end
+      end
+
+      artifact(:svg_assets, :guard => 'icon_set.font_file?') do |template_set, facets, helpers, template_options|
+        Noft::Base::AssetsTemplate.new(template_set,
+                                       facets,
+                                       self.target_key,
+                                       'svg_assets',
+                                       'assets/#{icon_set.name}',
+                                       helpers,
+                                       template_options)
+      end
+      artifact(:assets, :guard => 'icon_set.font_file?') do |template_set, facets, helpers, template_options|
+        Noft::Base::AssetsTemplate.new(template_set,
+                                       facets,
+                                       self.target_key,
+                                       'svg_assets',
+                                       '',
+                                       helpers,
+                                       template_options)
+      end
+    end
+  end
+end