inkjet 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4af8afe6467c85adc6846dad80f5358ae21af5a
-  data.tar.gz: c85db1efd92d913881477a74f08bea7e4afaca06
+  metadata.gz: 834476aeabcd5ab348125c5fb525db4859ee4dfa
+  data.tar.gz: a6f6b0b36d1a46213858d02febd83774bfd7b14c
 SHA512:
-  metadata.gz: 2e04395528ab2ac80135d801afb883c9d2df2d950d8dd99716bce72c816bc17b4cdc412fc1157dc75c20521695a4bcaa79a60179b127cda9cdaf80e2ee45a234
-  data.tar.gz: 3e65522f8da9e88f79cad5d568ea9ba061d6b36e01e9b8cddab01f739717b16c0751fbaacc7d35e314c4962bc967f8fd9a664f55f14cf7cbd68e028ebc126745
+  metadata.gz: daf70655f31d52f49a3f29d7d0487d4824ab8eede474c7044a80b38ab58d61fc8ae589850e9584d0a36de9ee1326be9f4c747de134a2d1e42186c6dc17636e72
+  data.tar.gz: 6024564d3bea03575d45bd7e00aeb1de9d172453385c775357c31cfcb8500e1128236e6dd4bb7a4e709a518c2fba462699df62d37bc2f9a98d0a21d0ab6c84fd

data/lib/inkjet.rb

@@ -1,17 +1,13 @@
 require 'active_support/inflector'
 require 'inkjet/string'
 require 'inkjet/colors'
+require 'inkjet/styles'
 require 'inkjet/indent'
 
 module Inkjet
   Close     = 0
-  Bold      = 1
-  Dim       = 2
-  Underline = 4
-  Blink     = 5
-  Invert    = 7
-  Hidden    = 8
   include Colors::Formatters
+  include Styles::Formatters
 
   def self.escape(code)
     "\e[#{code.to_s.chomp('m')}m"

data/lib/inkjet/indent.rb

@@ -1,29 +1,59 @@
 module Inkjet
   module Indent
     TABSTOP = 2 # TODO set based on config
+
+    class Formatter
+      def call_on(str)
+        str.send @meth, *@args
+      end
+
+      protected
+
+      def initialize(meth, *args)
+        @meth = meth.to_sym
+        @args = args
+      end
+    end
     
     def self.indent(*args, &block)
-      @spaces ||= 0
+      @@spaces ||= 0
       if block_given?
-        @spaces += args[0] || TABSTOP
+        @@spaces += args[0] || TABSTOP
+        scoped_formatters = formatters.clone
+
         class_eval &block
-        @spaces -= args[0] || TABSTOP
+        
+        @@formatters = scoped_formatters
+        @@spaces -= args[0] || TABSTOP
       else
         spaces = args[1] || TABSTOP
-        "#{padding(@spaces + spaces.to_i)}#{args[0].to_s.split("\n").join("\n#{padding(@spaces + spaces.to_i)}")}"
+        "#{padding(@@spaces + spaces.to_i)}#{args[0].to_s.split("\n").join("\n#{padding(@@spaces + spaces.to_i)}")}"
       end
     end
 
+    def self.formatters
+      @@formatters ||= []
+    end
+
+    def self.format_with(fmeth, *fargs)
+      formatters.push(Formatter.new(fmeth, *fargs))
+    end
+
+    def self.apply_formatters(output)
+      formatters.each { |f| output = f.call_on(output) }
+      output
+    end
+
     def self.padding(spaces)
       spaces.times.map {" "}.join
     end
 
     def self.puts(output)
-      STDOUT.puts indent(output, 0)
+      STDOUT.puts apply_formatters(indent(output))#indent(output, 0)
     end
 
     def self.print(output)
-      STDOUT.print indent(output, 0)
+      STDOUT.print apply_formatters(indent(output))#indent(output, 0)
     end
 
     module String

data/lib/inkjet/string.rb

@@ -1,52 +1,94 @@
 module Inkjet
