angelic-suprails 0.2.1

data/README

@@ -0,0 +1,92 @@
+# Copyright 2008 Bradley Grzesiak
+# This file is part of Suprails.
+# 
+#     Suprails 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 3 of the License, or
+#     (at your option) any later version.
+# 
+#     Suprails 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 Suprails.  If not, see <http://www.gnu.org/licenses/>.
+
+Suprails
+========
+
+This project is intended to be a replacement for the "rails" command. It 
+does not replace the rails framework but rather provides a starting point
+for a rails application far beyond what the "rails" command provides. 
+During execution, in fact, the suprails command calls the rails command.
+
+Suprails has a website at http://suprails.org Eventually, it will be a place
+where suprails users can exchange config files and facets.
+
+How it works
+============
+
+Suprails is unlike most other "Rails plus other stuff" projects out there.
+Instead of me, the Suprails author, deciding what you should have in your rails
+app, you get to decide. In addition, any time you execute Suprails, you have
+the option to update any gems that would otherwise be out-of-date.
+
+Example configuration file (~/.suprails/config)
+===============================================
+
+# Notice that ruby comments work just fine!
+# gems.update "rspec", "rails", "rspec-rails", "haml", "capistrano"
+frozen_rails
+gems.config :haml
+gems.unpack
+plugin "git://github.com/rails/exception_notification"
+generate :rspec
+folder "public/stylesheets/sass"
+delete "public/index.html"
+gpl
+git
+haml
+save # saves a copy of the configfile into rails app
+
+Installation
+============
+
+$ sudo gem install suprails
+
+Execution
+============
+
+First, run suprails without any arguments:
+
+$ suprails
+
+This will initialize your ~/.suprails/ folder and configuration in that folder
+
+You will now want to edit the configuration file to your liking. It is located
+at: ~/.suprails/config
+
+Now, run suprails instead of rails:
+
+$ suprails AppName
+
+History/Bugs
+====
+
+gems.config currently only accepts one arg.
+
+0.2.1 - Added ability to specify a particular config file when running suprails
+        Added output for all commands
+        Updated help text when suprails is run without args (after 1st time)
+
+0.1.3 - Added the save command and extended the file command
+
+0.1.2 - Changed runcommand to runinside
+
+0.1.1 - Added the runcommand verb
+
+0.1 - The DB commands do not yet work. You have to just use the file command
+      instead.
+
+0.0.0 - Initial readme. No code.

data/TODO

@@ -0,0 +1,35 @@
+20-Nov-08
+---------
+
+Need to provide facets with access to all standard suprails commands
+- (michelangeloaltamore)
+
+13-Oct-08
+---------
+Command list is tentatively:
+
+sources "foldername"
+rails
+freeze
+gems.config [:development|:test|:production] [ :gemname1 [, "gemname2" [...]]]
+gems.update [ "gemname1" [, :gemname2 [...]]]
+gems.unpack
+plugin "pluginlocation"
+generate "generator" [ :optional_argument [, "optional_argument2" [...]]]
+folder "foldername"
+file "sourcefile", "destfile"
+delete "filename"
+gpl
+db.(development|test|production).(adapter|encoding|database|username|password|host) "value"
+db.create
+rake "rake-task"
+git
+svn
+(facet-name)
+(facet-name).(cmd) [ :optional_argument1 [, "optional_argument2" [...]]]
+
+=========
+
+courtesy of nice_burger on irc.freenode.net#rubyonrails
+
+I18n,globalize2 for that. map.root in route.db to welcome or something. install haml, if only to get sass. freeze rails, action_mailer stuff for restful_auth, exception_notifier is good, capify, shoulda for tests, app_config plugin, put something nice in README, set up on github (ssh keys stuff to worry about). um, for starters.

data/bin/suprails

