artii 0.0.3 → 1.0.0

data/History.txt

@@ -23,4 +23,10 @@
 
 === 0.0.3 / 2010-08-27
 
-* No functional changes.  
+* No functional changes.
+
+=== 1.0.0 / 2010-08-28
+
+* Available Fonts are generated from the included font files
+* Available Fonts are stored as a hash, and now fully listed when called with -l or --list
+* A few other minor tweaks

data/README.rdoc

@@ -40,16 +40,17 @@ None (yet)
 
 == TODO
 
-- Ability to load non *.flf files (fonts are available, but the script assumes a .flf extension)
+- Ability to load non *.flf files (fonts are available, .flc file-types seem to be an issue right now)
 - Ability to set custom configurations, so you don't have to constantly set the options (like font) unless you want to
 - Some nice built-in utilities (to make for easier demoing)
-- Font list should be stored as a hash, and not a string
 - Font list should show samples of the faces in addition to the names
 - Font list should be able to show a given range (fonts starting with specific letters, or a range of letters)
 - Font list should be searchable (a la grep)
-- Font list needs to be generated from a) included fonts and b) a user-specified location (see To Do about custom configurations)
+- Font list needs to be generated from <strike>a) included fonts</strike> and b) a user-specified location (see To Do about custom configurations)
 
-= Note on Figlet
+= Prior Art
+
+== Figlet
 
 Figlet (http://www.figlet.org) implementation written by Tim Fletcher
 (twoggle@gmail.com). Found originally in the text gem

data/VERSION

@@ -1 +1 @@
-0.0.3
+1.0.0

data/artii.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{artii}
-  s.version = "0.0.3"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mike Tierney"]
-  s.date = %q{2010-08-27}
+  s.date = %q{2010-08-28}
   s.default_executable = %q{artii}
   s.description = %q{A Figlet-based ASCII art generator, useful for command-line based ASCII Art Generation.}
   s.email = %q{mike@panpainter.com}
@@ -707,7 +707,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/panpainter/artii}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A little Figlet-based ASCII art generator.}
   s.test_files = [
     "spec/artii/base_spec.rb",
@@ -720,7 +720,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])

data/lib/artii.rb

@@ -1,3 +1,17 @@
+# This gem takes a string and outputs ASCII art, generated by the
+# FIGLET library. While it defaults to the 'big' font, an optional
+# flag can be passed (-f or --font) with a string following it
+# (e.g., slant) that will change the font that is used.
+#
+# The ruby Figlet implementation was written by Tim Fletcher
+# (twoggle@gmail.com), and will only be curosrily maintained
+# by the author of this rubygem (Michael Tierney,
+# dev@panpainter.com).
+#
+# Author::    Michael Tierney (mailto:dev@panpainter.com)
+# Copyright:: Copyright (c) 2010 Michael Tierney
+# License::   Distributed under the MIT License
+
 require 'rubygems'
 
 $: << File.dirname(__FILE__)

data/lib/artii/base.rb

@@ -1,3 +1,4 @@
+require 'find'
 require 'optparse'
 
 module Artii
@@ -8,16 +9,17 @@ module Artii
     def initialize(*args)
       @options = {}
       @output = ''
+      @faces = all_fonts
 
       OptionParser.new do |opts|
         opts.banner = "Usage: artii 'your string here' [-f FONT_NAME or --font FONT_NAME] [-l or --list]"
 
         opts.on('-f', '--font FONT_NAME', 'Specify the font to be used (defaults to "big")') do |font|
-          @options[:font] = font
+          @font_name = @faces[font]
         end
 
         opts.on('-l', '--list', 'Prints the list of available fonts') do |list|
-          @options[:list] = list
+          @options[:list] = list_all_fonts
         end
 
         opts.on_tail("-h", "--help", "Show this message") do
@@ -32,12 +34,12 @@ module Artii
       end.parse!(args)
 
       if @options[:list]
-        @output = "Currently available faces:\n - Big\n - Chunky\n - Slant"
+        @output = list_all_fonts
       end
 
-      @font_name = @options[:font] ? @options[:font] : 'big'
+      @font_name = @font_name.nil? ? @faces['big'] : @font_name
 
-      @font = Artii::Figlet::Font.new("#{FONTPATH}/#{@font_name}.flf")
+      @font = Artii::Figlet::Font.new("#{FONTPATH}/#{@font_name}")
 
       asciify args.first unless args.empty?
     end
@@ -46,5 +48,38 @@ module Artii
       figlet = Artii::Figlet::Typesetter.new(@font)
       @output = figlet[string]
     end
