skema 0.2.0

data/History.txt

@@ -0,0 +1,8 @@
+== 0.2.0 05/03/2008
+
+* Packaged skema as a gem
+* Added LGPL template
+
+== 0.1 19/11/2007
+
+* First release

data/License.txt

@@ -0,0 +1,21 @@
+Copyright (c) 2007-2008 Paolo Capriotti <p.capriotti@gmail.com>
+Copyright (c) 2008 Riccardo Iaconelli <riccardo@kde.org>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,35 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/skema
+config/hoe.rb
+config/requirements.rb
+lib/modules/gpl/gpl.rb
+lib/modules/gpl/templates/file
+lib/modules/kapp/kapp.rb
+lib/modules/kapp/templates/CMakeLists.txt
+lib/modules/kapp/templates/appui.rc
+lib/modules/kapp/templates/main.cpp
+lib/modules/lgpl/lgpl.rb
+lib/modules/lgpl/templates/file
+lib/modules/skemaconfig/skemaconfig.rb
+lib/modules/skemaconfig/templates/skemarc
+lib/skema.rb
+lib/skema/version.rb
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_skema.rb
+website/img/header_bg.png
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,17 @@
+= skema
+
+=== A command line template expansion tool
+
+Homepage: http://skema.rubyforge.org/
+
+Copyright (c) 2008 Paolo Capriotti  <p.capriotti@gmail.com>
+
+skema is a command line utility for expanding templates.
+It can be used in a number of ways. Examples include:
+* fast prototyping applications in frameworks that require a lot of boilerplate code;
+* adding copyright statements to source files;
+* automating repetitive coding tasks.
+
+Of course, there's nothing in skema that you can't find in your favourite text
+editor's templating facility; skema just makes it easier if you happen to like
+the command line.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/skema

@@ -0,0 +1,137 @@
+#!/usr/bin/env ruby
+#
+# skema - A command line template expansion tool
+#
+# Copyright (c) 2007 Paolo Capriotti  <p.capriotti@gmail.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'rubygems' rescue nil
+require 'skema'
+
+def error(msg)
+    warn "ERROR: #{msg}"
+    exit 1
+end
+
+def usage
+    error "Usage #$0 MODULE TARGET [ARGS...]"
+end
+
+def load_module(mod)
+    alt = [mod]
+    mdir = Skema::config[:skema_modules_dir]
+    case mdir
+    when String
+        alt << File.join(mdir, mod)
+    when Array
+        mdir.each do |module_dir|
+            alt << File.join(module_dir, mod)
+        end
+    end
+    alt = alt.inject([]) do |res, file|
+        if File.exist? file
+            if File.directory? file
+                modfile = File.join(file, "#{File.basename(file)}.rb")
+                if File.exist? modfile
+                    res << modfile
+                else
+                    # add all ruby scripts
+                    Dir[File.join(file, '*.rb')].each do |modfile|
+                        res << modfile
+                    end
+                end
+            else
+                res << file
+            end
+        end
+        res
+    end
+
+    alt.each do |file|
+        begin
+            load file
+            return file
+        rescue Exception => e
+            warn "Could not load #{file}:"
+            warn e
+        end
+    end
+    error "Could not load module #{mod}. Tried #{alt.join ','}"
+end
+
+def ask(key, value)
+    ans = nil
+    while ans.nil? || ans.empty?
+        q = key.to_s
+        q += " [#{value}]" if value
+        q += ": "
+        $stdout.write(q)
+        ans = $stdin.gets.chomp
+        ans = value if ans.empty?
+    end
+    ans
+end
+
+mod = ARGV.shift or usage
+if mod == "-i"
+    $interactive = true
+    mod = ARGV.shift or usage
+end
+target = ARGV.shift or usage
+mod = load_module mod
+error "Invalid template module" unless $last_template
+
+# read args
+args = {}
+if File.exist?(target) and not File.directory?(target)
+    args[:filename] = File.basename(target)
+    target = File.dirname(target)
+end
+ARGV.each do |arg|
+    if arg =~ /^(\S*):(.*)$/
+        args[$1.to_sym] = $2
+    else
+        usage
+    end
+end
+
+$last_template.args.each do |key, value|
+    unless args.has_key? key
+        default = nil
+        if not value.nil?
+            default = value
+        elsif Skema::config.has_key? key
+            default = Skema::config[key]
+        end
+
+        if $interactive || Skema::config[:interactive]
+            args[key] = ask(key, default)
+        elsif default
+            args[key] = default
+        else
+            error "Missing argument #{key}"
+        end
+    end
+end
+
+dir = $last_template.template || File.dirname(mod)
+template = Skema::Template.new dir, target
+template.run args

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'skema/version'
+
+AUTHOR = 'Paolo Capriotti'
+EMAIL = "p.capriotti@gmail.com"
+DESCRIPTION = "Command line template expansion tool"
+GEM_NAME = 'skema'
+RUBYFORGE_PROJECT = 'skema'
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "pcapriotti"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Skema::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'skema documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'skema'

