fontello_rails_converter 0.0.2 → 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmE5YjIxMTdiMmI1YjhkNzJhOTNlNWNiZTNlZTE5ODM0MWFlMmMwNA==
+  data.tar.gz: !binary |-
+    ZDdhNjEyMzA4ZmFhOTY1MDZkM2VmYTg2NGE4YzE5NmQ5NjQwZGUxOQ==
+SHA512:
+  metadata.gz: !binary |-
+    MTFlOTgxMmM4YTE3MTNiMTRmNzIwZGQzOWY2N2RmMGQ0N2IzNzNmY2NjNzRj
+    MWI3YzViYWFmOWQ3OTAzNTllNzdjZWM0MTVlOTdhM2QzZDI0NzM4YzMwOGM1
+    ZjY2M2M1ZGY2NmFjMzUwNDdiMzhjZTA2NzE3YjM2OTlmY2FjMDE=
+  data.tar.gz: !binary |-
+    Y2IzNjE0MmRiZTI4ODViNzdlMDgwZmExNjNlNjA1YWYzMzlmM2RjZjdhNTgx
+    ZDA0M2I0OWI3NjhjOGNmMmRhOTlhYzY2NjhjYmEzNzU4MTQ1NzEzY2E2ZjI1
+    ZWJhMDczNGMzODYwOGUwZDA2MTExMDhjZjEzZGM4OWUyZDdlM2Y=

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+### 0.1.0
+
+* convert the gem to a CLI tool
+* deprecated rake task
+
+### 0.0.2
+
+updated rubyzip dependency
+
+### 0.0.1
+
+initial release

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fontello_rails_converter.gemspec
 gemspec
+
+gem 'rails-dummy'
+gem 'sqlite3' # dummy app dependency

data/README.md

@@ -1,34 +1,53 @@
 ## fontello_rails_converter
 
