fontcustom 1.1.0.pre → 1.1.0.pre2

data/lib/fontcustom/options.rb

@@ -1,27 +1,211 @@
+require "yaml"
+require "thor/shell"
+require "thor/shell/basic"
+require "thor/shell/color"
 require "thor/core_ext/hash_with_indifferent_access"
+require "fontcustom/util"
 
 module Fontcustom
-  # :output and :config are build from arguments
-  DEFAULT_OPTIONS = Thor::CoreExt::HashWithIndifferentAccess.new({
-    :project_root => Dir.pwd,
-    :input => "",
-    :templates => %w|css preview|,
-    :font_name => "fontcustom",
-    :file_hash => true,
-    :css_prefix => "icon-",
-    :preprocessor_font_path => "",
-    :debug => false,
-    :verbose => true
-  })
-
-  DATA_MODEL = Thor::CoreExt::HashWithIndifferentAccess.new({
-    :fonts => [],
-    :templates => [],
-    :glyphs => [],
-    :paths => {
-      :css_to_fonts => "",
-      :preprocessor_to_fonts => "",
-      :preview_to_css => ""
-    }
-  })
+  class Options
+    include Util
+
+    attr_reader :project_root, :input, :output, :config, :data_cache, :templates,
+      :font_name, :file_hash, :css_prefix, :preprocessor_path, :skip_first, :debug, :verbose
+
+    def initialize(options = {})
+      check_fontforge
+
+      # Overwrite example defaults (used in Thor's help) with real defaults, if unchanged
+      EXAMPLE_OPTIONS.keys.each do |key|
+        options.delete(key) if options[key] == EXAMPLE_OPTIONS[key]
+      end
+      @cli_options = DEFAULT_OPTIONS.dup.merge options
+
+      @shell = Thor::Shell::Color.new
+      set_options
+    end
+
+    private
+
+    def set_options
+      set_config_path
+      load_config
+      merge_options
+      set_data_path
+      set_input_paths
+      set_output_paths
+      set_template_paths
+    end
+
+    def set_config_path
+      @config = if @cli_options[:config]
+        path = File.expand_path File.join(@cli_options[:project_root], @cli_options[:config])
+
+        # :config is the path to fontcustom.yml
+        if File.exists?(path) && ! File.directory?(path)
+          path
+
+        # :config is a dir containing fontcustom.yml
+        elsif File.exists? File.join(path, "fontcustom.yml")
+          File.join path, "fontcustom.yml"
+
+        else
+          raise Fontcustom::Error, "The configuration file was not found. Check #{relative_to_root(path)} and try again."
+        end
+      else
+        # fontcustom.yml is in the project_root
+        if File.exists? File.join(@cli_options[:project_root], "fontcustom.yml")
+          File.join @cli_options[:project_root], "fontcustom.yml"
+
+        # config/fontcustom.yml is in the project_root
+        elsif File.exists? File.join(@cli_options[:project_root], "config", "fontcustom.yml")
+          File.join @cli_options[:project_root], "config", "fontcustom.yml"
+
+        else
+          false
+        end
+      end
+    end
+
+    def load_config
+      @config_options = {}
+      return unless @config
+      begin
+        config = YAML.load File.open(@config)
+        @config_options = config if config # empty file returns false
+      rescue Exception => e
+        raise Fontcustom::Error, "The configuration file failed to load. Message: #{e.message}"
+      end
+    end
+
+    def merge_options
+      @cli_options.delete_if { |key, val| val == DEFAULT_OPTIONS[key] }
+
+      options = DEFAULT_OPTIONS.dup
+      options = options.merge @config_options
+      options = options.merge @cli_options
+      remove_instance_variable :@config_options
+      remove_instance_variable :@cli_options
+
+      # :config is excluded since it's already been set
+      keys = %w|project_root input output data_cache templates font_name file_hash css_prefix preprocessor_path skip_first debug verbose|
+      keys.each { |key| instance_variable_set("@#{key}", options[key]) }
+
+      @font_name = @font_name.strip.gsub(/\W/, '-')
+    end
+
+    def set_data_path
+      @data_cache = if ! @data_cache.nil?
+        File.expand_path File.join(@project_root, @data_cache)
+      elsif @config
+        File.join File.dirname(@config), '.fontcustom-data'
+      else
+        File.join @project_root, '.fontcustom-data'
+      end
+    end
+
+    def set_input_paths
+      if @input.is_a? Hash
+        @input = Thor::CoreExt::HashWithIndifferentAccess.new @input
+
+        if @input.has_key? "vectors"
+          @input[:vectors] = File.expand_path File.join(@project_root, @input[:vectors])
+          unless File.directory? input[:vectors]
+            raise Fontcustom::Error, "INPUT[\"vectors\"] should be a directory. Check #{relative_to_root(input[:vectors])} and try again."
+          end
+        else
+          raise Fontcustom::Error, "INPUT (as a hash) should contain a \"vectors\" key."
+        end
+
+        if @input.has_key? "templates"
+          @input[:templates] = File.expand_path File.join(@project_root, @input[:templates])
+          unless File.directory? @input[:templates]
+            raise Fontcustom::Error, "INPUT[\"templates\"] should be a directory. Check #{relative_to_root(input[:templates])} and try again."
+          end
+        else
+          @input[:templates] = @input[:vectors]
+        end
+      elsif @input.is_a? String
+        input = File.expand_path File.join(@project_root, @input)
+        unless File.directory? input
+          raise Fontcustom::Error, "INPUT (as a string) should be a directory. Check #{relative_to_root(input)} and try again."
+        end
+        @input = Thor::CoreExt::HashWithIndifferentAccess.new({
+          :vectors => input,
+          :templates => input
+        })
+      end
+
+      if Dir[File.join(@input[:vectors], "*.{svg,eps}")].empty?
+        raise Fontcustom::Error, "#{relative_to_root(@input[:vectors])} doesn't contain any vectors (*.svg or *.eps files)."
+      end
+    end
+
+    def set_output_paths
+      if @output.is_a? Hash
+        @output = Thor::CoreExt::HashWithIndifferentAccess.new @output
+        raise Fontcustom::Error, "OUTPUT (as a hash) should contain a \"fonts\" key." unless @output.has_key? "fonts"
+
+        @output.each do |key, val|
+          @output[key] = File.expand_path File.join(@project_root, val)
+          if File.exists?(val) && ! File.directory?(val)
+            raise Fontcustom::Error, "OUTPUT[\"#{key}\"] should be a directory, not a file. Check #{relative_to_root(val)} and try again."
+          end
+        end
+
+        @output[:css] ||= @output[:fonts]
+        @output[:preview] ||= @output[:fonts]
+      else
+        if @output.is_a? String
+          output = File.expand_path File.join(@project_root, @output)
+          if File.exists?(output) && ! File.directory?(output)
+            raise Fontcustom::Error, "OUTPUT should be a directory, not a file. Check #{relative_to_root(output)} and try again."
+          end
+        else
+          output = File.join @project_root, @font_name
+          say_message :status, "All generated files will be added into `#{relative_to_root(output)}/` by default."
+        end
+
+        @output = Thor::CoreExt::HashWithIndifferentAccess.new({
+          :fonts => output,
+          :css => output,
+          :preview => output
+        })
+      end
+    end
+
+    # Translates shorthand to full path of packages templates, otherwise,
+    # it checks input and pwd for the template.
+    #
+    # Could arguably belong in Generator::Template, however, it's nice to
+    # be able to catch template errors before any generator runs.
+    def set_template_paths
+      template_path = File.join Fontcustom.gem_lib, "templates"
+
+      @templates = @templates.map do |template|
+        case template
+        when "preview"
+          File.join template_path, "fontcustom-preview.html"
+        when "css"
+          File.join template_path, "fontcustom.css"
+        when "scss"
+          File.join template_path, "_fontcustom.scss"
+        when "scss-rails"
+          File.join template_path, "_fontcustom-rails.scss"
+        when "bootstrap"
+          File.join template_path, "fontcustom-bootstrap.css"
+        when "bootstrap-scss"
+          File.join template_path, "_fontcustom-bootstrap.scss"
+        when "bootstrap-ie7"
+          File.join template_path, "fontcustom-bootstrap-ie7.css"
+        when "bootstrap-ie7-scss"
+          File.join template_path, "_fontcustom-bootstrap-ie7.scss"
+        else
+          path = File.expand_path File.join(@input[:templates], template)
+          raise Fontcustom::Error, "The custom template at #{relative_to_root(path)} does not exist." unless File.exists? path
+          path
+        end
+      end
+    end
+  end
 end