data/lib/modules/gpl/gpl.rb

@@ -0,0 +1,4 @@
+template :author => nil,
+         :email => nil,
+         :year => Time.now.year,
+         :filename => nil

data/lib/modules/gpl/templates/file

@@ -0,0 +1,10 @@
+<% filename @filename %>/*
+  Copyright (c) <%= @year %> <%= @author %> <<%= @email %>>
+
+  This program 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.
+*/
+
+<%= original_content %>

data/lib/modules/kapp/kapp.rb

@@ -0,0 +1,6 @@
+template :name => nil,
+         :title => nil,
+         :version => "0.1",
+         :author => nil,
+         :email => nil
+

data/lib/modules/kapp/templates/CMakeLists.txt

@@ -0,0 +1,17 @@
+project(<%= @name %>)
+
+find_package(KDE4)
+include(KDE4Defaults)
+
+set(<%= @name %>_SRC
+    main.cpp
+)
+
+include_directories(${KDE4_INCLUDES})
+
+kde4_add_executable(<%= @name %> ${<%= @name %>_SRC})
+target_link_libraries(<%= @name %> ${KDE4_KDEUI_LIBS})
+
+install(TARGETS <%= @name %> DESTINATION ${BIN_INSTALL_DIR})
+# install(FILES <%= @name %>.desktop DESTINATION ${XDG_APPS_INSTALL_DIR})
+install(FILES <%= @name %>ui.rc  DESTINATION  ${DATA_INSTALL_DIR}/<%= @name %>)

data/lib/modules/kapp/templates/appui.rc

@@ -0,0 +1,5 @@
+<% filename "#{@name}ui.rc" %>
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE kpartgui SYSTEM "kpartgui.dtd">
+<gui name="<%= @name %>" version="1">
+</gui>

data/lib/modules/kapp/templates/main.cpp

@@ -0,0 +1,34 @@
+/*
+  Copyright (c) <%= Time.now.year %> <%= @author %> <<%= @email %>>
+
+            
+  This program 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.
+*/
+
+#include <KApplication>
+#include <KAboutData>
+#include <KLocale>
+#include <KCmdLineArgs>
+
+int main(int argc, char *argv[])
+{
+    KAboutData aboutData("<%= @name %>", 0, ki18n("<%= @title %>"),
+                         "<%= @version %>", ki18n("Description"), 
+                         KAboutData::License_GPL,
+                         ki18n("(c) <%= Time.now.year %>  <%= @author %>"), 
+                         KLocalizedString(), "", "<%= @email %>");
+    aboutData.addAuthor(ki18n("<%= @author %>"), KLocalizedString(), "<%= @email %>");
+
+    KCmdLineArgs::init(argc, argv, &aboutData);
+
+    KCmdLineOptions options;
+    KCmdLineArgs::addCmdLineOptions(options);
+    KCmdLineArgs::parsedArgs();
+    KApplication app;
+
+    return app.exec();
+}
+

data/lib/modules/lgpl/lgpl.rb

