icomoon 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53b0108a30656c9c7590ed344b6343d72947be75
+  data.tar.gz: 103310f193a88ea46fb4098dfb905f1e02ecf607
+SHA512:
+  metadata.gz: 53158fe6b99a2a08effbe4603e589fd7f74d49419aaaa9922d8918511faead57a44fd582f24f9a28ae38b614dbf6c40a883aba0c4bae90bae0468de58302ae2a
+  data.tar.gz: c39ba697be84deff9885723059921aa2b2fd3a5394d2283a3a40c0487824faaeee7f48306b7691a7824c841fdab119a12d6f7048e04dba6e96eafebc64c2e8cb

data/README.md

@@ -0,0 +1,31 @@
+# Icomoon
+This helper will make using Icomoon icons set easier.
+
+## Usage
+If you want to use Icomoon icons on your project, this is what will help you.
+
+### Installation
+Add this to your Gemfile:
+```ruby
+gem 'icomoon'
+```
+And then `bundle install`. You can always run `icomoon help` if you need help.
+
+### Getting started
+- run `icomoon init`
+
+### Adding/removing icons (basically updating your icon set)
+- open [IcoMoon App](https://icomoon.io/app/#/projects)
+- click "Import Project" and select icomoon.json file from your project (it's located in the "Directory of fonts files" directory from the survey you took before)
+- click "Load" on the imported project
+- add/remove icons, change project preferences
+- download set and unzip without changing folder name
+- run `icomoon import` and specify location of unzipped icon set (`--dir` or `-d`)
+- update icons file code (will display)
+
+## Requirements
+- ruby 2.2.2 or higher
+- requires your application to use SASS/SCSS
+
+## Note
+It was tested on OS X only, not tested on Linux nor Windows.

data/bin/icomoon

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'icomoon/cli'
+
+Icomoon::Cli.start(ARGV)

data/lib/icomoon.rb

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

data/lib/icomoon/cli.rb

@@ -0,0 +1,59 @@
+require 'pry'
+require 'json'
+require 'colorize'
+
+require 'icomoon/cli/exec_param'
+require 'icomoon/cli/exec'
+require 'icomoon/cli/parse_argv'
+require 'icomoon/cli/survey'
+require 'icomoon/cli/question'
+require 'icomoon/cli/logger'
+require 'icomoon/cli/operation'
+require 'icomoon/cli/writer'
+require 'icomoon/cli/config'
+require 'icomoon/cli/icon'
+
+module Icomoon
+  module Cli
+    MANIFEST_FILENAME = 'icomoon.json'
+
+    Error   = Class.new(StandardError)
+    Warning = Class.new(StandardError)
+
+    class << self
+      def start(argv)
+        Icomoon::Cli::Exec.run(argv)
+      end
+
+      def logs(text)
+        logger.log(text, true)
+      end
+
+      def log(text)
+        logger.log(text, false)
+      end
+
+      def error(text)
+        puts "#{'Error:'.red} #{text}"
+      end
+
+      def put_separator
+        logs('---')
+      end
+
+      def file_exists?(path)
+        File.exists?(path)
+      end
+
+      def logger
+        @@logger
+      end
+
+      def logger=(logger)
+        @@logger = logger
+      end
+
+      @@logger = Icomoon::Cli::Logger.new
+    end
+  end
+end

data/lib/icomoon/cli/config.rb

@@ -0,0 +1,43 @@
+module Icomoon
+  module Cli
+    class Config
+      CONFIG_FILE_NAME = '.icomoon-config.json'
+
+      class << self
+        def read
+          if !File.exists? config_file_full_path
+            fail Icomoon::Cli::Error, 'Config file not found.'
+          end
+
+          content = JSON.parse(File.read(config_file_full_path))
+
+          Struct.new(
+            :icons_set_name,
+            :icons_file_path,
+            :fonts_file_dir,
+            :css_class
+          ).new(
+            content['icons_set_name'],
+            content['icons_file_path'],
+            content['fonts_file_dir'],
+            content['css_class']
+          )
+        end
+
+        def write(config)
+          Icomoon::Cli::Writer.write(CONFIG_FILE_NAME) do |file|
+            file.puts(JSON.pretty_generate(config))
+          end
+        end
+
+        def config_file_exists?
+          File.exists? CONFIG_FILE_NAME
+        end
+
+        def config_file_full_path
+          File.expand_path(CONFIG_FILE_NAME)
+        end
+      end
+    end
+  end
+end

data/lib/icomoon/cli/exec.rb

@@ -0,0 +1,31 @@
+require 'icomoon/version'
+
+require 'icomoon/cli/exec/base'
+require 'icomoon/cli/exec/init'
+require 'icomoon/cli/exec/import'
+require 'icomoon/cli/exec/help'
+
+module Icomoon
+  module Cli
+    module Exec
+      class << self
+        def run(argv)
+          command = argv.shift
+
+          case command
+          when 'init'
+            Icomoon::Cli::Exec::Init.run(argv)
+          when 'import'
+            Icomoon::Cli::Exec::Import.run(argv)
+          when 'help', nil
+            Icomoon::Cli::Exec::Help.run(argv)
+          when 'version', '--version', '-v'
+            Icomoon::Cli.logs Icomoon::VERSION
+          else
+            Icomoon::Cli.logs "invalid command: #{command}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/icomoon/cli/exec/base.rb

@@ -0,0 +1,59 @@
+module Icomoon
+  module Cli
+    module Exec
+      class Base
+        @@params = []
+
+        def self.params
+          @@params
+        end
+
+        def initialize(args)
+          @args = args
+        end
+
+        class << self
+          def run(argv)
+            if argv.count == 1 && argv[0] == 'help'
+              return display_help
+            end
+
+            new(Icomoon::Cli::ParseArgv.call(argv, params)).run
+          end
+
+          def display_help
+            puts @command_help_text
+          end
+
+          def help(text)
+            @command_help_text = text
+          end
+
+          def param(*args)
+            add_param(true, *args)
+          end
+
+          def flag(*args)
+            add_param(false, *args)
+          end
+
+          def add_param(needs_value, *args)
+            key = args.shift
+            params << Icomoon::Cli::ExecParam.new(key, args, needs_value) if args.count.nonzero?
+
+            method_name = needs_value ? key : "#{key}?"
+            define_param_reader(key, method_name)
+          end
+
+          def define_param_reader(key, method_name = key)
+            class_eval("def #{method_name}; args[#{key.to_sym.inspect}] rescue nil; end")
+          end
+        end
+
+        private
+
+        attr_reader :args
+      end
+    end
+  end
+end

data/lib/icomoon/cli/exec/help.rb

@@ -0,0 +1,23 @@
+module Icomoon
+  module Cli
+    module Exec
+      class Help < Icomoon::Cli::Exec::Base
+        help <<~STRING
+          :-)
+        STRING
+
+        def run
+          puts <<~STRING
+            Usage: icomoon command [...options]
+
+            Run `icomoon command help` to get help about specific command.
+
+            Commands:
+              - help      Displays this help text.
+              - init      Initializes and configures Icomoon.
+          STRING
+        end
+      end
+    end
+  end
+end

data/lib/icomoon/cli/exec/import.rb

@@ -0,0 +1,143 @@
+require 'fileutils'
+
+module Icomoon
+  module Cli
+    module Exec
+      class Import < Icomoon::Cli::Exec::Base
+        CONFIG_FILE_NAME = '.icomoonrc'
+        EXTENSIONS = %w[eot ttf woff svg].freeze
+
+        help <<~STRING
+          Usage: icomoon import [--major]
+
+          This subprogram imports fonts files and JSON manifest from given
+          directory. It also updates icon font version.
+
+          options:
+
+            -dir, -d          Specifies source directory for importing files.
+                              This option is required.
+        STRING
+
+        param :source_dir, '--dir', '-d'
+
+        def run
+          Icomoon::Cli::Operation.new do
+            validate_params
+          end
+
+          Icomoon::Cli::Operation.new do
+            read_config
+          end
+
+          Icomoon::Cli::Operation.new 'Checking files' do
+            EXTENSIONS.each do |ext|
+              check_source_file("fonts/#{config.icons_set_name}.#{ext}")
+            end
+          end
+
+          Icomoon::Cli::Operation.new 'Copying font files' do
+            EXTENSIONS.each do |ext|
+              filename = "#{config.icons_set_name}.#{ext}"
+              copy_file(filename, source_subdir: 'fonts')
+            end
+          end
+
+          Icomoon::Cli::Operation.new 'Copying JSON manifest' do
+            copy_file('selection.json', target_filename: Icomoon::Cli::MANIFEST_FILENAME)
+          end
+
+          Icomoon::Cli::Operation.new do
+            validate_and_print_code
+          end
+
+          Icomoon::Cli::Operation.dump_warnings
+          Icomoon::Cli::Operation.dump_errors
+        end
+
+        private
+
+        attr_reader :config
+
+        def read_config
+          @config = Icomoon::Cli::Config.read
+        end
+
+        def check_source_file(path)
+          absolute_path = File.join(source_dir, config.icons_set_name, path)
+          return true if File.exists?(absolute_path)
+          fail Icomoon::Cli::Error, "File not found: #{absolute_path}"
+        end
+
+        def copy_file(filename, source_subdir: '', target_filename: filename)
+          FileUtils.cp(
+            File.join(source_dir, config.icons_set_name, source_subdir, filename),
+            File.expand_path(File.join(config.fonts_file_dir, target_filename))
+          )
+        rescue StandardError => e
+          fail Icomoon::Cli::Error, e.message
+        end
+
+        def validate_and_print_code
+          css_icons_path  = File.expand_path(config.icons_file_path)
+          css_icon_regex  = /\&--([0-9a-z_\-]+)\:before \{\s+content: \"\\(e[0-9a-f]+)\"/
+          css_icons       = array_to_icons(File.read(css_icons_path).scan(css_icon_regex))
+
+          svg_icons_path = File.expand_path(File.join(config.fonts_file_dir, "#{config.icons_set_name}.svg"))
+          svg_icon_regex = /unicode=\"&#x([0-9a-z]+);\" glyph-name=\"([0-9a-z_\-]+)\"/
+          svg_icons      = array_to_icons(File.read(svg_icons_path).scan(svg_icon_regex).map(&:reverse))
+
+          find_unused_icons(css_icons, svg_icons)
+          print_code_update(css_icons, svg_icons)
+        end
+
+        def find_unused_icons(css_icons, svg_icons)
+          unused_icons = css_icons.select do |css_icon|
+            svg_icons.map(&:code).index(css_icon.code).nil?
+          end
+
+          n = unused_icons.count
+
+          return true if n.zero?
+
+          names   = unused_icons.map(&:name).join(', ')
+          message =  "#{n} unused #{n == 1 ? 'icon' : 'icons'} detected: #{names}."
+          Icomoon::Cli::Operation.warn! message
+        end
+
+        def print_code_update(css_icons, svg_icons)
+          missing_icons = svg_icons.select do |svg_icon|
+            css_icons.map(&:code).index(svg_icon.code).nil?
+          end
+
+          if missing_icons.count.zero?
+            Icomoon::Cli::Operation.warn! 'No new icons detected.'
+            return
+          end
+
+          code = missing_icons.map do |icon|
+            <<~STRING
+              &--#{icon.name}:before {
+                content: "\\#{icon.code}";
+              }
+            STRING
+          end.join("\n").cyan
+
+          puts "\nAdd this to #{config.icons_file_path}:\n\n#{code}"
+        end
+
+        def validate_params
+          if source_dir.nil?
+            fail Icomoon::Cli::Error, 'Source directory argument (--dir, -d) is required.'
+          end
+        end
+
+        def array_to_icons(array)
+          array.map do |name, code|
+            Icomoon::Cli::Icon.new(name, code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/icomoon/cli/exec/init.rb

@@ -0,0 +1,160 @@
+module Icomoon
+  module Cli
+    module Exec
+      class Init < Icomoon::Cli::Exec::Base
+        help <<~STRING
+          Usage: icomoon init [--force, -f]
+
+          This subprogram will help you to create starting
+          files such as icon stylesheet file and config initializer.
+          Just run `icomoon init` and follow instructions.
+
+          options:
+
+            --force, -f       Overrides config and stylesheet files.
+        STRING
+
+        flag :force, '--force', '-f'
+
+        def run
+          config = Icomoon::Cli::Survey.run do |s|
+            s.ask :icons_set_name, 'Icon set name', 'icomoon-icons'
+            s.ask :icons_file_path, 'Path of icons stylesheet file', 'app/assets/stylesheets/_icons.scss'
+            s.ask :fonts_file_dir, 'Directory of fonts files', 'app/assets/fonts/'
+            s.ask :css_class, 'CSS icon class', 'icon'
+          end
+
+          dir           = config[:fonts_file_dir]
+          manifest_path = File.expand_path(File.join(dir, Icomoon::Cli::MANIFEST_FILENAME))
+
+          Icomoon::Cli.put_separator
+
+          Icomoon::Cli::Operation.new do
+            ensure_pristine(config, manifest_path)
+          end
+
+          Icomoon::Cli::Operation.new 'Creating config file' do
+            write_config(config)
+          end
+
+          Icomoon::Cli::Operation.new 'Initializing icons stylesheet' do
+            write_styles(config)
+          end
+
+          Icomoon::Cli::Operation.new 'Creating JSON manifest' do
+            write_manifest(config, manifest_path)
+          end
+
+          Icomoon::Cli::Operation.dump_warnings
+          Icomoon::Cli::Operation.dump_errors
+        end
+
+        private
+
+        def ensure_pristine(config, manifest_path)
+          return true if force?
+
+          force_tip = 'use --force (-f) option if you want to override.'
+
+          if Icomoon::Cli::Config.config_file_exists?
+            fail Icomoon::Cli::Error, 'Config file already exists, '\
+              + force_tip
+          end
+
+          if Icomoon::Cli.file_exists?(config[:icons_file_path])
+            fail Icomoon::Cli::Error, 'Styles file already exists, '\
+              + force_tip
+          end
+
+          if Icomoon::Cli.file_exists?(manifest_path)
+            fail Icomoon::Cli::Error, 'icomoon.json file already exists, '\
+              + force_tip
+          end
+        end
+
+        def write_config(config)
+          Icomoon::Cli::Config.write(config)
+        end
+
+        def write_styles(config)
+          icons_file_path = config[:icons_file_path]
+          icons_set_name  = config[:icons_set_name]
+          css_class       = config[:css_class]
+
+          Icomoon::Cli::Writer.write(icons_file_path) do |file|
+            file.puts(<<~STRING
+              @font-face {
+                font-family: '#{icons_set_name}';
+                src: asset-url('#{icons_set_name}.eot');
+                src: asset-url('#{icons_set_name}.eot') format('embedded-opentype'),
+                  asset-url('#{icons_set_name}.ttf') format('truetype'),
+                  asset-url('#{icons_set_name}.woff') format('woff');
+              }
+
+              .#{css_class} {
+                font-family: '#{icons_set_name}';
+
+                // &--icon-name:before {
+                //   content: \"\\e900\";
+                // }
+              }
+            STRING
+            )
+          end
+        end
+
+        def write_manifest(config, manifest_path)
+          font_name       = config[:icons_set_name]
+          css_class       = config[:css_class]
+          icons_file_path = config[:icons_file_path]
+          prefix          = "#{css_class}-"
+
+          Icomoon::Cli::Writer.write_json(
+            manifest_path,
+            IcoMoonType: 'selection',
+            icons: [],
+            height: 1024,
+            metadata: {
+              name: font_name
+            },
+            preferences: {
+              showGlyphs: true,
+              showQuickUse: true,
+              showQuickUse2: true,
+              showSVGs: true,
+              fontPref: {
+                prefix: prefix,
+                metadata: {
+                  fontFamily: font_name,
+                  majorVersion: 0,
+                  minorVersion: 1
+                },
+                metrics: {
+                  emSize: 1024,
+                  baseline: 6.25,
+                  whitespace: 50
+                },
+                embed: false,
+                showSelector: false,
+                showMetrics: false,
+                showMetadata: false,
+                showVersion: false
+              },
+              imagePref: {
+                prefix: prefix,
+                png: true,
+                useClassSelector: true,
+                color: 0,
+                bgColor: 16777215,
+                classSelector: ".#{css_class}"
+              },
+              historySize: 50,
+              showCodes: true,
+              gridSize: 16
+            }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/icomoon/cli/exec_param.rb

@@ -0,0 +1,13 @@
+module Icomoon
+  module Cli
+    class ExecParam
+      attr_reader :key, :aliases, :needs_value
+
+      def initialize(key, aliases, needs_value)
+        @key         = key
+        @aliases     = aliases || []
+        @needs_value = needs_value
+      end
+    end
+  end
+end

data/lib/icomoon/cli/icon.rb

@@ -0,0 +1,12 @@
+module Icomoon
+  module Cli
+    class Icon
+      def initialize(name, code)
+        @name = name
+        @code = code
+      end
+
+      attr_reader :name, :code
+    end
+  end
+end

data/lib/icomoon/cli/logger.rb

@@ -0,0 +1,15 @@
+module Icomoon
+  module Cli
+    class Logger
+      PREFIX = "[#{'icomoon'.light_blue}]".freeze
+
+      def log(text, break_line)
+        if break_line
+          puts "#{PREFIX} #{text}"
+        else
+          print "#{PREFIX} #{text}"
+        end
+      end
+    end
+  end
+end

data/lib/icomoon/cli/operation.rb

@@ -0,0 +1,54 @@
+module Icomoon
+  module Cli
+    class Operation
+      @@warnings = []
+      @@errors   = []
+      @@skip_all = false
+
+      def initialize(name = nil)
+        return unless block_given?
+        return if self.class.skip?
+
+        Icomoon::Cli.log "#{name}... " if name
+
+        begin
+          yield
+          puts '✔'.green if name
+        rescue Icomoon::Cli::Error => error
+          @@errors << error
+          puts '✘'.red if name
+          Icomoon::Cli::Operation.skip_all!
+        rescue Icomoon::Cli::Warning => warning
+          @@warnings << warning
+          puts '✘'.red if name
+        end
+      end
+
+      def self.dump_warnings
+        while (warning = @@warnings.shift)
+          Icomoon::Cli.logs "#{'Warning:'.yellow} #{warning.message}"
+        end
+      end
+
+      def self.dump_errors(exit_code = nil)
+        while (error = @@errors.shift)
+          Icomoon::Cli.logs "#{'Error:'.red} #{error.message}"
+        end
+
+        exit(exit_code) if exit_code
+      end
+
+      def self.warn!(message)
+        @@warnings << Icomoon::Cli::Operation::Warning.new(message)
+      end
+
+      def self.skip_all!
+        @@skip_all = true
+      end
+
+      def self.skip?
+        @@skip_all
+      end
+    end
+  end
+end

data/lib/icomoon/cli/parse_argv.rb

@@ -0,0 +1,27 @@
+module Icomoon
+  module Cli
+    class ParseArgv
+      def self.call(argv, params)
+        result = {}
+
+        params.each do |param|
+          param.aliases.each do |aliaz|
+            idx = argv.find_index { |arg| argv.include? aliaz }
+
+            if idx
+              value = param.needs_value ? argv.delete_at(idx + 1) : true
+              argv.delete_at(idx)
+              result[param.key] = value
+            end
+          end
+        end
+
+        if argv.count.nonzero?
+          Icomoon::Cli.error "Unrecognized arguments: #{argv.join(', ')}"
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/icomoon/cli/question.rb

@@ -0,0 +1,13 @@
+module Icomoon
+  module Cli
+    class Question
+      def initialize(value, name, default)
+        @value   = value
+        @name    = name
+        @default = default
+      end
+
+      attr_reader :value, :name, :default
+    end
+  end
+end

data/lib/icomoon/cli/survey.rb

@@ -0,0 +1,36 @@
+module Icomoon
+  module Cli
+    class Survey
+      def initialize
+        @questions = []
+      end
+
+      def ask(value, name, default = nil)
+        questions << Icomoon::Cli::Question.new(value, name, default)
+      end
+
+      def read!
+        Hash.new.tap do |answers|
+          questions.each do |q|
+            Icomoon::Cli.log "#{'question'.light_black} #{q.name} (#{q.default || 'none'}): "
+
+            answer = (gets || '').chomp
+            answer = q.default if /\A[\s]*\z/.match?(answer)
+
+            answers[q.value] = answer
+          end
+        end
+      end
+
+      def self.run
+        survey = new
+        yield(survey)
+        survey.read!
+      end
+
+      private
+
+      attr_reader :questions
+    end
+  end
+end

data/lib/icomoon/cli/writer.rb

@@ -0,0 +1,26 @@
+module Icomoon
+  module Cli
+    class Writer
+      class << self
+        def write(path)
+          return unless block_given?
+
+          path = File.expand_path(path)
+
+          File.new(path, 'w+').tap do |file|
+            yield file
+            file.close
+          end
+
+          path
+        end
+
+        def write_json(path, json = {})
+          write(path) do |file|
+            file.puts(JSON.pretty_generate(json))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/icomoon/version.rb

@@ -0,0 +1,3 @@
+module Icomoon
+  VERSION = '0.0.2'.freeze
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: icomoon
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- polakowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Rails helper makes using Icomoon easier.
+email: marek.polakowski@gmail.com
+executables:
+- icomoon
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/icomoon
+- lib/icomoon.rb
+- lib/icomoon/cli.rb
+- lib/icomoon/cli/config.rb
+- lib/icomoon/cli/exec.rb
+- lib/icomoon/cli/exec/base.rb
+- lib/icomoon/cli/exec/help.rb
+- lib/icomoon/cli/exec/import.rb
+- lib/icomoon/cli/exec/init.rb
+- lib/icomoon/cli/exec_param.rb
+- lib/icomoon/cli/icon.rb
+- lib/icomoon/cli/logger.rb
+- lib/icomoon/cli/operation.rb
+- lib/icomoon/cli/parse_argv.rb
+- lib/icomoon/cli/question.rb
+- lib/icomoon/cli/survey.rb
+- lib/icomoon/cli/writer.rb
+- lib/icomoon/version.rb
+homepage: https://github.com/polakowski/icomoon
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Icomoon helper
+test_files: []