data/lib/fontcustom/templates/_fontcustom-bootstrap-ie7.scss

@@ -1,22 +1,22 @@
 //
-// Icon Font: <%= @opts[:font_name] %>
+// Icon Font: <%= @opts.font_name %>
 // Bootstrap IE7 Enabler
 //
 
-[class^="<%= @opts[:css_prefix] %>"],
-[class*=" <%= @opts[:css_prefix] %>"] {
-  font-family: "<%= @opts[:font_name] %>";
+[class^="<%= @opts.css_prefix %>"],
+[class*=" <%= @opts.css_prefix %>"] {
+  font-family: "<%= @opts.font_name %>";
   font-style: normal;
   font-weight: normal;
 }
 
-.btn.dropdown-toggle [class^="<%= @opts[:css_prefix] %>"],
-.btn.dropdown-toggle [class*=" <%= @opts[:css_prefix] %>"] {
+.btn.dropdown-toggle [class^="<%= @opts.css_prefix %>"],
+.btn.dropdown-toggle [class*=" <%= @opts.css_prefix %>"] {
   line-height: 1.4em;
 }
 
-.<%= @opts[:css_prefix] %>large {
+.<%= @opts.css_prefix %>large {
   font-size: 1.3333em;
 }
-<% @data[:glyphs].each_with_index do |name, index| %>
-.<%= @opts[:css_prefix] + name %> { *zoom: expression( this.runtimeStyle['zoom'] = '1', this.innerHTML = '&#x<%= (61696+index).to_s(16) %>;&nbsp;'); }<% end %>
+<% @glyphs.each_with_index do |name, index| %>
+.<%= @opts.css_prefix + name %> { *zoom: expression( this.runtimeStyle['zoom'] = '1', this.innerHTML = '&#x<%= (61696+index).to_s(16) %>;&nbsp;'); }<% end %>

data/lib/fontcustom/templates/_fontcustom-bootstrap.scss

@@ -1,63 +1,63 @@
 //
-// Icon Font: <%= @opts[:font_name] %>
+// Icon Font: <%= @opts.font_name %>
 // Bootstrap Override
 //
 
 @font-face {
-  font-family: "<%= @opts[:font_name] %>";
-  src: url("<%= @data[:paths][:preprocessor_to_fonts] %>.eot");
-  src: url("<%= @data[:paths][:preprocessor_to_fonts] %>.eot?#iefix") format("embedded-opentype"),
-       url("<%= @data[:paths][:preprocessor_to_fonts] %>.woff") format("woff"),
-       url("<%= @data[:paths][:preprocessor_to_fonts] %>.ttf") format("truetype"),
-       url("<%= @data[:paths][:preprocessor_to_fonts] %>.svg#<%= @opts[:font_name] %>") format("svg");
+  font-family: "<%= @opts.font_name %>";
+  src: url("<%= @font_path_pre %>.eot");
+  src: url("<%= @font_path_pre %>.eot?#iefix") format("embedded-opentype"),
+       url("<%= @font_path_pre %>.woff") format("woff"),
+       url("<%= @font_path_pre %>.ttf") format("truetype"),
+       url("<%= @font_path_pre %>.svg#<%= @opts.font_name %>") format("svg");
   font-weight: normal;
   font-style: normal;
 }
 
-[class^="<%= @opts[:css_prefix] %>"]:before, [class*=" <%= @opts[:css_prefix] %>"]:before {
-  font-family: "<%= @opts[:font_name] %>";
+[class^="<%= @opts.css_prefix %>"]:before, [class*=" <%= @opts.css_prefix %>"]:before {
+  font-family: "<%= @opts.font_name %>";
   font-weight: normal;
   font-style: normal;
   display: inline-block;
   text-decoration: inherit;
 }
 
-a [class^="<%= @opts[:css_prefix] %>"], a [class*=" <%= @opts[:css_prefix] %>"] {
+a [class^="<%= @opts.css_prefix %>"], a [class*=" <%= @opts.css_prefix %>"] {
   display: inline-block;
   text-decoration: inherit;
 }
 
-.<%= @opts[:css_prefix] %>large:before {
+.<%= @opts.css_prefix %>large:before {
   vertical-align: top;
   font-size: 1.333em;
 }
 
-.btn [class^="<%= @opts[:css_prefix] %>"], .btn [class*=" <%= @opts[:css_prefix] %>"] {
+.btn [class^="<%= @opts.css_prefix %>"], .btn [class*=" <%= @opts.css_prefix %>"] {
   line-height: 0.9em;
 }
 
-li [class^="<%= @opts[:css_prefix] %>"], li [class*=" <%= @opts[:css_prefix] %>"] {
+li [class^="<%= @opts.css_prefix %>"], li [class*=" <%= @opts.css_prefix %>"] {
   display: inline-block;
   width: 1.25em;
   text-align: center;
 }
 
-li .<%= @opts[:css_prefix] %>large[class^="<%= @opts[:css_prefix] %>"], li .<%= @opts[:css_prefix] %>large[class*=" <%= @opts[:css_prefix] %>"] {
+li .<%= @opts.css_prefix %>large[class^="<%= @opts.css_prefix %>"], li .<%= @opts.css_prefix %>large[class*=" <%= @opts.css_prefix %>"] {
   width: 1.875em;
 }
 
-li[class^="<%= @opts[:css_prefix] %>"], li[class*=" <%= @opts[:css_prefix] %>"] {
+li[class^="<%= @opts.css_prefix %>"], li[class*=" <%= @opts.css_prefix %>"] {
   margin-left: 0;
   list-style-type: none;
 }
 
-li[class^="<%= @opts[:css_prefix] %>"]:before, li[class*=" <%= @opts[:css_prefix] %>"]:before {
+li[class^="<%= @opts.css_prefix %>"]:before, li[class*=" <%= @opts.css_prefix %>"]:before {
   text-indent: -2em;
   text-align: center;
 }
 
-li[class^="<%= @opts[:css_prefix] %>"].<%= @opts[:css_prefix] %>large:before, li[class*=" <%= @opts[:css_prefix] %>"].<%= @opts[:css_prefix] %>large:before {
+li[class^="<%= @opts.css_prefix %>"].<%= @opts.css_prefix %>large:before, li[class*=" <%= @opts.css_prefix %>"].<%= @opts.css_prefix %>large:before {
   text-indent: -1.333em;
 }
-<% @data[:glyphs].each_with_index do |name, index| %>
-.<%= @opts[:css_prefix] + name %>:before { content: "\<%= (61696+index).to_s(16) %>"; }<% end %>
+<% @glyphs.each_with_index do |name, index| %>
+.<%= @opts.css_prefix + name %>:before { content: "\<%= (61696+index).to_s(16) %>"; }<% end %>

data/lib/fontcustom/templates/_fontcustom-rails.scss

@@ -0,0 +1,28 @@
+//
+// Icon Font: <%= @opts.font_name %>
+//
+
+@font-face {
+  font-family: "<%= @opts.font_name %>";
+  src: font-url("<%= @font_path_pre %>.eot");
+  src: font-url("<%= @font_path_pre %>.eot?#iefix") format("embedded-opentype"),
+       font-url("<%= @font_path_pre %>.woff") format("woff"),
+       font-url("<%= @font_path_pre %>.ttf") format("truetype"),
+       font-url("<%= @font_path_pre %>.svg#<%= @opts.font_name %>") format("svg");
+  font-weight: normal;
+  font-style: normal;
+}
+
+<%= @glyphs.map {|name| ".#{@opts.css_prefix + name}:before"}.join(",\n") %> {
+  font-family: "<%= @opts.font_name %>";
+  font-style: normal;
+  font-weight: normal;
+  font-variant: normal;
+  text-transform: none;
+  line-height: 1;
+  -webkit-font-smoothing: antialiased;
+  display: inline-block;
+  text-decoration: inherit;
+}
+<% @glyphs.each_with_index do |name, index| %>
+.<%= @opts.css_prefix + name %>:before { content: "\<%= (61696+index).to_s(16) %>"; }<% end %>

data/lib/fontcustom/templates/_fontcustom.scss

@@ -1,20 +1,20 @@
 //
-// Icon Font: <%= @opts[:font_name] %>
+// Icon Font: <%= @opts.font_name %>
 //
 
 @font-face {
-  font-family: "<%= @opts[:font_name] %>";
-  src: url("<%= @data[:paths][:preprocessor_to_fonts] %>.eot");
-  src: url("<%= @data[:paths][:preprocessor_to_fonts] %>.eot?#iefix") format("embedded-opentype"),
-       url("<%= @data[:paths][:preprocessor_to_fonts] %>.woff") format("woff"),
-       url("<%= @data[:paths][:preprocessor_to_fonts] %>.ttf") format("truetype"),
-       url("<%= @data[:paths][:preprocessor_to_fonts] %>.svg#<%= @opts[:font_name] %>") format("svg");
+  font-family: "<%= @opts.font_name %>";
+  src: url("<%= @font_path_pre %>.eot");
+  src: url("<%= @font_path_pre %>.eot?#iefix") format("embedded-opentype"),
+       url("<%= @font_path_pre %>.woff") format("woff"),
+       url("<%= @font_path_pre %>.ttf") format("truetype"),
+       url("<%= @font_path_pre %>.svg#<%= @opts.font_name %>") format("svg");
   font-weight: normal;
   font-style: normal;
 }
 
-<%= @data[:glyphs].map {|name| ".#{@opts[:css_prefix] + name}:before"}.join(",\n") %> {
-  font-family: "<%= @opts[:font_name] %>";
+<%= @glyphs.map {|name| ".#{@opts.css_prefix + name}:before"}.join(",\n") %> {
+  font-family: "<%= @opts.font_name %>";
   font-style: normal;
   font-weight: normal;
   font-variant: normal;
@@ -24,5 +24,5 @@
   display: inline-block;
   text-decoration: inherit;
 }
-<% @data[:glyphs].each_with_index do |name, index| %>
-.<%= @opts[:css_prefix] + name %>:before { content: "\<%= (61696+index).to_s(16) %>"; }<% end %>
+<% @glyphs.each_with_index do |name, index| %>
+.<%= @opts.css_prefix + name %>:before { content: "\<%= (61696+index).to_s(16) %>"; }<% end %>

data/lib/fontcustom/templates/fontcustom-bootstrap-ie7.css

@@ -1,22 +1,22 @@
 /* 
-  Icon Font: <%= @opts[:font_name] %>
+  Icon Font: <%= @opts.font_name %>
   Bootstrap IE7 Enabler
 */
 
-[class^="<%= @opts[:css_prefix] %>"],
-[class*=" <%= @opts[:css_prefix] %>"] {
-  font-family: "<%= @opts[:font_name] %>";
+[class^="<%= @opts.css_prefix %>"],
+[class*=" <%= @opts.css_prefix %>"] {
+  font-family: "<%= @opts.font_name %>";
   font-style: normal;
   font-weight: normal;
 }
 
-.btn.dropdown-toggle [class^="<%= @opts[:css_prefix] %>"],
-.btn.dropdown-toggle [class*=" <%= @opts[:css_prefix] %>"] {
+.btn.dropdown-toggle [class^="<%= @opts.css_prefix %>"],
+.btn.dropdown-toggle [class*=" <%= @opts.css_prefix %>"] {
   line-height: 1.4em;
 }
 
-.<%= @opts[:css_prefix] %>large {
+.<%= @opts.css_prefix %>large {
   font-size: 1.3333em;
 }
-<% @data[:glyphs].each_with_index do |name, index| %>
-.<%= @opts[:css_prefix] + name %> { *zoom: expression( this.runtimeStyle['zoom'] = '1', this.innerHTML = '&#x<%= (61696+index).to_s(16) %>;&nbsp;'); }<% end %>
+<% @glyphs.each_with_index do |name, index| %>
+.<%= @opts.css_prefix + name %> { *zoom: expression( this.runtimeStyle['zoom'] = '1', this.innerHTML = '&#x<%= (61696+index).to_s(16) %>;&nbsp;'); }<% end %>