-Rake task to be run on .zip file downloaded from fontello.com.  It will copy all the assets to the appropiate places in your Rails app and convert them where necessary.
+CLI gem for comfortably working with icon fonts from [http://fontello.com](http://fontello.com) for usage in Rails apps.
 
-## Usage
+Main features:
 
-1. Add the gem to your Gemfile `gem 'fontello_rails_converter'` and run `bundle install`
+* **Open** up your current fontello font in the browser from the command line
+* **Copy & convert** files from the zip into rails app (inclusively Sass enhancements)
 
-1. Download `.zip` file from [http://fontello.com](http://fontello.com) and copy it to your app directory, e.g. into `myapp/tmp/`
 
-1. Run the rake task `rake import_fontello["tmp/fontello-b9661c9f.zip"]`
+## Initial usage
 
-It will copy all the assets from the fontello .zip file into the appropiate places in your app's `vendor/assets/` directory.
+#### Rails app setup
 
-To use them in your app you will need to `@import` the main stylesheet `vendor/assets/stylesheets/fontname.css.scss` in your `application.css.sass` using `@import 'fontname'`.  For special cases you might also want `@import` some of the other stylesheets (`fontname-ie7-codes.css.scss`, `fontname-embedded.css.scss`, `animation.css.scss`, `fontname-ie7.css.scss`, `fontname-codes.css.scss`).
+Add the gem to your Gemfile `gem 'fontello_rails_converter'` and run `bundle install`
 
-In order for the fonts in `vendor/assets/fonts/` to be served up through the Rails asset pipeline, you will need tell it about font directories, by adding this to your `application.rb`:
+#### Get your icon font
 
-    config.assets.paths << Rails.root.join('app', 'assets', 'fonts')
+1. Download your initial `.zip` file from [http://fontello.com](http://fontello.com) and save it to `myapp/tmp/fontello.zip`
 
-You can check if the icon font is working correctly by visiting [http://localhost:3000/demo.html](http://localhost:3000/demo.html).
+1. Run `fontello convert` inside your app's root directory
 
-## Updating your font
+It will copy all the assets from the `fontello.zip` file into the appropiate places in your app's `vendor/assets/` directory.
 
-When you want to add new icons to your fontello font, just grab the `config.json` from `vendor/assets/fonts/` upload it to fontello, select new icons, download the .zip file and start at step 1.
+#### Use the font in your app
 
-## TODO
+To use your font in your app you will need to `@import` the main stylesheet `vendor/assets/stylesheets/fontname.css.scss` in your `application.css.sass` using `@import 'fontname'`.
 
-Fontello recently added an API ([https://github.com/fontello/fontello#developers-api](https://github.com/fontello/fontello#developers-api)), which would save us all the .zip file downloading hassle.
+You can check if the icon font is working correctly by visiting [http://localhost:3000/fontello-demo.html](http://localhost:3000/fontello-demo.html).
 
 
+## Updating your existing fontello font
 
+When you want to add new icons to your existing fontello font you can open it in the browser by using `fontello open` and select all the additional icons you want to add.
 
+Next you click the 'Save session' button on the fontello website. After that you can download, copy and convert the changed font by running `fontello convert` (it has persisted the session id in `tmp/fontello_session_id` and will used that to pull down your changed font).
+
+Alternatively, you can download & save the `.zip` file just like in the initial setp and run `fontello convert --no-download` to use the manually downloaded file instead of pulling it down from fontello.
+
+## More help
+
+For more help run `fontello --help`
+
+## Misc
+
+#### Additional fontello stylesheets
+
+Besides the main stylesheet (`fontname.css.scss`) fontello also provides a couple of additional stylesheets that you might want to `@import` in your app for special use cases:  `fontname-ie7-codes.css.scss`, `fontname-embedded.css.scss`, `animation.css.scss`, `fontname-ie7.css.scss`, `fontname-codes.css.scss`
+
+----
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/railslove/fontello_rails_converter/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 

data/Rakefile

@@ -1 +1,2 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rails/dummy/tasks'

data/bin/fontello

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require "fontello_rails_converter"
+command = ARGV[0]
+
+if ARGV[0].nil?
+  puts "Run fontello --help for help"
+  exit
+end
+
+def options_based_on_rails_root(options)
+  options[:asset_dir] = "#{options[:rails_root_dir]}/vendor/assets"
+  options.merge!({
+    stylesheet_dir: "#{options[:asset_dir]}/stylesheets",
+    font_dir: "#{options[:asset_dir]}/fonts",
+    zip_file: "#{options[:rails_root_dir]}/tmp/fontello.zip",
+    config_file: "#{options[:asset_dir]}/fonts/config.json",
+    fontello_session_id_file: "#{options[:rails_root_dir]}/tmp/fontello_session_id"
+  })
+end
+
+options = { rails_root_dir: "." } # default
+options = options_based_on_rails_root(options)
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: fontello COMMAND [options]\n\n"
+
+  opts.separator "Available commands: open, convert, download\n\n"
+
+  opts.separator "Global options:"
+
+  opts.on("-i", "--fontello-session-id [ID]", "Pass in session ID from fontello.com (e.g. fb235ab72cad01d2b46aaa023ab4abbd) otherwise it will be taken from session-id-file\n\n") do |opt|
+    options[:fontello_session_id] = opt
+  end
+
+  opts.separator "`open` options:"
+
+  opts.on("-e", "--open-existing", "Doesn't open fontello based on config.json, but based on passed in or persisted sesssion id\n\n") do |opt|
+    options[:open_existing] = true
+  end
+
+  opts.separator "`convert` options:"
+
+  opts.on("-n", "--no-download", "Converts existing .zip file without automatically downloading a new one\n\n") do |opt|
+    options[:no_download] = true
+  end
+
+  opts.separator "`download` options:"
+
+  opts.on("-u", "--use-config", "Uses existing config.json instead of persisted or passed in fontello session ID\n\n") do |opt|
+    options[:use_config] = true
+  end
+
+  opts.separator "Path options:"
+
+  opts.on("-r", "--rails-root [PATH]", "Rails root path (default: current location)") do |opt|
+    options[:rails_root_dir] = opt
+    options = options_based_on_rails_root(options)
+  end
+
+  opts.on("-c", "--config-file [PATH]", "config.json file (default: /rails_root/vendor/assets/fonts/config.json)") do |opt|
+    options[:config_file] = opt
+  end
+
+  opts.on("-z", "--zip-file [PATH]", "Downloaded zip file (default: /rails_root/tmp/fontello.zip)") do |opt|
+    options[:zip_file] = opt
+  end
+
+  opts.on("-a", "--asset-dir [PATH]", "Target asset directory (default: /rails_root/vendor/assets)") do |opt|
+    options[:asset_dir] = opt
+  end
+
+  opts.on("-s", "--stylesheet-dir [PATH]", "Target stylesheet directory (default: /rails_root/vendor/assets/stylesheets)") do |opt|
+    options[:stylesheet_dir] = opt
+  end
+
+  opts.on("-f", "--font-dir [PATH]", "Target font directory (default: /rails_root/vendor/assets/fonts)") do |opt|
+    options[:font_dir] = opt
+  end
+
+  opts.on("-p", "--session-id-file [PATH]", "File to persist fontello session ID (default: /rails_root/tmp/fontello_session_id)") do |opt|
+    options[:font_dir] = opt
+  end
+
+  opts.separator "\nExamples:\n"\
+                 "    fontello open -r /path/to/railsapp\n"\
+                 "    fontello convert\n"\
+                 "    fontello download -e -i fb235ab72cad01d2b46aaa023ab4abbd\n"
+end.parse!
+
+
+unless ["open", "download", "convert"].include?(command)
+  puts "available commands: open, download, convert"
+  exit
+end
+
+FontelloRailsConverter::Cli.new(options).send(command)

data/fontello_rails_converter.gemspec

@@ -18,9 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "rails", ">= 3.1"
   spec.add_runtime_dependency "rubyzip", "~> 1.0"
+  spec.add_runtime_dependency "launchy"
+  spec.add_runtime_dependency "rest-client"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry-debugger"
 end

data/lib/fontello_rails_converter/cli.rb

@@ -0,0 +1,110 @@
+require 'fileutils'
+require 'launchy'
+require 'zip'
+
+module FontelloRailsConverter
+  class Cli
+    include ColorizedOutput
+
+    def initialize(options)
+      @options = options
+      @fontello_api = FontelloApi.new @options
+    end
+
+    def open
+      @fontello_api.new_session_from_config  unless @options[:open_existing] == true
+      Launchy.open @fontello_api.session_url
+    end
+
+    def download
+      @fontello_api.new_session_from_config  if @options[:use_config] == true
+      File.open(@options[:zip_file], "w+") do |file|
+        file.write @fontello_api.download_zip_body
+      end
+    end
+
+    def convert
+      self.download  unless @options[:no_download] == true || !config_file_exists?
+      self.prepare_directories
+
+      Zip::File.open(@options[:zip_file]) do |zipfile|
+        zipfile.each do |file|
+          filename = file.to_s.split("/").last
+
+          # stylesheets
+          if filename.end_with? '.css'
+            # extract stylesheet to target location
+            target_file = File.join @options[:stylesheet_dir], "#{filename}.scss"
+            zipfile.extract(file, target_file) { true }
+            puts green("copied #{target_file}")
+
+            if !filename.end_with? "animation.css", "-ie7.css", "-codes.css", "-ie7-codes.css", "-embedded.css"
+              converted_css = self.convert_main_stylesheet File.read(target_file)
+              File.open(target_file, 'w') { |f| f.write(converted_css) }
+              puts green("converted #{target_file} for Sass & asset pipeline")
+            end
+
+          # font files
+          elsif filename.end_with? ".eot", ".woff", ".ttf", ".svg", "config.json"
+            target_file = File.join @options[:font_dir], filename
+            zipfile.extract(file, target_file) { true }
+            puts green("copied #{target_file}")
+
+          # demo.html
+          elsif filename == 'demo.html'
+            target_file = File.join @options[:rails_root_dir], "public", "fontello-demo.html"
+            zipfile.extract(file, target_file) { true }
+            puts green("copied #{target_file}")
+
+            converted_html = convert_demo_html File.read(target_file)
+            File.open(target_file, 'w') { |f| f.write(converted_html) }
+            puts green("converted #{filename}'s HTML for asset pipeline")
+          end
+
+        end
+      end
+    end
+
+    def prepare_directories
+      FileUtils.mkdir_p @options[:font_dir]
+      FileUtils.mkdir_p @options[:stylesheet_dir]
+      FileUtils.mkdir_p @options[:asset_dir]
+    end
+
+    def convert_main_stylesheet(content)
+      # asset URLs
+      content.gsub! /\.\.\/font\//, ""
+      content.gsub!(/url\(([^\(]+)\)/) { |m| "url(font-path(#{$1}))" }
+
+      # turn icon base class into placeholder selector
+      content.gsub! /\[class\^="icon-[^\{]+{/m, "%icon-base {"
+
+      # get icons
+      icons = content.scan(/\.(icon-\S+):before/).map(&:first)
+
+      # convert icon classes to placeholder selectors
+      content.gsub!(/^\.(icon-\S+:before) { (.+)$/) { |m| "%#{$1} { @extend %icon-base; #{$2}" }
+
+      # recreate icon classes using the mixins
+      if icons.any?
+        content += "\n\n"
+        icons.each do |icon|
+          content += ".#{icon} { @extend %#{icon}; }\n"
+        end
+      end
+
+      return content
+    end
+
+    private
+
+      def config_file_exists?
+        @options[:config_file] && File.exist?(@options[:config_file])
+      end
+
+      def convert_demo_html(content)
+        content.gsub! /css\//, "/assets/"
+      end
+
+  end
+end

data/lib/fontello_rails_converter/fontello_api.rb

@@ -0,0 +1,49 @@
+require 'rest_client'
+require 'json'
+
+module FontelloRailsConverter
+  class FontelloApi
+    FONTELLO_HOST = "http://fontello.com"
+
+    def initialize(options)
+      @config_file = options[:config_file]
+      @session_id = options[:fontello_session_id]
+      @fontello_session_id_file = options[:fontello_session_id_file]
+    end
+
+    # creates a new fontello session from config.json
+    def new_session_from_config
+      @session_id = RestClient.post FONTELLO_HOST, config: File.new(@config_file, 'rb')
+      persist_session
+      @session_id
+    end
+
+    def session_url
+      "#{FONTELLO_HOST}/#{session_id}"
+    end
+
+    def download_zip_body
+      response = RestClient.get "#{session_url}/get"
+      response.body
+    end
+
+    private
+
+      def session_id
+        @session_id ||= read_or_create_session
+      end
+
+      def read_or_create_session
+        if @fontello_session_id_file && File.exist?(@fontello_session_id_file)
+          @session_id = File.read(@fontello_session_id_file)
+          return @session_id  unless @session_id == ""
+        end
+
+        new_session_from_config
+      end
+
+      def persist_session
+        File.open(@fontello_session_id_file, 'w+') { |f| f.write @session_id }
+      end
+  end
+end

data/lib/fontello_rails_converter/railtie.rb

@@ -3,5 +3,9 @@ module FontelloRailsConverter
     rake_tasks do
       load File.join(File.dirname(__FILE__), '../tasks/fontello_rails_converter.rake')
     end
+
+    initializer "fontello_rails_converter.setup" do |app|
+      app.config.assets.paths << Rails.root.join('app', 'assets', 'fonts')
+    end
   end
 end

data/lib/fontello_rails_converter/version.rb

@@ -1,3 +1,3 @@
 module FontelloRailsConverter
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/fontello_rails_converter.rb

@@ -1,7 +1,8 @@
 require "fontello_rails_converter/version"
 require "fontello_rails_converter/colorized_output"
-require "fontello_rails_converter/railtie"
+require "fontello_rails_converter/fontello_api"
+require "fontello_rails_converter/cli"
+require "fontello_rails_converter/railtie" if defined?(Rails)
 
 module FontelloRailsConverter
-  # Your code goes here...
 end

data/lib/tasks/fontello_rails_converter.rake

@@ -1,5 +1,7 @@
-desc "import new zipfile from fontello"
+desc "[deprecated] import new zipfile from fontello"
 task :import_fontello, [:zipfile] => :environment do |t, args|
+  puts "THIS RAKE TASK IS DEPRECATED AND WILL BE REMOVED IN THE NEXT VERSION"
+
   include FontelloRailsConverter::ColorizedOutput
   require 'zip'
 
@@ -74,7 +76,7 @@ task :import_fontello, [:zipfile] => :environment do |t, args|
 
       # demo.html
       elsif filename == 'demo.html'
-        target_file = File.join Rails.root, "public", filename
+        target_file = File.join Rails.root, "public", "fontello-demo.html"
         zipfile.extract(file, target_file) { true }
         puts green("copied #{target_file}")
 

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config/application.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "fontello_rails_converter"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!