@@ -0,0 +1,4 @@
+template :author => nil,
+         :email => nil,
+         :year => Time.now.year,
+         :filename => nil

data/lib/modules/lgpl/templates/file

@@ -0,0 +1,19 @@
+<% filename @filename %>/*
+  Copyright (c) <%= @year %> <%= @author %> <<%= @email %>>
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License version 2 as published by the Free Software Foundation.
+
+  This library 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
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with this library; see the file COPYING.LIB.  If not, write to
+  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+  Boston, MA 02110-1301, USA.
+*/
+
+<%= original_content %>

data/lib/modules/skemaconfig/skemaconfig.rb

@@ -0,0 +1 @@
+template :name => nil, :email => nil, :filename => nil

data/lib/modules/skemaconfig/templates/skemarc

@@ -0,0 +1,5 @@
+<% filename @filename %>:author: <%= @name %>
+:email: <%= @email %>
+:skema_modules_dir:
+ - <%= File.join(ENV['HOME'], '.skema') %>
+

data/lib/skema.rb

@@ -0,0 +1,122 @@
+$:.unshift File.dirname(__FILE__)
+require 'find'
+require 'fileutils'
+require 'erb'
+require 'yaml'
+
+def template(*args)
+    dirname = nil
+    dirname = args.first if args.size > 1
+    args = args.last || {}
+
+    $last_template = Skema::TemplateDefinition.new(dirname, args)
+end
+
+module Skema
+    DEFAULT_MODULE_DIR = File.join(File.dirname(__FILE__), 'modules')
+    
+    def self.config
+        @@config ||= Config.new
+    end
+
+    def self.last
+        @@last
+    end
+    
+    class Config
+        def initialize
+            configfile = File.join(ENV['HOME'], '.skemarc')
+            if File.exist? configfile
+                @config = File.open(configfile) {|f| YAML::load(f) }
+            else
+                @config = {}
+            end
+            md = @config[:skema_modules_dir] ||= []
+            md.unshift(DEFAULT_MODULE_DIR) if md.class == Array
+        end
+        
+        def [](key)
+            @config[key]
+        end
+        
+        def has_key? key
+            @config.has_key? key
+        end
+    end
+    
+    class TemplateDefinition
+        attr_reader :template, :args
+        def initialize(template, args)
+            @template = template
+            @args = args
+        end
+    end
+    
+    class Template
+        def initialize(dir, target)
+            @dir = dir
+            @target = target
+        end
+        
+        def run(arguments)
+            template_dir = File.join(@dir, 'templates')
+            if File.exists? template_dir
+                Find.find(template_dir) do |filename|
+                    Find.purge if filename[0] == '.'
+                    next if File.directory? filename
+                    args = Args.new(@target, filename[template_dir.size+1..-1], arguments)
+                    data = File.open(filename) do |f|
+                      ERB.new(f.read).result(args.get_binding)
+                    end
+                    puts "-> #{args.filename}"
+                    create_file(args.full_filename, data)
+                end
+            end
+        end
+
+        def create_file(filename, data)
+            dir = File.dirname filename
+            FileUtils.mkdir_p dir unless File.exist? dir
+            File.open(filename, 'w') {|f| f.write data }
+        end
+    end
+    
+    class Args        
+        def initialize(target, base, args)
+            @_target = target
+            @_base = base
+            args.each do |arg, value|
+                instance_variable_set("@#{arg}", value)
+            end
+        end
+        
+        def get_binding
+            binding
+        end
+
+        def filename(*args)
+            if args.size > 0
+                filename = args.shift
+                @_filename = if args.include? :absolute
+                    filename
+                else
+                    File.join(File.dirname(@_base), filename)
+                end
+            else
+                @_filename || @_base
+            end
+        end
+        
+        def full_filename
+          File.join(@_target, filename)
+        end
+        
+        def original_content
+          if File.exist? full_filename
+            File.open(full_filename) {|f| f.read }
+          else
+            ""
+          end
+        end
+    end
+end