rubybuntu-gedit 11.08.18

data/README.rdoc

@@ -0,0 +1,20 @@
+= Ruby/Rails/Web related gedit language definitions, mime types, styles and snippets.
+
+This is not meant to be an alternative to *gedit-plugins* or gmate[https://github.com/gmate/gmate.git], but an addition. It focuses on maintaining the base stuff to provide a foundation for customizing your gedit with plugins.
+
+=== Contains
+* {language specifications}[https://github.com/janlelis/rubybuntu-language-specs]
+* {mime types}[https://github.com/janlelis/rubybuntu-mime]
+* {styles}[https://github.com/janlelis/rubybuntu-editor-styles]
+* [snippets}[https://github.com/janlelis/rubybuntu-gedit-snippets]
+
+Might also contain plugins someday, but only ones directly related to Ruby/Rails/Web stuff.
+
+== Setup
+
+Either checkout the sub-repositories (in the data directory) and install each one manually or run
+
+    gem install rubybuntu-gedit
+    rubybuntu-gedit install
+
+== J-_-L

data/Rakefile

@@ -0,0 +1,28 @@
+require 'fileutils'
+GEMSPEC = 'rubybuntu-gedit.gemspec'
+
+def gemspec
+  @gemspec ||= eval(File.read( GEMSPEC ), binding, GEMSPEC)
+end
+
+desc "Build the gem"
+task :gem => :gemspec do
+  sh "gem build #{GEMSPEC}"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+end
+
+desc "Install the gem locally (without docs)"
+task :install => :gem do
+  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version} --no-rdoc --no-ri}
+end
+
+desc "Generate the gemspec"
+task :generate do
+  puts gemspec.to_ruby
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end

data/bin/rubybuntu-gedit

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+# The installer was done as fast as possible, so
+# TODO use dry and maintainable ruby code :D
+
+# enable colors if possible
+require 'paint' rescue nil
+unless defined? Paint
+  module Paint
+    def self.[](*args)
+      args[0]
+    end
+  end
+end
+
+if ARGV.shift != 'install'
+  warn 'Currently, only "rubybuntu-gedit install" is supported. Quitting...'
+  exit
+end
+
+def action(what)
+  if what && !what.empty?
+    puts Paint["x] #{what}", :yellow]
+    system what
+  end
+end
+
+def check_existence(what, sudo = true)
+  if File.exists?(what)
+    print ">> The installer found an outdated file at \"#{what}\"\n" \
+          "Q] It's recommended to remove it. Do you want to remove it? [Yn]"
+    action gets.chop =~ /^y?$/i ?
+     "sudo rm -f #{what}"
+     : nil
+  end
+end
+
+@data = File.dirname(__FILE__) + "/../data"
+
+puts 'Welcome to the rubybuntu-gedit installer :D'
+puts 'Before each action I\'ll tell you what I am going to do'
+puts Paint['Please note: ', :bold] + 'I am pretty untested and might destroy your computer'
+
+# # #
+# language specs
+puts '>> Let\'s start with copying the language specs'
+print 'Q] Do you want to install the languages specs as sudo [/usr/share/gtksourceview-2.0/language-specs] or in your home directory [~/.local/share/gtksourceview-2.0/language-specs]? [Sh]'
+action gets.chop =~ /^s?$/i ?
+  "sudo cp #@data/language-specs/*.lang /usr/share/gtksourceview-2.0/language-specs"
+  : "mkdir -p ~/.local/share/gtksourceview-2.0/language-specs\n" \
+    "   cp #@data/language-specs/*.lang ~/.local/share/gtksourceview-2.0/language-specs"
+
+check_existence '/usr/share/gtksourceview-2.0/language-specs/rhtml.lang', true
+check_existence '/usr/share/gtksourceview-2.0/language-specs/ruby_on_rails.lang', true
+check_existence '~/.local/share/gtksourceview-2.0/language-specs/rhtml.lang', false
+check_existence '~/.local/share/gtksourceview-2.0/language-specs/ruby_on_rails.lang', false
+
+# # #
+# mime
+puts '>> Now the mime types should be updated'
+print 'Q] Do you want to install the mime types as sudo [/usr/share/mime/packages] or in your home directory [~/.local/share/gtksourceview-2.0/language-specs]? [Sh]'
+action gets.chop =~ /^s?$/i ?
+  "sudo cp #@data/mime/*.xml /usr/share/mime/packages\n" \
+  "   sudo update-mime-database /usr/share/mime"
+  : "mkdir -p ~/.local/share/mime/packages\n" \
+    "   cp #@data/mime/*.xml ~/.local/share/mime/packages" \
+    "   update-mime-database ~/.local/share/mime"
+
+check_existence '/usr/share/mime/rails.xml', true
+check_existence '~/.local/share/mime/rails.xml', false
+
+# # #
+# styles
+puts '>> Now, some styles get copied that use the new language specs :)'
+print 'Q] Do you want to install the styles as sudo [/usr/share/gtksourceview-2.0/styles] or in your home directory [~/.local/share/gtksourceview-2.0/styles]? [Sh]'
+action gets.chop =~ /^s?$/i ?
+  "sudo cp #@data/styles/*.xml /usr/share/gtksourceview-2.0/styles"
+  : "mkdir -p ~/.local/share/gtksourceview-2.0/styles\n" \
+    "   cp #@data/language-specs/*.lang ~/.local/share/gtksourceview-2.0/styles"
+
+# # #
+# snippets
+puts '>> Sorry, currently, the snippets cannot installed via this installer'
+
+puts Paint["Congratulations! You've updated your gedit stuff! (if everything worked correctly °_°)", :green]
+puts "If not, please install manually and open an issue on github"
+puts 'Don\'t forget to change your gedit style to "RubyBuntu One" ;)'
+puts
+puts "  J-_-L"

data/data/language-specs/README.rdoc

@@ -0,0 +1,73 @@
+= Ruby/Rails/Web related gedit/gtksourceview language definitions.
+
+Part of {RubyBuntuGedit}[https://github.com/janlelis/rubybuntu-gedit]
+
+== Features
+Contains various language specs needed by Ruby/Rails/Web developers and also tries to maintain them.
+
+* The Ruby language specification has been improved alot. It uses 1.9.2 as reference implementation, recognizes many Ruby-specific language constructs (that can be highlighted differently) and implements many language details. To see all these changes, you need a style that supports ("uses") the new specification, for example, {these styles}[https://github.com/janlelis/rubybuntu-editor-styles]. See below for a changelog summary.
+* ERB is not only usable with HTML, but also with JavaScript, YAML and XML.
+* Gemfile.lock highlighting
+
+== Setup
+
+You should also use up-to-date {mime types}[https://github.com/janlelis/rubybuntu-mime].
+
+=== as root
+
+    sudo cp *.lang /usr/share/gtksourceview-2.0/language-specs
+    # you can also delete the rhtml.lang (now done via html-erb)
+    sudo rm -f /usr/share/gtksourceview-2.0/language-specs/rhtml.lang
+    # and the ruby_on_rails.lang (except you want to have rails highlighting with an extra language..)
+    sudo rm -f /usr/share/gtksourceview-2.0/language-specs/ruby_on_rails.lang
+
+=== as non-root
+
+    mkdir -p ~/.local/share/gtksourceview-2.0/language-specs
+    cp *.lang ~/.local/share/gtksourceview-2.0/language-specs
+    # you can also delete the rhtml.lang (now done via html-erb)
+    rm -f ~/.local/share/gtksourceview-2.0/language-specs/rhtml.lang
+    # and the ruby_on_rails.lang (except you want to have rails highlighting with an extra language..)
+    rm -f ~/.local/share/gtksourceview-2.0/language-specs/ruby_on_rails.lang
+
+
+== CHANGES
+=== ruby.lang
+* Uses 1.9 as reference implementation
+* No Rails keywords, no extra language for Rails
+* Refactored/updated keyword and builtin detection, highlight important constants and methods
+* Improved function definition highlighting
+* More logical style mappings (which also means: current styles are not fully ruby:compatible)
+* Fixed string interpolations
+* Better support for advanced literals (e.g. `%x[]`, `%r<>`, ...)
+* Support Arrays & Hashes (inclusive 1.9 symbol syntax)
+* Different heredoc matching
+* Better symbol detection
+* Small language details, like recognizing `__END__`
+* See `git log` for full details
+* Based on https://github.com/gmate/gmate/blob/master/lang-specs/ruby_on_rails.lang
+
+== TODO
+=== ruby.lang - Advanced TODOs (or: build a "real" parser)
+* Improve heredocs (e.g. nested ones)
+* Different colorizations for "end"s (e.g. def/begin, class/module, while/until, if/case, block), needs to detect modifier statements correctly
+* Detect (multi-line) yard doc tag values
+* Add escapable char for generic string delimiters
+* Advanced regex highlighting (maybe there is already something for pcre out there?)
+* ruby.lang-extras/known-bugs.rb
+
+=== Languages to add/import/update
+* SASS / SCSS / CSS
+* COFFEE
+* HAML
+* SLIM
+* YAML
+* CUCUMBER
+
+Meanwhile, you can, for example, use the ones found in gmate[https://github.com/gmate/gmate/tree/master/lang-specs]
+
+=== MAYBE
+* RDOC markup support (and cross-referencing in ruby)
+* ruby: make unicode-aware/test with unicode code
+
+== J-_-L

data/data/language-specs/erb.lang

@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<language id="erb" _name="Embedded Ruby (erb)" version="2.0" _section="Markup">
+  <metadata>
+    <property name="mimetypes">text/erb</property>
+    <property name="globs">*(?&lt;!text).erb</property>
+  </metadata>
+
+  <styles>
+    <style id="tag"         _name="ERB tag: &lt;%"         map-to="xml:cdata-delim"/>
+    <style id="output"      _name="ERB output tag_ &lt;%=" map-to="erb:tag"/>
+    <style id="comment"     _name="ERB comment: &lt;%#"    map-to="xml:comment"/>
+  </styles>
+
+  <definitions>
+    <context id="block-comment" style-ref="comment">
+      <start>&lt;%#</start>
+      <end>-?%&gt;</end>
+      <include>
+        <context ref="def:in-comment"/>
+      </include>
+    </context>
+
+    <context id="block-output" class="no-spell-check">
+      <start>&lt;%=</start>
+      <end>-?%&gt;</end>
+      <include>
+        <context where="start" sub-pattern="0" style-ref="output"/>
+        <context where="end"   sub-pattern="0" style-ref="output"/>
+        <context ref="ruby:ruby"/>
+      </include>
+    </context>
+
+    <context id="block" class="no-spell-check">
+      <start>&lt;%</start>
+      <end>-?%&gt;</end>
+      <include>
+        <context where="start" sub-pattern="0" style-ref="tag"/>
+        <context where="end"   sub-pattern="0" style-ref="tag"/>
+        <context ref="ruby:ruby"/>
+      </include>
+    </context>
+
+    <context id="erb">
+      <include>
+        <context ref="block-comment"/>
+        <context ref="block-output"/>
+        <context ref="block"/>
+      </include>
+    </context>
+
+  </definitions>
+</language>
+

data/data/language-specs/html-erb.lang

@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<language id="html-erb" _name="HTML (erb)" version="2.0" _section="Markup">
+  <metadata>
+    <property name="mimetypes">text/x-html-erb</property>
+    <property name="globs">*.html.erb;*.rhtml</property>
+    <property name="block-comment-start">&lt;!--</property>
+    <property name="block-comment-end">--&gt;</property>
+  </metadata>
+
+  <!-- also see erb.lang -->
+
+  <styles><!-- you should not edit these but the original ones -->
+    <style id="tag"          _name="ERB tag"          map-to="erb:tag"/>
+    <style id="output"       _name="ERB output tag"   map-to="erb:output"/>
+    <style id="ruby-method"  _name="Ruby method"      map-to="ruby:method"/>
+    <style id="ruby-keyword" _name="Ruby keyword"     map-to="ruby:keyword"/>
+  </styles>
+
+  <definitions>
+     <!-- JS code inside javascript_tag -->
+    <context id="javascript-block">
+       <start>(&lt;%=)\s*(javascript_tag)\s*(do|\{)\s*(%&gt;)</start>
+       <end>(&lt;%)\s*(end|})\s*(%&gt;)</end>
+       <include>
+          <context where="start" sub-pattern="1" style-ref="output"/>
+          <context where="start" sub-pattern="2" style-ref="ruby-method"/>
+          <context where="start" sub-pattern="3" style-ref="ruby-keyword"/>
+          <context where="start" sub-pattern="4" style-ref="output"/>
+          <context where="end"   sub-pattern="1" style-ref="tag"/>
+          <context where="end"   sub-pattern="2" style-ref="ruby-keyword"/>
+          <context where="end"   sub-pattern="3" style-ref="tag"/>
+          <context ref="js:js"/>
+      </include>
+    </context>
+
+    <replace id="html:embedded-lang-hook" ref="erb:block"/><!-- allow erb tags in strings -->
+
+    <context id="html-erb">
+      <include>
+        <context ref="javascript-block"/>
+        <context ref="erb:erb"/>
+        <context ref="html:html"/>
+      </include>
+    </context>
+
+  </definitions>
+</language>
+

data/data/language-specs/javascript-erb.lang

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<language id="js-erb" _name="JavaScript (erb)" version="2.0" _section="Markup">
+  <metadata>
+    <property name="mimetypes">application/x-javascript-erb;text/x-javascript-erb</property>
+    <property name="globs">*.js.erb</property>
+    <property name="line-comment-start">//</property>
+    <property name="block-comment-start">/*</property>
+    <property name="block-comment-end">*/</property>
+  </metadata>
+
+  <!-- also see erb.lang -->
+
+  <definitions>
+    <context id="js-erb">
+      <include>
+        <context ref="erb:erb"/>
+        <context ref="js:js"/>
+      </include>
+    </context>
+  </definitions>
+</language>
+

data/data/language-specs/ruby-bundler-gemfile-lock.lang

@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+ Copyright (C) 2011 Jan Lelis <mail@janlelis.de>
+
+ This library is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+-->
+<language id="ruby-bundler-gemfile-lock" _name="Bundler Gemfile.lock" version="2.0" _section="Others">
+  <metadata>
+    <property name="mimetypes">application/x-ruby-bundler-gemfile-lock;text/x-ruby-bundler-gemfile-lock</property>
+    <property name="globs">Gemfile.lock</property>
+  </metadata>
+
+  <styles>
+    <style id="gem_name"                      _name="Gem Name"               map-to="def:identifier"/>
+    <style id="gem_dependency_type"           _name="Gem Dependency Type"    map-to="def:type"/><!-- TODO/maybe: not via regex (multiple dependencies) -->
+    <style id="gem_dependency_version"        _name="Gem Dependency Version" map-to="def:type"/>
+    <style id="heading"                       _name="Heading"                map-to="def:comment"/>
+    <style id="key"                           _name="Key"                    map-to="def:keyword"/>
+    <style id="value"                         _name="Value"                  map-to="def:string"/>
+    <style id="important"                     _name="Exclamation Mark"       map-to="def:type"/>
+  </styles>
+
+  <definitions>
+    <context id="ruby-bundler-gemfile-lock">
+      <include>
+        <context ref="types"/>
+        <context ref="values"/>
+        <context ref="specs"/>
+        <context ref="dependency_block"/>
+        <context ref="platform_block"/>
+      </include>
+    </context>
+  
+
+    <context id="types" style-ref="heading">
+      <keyword>GIT</keyword>
+      <keyword>GEM</keyword>
+      <keyword>PATH</keyword>
+    </context>
+
+    <context id="values" end-at-line-end="true">
+      <start>^  ([a-zA-Z0-9_]+:) (.*)$</start>
+      <include>
+        <context sub-pattern="1" where="start" style-ref="key"/>
+        <context sub-pattern="2" where="start" style-ref="value"/>
+      </include>
+    </context>
+
+    <context id="specs">
+      <start>  specs:</start>
+      <end>^$</end>
+      <include>
+        <context sub-pattern="0" where="start" style-ref="key"/>
+        <context ref="dependencies"/>
+      </include>
+    </context>
+
+    <context id="dependency_block">
+      <start>DEPENDENCIES</start>
+      <end>^$</end>
+      <include>
+        <context sub-pattern="0" where="start" style-ref="heading"/>
+        <context ref="dependencies"/>
+      </include>
+    </context>
+
+    <context id="dependencies" end-at-line-end="true">
+      <start>^ +(?! )(.*?)(?: \(([^\s\w]*)([^-]*)(?:-(.*))?\))?(!)?$</start><!-- see lib/bundler/lockfile_parser.rb ^ {2}(?! )(.*?)(?: \(([^-]*)(?:-(.*))?\))?'(!)?$ -->
+      <include>
+        <context sub-pattern="1" where="start" style-ref="gem_name"/>
+        <context sub-pattern="2" where="start" style-ref="gem_dependency_type"/>
+        <context sub-pattern="3" where="start" style-ref="gem_dependency_version"/>
+        <context sub-pattern="5" where="start" style-ref="important"/>
+      </include>
+    </context>
+
+
+    <context id="platform_block" style-ref="value">
+      <start>PLATFORMS</start>
+      <end>^$</end>
+      <include>
+        <context sub-pattern="0" where="start" style-ref="heading"/>
+      </include>
+    </context>
+
+  </definitions>
+</language>

data/data/language-specs/ruby-erb.lang

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<language id="ruby-erb" _name="JavaScript (erb)" version="2.0" _section="Markup">
+  <metadata>
+    <property name="mimetypes">application/x-ruby-erb;text/x-ruby-erb</property>
+    <property name="globs">*.rb.erb;*.gemspec.erb;*.rake.erb;*.ru.erb;*thor.erb;Rakefile.erb;Capfile.erb;Gemfile.erb;Thorfile.erb</property>
+    <property name="line-comment-start">#</property>
+    <property name="block-comment-start">=begin</property>
+    <property name="block-comment-end">=end</property>
+  </metadata>
+
+  <!-- also see erb.lang -->
+
+  <definitions>
+    <context id="ruby-erb">
+      <include>
+        <context ref="erb:erb"/>
+        <context ref="ruby:ruby"/>
+      </include>
+    </context>
+  </definitions>
+</language>