@@ -0,0 +1,95 @@
+#! /usr/bin/env ruby
+#
+# Suprails: The customizable wrapper to the rails command
+#
+# Copyright 2008 Bradley Grzesiak
+# This file is part of Suprails.
+# 
+#     Suprails 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 3 of the License, or
+#     (at your option) any later version.
+# 
+#     Suprails 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 Suprails.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require File.dirname(__FILE__) + '/../lib/suprails'
+opts = ARGV
+SUPRAILS_VERSION = "0.2.1"
+
+def is_setup?
+  File.exists?(File.expand_path('~/.suprails'))
+end
+
+def setup_suprails
+  Dir.mkdir(File.expand_path('~/.suprails'))
+  Dir.mkdir(File.expand_path('~/.suprails/sources'))
+  Dir.mkdir(File.expand_path('~/.suprails/facets'))
+  require 'ftools'
+  config_source = File.expand_path(File.dirname(__FILE__) + '/../suprails.config.example')
+  config_dest = File.expand_path('~/.suprails/config')
+  File.copy(config_source, config_dest, false)
+  Dir[File.dirname(__FILE__) + '/../facets/*.rb'].each do |f|
+    File.copy(f, File.expand_path('~/.suprails/facets/'), false)
+  end
+  puts "Finished setting up suprails in #{File.expand_path('~/.suprails')}"
+  puts "You probably want to edit the config file in there now."
+end
+
+# Does the ~/.suprails folder exist?
+if !is_setup?
+  setup_suprails
+  exit
+end
+
+if opts.length == 0
+  puts <<-EOF
+Usage: /usr/bin/suprails /path/to/your/app [options]
+
+Options:
+    -v, --version                   Show the Suprails version number and quit.
+    -c, --config filename           Configuration file to use (^foo resolves to ~/.suprails/config.foo)
+
+Description:
+    The 'suprails' command parses a configuration file to create a new Ruby on
+    Rails application customized however you'd like.
+
+Examples:
+    suprails ~/dev/pro/WidgetStoreFront
+    
+    This generates a Rails application in ~/dev/pro/WidgetStoreFront with all
+    the customizations you specified in ~/.suprails/config
+    
+    suprails ~/dev/fun/BazBlog -c ^bort
+    
+    This generates a Rails application in ~/dev/fun/BazBlog with all the
+    customizations you specified in ~/.suprails/config.bort
+EOF
+else
+  # If options include -v or --version, print the version and exit
+  if opts.any? {|opt| %w{-v --version}.include?(opt)}
+    puts "Suprails Version: #{SUPRAILS_VERSION}"
+    exit
+  end
+  
+  # setup the config file, using ~/.suprails/config as default
+  config = opts.index('-c') || opts.index('--config') || '~/.suprails/config'
+  if config.is_a? Fixnum
+    opts.delete_at(config)
+    config = opts.delete_at(config)
+    # allow "^foo" to resolve to "~/.suprails/config.foo"
+    config = config.sub(/\A(\^)/, '~/.suprails/config.')
+  end
+  
+  if opts.first =~ /^[a-zA-Z0-9]+/
+    Suprails.new(opts.shift).create_project(config)
+  else
+    puts 'Invalid Application Name. Must start with alphanumeric character!'
+  end
+end

data/facets/haml.rb

@@ -0,0 +1,28 @@
+#
+# Haml Facet for Suprails
+# Copyright 2008 Bradley Grzesiak
+# This file is part of Suprails.
+# 
+#     Suprails 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 3 of the License, or
+#     (at your option) any later version.
+# 
+#     Suprails 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 Suprails.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+Facet.define "haml" do
+  author "Bradley Grzesiak"
+  version "0.1"
+  
+  def go app_name
+    puts 'Running haml'
+    `haml --rails #{app_name}`
+  end
+end

data/lib/db.rb

@@ -0,0 +1,80 @@
+#
+# Suprails: The customizable wrapper to the rails command
+#
+# Copyright 2008 Bradley Grzesiak
+# This file is part of Suprails.
+# 
+#     Suprails 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 3 of the License, or
+#     (at your option) any later version.
+# 
+#     Suprails 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 Suprails.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require File.dirname(__FILE__) + '/yaml_helper'
+
+class DB
+  attr_reader :development, :test, :production
+  class Environment
+    def initialize db_type
+      @db_type = db_type
+    end
+    def adapter adapter
+      # puts "db.#{@db_type}.adapter #{adapter}"
+      puts 'database.yml modification not yet implemented'
+    end
+    def db db
+      # puts "db.#{@db_type}.db #{db}"
+      puts 'database.yml modification not yet implemented'
+    end
+    def database datab
+      db datab
+    end
+    def host h
+      # puts "db.#{@db_type}.host #{h}"
+      puts 'database.yml modification not yet implemented'
+    end
+    def username uname
+      # puts "db.#{@db_type}.username #{uname}"
+      puts 'database.yml modification not yet implemented'
+    end
+    def password passwd
+      # puts "db.#{@db_type}.password #{passwd}"
+      puts 'database.yml modification not yet implemented'
+    end
+    def socket s
+      # puts "db.#{@db_type}.socket #{s}"
+      puts 'database.yml modification not yet implemented'
+    end
+    def timeout to
+      # puts "db.#{@db_type}.timeout #{to}"
+      puts 'database.yml modification not yet implemented'
+    end
+  end
+  def initialize app_name
+    @development = Environment.new 'development'
+    @test = Environment.new 'test'
+    @production = Environment.new 'production'
+    @app_name = app_name
+  end
+
+  def save_yaml database_hash
+    file = "#{@app_name}/config/database.yml"
+    YAMLHelper.create_yaml file, database_hash
+  end
+  
+  def create
+    `cd #{@app_name}; rake db:create`
+  end
+  def migrate
+    `cd #{@app_name}; rake db:migrate`
+  end
+    
+end