+
+    def list_all_fonts
+      font_list = "\n--------------------\nAll Available Fonts:\n--------------------\n\n"
+      @faces.sort.each do |k,v|
+        font_list += "#{k}\n"
+      end
+      font_list += "\n--------------------------\nTotal Available Fonts: #{@faces.size}\n\n"
+    end
+
+    def all_fonts
+      font_faces = {}
+      size_of_fontpath = FONTPATH.split('/').size
+      font_exts = %w(flf) # FIXME: was %w(flf flc) but the .flc format seems to not be recognized. Need to investigate further.
+
+      Find.find(FONTPATH) do |file|
+        ext = File.extname(file).gsub('.','')
+        next if (File.directory?(file) or !font_exts.include?(ext))
+
+        dir = File.dirname(file).split('/')
+        if dir.size > size_of_fontpath
+          dir = "#{dir.last}/"
+        else
+          dir = ''
+        end
+
+        filename = File.basename(file)
+        filename = "#{dir}#{filename}"
+
+        font_faces[File.basename(file, ".#{ext}")] = filename
+      end
+
+      font_faces
+    end
   end
 end

data/spec/artii/base_spec.rb

@@ -9,37 +9,43 @@ describe Artii::Base do
     end
   end
 
-    it "should default to 'big'" do
+    it "font_name should default to 'big.flf'" do
       a = Artii::Base.new 'test'
-      a.font_name.should == 'big'
+      a.font_name.should == 'big.flf'
     end
 
   describe "font switching" do
     context 'should set font if passed -f ' do
-      before do
-        @a = Artii::Base.new 'test', '-f', 'chunky'
+      it "should set @font_name" do
+        a = Artii::Base.new 'test', '-f', 'chunky'
+        a.instance_variable_get(:@font_name).should == 'chunky.flf'
       end
 
-      it "set @options[:font]" do
-        @a.instance_variable_get(:@options)[:font].should == 'chunky'
+      xit "should accept non-flf file formats" do
+        a = Artii::Base.new 'test', '-f', 'frango'
+        a.font_name.should == 'frango.flc'
       end
 
-      it "should have @options[:font] and @font_name be the same" do
-        @a.font_name.should == @a.instance_variable_get(:@options)[:font]
+      it "should accept fonts in nested directories" do
+        a = Artii::Base.new 'test', '-f', 'cour'
+        a.font_name.should == 'bdffonts/cour.flf'
       end
     end
 
     context 'should set font if passed --font' do
-      before do
-        @a = Artii::Base.new 'test', '--font', 'chunky'
+      it "set @font_name" do
+        a = Artii::Base.new 'test', '--font', 'chunky'
+        a.instance_variable_get(:@font_name).should == 'chunky.flf'
       end
 
-      it "set @options[:font]" do
-        @a.instance_variable_get(:@options)[:font].should == 'chunky'
+      it "should accept fonts in nested directories" do
+        a = Artii::Base.new 'test', '--f', 'cour'
+        a.font_name.should == 'bdffonts/cour.flf'
       end
 
-      it "should have @options[:font] and @font_name be the same" do
-        @a.font_name.should == @a.instance_variable_get(:@options)[:font]
+      xit "should accept non-flf file formats" do
+        a = Artii::Base.new 'test', '--font', 'frango'
+        a.font_name.should == 'frango.flc'
       end
     end
   end
@@ -49,18 +55,19 @@ describe Artii::Base do
     it "should list all fonts if passed -l" do
       a = Artii::Base.new '-l'
       a.output.should_not be_empty
-      a.output.should include 'Big'
-      a.output.should include 'Chunky'
-      a.output.should include 'Slant'
-      
+      a.output.should include 'big'
+      a.output.should include 'chunky'
+      a.output.should include 'slant'
+      a.output.should include 'helv'
     end
 
     it "should list all fonts if passed --list" do
       a = Artii::Base.new '--list'
       a.output.should_not be_empty
-      a.output.should include 'Big'
-      a.output.should include 'Chunky'
-      a.output.should include 'Slant'
+      a.output.should include 'big'
+      a.output.should include 'chunky'
+      a.output.should include 'slant'
+      a.output.should include 'helv'
     end
   end
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: artii
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
+  - 1
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors: 
 - Mike Tierney
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-27 00:00:00 -07:00
+date: 2010-08-28 00:00:00 -07:00
 default_executable: artii
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -735,23 +738,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A little Figlet-based ASCII art generator.