wirb 0.3.1 → 0.3.2

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 0.3.2
+* Improve :<=> parsing :D
+* Support gem requirements (:gem_requirement_condition, :gem_requirement_version) and gem dependencies
+
 == 0.3.1
 * Fix ;$., ;$", :$,
 

data/README.rdoc

@@ -1,6 +1,8 @@
 == Wavy Interactive Ruby
 *Wirb* colorizes your inspected Ruby objects. It is based on Wirble[http://pablotron.org/software/wirble/], but only provides and improves result highlighting.
 
+http://travis-ci.org/janlelis/wirb.png
+
 == Install
 Install the gem with:
 
@@ -13,21 +15,21 @@ Add to your <tt>~/.irbrc</tt>
   require 'wirb'
   Wirb.start
 
-== Improvements and fixed Wirble bugs
-* Does not change the inspect value (e.g. ranges with 4 instead of 3 dots)
-* Basic support for regexes
-* Fixes some symbol bugs (e.g. :+, :*, ...)
+== Features
+* Syntax highlighting for Ruby objects
+* Does not change the inspect value
 * Support for generic objects, especially sets and enumerators
 * Comes with tests
 * Can be used without irb
-* Supports 1.8, 1.9, jruby, rbx
+* Limited stdlib/gem objects support (e.g. Set, Gem::Requirement)
+* Supports 1.8, 1.9, jruby, rbx, head
 
 == Customize
 The color schema can be changed with:
 
   Wirb.schema = { :comma => :purple, ... }
 
-Wirb color schemas are (almost) compatible with those from the original Wirble, but there are many extensions. Take a look at wirb/schema.rb or <tt>Wirb.schema</tt> for a list of available token descriptions. See wirb/colors.rb or <tt>Wirb::COLORS</tt> for the available colors.
+Wirb color schemas are (almost) compatible with those from the original Wirble, but there are lots of extensions. Take a look at wirb/schema.rb or <tt>Wirb.schema</tt> for a list of available token descriptions. See wirb/colors.rb or <tt>Wirb::COLORS</tt> for the available colors.
 
 Color schemas wanted! You've got a good looking alternative color schema? Please post it on the wiki[https://github.com/janlelis/wirb/wiki/schemas], it may be bundled with a next version ;)
 
@@ -38,9 +40,9 @@ You can colorize any object with <tt>wp</tt> (wavy_print):
   wp some_object, :light_red
 
 == Also see
-* hirb[https://github.com/cldwalker/hirb]
-* irbtools[https://github.com/janlelis/irbtools]
-* ripl-color_result[https://github.com/janlelis/ripl-color_result]
+* Configure views for specific objects: hirb[https://github.com/cldwalker/hirb]
+* Wirb is part of: irbtools[https://github.com/janlelis/irbtools]
+* ripl is an irb alternative, syntax highlighting plugin (uses wirb by default): ripl-color_result[https://github.com/janlelis/ripl-color_result]
 
 == Credits
 Copyright (c) 2011 Jan Lelis <http://rbjl.net>, see COPYING for details.

data/lib/wirb/schema.rb

@@ -59,11 +59,13 @@ module Wirb
 
     # misc
     :default => nil,
-    :keyword => nil, # some lowercased word, merge with default?
+    :keyword => nil, # some lowercased word
     :time    => :purple,
     :nil     => :light_red,
     :false   => :red,
     :true    => :green,
+    :gem_requirement_condition => :cyan,
+    :gem_requirement_version => :light_cyan,
   }
 end
 

data/lib/wirb/tokenizer.rb

@@ -1,6 +1,6 @@
 class << Wirb
   # This is an extended version of the original wirble tokenizer.
-  # Almost everyone would say that 300 lines long case statements need refactoring, but
+  # Almost everyone would say that 400 lines long case statements need refactoring, but
   # ...sometimes it just doesn't matter ;)
   def tokenize(str)
     raise ArgumentError, 'Tokenizer needs an inspect-string' unless str.is_a? String
@@ -52,7 +52,7 @@ class << Wirb
       # warn "char = #{c}  state = #{@state*':'}"
 
       case @state[-1]
-      when nil, :hash, :array, :enumerator, :set, :variable # "default" state
+      when nil, :hash, :array, :enumerator, :set, :variable # default state
         case c
         when '"'      then push_state[:string]
         when '/'      then push_state[:regexp]
@@ -61,6 +61,7 @@ class << Wirb
         when /[a-z]/  then push_state[:keyword,  :repeat]
         when /[0-9-]/ then push_state[:number,   :repeat]
         when '.'      then push_state[:range,    :repeat]
+        when /[~=]/  then push_state[:gem_requirement_condition, :repeat]
 
         when /\s/
           if get_state[:variable]
@@ -74,6 +75,7 @@ class << Wirb
             pop_state[:repeat]
           else
             pass[:comma, ',']
+            @refers_seen[-1] = false if get_state[:hash]
           end
 
         when ':'
@@ -84,14 +86,10 @@ class << Wirb
           end
  
         when '>'
-          if lc == '='
-            if get_state[:hash]
-              pass[:refers, '=>']
-            else # MAYBE remove this <=> cheat
-              pass[:symbol, '=>']
-            end
-          elsif get_state[:variable]
+          if get_state[:variable]
             pop_state[:repeat]
+          elsif @token == '' && nc =~ /[= ]/
+            push_state[:gem_requirement_condition, :repeat]
           end
         when '('
           if nc =~ /[0-9-]/
@@ -106,6 +104,8 @@ class << Wirb
             pass[:open_set, '{']; push_state[nil] # {{ means set-hash
           else
             pass[:open_hash, '{']; push_state[:hash]
+            @refers_seen ||= []
+            @refers_seen.push false
           end
 
         when '['
@@ -121,6 +121,7 @@ class << Wirb
         when '}'
           if get_state[:hash]
             pass[:close_hash, '}']
+            @refers_seen.pop
           elsif get_previous_state[:set]
             pass[:close_set, '}']
             pop_state[] # remove extra nil state
@@ -129,9 +130,14 @@ class << Wirb
           pop_state[] if get_state[:enumerator]
 
         when '<'
-          pass[:open_object, '<']
-          push_state[:ruby_vm]
-          push_state[:object_class]
+          if nc =~ /[= ]/
+            push_state[:gem_requirement_condition, :repeat]
+          else # MAYBE slightly refactoring
+            pass[:open_object, '<']
+            push_state[:object]
+            push_state[:object_class]
+            open_brackets = 0
+          end
 
         # else
         #  warn "ignoring char #{c.inspect}" if @debug
@@ -165,7 +171,7 @@ class << Wirb
         else
           if c == ']' && lc == '['
             @token << c
-          elsif c == '=' && nc != '>' # FIXME: spaceship error
+          elsif c == '=' && nc != '>'
             @token << c
           elsif c =~ /[.,]/ && lc == '$' && llc == ':'
             @token << c
@@ -293,24 +299,19 @@ class << Wirb
             pass_state[]
             pass[:class_separator, '::']
           elsif !(c == ':' && lc == ':')
-            if get_previous_state[:ruby_vm]
-              pass_state[]
-              pop_state[:remove]
+            pass_state[:keep_token]
+            pass[:object_description_prefix, c]
+
+            @token = @token.downcase
+            if %w[set instructionsequence].include?(@token)
+              set_state[@token.to_sym]
             else
-              pass_state[:keep_token]
-              pass[:object_description_prefix, c]
-
-              @token = @token.downcase
-              if %w[set].include?(@token)
-                set_state[@token.to_sym]
-              else
-                set_state[:object_description]
-                if %w[enumerator].include?(@token) && RUBY_VERSION >= '1.9'
-                  push_state[@token.to_sym]
-                end
+              set_state[:object_description]
+              if %w[enumerator].include?(@token) && RUBY_VERSION >= '1.9'
+                push_state[@token.to_sym]
               end
-              @token = ''
             end
+            @token = ''
           end
         end
 
@@ -374,7 +375,6 @@ class << Wirb
           push_state[:object_line_number]
         elsif c == '>' # e.g. RubyVM
           pass_state[:remove, :repeat]
-          pass[:close_object, '>'] # TODO move somewhere else if disturbing
         else
           @token << c
         end
@@ -386,12 +386,38 @@ class << Wirb
           pass_state[:remove, :repeat]
         end
 
-      # <RubyVM::InstructionSequence:pp@/home/jan/.rvm/rubies/ruby-1.9.2-p180/lib/ruby/1.9.1/irb/output-method.rb>
-      when :ruby_vm # TODO write tests
+      when :gem_requirement_condition
+        if c == '>' && lc == '='
+          @token = ''; pop_state[] # TODO in pass helper
+          if get_state[:hash]
+            if nc == '=' || @refers_seen[-1]
+              pass[:symbol, '=>']
+            else
+              pass[:refers, '=>']
+              @refers_seen[-1] = true
+            end
+          else # MAYBE remove this <=> cheat
+            pass[:symbol, '=>']
+          end
+        elsif c =~ /[^\s]/
+          @token << c
+        else
+          pass_state[:remove]
+          pass[:whitespace, c]
+          push_state[:gem_requirement_version]
+        end
+
+      when :gem_requirement_version
+        if c =~ /[0-9a-z.]/i
+          @token << c
+        else
+          pass_state[:remove, :repeat]
+        end
+
+      when :instructionsequence # RubyVM
         if c =~ /[^@]/i
           @token << c
         else
-          pass[:object_description_prefix, ':']
           pass[:object_line_prefix, @token + '@']
           @token = ''
           set_state[:object_line]

data/lib/wirb/version.rb

@@ -1,3 +1,3 @@
 module Wirb
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/spec/tokenizer_rubygems_spec.rb

@@ -0,0 +1,80 @@
+describe tokenizer(__FILE__) do
+  after :each do check_value end
+
+  please do check_inspected "> 3.0.0.beta.4"
+    tokens.should == [
+      [:gem_requirement_condition, ">"],
+      [:whitespace, " "],
+      [:gem_requirement_version, "3.0.0.beta.4"],
+    ]
+  end
+
+  please do check_inspected "< 3"
+    tokens.should == [
+      [:gem_requirement_condition, "<"],
+      [:whitespace, " "],
+      [:gem_requirement_version, "3"],
+    ]
+  end
+
+  please do check_inspected "<= 3"
+    tokens.should == [
+      [:gem_requirement_condition, "<="],
+      [:whitespace, " "],
+      [:gem_requirement_version, "3"],
+    ]
+  end
+
+  please do check_inspected "{1=>>= 0}"
+    tokens.should == [
+      [:open_hash, '{'],
+      [:number, '1'],
+      [:refers, '=>'],
+      [:gem_requirement_condition, ">="],
+      [:whitespace, " "],
+      [:gem_requirement_version, "0"],
+      [:close_hash, '}'],
+    ]
+  end
+
+  if Gem::Specification.respond_to? :find_by_name
+    only19 do
+      please do
+        require 'rspec'
+        check [Gem::Specification.find_by_name('rspec').dependencies.first.requirement]*2
+        tokens.should == [
+          [:open_array, '['],
+          [:gem_requirement_condition, "~>"],
+          [:whitespace, " "],
+          [:gem_requirement_version, RSpec::Version::STRING],
+          [:comma, ","],
+          [:whitespace, " "],
+          [:gem_requirement_condition, "~>"],
+          [:whitespace, " "],
+          [:gem_requirement_version, RSpec::Version::STRING],
+          [:close_array, ']'],
+        ]
+      end
+    end
+
+    please do
+      check Gem::Specification.find_by_name('wirb').dependencies.first
+      tokens.should == [ # <Gem::Dependency type=:development name="rspec" requirements=">= 0">
+        [:open_object, "<"],
+        [:object_class, "Gem"],
+        [:class_separator, "::"],
+        [:object_class, "Dependency"],
+        [:object_description_prefix, " "],
+        [:object_description, "type=:development name="],
+        [:open_string, "\""],
+        [:string, "rspec"],
+        [:close_string, "\""],
+        [:object_description, " requirements="],
+        [:open_string, "\""],
+        [:string, ">= 0"],
+        [:close_string, "\""],
+        [:close_object, ">"],
+      ]
+    end
+  end
+end

data/spec/tokenizer_rubyvm_spec.rb

@@ -0,0 +1,18 @@
+describe tokenizer(__FILE__) do
+  after :each do check_value end
+  please do
+    check_inspected "<RubyVM::InstructionSequence:pp"\
+                    "@/home/jan/.rvm/rubies/ruby-1.9.2-p180"\
+                    "/lib/ruby/1.9.1/irb/output-method.rb>"
+    tokens.should == [
+      [:open_object, "<"],
+      [:object_class, "RubyVM"],
+      [:class_separator, "::"],
+      [:object_class, "InstructionSequence"],
+      [:object_description_prefix, ":"],
+      [:object_line_prefix, "pp@"],
+      [:object_line, "/home/jan/.rvm/rubies/ruby-1.9.2-p180/lib/ruby/1.9.1/irb/output-method.rb"],
+      [:close_object, ">"],
+    ]
+  end
+end

data/spec/tokenizer_symbol_spec.rb

@@ -37,7 +37,7 @@ describe tokenizer(__FILE__) do
       [:comma, ","],
       [:whitespace, " "],
       [:symbol_prefix, ":"],
-      # [:symbol, "<=>"], # FIXME
+      # [:symbol, "<=>"], # MAYBE fixme
       [:symbol, "<"],
       [:symbol, "=>"],
       [:comma, ","],
@@ -95,7 +95,7 @@ describe tokenizer(__FILE__) do
     ]
   end
 
-  please do check [[:hallo],{:'hallo'=>:'test'}, {:'hallo='=>:'test='}, {:'<'=>9}]
+  please do check [[:hallo],{:'hallo'=>:'test'}, {:'hallo='=>:'test='}, {:'<'=>9}, {:'<=>'=>9}, {:'<'=>:'<=>'}]
     tokens.should == [
       [:open_array, "["],
       [:open_array, "["],
@@ -128,6 +128,27 @@ describe tokenizer(__FILE__) do
       [:refers, "=>"],
       [:number, "9"],
       [:close_hash, "}"],
+      [:comma, ","],
+      [:whitespace, " "],
+      [:open_hash, "{"],
+      [:symbol_prefix, ":"],
+      # [:symbol, "<=>"], # MAYBE fixme
+      [:symbol, "<"],
+      [:symbol, "=>"],
+      [:refers, "=>"],
+      [:number, "9"],
+      [:close_hash, "}"],
+      [:comma, ","],
+      [:whitespace, " "],
+      [:open_hash, "{"],
+      [:symbol_prefix, ":"],
+      [:symbol, "<"],
+      [:refers, "=>"],
+      [:symbol_prefix, ":"],
+      # [:symbol, "<=>"], # MAYBE fixme
+      [:symbol, "<"],
+      [:symbol, "=>"],
+      [:close_hash, "}"],
       [:close_array, "]"],
     ]
   end

data/wirb.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   s.license = 'MIT'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rspec-core'
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'zucker', '>= 11'
  
   len = s.homepage.size

metadata

@@ -2,7 +2,7 @@
 name: wirb
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Jan Lelis
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-26 00:00:00 Z
+date: 2011-06-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -35,16 +35,27 @@ dependencies:
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: zucker
+  name: rake
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "11"
+        version: "0"
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: zucker
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "11"
+  type: :development
+  version_requirements: *id004
 description: Colorizes your irb results. It's based on Wirble but only provides result highlighting. Just call Wirb.start and enjoy the colors ;).
 email: mail@janlelis.de
 executables: []
@@ -76,7 +87,9 @@ files:
 - spec/tokenizer_object_spec.rb
 - spec/tokenizer_nested_spec.rb
 - spec/tokenizer_time_spec.rb
+- spec/tokenizer_rubyvm_spec.rb
 - spec/tokenizer_string_spec.rb
+- spec/tokenizer_rubygems_spec.rb
 - COPYING.txt
 - README.rdoc
 - CHANGELOG.rdoc