data/lib/facet.rb

@@ -0,0 +1,56 @@
+#
+# Suprails: The customizable wrapper to the rails command
+#
+# Copyright 2008 Bradley Grzesiak
+# This file is part of Suprails.
+# 
+#     Suprails 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 3 of the License, or
+#     (at your option) any later version.
+# 
+#     Suprails 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 Suprails.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+# See: http://eigenclass.org/hiki.rb?ruby+plugins
+module FacetSugar
+  def def_field(*names)
+    class_eval do 
+      names.each do |name|
+        define_method(name) do |*args| 
+          case args.size
+          when 0: instance_variable_get("@#{name}")
+          else    instance_variable_set("@#{name}", *args)
+          end
+        end
+      end
+    end
+  end
+end
+
+require File.dirname(__FILE__) + '/suprails_helper'
+
+class Facet
+  include SuprailsHelper
+  
+  @registered_facets = {}
+  class << self
+    attr_reader :registered_facets
+    private :new
+  end
+
+  def self.define(name, &block)
+    f = new
+    f.instance_eval(&block)
+    Facet.registered_facets[name] = f
+  end
+
+  extend FacetSugar
+  def_field :author, :version, :exposed_methods
+end

data/lib/gems.rb

@@ -0,0 +1,47 @@
+#
+# Suprails: The customizable wrapper to the rails command
+#
+# Copyright 2008 Bradley Grzesiak
+# This file is part of Suprails.
+# 
+#     Suprails 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 3 of the License, or
+#     (at your option) any later version.
+# 
+#     Suprails 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 Suprails.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+class Gems
+  def initialize app_name
+    @app_name = app_name
+  end
+  
+  def update *gems
+    args = gems.inject('') {|text, g| "#{text} #{g}"}
+    result = `gem update #{args}`
+    if result
+      puts 'Gem update failed. Please enter your admin password for sudo gem update:'
+      `sudo gem update #{args}`
+    end
+  end 
+ 
+  def config *gems
+    @gems |= gems
+    to_insert = gems.inject("") {|text, g| "#{text}  config.gem '#{g}'\n"}
+    file = "#{@app_name}/config/environment.rb"
+    # InsertionHelper.file_sub! file, /(^.*config\.gem.*$)/, "#{to_insert}\\1"
+    InsertionHelper.insert_above file, "config.gem", to_insert[0..-2]
+  end
+  
+  def unpack
+    `cd #{@app_name}; rake gems:unpack`
+  end
+end
+

data/lib/insertion_helper.rb

@@ -0,0 +1,40 @@
+#
+# Suprails: The customizable wrapper to the rails command
+#
+# Copyright 2008 Bradley Grzesiak
+# This file is part of Suprails.
+# 
+#     Suprails 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 3 of the License, or
+#     (at your option) any later version.
+# 
+#     Suprails 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 Suprails.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+class InsertionHelper
+  
+  def self.insert_at filename, line_number, contents
+    file_contents = File.readlines(filename)
+    file_contents.insert(line_number-1, "#{contents}\n")
+    File.open(filename, 'w') {|f| f << file_contents }
+  end
+  
+  def self.file_sub! filename, pattern, contents
+    file_contents = File.read(filename)
+    file_contents.sub!(pattern, contents)
+    File.open(filename, 'w') {|f| f << file_contents }
+  end
+  
+  def self.insert_above filename, search_string, contents
+    file_contents = File.read(filename)
+    file_contents.sub!(/(^.*#{Regexp.escape(search_string)}.*$)/, "#{contents}\n\\1")
+    File.open(filename, 'w') {|f| f << file_contents}
+  end
+end