-  module String
-    
-    def method_missing(meth, *args)
-      if meth.match(/(#{%w(bold dim underline blink invert hidden).join('|')})(!?)/)
-        send "apply_inkjet_code#{$2}", "Inkjet::#{meth.capitalize}".constantize, *args
-      else
-        super
-      end
+  class Substring
+    attr_accessor :pre, :codes, :string, :post
+
+    def push(code)
+      codes.push(code)
+      self
     end
     
-    def clean
-      clone.clean!
+    def unshift(code)
+      codes.unshift(code)
+      self
     end
 
+    def formattable?(chunk)
+      !chunk.nil? && !chunk.empty? #&& !chunk.match(/\A[\r\n]+\Z/)
+    end
+
+    # Formats a chunk of the substring
+    #
+    # If no codes are provided, or the chunk is empty, it si not formatted
+    def format_chunk(chunk, codes)
+      codes = [codes].flatten
+      return chunk if !formattable?(chunk) || (codes.nil? || codes.empty?)
+      "\e[#{codes.join(";")}m#{chunk}\e[#{Inkjet::Close}m"
+    end
+
+    # Format the string by applying the proper codes to various chunks of the string.
+    #
+    # The primary string is formatted with this object's @codes
+    #
+    # If a super_code is provided, it is used to format the superstring (pre/post) chunks,
+    # otherwise they are left unformatted.
+    def format(super_code=nil)
+      format_chunk(pre, super_code) +
+      format_chunk(string, codes) +
+      format_chunk(post, super_code)
+    end
+
+    private
+
+    def initialize(pre, codes, string, post)
+      @pre = pre
+      @codes = codes
+      @string = string
+      @post = post
+    end
+  end
+
+  module String
+
+    # Clean out all escape codes from the formatted string
     def clean!
       gsub!(/\e\[[\d;]+m/, '')
     end
-
-    def apply_inkjet_code(code, wrap=false)
-      clone.apply_inkjet_code!(code, wrap)
+    
+    def clean
+      clone.clean!
     end
 
+    # Apply a formatting code to the appropriate chunks in the string.
+    #
+    # If forcing a wrap, all chunks within the string get formatted with the new code, regardless of whether they were previously formatted
+    #
+    # If there are codes applied to the first chunk of the string, apply the new code to all previously formatted chunks with matching codes
+    #
+    # If the first chunk of the string is unformatted, apply the new code to all unformatted chunks
+    #
+    # If the string is completely unformatted, enclose self within the provided code
     def apply_inkjet_code!(code, wrap=false)
-      if inkjet_strings.length > 0
-        replace(inkjet_strings.map do |istr|
+      if inkjet_substrings.length > 0
+        
+        replace(inkjet_substrings.map do |substr|
           if wrap # apply the code to every chunk within the string, formatted or unformatted
-            
-            (istr[0].empty? ? "" : apply_inkjet_codes_to_substring([code], istr[0])) +
-            apply_inkjet_codes_to_substring(istr[1].push(code), istr[2]) +
-            (istr[3].empty? ? "" : apply_inkjet_codes_to_substring([code], istr[3]))
-          
-          elsif !inkjet_codes.empty? && istr[1] == inkjet_codes # apply the code only to the formatted chunks of the 'primary string'
-            
-            istr[0] + apply_inkjet_codes_to_substring(istr[1].push(code), istr[2]) + istr[3]
-          
-          else # apply the code only to the unformatted chunks of the 'primary string' leaving any formatted substrings untouched
-            
-            (istr[0].empty? ? "" : apply_inkjet_codes_to_substring([code], istr[0])) +
-            apply_inkjet_codes_to_substring(istr[1], istr[2]) +
-            (istr[3].empty? ? "" : apply_inkjet_codes_to_substring([code], istr[3]))
-          
+            substr.push(code).format(code)
+          elsif !inkjet_codes.empty? && substr.codes == inkjet_codes # apply the code only to formatted chunks with matching codes
+            substr.push(code).format
+          else # apply the code only to the unformatted chunks
+            substr.format(code)
           end
-        end.join(""))
-      else # wrap the entire unformatted string w/ the code
+        end.join)
+
+      else # enclose the entire unformatted string w/ the code
         replace("\e[#{code}m#{self}\e[#{Inkjet::Close}m")
       end
     end
 
+    def apply_inkjet_code(code, wrap=false)
+      clone.apply_inkjet_code!(code, wrap)
+    end
+
     def apply_inkjet_codes(codes, wrap=false)
       cloned = clone
       codes.each { |code| cloned.apply_inkjet_code!(code, wrap) }
@@ -60,19 +102,21 @@ module Inkjet
     
     protected
 
-    # return the first set of escape codes found in the string if no pre-string
+    # Return the first set of escape codes found in the string if no pre-string.
+    # 
+    # This determines whether the main chunks of the string are already formatted or not,
+    # and helps decide whether multiple chunks of a string should be formatted when not 
+    # forcing everything to be wrapped.
     def inkjet_codes
-      inkjet_strings.first[0].empty? ? inkjet_strings.first[1] : []
+      inkjet_substrings.first.pre.empty? ? inkjet_substrings.first.codes : []
     rescue
       []
     end
 
-    def inkjet_strings
-      scan(/([^\e]*)\e\[([\d;]+)m([^\e]*)\e\[#{Inkjet::Close}m([^\e]*)/).map { |pre,codes,str,post| [pre, codes.split(";"), str, post] } # TODO make a class for these
-    end
-
-    def apply_inkjet_codes_to_substring(codes, substr)
-      "\e[#{codes.join(";")}m#{substr}\e[#{Inkjet::Close}m"
+    # Scan the string for formatted chunks and their surrounding unformatted chunks and
+    # return an array of Inkjet::Substring objects.
+    def inkjet_substrings
+      scan(/([^\e]*)\e\[([\d;]+)m([^\e]*)\e\[#{Inkjet::Close}m([^\e]*)/).map { |pre,codes,str,post| Inkjet::Substring.new(pre, codes.split(";"), str, post) }
     end
 
   end

data/lib/inkjet/styles.rb

@@ -0,0 +1,50 @@
+module Inkjet
+  module Styles
+    Styles = %w(bold dim underline blink invert hidden)
+    Bold      = 1
+    Dim       = 2
+    Underline = 4
+    Blink     = 5
+    Invert    = 7
+    Hidden    = 8
+    
+    def self.style(style)
+      "Inkjet::Styles::#{style.capitalize}".constantize rescue raise("Style does not exist: '#{style}'")
+    end
+
+    module Formatters
+      def self.included(base)
+        base.send :extend, self
+      end
+
+      def stylize(style, str, wrap=false)
+        stylize!(style, str.clone, wrap)
+      end
+      
+      def stylize!(style, str, wrap=false)
+        str.apply_inkjet_code!(Inkjet::Styles.style(style), wrap)
+      end
+
+      def method_missing(meth, *args)
+        if meth.match(/\A(#{Inkjet::Styles::Styles.join("|")})(!?)\Z/)
+          stylize($1, *args)
+        else
+          super(meth, *args)
+        end
+      end
+    end
+
+    module String
+      def method_missing(meth, *args)
+        if meth.match(/\A(#{Inkjet::Styles::Styles.join("|")})(!?)\Z/)
+          Inkjet.send("stylize#{$2}", $1, self, *args)
+        else
+          super(meth, *args)
+        end
+      end
+    end
+  
+  end
+end
+
+String.send :include, Inkjet::Styles::String

data/lib/inkjet/version.rb

@@ -1,3 +1,3 @@
 module Inkjet
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inkjet
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Mark Rebec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-09 00:00:00.000000000 Z
+date: 2013-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/inkjet/string.rb
+- lib/inkjet/styles.rb
 - lib/inkjet/indent.rb
 - lib/inkjet/configuration.rb
 - lib/inkjet/colors.rb